tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyCloudRecording

Last updated: 2024-03-11 11:06:31

    1. API Description

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

    This API is used to modify a recording task. It works only when a task is in progress. If the task has already ended when this API is called, an error will be returned. You need to specify all the parameters for each request instead of just the ones you want to modify.

    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: ModifyCloudRecording.
    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-beijing, ap-guangzhou, ap-mumbai, ap-shanghai, ap-singapore.
    SdkAppId Yes Integer The SDKAppID of the room whose streams are recorded.
    TaskId Yes String The unique ID of the recording task, which is returned after recording starts successfully.
    MixLayoutParams No MixLayoutParams The new stream mixing layout to use.
    SubscribeStreamUserIds No SubscribeStreamUserIds The allowlist/blocklist for stream subscription.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String The task ID assigned by the recording service, which uniquely identifies a recording process and becomes invalid after a recording task ends.
    RequestId String The 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 Modifying an on-cloud recording task

    This example shows you how to subscribe to the video and audio streams of user 123 and 456 and customize the layout for the recording task whose task ID is xx under the application whose SDKAppID is 1234.

    Input Example

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

{
    "SubscribeStreamUserIds": {
        "SubscribeVideoUserIds": [
            "123",
            "456"
        ],
        "SubscribeAudioUserIds": [
            "123",
            "456"
        ]
    },
    "TaskId": "xx",
    "SdkAppId": 1234,
    "MixLayoutParams": {
        "MixLayoutMode": 4,
        "MixLayoutList": [
            {
                "Top": 100,
                "UserId": "123",
                "Height": 100,
                "Width": 100,
                "Left": 100
            },
            {
                "Top": 200,
                "UserId": "456",
                "Height": 100,
                "Width": 100,
                "Left": 200
            }
        ]
    }
}

    Output Example

    {
    "Response": {
        "TaskId": "5df46eb2-8e4b-490e-9c3c-dbd3b84faefc",
        "RequestId": "71993312-6ab8-4768-9124-118e0a20c45f"
    }
}

    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.
    FailedOperation.CRUnsupportMethod Unsupported on-cloud recording method.
    InternalError.CRInternalError On-cloud recording internal error.
    InvalidParameter.OutOfRange Parameter value is out of range.
    MissingParameter.RoomId RoomId is missing.
    MissingParameter.SdkAppId SdkAppId is missing.
    MissingParameter.TaskId TaskId parameter missing.
    MissingParameter.UserId Missing UserId parameter.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy