Home
Voice SDK for Android
PlayerConfig
This class provides methods relevant to player settings.

Voice SDK for Android
- API Overview
  Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through SD-RTN™.
- Lite SDK API List
  This page lists the APIs supported by Lite SDK.
- RtcEngine
  The basic interface of the Agora SDK that implements the core functions of real-time communication.
- RtcEngineEx
  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.
- IAudioEffectManager
  This class provides audio management methods.
- IAudioEncodedFrameObserver
  The encoded audio observer.
- IMediaExtensionObserver
  Extension event callback interface class.
- IMediaPlayer
  This class provides media player functions and supports multiple instances.
- IMediaPlayerAudioFrameObserver
  The audio frame observer for the media player.
- IMediaPlayerCacheManager
  This class provides methods to manage cached media files.
- IMediaPlayerCustomDataProvider
  The callback for custom media resource files.
- IMediaPlayerObserver
  Provides callbacks for media players.
- IMediaPlayerVideoFrameObserver
  The video frame observer for the media player.
- IAudioFrameObserver
  The audio frame observer.
- IMediaEngine
  The IMediaEngine class.
- IFaceInfoObserver
  Facial information observer.
- IAudioSpectrumObserver
  The audio spectrum observer.
- IMetadataObserver
  The metadata observer.
- IVideoEncodedFrameObserver
  Receives encoded video images.
- IVideoFrameObserver
  The IVideoFrameObserver class.
- ILocalSpatialAudioEngine
  This class calculates user positions through the SDK to implement the spatial audio effect.
- 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.
- PlayerGetStatsCallback
  This class provides callbacks which report the result of synchorous operations that gets the statistics of the media resources.
- AsyncCallback
  This class provides callbacks that report the result of asychronous operations.
- Rte
  The fundamental interface class of the RTE API, which provides major methods for enabling real-time audio video interaction.
- RteException
  The exception information of the Rte Object.
- Class and Enum
  This page lists all the definitions of Class and the enums for Android.
- API Sunset Notice
  This page introduces the deprecated and deleted APIs in the SDK.

PlayerConfig

This class provides methods relevant to player settings.

public class PlayerConfig {
  public void setAutoPlay(boolean autoPlay) throws RteException;
  public boolean getAutoPlay() throws RteException;
  public void setAbrSubscriptionLayer(Constants.AbrSubscriptionLayer subscriptionLayer) throws RteException;
  public Constants.AbrSubscriptionLayer getAbrSubscriptionLayer() throws RteException;
  public void setAbrFallbackLayer(Constants.AbrFallbackLayer fallbackLayer) throws RteException;
  public Constants.AbrFallbackLayer getAbrFallbackLayer() throws RteException;
}

Since: v4.5.0

Method

setAutoPlay: The error code. See setAutoPlay.
getAutoPlay: Gets the autoplay settings. See getAutoPlay.

getAutoPlay

Gets the autoplay settings.

public boolean getAutoPlay() throws RteException;

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.

Returns

Whether the autoplay settings are retrieved:

true: Yes.
false: No.

Exception

If the method call fails, the SDK throws RteException and returns an error message. You need to catch the exception and handle it.

setAutoPlay

The error code.

public void setAutoPlay(boolean autoPlay) throws RteException;

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

autoPlay

Whether to enable autoplay:

true: (Default) Yes.
false: No.

Exception

If the method call fails, the SDK throws RteException and returns an error message. You need to catch the exception and handle it.