ApsaraVideo Live:Live stream recording

Method one: Console configuration

1. Log on to the ApsaraVideo Live console.

2. In the left-side navigation pane, select Feature Management > Live Stream Recording to go to the Live Stream Recording page, and then select the Store To VOD Configuration tab.

3. Select the streaming domain that you want to configure, and click Add.

4. Configure the recording template.

   

   The parameters and descriptions of the recording template are shown in the following table.

   Parameters	Description
   AppName	The application name of the video. The AppName you enter must be consistent with the AppName of the stream ingest to take effect. If you want to record at the domain name level, you can enter an asterisk (*).
   StreamName	You can store the recording files of a specific live stream in ApsaraVideo VOD. You only need to enter the specified stream name. If you want to record all streams, which means recording all streams under the AppName, you can enter an asterisk (*). Note AppName and StreamName parameters support English letters, numbers, "-", and "_" characters, with a length limit of 255 characters.
   Storage Address	Select a storage location.
   Recording Cycle	Recording Cycle is the maximum duration after the current live stream is converted to a video-on-demand file. The range is 15 to 360 minutes, with a maximum recording time of 6 hours. If the recording exceeds 6 hours, the system generates a new file based on the recording naming convention. The default ts segment length is 30 seconds.
   Recording Transcoding Template	Select a storage transcoding rule from the drop-down list. You can transcode the recorded videos in the video-on-demand service. You can transcode the videos to different formats or retain the original quality without transcoding. Recording and transcoding template operations, please see ApsaraVideo VOD transcoding configuration. Note The region of the transcoding template that you use in ApsaraVideo VOD must be the same as the region of your domain name. For example, if your domain name resides in the China (Shanghai) region, the transcoding template that you use in ApsaraVideo VOD must also reside in the China (Shanghai) region.
   Auto Merge Switch	After you enable this feature, multiple recording cycle files can be automatically merged into one recording file and stored in VOD after the live stream recording ends. Note After you enable the auto merging of recording files of multiple cycles, the editing and production feature and the transcoding feature of ApsaraVideo VOD are required. For billing details, see Billing of editing and production and Billing of media transcoding.
   Custom Merge Transcoding Template	Select a transcoding template from the drop-down list, which is obtained from the current video-on-demand system. The system performs transcoding on the automatically merged video in the video-on-demand service based on the settings of the transcoding template. For more information about operations on automatic merge transcoding templates, see Transcoding templates. Note The region of the transcoding template that you use in ApsaraVideo VOD must be the same as the region of your domain name. For example, if your domain name resides in the China (Shanghai) region, the transcoding template that you use in ApsaraVideo VOD must also reside in the China (Shanghai) region.

5. Click OK.

Method 2: API configuration

Call the AddLiveRecordVodConfig - Add live stream recording to video-on-demand configuration interface to add configuration. The SDK call reference is as follows:

//Replace the content in angle brackets with actual values
DefaultProfile profile = DefaultProfile.getProfile("", "", "");
IAcsClient client = new DefaultAcsClient(profile);   
AddLiveRecordVodConfigRequest addLiveRecordVodConfigRequest=new AddLiveRecordVodConfigRequest();
addLiveRecordVodConfigRequest.setDomainName("");
addLiveRecordVodConfigRequest.setAppName("");
addLiveRecordVodConfigRequest.setStreamName("");
addLiveRecordVodConfigRequest.setVodTranscodeGroupId("VOD_NO_TRANSCODE");
//The address of the VOD bucket.
addLiveRecordVodConfigRequest.setStorageLocation("");
AddLiveRecordVodConfigResponse addLiveRecordVodConfigResponse = null;
try {
    addLiveRecordVodConfigResponse = client.getAcsResponse(addLiveRecordVodConfigRequest);
} catch (ClientException e) {
    e.printStackTrace();
}
 System.out.println(new Gson().toJson(addLiveRecordVodConfigResponse));

 addLiveRecordVodConfigRequest.setVodTranscodeGroupId("");

Method one: Console configuration

1. Log on to the ApsaraVideo Live console.

2. In the left-side navigation pane, select Feature Management > Live Stream Recording to go to the Live Stream Recording page, and then select the Store To OSS Configuration tab.

3. Select the streaming domain that you want to configure, and click Add.

4. Configure the recording template.

   

   Table 1. Recording template parameters

   Parameters	Description
   AppName	The application name of the video. The AppName you enter must be consistent with the AppName in the ingest URL for the configuration to take effect. If you want to record at the domain name level, you can enter an asterisk (*).
   StreamName	You can store the recordings of a specific live stream in OSS by specifying the stream name. If you want to record all streams, which means recording all streams under the AppName, you can enter an asterisk (*). Note AppName and StreamName parameters support English letters, numbers, hyphens (-), and underscores (_). The length is limited to 255 characters. The asterisk (*) can only be entered separately and cannot be used as a wildcard character in a string.
   Storage Location	Select a storage location. Note Storage buckets are classified into two types: Standard bucket: Used for regular file storage Media Bucket: Dedicated to video transcoding processing. Files stored in this type of bucket automatically trigger MPS transcoding jobs. The current system does not identify or distinguish Bucket types. If you need to execute video transcoding, please record the media Bucket name you use to ensure the accurate storage location of the transcoded media files.
   Stream Splicing Duration	If the stream interruption duration exceeds the specified duration, a new file is generated. The stream interruption duration ranges from 15 to 21600 seconds.
   Storage Format	Supports four formats: FLV, M3U8, MP4, and CMAF. Note Select at least one storage format. You cannot select the CMAF and M3U8 formats at the same time.
   Storage Rules	The default storage path is: record/{AppName}/{StreamName}/{EscapedStartTime}_{EscapedEndTime}. Sample command: AppName is liveApp****, StreamName is liveStream****, and the storage path for recording in m3u8 format is record/liveApp****/liveStream****/{EscapedStartTime}_{EscapedEndTime }.
   Single TS Duration	The length of a single segment. Default value: 30 seconds. The length of a TS segment can range from 5 to 30 seconds.
   Recording Cycle	Recording Cycle ranges from 15 minutes to 360 minutes, with a maximum recording duration of 6 hours. If the recording exceeds 6 hours, the system will generate a new file according to the recording naming convention. Note The recording cycle specifies the maximum length of a video-on-demand file that is converted from the current live stream.

5. Configure recording transcoding stream. (Optional)

   Important

   When you use the live stream transcoding feature, you are charged based on the transcoding standard, resolution, and total length of transcoded streams. For more information about billing rules, see Live Stream Transcoding Fees.

   

   Table 2. Recording transcoding stream parameters

   Parameters	Description
   Recording Transcoding Stream	Open the Record And Transcode Stream switch and configure the parameters.
   Storage Format	Supports four formats: FLV, M3U8, MP4, and CMAF. Note Select at least one storage format. You cannot select the CMAF and M3U8 formats at the same time.
   Storage Rule	The default storage path is: transcodeRecord/{AppName}/{StreamName}/{EscapedStartTime}_{EscapedEndTime}. Sample command: AppName is liveApp****, StreamName is liveStream****, Transcoding Template ID is lld, and the actual storage path when recording in m3u8 format is transcodeRecord/liveApp****/liveStream****_lld/{EscapedStartTime}_{EscapedEndTime}.
   Single TS Duration	The length of a single segment. Default value: 30 seconds. The length of a TS segment can range from 5 to 30 seconds.
   Recording Cycle	Recording Cycle ranges from 15 minutes to 360 minutes, with a maximum recording duration of 6 hours. If the recording exceeds 6 hours, the system generates a new file based on the recording naming convention. Note The recording cycle specifies the maximum length of a VOD file that is converted from the current live stream.
   Transcoding Template ID	You can select specific transcoding templates (up to 10) or all transcoding templates. The AppName of the transcoding template must be consistent with the recording template to take effect. If there is no transcoding template, you need to add one first. For more information, see default transcoding.

6. Click OK.

Method 2: API configuration

Call the AddLiveAppRecordConfig - Add recording configuration API to add a configuration. The SDK call reference is as follows:

        //Replace the content in angle brackets with actual values
        DefaultProfile profile = DefaultProfile.getProfile("", "", "");
        IAcsClient client = new DefaultAcsClient(profile);   
        AddLiveAppRecordConfigRequest addLiveAppRecordConfigRequest=new AddLiveAppRecordConfigRequest();
        addLiveAppRecordConfigRequest.setAppName("");
        addLiveAppRecordConfigRequest.setStreamName("");
        addLiveAppRecordConfigRequest.setDomainName("");
        addLiveAppRecordConfigRequest.setOssEndpoint("");
        addLiveAppRecordConfigRequest.setOssBucket("");
        List formatList=new ArrayList();
        AddLiveAppRecordConfigRequest.RecordFormat m3u8Format=new AddLiveAppRecordConfigRequest.RecordFormat();
        m3u8Format.setFormat("m3u8");
        //The naming format of a recording to store in OSS.
        m3u8Format.setOssObjectPrefix("");
        //The naming format of a segment.
        m3u8Format.setSliceOssObjectPrefix("");
        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));

        //Replace the content in angle brackets with actual values        
        List transcodeFormatList=new ArrayList();
        AddLiveAppRecordConfigRequest.TranscodeRecordFormat m3u8TranscodeFormat=new AddLiveAppRecordConfigRequest.TranscodeRecordFormat();
        m3u8TranscodeFormat.setFormat("m3u8");
        //The naming format of a transcoded stream recording to store in OSS.
        m3u8TranscodeFormat.setOssObjectPrefix("");
        //The naming format of a segment in a transcoded stream recording.
        m3u8TranscodeFormat.setSliceOssObjectPrefix("");
        transcodeFormatList.add(m3u8TranscodeFormat);
        addLiveAppRecordConfigRequest.setTranscodeRecordFormats(transcodeFormatList);
        List transcodeTemplateList=new ArrayList();
        //The ID of the transcoding template.
        transcodeTemplateList.add("");
        addLiveAppRecordConfigRequest.setTranscodeTemplatess(transcodeTemplateList);

On-demand recording

To implement on-demand recording, your business system needs to provide a URL address for live service invocation. For more information, see On-demand recording callback.

The following sample code provides an example on how to configure on-demand recording:

        //Set the OnD//Set the OnDemand parameter to 1 to enable on-demand recording through HTTP callbacks.
        addLiveAppRecordConfigRequest.setOnDemand(1);

Simultaneously call the AddLiveRecordNotifyConfig - Add domain-level recording callback configuration API to configure recording callbacks.

        //Replace the content in angle brackets with actual values
        AddLiveRecordNotifyConfigRequest addLiveRecordNotifyConfigRequest=new AddLiveRecordNotifyConfigRequest();
        //Specify a callback URL for on-demand recording.
        addLiveRecordNotifyConfigRequest.setOnDemandUrl("");
        addLiveRecordNotifyConfigRequest.setNotifyUrl("");
        addLiveRecordNotifyConfigRequest.setDomainName("");
        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 the automatic recording feature. The following sample code provides an example:

        //Set the OnDemand parameter to 7 to disable automatic recording.
        addLiveAppRecordConfigRequest.setOnDemand(7);

Then during the live streaming, you can call the RealTimeRecordCommand - Real-time recording instruction API to start recording based on your business requirements.

        //Replace the content in angle brackets with actual values 
        RealTimeRecordCommandRequest realTimeRecordCommandRequest=new RealTimeRecordCommandRequest();
        realTimeRecordCommandRequest.setCommand("start");
        realTimeRecordCommandRequest.setAppName("");
        realTimeRecordCommandRequest.setStreamName("");
        realTimeRecordCommandRequest.setDomainName("");
        RealTimeRecordCommandResponse realTimeRecordCommandResponse = null;
        try {
            realTimeRecordCommandResponse = client.getAcsResponse(realTimeRecordCommandRequest);
        } catch (ClientException e) {
            e.printStackTrace();
        }
        System.out.println(new Gson().toJson(realTimeRecordCommandResponse));