Class StreamRecorderAudioOptions

    Definition

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

    Specifies the options associated with audio recording.

    public class StreamRecorderAudioOptions
    Inheritance
    object
    StreamRecorderAudioOptions

    Constructors

    View Source

    StreamRecorderAudioOptions(RecorderAudioCodec, int, int, int)

    Initialize a new instance of the StreamRecorderAudioOptions class with the specified codec, sample rate, bit rate, and channel value.

    Declaration
    public StreamRecorderAudioOptions(RecorderAudioCodec codec, int sampleRate, int bitRate, int channels)
    Parameters
    Type Name Description
    RecorderAudioCodec codec

    The RecorderAudioCodec for encoding audio stream.

    int sampleRate

    The sample rate for encoding audio stream.

    int bitRate

    The bit rate for encoding audio stream.

    int channels

    The number of channels for encoding audio stream.

    Exceptions
    Type Condition
    System.ArgumentException

    codec is not valid.

    System.ArgumentOutOfRangeException

    sampleRate is less than zero.
    -or-
    bitRate is less than or equal to zero.
    -or-
    channels is less than or equal to zero.

    See Also
    StreamRecorder
    StreamRecorderOptions
    StreamRecorderVideoOptions
    View Source

    StreamRecorderAudioOptions(RecorderAudioCodec)

    Initialize a new instance of the StreamRecorderAudioOptions class with the specified codec.

    Declaration
    public StreamRecorderAudioOptions(RecorderAudioCodec codec)
    Parameters
    Type Name Description
    RecorderAudioCodec codec

    The RecorderAudioCodec for encoding audio stream.

    Remarks

    SampleRate, BitRate and Channels will be set as default.

    Exceptions
    Type Condition
    System.ArgumentException

    codec is not valid.

    See Also
    StreamRecorder
    StreamRecorderOptions
    StreamRecorderVideoOptions

    Properties

    View Source

    BitRate

    Gets or sets the bit rate of the audio encoder in bits per second.

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

    The bit rate value for audio stream recording. The default is 128000.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    value is less than or equal to zero.

    See Also
    StreamRecorder
    StreamRecorderOptions
    StreamRecorderVideoOptions
    View Source

    Channels

    Gets or sets the number of audio channels.

    Declaration
    public int Channels { get; set; }
    Property Value
    Type Description
    int

    The number of audio channels for audio stream recording. The default is 2.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    value is less than or equal to zero.

    See Also
    StreamRecorder
    StreamRecorderOptions
    StreamRecorderVideoOptions
    View Source

    Codec

    Gets or sets the audio codec for encoding an audio stream.

    Declaration
    public RecorderAudioCodec Codec { get; set; }
    Property Value
    Type Description
    RecorderAudioCodec

    The codec for audio stream recording.

    Exceptions
    Type Condition
    System.ArgumentException

    value is not valid.

    See Also
    GetSupportedAudioCodecs()
    View Source

    SampleRate

    Gets or sets the sampling rate of the audio stream in hertz.

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

    The sample rate value for stream recorder. The default is zero.

    Remarks

    If the value is zero, the sample rate will be decided based on input buffers.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    value is less than zero.

    See Also
    StreamRecorder
    StreamRecorderOptions
    StreamRecorderVideoOptions

    See Also

    StreamRecorder
    StreamRecorderOptions
    StreamRecorderVideoOptions
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX