FMIceLinkVideoFormat Class Reference

Inherits from FMIceLinkMediaFormat : NSObject
Conforms to *
FMIceLinkVideoFormat
Declared in FMIceLinkVideoFormat.h
FMIceLinkVideoFormat.m

Overview

A video format.

+ abgr

Gets an ABGR video format.
+ (FMIceLinkVideoFormat *)abgr

Discussion

Gets an ABGR video format.

Declared In

FMIceLinkVideoFormat.h

+ abgrName

Gets the name of the ABGR video format ("ABGR"). Indicates that each pixel occupies 32 bits (8 bits for alpha, then 8 bits for blue, then8 bits for green, then 8 bits for red).
+ (NSString *)abgrName

Discussion

Gets the name of the ABGR video format ("ABGR"). Indicates that each pixel occupies 32 bits (8 bits for alpha, then 8 bits for blue, then8 bits for green, then 8 bits for red).

Declared In

FMIceLinkVideoFormat.h

+ argb

Gets an ARGB video format.
+ (FMIceLinkVideoFormat *)argb

Discussion

Gets an ARGB video format.

Declared In

FMIceLinkVideoFormat.h

+ argbName

Gets the name of the ARGB video format ("ARGB"). Indicates that each pixel occupies 32 bits (8 bits for alpha, then 8 bits for red, then 8 bits for green, then 8 bits for blue).
+ (NSString *)argbName

Discussion

Gets the name of the ARGB video format ("ARGB"). Indicates that each pixel occupies 32 bits (8 bits for alpha, then 8 bits for red, then 8 bits for green, then 8 bits for blue).

Declared In

FMIceLinkVideoFormat.h

+ bgr

Gets a BGR video format.
+ (FMIceLinkVideoFormat *)bgr

Discussion

Gets a BGR video format.

Declared In

FMIceLinkVideoFormat.h

+ bgra

Gets an BGRA video format.
+ (FMIceLinkVideoFormat *)bgra

Discussion

Gets an BGRA video format.

Declared In

FMIceLinkVideoFormat.h

+ bgraName

Gets the name of the BGRA video format ("BGRA"). Indicates that each pixel occupies 32 bits (8 bits for blue, then8 bits for green, then 8 bits for red, then 8 bits for alpha).
+ (NSString *)bgraName

Discussion

Gets the name of the BGRA video format ("BGRA"). Indicates that each pixel occupies 32 bits (8 bits for blue, then8 bits for green, then 8 bits for red, then 8 bits for alpha).

Declared In

FMIceLinkVideoFormat.h

+ bgrName

Gets the name of the BGR video format ("BGR"). Indicates that each pixel occupies 24 bits (8 bits for blue, then8 bits for green, then 8 bits for red).
+ (NSString *)bgrName

Discussion

Gets the name of the BGR video format ("BGR"). Indicates that each pixel occupies 24 bits (8 bits for blue, then8 bits for green, then 8 bits for red).

Declared In

FMIceLinkVideoFormat.h

– clone

Clones this instance.
- (FMIceLinkVideoFormat *)clone

Discussion

Clones this instance.

Declared In

FMIceLinkVideoFormat.h

– createInstance

Creates a new instance.
- (FMIceLinkVideoFormat *)createInstance

Discussion

Creates a new instance.

Declared In

FMIceLinkVideoFormat.h

+ formatNameToFourCCWithFormatName:

Converts a format name to its FourCC value.
+ (int)formatNameToFourCCWithFormatName:(NSString *)formatName

Parameters

formatName

The format name.

Return Value

The FourCC value, or 0 if the format name is not recognized.

Discussion

Converts a format name to its FourCC value.

Declared In

FMIceLinkVideoFormat.h

– fourCC

Gets the FourCC value for this format.
- (int)fourCC

Discussion

Gets the FourCC value for this format.

Declared In

FMIceLinkVideoFormat.h

– fourCCToFormatNameWithFourcc:

Converts a FourCC value to its format name.
- (NSString *)fourCCToFormatNameWithFourcc:(int)fourcc

Parameters

fourcc

The FourCC value.

Return Value

The format name, or an empty string if the FourCC value is not recognized.

Discussion

Converts a FourCC value to its format name.

Declared In

FMIceLinkVideoFormat.h

+ fromJsonWithVideoFormatJson:

Deserializes an instance from JSON.
+ (FMIceLinkVideoFormat *)fromJsonWithVideoFormatJson:(NSString *)videoFormatJson

Parameters

videoFormatJson

The video format JSON. @return

Discussion

Deserializes an instance from JSON.

Declared In

FMIceLinkVideoFormat.h

+ h264

Gets an H.264 video format.
+ (FMIceLinkVideoFormat *)h264

Discussion

Gets an H.264 video format.

Declared In

FMIceLinkVideoFormat.h

+ h264Name

Gets the name of the H.264 video format ("H264").
+ (NSString *)h264Name

Discussion

Gets the name of the H.264 video format ("H264").

Declared In

FMIceLinkVideoFormat.h

+ i420

Gets an I420 video format.
+ (FMIceLinkVideoFormat *)i420

Discussion

Gets an I420 video format.

Declared In

FMIceLinkVideoFormat.h

+ i420Name

Gets the name of the I420 video format ("I420"). Indicates that each pixel occupies 12 bits (8 bits for Y, 2 bits for U, and 2 bits for V). Y plane is followed by U plane and then V plane.
+ (NSString *)i420Name

Discussion

Gets the name of the I420 video format ("I420"). Indicates that each pixel occupies 12 bits (8 bits for Y, 2 bits for U, and 2 bits for V). Y plane is followed by U plane and then V plane.

Declared In

FMIceLinkVideoFormat.h

– init

Initializes a new instance of the FMIceLinkVideoFormat class.
- (instancetype)init

Discussion

Initializes a new instance of the FMIceLinkVideoFormat class.

Declared In

FMIceLinkVideoFormat.h

– initWithName:

Initializes a new instance of the FMIceLinkVideoFormat class.
- (instancetype)initWithName:(NSString *)name

Parameters

name

The name.

Discussion

Initializes a new instance of the FMIceLinkVideoFormat class.

Declared In

FMIceLinkVideoFormat.h

– initWithName:clockRate:

Initializes a new instance of the FMIceLinkVideoFormat class.
- (instancetype)initWithName:(NSString *)name clockRate:(int)clockRate

Parameters

name

The name.
clockRate

The clock rate.

Discussion

Initializes a new instance of the FMIceLinkVideoFormat class.

Declared In

FMIceLinkVideoFormat.h

– isAbgr

Gets a value indicating whether this format is ABGR.
- (bool)isAbgr

Discussion

Gets a value indicating whether this format is ABGR.

Declared In

FMIceLinkVideoFormat.h

– isArgb

Gets a value indicating whether this format is ARGB.
- (bool)isArgb

Discussion

Gets a value indicating whether this format is ARGB.

Declared In

FMIceLinkVideoFormat.h

– isBgr

Gets a value indicating whether this format is BGR.
- (bool)isBgr

Discussion

Gets a value indicating whether this format is BGR.

Declared In

FMIceLinkVideoFormat.h

– isBgra

Gets a value indicating whether this format is BGRA.
- (bool)isBgra

Discussion

Gets a value indicating whether this format is BGRA.

Declared In

FMIceLinkVideoFormat.h

– isH264

Gets a value indicating whether this format is H.264.
- (bool)isH264

Discussion

Gets a value indicating whether this format is H.264.

Declared In

FMIceLinkVideoFormat.h

– isI420

Gets a value indicating whether this format is I420.
- (bool)isI420

Discussion

Gets a value indicating whether this format is I420.

Declared In

FMIceLinkVideoFormat.h

– isNv12

Gets a value indicating whether this format is NV12.
- (bool)isNv12

Discussion

Gets a value indicating whether this format is NV12.

Declared In

FMIceLinkVideoFormat.h

– isNv21

Gets a value indicating whether this format is NV21.
- (bool)isNv21

Discussion

Gets a value indicating whether this format is NV21.

Declared In

FMIceLinkVideoFormat.h

– isRaw

Gets a value indicating whether this format is RGB, BGR, I420, YV12, NV12, NV21, RGBA, BGRA, ARGB, or ABGR.
- (bool)isRaw

Discussion

Gets a value indicating whether this format is RGB, BGR, I420, YV12, NV12, NV21, RGBA, BGRA, ARGB, or ABGR.

Declared In

FMIceLinkVideoFormat.h

– isRgb

Gets a value indicating whether this format is RGB.
- (bool)isRgb

Discussion

Gets a value indicating whether this format is RGB.

Declared In

FMIceLinkVideoFormat.h

– isRgba

Gets a value indicating whether this format is RGBA.
- (bool)isRgba

Discussion

Gets a value indicating whether this format is RGBA.

Declared In

FMIceLinkVideoFormat.h

– isRgbaType

Gets a value indicating whether this format is RGBA, BGRA, ARGB, or ABGR.
- (bool)isRgbaType

Discussion

Gets a value indicating whether this format is RGBA, BGRA, ARGB, or ABGR.

Declared In

FMIceLinkVideoFormat.h

– isRgbType

Gets a value indicating whether this format is RGB or BGR.
- (bool)isRgbType

Discussion

Gets a value indicating whether this format is RGB or BGR.

Declared In

FMIceLinkVideoFormat.h

– isVp8

Gets a value indicating whether this format is VP8.
- (bool)isVp8

Discussion

Gets a value indicating whether this format is VP8.

Declared In

FMIceLinkVideoFormat.h

– isVp9

Gets a value indicating whether this format is VP9.
- (bool)isVp9

Discussion

Gets a value indicating whether this format is VP9.

Declared In

FMIceLinkVideoFormat.h

– isYuvType

Gets a value indicating whether this format is I420, YV12, NV12, or NV21.
- (bool)isYuvType

Discussion

Gets a value indicating whether this format is I420, YV12, NV12, or NV21.

Declared In

FMIceLinkVideoFormat.h

– isYv12

Gets a value indicating whether this format is YV12.
- (bool)isYv12

Discussion

Gets a value indicating whether this format is YV12.

Declared In

FMIceLinkVideoFormat.h

+ nv12

Gets an NV12 video format.
+ (FMIceLinkVideoFormat *)nv12

Discussion

Gets an NV12 video format.

Declared In

FMIceLinkVideoFormat.h

+ nv12Name

Gets the name of the NV12 video format ("NV12"). Indicates that each pixel occupies 12 bits (8 bits for Y, 2 bits for U, and 2 bits for V). Y plane is followed by interleaved U/V plane.
+ (NSString *)nv12Name

Discussion

Gets the name of the NV12 video format ("NV12"). Indicates that each pixel occupies 12 bits (8 bits for Y, 2 bits for U, and 2 bits for V). Y plane is followed by interleaved U/V plane.

Declared In

FMIceLinkVideoFormat.h

+ nv21

Gets an NV21 video format.
+ (FMIceLinkVideoFormat *)nv21

Discussion

Gets an NV21 video format.

Declared In

FMIceLinkVideoFormat.h

+ nv21Name

Gets the name of the NV21 video format ("NV21"). Indicates that each pixel occupies 12 bits (8 bits for Y, 2 bits for U, and 2 bits for V). Y plane is followed by interleaved V/U plane.
+ (NSString *)nv21Name

Discussion

Gets the name of the NV21 video format ("NV21"). Indicates that each pixel occupies 12 bits (8 bits for Y, 2 bits for U, and 2 bits for V). Y plane is followed by interleaved V/U plane.

Declared In

FMIceLinkVideoFormat.h

– parameters

Gets the parameters.
- (NSString *)parameters

Discussion

Gets the parameters.

Declared In

FMIceLinkVideoFormat.h

+ rgb

Gets an RGB video format.
+ (FMIceLinkVideoFormat *)rgb

Discussion

Gets an RGB video format.

Declared In

FMIceLinkVideoFormat.h

+ rgba

Gets an RGBA video format.
+ (FMIceLinkVideoFormat *)rgba

Discussion

Gets an RGBA video format.

Declared In

FMIceLinkVideoFormat.h

+ rgbaName

Gets the name of the RGBA video format ("RGBA"). Indicates that each pixel occupies 32 bits (8 bits for red, then 8 bits for green, then 8 bits for blue, then 8 bits for alpha).
+ (NSString *)rgbaName

Discussion

Gets the name of the RGBA video format ("RGBA"). Indicates that each pixel occupies 32 bits (8 bits for red, then 8 bits for green, then 8 bits for blue, then 8 bits for alpha).

Declared In

FMIceLinkVideoFormat.h

+ rgbName

Gets the name of the RGB video format ("RGB"). Indicates that each pixel occupies 24 bits (8 bits for red, then 8 bits for green, then 8 bits for blue).
+ (NSString *)rgbName

Discussion

Gets the name of the RGB video format ("RGB"). Indicates that each pixel occupies 24 bits (8 bits for red, then 8 bits for green, then 8 bits for blue).

Declared In

FMIceLinkVideoFormat.h

– setFourCC:

Sets the FourCC value for this format.
- (void)setFourCC:(int)value

Discussion

Sets the FourCC value for this format.

Declared In

FMIceLinkVideoFormat.h

+ toFourCCWithA:b:c:d:

Converts 4 FourCC characters to an int.
+ (int)toFourCCWithA:(unichar)a b:(unichar)b c:(unichar)c d:(unichar)d

Discussion

Converts 4 FourCC characters to an int.

Declared In

FMIceLinkVideoFormat.h

+ toFourCCWithFourcc:

Converts a FourCC string to a int.
+ (int)toFourCCWithFourcc:(NSString *)fourcc

Parameters

fourcc

The fourcc.

Discussion

Converts a FourCC string to a int.

Declared In

FMIceLinkVideoFormat.h

– toJson

Serializes this instance to JSON.

@return

- (NSString *)toJson

Discussion

Serializes this instance to JSON.

@return

Declared In

FMIceLinkVideoFormat.h

+ toJsonWithVideoFormat:

Serializes an instance to JSON.
+ (NSString *)toJsonWithVideoFormat:(FMIceLinkVideoFormat *)videoFormat

Parameters

videoFormat

The video format. @return

Discussion

Serializes an instance to JSON.

Declared In

FMIceLinkVideoFormat.h

+ videoFormat

Initializes a new instance of the FMIceLinkVideoFormat class.
+ (FMIceLinkVideoFormat *)videoFormat

Discussion

Initializes a new instance of the FMIceLinkVideoFormat class.

Declared In

FMIceLinkVideoFormat.h

+ videoFormatWithName:

Initializes a new instance of the FMIceLinkVideoFormat class.
+ (FMIceLinkVideoFormat *)videoFormatWithName:(NSString *)name

Parameters

name

The name.

Discussion

Initializes a new instance of the FMIceLinkVideoFormat class.

Declared In

FMIceLinkVideoFormat.h

+ videoFormatWithName:clockRate:

Initializes a new instance of the FMIceLinkVideoFormat class.
+ (FMIceLinkVideoFormat *)videoFormatWithName:(NSString *)name clockRate:(int)clockRate

Parameters

name

The name.
clockRate

The clock rate.

Discussion

Initializes a new instance of the FMIceLinkVideoFormat class.

Declared In

FMIceLinkVideoFormat.h

+ vp8

Gets a VP8 video format.
+ (FMIceLinkVideoFormat *)vp8

Discussion

Gets a VP8 video format.

Declared In

FMIceLinkVideoFormat.h

+ vp8Name

Gets the name of the VP8 video format ("VP8").
+ (NSString *)vp8Name

Discussion

Gets the name of the VP8 video format ("VP8").

Declared In

FMIceLinkVideoFormat.h

+ vp9

Gets a VP9 video format.
+ (FMIceLinkVideoFormat *)vp9

Discussion

Gets a VP9 video format.

Declared In

FMIceLinkVideoFormat.h

+ vp9Name

Gets the name of the VP9 video format ("VP9").
+ (NSString *)vp9Name

Discussion

Gets the name of the VP9 video format ("VP9").

Declared In

FMIceLinkVideoFormat.h

+ yv12

Gets a YV12 video format.
+ (FMIceLinkVideoFormat *)yv12

Discussion

Gets a YV12 video format.

Declared In

FMIceLinkVideoFormat.h

+ yv12Name

Gets the name of the YV12 video format ("YV12"). Indicates that each pixel occupies 12 bits (8 bits for Y, 2 bits for U, and 2 bits for V). Y plane is followed by V plane and then U plane.
+ (NSString *)yv12Name

Discussion

Gets the name of the YV12 video format ("YV12"). Indicates that each pixel occupies 12 bits (8 bits for Y, 2 bits for U, and 2 bits for V). Y plane is followed by V plane and then U plane.

Declared In

FMIceLinkVideoFormat.h