Agora Server Gateway SDK C++ API Reference
Public Member Functions | List of all members
agora::rtc::IVideoSinkBase Class Referenceabstract

#include <NGIAgoraMediaNode.h>

Public Member Functions

virtual int setProperty (const char *key, const void *buf, int buf_size)
 
virtual int getProperty (const char *key, void *buf, int buf_size)
 
virtual int onFrame (const media::base::VideoFrame &videoFrame)=0
 
virtual bool applyMirror ()
 
virtual bool applyRotation ()
 

Detailed Description

The IVideoSinkBase class is the base class for the custom video sink.

Member Function Documentation

◆ applyMirror()

virtual bool agora::rtc::IVideoSinkBase::applyMirror ( )
inlinevirtual

Whether to mirror the video frame.

Returns
  • true: mirror the video frame.
  • false: do not mirror the video frame.

◆ applyRotation()

virtual bool agora::rtc::IVideoSinkBase::applyRotation ( )
inlinevirtual

Whether to rotate the video frame.

Returns
  • true: rotate the video frame.
  • false: do not rotate the video frame.

◆ getProperty()

virtual int agora::rtc::IVideoSinkBase::getProperty ( const char *  key,
void *  buf,
int  buf_size 
)
inlinevirtual

Gets a private property in the IVideoFilter class.

Parameters
keyThe pointer to the property name.
bufThe pointer to the buffer of this private property.
buf_sizeThe buffer size of this private property.
Returns
  • The actual size of the private property, if the method call succeeds.
  • -1, if the method call fails.

◆ onFrame()

virtual int agora::rtc::IVideoSinkBase::onFrame ( const media::base::VideoFrame &  videoFrame)
pure virtual

Occurs when the IVideoSinkBase object receives the video frame.

Parameters
videoFrameThe reference to the video frame.

◆ setProperty()

virtual int agora::rtc::IVideoSinkBase::setProperty ( const char *  key,
const void *  buf,
int  buf_size 
)
inlinevirtual

Sets a private property in the IVideoFilter class.

Parameters
keyThe pointer to the property name.
bufThe pointer to the buffer of this private property.
buf_sizeThe buffer size of this private property.
Returns
  • The actual size of the private property, if the method call succeeds.
  • -1, if the method call fails.

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