Agora RTC Objective-C API Reference  Refactor
Public Member Functions
IVideoSinkBase Class Referenceabstract

Inherits RefCountInterface.

Inherited by IVideoRenderer.

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 isExternalSink ()
 
virtual bool onDataStreamWillStart ()
 
virtual void onDataStreamWillStop ()
 
virtual bool applyMirror ()
 
virtual bool applyRotation ()
 

Detailed Description

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

Member Function Documentation

◆ setProperty()

virtual int 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.

◆ getProperty()

virtual int 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 onFrame ( const media::base::VideoFrame videoFrame)
pure virtual

Occurs when the IVideoSinkBase object receives the video frame.

Parameters
videoFrameThe reference to the video frame.

◆ isExternalSink()

virtual bool isExternalSink ( )
inlinevirtual

Used internally to distinguish between external and internal sinks. External application should not override this interface.

◆ onDataStreamWillStart()

virtual bool onDataStreamWillStart ( )
inlinevirtual

This function is invoked right before data stream starts. Custom sink can override this function for initialization.

Returns
  • true, if initialization succeeds.
  • false, if initialization fails.

◆ onDataStreamWillStop()

virtual void onDataStreamWillStop ( )
inlinevirtual

This function is invoked right before data stream stops. Custom sink can override this function for deinitialization.

◆ applyMirror()

virtual bool applyMirror ( )
inlinevirtual

Whether to mirror the video frame.

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

◆ applyRotation()

virtual bool applyRotation ( )
inlinevirtual

Whether to rotate the video frame.

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

◆ AddRef()

virtual void AddRef ( ) const
pure virtualinherited

◆ Release()

virtual RefCountReleaseStatus Release ( ) const
pure virtualinherited

◆ HasOneRef()

virtual bool HasOneRef ( ) const
pure virtualinherited