Home
Video SDK for C++
PlayerConfig
This class provides methods relevant to player settings.

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.

PlayerConfig

This class provides methods relevant to player settings.

class PlayerConfig {
 public:
  void SetAutoPlay(bool auto_play, Error *err = nullptr);
  bool GetAutoPlay(Error *err = nullptr);
  void SetAbrSubscriptionLayer(AbrSubscriptionLayer abr_subscription_layer, Error *err = nullptr);
  AbrSubscriptionLayer GetAbrSubscriptionLayer(Error *err = nullptr);
  void SetAbrFallbackLayer(AbrFallbackLayer abr_fallback_layer, Error *err = nullptr);
  AbrFallbackLayer GetAbrFallbackLayer(Error *err = nullptr);
};

Since: v4.5.0

Method

SetAutoPlay: The error code. See SetAutoPlay.
GetAutoPlay: Gets the autoplay settings. See GetAutoPlay.

GetAutoPlay

Gets the autoplay settings.

bool GetAutoPlay(Error *err = nullptr);

Since: v4.5.0

You can call this method to get the autoplay settings of the current player.

Call timing

Call this method after GetConfigs [2/3].

Restrictions

None.

Parameters

err: The state or error information: Error.

Returns

Whether the autoplay settings are retrieved:

true: Yes.
false: No.

SetAutoPlay

The error code.

void SetAutoPlay(bool auto_play, Error *err = nullptr);

Since: v4.5.0

Before you call OpenWithUrl to open the media stream, you can call this method to set whether to enable autoplay. The default setting is to enable autoplay.

Call timing

Call this method after OpenWithUrl.

Restrictions

None.

Parameters

auto_play

Whether to enable autoplay:

true: (Default) Yes.
false: No.

err

The state or error information: Error.