tencent cloud

Feedback

UpdatePublishCdnStream

Last updated: 2024-01-25 19:47:56

    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 Name Required Type Description
    Action Yes String Common Params. The value used for this API: UpdatePublishCdnStream.
    Version Yes String Common Params. The value used for this API: 2019-07-22.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-hongkong, ap-singapore.
    SdkAppId Yes Integer The SDKAppID of the TRTC room whose streams are relayed.
    TaskId Yes String The task ID.
    SequenceNumber Yes Integer The 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.
    WithTranscoding Yes Integer Whether to transcode the streams. 0: No; 1: Yes.
    AudioParams No McuAudioParams Pass this parameter to change the users whose audios are mixed. If you do not pass this parameter, no changes will be made.
    VideoParams No McuVideoParams Pass 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.
    SingleSubscribeParams No SingleSubscribeParams Pass 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.N No Array of McuPublishCdnParam Pass this parameter to change the CDNs to relay to. If you do not pass this parameter, no changes will be made.
    SeiParams No McuSeiParams The stream mixing SEI parameters.
    FeedBackRoomParams.N No Array of McuFeedBackRoomParams The information of the room to which streams are relayed.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String The task ID.
    RequestId String The unique request ID, which is returned for each request. 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 Code Description
    AuthFailure CAM signature/authentication error.
    AuthFailure.UnRealNameAuthenticated Identity verification has not been completed, so this operation is not allowed.
    AuthFailure.UnauthorizedOperation CAM authentication failed.
    AuthFailure.UnsupportedOperation Unsupported operation.
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Parameter error.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.
    UnsupportedOperation Unsupported operation.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support