<MCVideoFrame> Protocol Reference

#import <frames.h>

Inheritance diagram for <MCVideoFrame>:

Collaboration diagram for <MCVideoFrame>:

Instance Methods
(int)	- width
(int)	- height
(MCVideoType)	- frameType
(uint32_t)	- sizeRgb
(uint32_t)	- sizeI420
(uint32_t)	- sizeI444
(void)	- getRgbBuffer:
(void)	- getI420Buffer:
(void)	- getI444Buffer:

Detailed Description

This class represents a raw Video Frame. Used with MCVideoRenderer for playback.

Method Documentation

frameType

- (MCVideoType) frameType

The pixel format. For example, can be an I420 or a I444 frame.

• Returns: MCVideoType representing the pixel format.

getI420Buffer:

- (void) getI420Buffer:

(uint8_t *)

buffer

Get the video frame buffer as an I420 frame. Performs the necessary conversion.

• Parameters:
  • buffer: The pre-allocated buffer to be filled on the user side. buffer needs to fit MCVideoFrame/sizeI420 bytes.

getI444Buffer:

- (void) getI444Buffer:

(uint8_t *)

buffer

Get the video frame buffer as an I444 frame. Performs the necessary conversion.

• Parameters:
  • buffer: The pre-allocated buffer to be filled on the user side. buffer needs to fit MCVideoFrame/sizeI444 bytes.

getRgbBuffer:

- (void) getRgbBuffer:

(uint8_t *)

buffer

Get the video frame buffer as an RGB frame. Performs the necessary conversion.

• Parameters:
  • buffer: The pre-allocated buffer to be filled on the user side. buffer needs to fit MCVideoFrame/sizeRgb bytes.

height

- (int) height

The height of the video frame.

• Returns: The height of the video frame

sizeI420

- (uint32_t) sizeI420

If the frame was an I420 frame, then this will return size of the frame in bytes.

• Returns: The actual size if it was an I420 frame, 0 otherwise.

sizeI444

- (uint32_t) sizeI444

If the frame was an I444 frame, then this will return size of the frame in bytes.

• Returns: The actual size if it was an I444 frame, 0 otherwise.

sizeRgb

- (uint32_t) sizeRgb

If the frame was an RGB frame, then this will return size of the frame in bytes.

• Returns: The actual size if it was an RGB frame, 0 otherwise.

width

- (int) width

The width of the video frame.

• Returns: the width of the video frame.

---

The documentation for this protocol was generated from the following file:

• objc/MillicastSDK/frames.h