Share via


AudioConverter Class

Definition

The linear PCM audio formats converter.

public class AudioConverter : ObjCRuntime.DisposableObject
type AudioConverter = class
    inherit DisposableObject
Inheritance
AudioConverter

Properties

Name Description
ApplicableEncodeBitRates

All applicable bit rates based on current settings.

ApplicableEncodeSampleRates

All applicable sample rates based on current settings.

AvailableEncodeBitRates

All available bit rates for the input format.

AvailableEncodeChannelLayoutTags

All audio channel layouts for the input format.

AvailableEncodeSampleRates

All applicable sample rates based on current settings.

BitDepthHint

The source bit depth to preserve.

CalculateInputBufferSize

On input, the desired size (in bytes) of the output data. On output, the size (in bytes) of the input required to generate the desired output data size.

CalculateOutputBufferSize

On input, the desired size (in bytes) of the input data. On output, the size (in bytes) of the output data that will be generated from the desired input data size.

CanResumeFromInterruption

The underlying codec supports resumption following an interruption.

ChannelMap

Input to Output channel mapping.

ChannelMixMap

An array of gain values to apply to input and output channels. Each gain value is a value between 0.0 and 1.0.

CodecQuality

Rendering quality of the converter codec.

CompressionMagicCookie

Gets or sets a magic cookie that is used for compression.

CurrentInputStreamDescription

Completely filled input audio description.

CurrentOutputStreamDescription

Completely filled output audio description.

DecodeFormats

All valid converter input formats.

DecompressionMagicCookie

Gets or sets a magic cookie that is used for decompression.

EncodeAdjustableSampleRate

An an output sample rate.

EncodeBitRate

The number of bits per second to aim for when encoding data.

EncodeFormats

All valid converter output formats.

FormatList

All the data formats produced by the converter encoder.

Handle (Inherited from DisposableObject)
InputChannelLayout

Input audio channels layout.

MaximumInputPacketSize

The size in bytes of the largest single packet of data in the input format.

MaximumOutputPacketSize

The size in bytes of the largest single packet of data in the output format.

MinimumInputBufferSize

The size in bytes of the smallest buffer of input data.

MinimumOutputBufferSize

The size in bytes of the smallest buffer of output data.

OutputChannelLayout

Output audio channels layout.

Owns (Inherited from DisposableObject)
PerformDownmix

Whether to perform a mix from input to output channels.

PrimeInfo

The priming method.

PrimeMethod

The priming information for converter's priming method.

SampleRateConverterComplexity

The sample rate converter algorithm.

SampleRateConverterInitialPhase

The initial sub-sample position of the sample rate converter.

SampleRateConverterQuality

The rendering quality of the sample rate converter.

Methods

Name Description
ClearHandle() (Inherited from DisposableObject)
ConvertBuffer(Byte[], Byte[])

Converts audio data from one linear PCM format to another.

ConvertComplexBuffer(Int32, AudioBuffers, AudioBuffers)

Converts audio data from one linear PCM format to another where both use the same sample rate.

Create(AudioStreamBasicDescription, AudioStreamBasicDescription, AudioClassDescription[])

Creates a new audio converter instance using a specified codec.

Create(AudioStreamBasicDescription, AudioStreamBasicDescription, AudioConverterError)

Creates a new audio converter instance using a specified codec.

Create(AudioStreamBasicDescription, AudioStreamBasicDescription, AudioConverterOptions, AudioConverterError)

Create a new AudioConverter with the specified options.

Create(AudioStreamBasicDescription, AudioStreamBasicDescription, AudioConverterOptions)

Create a new AudioConverter with the specified options.

Create(AudioStreamBasicDescription, AudioStreamBasicDescription)

Creates a new audio converter instance based on specified audio formats.

Dispose() (Inherited from DisposableObject)
Dispose(Boolean)

Releases the resources used by the AudioConverter object.

Equals(Object) (Inherited from DisposableObject)
FillComplexBuffer(Int32, AudioBuffers, AudioStreamPacketDescription[], AudioConverterComplexInputData, AudioStreamPacketDependencyDescription[])

Converts audio data, supplied by a callback function, supporting packet dependencies.

FillComplexBuffer(Int32, AudioBuffers, AudioStreamPacketDescription[], AudioConverterComplexInputData)

Converts audio data supporting non-interleaved and packetized formats.

FillComplexBuffer(Int32, AudioBuffers, AudioStreamPacketDescription[], AudioStreamPacketDependencyDescription[])

Converts audio data, supplied by an event handler, supporting packet dependencies.

FillComplexBuffer(Int32, AudioBuffers, AudioStreamPacketDescription[])

Converts audio data supporting non-interleaved and packetized formats.

GetCheckedHandle() (Inherited from DisposableObject)
GetHashCode() (Inherited from DisposableObject)
InitializeHandle(NativeHandle) (Inherited from DisposableObject)
Prepare(AudioConverter+PrepareCompletionCallback)

Optimizes any subsequent creation of audio converters in this process.

Prepare(UInt32, IntPtr, AudioConverter+PrepareCompletionCallback)

Optimizes any subsequent creation of audio converters in this process.

Reset()

Resets an audio converter.

Events

Name Description
InputData

Extension Methods

Name Description
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)

Applies to