高级功能与服务端 API
  • 云端录制
  • 音视频流推至CDN
  • 通过 TRTC 实现与 RTMP 互通
  • 服务端事件回调
    • 房间与媒体回调
    • 旁路转推回调
    • 云端录制回调
    • 签名校验示例
  • 发送和接收消息
  • 访问管理
    • 产品概述
    • 可授权的资源及操作
    • 预设策略
    • 自定义策略
  • 启用高级权限控制
  • 如何通过 OBS WHIP 推流至 TRTC 房间
  • 服务端 API
    • 接口分类
    • 历史记录
    • 发出接口请求
      • 请求结构
      • 通用参数
      • 签名方法 v3
      • 签名
      • 回复
    • 房间管理接口
      • SetUserBlockedByStrRoomId
      • SetUserBlocked
      • RemoveUser
      • DismissRoom
      • RemoveUserByStrRoomId
      • DismissRoomByStrRoomId
    • 通话质量监控接口
      • DescribeRoomInfo
      • DescribeUserEvent
      • DescribeCallDetailInfo
      • DescribeUserInfo
      • DescribeScaleInfo
    • 输入在线媒体流相关接口
      • StartStreamIngest
      • StopStreamIngest
      • DescribeStreamIngest
    • 云端录制接口
      • CreateCloudRecording
      • DescribeCloudRecording
      • ModifyCloudRecording
      • DeleteCloudRecording
    • 混流转推相关接口
      • UpdatePublishCdnStream
      • StartPublishCdnStream
      • StopPublishCdnStream
    • 用量统计相关接口
      • DescribeTrtcUsage
      • DescribeRecordingUsage
      • DescribeMixTranscodingUsage
      • DescribeRelayUsage
      • DescribeTrtcRoomUsage
    • 数据类型
    • 错误码
    • 附录
      • 事件 ID 映射表
当前内容仅提供英语版本,中文版我们将尽快补充,感谢您的理解。

UpdatePublishCdnStream

1. API Description

Domain name for API request: trtc.tencentcloudapi.com.

This API is used to change the parameters of a relaying task.
Note: For details about how to use this API, see the StartPublishCdnStream document.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: UpdatePublishCdnStream.
VersionYesStringCommon Params. The value used for this API: 2019-07-22.
RegionYesStringCommon Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-hongkong, ap-singapore.
SdkAppIdYesIntegerThe SDKAppID of the TRTC room whose streams are relayed.
TaskIdYesStringThe task ID.
SequenceNumberYesIntegerThe sequence of a request. This parameter ensures the requests to change the parameters of the same relaying task are in the correct order. It increases each time a new request is made.
WithTranscodingYesIntegerWhether to transcode the streams. 0: No; 1: Yes.
AudioParamsNoMcuAudioParamsPass this parameter to change the users whose audios are mixed. If you do not pass this parameter, no changes will be made.
VideoParamsNoMcuVideoParamsPass this parameter to change video parameters other than the codec, including the video layout, background image, background color, and watermark information. This parameter is valid only if streams are transcoded. If you do not pass it, no changes will be made.
SingleSubscribeParamsNoSingleSubscribeParamsPass this parameter to change the single stream that is relayed. This parameter is valid only if streams are not transcoded. If you do not pass this parameter, no changes will be made.
PublishCdnParams.NNoArray of McuPublishCdnParamPass this parameter to change the CDNs to relay to. If you do not pass this parameter, no changes will be made.
SeiParamsNoMcuSeiParamsThe stream mixing SEI parameters.
FeedBackRoomParams.NNoArray of McuFeedBackRoomParamsThe information of the room to which streams are relayed.

3. Output Parameters

Parameter NameTypeDescription
TaskIdStringThe task ID.
RequestIdStringThe unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Changing the audios mixed and the video layout

This example shows you how to change a relaying task to mix the audio and video of Trtc_User_0 and Trtc_User_3.

Input Example

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdatePublishCdnStream
<Common request parameters>

{
    "SdkAppId": 1400188366,
    "TaskId": "-m97l2ZU7kOlV5cTRMoU6yoGp2nDYkzbJ13EC4K-4pycoZXVv+XVrNoUXQ8++8Z2PwUlAQ..",
    "SequenceNumber": 20,
    "WithTranscoding": 1,
    "AudioParams": {
        "SubscribeAudioList": [
            {
                "UserInfo": {
                    "RoomId": "48111",
                    "RoomIdType": 0,
                    "UserId": "Trtc_User_0"
                }
            },
            {
                "UserInfo": {
                    "RoomId": "48111",
                    "RoomIdType": 0,
                    "UserId": "Trtc_User_3"
                }
            }
        ]
    },
    "VideoParams": {
        "LayoutParams": {
            "MixLayoutMode": 4,
            "MixLayoutList": [
                {
                    "UserMediaStream": {
                        "UserInfo": {
                            "RoomId": "48111",
                            "RoomIdType": 0,
                            "UserId": "Trtc_User_3"
                        },
                        "StreamType": 0
                    },
                    "ImageWidth": 640,
                    "ImageHeight": 720,
                    "LocationX": 0,
                    "LocationY": 0,
                    "ZOrder": 0,
                    "RenderMode": 0
                },
                {
                    "UserMediaStream": {
                        "UserInfo": {
                            "RoomId": "48111",
                            "RoomIdType": 0,
                            "UserId": "Trtc_User_0"
                        },
                        "StreamType": 0
                    },
                    "ImageWidth": 640,
                    "ImageHeight": 720,
                    "LocationX": 640,
                    "LocationY": 360,
                    "ZOrder": 0,
                    "RenderMode": 0
                }
            ]
        }
    }
}

Output Example

{
    "Response": {
        "RequestId": "71993312-6ab8-4768-9124-118e0a20c45f",
        "TaskId": "xxxx"
    }
}

Example2 Changing the relaying parameters

This example shows you how to change relaying parameters.

Input Example

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdatePublishCdnStream
<Common request parameters>

{
    "SdkAppId": 1400188366,
    "TaskId": "-m97l2ZU7kOlV5cTRMoU6yoGp2nDYkzbJ13EC4K-4pycoZXVv+XVrNoUXQ8++8Z2PwUlAQ..",
    "SequenceNumber": 20,
    "WithTranscoding": 1,
    "PublishCdnParams": [
        {
            "IsTencentCdn": 1,
            "PublishCdnUrl": "rtmp://3891.livepush.myqcloud.com/live/trtc_publishcdn_test2?bizid=3891&txSecret=23aeb6ec16fd275af0d00a447b2282f7&txTime=62635BDE"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "71993312-6ab8-4768-9124-118e0a20c45f",
        "TaskId": "xxxx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error CodeDescription
AuthFailureCAM signature/authentication error.
AuthFailure.UnRealNameAuthenticatedIdentity verification has not been completed, so this operation is not allowed.
AuthFailure.UnauthorizedOperationCAM authentication failed.
AuthFailure.UnsupportedOperationUnsupported operation.
FailedOperationOperation failed.
InternalErrorInternal error.
InvalidParameterParameter error.
MissingParameterMissing parameter.
ResourceNotFoundThe resource does not exist.
UnsupportedOperationUnsupported operation.