Skip to content

Commit

Permalink
Update SbPlayer function descriptions (#2475)
Browse files Browse the repository at this point in the history
Updates the comments describing SbPlayerWriteSamples() and
SbPlayerGetMaximumNumberOfSamplesPerWrite()

b/326446911
  • Loading branch information
osagie98 authored Feb 23, 2024
1 parent a9c3206 commit 75db66e
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions starboard/player.h
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,7 @@ SB_EXPORT void SbPlayerSeek2(SbPlayer player,
// SbPlayerWriteSamples(), so it must be copied if its content will be used
// after SbPlayerWriteSamples() returns.
// |number_of_sample_infos|: Specify the number of samples contained inside
// |sample_infos|. It has to be at least one, and less than the return value
// |sample_infos|. It has to be at least one, and at most the return value
// of SbPlayerGetMaximumNumberOfSamplesPerWrite().
#if SB_API_VERSION >= 15
SB_EXPORT void SbPlayerWriteSamples(SbPlayer player,
Expand All @@ -532,13 +532,8 @@ SB_EXPORT void SbPlayerWriteSample2(SbPlayer player,
const SbPlayerSampleInfo* sample_infos,
int number_of_sample_infos);

// Writes a single sample of the given media type to |player|'s input stream.
// Its data may be passed in via more than one buffers. The lifetime of
// |sample_buffers|, |sample_buffer_sizes|, |video_sample_info|, and
// |sample_drm_info| (as well as member |subsample_mapping| contained inside it)
// are not guaranteed past the call to SbPlayerWriteSample. That means that
// before returning, the implementation must synchronously copy any information
// it wants to retain from those structures.
// Returns the maximum number of samples that can be written in a single call
// to SbPlayerWriteSamples().
//
// |player|: The player for which the number is retrieved.
// |sample_type|: The type of sample for which the number is retrieved. See the
Expand Down

0 comments on commit 75db66e

Please sign in to comment.