开始录制 | 开发文档

说明

云端录制，是 qttAudio SDK 针对音视频通话、直播研发的录制功能，通过简单的操作方法，帮助开发者快速、灵活地实现录制服务，实现一对一、一对多的音视频通话或直播的录制。

请求URL

/cloud_record/global/{appKey}/startPOST

请求头

X-Auth-Token：需要传入appkey，channel和uid生成的token值

请求参数

参数名	类型	必须	描述
channel	string	是	设置待录制的频道名。
uid	integer	是	云端录制服务在频道内使用的 UID，用于标识该录制服务，例如527841。不能与当前频道内的任何 UID 重复。
streamTypes	integer	是	订阅的媒体流类型。0：仅订阅音频 1：仅订阅视频 2：（默认）订阅音频和视频
mode	string	否	individual（默认）：单流录制。
maxIdleTime	integer	否	最长空闲频道时间，单位为秒。默认值为 30。该值需大于等于 5，且小于等于 2,592,000，即 30 天。如果频道内无用户的状态持续超过该时间，录制程序会自动退出。退出后，再次调用 start 请求，会产生新的录制文件。
storageConfig	json	是	用于设置第三方云存储的 JSON Object，包含以下字段： vendor：String 类型，第三方云存储平台。可选值为：”amazon_s3”，”aliyun_oss”，”other_s3” region: String 类型，第三方云存储指定的地区信息。当 vendor为”amazon_s3”，即第三方云存储为Amazon S3时：可选值为”us-east-1”，”us-east-2”，”us-west-1”，”us-west-2”，”ap-northeast-1”，”ap-northeast-2”，”ap-northeast-3”，”ap-south-1”，”ap-east-1”，”ap-southeast-1”，”ap-southeast-2”，”ca-central-1”，”eu-west-1”，”eu-west-2”，”eu-west-3”，”eu-central-1”，”eu-north-1”，”sa-east-1”。当 vendor为”aliyun_oss”，即第三方云存储为阿里云 OSS时：可选值为”cn-hangzhou”， “cn-shanghai”, “cn-nanjing”, “cn-qingdao”, “cn-beijing”, “cn-zhangjiakou”, “cn-huhehaote”, “cn-wulanchabu”, “cn-shenzhen”, “cn-heyuan”, “cn-guangzhou”, “cn-chengdu”, “cn-hongkong”, “ap-southeast-1”, “ap-southeast-2”, “-northeast-2”，”ap-southeast-3”， “ap-“southeast-5”, “ap-northeast-1”, “eu-central-1”, “eu-west-1”, “us-west-1”, “us-east-1”, “me-east-1”, “ap-southeast-6”, “ap-southeast-7”, “ap-south-1” 当 vendor为”other_s3”，即第三方为兼容s3协议的云储存时：region无需传入或传入空字符串；endpoint需要保证传入。 bucket：String 类型，第三方云存储的 bucket，bucket 名称需要符合对应第三方云存储服务的命名规则。 endpoint：String类型，当vendor的值为”other_s3”时，需要保证传入的可用，例如：https://nyc3.digitaloceanspaces.com。vendor为”amazon_s3”或”aliyun_oss”无需传入或者传入空字符串 accessKey：String 类型，第三方云存储的 access key。在一般情况下，建议提供只写权限的访问密钥。 secretKey：String 类型，第三方云存储的 secret key。 fileNamePrefix：（选填）JSONArray 类型，由多个字符串组成的数组，指定录制文件在第三方云存储中的存储位置。举个例子，fileNamePrefix = [“directory1”,”directory2”]，将在录制文件名前加上前缀 “directory1/directory2/“。前缀长度（包括斜杠）不得超过 128 个字符。字符串中不得出现斜杠、下划线、括号等符号字符。以下为支持的字符集范围：26 个小写英文字母 a-z，26 个大写英文字母 A-Z，10 个数字 0-9

返回结果

{
    "status":"int //the status code compatible with http code",
    "message":"string //the extra explain message, always 'ok' if success",
    "data":{
        "channel":"1234",
        "uid":123,
        "streamTypes":2,
        "mode":"individual",
        "maxIdleTime":600,
        "storageConfig":{
            "vendor":"amazon_s3",
            "region":"ap-east-1",
            "bucket":"qtt",
            "endpoint":"vendor是amazon_s3或aliyun_oss，返回为空",
            "accessKey":"********",
            "secretKey":"*****",
            "fileNamePrefix":null
        },
        "id":1,
        "createdDate":"2022-04-22T00:17:02.448+00:00",
        "state":0,
        "record_file":"s3://qtt/1234/20220422081702"
    }
}

关键字段的含义如下表：

字段	类型	说明
id	Integer	服务端生成的录制的唯一资源id
idleTimeout	Integer	最长空闲时间，单位为秒，默认为30
channel	String	录制的channel
uid	Integer	录制服务在频道内使用的 UID
createdDate	String	录制服务的创建时间
record_file	String	为录制后的文件的存储路径

上次更新：2022-04-24