Skip to content

Commit

Permalink
Change API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ktmf01 authored Sep 24, 2024
1 parent 9d7a63e commit 0918832
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions include/FLAC/stream_encoder.h
Original file line number Diff line number Diff line change
Expand Up @@ -544,10 +544,11 @@ typedef FLAC__StreamEncoderReadStatus (*FLAC__StreamEncoderReadCallback)(const F
* pair of calls several times in a batch with the same value of
* \a current_frame. When writing the page header, as well as in all but the
* first page body write of the batch, the \a samples argument to the write
* callback will be \c 0. The full number of samples of the batch will be
* passed in the first page body write. Furthermore, it is possible that a few
* of these samples are retained in an internal Ogg encoding buffer and not
* actually encoded until the next batch.
* callback will be \c 0. For the write callback call containing the first
* page body, the \a samples argument is the number of samples contained in
* all newly added complete packets (not pages). This means that in case a
* packet is split over two pages, they are counted in the samples argument
* of the page on which the packet is completed.
*
* \note In general, FLAC__StreamEncoder functions which change the
* state should not be called on the \a encoder while in the callback.
Expand Down

0 comments on commit 0918832

Please sign in to comment.