Class OpusDecoderExtensions

Contains the OpusDecoder helper extensions.

Inheritance
object
OpusDecoderExtensions
Inherited Members
Namespace: OpusSharp.Core.Extensions
Assembly: OpusSharp.Core.dll
Syntax
public static class OpusDecoderExtensions
Remarks

OPUS_SET_COMPLEXITY and OPUS_GET_COMPLEXITY have not been added since they aren't documented yet in the opus documentation.

Methods

| Edit this page View Source

GetBandwidth(IOpusDecoder)

Gets the decoder's last bandpass.

Declaration
public static OpusPredefinedValues GetBandwidth(this IOpusDecoder decoder)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
Returns
Type Description
OpusPredefinedValues

The decoder's last bandpass.
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

GetFinalRange(IOpusDecoder)

Gets the final state of the codec's entropy coder.

Declaration
public static uint GetFinalRange(this IOpusDecoder decoder)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
Returns
Type Description
uint

The final state of the codec's entropy coder.
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

GetGain(IOpusDecoder)

Gets the gain for an opus decoder.

Declaration
public static int GetGain(this IOpusDecoder decoder)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
Returns
Type Description
int

The gain for the opus decoder.
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

GetIgnoreExtensions(IOpusDecoder)

Determines whether the decoder is ignoring extensions found in the padding area.

Declaration
public static bool GetIgnoreExtensions(this IOpusDecoder decoder)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
Returns
Type Description
bool

Whether the decoder is ignoring extensions.
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

GetLastPacketDuration(IOpusDecoder)

Gets the duration (in samples) of the last packet successfully decoded or concealed.

Declaration
public static int GetLastPacketDuration(this IOpusDecoder decoder)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
Returns
Type Description
int

The last packet duration (in samples).
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

GetOsceBwe(IOpusDecoder)

Determines whether the decoder's OSCE BWE module is enabled or not.

Declaration
public static bool GetOsceBwe(this IOpusDecoder decoder)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
Returns
Type Description
bool

Whether the OSCE BWE module is enabled or not.
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

GetPhaseInversionDisabled(IOpusDecoder)

Gets the decoder's configured phase inversion status.

Declaration
public static bool GetPhaseInversionDisabled(this IOpusDecoder decoder)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
Returns
Type Description
bool

Whether the phase inversion is disabled or not.
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

GetPitch(IOpusDecoder)

Gets the pitch of the last decoded frame, if available.

Declaration
public static int GetPitch(this IOpusDecoder decoder)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
Returns
Type Description
int

The pitch of the last decoded frame if available.
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

GetSampleRate(IOpusDecoder)

Gets the sampling rate the decoder was initialized with.

Declaration
public static int GetSampleRate(this IOpusDecoder decoder)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
Returns
Type Description
int

The decoder's configured sample rate.
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

Reset(IOpusDecoder)

Resets the codec state to be equivalent to a freshly initialized state.

Declaration
public static void Reset(this IOpusDecoder decoder)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

SetGain(IOpusDecoder, short)

Sets gain for an opus decoder.

Declaration
public static void SetGain(this IOpusDecoder decoder, short gain)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
short gain

The gain to set.
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

SetIgnoreExtensions(IOpusDecoder, bool)

Sets whether the decoder should ignore extensions in the padding area.

Declaration
public static void SetIgnoreExtensions(this IOpusDecoder decoder, bool disabled)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
bool disabled

Whether to disable all found extensions in the padding area.
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

SetOsceBwe(IOpusDecoder, bool)

Enables or disables the decoder's OSCE BWE module.

Declaration
public static void SetOsceBwe(this IOpusDecoder decoder, bool enabled)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
bool enabled

Whether to enable or disable the OSCE BWE module.
Exceptions
Type Condition
OpusException
ObjectDisposedException
| Edit this page View Source

SetPhaseInversionDisabled(IOpusDecoder, bool)

If set to true, disables the use of phase inversion for intensity stereo, improving the quality of mono down-mixes, but slightly reducing normal stereo quality.

Declaration
public static void SetPhaseInversionDisabled(this IOpusDecoder decoder, bool disabled)
Parameters
Type Name Description
IOpusDecoder decoder

The decoder state.
bool disabled

Whether to disable or not.
Exceptions
Type Condition
OpusException
ObjectDisposedException