Class VideoMediaFormat

Definition

Namespace:

Tizen.Multimedia

Assembly:

Tizen.Multimedia.dll

Represents a video media format. This class cannot be inherited.

public sealed class VideoMediaFormat : MediaFormat

Inheritance

object

MediaFormat

VideoMediaFormat

Constructors

VideoMediaFormat(MediaFormatVideoMimeType, int, int, int, int)

Initializes a new instance of the VideoMediaFormat class with the specified mime type, width, height, frame rate, and bit rate.

Declaration

public VideoMediaFormat(MediaFormatVideoMimeType mimeType, int width, int height, int frameRate, int bitRate)

Parameters

Type	Name	Description
MediaFormatVideoMimeType	mimeType	The mime type of the format.
int	width	The width value of the format.
int	height	The height value of the format
int	frameRate	The frame rate of the format.
int	bitRate	The bit rate of the format.

Exceptions

Type	Condition
System.ArgumentException	mimeType is invalid (i.e. undefined value).
System.ArgumentOutOfRangeException	width, height, frameRate, or bitRate is less than zero.

VideoMediaFormat(MediaFormatVideoMimeType, int, int, int)

Initializes a new instance of the VideoMediaFormat class with the specified mime type, width, height, and frame rate.

Declaration

public VideoMediaFormat(MediaFormatVideoMimeType mimeType, int width, int height, int frameRate)

Parameters

Type	Name	Description
MediaFormatVideoMimeType	mimeType	The mime type of the format.
int	width	The width value of the format.
int	height	The height value of the format
int	frameRate	The frame rate of the format.

Exceptions

Type	Condition
System.ArgumentException	mimeType is invalid (i.e. undefined value).
System.ArgumentOutOfRangeException	width, height, or frameRate is less than zero.

VideoMediaFormat(MediaFormatVideoMimeType, int, int)

Initializes a new instance of the VideoMediaFormat class with the specified mime type, width, and height.

Declaration

public VideoMediaFormat(MediaFormatVideoMimeType mimeType, int width, int height)

Parameters

Type	Name	Description
MediaFormatVideoMimeType	mimeType	The mime type of the format.
int	width	The width value of the format.
int	height	The height value of the format

Exceptions

Type	Condition
System.ArgumentException	mimeType is invalid (i.e. undefined value).
System.ArgumentOutOfRangeException	width or height is less than zero.

VideoMediaFormat(MediaFormatVideoMimeType, Size, int, int)

Initializes a new instance of the VideoMediaFormat class with the specified mime type, size, frame rate, and bit rate.

Declaration

public VideoMediaFormat(MediaFormatVideoMimeType mimeType, Size size, int frameRate, int bitRate)

Parameters

Type	Name	Description
MediaFormatVideoMimeType	mimeType	The mime type of the format.
Size	size	The size of the format.
int	frameRate	The frame rate of the format.
int	bitRate	The bit rate of the format.

Exceptions

Type	Condition
System.ArgumentException	mimeType is invalid (i.e. undefined value).
System.ArgumentOutOfRangeException	The width or the height of size is less than zero. -or- frameRate is less than zero. -or- bitRate is less than zero.

VideoMediaFormat(MediaFormatVideoMimeType, Size, int)

Initializes a new instance of the VideoMediaFormat class with the specified mime type, width, height, and frame rate.

Declaration

public VideoMediaFormat(MediaFormatVideoMimeType mimeType, Size size, int frameRate)

Parameters

Type	Name	Description
MediaFormatVideoMimeType	mimeType	The mime type of the format.
Size	size	The video size of the format.
int	frameRate	The frame rate of the format.

Exceptions

Type	Condition
System.ArgumentException	mimeType is invalid (i.e. undefined value).
System.ArgumentOutOfRangeException	The width or the height of size is less than zero. -or- frameRate is less than zero.

VideoMediaFormat(MediaFormatVideoMimeType, Size)

Initializes a new instance of the VideoMediaFormat class with the specified mime type and size.

Declaration

public VideoMediaFormat(MediaFormatVideoMimeType mimeType, Size size)

Parameters

Type	Name	Description
MediaFormatVideoMimeType	mimeType	The mime type of the format.
Size	size	The size of the format.

Exceptions

Type	Condition
System.ArgumentException	mimeType is invalid (i.e. undefined value).
System.ArgumentOutOfRangeException	The width or the height of size is less than zero.

Properties

BitRate

Gets the bit rate value of the current format.

Declaration

public int BitRate { get; }

Property Value

Type	Description
int

FrameRate

Gets the frame rate value of the current format.

Declaration

public int FrameRate { get; }

Property Value

Type	Description
int

MimeType

Gets the mime type of the current format.

Declaration

public MediaFormatVideoMimeType MimeType { get; }

Property Value

Type	Description
MediaFormatVideoMimeType

Size

Gets the size of the current format.

Declaration

public Size Size { get; }

Property Value

Type	Description
Size

Methods

Equals(object)

Compares an object to an instance of VideoMediaFormat 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)

GetHashCode()

Gets the hash code for this instance of VideoMediaFormat.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	The hash code for this instance of VideoMediaFormat.

Overrides

object.GetHashCode()

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()