Intel® Collaboration Suite for WebRTC  version 4.3.1
Open WebRTC Toolkit (OWT) Client SDK for Windows*
owt::base::VideoFrameGeneratorInterface Class Referenceabstract

frame generator interface for users to generates frame. FrameGeneratorInterface is the virtual class to implement its own frame generator. More...

#include <owt/base/framegeneratorinterface.h>

Public Types

enum  VideoFrameCodec { I420, VP8, H264 }
 

Public Member Functions

 VideoFrameGeneratorInterface ()
 This function generates one frame data. More...
 
virtual uint32_t GenerateNextFrame (uint8_t *buffer, const uint32_t capacity)=0
 
virtual uint32_t GetNextFrameSize ()=0
 This function gets the size of next video frame.
 
virtual int GetHeight ()=0
 This function gets the height of video frame.
 
virtual int GetWidth ()=0
 This function gets the width of video frame.
 
virtual int GetFps ()=0
 This function gets the fps of video frame generator.
 
virtual VideoFrameCodec GetType ()=0
 This function gets the video frame type of video frame generator.
 

Detailed Description

frame generator interface for users to generates frame. FrameGeneratorInterface is the virtual class to implement its own frame generator.

Constructor & Destructor Documentation

◆ VideoFrameGeneratorInterface()

owt::base::VideoFrameGeneratorInterface::VideoFrameGeneratorInterface ( )
inline

This function generates one frame data.

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.