Best practices for calling API operations to use a production studio in playlist mode

Overview

Prerequisites

• An Alibaba Cloud account is created and has passed real-name verification.

• ApsaraVideo VOD and ApsaraVideo Live are activated. The production studio feature is enabled in ApsaraVideo Live. For more information, see Activate ApsaraVideo VOD, Activate ApsaraVideo Live and purchase resource plans, and Enable the production studio feature.

  Note

  The production studio feature is supported only in the China (Shanghai), China (Beijing), Singapore, and Indonesia (Jakarta) regions, and will be supported in more regions.

• A streaming domain is prepared. We recommend that you use regions outside the Chinese mainland as the live center and acceleration region of the streaming domain. This way, you do not need to apply for an Internet content provider (ICP) filing for the streaming domain.

• The AliyunFCFullAccess, AliyunLiveFullAccess, and AliyunVODFullAccess policies are attached to a Resource Access Management (RAM) user. For more information, see Create a RAM user and grant permissions to the RAM user.

Step 1: Enable the VOD bucket

Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Configuration Management > Media Management > Storage. On the Storage page, find the VOD bucket that you want to enable and click Enable in the Actions column.

Step 2: Upload videos

1. Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video. On the page that appears, click Upload.

2. On the Upload Media page, click Add Media.

   

3. In the Add Media dialog box, select From Local for the Upload Method parameter and select three prepared videos from your local device. Then, click Upload.

   

4. After the videos are uploaded, view and record their resource IDs on the Audio/Video page. To allow the videos to be available in production studios in the ApsaraVideo Live console, choose More > Make Available on Cloud Studio in the Actions column. For information about the functional areas of a production studio, see Functional areas.

   

Step 3: Add a streaming domain

1. Log on to the ApsaraVideo Live console. In the left-side navigation pane, click Domain Names. On the Domain Management page, click Add Domain.

2. In the Add Domain Name step, configure parameters based on your business requirements. Click Next. For more information about the parameters, see Add an accelerated domain name.

   

3. Record the generated CNAME for subsequent use.

   

4. On the Domain Name Resolution page of the Alibaba Cloud DNS console, find the domain name for which you want to add a CNAME record and click DNS Settings in the Actions column.

5. On the DNS Settings tab, click Add DNS Record. In the Add DNS Record panel, configure the parameters and click OK. For more information, see Add a CNAME record.

   

Step 4: Call an API operation to configure a production studio in playlist mode

1. Open Intellij IDEA and create a Maven project. In the pom.xml file, create a <dependencies></dependencies> tag and add the following dependencies:

   <dependencies>
           <dependency>
              <groupId>com.aliyun</groupId>
              <artifactId>aliyun-java-sdk-live</artifactId>
              <version>3.9.52</version>
           </dependency>
           <dependency>
               <groupId>com.aliyun</groupId>
               <artifactId>aliyun-java-sdk-core</artifactId>
               <version>4.6.3</version>
           </dependency>
           <dependency>
               <groupId>com.alibaba</groupId>
               <artifactId>fastjson</artifactId>
               <version>1.2.76</version>
           </dependency>
       </dependencies>

2. In the src/main/java directory, right-click the menu to create a Java class. In this example, the Java class is named bodan.

3. Configure the following parameters and run the sample code.

   package com.alibaba.aliyundebug.common;
   
   import com.alibaba.fastjson.JSON;
   import com.alibaba.fastjson.JSONArray;
   import com.alibaba.fastjson.JSONObject;
   import com.aliyun.live20161101.Client;
   import com.aliyuncs.AcsResponse;
   import com.aliyuncs.CommonRequest;
   import com.aliyuncs.CommonResponse;
   import com.aliyuncs.DefaultAcsClient;
   import com.aliyuncs.exceptions.ClientException;
   import com.aliyuncs.live.model.v20161101.*;
   import com.aliyuncs.profile.DefaultProfile;
   import com.aliyuncs.utils.StringUtils;
   import org.apache.commons.codec.digest.DigestUtils;
   import org.junit.jupiter.api.Test;
   
   import java.util.List;
   import java.util.Random;
   import java.util.UUID;
   
   public class Bodan {
       private final static String ACCESS_KEY_ID = "xxxx";
       private final static String ACCESS_KEY_SECRET = "xxxx";
   
   
       public static DefaultAcsClient initClient(String accessKeyId, String accessKeySecret) throws ClientException {
           String regionId = "cn-shanghai";  
           DefaultProfile profile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
           DefaultAcsClient client = new DefaultAcsClient(profile);
           return client;
       }
   
   
       private static CreateCasterResponse createCaster(DefaultAcsClient client) throws ClientException {
           CreateCasterRequest request = new CreateCasterRequest();
   
           Random random = new Random();
           int i = random.nextInt(100000);
           request.setCasterName("casterName" + i);
   
           UUID uuid = UUID.randomUUID();
           String token = "thisIsaToken";
           String clientToken = DigestUtils.sha256Hex(token + uuid);
           request.setClientToken(clientToken);
   
           // Create a production studio in playlist mode. 
           request.setNormType(6);
           request.setChargeType("PostPaid");
   
           CreateCasterResponse response = client.getAcsResponse(request);
   
           System.out.println("The production studio is created. Response: " + JSON.toJSONString(response));
           return response;
       }
   
   
       private static void setCasterConfig(DefaultAcsClient client, String casterId) throws ClientException {
           SetCasterConfigRequest request = new SetCasterConfigRequest();
           request.setCasterId(casterId);
   
           // Specify the domain name.
           request.setDomainName("example.aliyundoc.com");
           JSONObject transcodeConfig = new JSONObject();
           JSONArray liveTemplate = new JSONArray();
           // Configure a template for the production studio.
           liveTemplate.add("lld");
           transcodeConfig.put("LiveTemplate", liveTemplate);
           // Configure a transcoding template.
           transcodeConfig.put("CasterTemplate", "lp_sd");
           request.setTranscodeConfig(transcodeConfig.toJSONString());
   
           SetCasterConfigResponse response = client.getAcsResponse(request);
           System.out.println("The production studio is configured. Request: " + response.getRequestId() + ". Response: " + JSON.toJSONString(response));
   
       }
   
       private static AcsResponse startCaster(DefaultAcsClient client, String casterId) throws ClientException {
           StartCasterRequest startCasterRequest = new StartCasterRequest();
           startCasterRequest.setCasterId(casterId);
           StartCasterResponse acsResponse = client.getAcsResponse(startCasterRequest);
           System.out.println("The production studio is started.");
           return acsResponse;
       }
   
       private static AcsResponse stopCaster(DefaultAcsClient client, String casterId) throws ClientException {
           StopCasterRequest stopCasterRequest = new StopCasterRequest();
           stopCasterRequest.setCasterId(casterId);
           StopCasterResponse acsResponse = client.getAcsResponse(stopCasterRequest);
           System.out.println("The production studio is stopped.");
           return acsResponse;
       }
   
       private static CommonResponse addShowIntoShowList(DefaultAcsClient client, String showName, String resourceId, String resourceUrl,
                                                         String resourceType, Integer spot, Integer repeatTimes,
                                                         String casterId, Long duration) throws ClientException {
           CommonRequest addShowIntoShowListRequest = new CommonRequest();
           addShowIntoShowListRequest.setSysDomain("live.aliyuncs.com");
           addShowIntoShowListRequest.setSysVersion("2016-11-01");
           addShowIntoShowListRequest.setSysAction("AddShowIntoShowList");
   
   
       
           if (casterId == null || resourceType == null) {
               return null;
           }
           if (resourceId == null && resourceUrl == null) {
               return null;
           }
           addShowIntoShowListRequest.putQueryParameter("CasterId", casterId);
           addShowIntoShowListRequest.putQueryParameter("ResourceType", resourceType);
           if (showName != null) {
               addShowIntoShowListRequest.putQueryParameter("ShowName", showName);
           }
           if (resourceUrl != null) {
               addShowIntoShowListRequest.putQueryParameter("ResourceUrl", resourceUrl);
           }
           if (resourceId != null) {
               addShowIntoShowListRequest.putQueryParameter("ResourceId", resourceId);
           }
           if (spot != null) {
               addShowIntoShowListRequest.putQueryParameter("Spot", spot.toString());
           }
           if (repeatTimes != null) {
               addShowIntoShowListRequest.putQueryParameter("RepeatTimes", repeatTimes.toString());
           }
           if (duration != null) {
               addShowIntoShowListRequest.putQueryParameter("Duration", duration.toString());
           }
           CommonResponse addShowIntoShowListResponse = client.getCommonResponse(addShowIntoShowListRequest);
           return addShowIntoShowListResponse;
       }
   
   
       private static void removeShowFromShowList(DefaultAcsClient client, String casterId, String showId) throws ClientException {
   
           CommonRequest removeShowFromShowListFromShowList = new CommonRequest();
           removeShowFromShowListFromShowList.setSysDomain("live.aliyuncs.com");
           removeShowFromShowListFromShowList.setSysVersion("2016-11-01");
           removeShowFromShowListFromShowList.setSysAction("RemoveShowFromShowList");
   
           removeShowFromShowListFromShowList.putQueryParameter("ShowId", showId);
           removeShowFromShowListFromShowList.putQueryParameter("CasterId", casterId);
   
           CommonResponse removeShowFromShowListFromShowListResponse = client.getCommonResponse(removeShowFromShowListFromShowList);
           System.out.println("The VOD file is deleted from the episode list. Response: " + JSON.toJSONString(removeShowFromShowListFromShowListResponse));
       }
   
       private static CommonResponse modfiyShowList(DefaultAcsClient client, String casterId, String showId, Integer repeatTimes, Integer spot,
                                                    String highPriorityShowId, String highPriorityShowStartTime) throws ClientException {
   
           CommonRequest modfiyShowListRequest = new CommonRequest();
           modfiyShowListRequest.setSysDomain("live.aliyuncs.com");
           modfiyShowListRequest.setSysVersion("2016-11-01");
           modfiyShowListRequest.setSysAction("ModifyShowList");
           if (casterId != null) {
               modfiyShowListRequest.putQueryParameter("CasterId", casterId);
           }
           if (showId != null) {
               modfiyShowListRequest.putQueryParameter("ShowId", showId);
           }
           if (repeatTimes != null) {
               modfiyShowListRequest.putQueryParameter("RepeatTimes", repeatTimes.toString());
           }
           if (spot != null) {
               modfiyShowListRequest.putQueryParameter("Spot", spot.toString());
           }
           if (highPriorityShowId != null) {
               modfiyShowListRequest.putQueryParameter("HighPriorityShowId", highPriorityShowId.toString());
           }
           if (highPriorityShowStartTime != null) {
               modfiyShowListRequest.putQueryParameter("HighPriorityShowStartTime", highPriorityShowStartTime.toString());
           }
           CommonResponse modfiyShowListResponse = client.getCommonResponse(modfiyShowListRequest);
           System.out.println("The episode list is modified. Response: " + JSON.toJSONString(modfiyShowListResponse));
           return modfiyShowListResponse;
   
       }
   
       private static CommonResponse describeShowList(DefaultAcsClient client, String casterId) throws ClientException {
   
           CommonRequest describeShowListRequest = new CommonRequest();
           describeShowListRequest.setSysDomain("live.aliyuncs.com");
           describeShowListRequest.setSysVersion("2016-11-01");
           describeShowListRequest.setSysAction("DescribeShowList");
           if (casterId != null) {
               describeShowListRequest.putQueryParameter("CasterId", casterId);
           }
           CommonResponse describeShowListRequestResponse = client.getCommonResponse(describeShowListRequest);
           System.out.println("The episode list is queried. Response: " + JSON.toJSONString(describeShowListRequestResponse));
           return describeShowListRequestResponse;
   
       }
   
       private static void playChoosenShow(DefaultAcsClient client, String casterId, String showId) throws ClientException {
           CommonRequest playChoosenShow = new CommonRequest();
           playChoosenShow.setSysDomain("live.aliyuncs.com");
           playChoosenShow.setSysVersion("2016-11-01");
           playChoosenShow.setSysAction("playChoosenShow");
           playChoosenShow.putQueryParameter("CasterId", casterId);
           playChoosenShow.putQueryParameter("ShowId", showId);
           CommonResponse playChoosenShowResponse = client.getCommonResponse(playChoosenShow);
           System.out.println("Successfully switched to "+showId+ ".");
       }
   
   
       private static List<DescribeCasterStreamUrlResponse.CasterStream> describeCasterStreamUrl(DefaultAcsClient client, String casterId) throws ClientException {
           DescribeCasterStreamUrlRequest describeCasterStreamUrlRequest = new DescribeCasterStreamUrlRequest();
           describeCasterStreamUrlRequest.setCasterId(casterId);
           DescribeCasterStreamUrlResponse acsResponse = client.getAcsResponse(describeCasterStreamUrlRequest);
           List<DescribeCasterStreamUrlResponse.CasterStream> casterStreams = acsResponse.getCasterStreams();
           return casterStreams;
       }
   
       public static void main(String[] args) throws ClientException {
           DefaultAcsClient client = null;
           try {
               client = initClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
               // Create a production studio.
               CreateCasterResponse caster = createCaster(client);
               String casterId = caster.getCasterId();
               // Configure the production studio.
               setCasterConfig(client, casterId);
   
               // Add three VOD files to the episode list in sequence. Play the first VOD file once, the second VOD file twice, and the third VOD file three times.
               String[] resourceIds = new String[]{"698d2b23581f476ea71107703e64****", "9c97e83e211a435b9f797e4e20ee****", "76c6addaa41c438985666a8a964f****"};
               for (int i = 0; i < resourceIds.length; i++) {
                   String showName = "ShowName#" + i;
                   Integer repeatTimes = i;
                   addShowIntoShowList(client, showName, resourceIds[i], null, "vod", null, repeatTimes, casterId, null);
               }
               modfiyShowList(client, casterId, null, 10, null, null, null);
               CommonResponse describeShowList = describeShowList(client, casterId);
               String data = describeShowList.getData();
               JSONObject jsonObject = JSON.parseObject(data);
               JSONObject showList = jsonObject.getJSONObject("ShowList");
               JSONArray shows = showList.getJSONArray("Shows");
               // Display the episode list information.
               for (int i = 0; i < shows.size(); i++) {
                   JSONObject show = (JSONObject) shows.get(i);
                   String showId = show.getString("ShowId");
                   String resourceType = show.getString("ResourceType");
                   String resourceInfo = show.getString("ResourceInfo");
                   Integer repeatTimes = show.getInteger("RepeatTimes");
                   Long duration = show.getLong("Duration");
                   String showInfo = String.format("show%d: showId: %s \n resourceType: %s  \n  resourceInfo: %s \n RepeatTimes: %d \n Duration: %d",
                           i + 1, showId, resourceType, resourceInfo, repeatTimes, duration);
                   System.out.println(showInfo);
               }
   
               startCaster(client, casterId);
   
               Thread.sleep(500000);
   
               stopCaster(client, casterId);
   
   
           } catch (ClientException | InterruptedException e) {
               e.printStackTrace();
           }
       }
   }

   Parameter description:

   Parameter	Description

   Parameter	Description
   private final static String ACCESS_KEY_ID = "AccessKey ID"; private final static String ACCESS_KEY_SECRET = "AccessKey Secret";	You must use an AccessKey pair to complete identity verification. An AccessKey pair consists of an AccessKey ID and an AccessKey secret. The AccessKey ID is used to verify the identity of a user. The AccessKey secret is used to verify the key of a user. You must keep your AccessKey secret confidential. For more information, see Create an AccessKey pair.
   request.setDomainName("example.aliyundoc.com");	The streaming domain.
   String[] resourceIds = new String[]{"698d2b23581f476ea71107703e64****", "9c97e83e211a435b9f797e4e20ee****", "76c6addaa41c438985666a8a964f****"};	The resource IDs. For more information, see the Step 2: Upload videos section of this topic.

4. View the result.

   

5. On the Production Studio Management page, find the created production studio and click Open in the Actions column. You can see that the three VOD files are added to the episode list in sequence and can be played based on the configurations.

   

   

What to do next

If you want to play the videos, click Streaming URL in the production studio. Copy the URLs and use VLC media player, Push SDK demo, or ApsaraVideo Player SDK to play the videos. For more information, see Live stream playback.