ApsaraVideo Live:Live stream recording

In the console

1. Log on to the ApsaraVideo Live console.

2. In the left-side navigation pane, select Feature Management > Recording. Click the VOD tab.

3. Select the streaming domain for which you want to configure recording, and click Add.

4. Configure the recording template.

   

   Parameters	Description
   Application Name	To configure recording for all applications under the domain name, enter an asterisk (*).  To configure it for a specific application, the value must be the same as the AppName specified in the ingest URL of the stream.
   Stream Name	To configure recording for all streams under an application, enter an asterisk (*).  To configure it for a specific stream, enter the stream name.
   Bucket	The VOD buckets created in the current region are displayed. Select one of them. If not displayed, click the refresh button on the right.
   Recording Cycle	The recording cycle specifies the maximum duration of a live-to-VOD file. Valid values: 15 to 360 minutes. When a recording exceeds 360 minutes, the system generates a new file according to the naming rules. The default duration of each TS segment is 30 seconds.
   Transcoding Settings	Optional. Select a transcoding template retrieved from ApsaraVideo VOD. The recording will be transcoded in ApsaraVideo VOD. Note The transcoding template must be created in the same region as the live center of the domain name.
   Auto Merge	When enabled, the system automatically merges recordings of multiple cycles into a single file after the live program ends. The original recordings are also retained. Auto merge uses the basic editing and transcoding features of ApsaraVideo VOD, which incur additional fees. For billing information, see Editing and production and Media transcoding.
   Transcoding Settings of Merged Video	Select a transcoding template retrieved from ApsaraVideo VOD. The merged video will be transcoded in ApsaraVideo VOD. Note The transcoding template must be created in the same region as the live center of the domain name.

5. Click OK.

By API

Call the AddLiveRecordVodConfig operation to add a live-to-VOD configuration.

Sample code of basic settings

// Replace the placeholder values with actual values.
DefaultProfile profile = DefaultProfile.getProfile("<regionId>", "<ALIBABA_CLOUD_ACCESS_KEY_ID>", "<ALIBABA_CLOUD_ACCESS_KEY_SECRET>");
IAcsClient client = new DefaultAcsClient(profile);   
AddLiveRecordVodConfigRequest addLiveRecordVodConfigRequest=new AddLiveRecordVodConfigRequest();
addLiveRecordVodConfigRequest.setDomainName("<DomainName>");
addLiveRecordVodConfigRequest.setAppName("<AppName>");
addLiveRecordVodConfigRequest.setStreamName("<StreamName>");
addLiveRecordVodConfigRequest.setVodTranscodeGroupId("VOD_NO_TRANSCODE");
// The address of the VOD bucket.
addLiveRecordVodConfigRequest.setStorageLocation("<StorageLocation>");
AddLiveRecordVodConfigResponse addLiveRecordVodConfigResponse = null;
try {
    addLiveRecordVodConfigResponse = client.getAcsResponse(addLiveRecordVodConfigRequest);
} catch (ClientException e) {
    e.printStackTrace();
}
 System.out.println(new Gson().toJson(addLiveRecordVodConfigResponse));

In the preceding sample code, a Live-to-VOD configuration is added for a specific stream <StreamName> that belongs to the <AppName> application under the domain name <DomainName>. The recordings are saved to an ApsaraVideo VOD bucket <StorageLocation>. VOD_NO_TRANSCODE specifies that recordings are not transcoded.

 addLiveRecordVodConfigRequest.setVodTranscodeGroupId("<TranscodeGroupId>");

// Unit: seconds. Valid values: 300 to 21600. Default value: 900.
addLiveRecordVodConfigRequest.setCycleDuration(<300>);

addLiveRecordVodConfigRequest.setAutoCompose("ON");
addLiveRecordVodConfigRequest.setComposeVodTranscodeGroupId("<TranscodeGroupId>");

In the console

1. Log on to the ApsaraVideo Live console.

2. In the left-side navigation pane, select Feature Management > Recording. Click the OSS tab.

3. Select the streaming domain for which you want to configure recording, and click Add.

4. Configure the recording template.

   

   Table 1. Recording settings

   Parameter	Description
   Application Name	To configure recording for all applications under the domain name, enter an asterisk (*).  To configure it for a specific application, the value must be the same as the AppName specified in the ingest URL of the stream.
   Stream Name	To configure recording for all streams under an application, enter an asterisk (*).  To configure it for a specific stream, enter the stream name. Note An asterisk (*) cannot be used as a wildcard character in a string.
   Storage Location	Select an OSS bucket that is created in the same region as the live center of the domain name. Note There are two types of buckets: Standard bucket: used for storage. Media buckets: customized for ApsaraVideo Media Processing (MPS). It can automatically transcode stored videos. The two types of buckets are not distinguished in the bucket list. To use a media bucket, note down its name.
   Interruption Duration Threshold	If the stream interruption duration exceeds the threshold, a new recording is generated. Otherwise, the content before and after the interruption are automatically merged. Valid values: 15 to 21600 seconds.
   Storage Format	Supported formats: FLV, M3U8, MP4, and CMAF. Select at least one format. You cannot select CMAF and M3U8 at the same time.
   Naming Conventions	Default storage path: record/{AppName}/{StreamName}/{EscapedStartTime}_{EscapedEndTime}. The system automatically add the transcoding template ID to StreamName. Example: If you set Application Name to liveApp**** and Stream Name to liveStream****, the storage path of recordings in the M3U8 format is record/liveApp****/liveStream****/{EscapedStartTime}_{EscapedEndTime }.
   Segment Length	The duration of a TS segment. Unit: seconds. Default value: 30. Valid values: 5 to 30.
   Recording Cycle	The recording cycle specifies the maximum duration of a live-to-VOD file. Valid values: 15 to 360 minutes. When a recording exceeds 360 minutes, the system generates a new file according to the naming rules.

5. Optional. Configure transcoding settings.

   You can use the transcoding feature of ApsaraVideo Live to transcode the live stream and record the transcoded stream.

   Important

   This will incur transcoding fees in ApsaraVideo Live.

   

   Table 2. Transcoded stream recording settings

   Parameter	Description
   Transcoded Stream Recording	Turn on the switch to enable transcoding and recording.
   Storage Format	Supported formats: FLV, M3U8, MP4, and CMAF. Select at least one format. You cannot select CMAF and M3U8 at the same time.
   Naming Conventions	Default storage path: transcodeRecord/{AppName}/{StreamName}/{EscapedStartTime }_{EscapedEndTime }. The system automatically adds _transcoding template ID to {StreamName}. Example: If you set AppName to liveApp****, StreamName to liveStream****, and Transcoding Template ID to lld, the storage path of transcoded stream recordings in the M3U8 format is transcodeRecord/liveApp****/liveStream****_lld/{EscapedStartTime}_{EscapedEndTime }.
   Segment Length	The duration of a TS segment. Unit: seconds. Default value: 30. Valid values: 5 to 30.
   Recording Cycle	The recording cycle specifies the maximum duration of a live-to-VOD file. Valid values: 15 to 360 minutes. When a recording exceeds 360 minutes, the system generates a new file according to the naming rules.
   Transcoding Template ID	You can select All Templates or up to 10 transcoding templates.  Make sure that the application name in the transcoding template is the same as in the recording template.

6. Click OK.

By API

Call the AddLiveAppRecordConfig operation to add a recording template to store live content to OSS.

Sample code of basic settings

        // Replace the placeholder values with actual values.
        DefaultProfile profile = DefaultProfile.getProfile("<regionId>", "<ALIBABA_CLOUD_ACCESS_KEY_ID>", "<ALIBABA_CLOUD_ACCESS_KEY_SECRET>");
        IAcsClient client = new DefaultAcsClient(profile);   
        AddLiveAppRecordConfigRequest addLiveAppRecordConfigRequest=new AddLiveAppRecordConfigRequest();
        addLiveAppRecordConfigRequest.setAppName("<AppName>");
        addLiveAppRecordConfigRequest.setStreamName("<StreamName>");
        addLiveAppRecordConfigRequest.setDomainName("<DomainName>");
        addLiveAppRecordConfigRequest.setOssEndpoint("<OssEndpoint>");
        addLiveAppRecordConfigRequest.setOssBucket("<OssBucket>");
        List<AddLiveAppRecordConfigRequest.RecordFormat> formatList=new ArrayList<AddLiveAppRecordConfigRequest.RecordFormat>();
        AddLiveAppRecordConfigRequest.RecordFormat m3u8Format=new AddLiveAppRecordConfigRequest.RecordFormat();
        m3u8Format.setFormat("m3u8");
        // The naming convention for the recording files in OSS.
        m3u8Format.setOssObjectPrefix("<record/{AppName}/{StreamName}/{EscapedStartTime}_{EscapedEndTime}>");
        // The naming convention for segments.
        m3u8Format.setSliceOssObjectPrefix("<record/{AppName}/{StreamName}/{UnixTimestamp}_{Sequence}>");
        formatList.add(m3u8Format);
        addLiveAppRecordConfigRequest.setRecordFormats(formatList);
        AddLiveAppRecordConfigResponse addLiveAppRecordConfigResponse = null;
        try {
            addLiveAppRecordConfigResponse = client.getAcsResponse(addLiveAppRecordConfigRequest);
        } catch (ClientException e) {
            e.printStackTrace();
        }
        System.out.println(new Gson().toJson(addLiveAppRecordConfigResponse));

In the preceding sample code, a configuration is added for a specific stream <StreamName> that belongs to the <AppName> application under the domain name <DomainName>. The recordings are saved to an OSS bucket <OssBucket>. The storage format is m3u8.

        // Replace the placeholder values with actual values.        
        List<AddLiveAppRecordConfigRequest.TranscodeRecordFormat> transcodeFormatList=new ArrayList<AddLiveAppRecordConfigRequest.TranscodeRecordFormat>();
        AddLiveAppRecordConfigRequest.TranscodeRecordFormat m3u8TranscodeFormat=new AddLiveAppRecordConfigRequest.TranscodeRecordFormat();
        m3u8TranscodeFormat.setFormat("m3u8");
        // The naming convention for the transcoded recording files in OSS.
        m3u8TranscodeFormat.setOssObjectPrefix("<transcodeRecord/{AppName}/{StreamName}/{EscapedStartTime}_{EscapedEndTime}>");
        // The naming convention for transcoded segments.
        m3u8TranscodeFormat.setSliceOssObjectPrefix("<transcodeRecord/{AppName}/{StreamName}/{UnixTimestamp}_{Sequence}>");
        transcodeFormatList.add(m3u8TranscodeFormat);
        addLiveAppRecordConfigRequest.setTranscodeRecordFormats(transcodeFormatList);
        List<String> transcodeTemplateList=new ArrayList<String>();
        // The transcoding template ID.
        transcodeTemplateList.add("<lld>");
        addLiveAppRecordConfigRequest.setTranscodeTemplatess(transcodeTemplateList);

On-demand recording

To implement on-demand recording, your business server must provide a callback URL for ApsaraVideo Live. For more information, see Callbacks for on-demand recording. 

Sample code

        // Set OnDemand to 1, which indicates that on-demand recording is enabled through HTTP callbacks.
        addLiveAppRecordConfigRequest.setOnDemand(1);

Call the AddLiveRecordNotifyConfig operation to configure recording callbacks for a domain name.

        // Replace the placeholder values with actual values.
        AddLiveRecordNotifyConfigRequest addLiveRecordNotifyConfigRequest=new AddLiveRecordNotifyConfigRequest();
        // Specify a callback URL for on-demand recording.
        addLiveRecordNotifyConfigRequest.setOnDemandUrl("<OnDemandUrl>");
        addLiveRecordNotifyConfigRequest.setNotifyUrl("<NotifyUrl>");
        addLiveRecordNotifyConfigRequest.setDomainName("<DomainName>");
        AddLiveRecordNotifyConfigResponse addLiveRecordNotifyConfigResponse = null;
        try {
            addLiveRecordNotifyConfigResponse = client.getAcsResponse(addLiveRecordNotifyConfigRequest);
        } catch (ClientException e) {
            e.printStackTrace();
        }
        System.out.println(new Gson().toJson(addLiveRecordNotifyConfigResponse));

Manual recording

To enable manual recording, you must disable automatic recording. Sample code:

        // Set the OnDemand parameter to 7, which disables automatic recording. 
        addLiveAppRecordConfigRequest.setOnDemand(7);

During live streaming, call the RealTimeRecordCommand operation and set Command to start to start recording. 

        // Replace the placeholder values with actual values.
        RealTimeRecordCommandRequest realTimeRecordCommandRequest=new RealTimeRecordCommandRequest();
        realTimeRecordCommandRequest.setCommand("start");
        realTimeRecordCommandRequest.setAppName("<AppName>");
        realTimeRecordCommandRequest.setStreamName("<StreamName>");
        realTimeRecordCommandRequest.setDomainName("<DomainName>");
        RealTimeRecordCommandResponse realTimeRecordCommandResponse = null;
        try {
            realTimeRecordCommandResponse = client.getAcsResponse(realTimeRecordCommandRequest);
        } catch (ClientException e) {
            e.printStackTrace();
        }
        System.out.println(new Gson().toJson(realTimeRecordCommandResponse));