AudioConverter.Create Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| Create(AudioStreamBasicDescription, AudioStreamBasicDescription) |
Creates a new audio converter instance based on specified audio formats. |
| 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) |
Create a new AudioConverter with the specified options. |
| Create(AudioStreamBasicDescription, AudioStreamBasicDescription, AudioConverterOptions, AudioConverterError) |
Create a new AudioConverter with the specified options. |
Create(AudioStreamBasicDescription, AudioStreamBasicDescription)
Creates a new audio converter instance based on specified audio formats.
public static AudioToolbox.AudioConverter? Create(AudioToolbox.AudioStreamBasicDescription sourceFormat, AudioToolbox.AudioStreamBasicDescription destinationFormat);
static member Create : AudioToolbox.AudioStreamBasicDescription * AudioToolbox.AudioStreamBasicDescription -> AudioToolbox.AudioConverter
Parameters
- sourceFormat
- AudioStreamBasicDescription
Input audio format.
- destinationFormat
- AudioStreamBasicDescription
Output audio format.
Returns
A new AudioConverter instance if successful, null otherwise.
Applies to
Create(AudioStreamBasicDescription, AudioStreamBasicDescription, AudioClassDescription[])
Creates a new audio converter instance using a specified codec.
public static AudioToolbox.AudioConverter? Create(AudioToolbox.AudioStreamBasicDescription sourceFormat, AudioToolbox.AudioStreamBasicDescription destinationFormat, AudioToolbox.AudioClassDescription[] descriptions);
static member Create : AudioToolbox.AudioStreamBasicDescription * AudioToolbox.AudioStreamBasicDescription * AudioToolbox.AudioClassDescription[] -> AudioToolbox.AudioConverter
Parameters
- sourceFormat
- AudioStreamBasicDescription
Input audio format.
- destinationFormat
- AudioStreamBasicDescription
Output audio format.
- descriptions
- AudioClassDescription[]
A list of codec to be used.
Returns
A new AudioConverter instance if successful, null otherwise.
Applies to
Create(AudioStreamBasicDescription, AudioStreamBasicDescription, AudioConverterError)
Creates a new audio converter instance using a specified codec.
public static AudioToolbox.AudioConverter? Create(AudioToolbox.AudioStreamBasicDescription sourceFormat, AudioToolbox.AudioStreamBasicDescription destinationFormat, out AudioToolbox.AudioConverterError error);
static member Create : AudioToolbox.AudioStreamBasicDescription * AudioToolbox.AudioStreamBasicDescription * AudioConverterError -> AudioToolbox.AudioConverter
Parameters
- sourceFormat
- AudioStreamBasicDescription
The format of the source audio.
- destinationFormat
- AudioStreamBasicDescription
The destination audio format.
- error
- AudioConverterError
In case of failure, will contain the error code for the failure. Otherwise the value None will be returned.
Returns
A new AudioConverter instance if successful, null otherwise.
Applies to
Create(AudioStreamBasicDescription, AudioStreamBasicDescription, AudioConverterOptions)
Create a new AudioConverter with the specified options.
public static AudioToolbox.AudioConverter? Create(AudioToolbox.AudioStreamBasicDescription sourceFormat, AudioToolbox.AudioStreamBasicDescription destinationFormat, AudioToolbox.AudioConverterOptions options);
static member Create : AudioToolbox.AudioStreamBasicDescription * AudioToolbox.AudioStreamBasicDescription * AudioToolbox.AudioConverterOptions -> AudioToolbox.AudioConverter
Parameters
- sourceFormat
- AudioStreamBasicDescription
The format of the source audio to be converted.
- destinationFormat
- AudioStreamBasicDescription
The format to convert the source audio to.
- options
- AudioConverterOptions
Any AudioConverterOptions to use.
Returns
A new AudioConverter instance, or null in case of failure.
Applies to
Create(AudioStreamBasicDescription, AudioStreamBasicDescription, AudioConverterOptions, AudioConverterError)
Create a new AudioConverter with the specified options.
public static AudioToolbox.AudioConverter? Create(AudioToolbox.AudioStreamBasicDescription sourceFormat, AudioToolbox.AudioStreamBasicDescription destinationFormat, AudioToolbox.AudioConverterOptions options, out AudioToolbox.AudioConverterError error);
static member Create : AudioToolbox.AudioStreamBasicDescription * AudioToolbox.AudioStreamBasicDescription * AudioToolbox.AudioConverterOptions * AudioConverterError -> AudioToolbox.AudioConverter
Parameters
- sourceFormat
- AudioStreamBasicDescription
The format of the source audio to be converted.
- destinationFormat
- AudioStreamBasicDescription
The format to convert the source audio to.
- options
- AudioConverterOptions
Any AudioConverterOptions to use.
- error
- AudioConverterError
In case of failure, will contain the error code for the failure. Otherwise the value None will be returned.
Returns
A new AudioConverter instance, or null in case of failure.