ApsaraVideo Live:Live stream recording

Method 1: Console

1. Log on to the ApsaraVideo Live console.

2. In the left navigation bar, select Feature Management > Recording. On the Recording Configuration tab, select VOD.

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

4. Configure the recording template.

   Basic recording settings

   Parameter	Description
   Application Name	The application name must be the same as the AppName in the stream ingestion URL to take effect. To apply this to all applications under the domain, enter *.
   Stream Name	Stream name. Supports exact match to record a specific stream. To record all live streams under the current AppName, enter *.
   VOD Application	The workspace where recorded files are stored, created in the ApsaraVideo VOD service. This field is not displayed if workspaces are not enabled.
   Bucket	You can select a storage location created in the ApsaraVideo VOD service in the current region. By default, the system uses the default upload address configured in ApsaraVideo VOD.
   Recording Source	You can record the Raw Stream or the Transcoded Streams. Both can be selected at the same time. When you select Transcoded Streams, you can specify up to 10 transcoding templates or select all transcoding templates. The transcoded stream recording can take effect only if the AppName of the transcoding template is * or is the same as the AppName of the recording template.
   Trigger Mode	Recordings can be triggered in the following ways: Automatic, Callback Confirmation, Ingest Parameter Trigger, and Manual. For more information, see Recording trigger methods.
   Format	Supports M3U8, FLV, and MP4 formats. When multiple formats are selected, you can configure VOD settings for each format separately.
   Recording Cycle	The maximum duration of a single recording file. If the live stream duration exceeds this threshold, the system generates a new file. Default: 180 minutes. Range: 15 to 360 minutes.
   Reconnect Timeout	If a live stream interruption is shorter than this duration, recording resumes to the same file. Longer interruptions cause a new file to be created. Default: 180 seconds. Range: 15 to 21,600 seconds.
   Segment Length	The duration of a single TS segment. This is displayed only when you select the M3U8 format. Default: 30 seconds. Range: 5 to 30 seconds.

   VOD settings

   When storing recordings in ApsaraVideo VOD, you can use these settings to process the recorded files with ApsaraVideo VOD's media processing capabilities. If you select multiple recording formats, you can configure them separately.

   Parameter	Description
   Auto Merge	If enabled, multiple files from different recording cycles are automatically merged into a single recording file and stored in ApsaraVideo VOD after the live stream ends. The original recording files are retained.
   Video Processing	Use the ApsaraVideo VOD service to process the recorded videos. Source Video: Each recording cycle file is processed individually. Merged Video: Processes the merged file (Displayed after auto merge is enabled).
   Processing Method	SupportsTranscoding Template Group and Workflow.
   Processing Template	Select a transcoding template group or workflow template from the ApsaraVideo VOD service. Note: You can only select templates created in the same region as the domain's live center.
   Category	Set the category for the recorded file in the ApsaraVideo VOD service.

5. Click OK to create a recording template.

Method 2: API

Call the AddLiveRecordVodConfig API to add a configuration for storing recordings in ApsaraVideo VOD. Sample code:

// Parameter settings for API request
AddLiveRecordVodConfigRequest.RecordFormat recordFormat0 = AddLiveRecordVodConfigRequest.RecordFormat.builder()
        .format("m3u8")
        .sliceDuration(30)
        .autoCompose("ON")
        .videoProcess("origin,compose")
        .processMethod("transcode")
        .processTemplateId("e2d796d3bb5fd8049d32bff62f94****")
        .tags("sports")
        .build();

AddLiveRecordVodConfigRequest addLiveRecordVodConfigRequest = AddLiveRecordVodConfigRequest.builder()
        .regionId("<Your RegionID>")
        .domainName("<Your DomainName>")
        .appName("live")
        .streamName("stream1")
        .cycleDuration(3600)
        .spaceId("app-1000000")
        .storageLocation("<Your StorageLocation>")
        .onDemand(0)
        .recordContent("raw,transcode")
        .delayTime(180)
        .recordFormat(java.util.Arrays.asList(recordFormat0))
        .transcodeTemplates(java.util.Arrays.asList("sd"))
        // Request-level configuration rewrite, can set Http request parameters, etc.
        // .requestConfiguration(RequestConfiguration.create().setHttpHeaders(new HttpHeaders()))
        .build();

Key parameters

• OnDemand

  The recording trigger method. Valid values: 0 (automatic recording), 1 (on-demand recording), 2 (ingest parameter settings), 7 (manual recording). For details, see Recording trigger methods.

• DelayTime

  The splicing duration for interrupted streams in seconds. If a live stream interruption is shorter than this duration, recording resumes to the same file. Longer interruptions cause a new file to be created.

• RecordContent, TranscodeTemplates

  Specify whether to record the source stream or a transcoded stream. When recording a transcoded stream, you must specify the transcoding template ID.

• RecordFormat: Sets the storage format and VOD configuration. This includes:

  • AutoCompose: If enabled, multiple files from different recording cycles are automatically merged into a single file after the live stream ends.

  • VideoProcess, ProcessMethod, ProcessTemplateId: Use an ApsaraVideo VOD transcoding or workflow template to process the original recorded file or the auto-merged video.

For a complete parameter description, see AddLiveRecordVodConfig - Add a configuration to store live recordings in VOD.

Method 1: Console

1. Log on to the ApsaraVideo Live console.

2. In the left navigation bar, select Feature Management > Recording. On the Recording Configuration tab, select OSS.

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

4. Configure the recording template. You can choose to record the source stream, a transcoded stream, or both.

   Basic recording settings

   Parameter	Description
   Application Name	The application name. This must match the AppName in the push URL for the setting to take effect. If you want the setting to apply to all applications under the domain, enter *.
   Stream Name	Stream name. You can specify an exact stream name to record a specific stream. To record all live streams under the current AppName, enter *.
   Storage Location	You can select a bucket created in OSS in the current region. Note There are two types of storage buckets: Standard bucket: Used for general file storage. Media bucket: Dedicated to video transcoding. Files stored in this type of bucket can automatically trigger ApsaraVideo Media Processing (MPS) transcoding jobs. The system does not currently label bucket types. If you need to perform video transcoding, please keep a record of the media bucket name to ensure that transcoded files are stored correctly.
   Interruption Duration Threshold	If a live stream interruption is shorter than this duration, recording resumes to the same file. Longer interruptions cause a new file to be created. Default: 180 seconds. Range: 15 to 21,600 seconds.
   Trigger Mode	You can trigger recordings in the following ways: Automatic, Callback Confirmation, Ingest Parameter Trigger, and Manual. For more information, see Recording trigger methods.

   Record source stream

   Parameter	Description
   Storage Format	Supports M3U8, FLV, MP4, and CMAF formats. You can select multiple formats, but you cannot select M3U8 and CMAF at the same time.
   Naming Conventions	The naming convention for recorded files. Default paths: M3U8, FLV, MP4: record/{AppName}/{StreamName}/{EscapedStartTime}_{EscapedEndTime} TS, fMP4: record/{AppName}/{StreamName}/{UnixTimestamp}_{Sequence}
   Segment Length	The duration of a single TS segment. This is displayed only when you select the M3U8 or CMAF format. Default: 30 seconds. Range: 5 to 30 seconds.
   Recording Cycle	The maximum duration of a single recording file. If the live stream duration exceeds this threshold, the system generates a new file. Default: 180 minutes. Range: 15 to 360 minutes.

   Record transcoded stream

   Parameter	Description
   Transcoded Streams	Select the transcoded streams to record. You can specify up to 10 transcoding templates or select all of them. For transcoded stream recording to work, the AppName of the transcoding template must be * or match that of the recording template.
   Storage Format	Supports M3U8, FLV, MP4, and CMAF formats. You can select multiple formats, but you cannot select M3U8 and CMAF at the same time.
   Naming Conventions	The naming convention for recorded files. Default paths: M3U8, FLV, MP4: transcodeRecord/{AppName}/{StreamName}_{TranscodingTemplateID}/{EscapedStartTime}_{EscapedEndTime} TS, fMP4: transcodeRecord/{AppName}/{StreamName}_{TranscodeTemplateID}/{UnixTimestamp}_{Sequence}
   Segment Length	The duration of a single TS segment. This is displayed only when you select the M3U8 or CMAF format. Default: 30 seconds. Range: 5 to 30 seconds.
   Recording Cycle	The maximum duration of a single recording file. If the live stream duration exceeds this threshold, the system generates a new file. Default: 180 minutes. Range: 15 to 360 minutes.

5. Click OK to create the recording template.

Method 2: API

Call the AddLiveAppRecordConfig API to add a configuration for storing recordings in OSS. Sample code:

// Parameter settings for API request
AddLiveAppRecordConfigRequest.TranscodeRecordFormat transcodeRecordFormat0 = AddLiveAppRecordConfigRequest.TranscodeRecordFormat.builder()
        .sliceDuration(30)
        .sliceOssObjectPrefix("transcodeRecord/{AppName}/{StreamName}_{TranscodeTemplateID}/{UnixTimestamp}_{Sequence}")
        .ossObjectPrefix("transcodeRecord/{AppName}/{StreamName}_{TranscodeTemplateID}/{EscapedStartTime}_{EscapedEndTime}")
        .cycleDuration(900)
        .format("m3u8")
        .build();

AddLiveAppRecordConfigRequest.RecordFormat recordFormat0 = AddLiveAppRecordConfigRequest.RecordFormat.builder()
        .sliceDuration(30)
        .format("m3u8")
        .cycleDuration(900)
        .sliceOssObjectPrefix("record/{AppName}/{StreamName}/{UnixTimestamp}_{Sequence}")
        .ossObjectPrefix("record/{AppName}/{StreamName}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}")
        .build();

AddLiveAppRecordConfigRequest addLiveAppRecordConfigRequest = AddLiveAppRecordConfigRequest.builder()
        .domainName("<Your DomainName>")
        .appName("live")
        .ossEndpoint("<Your OssEndpoint>")
        .ossBucket("<Your OssBucket>")
        .streamName("stream1")
        .onDemand(0)
        .delayTime(180)
        .recordFormat(java.util.Arrays.asList(recordFormat0))
        .transcodeRecordFormat(java.util.Arrays.asList(transcodeRecordFormat0))
        .transcodeTemplates(java.util.Arrays.asList("sd"))
        // Request-level configuration rewrite, can set Http request parameters, etc.
        // .requestConfiguration(RequestConfiguration.create().setHttpHeaders(new HttpHeaders()))
        .build();

Key parameters

• OnDemand

  The recording trigger method. Valid values: 0 (automatic recording), 1 (on-demand recording), 2 (ingest parameter settings), 7 (manual recording). For details, see Recording trigger methods.

• DelayTime

  The splicing duration for interrupted streams in seconds. If a live stream interruption is shorter than this duration, recording resumes to the same file. Longer interruptions cause a new file to be created.

• RecordFormat

  The storage format and recording parameters for the source stream, including Format (storage format), OssObjectPrefix (naming convention), SliceDuration (segment duration), and CycleDuration (recording cycle).

• TranscodeTemplates, TranscodeRecordFormat

  When recording a transcoded stream, specify the list of transcoding template IDs and the storage format and recording parameters for the transcoded stream.

For a complete parameter description, see AddLiveAppRecordConfig - Add a recording configuration.