{ "name": "trtc", "display_name": "实时音视频", "description": "本文介绍如何使用 API 对实时音视频进行操作，例如房间管理、通话质量监控等。", "domain": "other", "api_version": "2019-07-22", "endpoint": "trtc.tencentcloudapi.com", "actions": [ { "name": "ControlAIConversation", "description": "提供服务端控制机器人的功能", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务唯一标识", "example": "v2*****test" }, { "name": "Command", "type": "string", "required": true, "description": "控制命令，目前支持命令如下：- ServerPushText，服务端发送文本给AI机器人，AI机器人会播报该文本. - InvokeLLM，服务端发送文本给大模型，触发对话", "example": "ServerPushText" }, { "name": "ServerPushText", "type": "object", "required": false, "description": "服务端发送播报文本命令，当Command为ServerPushText时必填", "example": "无", "children": [ { "name": "Text", "type": "string", "required": false, "description": "服务端推送播报文本", "example": "您好" }, { "name": "Interrupt", "type": "boolean", "required": false, "description": "是否允许该文本打断机器人说话", "example": "false" }, { "name": "StopAfterPlay", "type": "boolean", "required": false, "description": "播报完文本后，是否自动关闭对话任务", "example": "false" }, { "name": "Audio", "type": "string", "required": false, "description": "服务端推送播报音频 格式说明：音频必须为单声道，采样率必须跟对应TTS的采样率保持一致，编码为Base64字符串。 输入规则：当提供Audio字段时，将不接受Text字段的输入。系统将直接播放Audio字段中的音频内容。", "example": "音频base64字符串" }, { "name": "DropMode", "type": "integer", "required": false, "description": "默认为0，仅在Interrupt为false时有效 - 0表示当前有交互发生时，会丢弃Interrupt为false的消息 - 1表示当前有交互发生时，不会丢弃Interrupt为false的消息，而是缓存下来，等待当前交互结束后，再去处理 注意：DropMode为1时，允许缓存多个消息，如果后续出现了打断，缓存的消息会被清空", "example": "0" }, { "name": "Priority", "type": "integer", "required": false, "description": "ServerPushText消息的优先级，0表示可被打断，1表示不会被打断。**目前仅支持传入0，如果需要传入1，请提工单联系我们添加权限。** 注意：在接收到Priority=1的消息后，后续其他任何消息都会被忽略（包括Priority=1的消息），直到Priority=1的消息处理结束。该字段可与Interrupt、DropMode字段配合使用。 例子： - Priority=1、Interrupt=true，会打断现有交互，立刻播报，播报过程中不会被打断...", "example": "0" }, { "name": "AddHistory", "type": "boolean", "required": false, "description": "是否将文本加入到llm历史上下文中", "example": "true" }, { "name": "MetaInfo", "type": "string", "required": false, "description": "如果填写，会和字幕绑定发送到端上，注意确保内容为json字符串", "example": "\"{\\\"custom_msg\\\": 100}\"" } ] }, { "name": "InvokeLLM", "type": "object", "required": false, "description": "服务端发送命令主动请求大模型,当Command为InvokeLLM时会把content请求到大模型,头部增加X-Invoke-LLM=\"1\"", "example": "无", "children": [ { "name": "Content", "type": "string", "required": false, "description": "请求LLM的内容", "example": "今天天气怎么样" }, { "name": "Interrupt", "type": "boolean", "required": false, "description": "是否允许该文本打断机器人说话", "example": "false" }, { "name": "ExperimentalParams", "type": "string", "required": false, "description": "实验性参数,联系后台使用", "example": "实验性参数,联系后台使用" } ] } ], "required": [ "TaskId", "Command" ] }, { "name": "CreateBasicModeration", "description": "接口说明： 启动终端审核功能，完成房间内的音频审核。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和TRTC的房间所对应的SdkAppId相同。", "example": "140056784" }, { "name": "RoomId", "type": "string", "required": true, "description": "TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，为TRTC房间所对应的RoomId。", "example": "67467" }, { "name": "UserId", "type": "string", "required": true, "description": "目标审核用户id", "example": "wanjia1" }, { "name": "RoomIdType", "type": "integer", "required": false, "description": "TRTC房间号的类型。【*注意】必须和TRTC的房间所对应的RoomId类型相同:0: 字符串类型的RoomId1: 32位整型的RoomId（默认）", "example": "1" }, { "name": "AuditStorageParams", "type": "object", "required": false, "description": "音频文件上传到云存储的参数", "example": "无", "children": [ { "name": "CloudAuditStorage", "type": "object", "required": false, "description": "腾讯云对象存储COS以及第三方云存储的账号信息", "example": "无", "children": [ { "name": "Vendor", "type": "integer", "required": true, "description": "腾讯云对象存储COS以及第三方云存储账号信息 0：腾讯云对象存储 COS 1：AWS 【注意】目前第三方云存储仅支持AWS，更多第三方云存储陆续支持中 示例值：0", "example": "0" }, { "name": "Region", "type": "string", "required": true, "description": "腾讯云对象存储的[地域信息]（https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F）。 示例值：cn-shanghai-1 AWS S3[地域信息]（https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions） 示例值：ap-southeast-3", "example": "cn-shanghai-1" }, { "name": "Bucket", "type": "string", "required": true, "description": "云存储桶名称。", "example": "test-bucket" }, { "name": "AccessKey", "type": "string", "required": true, "description": "云存储的access_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretId值。 示例值：test-accesskey", "example": "test-accesskey" }, { "name": "SecretKey", "type": "string", "required": true, "description": "云存储的secret_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretKey值。 示例值：test-secretkey", "example": "test-secretkey" }, { "name": "FileNamePrefix", "type": "array", "required": false, "description": "云存储bucket 的指定位置，由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-'，举个例子，录制文件xxx.m3u8在 [\"prefix1\", \"prefix2\"]作用下，会变成prefix1/prefix2/TaskId/xxx.m3u8。 示例值：[\"prefix1\", \"prefix2\"]", "example": "[\"prefix1\", \"prefix2\"]", "item_type": "string" } ] } ] } ], "required": [ "SdkAppId", "RoomId", "UserId" ] }, { "name": "CreateCloudModeration", "description": "接口说明： 启动云端审核功能，完成房间内的音视频切片，视频截帧，或者录制音频流，送审到指定的审核商，完成审核。 您可以通过此接口实现如下目标： * 指定审核参数（ModerationParams）来指定审核需要的详细参数。 * 指定存储参数（ModerationStorageParams）将命中的审核文件指定上传到您希望的云存储，目前支持腾讯云（对象存储COS）和第三方AWS", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和TRTC的房间所对应的SdkAppId相同。", "example": "1400188366" }, { "name": "RoomId", "type": "string", "required": true, "description": "TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，为TRTC房间所对应的RoomId。", "example": "295212" }, { "name": "UserId", "type": "string", "required": true, "description": "机器人的UserId，用于进房发起审核任务。【*注意】这个UserId不能与当前房间内的主播观众UserId重复。如果一个房间发起多个切片任务时，机器人的userid也不能相互重复，否则会中断前一个切片任务。建议可以把房间ID作为UserId的标识的一部分，即机器人UserId在房间内唯一。", "example": "robot_1234" }, { "name": "ModerationParams", "type": "object", "required": true, "description": "云端审核控制参数。", "example": "无", "children": [ { "name": "ModerationType", "type": "integer", "required": false, "description": "审核任务类型， 1:音频切片审核，2:视频截帧审核，3:音视切片审核+视频截帧审核4:音频流式审核 5:音频流式+视频截帧审核  默认值1 （流式审核需要供应商支持才生效）", "example": "1" }, { "name": "MaxIdleTime", "type": "integer", "required": false, "description": "房间内持续没有用户（主播）上行推流的状态超过MaxIdleTime的时长，自动停止切片，单位：秒。默认值为 30 秒，该值需大于等于 5秒，且小于等于1800秒(0.5小时)。示例值：30", "example": "30" }, { "name": "SliceAudio", "type": "integer", "required": false, "description": "音频切片时长，默认15s 示例值：15", "example": "15" }, { "name": "SliceVideo", "type": "integer", "required": false, "description": "视频截帧间隔时长，默认5s", "example": "5" }, { "name": "ModerationSupplier", "type": "string", "required": false, "description": "供应商枚举， tianyu : 天御内容安全 （支持 1:音频切片审核，2:视频截帧审核，3:音视切片审核+视频截帧审核） ace : ACE内容安全 （支持 1:音频切片审核，2:视频截帧审核，3:音视切片审核+视频截帧审核） shumei : 数美审核（支持 1:音频切片审核，2:视频截帧审核，3:音视切片审核+视频截帧审核） yidun : 网易易盾审核 （支持 1:音频切片审核，2:视频截帧审核，3:音视切片审核+视频截...", "example": "ace" }, { "name": "ModerationSupplierParam", "type": "object", "required": false, "description": "第三方审核商送审需要配置信息", "example": "无", "children": [ { "name": "AppID", "type": "string", "required": false, "description": "供应审核商账号id，数美天御不为空，易盾为空", "example": "\"24189\"" }, { "name": "SecretId", "type": "string", "required": false, "description": "供应审核商秘钥id", "example": "\"ace_ugc_20521\"" }, { "name": "SecretKey", "type": "string", "required": false, "description": "供应审核商秘钥key", "example": "\"637ae34f4069afb92e9c6a799b36xxxx\"" }, { "name": "AudioBizType", "type": "string", "required": false, "description": "音频场景，策略id或者businessId", "example": "\"2001\"" }, { "name": "ImageBizType", "type": "string", "required": false, "description": "图片场景，策略id或者businessId", "example": "\"2001\"" } ] }, { "name": "SaveModerationFile", "type": "integer", "required": false, "description": "是否保存文件 0不保存文件 1保存所有文件 2仅保存命中文件", "example": "0" }, { "name": "CallbackAllResults", "type": "integer", "required": false, "description": "是否回调所有审核结果:\u000b0 默认回调所有结果 \u000b1 仅回调命中结果", "example": "0" }, { "name": "SubscribeStreamUserIds", "type": "object", "required": false, "description": "指定订阅流白名单或者黑名单。", "example": "无", "children": [ { "name": "SubscribeAudioUserIds", "type": "array", "required": false, "description": "订阅音频流白名单，指定订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的音频流；[\"1.*$\"], 代表订阅UserId前缀为1的音频流。默认不填订阅房间内所有的音频流，订阅列表用户数不超过32。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "UnSubscribeAudioUserIds", "type": "array", "required": false, "description": "订阅音频流黑名单，指定不订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的音频流；[\"1.*$\"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过32。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "SubscribeVideoUserIds", "type": "array", "required": false, "description": "订阅视频流白名单，指定订阅哪几个UserId的视频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的视频流；[\"1.*$\"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "UnSubscribeVideoUserIds", "type": "array", "required": false, "description": "订阅视频流黑名单，指定不订阅哪几个UserId的视频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的视频流；[\"1.*$\"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"123\",\"456\"]", "item_type": "string" } ] } ] }, { "name": "UserSig", "type": "string", "required": true, "description": "机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码，具体计算方法请参考TRTC计算UserSig的方案。", "example": "JwsjsHKgkAURt-lbv8fuXdyzAZauImIZBKDwJ3oKFdJhhkNI3r3yNx*B853XnA954GZLTsDiqSUAhH-l5VrM4zcsHGggAdvTTXCD-m6L63lGhSFiBTHmyhaCbegwIZ-WXfsu2kotauoccklT-Up0fOueN78pH15KFyrZZrtV*XI92-BNhSChKRV91jORYDw" }, { "name": "ModerationStorageParams", "type": "object", "required": false, "description": "云端审核文件上传到云存储的参数。", "example": "无", "children": [ { "name": "CloudModerationStorage", "type": "object", "required": false, "description": "腾讯云对象存储COS以及第三方云存储的账号信息", "example": "无", "children": [ { "name": "Vendor", "type": "integer", "required": true, "description": "腾讯云对象存储COS以及第三方云存储账号信息 0：腾讯云对象存储 COS 1：AWS S3 2: 阿里云 OSS 示例值：0", "example": "0" }, { "name": "Region", "type": "string", "required": true, "description": "腾讯云对象存储的[地域信息]（https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F）。 示例值：cn-shanghai-1 AWS S3[地域信息]（https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions） 示例值：ap-southeast-3", "example": "cn-shanghai-1" }, { "name": "Bucket", "type": "string", "required": true, "description": "云存储桶名称。", "example": "test-bucket" }, { "name": "AccessKey", "type": "string", "required": true, "description": "云存储的access_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretId值。 示例值：test-accesskey", "example": "test-accesskey" }, { "name": "SecretKey", "type": "string", "required": true, "description": "云存储的secret_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretKey值。 示例值：test-secretkey", "example": "test-secretkey" }, { "name": "FileNamePrefix", "type": "array", "required": false, "description": "云存储bucket 的指定位置，由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-'，举个例子，切片文件xxx.mp3在 [\"prefix1\", \"prefix2\"]作用下，音频切片文件会变成prefix1/prefix2/{taskId}/{userId}/audios/{sdkappid}_{roomId}_{userid}_{UTC时间}.ogg，视频截帧会变成prefix1/prefix2/{taskId}/{userId}/images/{sdkappid}_{roomId}_{userid}_{UTC时间}.png", "example": "[\"prefix1\", \"prefix2\"]", "item_type": "string" } ] } ] }, { "name": "RoomIdType", "type": "integer", "required": false, "description": "TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId（默认） 示例值：1", "example": "1" }, { "name": "ResourceExpiredHour", "type": "integer", "required": false, "description": "任务ID可以调用的时效性，从成功开启任务并获得TaskID后开始计算，超时后无法调用查询、更新和停止等接口，但是切片任务不会停止。 参数的单位是小时，默认24小时（1天），最大可设置72小时（3天），最小设置6小时。举例说明：如果不设置该参数，那么开始切片成功后，查询、更新和停止切片的调用时效为24个小时。", "example": "24" } ], "required": [ "SdkAppId", "RoomId", "UserId", "ModerationParams", "UserSig" ] }, { "name": "CreateCloudRecording", "description": "接口说明： 启动云端录制功能，完成房间内的音视频录制，并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面合流混成一路。 在线上正式运营之前，请关注录制的最佳实践 [录制最佳实践](https://cloud.tencent.com/document/product/647/76497#e7e2f04c-6cde-43c9-9cd0-0f8d22dee68c)，配合最佳实践，可大大提高接口录制的可用性。 您可以通...", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和录制的房间所对应的SdkAppId相同。", "example": "140000000" }, { "name": "RoomId", "type": "string", "required": true, "description": "TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。 注：房间号类型默认为整型，若房间号类型为字符串，请通过RoomIdType指定。", "example": "room_366" }, { "name": "UserId", "type": "string", "required": true, "description": "录制机器人的UserId，用于进房发起录制任务。 【*注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个录制任务时，机器人的userid也不能相互重复，否则会中断前一个录制任务。建议可以把房间ID作为UserId的标识的一部分，即录制机器人UserId在房间内唯一。", "example": "recorder_1234" }, { "name": "UserSig", "type": "string", "required": true, "description": "录制机器人UserId对应的校验签名，即UserId和UserSig相当于录制机器人进房的登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。", "example": "recorder_1234_sig" }, { "name": "RecordParams", "type": "object", "required": true, "description": "云端录制控制参数。", "example": "无", "children": [ { "name": "RecordMode", "type": "integer", "required": true, "description": "录制模式： 1：单流录制，分别录制房间的订阅UserId的音频和视频，将录制文件上传至云存储； 2：合流录制，将房间内订阅UserId的音视频混录成一个音视频文件，将录制文件上传至云存储；", "example": "1" }, { "name": "MaxIdleTime", "type": "integer", "required": false, "description": "房间内持续没有主播的状态超过MaxIdleTime的时长，自动停止录制，单位：秒。默认值为 30 秒，该值需大于等于 5秒，且小于等于 86400秒(24小时)。", "example": "30" }, { "name": "StreamType", "type": "integer", "required": false, "description": "录制的媒体流类型： 0：录制音频+视频流（默认）; 1：仅录制音频流； 2：仅录制视频流，", "example": "0" }, { "name": "SubscribeStreamUserIds", "type": "object", "required": false, "description": "指定订阅流白名单或者黑名单。", "example": "无", "children": [ { "name": "SubscribeAudioUserIds", "type": "array", "required": false, "description": "订阅音频流白名单，指定订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的音频流；[\"1.*$\"], 代表订阅UserId前缀为1的音频流。默认不填订阅房间内所有的音频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "UnSubscribeAudioUserIds", "type": "array", "required": false, "description": "订阅音频流黑名单，指定不订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的音频流；[\"1.*$\"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "SubscribeVideoUserIds", "type": "array", "required": false, "description": "订阅视频流白名单，指定订阅哪几个UserId的视频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的视频流；[\"1.*$\"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "UnSubscribeVideoUserIds", "type": "array", "required": false, "description": "订阅视频流黑名单，指定不订阅哪几个UserId的视频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的视频流；[\"1.*$\"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" } ] }, { "name": "OutputFormat", "type": "integer", "required": false, "description": "输出文件的格式（存储至COS等第三方存储时有效）。0：(默认)输出文件为hls格式。1：输出文件格式为hls+mp4。2：输出文件格式为hls+aac 。3：输出文件格式为mp4。4：输出文件格式为aac。 存储到云点播VOD时此参数无效，存储到VOD时请通过TencentVod（https://cloud.tencent.com/document/api/647/44055#TencentVod）内的MediaType设置。", "example": "0" }, { "name": "AvMerge", "type": "integer", "required": false, "description": "单流录制模式下，用户的音视频是否合并，0：单流音视频不合并（默认）。1：单流音视频合并成一个ts。合流录制此参数无需设置，默认音视频合并。", "example": "0" }, { "name": "MaxMediaFileDuration", "type": "integer", "required": false, "description": "如果是aac或者mp4文件格式，超过长度限制后，系统会自动拆分视频文件。单位：分钟。默认为1440min（24h），取值范围为1-1440。【单文件限制最大为2G，满足文件大小 \u003e2G 或录制时长度 \u003e 24h任意一个条件，文件都会自动切分】 Hls 格式录制此参数不生效。", "example": "1440" }, { "name": "MediaId", "type": "integer", "required": false, "description": "指定录制主辅流，0：主流+辅流（默认）；1:主流；2:辅流。", "example": "0" }, { "name": "FillType", "type": "integer", "required": false, "description": "上行视频停止时，录制的补帧类型，0：补最后一帧 1：补黑帧", "example": "0" }, { "name": "SubscribeAbility", "type": "integer", "required": false, "description": "控制录制任务是否订阅混流回推机器人，1是订阅，0是不订阅，默认是0。如果是混流录制任务，建议用订阅白名单控制订阅用户，防止同时订阅混流回推机器人和上行主播，以避免混音效果。", "example": "0" } ] }, { "name": "StorageParams", "type": "object", "required": true, "description": "云端录制文件上传到云存储的参数（不支持同时设置云点播VOD和对象存储COS）", "example": "无", "children": [ { "name": "CloudStorage", "type": "object", "required": false, "description": "腾讯云对象存储COS以及第三方云存储的账号信息", "example": "无", "children": [ { "name": "Vendor", "type": "integer", "required": true, "description": "腾讯云对象存储COS以及第三方云存储账号信息 0：腾讯云对象存储 COS 1：AWS 【注意】目前第三方云存储仅支持AWS，更多第三方云存储陆续支持中", "example": "0" }, { "name": "Region", "type": "string", "required": true, "description": "腾讯云对象存储的[地域信息]（https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F）。 示例值：cn-shanghai-1 AWS S3[地域信息]（https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions）", "example": "ap-shanghai(cos, 具体参考云存储厂商支持的地域)" }, { "name": "Bucket", "type": "string", "required": true, "description": "云存储桶名称。", "example": "test-bucket" }, { "name": "AccessKey", "type": "string", "required": true, "description": "云存储的access_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretId值。", "example": "test-accesskey" }, { "name": "SecretKey", "type": "string", "required": true, "description": "云存储的secret_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretKey值。", "example": "test-secretkey" }, { "name": "FileNamePrefix", "type": "array", "required": false, "description": "云存储bucket 的指定位置，由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-'，举个例子，录制文件xxx.m3u8在 [\"prefix1\", \"prefix2\"]作用下，会变成prefix1/prefix2/TaskId/xxx.m3u8。", "example": "[\"prefix1\", \"prefix2\"]", "item_type": "string" } ] }, { "name": "CloudVod", "type": "object", "required": false, "description": "腾讯云云点播Vod的存储信息", "example": "无", "children": [ { "name": "TencentVod", "type": "object", "required": false, "description": "腾讯云点播相关参数。", "example": "无", "children": [ { "name": "Procedure", "type": "string", "required": false, "description": "媒体后续任务处理操作，即完成媒体上传后，可自动发起任务流操作。参数值为任务流模板名，云点播支持 创建任务流模板 并为模板命名。", "example": "LongVideoPreset" }, { "name": "ExpireTime", "type": "integer", "required": false, "description": "媒体文件过期时间，为当前时间的绝对过期时间；保存一天，就填\"86400\"，永久保存就填\"0\"，默认永久保存。", "example": "86400" }, { "name": "StorageRegion", "type": "string", "required": false, "description": "指定上传园区，仅适用于对上传地域有特殊需求的用户。", "example": "ap-shanghai" }, { "name": "ClassId", "type": "integer", "required": false, "description": "分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。 默认值：0，表示其他分类。", "example": "0" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播子应用 ID。如果要访问子应用中的资源，则将该字段填写为子应用 ID；否则无需填写该字段。注意：不建议填写“托管类型”的点播子应用ID，只能填写“标准类型”的点播子应用ID，否则会导致无法通过点播域名正常播放视频。", "example": "1" }, { "name": "SessionContext", "type": "string", "required": false, "description": "任务流上下文，任务完成回调时透传。", "example": "\"session_context_example\"" }, { "name": "SourceContext", "type": "string", "required": false, "description": "上传上下文，上传完成回调时透传。", "example": "\"source_context_example\"" }, { "name": "MediaType", "type": "integer", "required": false, "description": "上传到vod平台的录制文件格式类型，0：mp4(默认), 1: hls, 2:aac(StreamType=1纯音频录制时有效), 3: hls+mp4, 4: hls+aac(StreamType=1纯音频录制时有效)。", "example": "1" }, { "name": "UserDefineRecordId", "type": "string", "required": false, "description": "仅支持API录制上传vod，该参数表示用户可以自定义录制文件名前缀，【限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符】。前缀与自动生成的录制文件名之间用`__UserDefine_u_` 分开。", "example": "\"user_prefix\"" } ] } ] } ] }, { "name": "RoomIdType", "type": "integer", "required": false, "description": "TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId（默认）", "example": "1" }, { "name": "MixTranscodeParams", "type": "object", "required": false, "description": "合流的转码参数，录制模式为合流的时候可以设置。", "example": "无", "children": [ { "name": "VideoParams", "type": "object", "required": false, "description": "录制视频转码参数，注意如果设置了这个参数，那么里面的字段都是必填的，没有默认值，如果不填这个参数，那么取值为默认值。", "example": "无", "children": [ { "name": "Width", "type": "integer", "required": true, "description": "视频的宽度值，单位为像素，默认值360。不能超过1920，与height的乘积不能超过1920*1080。", "example": "360" }, { "name": "Height", "type": "integer", "required": true, "description": "视频的高度值，单位为像素，默认值640。不能超过1920，与width的乘积不能超过1920*1080。", "example": "640" }, { "name": "Fps", "type": "integer", "required": true, "description": "视频的帧率，范围[1, 60]，默认15。", "example": "15" }, { "name": "BitRate", "type": "integer", "required": true, "description": "视频的码率,单位是bps，范围[64000, 8192000]，默认550000bps。", "example": "550000" }, { "name": "Gop", "type": "integer", "required": true, "description": "视频关键帧时间间隔，单位秒，默认值10秒。", "example": "10" } ] }, { "name": "AudioParams", "type": "object", "required": false, "description": "录制音频转码参数，注意如果设置了这个参数，那么里面的字段都是必填的，没有默认值，如果不填这个参数，那么取值为默认值。", "example": "无", "children": [ { "name": "SampleRate", "type": "integer", "required": true, "description": "音频采样率枚举值:(注意1 代表48000HZ, 2 代表44100HZ, 3 代表16000HZ) 1：48000Hz（默认）; 2：44100Hz 3：16000Hz。", "example": "1" }, { "name": "Channel", "type": "integer", "required": true, "description": "声道数枚举值: 1：单声道; 2：双声道（默认）。", "example": "2" }, { "name": "BitRate", "type": "integer", "required": true, "description": "音频码率: 取值范围[32000, 128000] ，单位bps，默认64000bps。", "example": "64000" } ] } ] }, { "name": "MixLayoutParams", "type": "object", "required": false, "description": "合流的布局参数，录制模式为合流的时候可以设置。", "example": "无", "children": [ { "name": "MixLayoutMode", "type": "integer", "required": true, "description": "布局模式: 1：悬浮布局； 2：屏幕分享布局； 3：九宫格布局； 4：自定义布局； 悬浮布局：默认第一个进入房间的主播（也可以指定一个主播）的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列，显示为小画面，小画面悬浮于大画面之上。当画面数量小于等于17个时，每行4个（4 x 4排列）。当画面数量大于17个时，重新布局小画面为每行...", "example": "3" }, { "name": "MixLayoutList", "type": "array", "required": false, "description": "如果MixLayoutMode 选择为4自定义布局模式的话，设置此参数为每个主播所对应的布局画面的详细信息，最大不超过25个。", "example": "无", "item_type": "object", "children": [ { "name": "Top", "type": "integer", "required": true, "description": "画布上该画面左上角的 y 轴坐标，取值范围 [0, 1920]，不能超过画布的高。", "example": "100" }, { "name": "Left", "type": "integer", "required": true, "description": "画布上该画面左上角的 x 轴坐标，取值范围 [0, 1920]，不能超过画布的宽。", "example": "100" }, { "name": "Width", "type": "integer", "required": true, "description": "画布上该画面宽度的相对值，取值范围 [0, 1920]，与Left相加不应超过画布的宽。", "example": "100" }, { "name": "Height", "type": "integer", "required": true, "description": "画布上该画面高度的相对值，取值范围 [0, 1920]，与Top相加不应超过画布的高。", "example": "100" }, { "name": "UserId", "type": "string", "required": false, "description": "字符串内容为待显示在该画面的主播对应的UserId，如果不指定，会按照主播加入房间的顺序匹配。", "example": "user_1" }, { "name": "Alpha", "type": "integer", "required": false, "description": "画布的透明度值，取值范围[0, 255]。0表示不透明，255表示全透明。默认值为0。", "example": "100" }, { "name": "RenderMode", "type": "integer", "required": false, "description": "0 ：拉伸模式，这个模式下整个视频内容会全部显示，并填满子画面，在源视频和目的视频宽高比不一致的时候，画面不会缺少内容，但是画面可能产生形变； 1 ：剪裁模式（默认），这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸，并填满子画面画布，在源视频和目的视频宽高比不一致的时候，画面保持不变形，但是会被剪裁； 2 ：填黑模式，这个模式下会...", "example": "1" }, { "name": "MediaId", "type": "integer", "required": false, "description": "对应订阅流的主辅路标识： 0：主流（默认）； 1：辅流；", "example": "1" }, { "name": "ImageLayer", "type": "integer", "required": false, "description": "该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。", "example": "2" }, { "name": "SubBackgroundImage", "type": "string", "required": false, "description": "图片的url地址， 只支持jpg, png, jpeg，图片分辨率限制不超过2K，图片大小限制不超过5MB。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '\u0026', '(', ')', '*', '+', ',', '%', '='", "example": "https://xxxx/image.jpg, https://xxxx/image.jpg?token=xxx" } ] }, { "name": "BackGroundColor", "type": "string", "required": false, "description": "录制背景颜色，RGB的颜色表的16进制表示，每个颜色通过8bit长度标识，默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500，格式规范：‘#‘开头，后面跟固定RGB的颜色值", "example": "#FF0000" }, { "name": "MaxResolutionUserId", "type": "string", "required": false, "description": "在布局模式为1：悬浮布局和 2：屏幕分享布局时，设定为显示大视频画面的UserId。不填的话：悬浮布局默认是第一个进房间的主播，屏幕分享布局默认是背景色", "example": "user_1" }, { "name": "MediaId", "type": "integer", "required": false, "description": "主辅路标识， 0：主流（默认）； 1：辅流（屏幕分享）； 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路，MixLayoutList内代表的是自定义用户的主辅路。", "example": "0" }, { "name": "BackgroundImageUrl", "type": "string", "required": false, "description": "图片的url地址，只支持jpg, png, jpeg，图片分辨率限制不超过2K，图片大小限制不超过5MB。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '\u0026', '(', ')', '*', '+', ',', '%', '='", "example": "https://xxxx/image.jpg, https://xxxx/image.jpg?token=xxx" }, { "name": "PlaceHolderMode", "type": "integer", "required": false, "description": "设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行音视频时可显示对应的占位图。", "example": "0" }, { "name": "BackgroundImageRenderMode", "type": "integer", "required": false, "description": "背景画面宽高比不一致的时候处理方案，与MixLayoutList定义的RenderMode一致。", "example": "1" }, { "name": "DefaultSubBackgroundImage", "type": "string", "required": false, "description": "子画面占位图url地址，只支持jpg, png, jpeg，图片分辨率限制不超过2K，图片大小限制不超过5MB。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '\u0026', '(', ')', '*', '+', ',', '%', '='", "example": "https://xxxx/image.jpg, https://xxxx/image.jpg?token=xxx" }, { "name": "WaterMarkList", "type": "array", "required": false, "description": "水印布局参数， 最多支持25个。", "example": "无", "item_type": "object", "children": [ { "name": "WaterMarkType", "type": "integer", "required": false, "description": "水印类型，0为图片（默认），1为文字，2为时间戳。", "example": "0" }, { "name": "WaterMarkImage", "type": "object", "required": false, "description": "水印为图片时的参数列表，水印为图片时校验必填。", "example": "无", "children": [ { "name": "WaterMarkUrl", "type": "string", "required": true, "description": "下载的url地址， 只支持jpg, png, jpeg，大小限制不超过5M。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '\u0026', '(', ')', '*', '+', ',', '%', '='", "example": "https://xxxx/image.jpg, https://xxxx/image.jpg?token=xxx" }, { "name": "Top", "type": "integer", "required": true, "description": "画布上该画面左上角的 y 轴坐标，取值范围 [0, 2560]，不能超过画布的高。", "example": "100" }, { "name": "Left", "type": "integer", "required": true, "description": "画布上该画面左上角的 x 轴坐标，取值范围 [0, 2560]，不能超过画布的宽。", "example": "100" }, { "name": "Width", "type": "integer", "required": true, "description": "画布上该画面宽度的相对值，取值范围 [0, 2560]，与Left相加不应超过画布的宽。", "example": "100" }, { "name": "Height", "type": "integer", "required": true, "description": "画布上该画面高度的相对值，取值范围 [0, 2560]，与Top相加不应超过画布的高。", "example": "100" } ] }, { "name": "WaterMarkChar", "type": "object", "required": false, "description": "水印为文字时的参数列表，水印为文字时校验必填。", "example": "无", "children": [ { "name": "Top", "type": "integer", "required": true, "description": "文字水印的起始坐标Y值，从左上角开始", "example": "0" }, { "name": "Left", "type": "integer", "required": true, "description": "文字水印的起始坐标X值，从左上角开始", "example": "0" }, { "name": "Width", "type": "integer", "required": true, "description": "文字水印的宽度，单位像素值", "example": "200" }, { "name": "Height", "type": "integer", "required": true, "description": "文字水印的高度，单位像素值", "example": "100" }, { "name": "Chars", "type": "string", "required": true, "description": "水印文字的内容", "example": "李专家" }, { "name": "FontSize", "type": "integer", "required": false, "description": "水印文字的大小，单位像素，默认14", "example": "14" }, { "name": "FontColor", "type": "string", "required": false, "description": "水印文字的颜色，默认白色", "example": "0xFFFFFF" }, { "name": "BackGroundColor", "type": "string", "required": false, "description": "水印文字的背景色，为空代表背景透明，默认为空", "example": "0xbbccbb" }, { "name": "Font", "type": "string", "required": false, "description": "文字水印的字体，支持设置以下值： 1. Tencent （默认） 2. SourceHanSans", "example": "Tencent" } ] }, { "name": "WaterMarkTimestamp", "type": "object", "required": false, "description": "水印为时间戳时的参数列表，水印为时间戳时校验必填。", "example": "无", "children": [ { "name": "Pos", "type": "integer", "required": true, "description": "时间戳的位置，取值范围0-6，分别代表上左，上右，下左，下右，上居中，下居中，居中", "example": "0" }, { "name": "TimeZone", "type": "integer", "required": false, "description": "显示时间戳的时区，默认东八区", "example": "8" }, { "name": "Font", "type": "string", "required": false, "description": "文字水印的字体，支持设置以下值： 1. Tencent （默认） 2. SourceHanSans", "example": "Tencent" } ] } ] }, { "name": "RenderMode", "type": "integer", "required": false, "description": "模板布局下，背景画面宽高比不一致的时候处理方案。自定义布局不生效，与MixLayoutList定义的RenderMode一致。", "example": "1" }, { "name": "MaxResolutionUserAlign", "type": "integer", "required": false, "description": "屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。", "example": "0" }, { "name": "PureAudioDisableLayout", "type": "boolean", "required": false, "description": "控制房间内纯音频用户是否占据混流布局，只在混流录制，模板布局生效。true: 代表纯音频用户不占位，false: 代表纯音频用户占位（默认为false）。", "example": "false" } ] }, { "name": "ResourceExpiredHour", "type": "integer", "required": false, "description": "接口可以调用的时效性，从成功开启录制并获得任务ID后开始计算，超时后无法调用查询、更新和停止等接口，但是录制任务不会停止。 参数的单位是小时，默认72小时（3天），最大可设置720小时（30天），最小设置6小时。举例说明：如果不设置该参数，那么开始录制成功后，查询、更新和停止录制的调用时效为72个小时。", "example": "24" }, { "name": "PrivateMapKey", "type": "string", "required": false, "description": "TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。", "example": "eJw1jcEKgkAURX9FZlvY****fL9rfNX4_" } ], "required": [ "SdkAppId", "RoomId", "UserId", "UserSig", "RecordParams", "StorageParams" ] }, { "name": "CreateCloudSliceTask", "description": "接口说明： 启动云端切片功能，完成房间内的音视频切片，并上传到指定的云存储。 您可以通过此接口实现如下目标： * 指定切片参数（SliceParams）来指定需要切片的主播的黑名单或者白名单。 * 指定存储参数（SliceStorageParams）来指定上传到您希望的云存储，目前支持腾讯云（对象存储COS）和第三方AWS", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和TRTC的房间所对应的SdkAppId相同。", "example": "1400704311" }, { "name": "RoomId", "type": "string", "required": true, "description": "TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，为TRTC房间所对应的RoomId。", "example": "295212" }, { "name": "UserId", "type": "string", "required": true, "description": "机器人的UserId，用于进房发起切片任务。【*注意】这个UserId不能与当前房间内的主播观众UserId重复。如果一个房间发起多个切片任务时，机器人的userid也不能相互重复，否则会中断前一个切片任务。建议可以把房间ID作为UserId的标识的一部分，即机器人UserId在房间内唯一。", "example": "slice_robot_1" }, { "name": "UserSig", "type": "string", "required": true, "description": "机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码，具体计算方法请参考TRTC计算UserSig的方案。", "example": "eJyrVgrxCdYrSy1SslIy0jNQ0gHzM1NS80oy0zLBwpl5xQWpySVQqeKU7MSCgswUJSsjAwNDAwsDM4h4axxx" }, { "name": "SliceParams", "type": "object", "required": true, "description": "云端切片控制参数。", "example": "无", "children": [ { "name": "SliceType", "type": "integer", "required": false, "description": "切片任务类型: 1:音频切片； 2:视频截帧； 3:音视切片+视频截帧 示例值：1", "example": "1" }, { "name": "MaxIdleTime", "type": "integer", "required": false, "description": "房间内持续没有主播的状态超过MaxIdleTime的时长，自动停止录制，单位：秒。默认值为 30 秒，该值需大于等于 5秒，且小于等于 86400秒(24小时)。 示例值：30", "example": "30" }, { "name": "SliceAudio", "type": "integer", "required": false, "description": "音频切片时长，默认15s 示例值：15 取值范围15-60s", "example": "15" }, { "name": "SliceVideo", "type": "integer", "required": false, "description": "视频截帧间隔时长，默认5s， 示例值：5 取值范围5-60s", "example": "5" }, { "name": "SubscribeStreamUserIds", "type": "object", "required": false, "description": "指定订阅流白名单或者黑名单。", "example": "无", "children": [ { "name": "SubscribeAudioUserIds", "type": "array", "required": false, "description": "订阅音频流白名单，指定订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的音频流；[\"1.*$\"], 代表订阅UserId前缀为1的音频流。默认不填订阅房间内所有的音频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "UnSubscribeAudioUserIds", "type": "array", "required": false, "description": "订阅音频流黑名单，指定不订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的音频流；[\"1.*$\"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "SubscribeVideoUserIds", "type": "array", "required": false, "description": "订阅视频流白名单，指定订阅哪几个UserId的视频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的视频流；[\"1.*$\"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "UnSubscribeVideoUserIds", "type": "array", "required": false, "description": "订阅视频流黑名单，指定不订阅哪几个UserId的视频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的视频流；[\"1.*$\"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" } ] }, { "name": "SliceImageType", "type": "integer", "required": false, "description": "知道图片格式类型： 0 png, 1 jpg默认0", "example": "0" }, { "name": "SliceCallbackUrl", "type": "string", "required": false, "description": "已废弃，从控制台配置回调url", "example": "url" } ] }, { "name": "SliceStorageParams", "type": "object", "required": true, "description": "云端切片文件上传到云存储的参数", "example": "无", "children": [ { "name": "CloudSliceStorage", "type": "object", "required": false, "description": "腾讯云对象存储COS以及第三方云存储的账号信息", "example": "无", "children": [ { "name": "Vendor", "type": "integer", "required": true, "description": "腾讯云对象存储COS以及第三方云存储账号信息 0：腾讯云对象存储 COS 1：AWS S3 2: 阿里云 OSS 示例值：0", "example": "0" }, { "name": "Region", "type": "string", "required": true, "description": "腾讯云对象存储的[地域信息]（https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F）。 示例值：cn-shanghai-1 AWS S3[地域信息]（https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions） 示例值：ap-southeast-3", "example": "cn-shanghai-1" }, { "name": "Bucket", "type": "string", "required": true, "description": "云存储桶名称。", "example": "test-bucket" }, { "name": "AccessKey", "type": "string", "required": true, "description": "云存储的access_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretId值。 示例值：test-accesskey", "example": "test-accesskey" }, { "name": "SecretKey", "type": "string", "required": true, "description": "云存储的secret_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretKey值。 示例值：test-secretkey", "example": "test-secretkey" }, { "name": "FileNamePrefix", "type": "array", "required": false, "description": "云存储bucket 的指定位置，由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-'，举个例子，切片文件xxx.mp3在 [\"prefix1\", \"prefix2\"]作用下，音频切片文件会变成prefix1/prefix2/{taskId}/{userId}/audios/{sdkappid}_{roomId}_{userid}_{UTC时间}.ogg，视频截帧会变成prefix1/prefix2/{taskId}/{userId}/images/{sdkappid}_{roomId}_{userid}_{UTC时间}.png", "example": "[\"prefix1\", \"prefix2\"]", "item_type": "string" } ] } ] }, { "name": "RoomIdType", "type": "integer", "required": false, "description": "TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId（默认） 示例值：1", "example": "1" }, { "name": "ResourceExpiredHour", "type": "integer", "required": false, "description": "接口可以调用的时效性，从成功开启录制并获得任务ID后开始计算，超时后无法调用查询、更新和停止等接口，但是录制任务不会停止。 参数的单位是小时，默认72小时（3天），最大可设置720小时（30天），最小设置6小时。举例说明：如果不设置该参数，那么开始录制成功后，查询、更新和停止录制的调用时效为72个小时。 示例值：24", "example": "24" }, { "name": "PrivateMapKey", "type": "string", "required": false, "description": "TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。 示例值：eJw1jcEKgkAURX9FZl...", "example": "无" } ], "required": [ "SdkAppId", "RoomId", "UserId", "UserSig", "SliceParams", "SliceStorageParams" ] }, { "name": "CreateCloudTranscription", "description": "接口说明： 启动云端转录功能。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和转录的房间所对应的SdkAppId相同。", "example": "140000000" }, { "name": "RoomId", "type": "string", "required": true, "description": "TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，转录的TRTC房间所对应的RoomId。注：房间号类型默认为整型，若房间号类型为字符串，请通过RoomIdType指定。", "example": "room_366" }, { "name": "RoomIdType", "type": "integer", "required": true, "description": "房间信息RoomType，必须和转录的房间所对应的RoomId类型相同，0为整型房间号，1为字符串房间号。", "example": "1" }, { "name": "TranscriptionParam", "type": "object", "required": true, "description": "转录服务加入TRTC房间的参数。", "example": "无", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "转录服务在TRTC房间使用的[UserId](https://cloud.tencent.com/document/product/647/46351#userid)，注意这个userId不能与其他TRTC或者转录服务等已经使用的UserId重复，建议可以把房间ID作为userId的标识的一部分。", "example": "transcription_1234" }, { "name": "UserSig", "type": "string", "required": true, "description": "转录服务加入TRTC房间的用户签名，当前 UserId 对应的验证签名，相当于登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。", "example": "transcription_1234_sig" }, { "name": "SubscribeList", "type": "array", "required": false, "description": "转录用户白名单，开始服务时，为空或不填表示转录所有主播音频，填具体值表示转录指定主播音频。 使用黑白名单时，同一个用户同时在黑白名单时，以黑名单为主。", "example": "无", "item_type": "object", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "用户ID。" } ] }, { "name": "UnSubscribeList", "type": "array", "required": false, "description": "转录用户黑名单，为空或不填表示无黑名单，填具体值表示不转录指定主播音频。 同一个用户同时在黑白名单时，以黑名单为主。", "example": "无", "item_type": "object", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "用户ID。" } ] }, { "name": "MaxIdleTime", "type": "integer", "required": false, "description": "所有参与转录的主播持续离开TRTC房间或切换成观众超过MaxIdleTime的时长，自动停止转录任务，单位：秒。默认值为 30 秒，该值需大于等于 5秒，且小于等于 86400秒(24小时)。", "example": "30" }, { "name": "SendCustomMode", "type": "integer", "required": false, "description": "自定义通道：支持自定义信息，只可以填0-2， 0表示不开启自定义通道，1表示开启自定义数据，2表示开启自定义消息。不填默认不开启自定义通道。注意：填1自定义数据只对 SDK版本 \u003e= 5.15.0生效。", "example": "1" } ] }, { "name": "AsrParam", "type": "object", "required": true, "description": "转录服务ASR使用的参数。", "example": "无", "children": [ { "name": "Lang", "type": "string", "required": true, "description": "转录服务使用的模型类型。示例值\"16k_zh_en\"。语音转文本不同套餐版本支持的语言如下： 基础语言引擎： - \"zh\": 8k 采样率中文识别模型，主要用于电话音频。 标准语言引擎： - \"8k_zh_large\": 8k 中文大模型引擎，针对电话音频支持较好。 - \"16k_zh_large\": 16k 大模型引擎，同时支持中文、英文、多种中文方言口音等语言的识别。 - \"16k_zh_en\": 最新 16k 中英大模型引擎，同时支持中文、英\ufffd\ufffd...", "example": "16k_zh_en" }, { "name": "VadSilenceTime", "type": "integer", "required": false, "description": "语音识别vad的时间，范围为240-2000，默认为1000，单位为ms。更小的值会让语音识别分句更快。 示例值：1000", "example": "1000" }, { "name": "HotWordList", "type": "string", "required": false, "description": "临时热词表：该参数用于提升识别准确率。 - 单个热词限制：\"热词|权重\"，单个热词不超过30个字符（最多10个汉字），权重[1-11]或者100，如：\"腾讯云|5\" 或 \"ASR|11\"。 - 临时热词表限制：多个热词用英文逗号分割，最多支持128个热词，如：\"腾讯云|10,语音识别|5,ASR|11\"。 注意： 热词权重设置为11时，当前热词将升级为超级热词，建议仅将重要且必须生效的热词设置到11，设置过多\ufffd\ufffd...", "example": "腾讯云|10,语音识别|5,ASR|11" }, { "name": "AlternativeLanguage", "type": "array", "required": false, "description": "发起模糊识别为高级版能力,默认按照高级版收费,仅支持填写除\"zh-dialect\"和\"zh-yue\"以外的高级版语言。注意：最多只能填写4种语言。", "example": "[\"vi\", \"ja\"]", "item_type": "string" }, { "name": "VadLevel", "type": "integer", "required": false, "description": "vad的远场人声抑制能力（不会对asr识别效果造成影响），范围为[0, 3]，默认为0。推荐设置为2，有较好的远场人声抑制能力。", "example": "0" } ] }, { "name": "TranslationParam", "type": "object", "required": false, "description": "转录服务翻译使用的参数。", "example": "无", "children": [ { "name": "TargetLang", "type": "array", "required": false, "description": "翻译的目标语言，示例值[\"en\", \"ja\"]。目标语种列表[中文 \"zh\"，英语 \"en\"，越南语 \"vi\"，日语 \"ja\"，韩语 \"ko\"，印度尼西亚语 \"id\"，泰语 \"th\"，葡萄牙语 \"pt\"，阿拉伯语 \"ar\"，西班牙语 \"es\"，法语 \"fr\"，马来语 \"ms\"，德语 \"de\"，意大利语 \"it\"，俄语 \"ru\"]。", "example": "[\"en\", \"ja\"]", "item_type": "string" } ] } ], "required": [ "SdkAppId", "RoomId", "RoomIdType", "TranscriptionParam", "AsrParam" ] }, { "name": "CreatePicture", "description": "如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印，可通过此接口上传新的图片素材。无需频繁新增图片的场景，建议直接在 [控制台 \u003e 应用管理 \u003e 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用id", "example": "1400000001" }, { "name": "Content", "type": "string", "required": true, "description": "图片内容经base64编码后的string格式,最大长度为2M", "example": "MTg4MTM=" }, { "name": "Suffix", "type": "string", "required": true, "description": "图片后缀名", "example": "jpg" }, { "name": "Height", "type": "integer", "required": true, "description": "图片长度", "example": "15" }, { "name": "Width", "type": "integer", "required": true, "description": "图片宽度", "example": "15" }, { "name": "XPosition", "type": "integer", "required": true, "description": "显示位置x轴方向", "example": "15" }, { "name": "YPosition", "type": "integer", "required": true, "description": "显示位置y轴方向", "example": "15" } ], "required": [ "SdkAppId", "Content", "Suffix", "Height", "Width", "XPosition", "YPosition" ] }, { "name": "DeleteBasicModeration", "description": "成功开启审核任务后，可以使用此接口来停止任务。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和TRTC的房间所使用的SDKAppId相同。", "example": "1400027384" }, { "name": "TaskId", "type": "string", "required": true, "description": "审核任务的唯一Id，在启动审核任务成功后会返回。", "example": "-nHp1XlU7mcW54zuscSryY-HYgLlPznbMzm9IYK-4pycoZWQnoT+HczjvK1mvkTPNxnCi14gJVpW6AE." } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DeleteCloudModeration", "description": "成功开启云端审核任务后，可以使用此接口来停止送审。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和TRTC的房间所对应的SDKAppId相同。", "example": "1400188366" }, { "name": "TaskId", "type": "string", "required": true, "description": "审核任务的唯一Id，在启动切片任务成功后会返回。", "example": "-npVoIhU7nQhuIyPncW+12qkkV--KL3bBznoI4K-4pycoZWQndibFvKbEU+fxxvJzuc+2xqATAE." } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DeleteCloudRecording", "description": "成功开启录制后，可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成，如果未完成后台将会继续上传文件，成功后通过事件回调通知客户文件全部传输完成状态。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和录制的房间所对应的SDKAppId相同。", "example": "1400**366" }, { "name": "TaskId", "type": "string", "required": true, "description": "录制任务的唯一Id，在启动录制成功后会返回。", "example": "-m9-bVVU7gzdSqvsV***Y+QMYNee2QE." } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DeleteCloudSliceTask", "description": "成功开启切片任务后，可以使用此接口来停止任务。停止切片成功后不代表文件全部传输完成，如果未完成后台将会继续上传文件，成功后通过事件回调通知客户文件全部传输完成状态。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和TRTC的房间所对应的SDKAppId相同。", "example": "1400188366" }, { "name": "TaskId", "type": "string", "required": true, "description": "切片任务的唯一Id，在启动切片任务成功后会返回。", "example": "-nHwX3RU7h3eZ-9PYsqd+z8I1uU1tUnbTWClW4K-xuWiN6KipeCyXJ8ZJEFpWSZ5zZuyZUAuAQ.." } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DeleteCloudTranscription", "description": "成功开启转录后，可以使用此接口来停止转录任务。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和转录的房间所对应的SDKAppId相同。", "example": "140000000" }, { "name": "TaskId", "type": "string", "required": true, "description": "转录任务的唯一Id，在启动转录成功后会返回。", "example": "-m9Ghi1U*****gjmwRxKiwE..." } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DeletePicture", "description": "如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印，可通过此接口删除已上传的图片。无需频繁删除图片的场景，建议直接在 [控制台 \u003e 应用管理 \u003e 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。", "status": "online", "parameters": [ { "name": "PictureId", "type": "integer", "required": true, "description": "图片id", "example": "18813" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用id", "example": "140000001" } ], "required": [ "PictureId", "SdkAppId" ] }, { "name": "DeleteVoicePrint", "description": "传入声纹ID，删除之前注册的声纹信息", "status": "online", "parameters": [ { "name": "VoicePrintId", "type": "string", "required": true, "description": "声纹信息ID", "example": "20250529_xxxxxx" } ], "required": [ "VoicePrintId" ] }, { "name": "DescribeAIConversation", "description": "查询AI对话任务状态。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": false, "description": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和开启转录任务的房间使用的SdkAppId相同。", "example": "无" }, { "name": "TaskId", "type": "string", "required": false, "description": "唯一标识一次任务。", "example": "无" }, { "name": "SessionId", "type": "string", "required": false, "description": "开启任务时填写的SessionId，如果没写则不返回。", "example": "无" } ], "required": [] }, { "name": "DescribeAITranscription", "description": "查询AI转录任务状态。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "查询任务状态，不使用时传入空字符串。 有两种查询方式： 1、只填写TaskId，这种方式使用TaskId来查询任务 2、TaskId为空字符串，填写SdkAppId和SessionId，这种方式不需要使用TaskId查询任务", "example": "无" }, { "name": "SdkAppId", "type": "integer", "required": false, "description": "TRTC的SdkAppId，和SessionId配合使用。", "example": "无" }, { "name": "SessionId", "type": "string", "required": false, "description": "开启转录任务时传入的SessionId，和SdkAppId配合使用。", "example": "无" } ], "required": [ "TaskId" ] }, { "name": "DescribeCallDetailInfo", "description": "查询指定时间内的用户列表及用户通话质量数据，最大可查询14天内数据。DataType 不为null，查询起止时间不超过1个小时，查询用户不超过6个，支持跨天查询。DataType为null时，查询起止时间不超过4个小时， 默认查询6个用户，同时支持每页查询100以内用户个数（PageSize不超过100）。接口用于查询质量问题，不推荐作为计费使用。（同老接口DescribeCallDetail） **注意**： 1.该接口只\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "CommId", "type": "string", "required": true, "description": "通话 ID（唯一标识一次通话）： SdkAppId_RoomId（房间号）_ CreateTime（房间创建时间，unix时间戳，单位为s）例：1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo（查询历史房间列表）接口获取（[查询历史房间列表](https://cloud.tencent.com/document/product/647/44050)）。", "example": "1400xxxxxx_218695_1590065777" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查询开始时间，本地unix时间戳，单位为秒（如：1590065777）， 注意：支持查询14天内的数据。", "example": "1590065777" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询结束时间，本地unix时间戳，单位为秒（如：1590065877） 注意：查询起止时间需小于1小时，超过则返回null，即与StartTime间隔时间不超过1小时。", "example": "1590065877" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "用户SdkAppId（如：1400xxxxxx）。", "example": "1400123456" }, { "name": "UserIds", "type": "array", "required": false, "description": "需查询的用户数组，默认不填返回6个用户。", "example": "[\"user_a\",\"user_b\"]", "item_type": "string" }, { "name": "DataType", "type": "array", "required": false, "description": "需查询的指标，不填则只返回用户列表，填all则返回所有指标。 appCpu：APP CPU使用率； sysCpu：系统 CPU使用率； aBit：上/下行音频码率；单位：bps aBlock：音频卡顿时长；单位：ms bigvBit：上/下行视频码率；单位：bps bigvCapFps：视频采集帧率； bigvEncFps：视频发送帧率； bigvDecFps：渲染帧率； bigvBlock：视频卡顿时长；单位：ms aLoss：上/下行音频丢包率； bigvLoss：上/下行视频丢包率\ufffd\ufffd...", "example": "[\"bigvCapFps\"]", "item_type": "string" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "当前页数，默认为0， 注意：PageNumber和PageSize 其中一个不填均默认返回6条数据。", "example": "0" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页个数，默认为6， 范围：[1，100] 注意：DataType不为null，UserIds长度不能超过6，PageSize最大值不超过6； DataType 为null，UserIds长度不超过100，PageSize最大不超过100。", "example": "6" } ], "required": [ "CommId", "StartTime", "EndTime", "SdkAppId" ] }, { "name": "DescribeCloudModeration", "description": "成功开启审核任务后，可以使用此接口来查询审核任务状态和订阅的黑白名单信息。仅在任务进行时有效，任务退出后查询将会返回错误。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和录制的房间所对应的SDKAppId相同。", "example": "1400188366" }, { "name": "TaskId", "type": "string", "required": true, "description": "云端审核任务的唯一Id，在启动切片任务成功后会返回。", "example": "-npVoIhU7uxalbjwbc-qxKyKqluNl93bUmLFI4K-4pycoZWQndibYzKsC3HkljEK3HikwogUxwE." } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DescribeCloudRecording", "description": "成功开启录制后，可以使用此接口来查询录制状态。仅在录制任务进行时有效，录制退出后查询将会返回错误。 录制文件上传到云点播VOD时，StorageFileList中不会返回录制文件信息，请订阅相关录制文件回调事件，获取录制文件信息。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和录制的房间所对应的SDKAppId相同。", "example": "1400***366" }, { "name": "TaskId", "type": "string", "required": true, "description": "录制任务的唯一Id，在启动录制成功后会返回。", "example": "-m9jKgBv***dPBQE." }, { "name": "RecorderKey", "type": "string", "required": false, "description": "转推录制任务发起时所填，标识一次录制", "example": "recorder_key_test" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DescribeCloudSliceTask", "description": "成功开启切片后，可以使用此接口来查询切片任务状态。仅在任务进行时有效，任务退出后查询将会返回错误。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和录制的房间所对应的SDKAppId相同。", "example": "1400188366" }, { "name": "TaskId", "type": "string", "required": true, "description": "切片任务的唯一Id，在启动切片任务成功后会返回。", "example": "-nHwX3RU7h3eZ-9PYsqd+z8I1uU1tUnbTWClW4K-xuWiN6KipeCyXJ8ZJEFpWSZ5zZuyZUAuAQ.." } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DescribeCloudTranscription", "description": "成功开启转录后，可以使用此接口来查询录制状态。仅在转录任务进行时有效，转录退出后查询将会返回错误。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和转录的房间所对应的SDKAppId相同。", "example": "1400000000" }, { "name": "TaskId", "type": "string", "required": true, "description": "转录任务的唯一Id，在启动转录成功后会返回。", "example": "-m9Ghi1U7upt0******aR8QqgE..." } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DescribeMixTranscodingUsage", "description": "获取TRTC混流转码的用量明细。 - 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。 - 单次查询统计区间最多不能超过31天。 - 若查询当天用量，由于统计延迟等原因，返回数据可能不够准确。 - 该接口只用于历史用量数据统计或核对数据使用，关键业务逻辑不能使用。 - 默认接口请求频率限制：5次/秒。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间，格式为YYYY-MM-DD。", "example": "2022-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，格式为YYYY-MM-DD。 单次查询统计区间最多不能超过31天。", "example": "2022-01-01 00:00:00" }, { "name": "SdkAppId", "type": "integer", "required": false, "description": "TRTC的SdkAppId，和房间所对应的SdkAppId相同。如果没有这个参数，返回用户下全部实时音视频应用的汇总。", "example": "1400123456" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribePicture", "description": "如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息，可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景，建议直接在 [控制台 \u003e 应用管理 \u003e 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用ID", "example": "1400000001" }, { "name": "PictureId", "type": "integer", "required": false, "description": "图片ID，不填时返回该应用下所有图片", "example": "100861" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页数量，不填时默认为10", "example": "10" }, { "name": "PageNo", "type": "integer", "required": false, "description": "页码，不填时默认为1", "example": "1" } ], "required": [ "SdkAppId" ] }, { "name": "DescribeRecordStatistic", "description": "查询云端录制计费时长。 - 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。 - 单次查询统计区间最多不能超过31天。 - 若查询当天用量，由于统计延迟等原因，返回数据可能不够准确。 - 日结后付费将于次日上午推送账单，建议次日上午9点以后再来查询前一天的用量。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询开始日期，格式为YYYY-MM-DD。", "example": "2019-10-11" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束日期，格式为YYYY-MM-DD。 单次查询统计区间最多不能超过31天。", "example": "2019-10-13" }, { "name": "SdkAppId", "type": "integer", "required": false, "description": "应用ID，可不传。传应用ID时返回的是该应用的用量，不传时返回多个应用的合计值。", "example": "1400123456" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeRecordingUsage", "description": "获取TRTC录制的用量明细。 - 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。 - 单次查询统计区间最多不能超过31天。 - 若查询当天用量，由于统计延迟等原因，返回数据可能不够准确。 - 该接口只用于历史用量数据统计或核对数据使用，关键业务逻辑不能使用。 - 默认接口请求频率限制：5次/秒。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间，格式为YYYY-MM-DD。", "example": "2022-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，格式为YYYY-MM-DD。 单次查询统计区间最多不能超过31天。", "example": "2022-01-01 00:00:00" }, { "name": "MixType", "type": "string", "required": true, "description": "查询单流录制或合流录制，值为\"single\"或\"multi\"。", "example": "\"single\"" }, { "name": "SdkAppId", "type": "integer", "required": false, "description": "TRTC的SdkAppId，和房间所对应的SdkAppId相同。如果没有这个参数，返回用户下全部实时音视频应用的汇总。", "example": "1400123456" } ], "required": [ "StartTime", "EndTime", "MixType" ] }, { "name": "DescribeRelayUsage", "description": "获取TRTC旁路转推的用量明细。 - 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。 - 单次查询统计区间最多不能超过31天。 - 若查询当天用量，由于统计延迟等原因，返回数据可能不够准确。 - 该接口只用于历史用量数据统计或核对数据使用，关键业务逻辑不能使用。 - 默认接口请求频率限制：5次/秒。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间，格式为YYYY-MM-DD。", "example": "2022-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，格式为YYYY-MM-DD。 单次查询统计区间最多不能超过31天。", "example": "2022-01-01 00:00:00" }, { "name": "SdkAppId", "type": "integer", "required": false, "description": "TRTC的SdkAppId，和房间所对应的SdkAppId相同。如果没有这个参数，返回用户下全部实时音视频应用的汇总。", "example": "1400123456" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeRoomInfo", "description": "查询SdkAppId下的房间列表。默认返回10条通话，一次最多返回100条通话。最大可查询14天内的数据。（同老接口DescribeRoomInformation） **注意**： 1.该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。 2.该接口自2024年4月1日起正式商业化，需订阅套餐解锁调用能力，提供以下两种解锁方式，可任意其一解锁： 方式一：通过订阅[包月套餐](https://cloud.tencent.com/d...", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "用户SdkAppId（如：1400xxxxxx）", "example": "1400xxxxxx" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查询开始时间，本地unix时间戳，单位为秒（如：1590065777）注意：最大支持查询14天内的数据", "example": "1590065777" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询结束时间，本地unix时间戳，单位为秒（如：1590065877） 注意：与StartTime间隔时间不超过24小时。", "example": "1590065877" }, { "name": "RoomId", "type": "string", "required": false, "description": "房间号（如：223)", "example": "223" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "当前页数，默认为0， 注意：PageNumber和PageSize 其中一个不填均默认返回10条数据。", "example": "0" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页个数，默认为10， 范围：[1，100]", "example": "10" } ], "required": [ "SdkAppId", "StartTime", "EndTime" ] }, { "name": "DescribeScaleInfo", "description": "可查询SdkAppId每天的房间数和用户数，按天统计，可查询最近14天的数据。当天未结束，数据未统计完成，无法查到当天的房间数与用户数。（同老接口DescribeHistoryScale）", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "用户SdkAppId（如：1400xxxxxx）", "example": "1400xxxxxx" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查询开始时间，本地unix时间戳，单位为秒（如：1590065777） 注意：支持查询14天内的数据。", "example": "1590065777" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询结束时间，本地unix时间戳，单位为秒（如：1590065877），建议与StartTime间隔时间超过24小时。 注意：按天统计，结束时间大于前一天，否则查询数据为空（如：需查询20号数据，结束时间需晚于20号0点）。", "example": "1590065777" } ], "required": [ "SdkAppId", "StartTime", "EndTime" ] }, { "name": "DescribeStreamIngest", "description": "您可以查询输入在线媒体流任务的状态。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和任务的房间所对应的SDKAppId相同", "example": "1600011111" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务的唯一Id，在启动任务成功后会返回。", "example": "HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DescribeTRTCMarketQualityData", "description": "查询TRTC监控仪表盘-数据大盘质量指标（包括下列指标） joinSuccessRate：加入频道成功率。 joinSuccessIn5sRate：5s内加入频道成功率。 audioFreezeRate：音频卡顿率。 videoFreezeRate：视频卡顿率。 networkDelay ：网络延迟率。 注意： 1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/6...", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "string", "required": true, "description": "用户SdkAppId（如：1400xxxxxx）", "example": "1400188366" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间，格式为YYYY-MM-DD。（查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天）", "example": "2022-10-20" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，格式为YYYY-MM-DD。", "example": "2022-10-21" }, { "name": "Period", "type": "string", "required": true, "description": "返回数据的粒度，支持设为以下值： d：按天。此时返回查询时间范围内 UTC 时间为零点的数据。 h：按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。", "example": "\"d\"" }, { "name": "IsFloat", "type": "boolean", "required": false, "description": "返回数据是否为小数", "example": "true" } ], "required": [ "SdkAppId", "StartTime", "EndTime", "Period" ] }, { "name": "DescribeTRTCMarketScaleData", "description": "查询TRTC监控仪表盘-数据大盘规模指标（会返回通话人数，通话房间数，峰值同时在线人数，峰值同时在线频道数） userCount：通话人数， roomCount：通话房间数，从有用户加入频道到所有用户离开频道计为一个通话频道。 peakCurrentChannels：峰值同时在线频道数。 peakCurrentUsers：峰值同时在线人数。 注意： 1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "string", "required": true, "description": "用户SdkAppId", "example": "1400000000" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间，格式为YYYY-MM-DD。（查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天）", "example": "2022-10-20" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，格式为YYYY-MM-DD。", "example": "2022-10-21" }, { "name": "Period", "type": "string", "required": true, "description": "返回数据的粒度，支持设为以下值： d：按天。此时返回查询时间范围内 UTC 时间为零点的数据。 h：按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。", "example": "\"d\"" } ], "required": [ "SdkAppId", "StartTime", "EndTime", "Period" ] }, { "name": "DescribeTRTCMarketScaleMetricData", "description": "云监控monitor接口已下线，trtc同步下线接口 查询TRTC监控仪表盘-数据大盘规模指标（会返回通话人数，通话房间数，峰值同时在线人数，峰值同时在线频道数） userCount：通话人数， roomCount：通话房间数，从有用户加入频道到所有用户离开频道计为一个通话频道。 peakCurrentChannels：峰值同时在线频道数。 peakCurrentUsers：峰值同时在线人数。 注意： 1.调用接口需开通监控仪表盘【\ufffd\ufffd...", "status": "deprecated", "parameters": [ { "name": "SdkAppId", "type": "string", "required": true, "description": "用户SdkAppId", "example": "\"1400188366\"" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间，格式为YYYY-MM-DD。（查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天）", "example": "2022-10-20" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，格式为YYYY-MM-DD。", "example": "2022-10-21" }, { "name": "Period", "type": "string", "required": true, "description": "返回数据的粒度，支持设为以下值： d：按天。此时返回查询时间范围内 UTC 时间为零点的数据。 h：按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。", "example": "\"d\"" } ], "required": [ "SdkAppId", "StartTime", "EndTime", "Period" ] }, { "name": "DescribeTRTCRealTimeQualityData", "description": "查询TRTC监控仪表盘-实时监控质量指标（会返回下列指标） -视频卡顿率 -音频卡顿率 注意： 1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，详情参考[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)。 2.查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "string", "required": true, "description": "用户SdkAppId（如：1400xxxxxx）", "example": "1400000000" }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间，unix时间戳，单位：秒（查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时）", "example": "1665747036" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间，unix时间戳，单位：秒", "example": "1665747284" }, { "name": "RoomId", "type": "string", "required": false, "description": "房间ID", "example": "23390" } ], "required": [ "SdkAppId", "StartTime", "EndTime" ] }, { "name": "DescribeTRTCRealTimeScaleData", "description": "查询TRTC监控仪表盘-实时监控规模指标（会返回下列指标） -userCount（在线用户数） -roomCount（在线房间数） 注意： 1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，详情参考[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)。 2.查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "string", "required": true, "description": "用户SdkAppId（如：1400xxxxxx）", "example": "1400000000" }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间，unix时间戳，单位：秒（查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时）", "example": "1665747036" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间，unix时间戳，单位：秒", "example": "1665747284" }, { "name": "RoomId", "type": "string", "required": false, "description": "房间ID", "example": "23390" } ], "required": [ "SdkAppId", "StartTime", "EndTime" ] }, { "name": "DescribeTrtcMcuTranscodeTime", "description": "查询旁路转码计费时长。 - 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。 - 单次查询统计区间最多不能超过31天。 - 若查询当天用量，由于统计延迟等原因，返回数据可能不够准确。 - 日结后付费将于次日上午推送账单，建议次日上午9点以后再来查询前一天的用量。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间，格式为YYYY-MM-DD。", "example": "2020-09-07" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，格式为YYYY-MM-DD。 单次查询统计区间最多不能超过31天。", "example": "2020-09-08" }, { "name": "SdkAppId", "type": "integer", "required": false, "description": "应用ID，可不传。传应用ID时返回的是该应用的用量，不传时返回多个应用的合计值。", "example": "1400123456" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeTrtcRoomUsage", "description": "查询TRTC音视频房间维度用量。 - 单次只能查询一天数据，返回查询时间段内的汇总数据；通过多次查询可以查不同天数据。若查询跨天用量，由于统计延迟等原因，返回数据可能不够准确。 - 该接口只用于历史用量数据统计或核对数据使用，关键业务逻辑不能使用，不可用于账单核对，如需对账请使用账号/应用维度用量API：DescribeTrtcUsage。 - 默认接口请求频率限制：1次/15秒。...", "status": "online", "parameters": [ { "name": "SdkAppid", "type": "integer", "required": true, "description": "TRTC的SdkAppId，和房间所对应的SdkAppId相同。", "example": "1400017192" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间，格式为YYYY-MM-DD HH:MM，精确到分钟级。", "example": "2023-01-06 00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，格式为YYYY-MM-DD HH:MM，单次查询不超过24h。", "example": "2023-01-06 10:00" } ], "required": [ "SdkAppid", "StartTime", "EndTime" ] }, { "name": "DescribeTrtcUsage", "description": "获取TRTC音视频互动的用量明细，单位:分钟。 - 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。 - 单次查询统计区间最多不能超过31天。 - 若查询当天用量，由于统计延迟等原因，返回数据可能不够准确。 - 该接口只用于历史用量数据统计或核对数据使用，关键业务逻辑不能使用。 - 默认接口请求频率限制：5次/秒。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间，格式为YYYY-MM-DD。", "example": "2022-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，格式为YYYY-MM-DD。 单次查询统计区间最多不能超过31天。", "example": "2022-01-01 00:00:00" }, { "name": "SdkAppId", "type": "integer", "required": false, "description": "TRTC的SdkAppId，和房间所对应的SdkAppId相同。如果没有这个参数，返回用户下全部实时音视频应用的汇总。", "example": "1400123456" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeUnusualEvent", "description": "查询SdkAppId下任意20条异常体验事件，返回异常体验ID与可能产生异常体验的原因。可查询14天内数据，查询起止时间不超过1个小时。支持跨天查询。（同老接口DescribeAbnormalEvent） 异常体验ID映射见：https://cloud.tencent.com/document/product/647/44916", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "用户SdkAppId（如：1400xxxxxx）", "example": "1400xxxxxx" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查询开始时间，本地unix时间戳，单位为秒（如：1590065777） 注意：支持查询14天内的数据", "example": "1590065777" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询结束时间，本地unix时间戳，单位为秒（如：1590065877）注意：与StartTime间隔时间不超过1小时。", "example": "1590065877" }, { "name": "RoomId", "type": "string", "required": false, "description": "房间号，查询房间内任意20条以内异常体验事件", "example": "223" } ], "required": [ "SdkAppId", "StartTime", "EndTime" ] }, { "name": "DescribeUserEvent", "description": "查询用户某次通话内的进退房，视频开关等详细事件。可查询14天内数据。（同接口DescribeDetailEvent）", "status": "online", "parameters": [ { "name": "CommId", "type": "string", "required": true, "description": "通话 ID（唯一标识一次通话）： SdkAppId_RoomId（房间号）_ CreateTime（房间创建时间，unix时间戳，单位为s）例：1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo（查询历史房间列表）接口获取（[查询历史房间列表](https://cloud.tencent.com/document/product/647/44050)）。", "example": "1400xxxxxx_3568_1588055615" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查询开始时间，本地unix时间戳，单位为秒（如：1590065777） 注意：支持查询14天内的数据", "example": "1590065777" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询结束时间，本地unix时间戳，单位为秒（如：1590065877） 注意：查询时间大于房间结束时间，以房间结束时间为准。", "example": "1590065777" }, { "name": "UserId", "type": "string", "required": true, "description": "用户UserId", "example": "user_66319581" }, { "name": "RoomId", "type": "string", "required": true, "description": "房间号（如：223）", "example": "1711" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "用户SdkAppId（如：1400xxxxxx）", "example": "1400xxxxxx" } ], "required": [ "CommId", "StartTime", "EndTime", "UserId", "RoomId", "SdkAppId" ] }, { "name": "DescribeUserInfo", "description": "查询指定时间内的用户列表，最大可查询14天内数据，查询起止时间不超过4小时。默认每页查询6个用户，支持每页最大查询100个用户PageSize不超过100）。（同老接口DescribeUserInformation） **注意**： 1.该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。 2.该接口自2024年4月1日起正式商业化，需订阅套餐解锁调用能力，提供以下两种解锁方式，可任选其一解\ufffd...", "status": "online", "parameters": [ { "name": "CommId", "type": "string", "required": true, "description": "通话 ID（唯一标识一次通话）： SdkAppId_RoomId（房间号）_ CreateTime（房间创建时间，unix时间戳，单位为s）例：1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo（查询历史房间列表）接口获取（[查询历史房间列表](https://cloud.tencent.com/document/product/647/44050)）。", "example": "1400xxxxxx_218695_1590065777" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查询开始时间，本地unix时间戳，单位为秒（如：1590065777）注意：最大支持查询14天内的数据", "example": "1590065777" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询结束时间，本地unix时间戳，单位为秒（如：1590065877） 注意：与StartTime间隔时间不超过4小时。", "example": "1590065877" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "用户SdkAppId（如：1400xxxxxx）", "example": "1400xxxxxx" }, { "name": "UserIds", "type": "array", "required": false, "description": "需查询的用户数组，不填默认返回6个用户 范围：[1，100]。", "example": "[\"a\",\"b\",\"c\"]", "item_type": "string" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "当前页数，默认为0， 注意：PageNumber和PageSize 其中一个不填均默认返回6条数据。", "example": "0" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页个数，默认为6， 范围：[1，100]。", "example": "10" } ], "required": [ "CommId", "StartTime", "EndTime", "SdkAppId" ] }, { "name": "DescribeVoicePrint", "description": "查询先前注册的声纹信息", "status": "online", "parameters": [ { "name": "DescribeMode", "type": "integer", "required": true, "description": "查询方式，0表示查询特定VoicePrintId，1表示分页查询", "example": "1" }, { "name": "VoicePrintIdList", "type": "array", "required": false, "description": "声纹ID", "example": "13000569123-fd91f128-52a6-4692-b94a-c0f9fd3c4287", "item_type": "string" }, { "name": "PageIndex", "type": "integer", "required": false, "description": "当前页码,从1开始,DescribeMode为1时填写", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页条数 最少20,DescribeMode为1时填写", "example": "20" } ], "required": [ "DescribeMode" ] }, { "name": "DescribeWebRecord", "description": "查询页面录制任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": false, "description": "开始页面录制时返回的任务id", "example": "HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri" }, { "name": "SdkAppId", "type": "integer", "required": false, "description": "发起页面录制时传递的SdkAppId", "example": "1600011111" }, { "name": "RecordId", "type": "string", "required": false, "description": "发起录制时传递的RecordId, 传入此值时需要传递SdkAppId", "example": "record_class_1" } ], "required": [] }, { "name": "DismissRoom", "description": "接口说明：把房间所有用户从房间移出，解散房间。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId。", "example": "1400***366" }, { "name": "RoomId", "type": "integer", "required": true, "description": "数字房间号。本接口仅支持解散数字类型房间号，如需解散字符串类型房间号，请使用DismissRoomByStrRoomId。", "example": "1001" } ], "required": [ "SdkAppId", "RoomId" ] }, { "name": "DismissRoomByStrRoomId", "description": "接口说明：把房间所有用户从房间移出，解散房间。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId。", "example": "1400000000" }, { "name": "RoomId", "type": "string", "required": true, "description": "字符串类型房间号。 本接口仅支持解散字符串类型房间号，如需解散数字类型房间号，请使用：DismissRoom", "example": "abcd" } ], "required": [ "SdkAppId", "RoomId" ] }, { "name": "ModifyCloudModeration", "description": "成功开启云端审核任务后，可以使用此接口来更新订阅黑白名单。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和TRTC的房间所对应的SDKAppId相同。", "example": "1400188366" }, { "name": "TaskId", "type": "string", "required": true, "description": "审核任务的唯一Id，在启动切片任务成功后会返回。", "example": "-npVoIhU7uxalbjwbc-qxKyKqluNl93bUmLFI4K-4pycoZWQndibYzKsC3HkljEK3HikwogUxwE." }, { "name": "SubscribeStreamUserIds", "type": "object", "required": false, "description": "指定订阅流白名单或者黑名单。", "example": "{\"SubscribeAudioUserIds\":[\"user1\"],\"SubscribeVideoUserIds\":[\"user2\"]}", "children": [ { "name": "SubscribeAudioUserIds", "type": "array", "required": false, "description": "订阅音频流白名单，指定订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的音频流；[\"1.*$\"], 代表订阅UserId前缀为1的音频流。默认不填订阅房间内所有的音频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "UnSubscribeAudioUserIds", "type": "array", "required": false, "description": "订阅音频流黑名单，指定不订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的音频流；[\"1.*$\"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "SubscribeVideoUserIds", "type": "array", "required": false, "description": "订阅视频流白名单，指定订阅哪几个UserId的视频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的视频流；[\"1.*$\"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "UnSubscribeVideoUserIds", "type": "array", "required": false, "description": "订阅视频流黑名单，指定不订阅哪几个UserId的视频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的视频流；[\"1.*$\"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" } ] } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "ModifyCloudRecording", "description": "成功开启录制后，可以使用此接口来更新录制任务。仅在录制任务进行时有效，录制退出后更新将会返回错误。更新操作是全量覆盖，并不是增量更新的模式，也就是说每次更新都需要携带全量的信息。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和录制的房间所对应的SDKAppId相同。", "example": "1400**366" }, { "name": "TaskId", "type": "string", "required": true, "description": "录制任务的唯一Id，在启动录制成功后会返回。", "example": "-m9-bVVU7gzdSqvsV***Y+QMYNee2QE." }, { "name": "MixLayoutParams", "type": "object", "required": false, "description": "需要更新的混流的布局参数。", "example": "无", "children": [ { "name": "MixLayoutMode", "type": "integer", "required": true, "description": "布局模式: 1：悬浮布局； 2：屏幕分享布局； 3：九宫格布局； 4：自定义布局； 悬浮布局：默认第一个进入房间的主播（也可以指定一个主播）的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列，显示为小画面，小画面悬浮于大画面之上。当画面数量小于等于17个时，每行4个（4 x 4排列）。当画面数量大于17个时，重新布局小画面为每行...", "example": "3" }, { "name": "MixLayoutList", "type": "array", "required": false, "description": "如果MixLayoutMode 选择为4自定义布局模式的话，设置此参数为每个主播所对应的布局画面的详细信息，最大不超过25个。", "example": "无", "item_type": "object", "children": [ { "name": "Top", "type": "integer", "required": true, "description": "画布上该画面左上角的 y 轴坐标，取值范围 [0, 1920]，不能超过画布的高。", "example": "100" }, { "name": "Left", "type": "integer", "required": true, "description": "画布上该画面左上角的 x 轴坐标，取值范围 [0, 1920]，不能超过画布的宽。", "example": "100" }, { "name": "Width", "type": "integer", "required": true, "description": "画布上该画面宽度的相对值，取值范围 [0, 1920]，与Left相加不应超过画布的宽。", "example": "100" }, { "name": "Height", "type": "integer", "required": true, "description": "画布上该画面高度的相对值，取值范围 [0, 1920]，与Top相加不应超过画布的高。", "example": "100" }, { "name": "UserId", "type": "string", "required": false, "description": "字符串内容为待显示在该画面的主播对应的UserId，如果不指定，会按照主播加入房间的顺序匹配。", "example": "user_1" }, { "name": "Alpha", "type": "integer", "required": false, "description": "画布的透明度值，取值范围[0, 255]。0表示不透明，255表示全透明。默认值为0。", "example": "100" }, { "name": "RenderMode", "type": "integer", "required": false, "description": "0 ：拉伸模式，这个模式下整个视频内容会全部显示，并填满子画面，在源视频和目的视频宽高比不一致的时候，画面不会缺少内容，但是画面可能产生形变； 1 ：剪裁模式（默认），这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸，并填满子画面画布，在源视频和目的视频宽高比不一致的时候，画面保持不变形，但是会被剪裁； 2 ：填黑模式，这个模式下会...", "example": "1" }, { "name": "MediaId", "type": "integer", "required": false, "description": "对应订阅流的主辅路标识： 0：主流（默认）； 1：辅流；", "example": "1" }, { "name": "ImageLayer", "type": "integer", "required": false, "description": "该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。", "example": "2" }, { "name": "SubBackgroundImage", "type": "string", "required": false, "description": "图片的url地址， 只支持jpg, png, jpeg，图片分辨率限制不超过2K，图片大小限制不超过5MB。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '\u0026', '(', ')', '*', '+', ',', '%', '='", "example": "https://xxxx/image.jpg, https://xxxx/image.jpg?token=xxx" } ] }, { "name": "BackGroundColor", "type": "string", "required": false, "description": "录制背景颜色，RGB的颜色表的16进制表示，每个颜色通过8bit长度标识，默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500，格式规范：‘#‘开头，后面跟固定RGB的颜色值", "example": "#FF0000" }, { "name": "MaxResolutionUserId", "type": "string", "required": false, "description": "在布局模式为1：悬浮布局和 2：屏幕分享布局时，设定为显示大视频画面的UserId。不填的话：悬浮布局默认是第一个进房间的主播，屏幕分享布局默认是背景色", "example": "user_1" }, { "name": "MediaId", "type": "integer", "required": false, "description": "主辅路标识， 0：主流（默认）； 1：辅流（屏幕分享）； 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路，MixLayoutList内代表的是自定义用户的主辅路。", "example": "0" }, { "name": "BackgroundImageUrl", "type": "string", "required": false, "description": "图片的url地址，只支持jpg, png, jpeg，图片分辨率限制不超过2K，图片大小限制不超过5MB。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '\u0026', '(', ')', '*', '+', ',', '%', '='", "example": "https://xxxx/image.jpg, https://xxxx/image.jpg?token=xxx" }, { "name": "PlaceHolderMode", "type": "integer", "required": false, "description": "设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行音视频时可显示对应的占位图。", "example": "0" }, { "name": "BackgroundImageRenderMode", "type": "integer", "required": false, "description": "背景画面宽高比不一致的时候处理方案，与MixLayoutList定义的RenderMode一致。", "example": "1" }, { "name": "DefaultSubBackgroundImage", "type": "string", "required": false, "description": "子画面占位图url地址，只支持jpg, png, jpeg，图片分辨率限制不超过2K，图片大小限制不超过5MB。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '\u0026', '(', ')', '*', '+', ',', '%', '='", "example": "https://xxxx/image.jpg, https://xxxx/image.jpg?token=xxx" }, { "name": "WaterMarkList", "type": "array", "required": false, "description": "水印布局参数， 最多支持25个。", "example": "无", "item_type": "object", "children": [ { "name": "WaterMarkType", "type": "integer", "required": false, "description": "水印类型，0为图片（默认），1为文字，2为时间戳。", "example": "0" }, { "name": "WaterMarkImage", "type": "object", "required": false, "description": "水印为图片时的参数列表，水印为图片时校验必填。", "example": "无", "children": [ { "name": "WaterMarkUrl", "type": "string", "required": true, "description": "下载的url地址， 只支持jpg, png, jpeg，大小限制不超过5M。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '\u0026', '(', ')', '*', '+', ',', '%', '='", "example": "https://xxxx/image.jpg, https://xxxx/image.jpg?token=xxx" }, { "name": "Top", "type": "integer", "required": true, "description": "画布上该画面左上角的 y 轴坐标，取值范围 [0, 2560]，不能超过画布的高。", "example": "100" }, { "name": "Left", "type": "integer", "required": true, "description": "画布上该画面左上角的 x 轴坐标，取值范围 [0, 2560]，不能超过画布的宽。", "example": "100" }, { "name": "Width", "type": "integer", "required": true, "description": "画布上该画面宽度的相对值，取值范围 [0, 2560]，与Left相加不应超过画布的宽。", "example": "100" }, { "name": "Height", "type": "integer", "required": true, "description": "画布上该画面高度的相对值，取值范围 [0, 2560]，与Top相加不应超过画布的高。", "example": "100" } ] }, { "name": "WaterMarkChar", "type": "object", "required": false, "description": "水印为文字时的参数列表，水印为文字时校验必填。", "example": "无", "children": [ { "name": "Top", "type": "integer", "required": true, "description": "文字水印的起始坐标Y值，从左上角开始", "example": "0" }, { "name": "Left", "type": "integer", "required": true, "description": "文字水印的起始坐标X值，从左上角开始", "example": "0" }, { "name": "Width", "type": "integer", "required": true, "description": "文字水印的宽度，单位像素值", "example": "200" }, { "name": "Height", "type": "integer", "required": true, "description": "文字水印的高度，单位像素值", "example": "100" }, { "name": "Chars", "type": "string", "required": true, "description": "水印文字的内容", "example": "李专家" }, { "name": "FontSize", "type": "integer", "required": false, "description": "水印文字的大小，单位像素，默认14", "example": "14" }, { "name": "FontColor", "type": "string", "required": false, "description": "水印文字的颜色，默认白色", "example": "0xFFFFFF" }, { "name": "BackGroundColor", "type": "string", "required": false, "description": "水印文字的背景色，为空代表背景透明，默认为空", "example": "0xbbccbb" }, { "name": "Font", "type": "string", "required": false, "description": "文字水印的字体，支持设置以下值： 1. Tencent （默认） 2. SourceHanSans", "example": "Tencent" } ] }, { "name": "WaterMarkTimestamp", "type": "object", "required": false, "description": "水印为时间戳时的参数列表，水印为时间戳时校验必填。", "example": "无", "children": [ { "name": "Pos", "type": "integer", "required": true, "description": "时间戳的位置，取值范围0-6，分别代表上左，上右，下左，下右，上居中，下居中，居中", "example": "0" }, { "name": "TimeZone", "type": "integer", "required": false, "description": "显示时间戳的时区，默认东八区", "example": "8" }, { "name": "Font", "type": "string", "required": false, "description": "文字水印的字体，支持设置以下值： 1. Tencent （默认） 2. SourceHanSans", "example": "Tencent" } ] } ] }, { "name": "RenderMode", "type": "integer", "required": false, "description": "模板布局下，背景画面宽高比不一致的时候处理方案。自定义布局不生效，与MixLayoutList定义的RenderMode一致。", "example": "1" }, { "name": "MaxResolutionUserAlign", "type": "integer", "required": false, "description": "屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。", "example": "0" }, { "name": "PureAudioDisableLayout", "type": "boolean", "required": false, "description": "控制房间内纯音频用户是否占据混流布局，只在混流录制，模板布局生效。true: 代表纯音频用户不占位，false: 代表纯音频用户占位（默认为false）。", "example": "false" } ] }, { "name": "SubscribeStreamUserIds", "type": "object", "required": false, "description": "指定订阅流白名单或者黑名单。", "example": "无", "children": [ { "name": "SubscribeAudioUserIds", "type": "array", "required": false, "description": "订阅音频流白名单，指定订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的音频流；[\"1.*$\"], 代表订阅UserId前缀为1的音频流。默认不填订阅房间内所有的音频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "UnSubscribeAudioUserIds", "type": "array", "required": false, "description": "订阅音频流黑名单，指定不订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的音频流；[\"1.*$\"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "SubscribeVideoUserIds", "type": "array", "required": false, "description": "订阅视频流白名单，指定订阅哪几个UserId的视频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的视频流；[\"1.*$\"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "UnSubscribeVideoUserIds", "type": "array", "required": false, "description": "订阅视频流黑名单，指定不订阅哪几个UserId的视频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的视频流；[\"1.*$\"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" } ] } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "ModifyCloudSliceTask", "description": "成功开启切片任务后，可以使用此接口来更新任务。用于更新指定订阅流白名单或者黑名单。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和TRTC的房间所对应的SDKAppId相同。", "example": "1400188366" }, { "name": "TaskId", "type": "string", "required": true, "description": "切片任务的唯一Id，在启动切片任务成功后会返回。", "example": "-nHwX3RU7h3eZ-9PYsqd+z8I1uU1tUnbTWClW4K-xuWiN6KipeCyXJ8ZJEFpWSZ5zZuyZUAuAQ.." }, { "name": "SubscribeStreamUserIds", "type": "object", "required": false, "description": "指定订阅流白名单或者黑名单。", "example": "无", "children": [ { "name": "SubscribeAudioUserIds", "type": "array", "required": false, "description": "订阅音频流白名单，指定订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的音频流；[\"1.*$\"], 代表订阅UserId前缀为1的音频流。默认不填订阅房间内所有的音频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "UnSubscribeAudioUserIds", "type": "array", "required": false, "description": "订阅音频流黑名单，指定不订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的音频流；[\"1.*$\"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "SubscribeVideoUserIds", "type": "array", "required": false, "description": "订阅视频流白名单，指定订阅哪几个UserId的视频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的视频流；[\"1.*$\"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" }, { "name": "UnSubscribeVideoUserIds", "type": "array", "required": false, "description": "订阅视频流黑名单，指定不订阅哪几个UserId的视频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的视频流；[\"1.*$\"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。", "example": "[\"123\",\"456\"]", "item_type": "string" } ] } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "ModifyPicture", "description": "如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材，可通过此接口修改已上传的图片。无需频繁修改图片素材的场景，建议直接在 [控制台 \u003e 应用管理 \u003e 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。", "status": "online", "parameters": [ { "name": "PictureId", "type": "integer", "required": true, "description": "图片id", "example": "10081" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用id", "example": "1500000001" }, { "name": "Height", "type": "integer", "required": false, "description": "图片长度", "example": "80" }, { "name": "Width", "type": "integer", "required": false, "description": "图片宽度", "example": "70" }, { "name": "XPosition", "type": "integer", "required": false, "description": "显示位置x轴方向", "example": "10" }, { "name": "YPosition", "type": "integer", "required": false, "description": "显示位置y轴方向", "example": "20" } ], "required": [ "PictureId", "SdkAppId" ] }, { "name": "RegisterVoicePrint", "description": "传入音频base64串，注册声纹信息，返回声纹ID", "status": "online", "parameters": [ { "name": "Audio", "type": "string", "required": true, "description": "整个wav音频文件的base64字符串,其中wav文件限定为16k采样率, 16bit位深, 单声道, 8到18秒音频时长,有效音频不小于6秒(不能有太多静音段),编码数据大小不超过2M", "example": "kAOgA9AEA..." }, { "name": "ReqTimestamp", "type": "integer", "required": true, "description": "毫秒时间戳", "example": "1748249540000" }, { "name": "AudioFormat", "type": "integer", "required": true, "description": "音频格式,目前只支持0,代表wav", "example": "0" }, { "name": "AudioName", "type": "string", "required": true, "description": "音频名称,长度不要超过32", "example": "jackson" }, { "name": "AudioMetaInfo", "type": "string", "required": false, "description": "和声纹绑定的MetaInfo，长度最大不超过512", "example": "metainfo string" } ], "required": [ "Audio", "ReqTimestamp", "AudioFormat", "AudioName" ] }, { "name": "RemoveUser", "description": "接口说明：将用户从房间移出，适用于主播/房主/管理员踢人等场景。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId。", "example": "1400***366" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间号。", "example": "1001" }, { "name": "UserIds", "type": "array", "required": true, "description": "要移出的用户列表，最多10个。", "example": "[user_1,user_2,user_3]", "item_type": "string" } ], "required": [ "SdkAppId", "RoomId", "UserIds" ] }, { "name": "RemoveUserByStrRoomId", "description": "接口说明：将用户从房间移出，适用于主播/房主/管理员踢人等场景。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId。", "example": "1400xxx" }, { "name": "RoomId", "type": "string", "required": true, "description": "房间号。", "example": "room_1001" }, { "name": "UserIds", "type": "array", "required": true, "description": "要移出的用户列表，最多10个。", "example": "[user_1,user_2,user_3]", "item_type": "string" } ], "required": [ "SdkAppId", "RoomId", "UserIds" ] }, { "name": "StartAIConversation", "description": "启动AI对话任务，AI通道机器人进入TRTC房间，与房间内指定的成员进行AI对话，适用于智能客服，AI口语教师等场景 TRTC AI对话功能内置语音转文本能力，同时提供通道服务，即客户可灵活指定第三方AI模型（LLM）服务和文本转音频（TTS)服务，更多[功能说明](https://cloud.tencent.com/document/product/647/108901)。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和开启转录任务的房间使用的SdkAppId相同。", "example": "14000000000" }, { "name": "RoomId", "type": "string", "required": true, "description": "TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，表示开启对话任务的房间号。", "example": "10000" }, { "name": "AgentConfig", "type": "object", "required": true, "description": "机器人参数", "example": "无", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "机器人的UserId，用于进房发起任务。【注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个任务时，机器人的UserId也不能相互重复，否则会中断前一个任务。需要保证机器人UserId在房间内唯一。", "example": "user_132" }, { "name": "UserSig", "type": "string", "required": true, "description": "机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。", "example": "ehbciOiJS" }, { "name": "TargetUserId", "type": "string", "required": true, "description": "机器人拉流的UserId, 填写后，机器人会拉取该UserId的流进行实时处理", "example": "user_132" }, { "name": "MaxIdleTime", "type": "integer", "required": false, "description": "房间内超过MaxIdleTime 没有推流，后台自动关闭任务，默认值是60s。", "example": "60" }, { "name": "WelcomeMessage", "type": "string", "required": false, "description": "机器人的欢迎语", "example": "你好呀" }, { "name": "InterruptMode", "type": "integer", "required": false, "description": "智能打断模式，默认为0，0表示服务端自动打断，1表示服务端不打断，由端上发送打断信令进行打断", "example": "0" }, { "name": "InterruptSpeechDuration", "type": "integer", "required": false, "description": "InterruptMode为0时使用，单位为毫秒，默认为500ms。表示服务端检测到持续InterruptSpeechDuration毫秒的人声则进行打断。", "example": "500" }, { "name": "TurnDetectionMode", "type": "integer", "required": false, "description": "控制新一轮对话的触发方式，默认为0。 - 0表示当服务端语音识别检测出的完整一句话后，自动触发一轮新的对话。 - 1表示客户端在收到字幕消息后，自行决定是否手动发送聊天信令触发一轮新的对话。", "example": "0" }, { "name": "FilterOneWord", "type": "boolean", "required": false, "description": "是否过滤掉用户只说了一个字的句子，true表示过滤，false表示不过滤，默认值为true", "example": "true" }, { "name": "WelcomeMessagePriority", "type": "integer", "required": false, "description": "欢迎消息优先级，0默认，1高优，高优不能被打断。", "example": "0" }, { "name": "FilterBracketsContent", "type": "integer", "required": false, "description": "用于过滤LLM返回内容，不播放括号中的内容。 1：中文括号（） 2：英文括号() 3：中文方括号【】 4：英文方括号[] 5：英文花括号{} 默认值为空，表示不进行过滤。", "example": "1" }, { "name": "AmbientSound", "type": "object", "required": false, "description": "环境音设置", "example": "无", "children": [ { "name": "Scene", "type": "string", "required": true, "description": "环境场景选择", "example": "coffee_shops" }, { "name": "Volume", "type": "float", "required": false, "description": "控制环境音的音量。取值的范围是 [0,2]。值越低，环境音越小；值越高，环境音越响亮。如果未设置，则使用默认值 1。", "example": "1.0" } ] }, { "name": "VoicePrint", "type": "object", "required": false, "description": "声纹配置", "example": "无", "children": [ { "name": "Mode", "type": "integer", "required": false, "description": "默认为0，表示不启用声纹。1表示启用声纹，此时需要填写voiceprint id。", "example": "1" }, { "name": "IdList", "type": "array", "required": false, "description": "VoicePrint Mode为1时需要填写，目前仅支持填写一个声纹id", "example": "[\"your-voiceprint-id\"]", "item_type": "string" } ] }, { "name": "TurnDetection", "type": "object", "required": false, "description": "语义断句检测", "example": "无", "children": [ { "name": "SemanticEagerness", "type": "string", "required": false, "description": "TurnDetectionMode为3时生效，语义断句的灵敏程度 功能简介：根据用户所说的话来判断其已完成发言来分割音频 可选: \"low\" | \"medium\" | \"high\" | \"auto\" auto 是默认值，与 medium 相同。 low 将让用户有足够的时间说话。 high 将尽快对音频进行分块。 如果您希望模型在对话模式下更频繁地响应，可以将 SemanticEagerness 设置为 high 如果您希望在用户停顿时，AI能够等待片刻，可以将 SemanticEagerness ...", "example": "auto" } ] }, { "name": "SubtitleMode", "type": "integer", "required": false, "description": "机器人字幕显示模式。 - 0表示尽快显示，不会和音频播放进行同步。此时字幕全量下发，后面的字幕会包含前面的字幕。 - 1表示句子级别的实时显示，会和音频播放进行同步，只有当前句子对应的音频播放完后，下一条字幕才会下发。此时字幕增量下发，端上需要把前后的字幕进行拼接才是完整字幕。", "example": "1" }, { "name": "InterruptWordList", "type": "array", "required": false, "description": "打断词列表，在AI说话期间，只有说出列表中的打断词才会打断AI说话。 注意：打断词不会触发AI回复。", "example": "[\"停下\"]", "item_type": "string" } ] }, { "name": "SessionId", "type": "string", "required": false, "description": "调用方传入的唯一Id，可用于客户侧防止重复发起任务以及可以通过该字段查询任务状态。", "example": "conversation_1_2" }, { "name": "RoomIdType", "type": "integer", "required": false, "description": "TRTC房间号的类型，0代表数字房间号，1代表字符串房间号。不填默认是数字房间号。", "example": "0" }, { "name": "STTConfig", "type": "object", "required": false, "description": "语音识别配置。", "example": "无", "children": [ { "name": "Language", "type": "string", "required": false, "description": "语音转文字支持识别的语言，默认是\"zh\" 中文 可通过购买「AI智能识别时长包」解锁或领取包月套餐体验版解锁不同语言. 详细说明参考：[AI智能识别计费说明](https://cloud.tencent.com/document/product/647/111976) 语音转文本不同套餐版本支持的语言如下： **基础语言引擎**： - \"zh\": 中文（简体） - \"zh-TW\": 中文（繁体） - \"en\": 英语 - \"16k_zh_edu\"：中文教育 - \"16k_zh_medical\"：中文医疗 - \"16k_zh_court...", "example": "zh" }, { "name": "AlternativeLanguage", "type": "array", "required": false, "description": "**发起模糊识别为高级版能力,默认按照高级版收费** 注意：不支持填写\"zh-dialect\", \"16k_zh_edu\", \"16k_zh_medical\", \"16k_zh_court\", \"8k_zh_large\", \"16k_zh_large\",\"16k_multi_lang\", \"16k_zh_en\"", "example": "[\"zh\", \"en\"]", "item_type": "string" }, { "name": "CustomParam", "type": "string", "required": false, "description": "自定义参数，联系后台使用", "example": "{\"key\": \"xx\"}" }, { "name": "VadSilenceTime", "type": "integer", "required": false, "description": "语音识别vad的时间，范围为240-2000，默认为1000，单位为ms。更小的值会让语音识别分句更快。", "example": "500" }, { "name": "HotWordList", "type": "string", "required": false, "description": "热词表：该参数用于提升识别准确率。 单个热词限制：\"热词|权重\"，单个热词不超过30个字符（最多10个汉字），权重[1-11]或者100，如：“腾讯云|5” 或 “ASR|11”； 热词表限制：多个热词用英文逗号分割，最多支持128个热词，如：“腾讯云|10,语音识别|5,ASR|11”；", "example": "腾讯云|10,语音识别|5,ASR|11" }, { "name": "VadLevel", "type": "integer", "required": false, "description": "vad的远场人声抑制能力（不会对asr识别效果造成影响），范围为[0, 5]，默认为0，表示不开启远场人声抑制能力。推荐设置为2，有较好的远场人声抑制能力。嘈杂的办公室环境下可以设置为3，更为嘈杂的环境下可以使用4和5。注意较高的VadLevel可能会将单字当作噪声给过滤。", "example": "1" } ] }, { "name": "LLMConfig", "type": "string", "required": false, "description": "必填参数，LLM配置。需符合openai规范，为JSON字符串，示例如下： { \u0026emsp; \"LLMType\": \"大模型类型\", // String 必填，如：\"openai\" \u0026emsp; \"Model\": \"您的模型名称\", // String 必填，指定使用的模型 \"APIKey\": \"您的LLM API密钥\", // String 必填 \u0026emsp; \"APIUrl\": \"https://api.xxx.com/chat/completions\", // String 必填，LLM API访问的URL \u0026emsp; \"History\": 10, // Integer 选填，设置 LLM 的上下文轮次，默认值为0，最大值50 \u0026emsp; \"Histor...", "example": "{\\\"LLMType\\\": \\\"openai\\\", \\\"Model\\\": \\\"gpt-xxx\", \\\"APIKey\\\": \\\"xxxxxxxx\\\", \\\"APIUrl\\\": \\\"https://api.xxx.com/v1/chat/completions\\\", \\\"Streaming\\\": true}" }, { "name": "TTSConfig", "type": "string", "required": false, "description": "必填参数，TTS配置，详见 [TTS配置说明](https://cloud.tencent.com/document/product/647/115414 )， 为JSON字符串: TRTC TTS的配置如下： ``` { \"TTSType\": \"flow\", // 【必填】固定为此值 \"VoiceId\": \"v-female-R2s4N9qJ\", // 【必填】精品音色 ID /克隆音色 ID, 可选择 不同音色, ID 库参考下方音色列表 \"Model\": \"flow_01_turbo\", // 【必填】当前默认的 TTS 模型版本（对应 Flash 版本） \"Speed\": 1.0, //【可选】调节语速 范围 [0.5-...", "example": "{\\\"TTSType\\\": \\\"flow\\\",\\\"VoiceId\\\": \\\"v-female-R2s4N9qJ\\\", \\\"Speed\\\": 1}" }, { "name": "AvatarConfig", "type": "string", "required": false, "description": "数字人配置，为JSON字符串。**数字人配置需要提工单加白后才能使用**", "example": "{\\\"AvatarType\\\": \\\"tencent\\\", \\\"Appkey\\\": \\\"数字人的appkey\\\", \\\"AccessToken\\\": \\\"token\\\",\\\"AssetVirtualmanKey\\\": \\\"2d64a32c02604b8db35d457ba0db0d75\\\", \\\"AvatarUserID\\\": \\\"robot_xiaowei\\\", \\\"DriverType\\\": 1, \\\"AvatarUserSig\\\": \\\"user_sign\\\"}" }, { "name": "ExperimentalParams", "type": "string", "required": false, "description": "实验性参数,联系后台使用", "example": "{\"internal\": \"xxx\"}" } ], "required": [ "SdkAppId", "RoomId", "AgentConfig" ] }, { "name": "StartAITranscription", "description": "启动转录机器人，后台会通过机器人拉流进行实时进行语音识别并下发字幕和转录消息。 转录机器人支持两种拉流方式，通过TranscriptionMode字段控制： - 拉取全房间的流。 - 拉取特定用户的流。 服务端通过TRTC的自定义消息实时下发字幕以及转录消息，CmdId固定是1。客户端只需监听自定义消息的回调即可，比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a251870...", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和开启转录任务的房间使用的SdkAppId相同。", "example": "14600000" }, { "name": "RoomId", "type": "string", "required": true, "description": "TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，表示开启转录任务的房间号。", "example": "11" }, { "name": "TranscriptionParams", "type": "object", "required": true, "description": "转录机器人的参数。", "example": "无", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "转录机器人的UserId，用于进房发起转录任务。【注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个转录任务时，机器人的userid也不能相互重复，否则会中断前一个任务。需要保证转录机器人UserId在房间内唯一。", "example": "user329" }, { "name": "UserSig", "type": "string", "required": true, "description": "转录机器人UserId对应的校验签名，即UserId和UserSig相当于转录机器人进房的登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。", "example": "egjirneiwrwq" }, { "name": "MaxIdleTime", "type": "integer", "required": false, "description": "房间内推流用户全部退出后超过MaxIdleTime秒，后台自动关闭转录任务，默认值是60s。", "example": "60" }, { "name": "TranscriptionMode", "type": "integer", "required": false, "description": "1表示机器人只订阅单个人的流，0表示机器人订阅整个房间的流，如果不填默认订阅整个房间的流。", "example": "1" }, { "name": "TargetUserId", "type": "string", "required": false, "description": "TranscriptionMode为1时必填，机器人只会拉该userid的流，忽略房间里其他用户。", "example": "user219" }, { "name": "TargetUserIdList", "type": "array", "required": false, "description": "机器人订阅的用户列表 仅 TranscriptionMode 为 1或者 TranscriptionMode 为无限上麦模式支持传入多个用户列表", "example": "[\"string\"]", "item_type": "string" }, { "name": "VoicePrint", "type": "object", "required": false, "description": "声纹配置", "example": "无", "children": [ { "name": "Mode", "type": "integer", "required": false, "description": "默认为0，表示不启用声纹。1表示启用声纹，此时需要填写voiceprint id。", "example": "1" }, { "name": "IdList", "type": "array", "required": false, "description": "VoicePrint Mode为1时需要填写，目前仅支持填写一个声纹id", "example": "[\"your-voiceprint-id\"]", "item_type": "string" } ] }, { "name": "TurnDetection", "type": "object", "required": false, "description": "语义断句检测", "example": "无", "children": [ { "name": "SemanticEagerness", "type": "string", "required": false, "description": "TurnDetectionMode为3时生效，语义断句的灵敏程度 功能简介：根据用户所说的话来判断其已完成发言来分割音频 可选: \"low\" | \"medium\" | \"high\" | \"auto\" auto 是默认值，与 medium 相同。 low 将让用户有足够的时间说话。 high 将尽快对音频进行分块。 如果您希望模型在对话模式下更频繁地响应，可以将 SemanticEagerness 设置为 high 如果您希望在用户停顿时，AI能够等待片刻，可以将 SemanticEagerness ...", "example": "auto" } ] } ] }, { "name": "SessionId", "type": "string", "required": false, "description": "调用方传入的唯一Id，服务端用来任务去重，重复的任务会发起失败。服务端固定使用SdkAppId+RoomId+RoomIdType+RobotUserId来去重，如果传入了SessionId，也会使用SessionId去重。 注意： TranscriptionMode为0时，需要保证一个房间内只发起一个任务，如果发起多个任务，则机器人之间会相互订阅，除非主动停止任务，否则只有10小时后任务才会超时退出，这种情况下建议填写SessionId，保证后续...", "example": "session_1" }, { "name": "RoomIdType", "type": "integer", "required": false, "description": "TRTC房间号的类型，0代表数字房间号，1代表字符串房间号。不填默认是数字房间号。", "example": "0" }, { "name": "RecognizeConfig", "type": "object", "required": false, "description": "语音识别配置。", "example": "无", "children": [ { "name": "Language", "type": "string", "required": false, "description": "语音转文字支持识别的语言，默认是\"zh\" 中文 可通过购买「AI智能识别时长包」解锁或领取包月套餐体验版解锁不同语言. 详细说明参考：[AI智能识别计费说明](https://cloud.tencent.com/document/product/647/111976) 语音转文本不同套餐版本支持的语言如下： **基础语言引擎**： - \"zh\": 中文（简体） **标准语言引擎：** - \"8k_zh_large\": 普方大模型引擎. 当前模型同时支持中文等语言的识别，模型\ufffd...", "example": "zh" }, { "name": "AlternativeLanguage", "type": "array", "required": false, "description": "**发起模糊识别为高级版能力,默认按照高级版收费,仅支持填写基础版和高级版语言.** 注意：不支持填写\"zh-dialect\"", "example": "[\"en\",\"jp\"]", "item_type": "string" }, { "name": "HotWordList", "type": "string", "required": false, "description": "热词表：该参数用于提升识别准确率。 单个热词限制：\"热词|权重\"，单个热词不超过30个字符（最多10个汉字），权重[1-11]或者100，如：“腾讯云|5” 或 “ASR|11”； 热词表限制：多个热词用英文逗号分割，最多支持300个热词，如：“腾讯云|10,语音识别|5,ASR|11”；", "example": "腾讯云|10,语音识别|5,ASR|11" }, { "name": "VadSilenceTime", "type": "integer", "required": false, "description": "语音识别vad的时间，范围为240-2000，默认为1000，单位为ms。更小的值会让语音识别分句更快。", "example": "1000" }, { "name": "VadLevel", "type": "integer", "required": false, "description": "vad的远场人声抑制能力（不会对asr识别效果造成影响），范围为[0, 3]，默认为0。推荐设置为2，有较好的远场人声抑制能力。", "example": "1" } ] }, { "name": "TranslationConfig", "type": "object", "required": false, "description": "翻译相关配置", "example": "无", "children": [ { "name": "TargetLanguages", "type": "array", "required": true, "description": "翻译的目标语言，目标语种列表（ISO 639-1）", "example": "[\"en\", \"ja\"]", "item_type": "string" }, { "name": "Mode", "type": "integer", "required": false, "description": "1： 仅文字翻译， 2： 语音同传", "example": "2" }, { "name": "TTSConfig", "type": "object", "required": false, "description": "语音同传配置，开启同传时，需要传递", "example": "无", "children": [ { "name": "VoiceId", "type": "string", "required": true, "description": "音色ID", "example": "v-female-R2s4N9qJ" }, { "name": "Model", "type": "string", "required": false, "description": "TTS 的模型，默认是：flow_01_turbo, 可选: [ flow_01_turbo, flow_01_ex]", "example": "flow_01_turbo" }, { "name": "Speed", "type": "float", "required": false, "description": "语速，范围 0.5-2.0，默认 1.0", "example": "1.0" }, { "name": "Volume", "type": "float", "required": false, "description": "(0, 10] 默认值1.0", "example": "1.0" } ] }, { "name": "Terminology", "type": "array", "required": false, "description": "翻译术语集合", "example": "无", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "源术语", "example": "腾讯云" }, { "name": "Target", "type": "string", "required": true, "description": "目标术语翻译结果", "example": "Tencent Cloud" } ] } ] } ], "required": [ "SdkAppId", "RoomId", "TranscriptionParams" ] }, { "name": "StartMCUMixTranscode", "description": "接口说明：启动云端混流，并指定混流画面中各路画面的布局位置。 TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过此 API 接口，通知腾讯云服务端将多路视频画面合成一路，并指定每一路画面的位置，同时将多路声音进行混音，最终形成一路音视频流，以便用于录制和直播观看。房间销毁后混流自动结束。 您可以通过此接口实现如下目标： - 设置最终直播流的\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId。", "example": "1400188366" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间号。", "example": "3560" }, { "name": "OutputParams", "type": "object", "required": true, "description": "混流输出控制参数。", "example": "无", "children": [ { "name": "StreamId", "type": "string", "required": true, "description": "直播流 ID，由用户自定义设置，该流 ID 不能与用户旁路的流 ID 相同，限制64字节。", "example": "mix_stream" }, { "name": "PureAudioStream", "type": "integer", "required": false, "description": "取值范围[0,1]， 填0：直播流为音视频(默认); 填1：直播流为纯音频", "example": "0" }, { "name": "RecordId", "type": "string", "required": false, "description": "自定义录制文件名称前缀。请先在实时音视频控制台开通录制功能，https://cloud.tencent.com/document/product/647/50768。 【注意】该方式仅对旧版云端录制功能的应用生效，新版云端录制功能的应用请用接口CreateCloudRecording发起录制。新、旧云端录制类型判断方式请见：https://cloud.tencent.com/document/product/647/50768#record", "example": "mix_stream_record" }, { "name": "RecordAudioOnly", "type": "integer", "required": false, "description": "取值范围[0,1]，填0无实际含义; 填1：指定录制文件格式为mp3。此参数不建议使用，建议在实时音视频控制台配置纯音频录制模板。", "example": "0" } ] }, { "name": "EncodeParams", "type": "object", "required": true, "description": "混流输出编码参数。", "example": "无", "children": [ { "name": "AudioSampleRate", "type": "integer", "required": true, "description": "混流-输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000]，单位是Hz。混流任务发起过程中，为了保持CDN链接的稳定，不要修改音频参数（codec、采样率、码率、声道数）。", "example": "48000" }, { "name": "AudioBitrate", "type": "integer", "required": true, "description": "混流-输出流音频码率。取值范围[8,500]，单位为kbps。混流任务发起过程中，为了保持CDN链接的稳定，不要修改音频参数（codec、采样率、码率、声道数）。", "example": "64" }, { "name": "AudioChannels", "type": "integer", "required": true, "description": "混流-输出流音频声道数，取值范围[1,2]，1表示混流输出音频为单声道，2表示混流输出音频为双声道。混流任务发起过程中，为了保持CDN链接的稳定，不要修改音频参数（codec、采样率、码率、声道数）。", "example": "2" }, { "name": "VideoWidth", "type": "integer", "required": false, "description": "混流-输出流宽，音视频输出时必填。取值范围[0,1920]，单位为像素值。", "example": "1280" }, { "name": "VideoHeight", "type": "integer", "required": false, "description": "混流-输出流高，音视频输出时必填。取值范围[0,1080]，单位为像素值。", "example": "720" }, { "name": "VideoBitrate", "type": "integer", "required": false, "description": "混流-输出流码率，音视频输出时必填。取值范围[1,10000]，单位为kbps。", "example": "512" }, { "name": "VideoFramerate", "type": "integer", "required": false, "description": "混流-输出流帧率，音视频输出时必填。取值范围[1,60]，表示混流的输出帧率可选范围为1到60fps。", "example": "15" }, { "name": "VideoGop", "type": "integer", "required": false, "description": "混流-输出流gop，音视频输出时必填。取值范围[1,5]，单位为秒。", "example": "2" }, { "name": "BackgroundColor", "type": "integer", "required": false, "description": "混流-输出流背景色，取值是十进制整数。常用的颜色有： 红色：0xff0000，对应的十进制整数是16724736。 黄色：0xffff00。对应的十进制整数是16776960。 绿色：0x33cc00。对应的十进制整数是3394560。 蓝色：0x0066ff。对应的十进制整数是26367。 黑色：0x000000。对应的十进制整数是0。 白色：0xFFFFFF。对应的十进制整数是16777215。 灰色：0x999999。对应的十进制整数是10066329。", "example": "0" }, { "name": "BackgroundImageId", "type": "integer", "required": false, "description": "混流-输出流背景图片，取值为实时音视频控制台上传的图片ID。", "example": "0" }, { "name": "AudioCodec", "type": "integer", "required": false, "description": "混流-输出流音频编码类型，取值范围[0,1, 2]，0为LC-AAC，1为HE-AAC，2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时，只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。混流任务发起过程中，为了保持CDN链接的稳定，不要修改音频参数（codec、采样率、码率、声道数）。", "example": "0" }, { "name": "BackgroundImageUrl", "type": "string", "required": false, "description": "混流-输出流背景图片URL地址，支持png、jpg、jpeg、bmp格式，暂不支持透明通道。URL链接长度限制为512字节。BackgroundImageUrl和BackgroundImageId参数都填时，以BackgroundImageUrl为准。图片大小限制不超过2MB。", "example": "https://******.png" } ] }, { "name": "LayoutParams", "type": "object", "required": true, "description": "混流输出布局参数。", "example": "无", "children": [ { "name": "Template", "type": "integer", "required": false, "description": "混流布局模板ID，0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。", "example": "0" }, { "name": "MainVideoUserId", "type": "string", "required": false, "description": "屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的用户ID。", "example": "\"main_video_user\"" }, { "name": "MainVideoStreamType", "type": "integer", "required": false, "description": "屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的流类型，0为摄像头，1为屏幕分享。左侧大画面为web用户时此值填0。", "example": "0" }, { "name": "SmallVideoLayoutParams", "type": "object", "required": false, "description": "画中画模板中有效，代表小画面的布局参数。", "example": "SmallVideoLayoutParams", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "代表小画面对应的用户ID。", "example": "\"small_video_user\"" }, { "name": "StreamType", "type": "integer", "required": true, "description": "代表小画面对应的流类型，0为摄像头，1为屏幕分享。小画面为web用户时此值填0。", "example": "0" }, { "name": "ImageWidth", "type": "integer", "required": false, "description": "小画面在输出时的宽度，单位为像素值，不填默认为0。", "example": "640" }, { "name": "ImageHeight", "type": "integer", "required": false, "description": "小画面在输出时的高度，单位为像素值，不填默认为0。", "example": "480" }, { "name": "LocationX", "type": "integer", "required": false, "description": "小画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。", "example": "0" }, { "name": "LocationY", "type": "integer", "required": false, "description": "小画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。", "example": "0" } ] }, { "name": "MainVideoRightAlign", "type": "integer", "required": false, "description": "屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。", "example": "0" }, { "name": "MixVideoUids", "type": "array", "required": false, "description": "指定混视频的用户ID列表。设置此参数后，输出流混合此参数中包含用户的音视频，以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效，最多可设置16个用户。", "example": "[\"1234\",\"5678\"]", "item_type": "string" }, { "name": "PresetLayoutConfig", "type": "array", "required": false, "description": "自定义模板中有效，指定用户视频在混合画面中的位置。", "example": "PresetLayoutConfig", "item_type": "object", "children": [ { "name": "UserId", "type": "string", "required": false, "description": "指定显示在该画面上的用户ID。如果不指定用户ID，会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。", "example": "user1" }, { "name": "StreamType", "type": "integer", "required": false, "description": "当该画面指定用户时，代表用户的流类型。0为摄像头，1为屏幕分享。小画面为web用户时此值填0。", "example": "0" }, { "name": "ImageWidth", "type": "integer", "required": false, "description": "该画面在输出时的宽度，单位为像素值，不填默认为0。", "example": "640" }, { "name": "ImageHeight", "type": "integer", "required": false, "description": "该画面在输出时的高度，单位为像素值，不填默认为0。", "example": "480" }, { "name": "LocationX", "type": "integer", "required": false, "description": "该画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。", "example": "0" }, { "name": "LocationY", "type": "integer", "required": false, "description": "该画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。", "example": "0" }, { "name": "ZOrder", "type": "integer", "required": false, "description": "该画面在输出时的层级，不填默认为0。", "example": "0" }, { "name": "RenderMode", "type": "integer", "required": false, "description": "该画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底。不填默认为0。", "example": "0" }, { "name": "MixInputType", "type": "integer", "required": false, "description": "该当前位置用户混入的流类型：0为混入音视频，1为只混入视频，2为只混入音频。默认为0，建议配合指定用户ID使用。", "example": "0" }, { "name": "PlaceImageId", "type": "integer", "required": false, "description": "占位图ID。启用占位图功能时，在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M，在实时音视频控制台上传并生成，https://cloud.tencent.com/document/product/647/50769", "example": "0" } ] }, { "name": "PlaceHolderMode", "type": "integer", "required": false, "description": "自定义模板中有效，设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。", "example": "0" }, { "name": "PureAudioHoldPlaceMode", "type": "integer", "required": false, "description": "悬浮模板、九宫格、屏幕分享模板生效，用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式，悬浮小画面占布局位置，九宫格画面占布局位置、屏幕分享小画面不占布局位置；设置为1时代表纯音频上行占布局位置；设置为2时代表纯音频上行不占布局位置。默认为0。", "example": "0" }, { "name": "WaterMarkParams", "type": "object", "required": false, "description": "水印参数。", "example": "WaterMarkParams", "children": [ { "name": "WaterMarkId", "type": "integer", "required": true, "description": "混流-水印图片ID。取值为实时音视频控制台上传的图片ID。", "example": "51" }, { "name": "WaterMarkWidth", "type": "integer", "required": true, "description": "混流-水印宽。单位为像素值。水印宽+X偏移不能超过整个画布宽。", "example": "64" }, { "name": "WaterMarkHeight", "type": "integer", "required": true, "description": "混流-水印高。单位为像素值。水印高+Y偏移不能超过整个画布高。", "example": "64" }, { "name": "LocationX", "type": "integer", "required": true, "description": "水印在输出时的X偏移。单位为像素值。水印宽+X偏移不能超过整个画布宽。", "example": "10" }, { "name": "LocationY", "type": "integer", "required": true, "description": "水印在输出时的Y偏移。单位为像素值。水印高+Y偏移不能超过整个画布高。", "example": "10" }, { "name": "WaterMarkUrl", "type": "string", "required": false, "description": "混流-水印图片URL地址，支持png、jpg、jpeg、bmp格式，暂不支持透明通道。URL链接长度限制为512字节。WaterMarkUrl和WaterMarkId参数都填时，以WaterMarkUrl为准。图片大小限制不超过2MB。", "example": "https://**.png" } ] }, { "name": "RenderMode", "type": "integer", "required": false, "description": "屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底，不填采用后台的默认渲染方式（屏幕分享大画面为缩放，其他为裁剪）。若此参数不生效，请提交工单寻求帮助。", "example": "0" } ] }, { "name": "PublishCdnParams", "type": "object", "required": false, "description": "第三方CDN转推参数。如需转推至腾讯云云直播，此参数无需填写，会默认转推", "example": "无", "children": [ { "name": "BizId", "type": "integer", "required": true, "description": "腾讯云直播BizId。", "example": "3891" }, { "name": "PublishCdnUrls", "type": "array", "required": true, "description": "第三方CDN转推的目的地址，同时只支持转推一个第三方CDN地址。", "example": "[\"rtmp://***.com/live/liveteststream\"]", "item_type": "string" } ] } ], "required": [ "SdkAppId", "RoomId", "OutputParams", "EncodeParams", "LayoutParams" ] }, { "name": "StartMCUMixTranscodeByStrRoomId", "description": "接口说明：启动云端混流，并指定混流画面中各路画面的布局位置。 TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过此 API 接口，通知腾讯云服务端将多路视频画面合成一路，并指定每一路画面的位置，同时将多路声音进行混音，最终形成一路音视频流，以便用于录制和直播观看。 您可以通过此接口实现如下目标： - 设置最终直播流的画质和音质，包括视频分辨\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId。", "example": "1400188366" }, { "name": "StrRoomId", "type": "string", "required": true, "description": "字符串房间号。", "example": "3560" }, { "name": "OutputParams", "type": "object", "required": true, "description": "混流输出控制参数。", "example": "无", "children": [ { "name": "StreamId", "type": "string", "required": true, "description": "直播流 ID，由用户自定义设置，该流 ID 不能与用户旁路的流 ID 相同，限制64字节。", "example": "mix_stream" }, { "name": "PureAudioStream", "type": "integer", "required": false, "description": "取值范围[0,1]， 填0：直播流为音视频(默认); 填1：直播流为纯音频", "example": "0" }, { "name": "RecordId", "type": "string", "required": false, "description": "自定义录制文件名称前缀。请先在实时音视频控制台开通录制功能，https://cloud.tencent.com/document/product/647/50768。 【注意】该方式仅对旧版云端录制功能的应用生效，新版云端录制功能的应用请用接口CreateCloudRecording发起录制。新、旧云端录制类型判断方式请见：https://cloud.tencent.com/document/product/647/50768#record", "example": "mix_stream_record" }, { "name": "RecordAudioOnly", "type": "integer", "required": false, "description": "取值范围[0,1]，填0无实际含义; 填1：指定录制文件格式为mp3。此参数不建议使用，建议在实时音视频控制台配置纯音频录制模板。", "example": "0" } ] }, { "name": "EncodeParams", "type": "object", "required": true, "description": "混流输出编码参数。", "example": "无", "children": [ { "name": "AudioSampleRate", "type": "integer", "required": true, "description": "混流-输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000]，单位是Hz。混流任务发起过程中，为了保持CDN链接的稳定，不要修改音频参数（codec、采样率、码率、声道数）。", "example": "48000" }, { "name": "AudioBitrate", "type": "integer", "required": true, "description": "混流-输出流音频码率。取值范围[8,500]，单位为kbps。混流任务发起过程中，为了保持CDN链接的稳定，不要修改音频参数（codec、采样率、码率、声道数）。", "example": "64" }, { "name": "AudioChannels", "type": "integer", "required": true, "description": "混流-输出流音频声道数，取值范围[1,2]，1表示混流输出音频为单声道，2表示混流输出音频为双声道。混流任务发起过程中，为了保持CDN链接的稳定，不要修改音频参数（codec、采样率、码率、声道数）。", "example": "2" }, { "name": "VideoWidth", "type": "integer", "required": false, "description": "混流-输出流宽，音视频输出时必填。取值范围[0,1920]，单位为像素值。", "example": "1280" }, { "name": "VideoHeight", "type": "integer", "required": false, "description": "混流-输出流高，音视频输出时必填。取值范围[0,1080]，单位为像素值。", "example": "720" }, { "name": "VideoBitrate", "type": "integer", "required": false, "description": "混流-输出流码率，音视频输出时必填。取值范围[1,10000]，单位为kbps。", "example": "512" }, { "name": "VideoFramerate", "type": "integer", "required": false, "description": "混流-输出流帧率，音视频输出时必填。取值范围[1,60]，表示混流的输出帧率可选范围为1到60fps。", "example": "15" }, { "name": "VideoGop", "type": "integer", "required": false, "description": "混流-输出流gop，音视频输出时必填。取值范围[1,5]，单位为秒。", "example": "2" }, { "name": "BackgroundColor", "type": "integer", "required": false, "description": "混流-输出流背景色，取值是十进制整数。常用的颜色有： 红色：0xff0000，对应的十进制整数是16724736。 黄色：0xffff00。对应的十进制整数是16776960。 绿色：0x33cc00。对应的十进制整数是3394560。 蓝色：0x0066ff。对应的十进制整数是26367。 黑色：0x000000。对应的十进制整数是0。 白色：0xFFFFFF。对应的十进制整数是16777215。 灰色：0x999999。对应的十进制整数是10066329。", "example": "0" }, { "name": "BackgroundImageId", "type": "integer", "required": false, "description": "混流-输出流背景图片，取值为实时音视频控制台上传的图片ID。", "example": "0" }, { "name": "AudioCodec", "type": "integer", "required": false, "description": "混流-输出流音频编码类型，取值范围[0,1, 2]，0为LC-AAC，1为HE-AAC，2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时，只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。混流任务发起过程中，为了保持CDN链接的稳定，不要修改音频参数（codec、采样率、码率、声道数）。", "example": "0" }, { "name": "BackgroundImageUrl", "type": "string", "required": false, "description": "混流-输出流背景图片URL地址，支持png、jpg、jpeg、bmp格式，暂不支持透明通道。URL链接长度限制为512字节。BackgroundImageUrl和BackgroundImageId参数都填时，以BackgroundImageUrl为准。图片大小限制不超过2MB。", "example": "https://******.png" } ] }, { "name": "LayoutParams", "type": "object", "required": true, "description": "混流输出布局参数。", "example": "无", "children": [ { "name": "Template", "type": "integer", "required": false, "description": "混流布局模板ID，0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。", "example": "0" }, { "name": "MainVideoUserId", "type": "string", "required": false, "description": "屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的用户ID。", "example": "\"main_video_user\"" }, { "name": "MainVideoStreamType", "type": "integer", "required": false, "description": "屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的流类型，0为摄像头，1为屏幕分享。左侧大画面为web用户时此值填0。", "example": "0" }, { "name": "SmallVideoLayoutParams", "type": "object", "required": false, "description": "画中画模板中有效，代表小画面的布局参数。", "example": "SmallVideoLayoutParams", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "代表小画面对应的用户ID。", "example": "\"small_video_user\"" }, { "name": "StreamType", "type": "integer", "required": true, "description": "代表小画面对应的流类型，0为摄像头，1为屏幕分享。小画面为web用户时此值填0。", "example": "0" }, { "name": "ImageWidth", "type": "integer", "required": false, "description": "小画面在输出时的宽度，单位为像素值，不填默认为0。", "example": "640" }, { "name": "ImageHeight", "type": "integer", "required": false, "description": "小画面在输出时的高度，单位为像素值，不填默认为0。", "example": "480" }, { "name": "LocationX", "type": "integer", "required": false, "description": "小画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。", "example": "0" }, { "name": "LocationY", "type": "integer", "required": false, "description": "小画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。", "example": "0" } ] }, { "name": "MainVideoRightAlign", "type": "integer", "required": false, "description": "屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。", "example": "0" }, { "name": "MixVideoUids", "type": "array", "required": false, "description": "指定混视频的用户ID列表。设置此参数后，输出流混合此参数中包含用户的音视频，以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效，最多可设置16个用户。", "example": "[\"1234\",\"5678\"]", "item_type": "string" }, { "name": "PresetLayoutConfig", "type": "array", "required": false, "description": "自定义模板中有效，指定用户视频在混合画面中的位置。", "example": "PresetLayoutConfig", "item_type": "object", "children": [ { "name": "UserId", "type": "string", "required": false, "description": "指定显示在该画面上的用户ID。如果不指定用户ID，会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。", "example": "user1" }, { "name": "StreamType", "type": "integer", "required": false, "description": "当该画面指定用户时，代表用户的流类型。0为摄像头，1为屏幕分享。小画面为web用户时此值填0。", "example": "0" }, { "name": "ImageWidth", "type": "integer", "required": false, "description": "该画面在输出时的宽度，单位为像素值，不填默认为0。", "example": "640" }, { "name": "ImageHeight", "type": "integer", "required": false, "description": "该画面在输出时的高度，单位为像素值，不填默认为0。", "example": "480" }, { "name": "LocationX", "type": "integer", "required": false, "description": "该画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。", "example": "0" }, { "name": "LocationY", "type": "integer", "required": false, "description": "该画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。", "example": "0" }, { "name": "ZOrder", "type": "integer", "required": false, "description": "该画面在输出时的层级，不填默认为0。", "example": "0" }, { "name": "RenderMode", "type": "integer", "required": false, "description": "该画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底。不填默认为0。", "example": "0" }, { "name": "MixInputType", "type": "integer", "required": false, "description": "该当前位置用户混入的流类型：0为混入音视频，1为只混入视频，2为只混入音频。默认为0，建议配合指定用户ID使用。", "example": "0" }, { "name": "PlaceImageId", "type": "integer", "required": false, "description": "占位图ID。启用占位图功能时，在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M，在实时音视频控制台上传并生成，https://cloud.tencent.com/document/product/647/50769", "example": "0" } ] }, { "name": "PlaceHolderMode", "type": "integer", "required": false, "description": "自定义模板中有效，设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。", "example": "0" }, { "name": "PureAudioHoldPlaceMode", "type": "integer", "required": false, "description": "悬浮模板、九宫格、屏幕分享模板生效，用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式，悬浮小画面占布局位置，九宫格画面占布局位置、屏幕分享小画面不占布局位置；设置为1时代表纯音频上行占布局位置；设置为2时代表纯音频上行不占布局位置。默认为0。", "example": "0" }, { "name": "WaterMarkParams", "type": "object", "required": false, "description": "水印参数。", "example": "WaterMarkParams", "children": [ { "name": "WaterMarkId", "type": "integer", "required": true, "description": "混流-水印图片ID。取值为实时音视频控制台上传的图片ID。", "example": "51" }, { "name": "WaterMarkWidth", "type": "integer", "required": true, "description": "混流-水印宽。单位为像素值。水印宽+X偏移不能超过整个画布宽。", "example": "64" }, { "name": "WaterMarkHeight", "type": "integer", "required": true, "description": "混流-水印高。单位为像素值。水印高+Y偏移不能超过整个画布高。", "example": "64" }, { "name": "LocationX", "type": "integer", "required": true, "description": "水印在输出时的X偏移。单位为像素值。水印宽+X偏移不能超过整个画布宽。", "example": "10" }, { "name": "LocationY", "type": "integer", "required": true, "description": "水印在输出时的Y偏移。单位为像素值。水印高+Y偏移不能超过整个画布高。", "example": "10" }, { "name": "WaterMarkUrl", "type": "string", "required": false, "description": "混流-水印图片URL地址，支持png、jpg、jpeg、bmp格式，暂不支持透明通道。URL链接长度限制为512字节。WaterMarkUrl和WaterMarkId参数都填时，以WaterMarkUrl为准。图片大小限制不超过2MB。", "example": "https://**.png" } ] }, { "name": "RenderMode", "type": "integer", "required": false, "description": "屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底，不填采用后台的默认渲染方式（屏幕分享大画面为缩放，其他为裁剪）。若此参数不生效，请提交工单寻求帮助。", "example": "0" } ] }, { "name": "PublishCdnParams", "type": "object", "required": false, "description": "第三方CDN转推参数。如需转推至腾讯云云直播，此参数无需填写，会默认转推", "example": "无", "children": [ { "name": "BizId", "type": "integer", "required": true, "description": "腾讯云直播BizId。", "example": "3891" }, { "name": "PublishCdnUrls", "type": "array", "required": true, "description": "第三方CDN转推的目的地址，同时只支持转推一个第三方CDN地址。", "example": "[\"rtmp://***.com/live/liveteststream\"]", "item_type": "string" } ] } ], "required": [ "SdkAppId", "StrRoomId", "OutputParams", "EncodeParams", "LayoutParams" ] }, { "name": "StartPublishCdnStream", "description": "接口说明： 启动一个混流转推任务，将 TRTC 房间的多路音视频流混成一路音视频流，编码后推到直播 CDN 或者回推到 TRTC 房间。也支持不转码直接转推 TRTC 房间的单路流。启动成功后，会返回一个 SdkAppid 维度唯一的任务 Id（TaskId）。您需要保存该 TaskId，后续需要依赖此 TaskId 更新和结束任务。可以参考文档： [功能说明](https://cloud.tencent.com/document/product/647/84721#b9a855f4-e38c-4616-9b0...", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和转推的房间所对应的SdkAppId相同。", "example": "1400***000" }, { "name": "RoomId", "type": "string", "required": true, "description": "主房间信息RoomId，转推的TRTC房间所对应的RoomId。", "example": "room_1234" }, { "name": "RoomIdType", "type": "integer", "required": true, "description": "主房间信息RoomType，必须和转推的房间所对应的RoomId类型相同，0为整型房间号，1为字符串房间号。", "example": "1" }, { "name": "AgentParams", "type": "object", "required": true, "description": "转推服务加入TRTC房间的机器人参数。", "example": "{\"UserId\":\"trtc_user_agent\",\"UserSig\":\"eJw1zV8****pljzBb*IOTE_\",\"MaxIdleTime\":30}", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "转推服务在TRTC房间使用的[UserId](https://cloud.tencent.com/document/product/647/46351#userid)，注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复，建议可以把房间ID作为userId的标识的一部分。", "example": "room_1234_rtmp_1" }, { "name": "UserSig", "type": "string", "required": false, "description": "转推服务加入TRTC房间的用户签名，当前 UserId 对应的验证签名，相当于登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。", "example": "eJw1zc0Ogj***kCs8k5Eg__" }, { "name": "MaxIdleTime", "type": "integer", "required": false, "description": "所有参与混流转推的主播持续离开TRTC房间或切换成观众超过MaxIdleTime的时长，自动停止转推，单位：秒。默认值为 30 秒，该值需大于等于 5秒，且小于等于 86400秒(24小时)。", "example": "50" } ] }, { "name": "WithTranscoding", "type": "integer", "required": true, "description": "是否转码，0表示无需转码，1表示需要转码。是否收取转码费是由WithTranscoding参数决定的，WithTranscoding为0，表示旁路转推，不会收取转码费用，WithTranscoding为1，表示混流转推，会收取转码费用。 注：混流是必须转码，这个参数需设置为1。", "example": "1" }, { "name": "AudioParams", "type": "object", "required": false, "description": "转推流的音频编码参数。由于音频是必转码的（不会收取转码费用），所以启动任务的时候，必须填写。", "example": "{\"AudioEncode\":{\"SampleRate\":48000,\"Channel\":2,\"BitRate\":64,\"Codec\":0}}", "children": [ { "name": "AudioEncode", "type": "object", "required": false, "description": "音频编码参数。", "example": "无", "children": [ { "name": "SampleRate", "type": "integer", "required": true, "description": "输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000]，单位是Hz。", "example": "48000" }, { "name": "Channel", "type": "integer", "required": true, "description": "输出流音频声道数，取值范围[1,2]，1表示混流输出音频为单声道，2表示混流输出音频为双声道。", "example": "2" }, { "name": "BitRate", "type": "integer", "required": true, "description": "输出流音频码率。取值范围[8,500]，单位为kbps。", "example": "64" }, { "name": "Codec", "type": "integer", "required": false, "description": "输出流音频编码类型，取值范围[0, 1, 2]，0为LC-AAC，1为HE-AAC，2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时，只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。", "example": "0" } ] }, { "name": "SubscribeAudioList", "type": "array", "required": false, "description": "音频用户白名单，start时，为空或不填表示混所有主播音频，填具体值表示混指定主播音频；update时，不填表示不更新，为空表示更新为混所有主播音频，填具体值表示更新为混指定主播音频。 使用黑白名单时，黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时，以黑名单为主。 注：如果是跨房pk时，跨房混流需要指定音频白名单，否则pk主播的音...", "example": "无", "item_type": "object", "children": [ { "name": "UserInfo", "type": "object", "required": true, "description": "用户参数。", "example": "{\"UserId\": \"user_a\",\"RoomId\": \"123456\",\"RoomIdType\": 0}", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "用户ID。", "example": "user_a" }, { "name": "RoomId", "type": "string", "required": false, "description": "动态布局时房间信息必须和主房间信息保持一致，自定义布局时房间信息必须和MixLayoutList中对应用户的房间信息保持一致，不填时默认与主房间信息一致。", "example": "room_123456" }, { "name": "RoomIdType", "type": "integer", "required": false, "description": "房间号类型，0为整型房间号，1为字符串房间号。", "example": "1" } ] }, { "name": "SoundLevel", "type": "integer", "required": false, "description": "混音的音量调整：取值范围是0到100，100为原始上行音量，不填默认为100，值越小则音量越低。 注：该参数只在音量白名单下配置生效，其他场景配置无效。", "example": "100" } ] }, { "name": "UnSubscribeAudioList", "type": "array", "required": false, "description": "音频用户黑名单，为空或不填表示无黑名单，填具体值表示不混指定主播音频。update时，不填表示不更新，为空表示更新为清空黑名单，填具体值表示更新为不混指定主播音频。 使用黑白名单时，黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时，以黑名单为主。", "example": "无", "item_type": "object", "children": [ { "name": "UserInfo", "type": "object", "required": true, "description": "用户参数。", "example": "{\"UserId\": \"user_a\",\"RoomId\": \"123456\",\"RoomIdType\": 0}", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "用户ID。", "example": "user_a" }, { "name": "RoomId", "type": "string", "required": false, "description": "动态布局时房间信息必须和主房间信息保持一致，自定义布局时房间信息必须和MixLayoutList中对应用户的房间信息保持一致，不填时默认与主房间信息一致。", "example": "room_123456" }, { "name": "RoomIdType", "type": "integer", "required": false, "description": "房间号类型，0为整型房间号，1为字符串房间号。", "example": "1" } ] }, { "name": "SoundLevel", "type": "integer", "required": false, "description": "混音的音量调整：取值范围是0到100，100为原始上行音量，不填默认为100，值越小则音量越低。 注：该参数只在音量白名单下配置生效，其他场景配置无效。", "example": "100" } ] } ] }, { "name": "VideoParams", "type": "object", "required": false, "description": "转推流的视频编码参数，不填表示纯音频转推。", "example": "{\"VideoEncode\":{\"Width\":64,\"Height\":64,\"Fps\":15,\"BitRate\":128,\"Gop\":2},\"LayoutParams\":{\"MixLayoutMode\":3}}", "children": [ { "name": "VideoEncode", "type": "object", "required": false, "description": "输出流视频编码参数。", "example": "无", "children": [ { "name": "Width", "type": "integer", "required": true, "description": "输出流宽，音视频输出时必填。取值范围[0,1920]，单位为像素值。", "example": "1280" }, { "name": "Height", "type": "integer", "required": true, "description": "输出流高，音视频输出时必填。取值范围[0,1920]，单位为像素值。", "example": "720" }, { "name": "Fps", "type": "integer", "required": true, "description": "输出流帧率，音视频输出时必填。取值范围[1,60]，表示混流的输出帧率可选范围为1到60fps。", "example": "15" }, { "name": "BitRate", "type": "integer", "required": true, "description": "输出流码率，音视频输出时必填。取值范围[1,10000]，单位为kbps。", "example": "1500" }, { "name": "Gop", "type": "integer", "required": true, "description": "输出流gop，音视频输出时必填。取值范围[1,5]，单位为秒。", "example": "2" } ] }, { "name": "LayoutParams", "type": "object", "required": false, "description": "混流布局参数。", "example": "无", "children": [ { "name": "MixLayoutMode", "type": "integer", "required": false, "description": "布局模式：动态布局（1：悬浮布局（默认），2：屏幕分享布局，3：九宫格布局），静态布局（4：自定义布局）。最多支持混入16路音视频流，如果用户只上行音频，也会被算作一路；自定义布局中，如果子画面只设置占位图，也被算作一路。", "example": "4" }, { "name": "PureAudioHoldPlaceMode", "type": "integer", "required": false, "description": "纯音频上行是否占布局位置，只在动态布局中有效。0表示纯音频不占布局位置，1表示纯音频占布局位置，不填默认为0。", "example": "0" }, { "name": "MixLayoutList", "type": "array", "required": false, "description": "自定义模板中有效，指定用户视频在混合画面中的位置，最多支持设置16个输入流。", "example": "[{\"UserMediaStream\":{\"UserInfo\":{\"UserId\":\"user_a\"}},\"ImageWidth\":1920,\"ImageHeight\":1080,\"LocationX\":0,\"LocationY\":0}]", "item_type": "object", "children": [ { "name": "UserMediaStream", "type": "object", "required": false, "description": "用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。", "example": "无" }, { "name": "ImageWidth", "type": "integer", "required": false, "description": "子画面在输出时的宽度，单位为像素值，不填默认为0。", "example": "1280" }, { "name": "ImageHeight", "type": "integer", "required": false, "description": "子画面在输出时的高度，单位为像素值，不填默认为0。", "example": "720" }, { "name": "LocationX", "type": "integer", "required": false, "description": "子画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。", "example": "0" }, { "name": "LocationY", "type": "integer", "required": false, "description": "子画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。", "example": "0" }, { "name": "ZOrder", "type": "integer", "required": false, "description": "子画面在输出时的层级，不填默认为0。", "example": "0" }, { "name": "RenderMode", "type": "integer", "required": false, "description": "子画面在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底。不填默认为0。", "example": "0" }, { "name": "BackGroundColor", "type": "string", "required": false, "description": "【此参数配置无效，暂不支持】子画面的背景颜色，常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。", "example": "0xFFFFFF" }, { "name": "BackgroundImageUrl", "type": "string", "required": false, "description": "子画面的占位图片url，填写该参数，当用户关闭摄像头或未进入TRTC房间时，会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致，则会对图片进行拉伸处理，优先级高于BackGroundColor。支持png、jpg、jpeg、bmp、gif、webm格式。图片分辨率限制不超过2K，图片大小限制不超过5MB。 注： 1，您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，...", "example": "https://***.png" }, { "name": "CustomCrop", "type": "object", "required": false, "description": "客户自定义裁剪，针对原始输入流裁剪", "example": "无" }, { "name": "BackgroundRenderMode", "type": "integer", "required": false, "description": "子背景图在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底，3为变比例伸缩，4为自定义渲染。不填默认为3。", "example": "3" }, { "name": "TransparentUrl", "type": "string", "required": false, "description": "子画面的透明模版url，指向一张包含透明通道的模板图片。填写该参数，后台混流时会提取该模板图片的透明通道，将其缩放作为目标画面的透明通道，再和其他画面进行混合。您可以通过透明模版实现目标画面的半透明效果和任意形状裁剪（如圆角、星形、心形等）。 支持png格式。图片分辨率限制不超过2K，图片大小限制不超过5MB。 注： 1，模板图片宽高比应接近目标画面\ufffd\ufffd...", "example": "https://***.png" }, { "name": "BackgroundCustomRender", "type": "object", "required": false, "description": "子背景图的自定义渲染参数，当BackgroundRenderMode为4时必须配置。", "example": "无" }, { "name": "BackGroundColorMode", "type": "integer", "required": false, "description": "子背景色生效模式，默认值为0表示均不生效。 bit0:占位图缩放是否生效。 bit1:上行流缩放是否生效。 您可以将相应bit位置1启动生效，例如： 0(00)表示子背景色不生效。 1(01)表示子背景色只在占位图缩放时生效。 2(10)表示子背景色只在上行流缩放时生效。 3(11)表示子背景色在占位图缩放和上行流缩放时均生效。", "example": "0" } ] }, { "name": "MaxVideoUser", "type": "object", "required": false, "description": "指定动态布局中悬浮布局和屏幕分享布局的大画面信息，只在悬浮布局和屏幕分享布局有效。", "example": "{\"UserMediaStream\":{\"UserInfo\":{\"UserId\":\"user_a\"}}}", "children": [ { "name": "UserMediaStream", "type": "object", "required": true, "description": "用户媒体流参数。", "example": "{\"UserInfo\":{\"UserId\":\"user_a\",\"RoomId\":\"123456\",\"RoomIdType\":0},\"StreamType\":0}" } ] }, { "name": "RenderMode", "type": "integer", "required": false, "description": "屏幕分享模板、悬浮模板、九宫格模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底", "example": "0" } ] }, { "name": "BackGroundColor", "type": "string", "required": false, "description": "整个画布背景颜色，常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。", "example": "0xFFFFFF" }, { "name": "BackgroundImageUrl", "type": "string", "required": false, "description": "整个画布的背景图片url，优先级高于BackGroundColor。支持png、jpg、jpeg格式。图片分辨率限制不超过2K，图片大小限制不超过5MB。 注： 1，您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，背景图片将不会生效。 2，url可支持字符集：【'0-9','a-z','A-Z','-', '.', '_', '~', ':', '/', '?', '#', '[', ']','@', '!', '\u0026', '(', ')', '*', '+', ',', '%', '=', ';', '|'\ufffd...", "example": "https://******.png" }, { "name": "WaterMarkList", "type": "array", "required": false, "description": "混流布局的水印参数。", "example": "无", "item_type": "object", "children": [ { "name": "WaterMarkType", "type": "integer", "required": false, "description": "水印类型，0为图片（默认），1为文字。", "example": "0" }, { "name": "WaterMarkImage", "type": "object", "required": false, "description": "图片水印参数。WaterMarkType为0指定。图片分辨率限制不超过2K，图片大小限制不超过5MB。", "example": "{\"WaterMarkUrl\": \"http://your_picture.png\",\"WaterMarkWidth\": 150,\"WaterMarkHeight\": 90,\"LocationX\": 0,\"LocationY\": 0,\"ZOrder\": 20}", "children": [ { "name": "WaterMarkUrl", "type": "string", "required": true, "description": "水印图片URL地址，支持png、jpg、jpeg格式。图片分辨率限制不超过2K，图片大小限制不超过5MB。 注： 1，您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，水印图片将不会生效。 2，url可支持字符集：【'0-9','a-z','A-Z','-', '.', '_', '~', ':', '/', '?', '#', '[', ']','@', '!', '\u0026', '(', ')', '*', '+', ',', '%', '=', ';', '|'】，您需要确保url字符在可支持\ufffd...", "example": "xxx.png" }, { "name": "WaterMarkWidth", "type": "integer", "required": true, "description": "水印在输出时的宽。单位为像素值。", "example": "64" }, { "name": "WaterMarkHeight", "type": "integer", "required": true, "description": "水印在输出时的高。单位为像素值。", "example": "64" }, { "name": "LocationX", "type": "integer", "required": true, "description": "水印在输出时的X偏移。单位为像素值。", "example": "0" }, { "name": "LocationY", "type": "integer", "required": true, "description": "水印在输出时的Y偏移。单位为像素值。", "example": "0" }, { "name": "ZOrder", "type": "integer", "required": false, "description": "水印在输出时的层级，不填默认为0。", "example": "0" }, { "name": "DynamicPosType", "type": "integer", "required": false, "description": "动态水印类型，默认为0。0:关闭；1:随机位置，每秒变动一次；2:边界扫描反弹，每帧变动一次。", "example": "0" } ] }, { "name": "WaterMarkText", "type": "object", "required": false, "description": "文字水印参数。WaterMarkType为1指定。", "example": "{\"Text\": \"主持人\",\"WaterMarkWidth\": 54,\"WaterMarkHeight\": 18,\"LocationX\": 80,\"LocationY\": 80,\"FontSize\": 18,\"DynamicPosType\": 0}", "children": [ { "name": "Text", "type": "string", "required": true, "description": "文字水印内容。", "example": "\"主持人\"" }, { "name": "WaterMarkWidth", "type": "integer", "required": true, "description": "水印在输出时的宽。单位为像素值。", "example": "64" }, { "name": "WaterMarkHeight", "type": "integer", "required": true, "description": "水印在输出时的高。单位为像素值。", "example": "64" }, { "name": "LocationX", "type": "integer", "required": true, "description": "水印在输出时的X偏移。单位为像素值。", "example": "0" }, { "name": "LocationY", "type": "integer", "required": true, "description": "水印在输出时的Y偏移。单位为像素值。", "example": "0" }, { "name": "FontSize", "type": "integer", "required": true, "description": "字体大小", "example": "12" }, { "name": "FontColor", "type": "string", "required": false, "description": "字体颜色，默认为白色。常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。", "example": "0xFFFFFF" }, { "name": "BackGroundColor", "type": "string", "required": false, "description": "字体背景色，不配置默认为透明。常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。", "example": "0x000000" }, { "name": "DynamicPosType", "type": "integer", "required": false, "description": "动态水印类型，默认为0。0:关闭；1:随机位置，每秒变动一次；2:边界扫描反弹，每帧变动一次。", "example": "0" }, { "name": "ZOrder", "type": "integer", "required": false, "description": "水印在输出时的层级，不填默认为0。", "example": "0" }, { "name": "Font", "type": "string", "required": false, "description": "水印字体，不填默认为Tencent。支持设置以下值： Tencent （默认） SourceHanSans", "example": "Tencent" } ] } ] }, { "name": "BackgroundRenderMode", "type": "integer", "required": false, "description": "背景图在输出时的显示模式：0为裁剪，1为缩放并显示黑底，2为变比例伸缩。后台默认为变比例伸缩。", "example": "2" } ] }, { "name": "SingleSubscribeParams", "type": "object", "required": false, "description": "需要单流旁路转推的用户上行参数，单流旁路转推时，WithTranscoding需要设置为0。", "example": "{\"UserMediaStream\":{\"UserInfo\":{\"RoomId\":\"123456\",\"RoomIdType\":0,\"UserId\":\"trtc_user_id\"},\"StreamType\":0}}", "children": [ { "name": "UserMediaStream", "type": "object", "required": true, "description": "用户媒体流参数。", "example": "{\"UserInfo\":{\"UserId\":\"user_a\",\"RoomId\":\"123456\",\"RoomIdType\":0},\"StreamType\":0}", "children": [ { "name": "UserInfo", "type": "object", "required": false, "description": "TRTC用户参数。", "example": "{\"UserId\":\"user_a\",\"RoomId\":\"123456\",\"RoomIdType\":0}", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "用户ID。", "example": "user_a" }, { "name": "RoomId", "type": "string", "required": false, "description": "动态布局时房间信息必须和主房间信息保持一致，自定义布局时房间信息必须和MixLayoutList中对应用户的房间信息保持一致，不填时默认与主房间信息一致。", "example": "room_123456" }, { "name": "RoomIdType", "type": "integer", "required": false, "description": "房间号类型，0为整型房间号，1为字符串房间号。", "example": "1" } ] }, { "name": "StreamType", "type": "integer", "required": false, "description": "主辅路流类型，0为摄像头，1为屏幕分享，不填默认为0。", "example": "0" } ] } ] }, { "name": "PublishCdnParams", "type": "array", "required": false, "description": "转推的CDN参数，一个任务最多支持10个推流URL。和回推房间参数必须要有一个。", "example": "[{\"IsTencentCdn\":1,\"PublishCdnUrl\":\"rtmp://***\u0026txTime=68639060\"}]", "item_type": "object", "children": [ { "name": "PublishCdnUrl", "type": "string", "required": true, "description": "CDN转推URL，只支持rtmp链接。 注：若更新转推时，URL有任何变化，都会断流重推。", "example": "rtmp://***\u0026txTime=686F7239" }, { "name": "IsTencentCdn", "type": "integer", "required": false, "description": "是否是腾讯云CDN，0为转推非腾讯云CDN，1为转推腾讯CDN，不携带该参数默认为1。注意：1，为避免误产生转推费用，该参数建议明确填写，转推非腾讯云CDN时会产生转推费用，详情参见接口文档说明；2，国内站默认只支持转推腾讯云CDN，如您有转推第三方CDN需求，请联系腾讯云技术支持。", "example": "1" } ] }, { "name": "SeiParams", "type": "object", "required": false, "description": "混流SEI参数", "example": "{\"LayoutVolume\":{\"AppData\":\"***\",\"PayloadType\":120, \"Interval\":3000,\"FollowIdr\":1}}", "children": [ { "name": "LayoutVolume", "type": "object", "required": false, "description": "音量布局SEI", "example": "{\"PayloadType\":243,\"FollowIdr\":1}", "children": [ { "name": "AppData", "type": "string", "required": false, "description": "AppData的内容，会被写入自定义SEI中的app_data字段，长度需小于4096。", "example": "user_custom_data" }, { "name": "PayloadType", "type": "integer", "required": false, "description": "SEI消息的payload_type，默认值100，取值范围100-254（244除外，244为我们内部自定义的时间戳SEI）", "example": "100" }, { "name": "Interval", "type": "integer", "required": false, "description": "SEI发送间隔，单位毫秒，默认值为1000。", "example": "1000" }, { "name": "FollowIdr", "type": "integer", "required": false, "description": "取值范围[0,1]，填1：发送关键帧时会确保带SEI；填0：发送关键帧时不确保带SEI。默认值为0。", "example": "0" } ] }, { "name": "PassThrough", "type": "object", "required": false, "description": "透传SEI", "example": "{\"PayloadContent\":\"user_custom_data\",\"PayloadType\":108,\"Interval\":2000,\"FollowIdr\":1}", "children": [ { "name": "PayloadContent", "type": "string", "required": true, "description": "透传SEI的payload内容。", "example": "user_custom_data" }, { "name": "PayloadType", "type": "integer", "required": true, "description": "SEI消息的PayloadType，取值范围5、100-254（244除外，244为我们内部自定义的时间戳SEI）。 注：部分播放器可能不支持PayloadType为5带PayloadUuid的标准类型，建议优先使用其他PayloadType。", "example": "101" }, { "name": "PayloadUuid", "type": "string", "required": false, "description": "PayloadType为5，PayloadUuid必须填写。PayloadType不是5时，不需要填写，填写会被后台忽略。该值必须是32长度的十六进制。", "example": "aaaaaaaabbbbbbbbccccccccdddddddd" }, { "name": "Interval", "type": "integer", "required": false, "description": "SEI发送间隔，单位毫秒，默认值为1000。", "example": "1000" }, { "name": "FollowIdr", "type": "integer", "required": false, "description": "取值范围[0,1]，填1：发送关键帧时会确保带SEI；填0：发送关键帧时不确保带SEI。默认值为0。", "example": "0" } ] } ] }, { "name": "FeedBackRoomParams", "type": "array", "required": false, "description": "回推房间信息，一个任务最多支持回推10个房间，和转推CDN参数必须要有一个。注：回推房间需使用10.4及以上SDK版本，如您有需求，请联系腾讯云技术支持。", "example": "[{\"RoomId\":\"123456\",\"RoomIdType\":0,\"UserId\":\"trtc_user_fb\",\"UserSig\":\"eJw1jdEKgj***AEOjOFw_\"}]", "item_type": "object", "children": [ { "name": "RoomId", "type": "string", "required": true, "description": "回推房间的RoomId。", "example": "room_1234" }, { "name": "RoomIdType", "type": "integer", "required": true, "description": "房间类型，必须和回推房间所对应的RoomId类型相同，0为整形房间号，1为字符串房间号。", "example": "1" }, { "name": "UserId", "type": "string", "required": true, "description": "回推房间使用的UserId(https://cloud.tencent.com/document/product/647/46351#userid)，注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复，建议可以把房间ID作为userId的标识的一部分。", "example": "room_1234_push_1" }, { "name": "UserSig", "type": "string", "required": true, "description": "回推房间UserId对应的用户签名，相当于登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。", "example": "eJw1zc0Ogj***kCs8k5Eg__" } ] }, { "name": "RecordParams", "type": "object", "required": false, "description": "转推录制参数，[参考文档](https://cloud.tencent.com/document/product/647/111748)。", "example": "{\"UniRecord\":1,\"RecordKey\": \"test_recore_key_a\"}", "children": [ { "name": "UniRecord", "type": "integer", "required": false, "description": "转推录制模式， 0/不填: 暂不支持，行为未定义； 1: 不开启录制； 2: 开启录制（使用控制台自动录制模板参数，参考：[跳转文档](https://cloud.tencent.com/document/product/647/111748#.E5.BD.95.E5.88.B6.E6.8E.A7.E5.88.B6.E6.96.B9.E6.A1.88)）； 3: 开启录制（使用API指定参数）。", "example": "2" }, { "name": "RecordKey", "type": "string", "required": false, "description": "录制任务 key，标识一个录制任务；您可以通过该参数，将多个转推任务录制成一个文件。不指定该参数时，只录制当前转推任务。 【限制长度为128字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】", "example": "test_recore_key_a" }, { "name": "RecordWaitTime", "type": "integer", "required": false, "description": "【仅当UniRecord=3时此参数有效】 续录等待时间，对应录制模板“续录等待时长”，单位：秒。该值需大于等于 5，且小于等于 86400(24小时)，默认值为 30。启用续录时，录制任务空闲超过RecordWaitTime的时长，自动结束。", "example": "30" }, { "name": "RecordFormat", "type": "array", "required": false, "description": "【仅当UniRecord=3时此参数有效】 录制输出文件格式列表，对应录制模板“文件格式”，支持“hls”、\"mp4\"、\"aac\"三种格式，默认值为\"mp4\"。其中\"mp4\"和\"aac\"格式，不能同时指定。 只录制 mp4格式，示例值：[\"mp4\"]。同时录制mp4 和 HLS 格式，示例值：[\"mp4\",\"hls\"]。", "example": "[\"mp4\",\"hls\"]", "item_type": "string" }, { "name": "MaxMediaFileDuration", "type": "integer", "required": false, "description": "【仅当UniRecord=3时此参数有效】 单个文件录制时长，对应录制模板“单个录制文件时长”，单位：分钟。该值需大于等于 1，且小于等于 1440(24小时)，默认值为 1440。只对\"mp4\"或\"aac\"格式生效。实际单文件录制时长还受单文件大小不超过 2G 限制，超过2G则强制拆分。", "example": "1440" }, { "name": "StreamType", "type": "integer", "required": false, "description": "【仅当UniRecord=3时此参数有效】 录制的音视频类型，对应录制模板“录制格式”，0:音视频，1：纯音频，2：纯视频。最终录制文件内容是录制指定类型和转推内容的交集。", "example": "0" }, { "name": "UserDefineRecordPrefix", "type": "string", "required": false, "description": "录制文件名前缀，不超过64字符。只有存储为vod时生效。 【限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】", "example": "mcu_record_prefix" }, { "name": "McuStorageParams", "type": "object", "required": false, "description": "【仅当UniRecord=3时此参数有效】 录制文件存储参数，对应控制台“存储位置”及相关参数。目前支持云点播VOD和对象存储COS两种存储方式，只能填写一种。", "example": "{\"McuCloudVod\":{\"McuTencentVod\":{\"ExpireTime\":86400}}}", "children": [ { "name": "CloudStorage", "type": "object", "required": false, "description": "第三方云存储的账号信息（特别说明：若您选择存储至对象存储COS将会收取录制文件投递至COS的费用，详见云端录制收费说明，存储至VOD将不收取此项费用。）。", "example": "{\"Vendor\":0,\"Region\":\"ap-shanghai\",\"Bucket\":\"***\",\"AccessKey\":\"***\",\"SecretKey\":\"***\",\"FileNamePrefix\":[\"mcu_record\"]}", "children": [ { "name": "Vendor", "type": "integer", "required": true, "description": "腾讯云对象存储COS以及第三方云存储账号信息 0：腾讯云对象存储 COS 1：AWS 【注意】目前第三方云存储仅支持AWS，更多第三方云存储陆续支持中", "example": "0" }, { "name": "Region", "type": "string", "required": true, "description": "腾讯云对象存储的[地域信息]（https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F）。 示例值：cn-shanghai-1 AWS S3[地域信息]（https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions）", "example": "ap-shanghai(cos, 具体参考云存储厂商支持的地域)" }, { "name": "Bucket", "type": "string", "required": true, "description": "云存储桶名称。", "example": "test-bucket" }, { "name": "AccessKey", "type": "string", "required": true, "description": "云存储的access_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretId值。", "example": "test-accesskey" }, { "name": "SecretKey", "type": "string", "required": true, "description": "云存储的secret_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretKey值。", "example": "test-secretkey" }, { "name": "FileNamePrefix", "type": "array", "required": false, "description": "云存储bucket 的指定位置，由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-'，举个例子，录制文件xxx.m3u8在 [\"prefix1\", \"prefix2\"]作用下，会变成prefix1/prefix2/TaskId/xxx.m3u8。", "example": "[\"prefix1\", \"prefix2\"]", "item_type": "string" } ] }, { "name": "McuCloudVod", "type": "object", "required": false, "description": "腾讯云云点播的账号信息。", "example": "{\"McuTencentVod\":{\"ExpireTime\":86400}}", "children": [ { "name": "McuTencentVod", "type": "object", "required": false, "description": "腾讯云点播相关参数。", "example": "{\"ExpireTime\":86400}" } ] } ] } ] } ], "required": [ "SdkAppId", "RoomId", "RoomIdType", "AgentParams", "WithTranscoding" ] }, { "name": "StartStreamIngest", "description": "将一个在线媒体流推到TRTC房间，更多功能说明见[输入媒体流进房](https://cloud.tencent.com/document/product/647/102957#50940aad-d90f-4473-9f46-d5dd46917653)。 使用输入在线媒体流功能需先订阅 [尊享版或旗舰版套餐包](https://cloud.tencent.com/document/product/647/85386) 解锁能力位。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和TRTC的房间所对应的SdkAppId相同。", "example": "1600011111" }, { "name": "RoomId", "type": "string", "required": true, "description": "TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。", "example": "82875" }, { "name": "RoomIdType", "type": "integer", "required": true, "description": "TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId（默认）", "example": "1" }, { "name": "UserId", "type": "string", "required": true, "description": "输入在线媒体流机器人的UserId，用于进房发起拉流转推任务。", "example": "recorder_1357" }, { "name": "UserSig", "type": "string", "required": true, "description": "输入在线媒体流机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。", "example": "recorder_1357_sig" }, { "name": "StreamUrl", "type": "string", "required": false, "description": "源流URL【必填】。如果是视频流，分辨率请保持不变。", "example": "https://a.b/test.mp4" }, { "name": "PrivateMapKey", "type": "string", "required": false, "description": "TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。", "example": "eJwsj1FPwjAUhf**************************w8ABP--78ZKOg__" }, { "name": "SeekSecond", "type": "integer", "required": false, "description": "指定视频从某个秒时间戳播放", "example": "10" }, { "name": "AutoPush", "type": "boolean", "required": false, "description": "开启自动旁路推流，请确认控制台已经开启该功能。", "example": "true" }, { "name": "RepeatNum", "type": "integer", "required": false, "description": "循环播放次数, 取值范围[-1, 1000], 默认1次。 - 0 无效值 - -1 循环播放, 需要主动调用停止接口或设置MaxDuration", "example": "5" }, { "name": "MaxDuration", "type": "integer", "required": false, "description": "循环播放最大时长,仅支持RepeatNum设置-1时生效，取值范围[1, 10080]，单位分钟。", "example": "60" }, { "name": "Volume", "type": "integer", "required": false, "description": "音量，取值范围[0, 100]，默认100，表示原音量。", "example": "90" }, { "name": "EnableProgress", "type": "boolean", "required": false, "description": "开启播放进度回调, 默认false，当开启后，播放进度会通过trtc custom data 回调给播放端", "example": "true" }, { "name": "Tempo", "type": "float", "required": false, "description": "播放倍速，默认1.0，可取[0.5, 0.75, 1.0, 1.25, 1.5, 1.75, 2.0]", "example": "1.5" } ], "required": [ "SdkAppId", "RoomId", "RoomIdType", "UserId", "UserSig" ] }, { "name": "StartWebRecord", "description": "通过此接口可以发起 WEB 页面录制任务，在接口参数中指定录制 URL，录制分辨率，录制结果存储等参数。 因为参数或API逻辑问题会立即返回结果。而因为页面问题，如页面无法访问，会在回调中返回结果，请关注。", "status": "online", "parameters": [ { "name": "RecordUrl", "type": "string", "required": true, "description": "【必填】需要录制的网页URL", "example": "https://web-record-xxxx.cos.ap-xxx.xxx.com/test/xxx.mp4" }, { "name": "StorageParams", "type": "object", "required": true, "description": "【必填】云存储相关的参数，目前支持腾讯云对象存储以及腾讯云云点播VOD，不支持第三方云存储；输出文件的存储格式仅支持hls或mp4", "example": "无", "children": [ { "name": "CloudStorage", "type": "object", "required": false, "description": "腾讯云对象存储COS以及第三方云存储的账号信息", "example": "无", "children": [ { "name": "Vendor", "type": "integer", "required": true, "description": "腾讯云对象存储COS以及第三方云存储账号信息 0：腾讯云对象存储 COS 1：AWS 【注意】目前第三方云存储仅支持AWS，更多第三方云存储陆续支持中", "example": "0" }, { "name": "Region", "type": "string", "required": true, "description": "腾讯云对象存储的[地域信息]（https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F）。 示例值：cn-shanghai-1 AWS S3[地域信息]（https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions）", "example": "ap-shanghai(cos, 具体参考云存储厂商支持的地域)" }, { "name": "Bucket", "type": "string", "required": true, "description": "云存储桶名称。", "example": "test-bucket" }, { "name": "AccessKey", "type": "string", "required": true, "description": "云存储的access_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretId值。", "example": "test-accesskey" }, { "name": "SecretKey", "type": "string", "required": true, "description": "云存储的secret_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretKey值。", "example": "test-secretkey" }, { "name": "FileNamePrefix", "type": "array", "required": false, "description": "云存储bucket 的指定位置，由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-'，举个例子，录制文件xxx.m3u8在 [\"prefix1\", \"prefix2\"]作用下，会变成prefix1/prefix2/TaskId/xxx.m3u8。", "example": "[\"prefix1\", \"prefix2\"]", "item_type": "string" } ] }, { "name": "CloudVod", "type": "object", "required": false, "description": "腾讯云云点播Vod的存储信息", "example": "无", "children": [ { "name": "TencentVod", "type": "object", "required": false, "description": "腾讯云点播相关参数。", "example": "无", "children": [ { "name": "Procedure", "type": "string", "required": false, "description": "媒体后续任务处理操作，即完成媒体上传后，可自动发起任务流操作。参数值为任务流模板名，云点播支持 创建任务流模板 并为模板命名。", "example": "LongVideoPreset" }, { "name": "ExpireTime", "type": "integer", "required": false, "description": "媒体文件过期时间，为当前时间的绝对过期时间；保存一天，就填\"86400\"，永久保存就填\"0\"，默认永久保存。", "example": "86400" }, { "name": "StorageRegion", "type": "string", "required": false, "description": "指定上传园区，仅适用于对上传地域有特殊需求的用户。", "example": "ap-shanghai" }, { "name": "ClassId", "type": "integer", "required": false, "description": "分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。 默认值：0，表示其他分类。", "example": "0" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播子应用 ID。如果要访问子应用中的资源，则将该字段填写为子应用 ID；否则无需填写该字段。注意：不建议填写“托管类型”的点播子应用ID，只能填写“标准类型”的点播子应用ID，否则会导致无法通过点播域名正常播放视频。", "example": "1" }, { "name": "SessionContext", "type": "string", "required": false, "description": "任务流上下文，任务完成回调时透传。", "example": "\"session_context_example\"" }, { "name": "SourceContext", "type": "string", "required": false, "description": "上传上下文，上传完成回调时透传。", "example": "\"source_context_example\"" }, { "name": "MediaType", "type": "integer", "required": false, "description": "上传到vod平台的录制文件格式类型，0：mp4(默认), 1: hls, 2:aac(StreamType=1纯音频录制时有效), 3: hls+mp4, 4: hls+aac(StreamType=1纯音频录制时有效)。", "example": "1" }, { "name": "UserDefineRecordId", "type": "string", "required": false, "description": "仅支持API录制上传vod，该参数表示用户可以自定义录制文件名前缀，【限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符】。前缀与自动生成的录制文件名之间用`__UserDefine_u_` 分开。", "example": "\"user_prefix\"" } ] } ] } ] }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "【必填】TRTC的SdkAppId", "example": "1600011111" }, { "name": "MaxDurationLimit", "type": "integer", "required": false, "description": "录制最大时长限制， 单位 s, 合法取值范围[1800, 86400], 默认 86400s(24 小时)", "example": "86400" }, { "name": "WebRecordVideoParams", "type": "object", "required": false, "description": "页面录制视频参数", "example": "无", "children": [ { "name": "Width", "type": "integer", "required": false, "description": "录制画面宽度，默认为1280，取值范围[0, 1920]", "example": "1280" }, { "name": "Height", "type": "integer", "required": false, "description": "录制画面高度，默认为720，取值范围[0, 1080]", "example": "720" }, { "name": "Format", "type": "string", "required": false, "description": "指定输出格式，可选hls,mp4。存储到云点播VOD时此参数无效，存储到VOD时请通过TencentVod（https://cloud.tencent.com/document/api/647/44055#TencentVod）内的MediaType设置。", "example": "mp4" }, { "name": "MaxMediaFileDuration", "type": "integer", "required": false, "description": "如果是aac或者mp4文件格式，超过长度限制后，系统会自动拆分视频文件。单位：分钟。默认为1440min（24h），取值范围为1-1440。【单文件限制最大为2G，满足文件大小 \u003e2G 或录制时长度 \u003e 24h任意一个条件，文件都会自动切分】 Hls 格式录制此参数不生效。 示例值：1440", "example": "1440" } ] }, { "name": "RecordId", "type": "string", "required": false, "description": "当对重复任务敏感时，请关注此值： 为了避免任务在短时间内重复发起，导致任务重复 传入录制RecordId来标识此次任务， 小于32字节，若携带RecordId发起两次以上的开始录制请求，任务只会启动一个，第二个报错FailedOperation.TaskExist。注意StartWebRecord调用失败时而非FailedOperation.TaskExist错误，请更换RecordId重新发起。", "example": "record_task_abc_1" }, { "name": "PublishCdnParams", "type": "array", "required": false, "description": "若您想要推流到CDN，可以使用PublishCdnParams.N参数设置，支持最多同时推流到10个CDN地址。若转推地址是腾讯云CDN时，请将IsTencentCdn明确设置为1", "example": "无", "item_type": "object", "children": [ { "name": "PublishCdnUrl", "type": "string", "required": true, "description": "CDN转推URL，只支持rtmp链接。 注：若更新转推时，URL有任何变化，都会断流重推。", "example": "rtmp://***\u0026txTime=686F7239" }, { "name": "IsTencentCdn", "type": "integer", "required": false, "description": "是否是腾讯云CDN，0为转推非腾讯云CDN，1为转推腾讯CDN，不携带该参数默认为1。注意：1，为避免误产生转推费用，该参数建议明确填写，转推非腾讯云CDN时会产生转推费用，详情参见接口文档说明；2，国内站默认只支持转推腾讯云CDN，如您有转推第三方CDN需求，请联系腾讯云技术支持。", "example": "1" } ] }, { "name": "ReadyTimeout", "type": "integer", "required": false, "description": "录制页面资源加载的超时时间，单位：秒。默认值为 0 秒，该值需大于等于 0秒，且小于等于 60秒。录制页面未启用页面加载超时检测时，请勿设置此参数。", "example": "30" }, { "name": "EmulateMobileParams", "type": "object", "required": false, "description": "渲染移动模式参数；不准备渲染移动模式页面时，请勿设置此参数。", "example": "无", "children": [ { "name": "MobileDeviceType", "type": "integer", "required": false, "description": "移动设备类型， 0: 手机 1: 平板", "example": "0" }, { "name": "ScreenOrientation", "type": "integer", "required": false, "description": "屏幕方向， 0: 竖屏， 1: 横屏", "example": "0" } ] } ], "required": [ "RecordUrl", "StorageParams", "SdkAppId" ] }, { "name": "StopAIConversation", "description": "停止AI对话任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "唯一标识任务。", "example": "-m97l2ZU7kOlV5cTRMoU6yoGp2nDYkzbJ13EC4K-4pycoZXVv+XVrNoUXQ8++8Z2PwUlAQ.." } ], "required": [ "TaskId" ] }, { "name": "StopAITranscription", "description": "停止AI转录任务。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "唯一标识转录任务。", "example": "-m97l2ZU7kOlV5cTRMoU6yoGp2nDYkzbJ13EC4K-4pycoZXVv+XVrNoUXQ8++8Z2PwUlAQ.." } ], "required": [ "TaskId" ] }, { "name": "StopMCUMixTranscode", "description": "接口说明：结束云端混流", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId。", "example": "1400188366" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间号。", "example": "3560" } ], "required": [ "SdkAppId", "RoomId" ] }, { "name": "StopMCUMixTranscodeByStrRoomId", "description": "接口说明：结束云端混流", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId。", "example": "1400***366" }, { "name": "StrRoomId", "type": "string", "required": true, "description": "字符串房间号。", "example": "room_1001" } ], "required": [ "SdkAppId", "StrRoomId" ] }, { "name": "StopPublishCdnStream", "description": "接口说明： 停止指定的混流转推任务。如果没有调用 Stop 接口停止任务，所有参与混流转推的主播离开 TRTC 房间超过 AgentParams.MaxIdleTime 设置的时间后，任务也会自动停止。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和转推的房间所对应的SdkAppId相同。", "example": "1400***000" }, { "name": "TaskId", "type": "string", "required": true, "description": "唯一标识转推任务。", "example": "-nHPekVU7h******sceOqAZ1YVQE." }, { "name": "RecordKey", "type": "string", "required": false, "description": "录制任务 key，标识一个录制任务，对应转推任务发起时指定 RecordKey； 如果填写该参数，表示调用者希望立即结束该录制任务。当RecordKey 指定的录制任务正在录制当前转推任务时，录制任务立即结束，否则录制任务不受影响。 如果没有填写该参数，但是转推任务发起时填写了 RecordKey，则表示在续录等待时间结束后才结束录制任务，续录等待期间可以使用相同的 RecordKey 发起新...", "example": "test_record_key_a" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "StopStreamIngest", "description": "停止一个输入在线媒体流任务。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和任务的房间所对应的SDKAppId相同。", "example": "1600011111" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务的唯一Id，在启动任务成功后会返回。", "example": "HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "StopWebRecord", "description": "停止页面录制任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "需要停止的任务Id", "example": "HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri" } ], "required": [ "TaskId" ] }, { "name": "TextToSpeech", "description": "语音合成接口", "status": "online", "parameters": [ { "name": "Text", "type": "string", "required": true, "description": "需要转语音的文字内容，长度范围：[1, 255]", "example": "你好呀，欢迎使用语音合成" }, { "name": "Voice", "type": "object", "required": true, "description": "文本转语音的声音配置", "example": "无", "children": [ { "name": "VoiceId", "type": "string", "required": true, "description": "音色 ID，可从音色列表获取，或使用声音克隆生成的自定义音色 ID", "example": "v-female-R2s4N9qJ" }, { "name": "Speed", "type": "float", "required": false, "description": "语速调节，0.5 为半速慢放，2.0 为两倍速快放，1.0 为正常语速，区间：[0.5, 2.0]，默认1.0", "example": "1.0" }, { "name": "Volume", "type": "float", "required": false, "description": "音量调节，0 为静音，10 为最大音量，建议保持默认值 1.0，区间：[0, 10]，默认1.0", "example": "1.0" }, { "name": "Pitch", "type": "integer", "required": false, "description": "音高调节，负值声音更低沉，正值声音更尖锐，0 为原始音高，区间 [-12, 12], 默认0", "example": "0" } ] }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SdkAppId", "example": "1400000000" }, { "name": "AudioFormat", "type": "object", "required": false, "description": "文本转语音的输出音频的格式", "example": "无", "children": [ { "name": "Format", "type": "string", "required": false, "description": "生成的音频格式 - TextToSpeechSSE 流式接口 支持 pcm, 默认: pcm - TextToSpeech 非流式接口 支持 pcm,wav,mp3, 默认: pcm", "example": "pcm" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "生成的音频采样率，默认24000 可选 - 16000 - 24000", "example": "24000" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "MP3 比特率 (kbps)，仅对 MP3 格式生效, 可以选： `64`, `128`, `192`, `256` , 默认： `128`", "example": "128" } ] }, { "name": "Model", "type": "string", "required": false, "description": "TTS的模型，当前固定为：flow_01_turbo", "example": "flow_01_turbo" }, { "name": "Language", "type": "string", "required": false, "description": "需要合成的语言（ISO 639-1），默认自动识别，支持的语言如下： - zh（中文） - en（英文） - yue（粤语） - ja（日语） - ko（韩语） - ar（阿拉伯语） - id（印尼语） - th（泰语）", "example": "zh" } ], "required": [ "Text", "Voice", "SdkAppId" ] }, { "name": "TextToSpeechSSE", "description": "SSE流式文本转语音", "status": "online", "parameters": [ { "name": "Text", "type": "string", "required": true, "description": "需要转语音的文字内容，长度范围：[1, 255]", "example": "你好呀，欢迎使用语音合成" }, { "name": "Voice", "type": "object", "required": true, "description": "文本转语音的声音配置", "example": "无", "children": [ { "name": "VoiceId", "type": "string", "required": true, "description": "音色 ID，可从音色列表获取，或使用声音克隆生成的自定义音色 ID", "example": "v-female-R2s4N9qJ" }, { "name": "Speed", "type": "float", "required": false, "description": "语速调节，0.5 为半速慢放，2.0 为两倍速快放，1.0 为正常语速，区间：[0.5, 2.0]，默认1.0", "example": "1.0" }, { "name": "Volume", "type": "float", "required": false, "description": "音量调节，0 为静音，10 为最大音量，建议保持默认值 1.0，区间：[0, 10]，默认1.0", "example": "1.0" }, { "name": "Pitch", "type": "integer", "required": false, "description": "音高调节，负值声音更低沉，正值声音更尖锐，0 为原始音高，区间 [-12, 12], 默认0", "example": "0" } ] }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SdkAppId", "example": "140000000" }, { "name": "AudioFormat", "type": "object", "required": false, "description": "文本转语音的输出音频的格式", "example": "无", "children": [ { "name": "Format", "type": "string", "required": false, "description": "生成的音频格式 - TextToSpeechSSE 流式接口 支持 pcm, 默认: pcm - TextToSpeech 非流式接口 支持 pcm,wav,mp3, 默认: pcm", "example": "pcm" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "生成的音频采样率，默认24000 可选 - 16000 - 24000", "example": "24000" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "MP3 比特率 (kbps)，仅对 MP3 格式生效, 可以选： `64`, `128`, `192`, `256` , 默认： `128`", "example": "128" } ] }, { "name": "Model", "type": "string", "required": false, "description": "TTS的模型，当前固定为：flow_01_turbo", "example": "flow_01_turbo" }, { "name": "Language", "type": "string", "required": false, "description": "需要合成的语言（ISO 639-1），默认自动识别，支持如下语言： - zh（中文） - en（英文） - yue（粤语） - ja（日语） - ko（韩语） - ar（阿拉伯语） - id（印尼语） - th（泰语）", "example": "zh" } ], "required": [ "Text", "Voice", "SdkAppId" ] }, { "name": "UpdateAIConversation", "description": "更新AIConversation参数", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "唯一标识一个任务", "example": "无" }, { "name": "WelcomeMessage", "type": "string", "required": false, "description": "不填写则不进行更新，机器人的欢迎语", "example": "无" }, { "name": "InterruptMode", "type": "integer", "required": false, "description": "不填写则不进行更新。智能打断模式，0表示服务端自动打断，1表示服务端不打断，由端上发送打断信令进行打断", "example": "无" }, { "name": "InterruptSpeechDuration", "type": "integer", "required": false, "description": "不填写则不进行更新。InterruptMode为0时使用，单位为毫秒，默认为500ms。表示服务端检测到持续InterruptSpeechDuration毫秒的人声则进行打断", "example": "无" }, { "name": "LLMConfig", "type": "string", "required": false, "description": "不填写则不进行更新，LLM配置，详情见StartAIConversation接口", "example": "无" }, { "name": "TTSConfig", "type": "string", "required": false, "description": "不填写则不进行更新，TTS配置，详情见StartAIConversation接口", "example": "无" } ], "required": [ "TaskId" ] }, { "name": "UpdatePublishCdnStream", "description": "接口说明： 成功发起混流转推后，可以使用此接口来更新任务。仅在任务进行时有效，任务退出后更新将会返回错误。更新操作为增量更新模式。 注意：为了保障推流的稳定性，更新不支持任务在纯音频、音视频、纯视频之间进行切换。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和转推的房间所对应的SdkAppId相同。", "example": "1400000001" }, { "name": "TaskId", "type": "string", "required": true, "description": "唯一标识转推任务。", "example": "-nHPekVU7h******sceOqAZ1YVQE." }, { "name": "SequenceNumber", "type": "integer", "required": true, "description": "客户保证同一个任务，每次更新请求中的SequenceNumber递增，防止请求乱序。", "example": "2" }, { "name": "WithTranscoding", "type": "integer", "required": true, "description": "是否转码，0表示无需转码，1表示需要转码。 WithTranscoding为0，表示旁路转推，默认不转码；WithTranscoding为1，表示混流转推，此时一定会转码，并收取转码费用。 注： 1，混流是必须转码的，这个参数需设置为1。 2，WithTranscoding=0时，视频输出Codec默认跟随上行视频Codec，如果上行视频Codec发生变化，CDN会断流重推。", "example": "1" }, { "name": "AudioParams", "type": "object", "required": false, "description": "更新相关参数，只支持更新参与混音的主播列表参数，不支持更新Codec、采样率、码率和声道数。不填表示不更新此参数。", "example": "无", "children": [ { "name": "AudioEncode", "type": "object", "required": false, "description": "音频编码参数。", "example": "无", "children": [ { "name": "SampleRate", "type": "integer", "required": true, "description": "输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000]，单位是Hz。", "example": "48000" }, { "name": "Channel", "type": "integer", "required": true, "description": "输出流音频声道数，取值范围[1,2]，1表示混流输出音频为单声道，2表示混流输出音频为双声道。", "example": "2" }, { "name": "BitRate", "type": "integer", "required": true, "description": "输出流音频码率。取值范围[8,500]，单位为kbps。", "example": "64" }, { "name": "Codec", "type": "integer", "required": false, "description": "输出流音频编码类型，取值范围[0, 1, 2]，0为LC-AAC，1为HE-AAC，2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时，只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。", "example": "0" } ] }, { "name": "SubscribeAudioList", "type": "array", "required": false, "description": "音频用户白名单，start时，为空或不填表示混所有主播音频，填具体值表示混指定主播音频；update时，不填表示不更新，为空表示更新为混所有主播音频，填具体值表示更新为混指定主播音频。 使用黑白名单时，黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时，以黑名单为主。 注：如果是跨房pk时，跨房混流需要指定音频白名单，否则pk主播的音...", "example": "无", "item_type": "object", "children": [ { "name": "UserInfo", "type": "object", "required": true, "description": "用户参数。", "example": "{\"UserId\": \"user_a\",\"RoomId\": \"123456\",\"RoomIdType\": 0}", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "用户ID。", "example": "user_a" }, { "name": "RoomId", "type": "string", "required": false, "description": "动态布局时房间信息必须和主房间信息保持一致，自定义布局时房间信息必须和MixLayoutList中对应用户的房间信息保持一致，不填时默认与主房间信息一致。", "example": "room_123456" }, { "name": "RoomIdType", "type": "integer", "required": false, "description": "房间号类型，0为整型房间号，1为字符串房间号。", "example": "1" } ] }, { "name": "SoundLevel", "type": "integer", "required": false, "description": "混音的音量调整：取值范围是0到100，100为原始上行音量，不填默认为100，值越小则音量越低。 注：该参数只在音量白名单下配置生效，其他场景配置无效。", "example": "100" } ] }, { "name": "UnSubscribeAudioList", "type": "array", "required": false, "description": "音频用户黑名单，为空或不填表示无黑名单，填具体值表示不混指定主播音频。update时，不填表示不更新，为空表示更新为清空黑名单，填具体值表示更新为不混指定主播音频。 使用黑白名单时，黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时，以黑名单为主。", "example": "无", "item_type": "object", "children": [ { "name": "UserInfo", "type": "object", "required": true, "description": "用户参数。", "example": "{\"UserId\": \"user_a\",\"RoomId\": \"123456\",\"RoomIdType\": 0}", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "用户ID。", "example": "user_a" }, { "name": "RoomId", "type": "string", "required": false, "description": "动态布局时房间信息必须和主房间信息保持一致，自定义布局时房间信息必须和MixLayoutList中对应用户的房间信息保持一致，不填时默认与主房间信息一致。", "example": "room_123456" }, { "name": "RoomIdType", "type": "integer", "required": false, "description": "房间号类型，0为整型房间号，1为字符串房间号。", "example": "1" } ] }, { "name": "SoundLevel", "type": "integer", "required": false, "description": "混音的音量调整：取值范围是0到100，100为原始上行音量，不填默认为100，值越小则音量越低。 注：该参数只在音量白名单下配置生效，其他场景配置无效。", "example": "100" } ] } ] }, { "name": "VideoParams", "type": "object", "required": false, "description": "更新视频相关参数，转码时支持更新除编码类型之外的编码参数，视频布局参数，背景图片和背景颜色参数，水印参数。不填表示不更新此参数。", "example": "无", "children": [ { "name": "VideoEncode", "type": "object", "required": false, "description": "输出流视频编码参数。", "example": "无", "children": [ { "name": "Width", "type": "integer", "required": true, "description": "输出流宽，音视频输出时必填。取值范围[0,1920]，单位为像素值。", "example": "1280" }, { "name": "Height", "type": "integer", "required": true, "description": "输出流高，音视频输出时必填。取值范围[0,1920]，单位为像素值。", "example": "720" }, { "name": "Fps", "type": "integer", "required": true, "description": "输出流帧率，音视频输出时必填。取值范围[1,60]，表示混流的输出帧率可选范围为1到60fps。", "example": "15" }, { "name": "BitRate", "type": "integer", "required": true, "description": "输出流码率，音视频输出时必填。取值范围[1,10000]，单位为kbps。", "example": "1500" }, { "name": "Gop", "type": "integer", "required": true, "description": "输出流gop，音视频输出时必填。取值范围[1,5]，单位为秒。", "example": "2" } ] }, { "name": "LayoutParams", "type": "object", "required": false, "description": "混流布局参数。", "example": "无", "children": [ { "name": "MixLayoutMode", "type": "integer", "required": false, "description": "布局模式：动态布局（1：悬浮布局（默认），2：屏幕分享布局，3：九宫格布局），静态布局（4：自定义布局）。最多支持混入16路音视频流，如果用户只上行音频，也会被算作一路；自定义布局中，如果子画面只设置占位图，也被算作一路。", "example": "4" }, { "name": "PureAudioHoldPlaceMode", "type": "integer", "required": false, "description": "纯音频上行是否占布局位置，只在动态布局中有效。0表示纯音频不占布局位置，1表示纯音频占布局位置，不填默认为0。", "example": "0" }, { "name": "MixLayoutList", "type": "array", "required": false, "description": "自定义模板中有效，指定用户视频在混合画面中的位置，最多支持设置16个输入流。", "example": "[{\"UserMediaStream\":{\"UserInfo\":{\"UserId\":\"user_a\"}},\"ImageWidth\":1920,\"ImageHeight\":1080,\"LocationX\":0,\"LocationY\":0}]", "item_type": "object", "children": [ { "name": "UserMediaStream", "type": "object", "required": false, "description": "用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。", "example": "无" }, { "name": "ImageWidth", "type": "integer", "required": false, "description": "子画面在输出时的宽度，单位为像素值，不填默认为0。", "example": "1280" }, { "name": "ImageHeight", "type": "integer", "required": false, "description": "子画面在输出时的高度，单位为像素值，不填默认为0。", "example": "720" }, { "name": "LocationX", "type": "integer", "required": false, "description": "子画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。", "example": "0" }, { "name": "LocationY", "type": "integer", "required": false, "description": "子画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。", "example": "0" }, { "name": "ZOrder", "type": "integer", "required": false, "description": "子画面在输出时的层级，不填默认为0。", "example": "0" }, { "name": "RenderMode", "type": "integer", "required": false, "description": "子画面在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底。不填默认为0。", "example": "0" }, { "name": "BackGroundColor", "type": "string", "required": false, "description": "【此参数配置无效，暂不支持】子画面的背景颜色，常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。", "example": "0xFFFFFF" }, { "name": "BackgroundImageUrl", "type": "string", "required": false, "description": "子画面的占位图片url，填写该参数，当用户关闭摄像头或未进入TRTC房间时，会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致，则会对图片进行拉伸处理，优先级高于BackGroundColor。支持png、jpg、jpeg、bmp、gif、webm格式。图片分辨率限制不超过2K，图片大小限制不超过5MB。 注： 1，您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，...", "example": "https://***.png" }, { "name": "CustomCrop", "type": "object", "required": false, "description": "客户自定义裁剪，针对原始输入流裁剪", "example": "无" }, { "name": "BackgroundRenderMode", "type": "integer", "required": false, "description": "子背景图在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底，3为变比例伸缩，4为自定义渲染。不填默认为3。", "example": "3" }, { "name": "TransparentUrl", "type": "string", "required": false, "description": "子画面的透明模版url，指向一张包含透明通道的模板图片。填写该参数，后台混流时会提取该模板图片的透明通道，将其缩放作为目标画面的透明通道，再和其他画面进行混合。您可以通过透明模版实现目标画面的半透明效果和任意形状裁剪（如圆角、星形、心形等）。 支持png格式。图片分辨率限制不超过2K，图片大小限制不超过5MB。 注： 1，模板图片宽高比应接近目标画面\ufffd\ufffd...", "example": "https://***.png" }, { "name": "BackgroundCustomRender", "type": "object", "required": false, "description": "子背景图的自定义渲染参数，当BackgroundRenderMode为4时必须配置。", "example": "无" }, { "name": "BackGroundColorMode", "type": "integer", "required": false, "description": "子背景色生效模式，默认值为0表示均不生效。 bit0:占位图缩放是否生效。 bit1:上行流缩放是否生效。 您可以将相应bit位置1启动生效，例如： 0(00)表示子背景色不生效。 1(01)表示子背景色只在占位图缩放时生效。 2(10)表示子背景色只在上行流缩放时生效。 3(11)表示子背景色在占位图缩放和上行流缩放时均生效。", "example": "0" } ] }, { "name": "MaxVideoUser", "type": "object", "required": false, "description": "指定动态布局中悬浮布局和屏幕分享布局的大画面信息，只在悬浮布局和屏幕分享布局有效。", "example": "{\"UserMediaStream\":{\"UserInfo\":{\"UserId\":\"user_a\"}}}", "children": [ { "name": "UserMediaStream", "type": "object", "required": true, "description": "用户媒体流参数。", "example": "{\"UserInfo\":{\"UserId\":\"user_a\",\"RoomId\":\"123456\",\"RoomIdType\":0},\"StreamType\":0}" } ] }, { "name": "RenderMode", "type": "integer", "required": false, "description": "屏幕分享模板、悬浮模板、九宫格模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底", "example": "0" } ] }, { "name": "BackGroundColor", "type": "string", "required": false, "description": "整个画布背景颜色，常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。", "example": "0xFFFFFF" }, { "name": "BackgroundImageUrl", "type": "string", "required": false, "description": "整个画布的背景图片url，优先级高于BackGroundColor。支持png、jpg、jpeg格式。图片分辨率限制不超过2K，图片大小限制不超过5MB。 注： 1，您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，背景图片将不会生效。 2，url可支持字符集：【'0-9','a-z','A-Z','-', '.', '_', '~', ':', '/', '?', '#', '[', ']','@', '!', '\u0026', '(', ')', '*', '+', ',', '%', '=', ';', '|'\ufffd...", "example": "https://******.png" }, { "name": "WaterMarkList", "type": "array", "required": false, "description": "混流布局的水印参数。", "example": "无", "item_type": "object", "children": [ { "name": "WaterMarkType", "type": "integer", "required": false, "description": "水印类型，0为图片（默认），1为文字。", "example": "0" }, { "name": "WaterMarkImage", "type": "object", "required": false, "description": "图片水印参数。WaterMarkType为0指定。图片分辨率限制不超过2K，图片大小限制不超过5MB。", "example": "{\"WaterMarkUrl\": \"http://your_picture.png\",\"WaterMarkWidth\": 150,\"WaterMarkHeight\": 90,\"LocationX\": 0,\"LocationY\": 0,\"ZOrder\": 20}", "children": [ { "name": "WaterMarkUrl", "type": "string", "required": true, "description": "水印图片URL地址，支持png、jpg、jpeg格式。图片分辨率限制不超过2K，图片大小限制不超过5MB。 注： 1，您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，水印图片将不会生效。 2，url可支持字符集：【'0-9','a-z','A-Z','-', '.', '_', '~', ':', '/', '?', '#', '[', ']','@', '!', '\u0026', '(', ')', '*', '+', ',', '%', '=', ';', '|'】，您需要确保url字符在可支持\ufffd...", "example": "xxx.png" }, { "name": "WaterMarkWidth", "type": "integer", "required": true, "description": "水印在输出时的宽。单位为像素值。", "example": "64" }, { "name": "WaterMarkHeight", "type": "integer", "required": true, "description": "水印在输出时的高。单位为像素值。", "example": "64" }, { "name": "LocationX", "type": "integer", "required": true, "description": "水印在输出时的X偏移。单位为像素值。", "example": "0" }, { "name": "LocationY", "type": "integer", "required": true, "description": "水印在输出时的Y偏移。单位为像素值。", "example": "0" }, { "name": "ZOrder", "type": "integer", "required": false, "description": "水印在输出时的层级，不填默认为0。", "example": "0" }, { "name": "DynamicPosType", "type": "integer", "required": false, "description": "动态水印类型，默认为0。0:关闭；1:随机位置，每秒变动一次；2:边界扫描反弹，每帧变动一次。", "example": "0" } ] }, { "name": "WaterMarkText", "type": "object", "required": false, "description": "文字水印参数。WaterMarkType为1指定。", "example": "{\"Text\": \"主持人\",\"WaterMarkWidth\": 54,\"WaterMarkHeight\": 18,\"LocationX\": 80,\"LocationY\": 80,\"FontSize\": 18,\"DynamicPosType\": 0}", "children": [ { "name": "Text", "type": "string", "required": true, "description": "文字水印内容。", "example": "\"主持人\"" }, { "name": "WaterMarkWidth", "type": "integer", "required": true, "description": "水印在输出时的宽。单位为像素值。", "example": "64" }, { "name": "WaterMarkHeight", "type": "integer", "required": true, "description": "水印在输出时的高。单位为像素值。", "example": "64" }, { "name": "LocationX", "type": "integer", "required": true, "description": "水印在输出时的X偏移。单位为像素值。", "example": "0" }, { "name": "LocationY", "type": "integer", "required": true, "description": "水印在输出时的Y偏移。单位为像素值。", "example": "0" }, { "name": "FontSize", "type": "integer", "required": true, "description": "字体大小", "example": "12" }, { "name": "FontColor", "type": "string", "required": false, "description": "字体颜色，默认为白色。常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。", "example": "0xFFFFFF" }, { "name": "BackGroundColor", "type": "string", "required": false, "description": "字体背景色，不配置默认为透明。常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。", "example": "0x000000" }, { "name": "DynamicPosType", "type": "integer", "required": false, "description": "动态水印类型，默认为0。0:关闭；1:随机位置，每秒变动一次；2:边界扫描反弹，每帧变动一次。", "example": "0" }, { "name": "ZOrder", "type": "integer", "required": false, "description": "水印在输出时的层级，不填默认为0。", "example": "0" }, { "name": "Font", "type": "string", "required": false, "description": "水印字体，不填默认为Tencent。支持设置以下值： Tencent （默认） SourceHanSans", "example": "Tencent" } ] } ] }, { "name": "BackgroundRenderMode", "type": "integer", "required": false, "description": "背景图在输出时的显示模式：0为裁剪，1为缩放并显示黑底，2为变比例伸缩。后台默认为变比例伸缩。", "example": "2" } ] }, { "name": "SingleSubscribeParams", "type": "object", "required": false, "description": "更新单流转推的用户上行参数，仅在非转码时有效。不填表示不更新此参数。", "example": "无", "children": [ { "name": "UserMediaStream", "type": "object", "required": true, "description": "用户媒体流参数。", "example": "{\"UserInfo\":{\"UserId\":\"user_a\",\"RoomId\":\"123456\",\"RoomIdType\":0},\"StreamType\":0}", "children": [ { "name": "UserInfo", "type": "object", "required": false, "description": "TRTC用户参数。", "example": "{\"UserId\":\"user_a\",\"RoomId\":\"123456\",\"RoomIdType\":0}", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "用户ID。", "example": "user_a" }, { "name": "RoomId", "type": "string", "required": false, "description": "动态布局时房间信息必须和主房间信息保持一致，自定义布局时房间信息必须和MixLayoutList中对应用户的房间信息保持一致，不填时默认与主房间信息一致。", "example": "room_123456" }, { "name": "RoomIdType", "type": "integer", "required": false, "description": "房间号类型，0为整型房间号，1为字符串房间号。", "example": "1" } ] }, { "name": "StreamType", "type": "integer", "required": false, "description": "主辅路流类型，0为摄像头，1为屏幕分享，不填默认为0。", "example": "0" } ] } ] }, { "name": "PublishCdnParams", "type": "array", "required": false, "description": "更新转推的CDN参数。不填表示不更新此参数。", "example": "无", "item_type": "object", "children": [ { "name": "PublishCdnUrl", "type": "string", "required": true, "description": "CDN转推URL，只支持rtmp链接。 注：若更新转推时，URL有任何变化，都会断流重推。", "example": "rtmp://***\u0026txTime=686F7239" }, { "name": "IsTencentCdn", "type": "integer", "required": false, "description": "是否是腾讯云CDN，0为转推非腾讯云CDN，1为转推腾讯CDN，不携带该参数默认为1。注意：1，为避免误产生转推费用，该参数建议明确填写，转推非腾讯云CDN时会产生转推费用，详情参见接口文档说明；2，国内站默认只支持转推腾讯云CDN，如您有转推第三方CDN需求，请联系腾讯云技术支持。", "example": "1" } ] }, { "name": "SeiParams", "type": "object", "required": false, "description": "混流SEI参数", "example": "无", "children": [ { "name": "LayoutVolume", "type": "object", "required": false, "description": "音量布局SEI", "example": "{\"PayloadType\":243,\"FollowIdr\":1}", "children": [ { "name": "AppData", "type": "string", "required": false, "description": "AppData的内容，会被写入自定义SEI中的app_data字段，长度需小于4096。", "example": "user_custom_data" }, { "name": "PayloadType", "type": "integer", "required": false, "description": "SEI消息的payload_type，默认值100，取值范围100-254（244除外，244为我们内部自定义的时间戳SEI）", "example": "100" }, { "name": "Interval", "type": "integer", "required": false, "description": "SEI发送间隔，单位毫秒，默认值为1000。", "example": "1000" }, { "name": "FollowIdr", "type": "integer", "required": false, "description": "取值范围[0,1]，填1：发送关键帧时会确保带SEI；填0：发送关键帧时不确保带SEI。默认值为0。", "example": "0" } ] }, { "name": "PassThrough", "type": "object", "required": false, "description": "透传SEI", "example": "{\"PayloadContent\":\"user_custom_data\",\"PayloadType\":108,\"Interval\":2000,\"FollowIdr\":1}", "children": [ { "name": "PayloadContent", "type": "string", "required": true, "description": "透传SEI的payload内容。", "example": "user_custom_data" }, { "name": "PayloadType", "type": "integer", "required": true, "description": "SEI消息的PayloadType，取值范围5、100-254（244除外，244为我们内部自定义的时间戳SEI）。 注：部分播放器可能不支持PayloadType为5带PayloadUuid的标准类型，建议优先使用其他PayloadType。", "example": "101" }, { "name": "PayloadUuid", "type": "string", "required": false, "description": "PayloadType为5，PayloadUuid必须填写。PayloadType不是5时，不需要填写，填写会被后台忽略。该值必须是32长度的十六进制。", "example": "aaaaaaaabbbbbbbbccccccccdddddddd" }, { "name": "Interval", "type": "integer", "required": false, "description": "SEI发送间隔，单位毫秒，默认值为1000。", "example": "1000" }, { "name": "FollowIdr", "type": "integer", "required": false, "description": "取值范围[0,1]，填1：发送关键帧时会确保带SEI；填0：发送关键帧时不确保带SEI。默认值为0。", "example": "0" } ] } ] }, { "name": "FeedBackRoomParams", "type": "array", "required": false, "description": "回推房间信息", "example": "无", "item_type": "object", "children": [ { "name": "RoomId", "type": "string", "required": true, "description": "回推房间的RoomId。", "example": "room_1234" }, { "name": "RoomIdType", "type": "integer", "required": true, "description": "房间类型，必须和回推房间所对应的RoomId类型相同，0为整形房间号，1为字符串房间号。", "example": "1" }, { "name": "UserId", "type": "string", "required": true, "description": "回推房间使用的UserId(https://cloud.tencent.com/document/product/647/46351#userid)，注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复，建议可以把房间ID作为userId的标识的一部分。", "example": "room_1234_push_1" }, { "name": "UserSig", "type": "string", "required": true, "description": "回推房间UserId对应的用户签名，相当于登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。", "example": "eJw1zc0Ogj***kCs8k5Eg__" } ] } ], "required": [ "SdkAppId", "TaskId", "SequenceNumber", "WithTranscoding" ] }, { "name": "UpdateStreamIngest", "description": "更新输入在线媒体流任务的StreamUrl", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SDKAppId，和任务的房间所对应的SDKAppId相同", "example": "1600011111" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务的唯一Id，在启动任务成功后会返回。", "example": "HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri" }, { "name": "StreamUrl", "type": "string", "required": false, "description": "源流URL。", "example": "https://a.b/test.mp4" }, { "name": "Volume", "type": "integer", "required": false, "description": "音量，取值范围[0, 100]，默认100，表示原音量。", "example": "90" }, { "name": "IsPause", "type": "boolean", "required": false, "description": "是否暂停，默认false表示不暂停。暂停期间任务仍在进行中仍会计费，暂停超过12小时会自动销毁任务, 建议主动调用停止任务接口。", "example": "false" }, { "name": "EnableProgress", "type": "boolean", "required": false, "description": "是否开启播放进度回调, 默认false，当开启后，播放进度会通过trtc custom data 回调给播放端", "example": "true" }, { "name": "Tempo", "type": "float", "required": false, "description": "播放倍速，默认1.0，可取[0.5, 0.75, 1.0, 1.25, 1.5, 1.75, 2.0]", "example": "1.5" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "UpdateVoicePrint", "description": "传入声纹ID以及对应音频信息，更新对应声纹信息", "status": "online", "parameters": [ { "name": "VoicePrintId", "type": "string", "required": true, "description": "声纹信息ID", "example": "20250529_xxxxxx" }, { "name": "ReqTimestamp", "type": "integer", "required": true, "description": "毫秒时间戳", "example": "1748249540000" }, { "name": "AudioFormat", "type": "integer", "required": false, "description": "音频格式,目前只支持0,代表wav", "example": "0" }, { "name": "Audio", "type": "string", "required": false, "description": "整个wav音频文件的base64字符串,其中wav文件限定为16k采样率, 16bit位深, 单声道, 8到18秒音频时长,有效音频不小于6秒(不能有太多静音段),编码数据大小不超过2M", "example": "f8AAAMABwAJAAsxxxx" }, { "name": "AudioMetaInfo", "type": "string", "required": false, "description": "和声纹绑定的MetaInfo，长度最大不超过512", "example": "metainfo string" } ], "required": [ "VoicePrintId", "ReqTimestamp" ] }, { "name": "VoiceClone", "description": "声音克隆", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "TRTC的SdkAppId", "example": "14600000000" }, { "name": "VoiceName", "type": "string", "required": true, "description": "声音克隆的名称, 只允许使用数字、字母、下划线，不能超过36位", "example": "xiaoming_01" }, { "name": "PromptAudio", "type": "string", "required": true, "description": "声音克隆的参考音频，必须为16k单声道的wav的base64字符串， 长度在6秒～180秒之间", "example": "ejiwnorinofnODSw" }, { "name": "PromptText", "type": "string", "required": false, "description": "声音克隆的参考文本，为参考音频对应的文字。", "example": "你好，我要复刻一个我的音色。" }, { "name": "Model", "type": "string", "required": false, "description": "TTS的模型：flow_01_turbo，flow_01_ex", "example": "flow_01_turbo" }, { "name": "Language", "type": "string", "required": false, "description": "语言参数，默认为空， 参考： (ISO 639-1)", "example": "zh" } ], "required": [ "SdkAppId", "VoiceName", "PromptAudio" ] } ] }