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

Inherits IVideoSinkBase.

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 ()
 

Member Function Documentation

◆ setProperty()

virtual int setProperty ( const char *  key,
const void *  buf,
int  buf_size 
)
inlinevirtualinherited

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 
)
inlinevirtualinherited

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 virtualinherited

Occurs when the IVideoSinkBase object receives the video frame.

Parameters
videoFrameThe reference to the video frame.

◆ isExternalSink()

virtual bool isExternalSink ( )
inlinevirtualinherited

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

◆ onDataStreamWillStart()

virtual bool onDataStreamWillStart ( )
inlinevirtualinherited

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 ( )
inlinevirtualinherited

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

◆ applyMirror()

virtual bool applyMirror ( )
inlinevirtualinherited

Whether to mirror the video frame.

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

◆ applyRotation()

virtual bool applyRotation ( )
inlinevirtualinherited

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