Manpages - opus_multistream_ctls.3
Table of Contents
NAME
opus_multistream_ctls - These are convenience macros that are specific to the opus_multistream_encoder_ctl() and opus_multistream_decoder_ctl() interface. The CTLs from Generic CTLs, Encoder related CTLs, and Decoder related CTLs may be applied to a multistream encoder or decoder as well. In addition, you may retrieve the encoder or decoder state for an specific stream via OPUS_MULTISTREAM_GET_ENCODER_STATE or OPUS_MULTISTREAM_GET_DECODER_STATE and apply CTLs to it individually.
SYNOPSIS
Macros
#define *OPUS_MULTISTREAM_GET_ENCODER_STATE*(x, y)
Gets the encoder state for an individual stream of a multistream
encoder.
#define *OPUS_MULTISTREAM_GET_DECODER_STATE*(x, y)
Gets the decoder state for an individual stream of a multistream
decoder.
Detailed Description
These are convenience macros that are specific to the opus_multistream_encoder_ctl() and opus_multistream_decoder_ctl() interface. The CTLs from Generic CTLs, Encoder related CTLs, and Decoder related CTLs may be applied to a multistream encoder or decoder as well. In addition, you may retrieve the encoder or decoder state for an specific stream via OPUS_MULTISTREAM_GET_ENCODER_STATE or OPUS_MULTISTREAM_GET_DECODER_STATE and apply CTLs to it individually.
Macro Definition Documentation
#define OPUS_MULTISTREAM_GET_DECODER_STATE(x, y)
Gets the decoder state for an individual stream of a multistream decoder.
Parameters
x
opus_int32: The index of the stream whose decoder you wish to retrieve. This must be non-negative and less than thestreamsparameter used to initialize the decoder.
yOpusDecoder**: Returns a pointer to the given decoder state.
Return values
OPUS_BAD_ARG The index of the requested stream was out of range.
#define OPUS_MULTISTREAM_GET_ENCODER_STATE(x, y)
Gets the encoder state for an individual stream of a multistream encoder.
Parameters
x
opus_int32: The index of the stream whose encoder you wish to retrieve. This must be non-negative and less than thestreamsparameter used to initialize the encoder.
yOpusEncoder**: Returns a pointer to the given encoder state.
Return values
OPUS_BAD_ARG The index of the requested stream was out of range.
Author
Generated automatically by Doxygen for Opus from the source code.