Class VideoMediaFormat

Definition

Namespace:
Tizen.Multimedia
Assembly:
Tizen.Multimedia.dll
API Level:
3

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

C#
Copy
public sealed class VideoMediaFormat : MediaFormat
Inheritance
System.Object
VideoMediaFormat

Constructors

View Source

VideoMediaFormat(MediaFormatVideoMimeType, Int32, Int32)

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

Declaration
C#
Copy
public VideoMediaFormat(MediaFormatVideoMimeType mimeType, int width, int height)
Parameters
Type Name Description
MediaFormatVideoMimeType mimeType

The mime type of the format.

System.Int32 width

The width value of the format.

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

API Level: 3
View Source

VideoMediaFormat(MediaFormatVideoMimeType, Int32, Int32, Int32)

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

Declaration
C#
Copy
public VideoMediaFormat(MediaFormatVideoMimeType mimeType, int width, int height, int frameRate)
Parameters
Type Name Description
MediaFormatVideoMimeType mimeType

The mime type of the format.

System.Int32 width

The width value of the format.

System.Int32 height

The height value of the format

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

API Level: 3
View Source

VideoMediaFormat(MediaFormatVideoMimeType, Int32, Int32, Int32, Int32)

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

Declaration
C#
Copy
public VideoMediaFormat(MediaFormatVideoMimeType mimeType, int width, int height, int frameRate, int bitRate)
Parameters
Type Name Description
MediaFormatVideoMimeType mimeType

The mime type of the format.

System.Int32 width

The width value of the format.

System.Int32 height

The height value of the format

System.Int32 frameRate

The frame rate of the format.

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

API Level: 3
View Source

VideoMediaFormat(MediaFormatVideoMimeType, Int32, Int32, Int32, Int32, Int32)

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

Declaration
C#
Copy
public VideoMediaFormat(MediaFormatVideoMimeType mimeType, int width, int height, int frameRate, int bitRate, int maxBps)
Parameters
Type Name Description
MediaFormatVideoMimeType mimeType

The mime type of the format.

System.Int32 width

The width value of the format.

System.Int32 height

The height value of the format

System.Int32 frameRate

The frame rate of the format.

System.Int32 bitRate

The bit rate of the format.

System.Int32 maxBps

The max bps of the format.

Exceptions
Type Condition
System.ArgumentException

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

System.ArgumentOutOfRangeException

width, height,
-or-
frameRate, or bitRate, or maxBps is less than zero.

API Level: 6
View Source

VideoMediaFormat(MediaFormatVideoMimeType, Size)

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

Declaration
C#
Copy
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.

API Level: 3
View Source

VideoMediaFormat(MediaFormatVideoMimeType, Size, Int32)

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

Declaration
C#
Copy
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.

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

API Level: 3
View Source

VideoMediaFormat(MediaFormatVideoMimeType, Size, Int32, Int32)

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

Declaration
C#
Copy
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.

System.Int32 frameRate

The frame rate of the format.

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

API Level: 3
View Source

VideoMediaFormat(MediaFormatVideoMimeType, Size, Int32, Int32, Int32)

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

Declaration
C#
Copy
public VideoMediaFormat(MediaFormatVideoMimeType mimeType, Size size, int frameRate, int bitRate, int maxBps)
Parameters
Type Name Description
MediaFormatVideoMimeType mimeType

The mime type of the format.

Size size

The size of the format.

System.Int32 frameRate

The frame rate of the format.

System.Int32 bitRate

The bit rate of the format.

System.Int32 maxBps

The max bps 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. -or-
maxBps is less than zero.

API Level: 6

Properties

View Source

BitRate

Gets the bit rate value of the current format.

Declaration
C#
Copy
public int BitRate { get; }
Property Value
Type Description
System.Int32
API Level: 3
View Source

FrameRate

Gets the frame rate value of the current format.

Declaration
C#
Copy
public int FrameRate { get; }
Property Value
Type Description
System.Int32
API Level: 3
View Source

MaxBps

Gets the max bps value of the current format.

Declaration
C#
Copy
public int MaxBps { get; }
Property Value
Type Description
System.Int32
API Level: 6
View Source

MimeType

Gets the mime type of the current format.

Declaration
C#
Copy
public MediaFormatVideoMimeType MimeType { get; }
Property Value
Type Description
MediaFormatVideoMimeType
API Level: 3
View Source

Size

Gets the size of the current format.

Declaration
C#
Copy
public Size Size { get; }
Property Value
Type Description
Size
API Level: 3

Methods

View Source

Equals(Object)

Compares an object to an instance of VideoMediaFormat for equality.

Declaration
C#
Copy
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

A System.Object to compare.

Returns
Type Description
System.Boolean

true if the formats are equal; otherwise, false.

Overrides
System.Object.Equals(System.Object)
API Level: 3
View Source

GetHashCode()

Gets the hash code for this instance of VideoMediaFormat.

Declaration
C#
Copy
public override int GetHashCode()
Returns
Type Description
System.Int32

The hash code for this instance of VideoMediaFormat.

Overrides
System.Object.GetHashCode()
API Level: 3
View Source

ToString()

Returns a string that represents the current object.

Declaration
C#
Copy
public override string ToString()
Returns
Type Description
System.String

A string that represents the current object.

Overrides
System.Object.ToString()
API Level: 3