FunctionsAndGlobals class
Properties
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
opus_custom_decode(Pointer<OpusCustomDecoder> st, Pointer<Uint8> data, int len, Pointer<Int16> pcm, int frame_size)
→ int
-
Decode an opus custom frame
@param
in st OpusCustomDecoder*: Decoder state
@param in data char*: Input payload. Use a NULL pointer to indicate packet loss
@param in len int: Number of bytes in payload
@param out pcm opus_int16*: Output signal (interleaved if 2 channels). length
is frame_sizechannelssizeof(opus_int16)
@param in frame_size Number of samples per channel of available space in *pcm.
@returns Number of decoded samples or @ref opus_errorcodes
-
opus_custom_decode_float(Pointer<OpusCustomDecoder> st, Pointer<Uint8> data, int len, Pointer<Float> pcm, int frame_size)
→ int
-
Decode an opus custom frame with floating point output
@param
in st OpusCustomDecoder*: Decoder state
@param in data char*: Input payload. Use a NULL pointer to indicate packet loss
@param in len int: Number of bytes in payload
@param out pcm float*: Output signal (interleaved if 2 channels). length
is frame_sizechannelssizeof(float)
@param in frame_size Number of samples per channel of available space in *pcm.
@returns Number of decoded samples or @ref opus_errorcodes
-
opus_custom_decoder_create(Pointer<OpusCustomMode> mode, int channels, Pointer<Int32> error)
→ Pointer<OpusCustomDecoder>
-
Creates a new decoder state. Each stream needs its own decoder state (can't
be shared across simultaneous streams).
@param
in mode OpusCustomMode: Contains all the information about the characteristics of the
stream (must be the same characteristics as used for the encoder)
@param in channels int: Number of channels
@param out error int*: Returns an error code
@return Newly created decoder state.
-
opus_custom_decoder_destroy(Pointer<OpusCustomDecoder> st)
→ void
-
Destroys a an decoder state.
@param
in st OpusCustomDecoder*: State to be freed.
-
opus_custom_decoder_get_size(Pointer<OpusCustomMode> mode, int channels)
→ int
-
Gets the size of an OpusCustomDecoder structure.
@param
in mode OpusCustomMode *: Mode configuration
@param in channels int: Number of channels
@returns size
-
opus_custom_decoder_init(Pointer<OpusCustomDecoder> st, Pointer<OpusCustomMode> mode, int channels)
→ int
-
Initializes a previously allocated decoder state
The memory pointed to by st must be the size returned by opus_custom_decoder_get_size.
This is intended for applications which use their own allocator instead of malloc.
@see opus_custom_decoder_create(),opus_custom_decoder_get_size()
To reset a previously initialized state use the OPUS_RESET_STATE CTL.
@param
in st OpusCustomDecoder*: Decoder state
@param in mode OpusCustomMode *: Contains all the information about the characteristics of
the stream (must be the same characteristics as used for the
encoder)
@param in channels int: Number of channels
@return OPUS_OK Success or @ref opus_errorcodes
-
opus_custom_encode(Pointer<OpusCustomEncoder> st, Pointer<Int16> pcm, int frame_size, Pointer<Uint8> compressed, int maxCompressedBytes)
→ int
-
Encodes a frame of audio.
@param
in st OpusCustomEncoder*: Encoder state
@param in pcm opus_int16*: PCM audio in signed 16-bit format (native endian).
There must be exactly frame_size samples per channel.
@param in frame_size int: Number of samples per frame of input signal
@param out compressed char *: The compressed data is written here. This may not alias pcm and must be at least maxCompressedBytes long.
@param in maxCompressedBytes int: Maximum number of bytes to use for compressing the frame
(can change from one frame to another)
@return Number of bytes written to "compressed".
If negative, an error has occurred (see error codes). It is IMPORTANT that
the length returned be somehow transmitted to the decoder. Otherwise, no
decoding is possible.
-
opus_custom_encode_float(Pointer<OpusCustomEncoder> st, Pointer<Float> pcm, int frame_size, Pointer<Uint8> compressed, int maxCompressedBytes)
→ int
-
Encodes a frame of audio.
@param
in st OpusCustomEncoder*: Encoder state
@param in pcm float*: PCM audio in float format, with a normal range of +/-1.0.
Samples with a range beyond +/-1.0 are supported but will
be clipped by decoders using the integer API and should
only be used if it is known that the far end supports
extended dynamic range. There must be exactly
frame_size samples per channel.
@param in frame_size int: Number of samples per frame of input signal
@param out compressed char *: The compressed data is written here. This may not alias pcm and must be at least maxCompressedBytes long.
@param in maxCompressedBytes int: Maximum number of bytes to use for compressing the frame
(can change from one frame to another)
@return Number of bytes written to "compressed".
If negative, an error has occurred (see error codes). It is IMPORTANT that
the length returned be somehow transmitted to the decoder. Otherwise, no
decoding is possible.
-
opus_custom_encoder_create(Pointer<OpusCustomMode> mode, int channels, Pointer<Int32> error)
→ Pointer<OpusCustomEncoder>
-
Creates a new encoder state. Each stream needs its own encoder
state (can't be shared across simultaneous streams).
@param
in mode OpusCustomMode*: Contains all the information about the characteristics of
the stream (must be the same characteristics as used for the
decoder)
@param in channels int: Number of channels
@param out error int*: Returns an error code
@return Newly created encoder state.
-
opus_custom_encoder_destroy(Pointer<OpusCustomEncoder> st)
→ void
-
Destroys a an encoder state.
@param
in st OpusCustomEncoder*: State to be freed.
-
opus_custom_encoder_get_size(Pointer<OpusCustomMode> mode, int channels)
→ int
-
Gets the size of an OpusCustomEncoder structure.
@param
in mode OpusCustomMode *: Mode configuration
@param in channels int: Number of channels
@returns size
-
opus_custom_encoder_init(Pointer<OpusCustomEncoder> st, Pointer<OpusCustomMode> mode, int channels)
→ int
-
Initializes a previously allocated encoder state
The memory pointed to by st must be the size returned by opus_custom_encoder_get_size.
This is intended for applications which use their own allocator instead of malloc.
@see opus_custom_encoder_create(),opus_custom_encoder_get_size()
To reset a previously initialized state use the OPUS_RESET_STATE CTL.
@param
in st OpusCustomEncoder*: Encoder state
@param in mode OpusCustomMode *: Contains all the information about the characteristics of
the stream (must be the same characteristics as used for the
decoder)
@param in channels int: Number of channels
@return OPUS_OK Success or @ref opus_errorcodes
-
opus_custom_mode_create(int Fs, int frame_size, Pointer<Int32> error)
→ Pointer<OpusCustomMode>
-
Creates a new mode struct. This will be passed to an encoder or
decoder. The mode MUST NOT BE DESTROYED until the encoders and
decoders that use it are destroyed as well.
@param
in Fs int: Sampling rate (8000 to 96000 Hz)
@param in frame_size int: Number of samples (per channel) to encode in each
packet (64 - 1024, prime factorization must contain zero or more 2s, 3s, or 5s and no other primes)
@param out error int*: Returned error code (if NULL, no error will be returned)
@return A newly created mode
-
opus_custom_mode_destroy(Pointer<OpusCustomMode> mode)
→ void
-
Destroys a mode struct. Only call this after all encoders and
decoders using this mode are destroyed as well.
@param
in mode OpusCustomMode*: Mode to be freed.
-
toString()
→ String
-
A string representation of this object.
inherited
