Agora C++ API Reference for All Platforms

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

Inherits agora::RefCountInterface.

Inherited by agora::rtc::IVideoEncodedImageSenderEx.

## Public Member Functions
virtual bool | sendEncodedVideoImage (const uint8_t *imageBuffer, size_t length, const EncodedVideoFrameInfo &videoEncodedFrameInfo, 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
| ~IVideoEncodedImageSender ()
Protected Member Functions inherited from agora::RefCountInterface
virtual | ~RefCountInterface ()

## Detailed Description

The `IVideoEncodedImageSender` class.

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

## Constructor & Destructor Documentation

## ◆ ~IVideoEncodedImageSender()

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

## Member Function Documentation

## ◆ sendEncodedVideoImage()

virtual bool agora::rtc::IVideoEncodedImageSender::sendEncodedVideoImage | ( | const uint8_t * | imageBuffer,
|  | size_t | length,
|  | const EncodedVideoFrameInfo & | videoEncodedFrameInfo,
|  | aosl_ref_t | ares = `AOSL_REF_INVALID`
| ) |  |
| pure virtual

Sends the encoded video image to the video track.

Parameters

  imageBuffer | The video buffer.
  length | The data length of the video data.
  videoEncodedFrameInfo | The reference to the information of the encoded video frame: EncodedVideoFrameInfo.

Returns
  - `true`: Success.
  - `false`: Failure.