Agora C++ API Reference for All Platforms

Public Member Functions | Protected Member Functions | List of all members
agora::rtc::IVideoFrameSender Class Referenceabstract

Inherits agora::RefCountInterface.

Inherited by agora::rtc::IVideoFrameSenderEx.

## Public Member Functions
virtual int | sendVideoFrame (const media::base::ExternalVideoFrame &videoFrame, aosl_ref_t ares=AOSL_REF_INVALID)=0
Public Member Functions inherited from agora::RefCountInterface
virtual void | AddRef () const =0
virtual RefCountReleaseStatus | Release () const =0
virtual bool | HasOneRef () const =0

## Protected Member Functions
| ~IVideoFrameSender ()
Protected Member Functions inherited from agora::RefCountInterface
virtual | ~RefCountInterface ()

## Detailed Description

The `IVideoFrameSender` class.

In scenarios involving custom video sources, you can use this class to send the video data directly to a video track. If the video track is disabled, the sent data will be automatically discarded.

## Constructor & Destructor Documentation

## ◆ ~IVideoFrameSender()

agora::rtc::IVideoFrameSender::~IVideoFrameSender | ( |  | ) |
| inline protected

## Member Function Documentation

## ◆ sendVideoFrame()

virtual int agora::rtc::IVideoFrameSender::sendVideoFrame | ( | const media::base::ExternalVideoFrame & | videoFrame,
|  | aosl_ref_t | ares = `AOSL_REF_INVALID`
| ) |  |
| pure virtual

Sends the video frame to the video track.

Parameters

  videoFrame | The reference to the video frame to send.

Returns
  - 0: Success.
  - < 0: Failure.