Intel® Collaboration Suite for WebRTC  version 4.3.1
Open WebRTC Toolkit (OWT) Client SDK for iOS*
<RTCVideoFrameGeneratorProtocol> Protocol Reference

Protocol for video frame generators RTCLocalCustomizedStream pulls video frames from an object implements this protocol. Height, width and frame rate cannot be changed once generator is created. More...

#import <OWTFrameGeneratorProtocol.h>

Inheritance diagram for <RTCVideoFrameGeneratorProtocol>:
Collaboration diagram for <RTCVideoFrameGeneratorProtocol>:

Instance Methods

(NSUInteger) - nextFrame:capacity:
 Generate next video frame. More...
 
(CGSize) - resolution
 frame resolution
 
(NSUInteger) - frameRate
 frame rate, unit: fps
 

Detailed Description

Protocol for video frame generators RTCLocalCustomizedStream pulls video frames from an object implements this protocol. Height, width and frame rate cannot be changed once generator is created.

Method Documentation

◆ nextFrame:capacity:()

- (NSUInteger) nextFrame: (uint8_t *)  buffer
capacity: (const NSUInteger)  capacity 

Generate next video frame.

Parameters
bufferPoints to the start address for frame data. The memory is allocated and owned by SDK. Implementations should fill frame data to the memory starts from |buffer|.
capacityBuffer's capacity. It will be equal or greater to expected frame buffer size.
Returns
The size of actually frame buffer size.