Class AudioMediaFormat

Definition

Namespace:

Tizen.Multimedia

Assembly:

Tizen.Multimedia.dll

API Level:

3

Represents an audio media format. This class cannot be inherited.

public sealed class AudioMediaFormat : MediaFormat

Inheritance

Object

MediaFormat

AudioMediaFormat

Constructors

AudioMediaFormat(MediaFormatAudioMimeType, Int32, Int32, Int32, Int32)

Initializes a new instance of the AudioMediaFormat class with the specified mime type, channel, sample rate, bit, and bit rate.

Declaration

public AudioMediaFormat(MediaFormatAudioMimeType mimeType, int channel, int sampleRate, int bit, int bitRate)

Parameters

Type	Name	Description
MediaFormatAudioMimeType	mimeType	The mime type of the format.
Int32	channel	The channel value of the format.
Int32	sampleRate	The sample rate value of the format.
Int32	bit	The bit value of the format.
Int32	bitRate	The bit rate value of the format.

Exceptions

Type	Condition
ArgumentException	mimeType is invalid(i.e. undefined value).
ArgumentOutOfRangeException	channel, sampleRate, bit, or bitRate is less than zero.

API Level: 3

AudioMediaFormat(MediaFormatAudioMimeType, Int32, Int32, Int32, Int32, Int32, IList<MediaFormatAudioChannelPosition>)

Initializes a new instance of the AudioMediaFormat class with the specified mime type, channel, sample rate, bit, bit rate, bit depth, and audio channel map.

Declaration

public AudioMediaFormat(MediaFormatAudioMimeType mimeType, int channel, int sampleRate, int bit, int bitRate, int bitDepth, IList<MediaFormatAudioChannelPosition> audioChannelMap)

Parameters

Type	Name	Description
MediaFormatAudioMimeType	mimeType	The mime type of the format.
Int32	channel	The channel value of the format.
Int32	sampleRate	The sample rate value of the format.
Int32	bit	The bit value of the format.
Int32	bitRate	The bit rate value of the format.
Int32	bitDepth	The bit depth value of the PCM audio format.
IList<MediaFormatAudioChannelPosition>	audioChannelMap	The loudspeaker position in PCM audio format.

Remarks

If audioChannelMap contains None, channel should be set greater than 0.
If audioChannelMap contains Mono, channel should be set 1.
User can not set None with another channel positions.
User can not set Mono with another channel positions.
If same channel position is added in audioChannelMap more than once, the duplicaiton will be removed.

Exceptions

Type	Condition
ArgumentException	mimeType is invalid (i.e. undefined value).
ArgumentException	audioChannelMap is invalid or mismatched with channel like the following: audioChannelMap is not matched correctly with channel. -or- audioChannelMap is set to Invaild. -or- Mono or None is set with another channel position.
ArgumentOutOfRangeException	channel, sampleRate, bit, or bitRate, bitDepth is less than zero.

API Level: 6

AudioMediaFormat(MediaFormatAudioMimeType, Int32, Int32, Int32, Int32, MediaFormatAacType)

Initializes a new instance of the AudioMediaFormat class with the specified mime type, channel, sample rate, bit, bit rate, and AAC type.

Declaration

public AudioMediaFormat(MediaFormatAudioMimeType mimeType, int channel, int sampleRate, int bit, int bitRate, MediaFormatAacType aacType)

Parameters

Type	Name	Description
MediaFormatAudioMimeType	mimeType	The mime type of the format.
Int32	channel	The channel value of the format.
Int32	sampleRate	The sample rate value of the format.
Int32	bit	The bit value of the format.
Int32	bitRate	The bit rate value of the format.
MediaFormatAacType	aacType	The AAC bitstream format(ADIF or ADTS).

Exceptions

Type	Condition
ArgumentException	mimeType or aacType is invalid (i.e. undefined value). -or- aacType is not None, but mimeType is one of the AAC types.
ArgumentOutOfRangeException	channel, sampleRate, bit, or bitRate is less than zero.

API Level: 3

AudioMediaFormat(MediaFormatAudioMimeType, Int32, Int32, Int32, Int32, MediaFormatAacType, Int32, IList<MediaFormatAudioChannelPosition>)

Initializes a new instance of the AudioMediaFormat class with the specified mime type, channel, sample rate, bit, bit rate, bit depth, and audio channel map.

Declaration

public AudioMediaFormat(MediaFormatAudioMimeType mimeType, int channel, int sampleRate, int bit, int bitRate, MediaFormatAacType aacType, int bitDepth, IList<MediaFormatAudioChannelPosition> audioChannelMap)

Parameters

Type	Name	Description
MediaFormatAudioMimeType	mimeType	The mime type of the format.
Int32	channel	The channel value of the format.
Int32	sampleRate	The sample rate value of the format.
Int32	bit	The bit value of the format.
Int32	bitRate	The bit rate value of the format.
MediaFormatAacType	aacType	The AAC bitstream format(ADIF or ADTS).
Int32	bitDepth	The bit depth value of the PCM audio format.
IList<MediaFormatAudioChannelPosition>	audioChannelMap	The loudspeaker position in PCM audio format.

Remarks

If audioChannelMap contains None, channel should be set greater than 0.
If audioChannelMap contains Mono, channel should be set 1.
User can not set None with another channel positions.
User can not set Mono with another channel positions.
If same channel position is added in audioChannelMap more than twice, its duplicaiton will be removed.

Exceptions

Type	Condition
ArgumentException	mimeType or aacType is invalid (i.e. undefined value). -or- aacType is not None, but mimeType is one of the AAC types.
ArgumentException	audioChannelMap is invalid or mismatched with channel like the following: audioChannelMap is not matched correctly with channel. -or- audioChannelMap is set to Invaild. -or- Mono or None is set with another channel position.
ArgumentOutOfRangeException	channel, sampleRate, bit, or bitRate, bitDepth is less than zero.

API Level: 6

Properties

AacType

Gets the AAC type of the current format.

Declaration

public MediaFormatAacType AacType { get; }

Property Value

Type	Description
MediaFormatAacType

API Level: 3

AudioChannelMap

Gets or sets the list of channel position value of PCM audio format.

Declaration

public ReadOnlyCollection<MediaFormatAudioChannelPosition> AudioChannelMap { get; }

Property Value

Type	Description
ReadOnlyCollection<MediaFormatAudioChannelPosition>

Remarks

The channel mask specifies the mapping of channels to speakers. default value is 0.

See Also

Channel

MediaFormatAudioChannelPosition

API Level: 6

Bit

Gets the bit value of the current format.

Declaration

public int Bit { get; }

Property Value

Type	Description
Int32

API Level: 3

BitDepth

Gets the bit depth value of the current format.

Declaration

public int BitDepth { get; }

Property Value

Type	Description
Int32

API Level: 6

BitRate

Gets the bit rate value of the current format.

Declaration

public int BitRate { get; }

Property Value

Type	Description
Int32

API Level: 3

Channel

Gets the channel value of the current format.

Declaration

public int Channel { get; }

Property Value

Type	Description
Int32

API Level: 3

MimeType

Gets the mime type of the current format.

Declaration

public MediaFormatAudioMimeType MimeType { get; }

Property Value

Type	Description
MediaFormatAudioMimeType

API Level: 3

SampleRate

Gets the sample rate value of the current format.

Declaration

public int SampleRate { get; }

Property Value

Type	Description
Int32

API Level: 3

Methods

Equals(Object)

Compares an object to an instance of AudioMediaFormat for equality.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	A Object to compare.

Returns

Type	Description
Boolean	true if the formats are equal; otherwise, false.

Overrides

Object.Equals(Object)

API Level: 3

GetHashCode()

Gets the hash code for this instance of AudioMediaFormat.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	The hash code for this instance of AudioMediaFormat.

Overrides

Object.GetHashCode()

API Level: 3

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
String	A string that represents the current object.

Overrides

Object.ToString()

API Level: 3