Cherry pick PR youtube#2477: Update SbPlayerGetMaximumNumberOfSamples…

…PerWrite() description (youtube#2628) Refer to the original PR: youtube#2477 b/326446911 Co-authored-by: Austin Osagie <[email protected]>
kaidokert · Mar 20, 2024 · 45d08c6 · 45d08c6
1 parent 0ed1dd1
commit 45d08c6
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/starboard/player.h b/starboard/player.h
@@ -534,7 +534,12 @@ SB_EXPORT void SbPlayerWriteSample2(SbPlayer player,
                                     int number_of_sample_infos);
 
 // Returns the maximum number of samples that can be written in a single call
-// to SbPlayerWriteSamples().
+// to SbPlayerWriteSamples(). Returning a value greater than one can improve
+// performance by allowing SbPlayerWriteSamples() to write multiple samples in
+// one call.
+//
+// Note that this feature is currently disabled in Cobalt where
+// SbPlayerWriteSamples() will always be called with one sample.
 //
 // |player|: The player for which the number is retrieved.
 // |sample_type|: The type of sample for which the number is retrieved. See the