Home
Video SDK for C++
CanvasConfig
This class provides methods relevant to video rendering by the player.

Video SDK for C++
- API Overview
  Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through SD-RTN™.
- IRtcEngine
  The basic interface of the Agora SDK that implements the core functions of real-time communication.
- IRtcEngineEx
  This interface class contains multi-channel methods.
- IRtcEngineEventHandler
  The SDK uses the IRtcEngineEventHandler interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
- IMediaPlayer
  This class provides media player functions and supports multiple instances.
- IAudioEncodedFrameObserver
  The encoded audio observer.
- IAudioDeviceManager
  Audio device management methods.
- IAudioDeviceCollection
  The IAudioDeviceCollection interface. You can get the information of audio devices with this interface.
- IVideoDeviceManager
  Video device management methods.
- IVideoDeviceCollection
  You can get the information of video devices with this interface.
- IMediaEngine
  The IMediaEngine class.
- IMediaPlayerCacheManager
  This class provides methods to manage cached media files.
- IMediaPlayerCustomDataProvider
  The callback for custom media resource files.
- IMediaPlayerSourceObserver
  Provides callbacks for media players.
- IAudioPcmFrameSink
  This class is used to get raw PCM audio.
- IAudioFrameObserverBase
  The audio frame observer.
- IAudioSpectrumObserver
  The audio spectrum observer.
- IPacketObserver
  The definition of IPacketObserver.
- IMetadataObserver
  The metadata observer.
- IVideoEncodedFrameObserver
  Receives encoded video images.
- IVideoFrameObserver
  The IVideoFrameObserver class.
- IFaceInfoObserver
  Facial information observer.
- ILocalSpatialAudioEngine
  This class calculates user positions through the SDK to implement the spatial audio effect.
- IScreenCaptureSourceList
  The IScreenCaptureSourceList class. This class is returned in the getScreenCaptureSources method.
- Canvas
  This class provides methods for video rendering.
- CanvasConfig
  This class provides methods relevant to video rendering by the player.
- Player
  The fundamental interface class for the RTE player, which implements the major functions of media playback.
- PlayerConfig
  This class provides methods relevant to player settings.
- PlayerObserver
  The interface class which provides callbacks for the player.
- Rte
  The fundamental interface class of the RTE API, which provides major methods for enabling real-time audio video interaction.
- Struct and Enum
  This page lists all the definitions of Struct and the enums for C++.
- API Sunset Notice
  This page introduces the deprecated and deleted APIs in the SDK.

CanvasConfig

This class provides methods relevant to video rendering by the player.

class CanvasConfig {
 public:
 CanvasConfig() {RteCanvasConfigInit(&c_canvas_config, nullptr);}
 void SetRenderMode(VideoRenderMode mode, Error *err = nullptr);
 VideoRenderMode GetRenderMode(Error *err = nullptr);
 void SetMirrorMode(VideoMirrorMode mode, Error *err = nullptr);
 VideoMirrorMode GetMirrorMode(Error *err = nullptr);
};

Since: v4.5.0

Method

SetRenderMode: Sets the vide render mode. See SetRenderMode.
GetRenderMode: Gets the current video rendering mode setting. See GetRenderMode.
SetMirrorMode: Sets the rendering mode of the video. See SetMirrorMode.
GetMirrorMode: Get the current video mirror mode setting. See GetMirrorMode.

GetMirrorMode

Gets the current image mode setting.

VideoMirrorMode GetMirrorMode(Error *err = nullptr);

Since: v4.5.0

Call timing

Call this method after GetConfigs [3/3].

Restrictions

None.

Parameters

err: The state or error information: Error.

Returns

The current image mode. See RteVideoMirrorMode.

GetRenderMode

Gets the current video render mode.

VideoRenderMode GetRenderMode(Error *err = nullptr)

Since: v4.5.0

Call timing

Call this method after GetConfigs [3/3].

Restrictions

None.

Parameters

err: The state or error information: Error.

Returns

The current video rendering mode. See RteVideoRenderMode.

SetMirrorMode

Sets the mirror mode of the video.

void SetMirrorMode(VideoMirrorMode mode, Error *err = nullptr);

Since: v4.5.0

Call timing

Call this method after SetConfigs [3/3].

Restrictions

None.

Parameters

mode: The mirror mode. See RteVideoMirrorMode. The default value is kRteVideoMirrorModeAuto, which means to be determined by the SDK. The SDK disables mirror mode by default.
err: The state or error information: Error.

SetRenderMode

Sets the vide render mode.

void SetRenderMode(VideoRenderMode mode, Error *err = nullptr);

Since: v4.5.0

Call timing

Call this method after SetConfigs [3/3].

Restrictions

None.

Parameters

mode: The video rendering mode. See RteVideoRenderMode. The default rendering mode is kRteVideoRenderModeHidden, which means that the video size is scaled proportionally to fill the view.
err: The state or error information: Error.