Inherits from NSObject
Declared in OTVideoKit.h
OTVideoKit.mm

Overview

Defines a frame of a video. See [OTVideoRender renderVideoFrame:] and [OTVideoCaptureConsumer consumeFrame:].

Properties of OTVideoFrame objects

  planes

An array of planes in the video frame.

@property (nonatomic, retain) NSPointerArray *planes

Declared In

OTVideoKit.h

  timestamp

A timestap of the video frame.

@property (nonatomic, assign) CMTime timestamp

Declared In

OTVideoKit.h

  orientation

The orientation of the video frame.

@property (nonatomic, assign) OTVideoOrientation orientation

Declared In

OTVideoKit.h

  format

The format of the video frame.

@property (nonatomic, retain) OTVideoFormat *format

Declared In

OTVideoKit.h

  metadata

The metadata associated with this video frame, if any.

@property (nonatomic, readonly) NSData *metadata

Declared In

OTVideoKit.h

Instantiating OTVideoFrame objects

– init

Initializes an OTVideoFrame object.

- (nonnull id)init

Declared In

OTVideoKit.h

– initWithFormat:

Initializes an OTVideoFrame object with a specified format.

- (nonnull id)initWithFormat:(nonnull OTVideoFormat *)videoFormat

Parameters

videoFormat

The video format used by the video frame.

Declared In

OTVideoKit.h

– setPlanesWithPointers:numPlanes:

Sets planes for the video frame.

- (void)setPlanesWithPointers:(uint8_t *_Nonnull [ _Nonnull ])planes numPlanes:(int)numPlanes

Parameters

planes

The planes to assign.

numPlanes

The number of planes to assign.

Declared In

OTVideoKit.h

– clearPlanes

Cleans the planes in the video frame.

- (void)clearPlanes

Declared In

OTVideoKit.h

– setMetadata:error:

Sets the metadata associated with this video frame.

- (void)setMetadata:(nonnull NSData *)data error:(out OTError *_Nullable *)error

Parameters

data

The metadata to assign.

error

If the size of the metadata passed is bigger than 32 bytes this value is set to an OTError object with the code property set to OTNullOrInvalidParameter.

Declared In

OTVideoKit.h