Updated on 2024-07-11 GMT+08:00

Creating a Recording Template

Function

Creates a recording template. The recording template only takes effect for streams that are pushed after the template is created. Using this function will incur live recording fees.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/record/rules

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

publish_domain

Yes

String

Ingest domain name.

app

Yes

String

Application name. To match any application, set this parameter to a wildcard character (*). Exact application matching is preferred. If no application is matched, all applications will be matched.

stream

Yes

String

Stream name. To match any stream, set this parameter to a wildcard character (*). Exact stream matching is preferred. If no stream is matched, all streams will be matched.

record_type

No

String

Recording type. The options are CONTINUOUS_RECORD and COMMAND_RECORD. The default value is CONTINUOUS_RECORD.

  • CONTINUOUS_RECORD: continuous recording. Recording is triggered when streams are pushed to the recording system.
  • COMMAND_RECORD: command-based recording. After streams are pushed to the recording system, you must run commands to start and stop stream recording.

default_record_config

Yes

DefaultRecordConfig object

Default recording template.

Table 4 DefaultRecordConfig

Parameter

Mandatory

Type

Description

record_format

Yes

Array of strings

Recording format.

obs_addr

Yes

RecordObsFileAddr object

Details about the bucket for storing recordings.

hls_config

No

HLSRecordConfig object

HLS configuration rule.

flv_config

No

FLVRecordConfig object

FLV configuration rule.

mp4_config

No

MP4RecordConfig object

MP4 configuration rule.

Table 5 RecordObsFileAddr

Parameter

Mandatory

Type

Description

bucket

Yes

String

OBS bucket name.

location

Yes

String

ID of the region where the OBS bucket resides.

object

Yes

String

OBS object path, which complies with the OBS object definition. If this parameter is left empty, recordings will be saved to the root directory.

Table 6 HLSRecordConfig

Parameter

Mandatory

Type

Description

record_cycle

Yes

Integer

Duration of periodic recording.

Unit: second. The value ranges from 1 minute (60 seconds) to 12 hours (43,200 seconds).

If the value is 0, the default value 6 hours (21,600 seconds) is used.

record_prefix

No

String

Path and file name prefix of an M3U8 file. The default value is Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}{file_start_time}/{stream}{file_start_time}.

record_ts_prefix

No

String

TS file name prefix. The default value is {file_start_time_unix}{file_end_time_unix}{ts_sequence_number}.

record_slice_duration

No

Integer

(Optional) TS slice duration for HLS recording.

Value range: [2,60]

Unit: second

Default value: 10

record_max_duration_to_merge_file

No

Integer

Interval threshold for combining HLS chunks. If the stream interruption duration exceeds this threshold, a new file will be generated.

Unit: second

Default value: 0

  • 0: A new file will be generated once the stream is interrupted.
  • –1: After the same stream is resumed, the recording will be saved in the previous file within 30 days.
Table 7 FLVRecordConfig

Parameter

Mandatory

Type

Description

record_cycle

Yes

Integer

Duration of periodic recording.

Unit: second. The value ranges from 1 minute (60 seconds) to 6 hours (21,600 seconds).

If the value is 0, the default value 2 hours (7,200 seconds) is used.

record_prefix

No

String

Path and file name prefix of an FLV file. The default value is **Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}*.

record_max_duration_to_merge_file

No

Integer

Interval threshold for combining FLV chunks. If the stream interruption duration exceeds this threshold, a new file will be generated. If the value is set to 0, a new file will be generated once the stream is interrupted.

Unit: second

Default value: 0

Table 8 MP4RecordConfig

Parameter

Mandatory

Type

Description

record_cycle

Yes

Integer

Duration of periodic recording.

Unit: second. The value ranges from 1 minute (60 seconds) to 6 hours (21,600 seconds).

If the value is 0, the default value 2 hours (7,200 seconds) is used.

record_prefix

No

String

Path and file name prefix of the file. The default value is **Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}*.

record_max_duration_to_merge_file

No

Integer

Interval threshold for combining MP4 chunks. If the stream interruption duration exceeds this threshold, a new file will be generated. If the value is set to 0, a new file will be generated once the stream is interrupted.

Unit: second

Default value: 0

Response Parameters

Status code: 201

Table 9 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID for task tracing. Format: *request_id-timestamp-hostname*. (*request_id* is the UUID generated on the server. *timestamp* indicates the current timestamp, and *hostname* is the name of the server that processes the current API.)

Table 10 Response body parameters

Parameter

Type

Description

id

String

Rule ID, which is returned by the server. This parameter is not needed during creation or modification.

publish_domain

String

Ingest domain name.

app

String

Application name. To match any application, set this parameter to a wildcard character (*). Exact application matching is preferred. If no application is matched, all applications will be matched.

stream

String

Stream name. To match any stream, set this parameter to a wildcard character (*). Exact stream matching is preferred. If no stream is matched, all streams will be matched.

record_type

String

Recording type. The options are CONTINUOUS_RECORD and COMMAND_RECORD. The default value is CONTINUOUS_RECORD.

  • CONTINUOUS_RECORD: continuous recording. Recording is triggered when streams are pushed to the recording system.
  • COMMAND_RECORD: command-based recording. After streams are pushed to the recording system, you must run commands to start and stop stream recording.

default_record_config

DefaultRecordConfig object

Default recording template.

create_time

String

Creation time in the format of yyyy-mm-ddThh:mm:ssZ (UTC time).

update_time

String

Modification time in the format of yyyy-mm-ddThh:mm:ssZ (UTC time).

Table 11 DefaultRecordConfig

Parameter

Type

Description

record_format

Array of strings

Recording format.

obs_addr

RecordObsFileAddr object

Details about the bucket for storing recordings.

hls_config

HLSRecordConfig object

HLS configuration rule.

flv_config

FLVRecordConfig object

FLV configuration rule.

mp4_config

MP4RecordConfig object

MP4 configuration rule.

Table 12 RecordObsFileAddr

Parameter

Type

Description

bucket

String

OBS bucket name.

location

String

ID of the region where the OBS bucket resides.

object

String

OBS object path, which complies with the OBS object definition. If this parameter is left empty, recordings will be saved to the root directory.

Table 13 HLSRecordConfig

Parameter

Type

Description

record_cycle

Integer

Duration of periodic recording.

Unit: second. The value ranges from 1 minute (60 seconds) to 12 hours (43,200 seconds).

If the value is 0, the default value 6 hours (21,600 seconds) is used.

record_prefix

String

Path and file name prefix of an M3U8 file. The default value is Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}{file_start_time}/{stream}{file_start_time}.

record_ts_prefix

String

TS file name prefix. The default value is {file_start_time_unix}{file_end_time_unix}{ts_sequence_number}.

record_slice_duration

Integer

(Optional) TS slice duration for HLS recording.

Value range: [2,60]

Unit: second

Default value: 10

record_max_duration_to_merge_file

Integer

Interval threshold for combining HLS chunks. If the stream interruption duration exceeds this threshold, a new file will be generated.

Unit: second

Default value: 0

  • 0: A new file will be generated once the stream is interrupted.
  • –1: After the same stream is resumed, the recording will be saved in the previous file within 30 days.
Table 14 FLVRecordConfig

Parameter

Type

Description

record_cycle

Integer

Duration of periodic recording.

Unit: second. The value ranges from 1 minute (60 seconds) to 6 hours (21,600 seconds).

If the value is 0, the default value 2 hours (7,200 seconds) is used.

record_prefix

String

Path and file name prefix of an FLV file. The default value is **Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}*.

record_max_duration_to_merge_file

Integer

Interval threshold for combining FLV chunks. If the stream interruption duration exceeds this threshold, a new file will be generated. If the value is set to 0, a new file will be generated once the stream is interrupted.

Unit: second

Default value: 0

Table 15 MP4RecordConfig

Parameter

Type

Description

record_cycle

Integer

Duration of periodic recording.

Unit: second. The value ranges from 1 minute (60 seconds) to 6 hours (21,600 seconds).

If the value is 0, the default value 2 hours (7,200 seconds) is used.

record_prefix

String

Path and file name prefix of the file. The default value is **Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}*.

record_max_duration_to_merge_file

Integer

Interval threshold for combining MP4 chunks. If the stream interruption duration exceeds this threshold, a new file will be generated. If the value is set to 0, a new file will be generated once the stream is interrupted.

Unit: second

Default value: 0

Status code: 400

Table 16 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID for task tracing. Format: *request_id-timestamp-hostname*. (*request_id* is the UUID generated on the server. *timestamp* indicates the current timestamp, and *hostname* is the name of the server that processes the current API.)

Table 17 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Creates a recording rule.

POST https://{endpoint}/v1/{project_id}/record/rules

{
  "publish_domain" : "publish.xxx.com",
  "app" : "live",
  "stream" : "*",
  "record_type" : "CONTINUOUS_RECORD",
  "default_record_config" : {
    "record_format" : [ "HLS", "FLV" ],
    "hls_config" : {
      "record_cycle" : 3600,
      "record_prefix" : "Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}",
      "record_ts_prefix" : "{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}",
      "record_slice_duration" : 10,
      "record_max_duration_to_merge_file" : 0
    },
    "flv_config" : {
      "record_cycle" : 9000,
      "record_prefix" : "Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}",
      "record_max_duration_to_merge_file" : 0
    },
    "obs_addr" : {
      "bucket" : "mybucket",
      "location" : "region1",
      "object" : "record/"
    }
  }
}

Example Responses

Status code: 400

Failed to create the recording template.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

SDK Sample Code

The SDK sample code is as follows.

Creates a recording rule.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.live.v1.region.LiveRegion;
import com.huaweicloud.sdk.live.v1.*;
import com.huaweicloud.sdk.live.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateRecordRuleSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateRecordRuleRequest request = new CreateRecordRuleRequest();
        RecordRuleRequest body = new RecordRuleRequest();
        FLVRecordConfig flvConfigDefaultRecordConfig = new FLVRecordConfig();
        flvConfigDefaultRecordConfig.withRecordCycle(9000)
            .withRecordPrefix("Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}")
            .withRecordMaxDurationToMergeFile(0);
        HLSRecordConfig hlsConfigDefaultRecordConfig = new HLSRecordConfig();
        hlsConfigDefaultRecordConfig.withRecordCycle(3600)
            .withRecordPrefix("Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}")
            .withRecordTsPrefix("{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}")
            .withRecordSliceDuration(10)
            .withRecordMaxDurationToMergeFile(0);
        RecordObsFileAddr obsAddrDefaultRecordConfig = new RecordObsFileAddr();
        obsAddrDefaultRecordConfig.withBucket("mybucket")
            .withLocation(RecordObsFileAddr.LocationEnum.fromValue("region1"))
            .withObject("record/");
        List<VideoFormatVar> listDefaultRecordConfigRecordFormat = new ArrayList<>();
        listDefaultRecordConfigRecordFormat.add(VideoFormatVar.fromValue("HLS"));
        listDefaultRecordConfigRecordFormat.add(VideoFormatVar.fromValue("FLV"));
        DefaultRecordConfig defaultRecordConfigbody = new DefaultRecordConfig();
        defaultRecordConfigbody.withRecordFormat(listDefaultRecordConfigRecordFormat)
            .withObsAddr(obsAddrDefaultRecordConfig)
            .withHlsConfig(hlsConfigDefaultRecordConfig)
            .withFlvConfig(flvConfigDefaultRecordConfig);
        body.withDefaultRecordConfig(defaultRecordConfigbody);
        body.withRecordType(RecordRuleRequest.RecordTypeEnum.fromValue("CONTINUOUS_RECORD"));
        body.withStream("*");
        body.withApp("live");
        body.withPublishDomain("publish.xxx.com");
        request.withBody(body);
        try {
            CreateRecordRuleResponse response = client.createRecordRule(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Creates a recording rule.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklive.v1.region.live_region import LiveRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklive.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LiveClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LiveRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateRecordRuleRequest()
        flvConfigDefaultRecordConfig = FLVRecordConfig(
            record_cycle=9000,
            record_prefix="Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}",
            record_max_duration_to_merge_file=0
        )
        hlsConfigDefaultRecordConfig = HLSRecordConfig(
            record_cycle=3600,
            record_prefix="Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}",
            record_ts_prefix="{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}",
            record_slice_duration=10,
            record_max_duration_to_merge_file=0
        )
        obsAddrDefaultRecordConfig = RecordObsFileAddr(
            bucket="mybucket",
            location="region1",
            object="record/"
        )
        listRecordFormatDefaultRecordConfig = [
            "HLS",
            "FLV"
        ]
        defaultRecordConfigbody = DefaultRecordConfig(
            record_format=listRecordFormatDefaultRecordConfig,
            obs_addr=obsAddrDefaultRecordConfig,
            hls_config=hlsConfigDefaultRecordConfig,
            flv_config=flvConfigDefaultRecordConfig
        )
        request.body = RecordRuleRequest(
            default_record_config=defaultRecordConfigbody,
            record_type="CONTINUOUS_RECORD",
            stream="*",
            app="live",
            publish_domain="publish.xxx.com"
        )
        response = client.create_record_rule(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Creates a recording rule.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := live.NewLiveClient(
        live.LiveClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateRecordRuleRequest{}
	recordPrefixFlvConfig:= "Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}"
	recordMaxDurationToMergeFileFlvConfig:= int32(0)
	flvConfigDefaultRecordConfig := &model.FlvRecordConfig{
		RecordCycle: int32(9000),
		RecordPrefix: &recordPrefixFlvConfig,
		RecordMaxDurationToMergeFile: &recordMaxDurationToMergeFileFlvConfig,
	}
	recordPrefixHlsConfig:= "Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}"
	recordTsPrefixHlsConfig:= "{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}"
	recordSliceDurationHlsConfig:= int32(10)
	recordMaxDurationToMergeFileHlsConfig:= int32(0)
	hlsConfigDefaultRecordConfig := &model.HlsRecordConfig{
		RecordCycle: int32(3600),
		RecordPrefix: &recordPrefixHlsConfig,
		RecordTsPrefix: &recordTsPrefixHlsConfig,
		RecordSliceDuration: &recordSliceDurationHlsConfig,
		RecordMaxDurationToMergeFile: &recordMaxDurationToMergeFileHlsConfig,
	}
	obsAddrDefaultRecordConfig := &model.RecordObsFileAddr{
		Bucket: "mybucket",
		Location: model.GetRecordObsFileAddrLocationEnum().REGION1,
		Object: "record/",
	}
	var listRecordFormatDefaultRecordConfig = []model.VideoFormatVarRecordFormat{
        model.GetVideoFormatVarRecordFormatEnum().HLS,
	    model.GetVideoFormatVarRecordFormatEnum().FLV,
    }
	defaultRecordConfigbody := &model.DefaultRecordConfig{
		RecordFormat: listRecordFormatDefaultRecordConfig,
		ObsAddr: obsAddrDefaultRecordConfig,
		HlsConfig: hlsConfigDefaultRecordConfig,
		FlvConfig: flvConfigDefaultRecordConfig,
	}
	recordTypeRecordRuleRequest:= model.GetRecordRuleRequestRecordTypeEnum().CONTINUOUS_RECORD
	request.Body = &model.RecordRuleRequest{
		DefaultRecordConfig: defaultRecordConfigbody,
		RecordType: &recordTypeRecordRuleRequest,
		Stream: "*",
		App: "live",
		PublishDomain: "publish.xxx.com",
	}
	response, err := client.CreateRecordRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

201

Recording template created.

400

Failed to create the recording template.

Error Codes

See Error Codes.