FMIceLinkVideoBuffer Class Reference
| Inherits from | FMIceLinkMediaBuffer : FMIceLinkDynamic : FMIceLinkSerializable : NSObject |
|---|---|
| Conforms to | * FMIceLinkVideoBuffer FMIceLinkVideoFormat |
| Declared in | FMIceLinkVideoBuffer.h FMIceLinkVideoBuffer.m |
– clone
Clones this instance.
- (FMIceLinkVideoBuffer *)cloneDiscussion
Clones this instance.
Declared In
FMIceLinkVideoBuffer.h
– convertWithFormat:
Creates a new video buffer using the specified format.
- (FMIceLinkVideoBuffer *)convertWithFormat:(FMIceLinkVideoFormat *)formatParameters
format |
The format. @return |
|---|
Discussion
Creates a new video buffer using the specified format.
Declared In
FMIceLinkVideoBuffer.h
– convertWithFormat:dataBuffer:
Creates a new video buffer using the specified format.
- (FMIceLinkVideoBuffer *)convertWithFormat:(FMIceLinkVideoFormat *)format dataBuffer:(FMIceLinkDataBuffer *)dataBufferParameters
format |
The format. |
|---|---|
dataBuffer |
The data buffer. @return |
Discussion
Creates a new video buffer using the specified format.
Declared In
FMIceLinkVideoBuffer.h
+ createBlackWithWidth:height:formatName:
Creates a black (0, 0, 0) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createBlackWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a black (0, 0, 0) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createBlueWithWidth:height:formatName:
Creates a blue (0, 0, 255) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createBlueWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a blue (0, 0, 255) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createCustomWithWidth:height:red:green:blue:formatName:
Creates a custom video buffer with the specified width/[height](#//api/name/height) and red/green/blue values
for the specified format name. If the format is not supported, returns null.
+ (FMIceLinkVideoBuffer *)createCustomWithWidth:(int)width height:(int)height red:(int)red green:(int)green blue:(int)blue formatName:(NSString *)formatNameParameters
width |
The width. |
|---|---|
height |
The height. |
red |
The red value. |
green |
The green value. |
blue |
The blue value. |
formatName |
Name of the format. |
Discussion
Creates a custom video buffer with the specified width/[height](#//api/name/height) and red/green/blue values
for the specified format name. If the format is not supported, returns null.
Declared In
FMIceLinkVideoBuffer.h
+ createCustomWithWidth:height:red:green:blue:formatName:buffer:
Creates a custom video buffer with the specified width/[height](#//api/name/height) and red/green/blue values
for the specified format name. If the format is not supported, returns null.
+ (FMIceLinkVideoBuffer *)createCustomWithWidth:(int)width height:(int)height red:(int)red green:(int)green blue:(int)blue formatName:(NSString *)formatName buffer:(FMIceLinkDataBuffer *)bufferParameters
width |
The width. |
|---|---|
height |
The height. |
red |
The red value. |
green |
The green value. |
blue |
The blue value. |
formatName |
Name of the format. |
buffer |
The output data buffer. |
Discussion
Creates a custom video buffer with the specified width/[height](#//api/name/height) and red/green/blue values
for the specified format name. If the format is not supported, returns null.
Declared In
FMIceLinkVideoBuffer.h
+ createCyanWithWidth:height:formatName:
Creates a cyan (0, 255, 255) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createCyanWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a cyan (0, 255, 255) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createDarkBlueWithWidth:height:formatName:
Creates a dark blue (0, 0, 128) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createDarkBlueWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a dark blue (0, 0, 128) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createDarkGreenWithWidth:height:formatName:
Creates a dark green (0, 128, 0) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createDarkGreenWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a dark green (0, 128, 0) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createDarkRedWithWidth:height:formatName:
Creates a dark red (128, 0, 0) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createDarkRedWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a dark red (128, 0, 0) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createGrayWithWidth:height:formatName:
Creates a gray (255, 255, 255) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createGrayWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a gray (255, 255, 255) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createGreenWithWidth:height:formatName:
Creates a green (0, 255, 0) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createGreenWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a green (0, 255, 0) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
– createInstance
Creates a new instance.
- (FMIceLinkVideoBuffer *)createInstanceDiscussion
Creates a new instance.
Declared In
FMIceLinkVideoBuffer.h
+ createMagentaWithWidth:height:formatName:
Creates a magenta (255, 0, 255) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createMagentaWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a magenta (255, 0, 255) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createOliveWithWidth:height:formatName:
Creates an olive (128, 128, 0) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createOliveWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates an olive (128, 128, 0) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createPurpleWithWidth:height:formatName:
Creates a purple (128, 0, 128) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createPurpleWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a purple (128, 0, 128) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createRedWithWidth:height:formatName:
Creates a red (255, 0, 0) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createRedWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a red (255, 0, 0) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createTealWithWidth:height:formatName:
Creates a teal (0, 128, 128) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createTealWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a teal (0, 128, 128) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createWhiteWithWidth:height:formatName:
Creates a white (255, 255, 255) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createWhiteWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a white (255, 255, 255) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ createYellowWithWidth:height:formatName:
Creates a yellow (255, 255, 0) video buffer with the specified width/[height](#//api/name/height).
+ (FMIceLinkVideoBuffer *)createYellowWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Creates a yellow (255, 255, 0) video buffer with the specified width/[height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
+ fromJsonArrayWithVideoBuffersJson:
Deserializes an array of instances from JSON.
+ (NSMutableArray *)fromJsonArrayWithVideoBuffersJson:(NSString *)videoBuffersJsonParameters
videoBuffersJson |
The video buffers JSON. @return |
|---|
Discussion
Deserializes an array of instances from JSON.
Declared In
FMIceLinkVideoBuffer.h
+ fromJsonWithVideoBufferJson:
Deserializes an instance from JSON.
+ (FMIceLinkVideoBuffer *)fromJsonWithVideoBufferJson:(NSString *)videoBufferJsonParameters
videoBufferJson |
The video buffer JSON. @return |
|---|
Discussion
Deserializes an instance from JSON.
Declared In
FMIceLinkVideoBuffer.h
+ getMinimumBufferLengthWithWidth:height:formatName:
Gets the minimum data buffer length for a given [width](#//api/name/width), [height](#//api/name/height), and format.
+ (int)getMinimumBufferLengthWithWidth:(int)width height:(int)height formatName:(NSString *)formatNameDiscussion
Gets the minimum data buffer length for a given [width](#//api/name/width), [height](#//api/name/height), and format.
Declared In
FMIceLinkVideoBuffer.h
– height
Gets the height.
- (int)heightDiscussion
Gets the height.
Declared In
FMIceLinkVideoBuffer.h
– init
Initializes a new instance of the FMIceLinkVideoBuffer class.
- (instancetype)initDiscussion
Initializes a new instance of the FMIceLinkVideoBuffer class.
Declared In
FMIceLinkVideoBuffer.h
– initWithWidth:height:dataBuffer:format:
Initializes a new instance of the FMIceLinkVideoBuffer class.
- (instancetype)initWithWidth:(int)width height:(int)height dataBuffer:(FMIceLinkDataBuffer *)dataBuffer format:(FMIceLinkVideoFormat *)formatDiscussion
Initializes a new instance of the FMIceLinkVideoBuffer class.
Declared In
FMIceLinkVideoBuffer.h
– initWithWidth:height:dataBuffers:format:
Initializes a new instance of the FMIceLinkVideoBuffer class.
- (instancetype)initWithWidth:(int)width height:(int)height dataBuffers:(NSMutableArray *)dataBuffers format:(FMIceLinkVideoFormat *)formatDiscussion
Initializes a new instance of the FMIceLinkVideoBuffer class.
Declared In
FMIceLinkVideoBuffer.h
– isAbgr
Gets a value indicating whether this buffer has ABGR video.
- (bool)isAbgrDiscussion
Gets a value indicating whether this buffer has ABGR video.
Declared In
FMIceLinkVideoBuffer.h
– isArgb
Gets a value indicating whether this buffer has ARGB video.
- (bool)isArgbDiscussion
Gets a value indicating whether this buffer has ARGB video.
Declared In
FMIceLinkVideoBuffer.h
– isBgr
Gets a value indicating whether this buffer has BGR video.
- (bool)isBgrDiscussion
Gets a value indicating whether this buffer has BGR video.
Declared In
FMIceLinkVideoBuffer.h
– isBgra
Gets a value indicating whether this buffer has BGRA video.
- (bool)isBgraDiscussion
Gets a value indicating whether this buffer has BGRA video.
Declared In
FMIceLinkVideoBuffer.h
– isH264
Gets a value indicating whether this buffer has H.264 video.
- (bool)isH264Discussion
Gets a value indicating whether this buffer has H.264 video.
Declared In
FMIceLinkVideoBuffer.h
– isI420
Gets a value indicating whether this buffer has I420 video.
- (bool)isI420Discussion
Gets a value indicating whether this buffer has I420 video.
Declared In
FMIceLinkVideoBuffer.h
– isKeyFrame
Gets a value indicating whether this buffer contains a keyframe.
- (bool)isKeyFrameDiscussion
Gets a value indicating whether this buffer contains a keyframe.
Declared In
FMIceLinkVideoBuffer.h
– isMuted
Gets a value indicating whether this instance has been muted.
- (bool)isMutedDiscussion
Gets a value indicating whether this instance has been muted.
Declared In
FMIceLinkVideoBuffer.h
– isNv12
Gets a value indicating whether this buffer has NV12 video.
- (bool)isNv12Discussion
Gets a value indicating whether this buffer has NV12 video.
Declared In
FMIceLinkVideoBuffer.h
– isNv21
Gets a value indicating whether this buffer has NV21 video.
- (bool)isNv21Discussion
Gets a value indicating whether this buffer has NV21 video.
Declared In
FMIceLinkVideoBuffer.h
– isRaw
Gets a value indicating whether this buffer has raw video.
- (bool)isRawDiscussion
Gets a value indicating whether this buffer has raw video.
Declared In
FMIceLinkVideoBuffer.h
– isRgb
Gets a value indicating whether this buffer has RGB video.
- (bool)isRgbDiscussion
Gets a value indicating whether this buffer has RGB video.
Declared In
FMIceLinkVideoBuffer.h
– isRgba
Gets a value indicating whether this buffer has RGBA video.
- (bool)isRgbaDiscussion
Gets a value indicating whether this buffer has RGBA video.
Declared In
FMIceLinkVideoBuffer.h
– isRgbaType
Gets a value indicating whether this buffer has raw RGBA, BGRA, ARGB, or ABGR video.
- (bool)isRgbaTypeDiscussion
Gets a value indicating whether this buffer has raw RGBA, BGRA, ARGB, or ABGR video.
Declared In
FMIceLinkVideoBuffer.h
– isRgbType
Gets a value indicating whether this buffer has raw RGB or BGR video.
- (bool)isRgbTypeDiscussion
Gets a value indicating whether this buffer has raw RGB or BGR video.
Declared In
FMIceLinkVideoBuffer.h
– isVp8
Gets a value indicating whether this buffer has VP8 video.
- (bool)isVp8Discussion
Gets a value indicating whether this buffer has VP8 video.
Declared In
FMIceLinkVideoBuffer.h
– isVp9
Gets a value indicating whether this buffer has VP9 video.
- (bool)isVp9Discussion
Gets a value indicating whether this buffer has VP9 video.
Declared In
FMIceLinkVideoBuffer.h
– isYuvType
Gets a value indicating whether this buffer has raw I420, YV12, NV12, or NV21 video.
- (bool)isYuvTypeDiscussion
Gets a value indicating whether this buffer has raw I420, YV12, NV12, or NV21 video.
Declared In
FMIceLinkVideoBuffer.h
– isYv12
Gets a value indicating whether this buffer has YV12 video.
- (bool)isYv12Discussion
Gets a value indicating whether this buffer has YV12 video.
Declared In
FMIceLinkVideoBuffer.h
– mute
Mutes this instance. This is a one-way operation that clears
the underlying data buffer.
- (bool)muteDiscussion
Mutes this instance. This is a one-way operation that clears
the underlying data buffer.
Declared In
FMIceLinkVideoBuffer.h
– orientation
Gets the orientation.
- (int)orientationDiscussion
Gets the orientation.
Declared In
FMIceLinkVideoBuffer.h
– setHeight:
Sets the [height](#//api/name/height).
- (void)setHeight:(int)valueDiscussion
Sets the [height](#//api/name/height).
Declared In
FMIceLinkVideoBuffer.h
– setOrientation:
Sets the [orientation](#//api/name/orientation).
- (void)setOrientation:(int)valueDiscussion
Sets the [orientation](#//api/name/orientation).
Declared In
FMIceLinkVideoBuffer.h
– setStride:
Sets the [stride](#//api/name/stride).
- (void)setStride:(int)valueDiscussion
Sets the [stride](#//api/name/stride).
Declared In
FMIceLinkVideoBuffer.h
– setStrides:
Sets the [strides](#//api/name/strides).
- (void)setStrides:(NSMutableArray *)valueDiscussion
Sets the [strides](#//api/name/strides).
Declared In
FMIceLinkVideoBuffer.h
– setWidth:
Sets the [width](#//api/name/width).
- (void)setWidth:(int)valueDiscussion
Sets the [width](#//api/name/width).
Declared In
FMIceLinkVideoBuffer.h
– stride
Gets the stride.
- (int)strideDiscussion
Gets the stride.
Declared In
FMIceLinkVideoBuffer.h
– strides
Gets the strides.
- (NSMutableArray *)stridesDiscussion
Gets the strides.
Declared In
FMIceLinkVideoBuffer.h
– toJson
Serializes this instance to JSON.
@return
- (NSString *)toJsonDiscussion
Serializes this instance to JSON.
@return
Declared In
FMIceLinkVideoBuffer.h
+ toJsonArrayWithVideoBuffers:
Serializes an array of instances to JSON.
+ (NSString *)toJsonArrayWithVideoBuffers:(NSMutableArray *)videoBuffersParameters
videoBuffers |
The video buffers. @return |
|---|
Discussion
Serializes an array of instances to JSON.
Declared In
FMIceLinkVideoBuffer.h
+ toJsonWithVideoBuffer:
Serializes an instance to JSON.
+ (NSString *)toJsonWithVideoBuffer:(FMIceLinkVideoBuffer *)videoBufferParameters
videoBuffer |
The video buffer. @return |
|---|
Discussion
Serializes an instance to JSON.
Declared In
FMIceLinkVideoBuffer.h
– toPlanar
Converts a planar representation of this
packed buffer, if in YUV-packed format.
Otherwise, returns the current buffer.
@return
- (FMIceLinkVideoBuffer *)toPlanarDiscussion
Converts a planar representation of this
packed buffer, if in YUV-packed format.
Otherwise, returns the current buffer.
@return
Declared In
FMIceLinkVideoBuffer.h
+ videoBuffer
Initializes a new instance of the FMIceLinkVideoBuffer class.
+ (FMIceLinkVideoBuffer *)videoBufferDiscussion
Initializes a new instance of the FMIceLinkVideoBuffer class.
Declared In
FMIceLinkVideoBuffer.h
+ videoBufferWithWidth:height:dataBuffer:format:
Initializes a new instance of the FMIceLinkVideoBuffer class.
+ (FMIceLinkVideoBuffer *)videoBufferWithWidth:(int)width height:(int)height dataBuffer:(FMIceLinkDataBuffer *)dataBuffer format:(FMIceLinkVideoFormat *)formatDiscussion
Initializes a new instance of the FMIceLinkVideoBuffer class.
Declared In
FMIceLinkVideoBuffer.h
+ videoBufferWithWidth:height:dataBuffers:format:
Initializes a new instance of the FMIceLinkVideoBuffer class.
+ (FMIceLinkVideoBuffer *)videoBufferWithWidth:(int)width height:(int)height dataBuffers:(NSMutableArray *)dataBuffers format:(FMIceLinkVideoFormat *)formatDiscussion
Initializes a new instance of the FMIceLinkVideoBuffer class.
Declared In
FMIceLinkVideoBuffer.h