The interface here is nearly identical to FLAC's stream decoder, including the callbacks, with the addition of OggFLAC__stream_decoder_set_serial_number(). See the FLAC stream decoder module for full documentation.
|
Signature for the read callback. See OggFLAC__stream_decoder_set_read_callback() and FLAC__StreamDecoderReadCallback for more info.
|
|
Signature for the write callback. See OggFLAC__stream_decoder_set_write_callback() and FLAC__StreamDecoderWriteCallback for more info.
|
|
Signature for the metadata callback. See OggFLAC__stream_decoder_set_metadata_callback() and FLAC__StreamDecoderMetadataCallback for more info.
|
|
Signature for the error callback. See OggFLAC__stream_decoder_set_error_callback() and FLAC__StreamDecoderErrorCallback for more info.
|
|
State values for an OggFLAC__StreamDecoder The decoder's state can be obtained by calling OggFLAC__stream_decoder_get_state().
|
|
Create a new stream decoder instance. The instance is created with default settings; see the individual OggFLAC__stream_decoder_set_*() functions for each setting's default.
|
|
Free a decoder instance. Deletes the object pointed to by decoder.
|
|
Set the read callback. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_read_callback()
|
|
Set the write callback. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_write_callback()
|
|
Set the metadata callback. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_callback()
|
|
Set the error callback. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_error_callback()
|
|
Set the client data to be passed back to callbacks. This value will be supplied to callbacks in their client_data argument.
|
|
Set the serial number for the Ogg stream. The default behavior is to use the serial number of the first Ogg page. Setting a serial number here will explicitly specify which stream is to be decoded.
|
|
Direct the decoder to pass on all metadata blocks of type type. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_respond()
|
|
Direct the decoder to pass on all APPLICATION metadata blocks of the given id. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_respond_application()
|
|
Direct the decoder to pass on all metadata blocks of any type. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_respond_all()
|
|
Direct the decoder to filter out all metadata blocks of type type. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_ignore()
|
|
Direct the decoder to filter out all APPLICATION metadata blocks of the given id. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_ignore_application()
|
|
Direct the decoder to filter out all metadata blocks of any type. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_ignore_all()
|
|
Get the current decoder state.
|
|
Get the state of the underlying FLAC stream decoder. Useful when the stream decoder state is
|
|
Get the current decoder state as a C string. This version automatically resolves
|
|
This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_get_channels()
|
|
This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_get_channel_assignment()
|
|
This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_get_bits_per_sample()
|
|
This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_get_sample_rate()
|
|
This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_get_blocksize()
|
|
Initialize the decoder instance. Should be called after OggFLAC__stream_decoder_new() and OggFLAC__stream_decoder_set_*() but before any of the OggFLAC__stream_decoder_process_*() functions. Will set and return the decoder state, which will be OggFLAC__STREAM_DECODER_OK if initialization succeeded.
|
|
Finish the decoding process. Flushes the decoding buffer, releases resources, resets the decoder settings to their defaults, and returns the decoder state to OggFLAC__STREAM_DECODER_UNINITIALIZED. In the event of a prematurely-terminated decode, it is not strictly necessary to call this immediately before OggFLAC__stream_decoder_delete() but it is good practice to match every OggFLAC__stream_decoder_init() with an OggFLAC__stream_decoder_finish().
|
|
This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_flush()
|
|
This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_reset()
|
|
Decode one metadata block or audio frame. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_process_single()
|
|
Decode until the end of the metadata. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_process_until_end_of_metadata()
|
|
Decode until the end of the stream. This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_process_until_end_of_stream()
|
|
Maps an OggFLAC__StreamDecoderState to a C string. Using an OggFLAC__StreamDecoderState as the index to this array will give the string equivalent. The contents should not be modified. |