ApsaraVideo Live:Implement RTS stream pulling on Android

Load the RTS library

Add System.loadLibrary("RtsSDK"); to the appropriate Activity as needed.

static {
    System.loadLibrary("RtsSDK");
}

Create a player

1. Create a player.

   You can create an AliPlayer using the AliPlayerFactory class.

   // Create a player instance
   AliPlayer mAliPlayer = AliPlayerFactory.createAliPlayer(context);
   // Pass in the traceId
   // Optional: We recommend using the 'Player single-point tracing' feature. When an exception occurs during video playback using ApsaraVideo Player SDK, use the single-point tracing feature to perform full-link tracing of abnormal playback behavior for a specific user or playback session. This helps you quickly diagnose the cause of the problem and effectively improve playback experience administration efficiency.
   // Define the traceId value yourself. It must be a unique identifier for your user or user device, such as your business's user ID, IMEI, or IDFA.
   mAliPlayer.setTraceId("traceId");

   Note

   The player provides the Playback Quality Monitoring feature (to view data about overall playback quality), the Single-Point Troubleshooting feature (to locate a specific user or device, analyze their playback behavior, and quickly identify playback abnormalities), and the Video Playback Statistics feature—all of which rely on the instrumentation log reporting feature.

   When you create a player, the available features are determined by the setting of the setTraceId parameter, as follows:

   • If the setTraceId parameter is not passed (default): The instrumentation log reporting feature is enabled. You can then use the playback quality monitoring and video playback statistics features, but the single-point tracing feature is not available.

   • If you pass the setTraceId parameter with a trace ID, you define the trace ID value yourself. It must be a unique identifier for your user or user device, such as your business's user ID, IMEI, or IDFA. After you pass the trace ID, the instrumentation log reporting feature is enabled. You can then use playback quality monitoring, single-point tracing, and video playback statistics.

   • If you set the setTraceId parameter to DisableAnalytics, instrumentation log reporting is disabled. You cannot use the playback quality monitoring, single-point tracing, or video playback statistics features.

2. Set the display view.

   The player supports AliDisplayView (recommended), SurfaceView, and TextureView. Choose one as needed.

   1. Declare the view in the XML file.

      AliDisplayView (recommended)

      <!-- Player rendering view -->
      <com.aliyun.player.videoview.AliDisplayView
          android:id="@+id/ali_display_view"
          android:layout_width="match_parent"
          android:layout_height="match_parent"
          android:layout_gravity="center" />

      SurfaceView

      <!-- Player rendering view -->
      <SurfaceView
          android:id="@+id/surface_view"
          android:layout_width="match_parent"
          android:layout_height="match_parent"
          android:layout_gravity="center" />

      TextureView

      <!-- Player rendering view -->
      <TextureView
          android:id="@+id/texture_view"
          android:layout_width="match_parent"
          android:layout_height="match_parent"
          android:layout_gravity="center" />

   2. Set the display view.

      AliDisplayView (recommended)

      Call the player's setDisplayView interface to bind the player view.

      AliDisplayView mAliDisplayView = findViewById(R.id.display_view);
      // Set the playback view type using setPreferDisplayView()
      mAliDisplayView.setPreferDisplayView(AliDisplayView.DisplayViewType.SurfaceView);
      mAliPlayer.setDisplayView(mAliDisplayView);

      SurfaceView

      Call the player's setSurface interface to bind the player view.

      SurfaceView mSurfaceView = findViewById(R.id.surface_view);
      mSurfaceView.getHolder().addCallback(new SurfaceHolder.Callback() {
          @Override
          public void surfaceCreated(@NonNull SurfaceHolder holder) {
              mAliPlayer.setSurface(holder.getSurface());
          }
      
          @Override
          public void surfaceChanged(@NonNull SurfaceHolder holder, int format, int width, int height) {
              mAliPlayer.surfaceChanged();
          }
      
          @Override
          public void surfaceDestroyed(@NonNull SurfaceHolder holder) {
              mAliPlayer.setSurface(null)
          }
      });

      TextureView

      Call the player's setSurface interface to bind the player view.

      TextureView mTextureView = findViewById(R.id.texture_view);
      mTextureView.setSurfaceTextureListener(new TextureView.SurfaceTextureListener() {
          @Override
          public void onSurfaceTextureAvailable(@NonNull SurfaceTexture surface, int width, int height) {
              mAliPlayer.setSurface(new Surface(surface));
          }
      
          @Override
          public void onSurfaceTextureSizeChanged(@NonNull SurfaceTexture surface, int width, int height) {
              mAliPlayer.surfaceChanged();
          }
      
          @Override
          public boolean onSurfaceTextureDestroyed(@NonNull SurfaceTexture surface) {
              mAliPlayer.setSurface(null);
              return true;
          }
      
          @Override
          public void onSurfaceTextureUpdated(@NonNull SurfaceTexture surface) {
      
          }
      });

3. Set the playback source.

   The player supports four playback sources: VidSts, VidAuth, VidMps, and UrlSource. UrlSource is for direct URL playback. Set the URL to the artc:// protocol to use the RTS service.

   UrlSource urlSource = new UrlSource();
   urlSource.setUri("artc://<Streaming URL>");
   mAliPlayer.setDataSource(urlSource);

   Note

   For more information about methods to set the playback source, see Basic Features.

4. Configure playback parameters.

   Configure playback parameters to improve RTS performance.

   Note

   ApsaraVideo Player SDK V6.3.0 and later support automatic optimal low-latency configuration. If the playback URL starts with "artc://" and you have not manually modified the mMaxDelayTime, mHighBufferDuration, and mStartBufferDuration values in PlayerConfig, the SDK automatically uses 1000, 10, and 10, respectively, for actual playback.

   To customize control, refer to the following example:

   // 1. Get and modify the configurations
   PlayerConfig config = mAliPlayer.getConfig();
   if (playUrl.startWith("artc://")) {
       // Maximum delay: 1000 milliseconds
       config.mMaxDelayTime = 1000;
       // Buffer duration for playback startup: 10 milliseconds
       config.mStartBufferDuration = 10;
       // Buffer duration for stuttering recovery: 10 milliseconds
       config.mHighBufferDuration = 10;
   } else {
       // Use default configurations or customize to other configurations
   }
   
   // 2. Apply the configurations
   mAliPlayer.setConfig(config);

5. Start playback.

   // Prepare for playback
   mAliPlayer.prepare();
   // Start playback
   mAliPlayer.start();

Control playback

The ApsaraVideo Player SDK for Android supports operations such as playing from a specific point in time, starting, and stopping playback.

1. Start playback.

   This refers to starting video playback, implemented by the start interface. For example:

   mAliPlayer.start();

2. Stop playback.

   This refers to stopping video playback, implemented by the stop interface. For example:

   mAliPlayer.stop();

3. Destroy the player.

   Destroy the player instance using either synchronous or asynchronous destruction methods, as follows:

   // Synchronous destruction. The system automatically calls the stop interface.
   mAliPlayer.release();
   // Asynchronous destruction. The system automatically calls the stop interface.
   mAliPlayer.releaseAsync();	

   Note

   The synchronous destruction method returns only after player resources are fully released. If you have high requirements for UI response speed, use the asynchronous destruction method and note the following:

   1. Avoid performing any other operations on the player object during asynchronous destruction.

   2. You do not need to manually stop the player before calling the asynchronous destruction method, because the process internally includes an asynchronous stop flow.

Auxiliary Features

1. Log switch.

   // Enable logging
   Logger.getInstance(context).enableConsoleLog(true);
   Logger.getInstance(context).setLogLevel(Logger.LogLevel.AF_LOG_LEVEL_TRACE);
   // Disable logging
   Logger.getInstance(context).enableConsoleLog(false);
   Logger.getInstance(context).setLogLevel(Logger.LogLevel.AF_LOG_LEVEL_NONE);

2. Live RTS degradation.

   Note

   • Playback failure degradation applies only to timeout scenarios. If any of the following degradation schemes are configured in a playback timeout scenario, degraded playback processing occurs; otherwise, the player's onError callback is triggered. For example, exceptions such as 404, 403, or streamer disconnection do not trigger degradation.

   • RTS automatic degradation uses the same domain name to achieve RTS to FLV degradation. If your RTS and FLV domain names are different, configure the RTS custom degradation scheme to specify the target FLV domain name.

   1. RTS automatic degradation (enabled by default)

      In scenarios where Real-Time Streaming (RTS) addresses are used for playback, if RTS custom degradation is not configured and RTS stream pulling fails, the system automatically degrades to the default FLV address corresponding to RTS for playback. For example:

      // 1 means enabled, 0 means disabled. Enabled by default.
      AliPlayerGlobalSettings.setOption(AliPlayerGlobalSettings.ALLOW_RTS_DEGRADE, 1);

   2. RTS custom degradation

      In scenarios where Real-Time Streaming (RTS) addresses are used for playback, by setting the RTS degradation address (such as an HLS or FLV address), if RTS stream pulling fails, the system automatically degrades to that address for playback. For example:

      PlayerConfig config = mAliPlayer.getConfig();
      // Optional: Configure other items in config
      UrlSource urlSource = new UrlSource();
      urlSource.setUri(downgradeUrl);
      // Set the degradation URL
      mAliPlayer.enableDowngrade(urlSource, config);

3. Obtain the TraceID.

   Each low-latency playback has a traceId, which is used for troubleshooting. Obtain the traceId through the player event callback.

   // Listen for the player's onInfo callback and parse the DemuxerTraceID message
   mAliPlayer.setOnInfoListener(infoBean -> {
       if (infoBean.getCode() == InfoCode.DemuxerTraceID) {
           String traceId = infoBean.getExtraMsg();
   });