機能とサーバーインターフェース
  • クラウドレコーディング
  • CDN へのストリーミング
  • TRTC を介して RTMP との相互接続を実現
  • イベントコールバック
    • イベントコールバック
    • バイパスリレーコールバック
    • クラウドレコーディングのコールバック
    • サイン検証の例
  • メッセージの送受信
  • アクセス管理
    • Overview
    • 認可可能なリソースおよび操作
    • プリセットされたポリシー
    • カスタムポリシー
  • 高度な権限制御の有効化
  • 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 マッピングテーブル
このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

ModifyCloudRecording

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: ModifyCloudRecording.
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-beijing, ap-guangzhou, ap-mumbai, ap-shanghai, ap-singapore.
SdkAppIdYesIntegerThe SDKAppID of the room whose streams are recorded.
TaskIdYesStringThe unique ID of the recording task, which is returned after recording starts successfully.
MixLayoutParamsNoMixLayoutParamsThe new stream mixing layout to use.
SubscribeStreamUserIdsNoSubscribeStreamUserIdsThe allowlist/blocklist for stream subscription.

3. Output Parameters

Parameter NameTypeDescription
TaskIdStringThe task ID assigned by the recording service, which uniquely identifies a recording process and becomes invalid after a recording task ends.
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 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 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.
FailedOperation.CRUnsupportMethodUnsupported on-cloud recording method.
InternalError.CRInternalErrorOn-cloud recording internal error.
InvalidParameter.OutOfRangeParameter value is out of range.
MissingParameter.RoomIdRoomId is missing.
MissingParameter.SdkAppIdSdkAppId is missing.
MissingParameter.TaskIdTaskId parameter missing.
MissingParameter.UserIdMissing UserId parameter.
ResourceNotFoundThe resource does not exist.