创建录制视频索引文件
功能介绍
录制索引就是使用视频流HLS格式的录制的ts文件,根据指定的时间范围,剪辑生成新的M3U8文件。
接口约束
录制配置中,录制格式必须有HLS,且参数“record_ts_prefix”必须为默认值:{file_start_time_unix}_{file_end_time_unix}_{ts_sequence_number}。请求时间段内必须有推送成功的直播流。同一个请求所涉及的录制文件必须在相同的OBS桶中。只允许创建开始时间晚于当前时间前30天的录制索引。如果请求时间段的时长小于HLS录制配置中的ts切片时长,将会返回与请求时间段有时间交集的ts分片,不会对ts文件做裁剪。请求时刻和请求中的开始时间间隔小于一个ts分片时长,可能会因为ts分片未录制完成而请求失败。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/record/indexes
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必填,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必填,请求的发生时间。 |
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必填,携带项目ID信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
publish_domain |
是 |
String |
推流域名 |
app |
是 |
String |
应用名 |
stream |
是 |
String |
流名 |
start_time |
是 |
String |
开始时间。格式为:YYYY-MM-DDTHH:mm:ssZ(UTC时间),开始时间与结束时间的间隔最大为12小时。开始时间不允许晚于当前时间。 |
end_time |
是 |
String |
结束时间。格式为:YYYY-MM-DDTHH:mm:ssZ(UTC时间),开始时间与结束时间的间隔最大为12小时。结束时间必须晚于开始时间。 |
object |
否 |
String |
m3u8文件在OBS中的储存路径。支持下列字符串的转义 - {publish_domain} - {app} - {stream} - {start_time} - {end_time} - {start_time_unix} - {end_time_unix}其中{start_time},{end_time},{start_time_unix},{end_time_unix}为返回结果的实际时间。 默认值为Index/{publish_domain}/{app}/{stream}/{stream}-{start_time}-{end_time} |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
此字段携带请求ID号,以便任务跟踪。 格式为 request_id-timestamp-hostname(request_id在服务器端生成UUID, timestamp为当前时间戳,hostname为处理当前接口的服务器名称) |
参数 |
参数类型 |
描述 |
---|---|---|
index_url |
String |
索引文件地址 |
publish_domain |
String |
直播推流域名 |
app |
String |
应用名 |
stream |
String |
录制的流名 |
start_time |
String |
开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。(实际视频的开始时间) |
end_time |
String |
结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。(实际视频的结束时间) |
duration |
Integer |
录制时长。 单位:秒。 |
width |
Integer |
视频宽 |
height |
Integer |
视频高 |
location |
String |
OBS Bucket所在RegionID |
bucket |
String |
桶名称 |
object |
String |
m3u8文件路径。默认Index/{publish_domain}/{app}/{stream}-{start_time}-{end_time} |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
此字段携带请求ID号,以便任务跟踪。 格式为 request_id-timestamp-hostname(request_id在服务器端生成UUID, timestamp为当前时间戳,hostname为处理当前接口的服务器名称) |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
创建录制视频索引。
POST https://{endpoint}/v1/{project_id}/record/indexes { "publish_domain" : "push.example.com", "app" : "live", "stream" : "index", "start_time" : "2022-07-25T16:20:00+08:00", "end_time" : "2022-07-25T16:30:00+08:00", "object" : "Index/{publish_domain}/{app}/{stream}/{stream}-{start_time}-{end_time}" }
响应示例
状态码: 201
创建录制视频索引操作成功
{ "index_url" : "http://obs***.com/push.test.com/live/stream01-20220901000000-20220901001000.m3u8", "duration" : 600, "height" : 1080, "width" : 720, "publish_domain" : "push.test.com", "app" : "live", "stream" : "stream01", "start_time" : "2022-09-01T00:00:00Z", "end_time" : "2022-09-01T00:10:00Z", "bucket" : "obs_bucket_name", "location" : "cn-north-5", "object" : "push.test.com/live/stream01-20220901000000-20220901001000.m3u8" }
状态码: 400
创建录制视频索引操作失败,常见错误:
-
illegal time range:请求时间范围有误,请查看start_time,end_time参数限制;
-
no record info found:请求时间段内没有录制任务,可能是时间段内没有成功推送的直播流或命令录制规则下未启动命令录制;
-
no ts info found:请求时间段内没有ts文件,可能是请求时间段推流有断流或请求时ts切片文件还没录制结束。
{ "error_code" : "LIVE.100011001", "error_msg" : "参数校验失败" }
SDK代码示例
SDK代码示例如下。
Java
创建录制视频索引。
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 |
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.time.OffsetDateTime; import java.time.format.DateTimeFormatter; public class CreateRecordIndexSolution { 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(); CreateRecordIndexRequest request = new CreateRecordIndexRequest(); RecordIndexRequestBody body = new RecordIndexRequestBody(); body.withObject("Index/{publish_domain}/{app}/{stream}/{stream}-{start_time}-{end_time}"); body.withEndTime(OffsetDateTime.parse("2022-07-25T16:30:00+08:00", DateTimeFormatter.ISO_OFFSET_DATE_TIME)); body.withStartTime(OffsetDateTime.parse("2022-07-25T16:20:00+08:00", DateTimeFormatter.ISO_OFFSET_DATE_TIME)); body.withStream("index"); body.withApp("live"); body.withPublishDomain("push.example.com"); request.withBody(body); try { CreateRecordIndexResponse response = client.createRecordIndex(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()); } } } |
Python
创建录制视频索引。
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 |
# 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 = CreateRecordIndexRequest() request.body = RecordIndexRequestBody( object="Index/{publish_domain}/{app}/{stream}/{stream}-{start_time}-{end_time}", end_time="2022-07-25T16:30:00+08:00", start_time="2022-07-25T16:20:00+08:00", stream="index", app="live", publish_domain="push.example.com" ) response = client.create_record_index(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
创建录制视频索引。
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 |
package main import ( "fmt" "time" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/sdktime" 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.CreateRecordIndexRequest{} objectRecordIndexRequestBody:= "Index/{publish_domain}/{app}/{stream}/{stream}-{start_time}-{end_time}" dateTimeEndTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "2022-07-25T16:30:00+08:00", time.UTC) sdkTimeEndTime := sdktime.SdkTime(dateTimeEndTime) dateTimeStartTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "2022-07-25T16:20:00+08:00", time.UTC) sdkTimeStartTime := sdktime.SdkTime(dateTimeStartTime) request.Body = &model.RecordIndexRequestBody{ Object: &objectRecordIndexRequestBody, EndTime: &sdkTimeEndTime, StartTime: &sdkTimeStartTime, Stream: "index", App: "live", PublishDomain: "push.example.com", } response, err := client.CreateRecordIndex(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
创建录制视频索引操作成功 |
400 |
创建录制视频索引操作失败,常见错误:
|
错误码
请参见错误码。