Class AudioMediaFormat

    Definition

    Namespace:
    Tizen.Multimedia
    Assembly:
    Tizen.Multimedia.dll

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

    public sealed class AudioMediaFormat : MediaFormat
    Inheritance
    object
    MediaFormat
    AudioMediaFormat

    Constructors

    View Source

    AudioMediaFormat(MediaFormatAudioMimeType, int, int, int, int, int, 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.

    int channel

    The channel value of the format.

    int sampleRate

    The sample rate value of the format.

    int bit

    The bit value of the format.

    int bitRate

    The bit rate value of the format.

    int bitDepth

    The bit depth value of the PCM audio format.

    System.Collections.Generic.IList<T><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
    System.ArgumentException

    mimeType is invalid (i.e. undefined value).

    System.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.

    System.ArgumentOutOfRangeException

    channel, sampleRate, bit, or bitRate, bitDepth is less than zero.

    View Source

    AudioMediaFormat(MediaFormatAudioMimeType, int, int, int, int, MediaFormatAacType, int, 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.

    int channel

    The channel value of the format.

    int sampleRate

    The sample rate value of the format.

    int bit

    The bit value of the format.

    int bitRate

    The bit rate value of the format.

    MediaFormatAacType aacType

    The AAC bitstream format(ADIF or ADTS).

    int bitDepth

    The bit depth value of the PCM audio format.

    System.Collections.Generic.IList<T><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
    System.ArgumentException

    mimeType or aacType is invalid (i.e. undefined value).
    -or-
    aacType is not None, but mimeType is one of the AAC types.

    System.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.

    System.ArgumentOutOfRangeException

    channel, sampleRate, bit, or bitRate, bitDepth is less than zero.

    View Source

    AudioMediaFormat(MediaFormatAudioMimeType, int, int, int, int, 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.

    int channel

    The channel value of the format.

    int sampleRate

    The sample rate value of the format.

    int bit

    The bit value of the format.

    int bitRate

    The bit rate value of the format.

    MediaFormatAacType aacType

    The AAC bitstream format(ADIF or ADTS).

    Exceptions
    Type Condition
    System.ArgumentException

    mimeType or aacType is invalid (i.e. undefined value).
    -or-
    aacType is not None, but mimeType is one of the AAC types.

    System.ArgumentOutOfRangeException

    channel, sampleRate, bit, or bitRate is less than zero.

    View Source

    AudioMediaFormat(MediaFormatAudioMimeType, int, int, int, int)

    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.

    int channel

    The channel value of the format.

    int sampleRate

    The sample rate value of the format.

    int bit

    The bit value of the format.

    int bitRate

    The bit rate value of the format.

    Exceptions
    Type Condition
    System.ArgumentException

    mimeType is invalid(i.e. undefined value).

    System.ArgumentOutOfRangeException

    channel, sampleRate, bit, or bitRate is less than zero.

    Properties

    View Source

    AacType

    Gets the AAC type of the current format.

    Declaration
    public MediaFormatAacType AacType { get; }
    Property Value
    Type Description
    MediaFormatAacType
    View Source

    AudioChannelMap

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

    Declaration
    public ReadOnlyCollection<MediaFormatAudioChannelPosition> AudioChannelMap { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ReadOnlyCollection<T><MediaFormatAudioChannelPosition>
    Remarks

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

    See Also
    Channel
    MediaFormatAudioChannelPosition
    View Source

    Bit

    Gets the bit value of the current format.

    Declaration
    public int Bit { get; }
    Property Value
    Type Description
    int
    View Source

    BitDepth

    Gets the bit depth value of the current format.

    Declaration
    public int BitDepth { get; }
    Property Value
    Type Description
    int
    View Source

    BitRate

    Gets the bit rate value of the current format.

    Declaration
    public int BitRate { get; }
    Property Value
    Type Description
    int
    View Source

    Channel

    Gets the channel value of the current format.

    Declaration
    public int Channel { get; }
    Property Value
    Type Description
    int
    View Source

    MimeType

    Gets the mime type of the current format.

    Declaration
    public MediaFormatAudioMimeType MimeType { get; }
    Property Value
    Type Description
    MediaFormatAudioMimeType
    View Source

    SampleRate

    Gets the sample rate value of the current format.

    Declaration
    public int SampleRate { get; }
    Property Value
    Type Description
    int

    Methods

    View Source

    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
    bool

    true if the formats are equal; otherwise, false.

    Overrides
    object.Equals(object)
    View Source

    GetHashCode()

    Gets the hash code for this instance of AudioMediaFormat.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    The hash code for this instance of AudioMediaFormat.

    Overrides
    object.GetHashCode()
    View Source

    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()
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX