Class StreamRecorderVideoOptions

Definition

Namespace:

Tizen.Multimedia

Assembly:

Tizen.Multimedia.StreamRecorder.dll

API Level:

4

Specifies the options associated with video recording.

public class StreamRecorderVideoOptions

Inheritance

Object

StreamRecorderVideoOptions

Constructors

StreamRecorderVideoOptions(RecorderVideoCodec, Size, StreamRecorderVideoFormat, Int32)

Initialize a new instance of the StreamRecorderVideoOptions class with the specified codec, resolution, source format, and frame rate.

Declaration

public StreamRecorderVideoOptions(RecorderVideoCodec codec, Size resolution, StreamRecorderVideoFormat sourceFormat, int frameRate)

Parameters

Type	Name	Description
RecorderVideoCodec	codec	The RecorderVideoCodec for encoding video stream.
Size	resolution	The resolution of video recording.
StreamRecorderVideoFormat	sourceFormat	The format of source stream.
Int32	frameRate	The frame rate for encoding video stream.

Remarks

BitRate will be set as default.

Exceptions

Type	Condition
ArgumentException	codec is not valid. -or- sourceFormat is not valid.
ArgumentOutOfRangeException	Width or height of resolution is less than or equal to zero. -or- frameRate is less than or equal to zero.

API Level: 4

StreamRecorderVideoOptions(RecorderVideoCodec, Size, StreamRecorderVideoFormat, Int32, Int32)

Initialize a new instance of the StreamRecorderVideoOptions class with the specified codec, resolution, source format, frame rate, and bit rate.

Declaration

public StreamRecorderVideoOptions(RecorderVideoCodec codec, Size resolution, StreamRecorderVideoFormat sourceFormat, int frameRate, int bitRate)

Parameters

Type	Name	Description
RecorderVideoCodec	codec	The RecorderVideoCodec for encoding video stream.
Size	resolution	The resolution of video recording.
StreamRecorderVideoFormat	sourceFormat	The format of source stream.
Int32	frameRate	The frame rate for encoding video stream.
Int32	bitRate	The bit rate for encoding video stream.

Exceptions

Type	Condition
ArgumentException	codec is not valid. -or- sourceFormat is not valid.
ArgumentOutOfRangeException	Width or height of resolution is less than or equal to zero. -or- frameRate is less than or equal to zero. -or- bitRate is less than zero.

API Level: 4

Properties

BitRate

The bit rate of the video encoder in bits per second.

Declaration

public int BitRate { get; set; }

Property Value

Type	Description
Int32	The bit rate value for video stream recording. The default is 0.

Exceptions

Type	Condition
ArgumentOutOfRangeException	value is less than zero.

API Level: 4

Codec

Gets or sets the video codec for encoding video stream.

Declaration

public RecorderVideoCodec Codec { get; set; }

Property Value

Type	Description
RecorderVideoCodec	The codec for video stream recording.

Exceptions

Type	Condition
ArgumentException	value is not valid.

See Also

GetSupportedVideoCodecs()

API Level: 4

FrameRate

Gets or sets the frame rate for recording media stream.

Declaration

public int FrameRate { get; set; }

Property Value

Type	Description
Int32	The frame rate value for video stream recording.

Exceptions

Type	Condition
ArgumentOutOfRangeException	value is less than or equal to zero.

API Level: 4

Resolution

Gets or sets the resolution of the video recording.

Declaration

public Size Resolution { get; set; }

Property Value

Type	Description
Size	The output resolution for video stream recording.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Width or height of value is less than or equal to zero.

See Also

GetSupportedVideoResolutions()

API Level: 4

SourceFormat

Gets or sets the video source format for recording media stream.

Declaration

public StreamRecorderVideoFormat SourceFormat { get; set; }

Property Value

Type	Description
StreamRecorderVideoFormat	The source format of buffers for video stream recording.

Exceptions

Type	Condition
ArgumentException	value is not valid.

API Level: 4

See Also

StreamRecorder

StreamRecorderOptions

StreamRecorderAudioOptions