Class StreamRecorderAudioOptions

Definition

Namespace:
Tizen.Multimedia
Assembly:
Tizen.Multimedia.StreamRecorder.dll
API Level:
4

Specifies the options associated with audio recording.

public class StreamRecorderAudioOptions
Inheritance
Object
StreamRecorderAudioOptions

Constructors

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
ArgumentException

codec is not valid.
API Level: 4
View Source

StreamRecorderAudioOptions(RecorderAudioCodec, Int32, Int32, Int32)

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.
Int32 sampleRate

The sample rate for encoding audio stream.
Int32 bitRate

The bit rate for encoding audio stream.
Int32 channels

The number of channels for encoding audio stream.
Exceptions
Type Condition
ArgumentException

codec is not valid.
ArgumentOutOfRangeException

sampleRate is less than zero.
-or-
bitRate is less than or equal to zero.
-or-
channels is less than or equal to zero.
API Level: 4

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
Int32

The bit rate value for audio stream recording. The default is 128000.
Exceptions
Type Condition
ArgumentOutOfRangeException

value is less than or equal to zero.
API Level: 4
View Source

Channels

Gets or sets the number of audio channels.

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

The number of audio channels for audio stream recording. The default is 2.
Exceptions
Type Condition
ArgumentOutOfRangeException

value is less than or equal to zero.
API Level: 4
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
ArgumentException

value is not valid.
See Also
API Level: 4
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
Int32

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
ArgumentOutOfRangeException

value is less than zero.
API Level: 4

See Also