すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:UpdateRtcCloudRecording

    ドキュメントセンター

    ApsaraVideo Live:UpdateRtcCloudRecording

    最終更新日:Jun 26, 2026

    RTC クラウド録画タスクを更新します。

    操作説明

    シングルストリーム録画ではサブスクリプションパラメーターの更新がサポートされています。ストリームミキシング録画では、サブスクライブされたユーザーストリームのみの更新がサポートされています。

    QPS 制限

    この操作のシングルユーザー QPS 制限は 1 秒あたり 50 回です。この制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。必要に応じてこの操作を呼び出してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    live:UpdateRtcCloudRecording

    update

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TaskId

    string

    必須

    タスク ID。この ID は StartRtcCloudRecording によって返されます。実行中または異常状態のタスクのみ更新できます。

    ******73-8501-****-8ac1-72295a******

    SubscribeParams

    object

    必須

    更新されたサブスクリプションパラメーター。

    SubscribeUserIdList

    array<object>

    必須

    サブスクライブされた UserId エントリのリスト。シングルストリーム録画モードでは、各 UserId が個別に録画されます。ストリームミキシング録画モードでは、すべての UserId のオーディオとビデオが 1 セットのオーディオとビデオにミキシングされます。

    説明

    • 配列の最大値は 17 要素です。

    object

    任意

    サブスクライブされた UserId の情報。

    UserId

    string

    必須

    サブスクライブされた UserId。

    userA
    StreamType

    integer

    任意

    サブスクライブされた UserId のメディアタイプ。有効な値:

    • 0: オリジナルストリーム。オーディオとビデオの両方を含みます。(デフォルト)

    • 1: オーディオのみのストリーム。

    • 2: ビデオのみのストリーム。

    列挙値:

    • 0 :

      オリジナルストリーム。オーディオとビデオの両方を含みます。

    • 1 :

      オーディオのみのストリーム。

    • 2 :

      ビデオのみのストリーム。

    0
    SourceType

    integer

    任意

    UserId のビデオ入力ストリームタイプ。このパラメーターはビデオストリームがサブスクライブされている場合 (StreamType=2) にのみ効果があります。有効な値:

    • 0: カメラ。(デフォルト)

    • 1: 画面共有。

    列挙値:

    • 0 :

      カメラ。

    • 1 :

      画面共有。

    0
    MixLayoutParams

    object

    任意

    更新されたレイアウトパラメーター。シングルストリーム録画モードではこのパラメーターを空のままにしてください。ストリームミキシング録画モードでトランスコード中の出力がオーディオのみでない場合、このパラメーターは必須です。

    MixBackground

    object

    任意

    ストリームミキシングのグローバルバックグラウンドイメージ。

    RenderMode

    integer

    任意

    出力の表示モード。有効な値:

    • 0: クロップ。(デフォルト)

    • 1: スケーリングして黒い枠付きで表示。

    列挙値:

    • 0 :

      クロップ。

    • 1 :

      スケーリングして黒い枠付きで表示。

    0
    Url

    string

    任意

    バックグラウンドイメージの URL。最大長は 2048 文字です。

    https://xxxx.com/photos/my-test-picture.png

    UserPanes

    array<object>

    任意

    サブスクライブされたユーザーのウィンドウレイアウト情報。レイアウト情報が設定された UserId のみが出力に配置されます。オーディオのみでないファイルを録画する場合、ストリームミキシングモードではこのパラメーターは必須です。

    array<object>

    任意

    出力のウィンドウ構成。

    UserId

    string

    任意

    このウィンドウに対応する UserId。

    • UserId が指定されていない場合、サブスクライブされたユーザーがチャンネルに参加した順序でウィンドウが埋められます。

    • ここで指定された UserId と SourceType の組み合わせは SubscribeUserIdList に含まれている必要があります。

    • オーディオのみのストリームはレイアウトに追加できません。

    userA
    SourceType

    integer

    任意

    UserId のビデオ入力ストリームタイプ。UserId が指定されていない場合、SourceType の設定は無視されます。有効な値:

    • 0: カメラ。(デフォルト)

    • 1: 画面共有。

    ここで指定された UserId と SourceType の組み合わせは SubscribeUserIdList に含まれている必要があります。

    列挙値:

    • 0 :

      カメラ。

    • 1 :

      画面共有。

    0
    Height

    string

    任意

    正規化されたパーセンテージとしてのペインの高さ。値の有効値は [0, 1] です。(デフォルト: 0)。

    0.5
    Width

    string

    任意

    正規化されたパーセンテージとしてのペインの幅。値の有効値は [0, 1] です。(デフォルト: 0)。

    0.5
    X

    string

    任意

    正規化されたパーセンテージとしての X 座標。値の有効値は [0, 1] です。(デフォルト: 0)。

    0
    Y

    string

    任意

    正規化されたパーセンテージとしての Y 座標。値の有効値は [0, 1] です。(デフォルト: 0)。

    0
    ZOrder

    integer

    任意

    スタッキング順序。0 が最下層で、レイヤー 1 はレイヤー 0 の上に配置され、以降同様です。(デフォルト: 0)。

    0
    SubBackground

    object

    任意

    サブペインのバックグラウンドイメージ。ユーザーがカメラをオフにした場合、参加後にまだストリームのアップストリーミングを開始していない場合、または途中でチャンネルを離れた場合、対応するイメージがレイアウト位置を埋めます。

    RenderMode

    integer

    任意

    サブペイン出力の表示モード。有効な値:

    • 0: クロップ。(デフォルト)

    • 1: スケーリングして黒い枠で表示。

    列挙値:

    • 0 :

      クロップ。

    • 1 :

      スケーリングして黒い枠で表示。

    0
    Url

    string

    任意

    バックグラウンドイメージの URL。最大長は 2048 文字です。

    https://xxxx.com/photos/my-test-pane-picture.png

    • 同じ UserId のカメラストリームと画面共有ストリームの両方を同時にサブスクライブすることがサポートされています。シングルストリーム録画モードで同じ UserId のカメラストリームと画面共有ストリームの両方をサブスクライブする場合、録画ファイルが互いに上書きされないように、FileNamePattern と SliceNamePattern に SourceType 変数を含める必要があります。

    • シングルストリーム録画モードでは、特定の UserId のビデオのみのストリームをサブスクライブすることはサポートされていません。つまり、シングルストリームモードでは UserInfo.StreamType を 2 に設定できません。

    • UserId の画面ストリームのみをオーディオなしで録画するには、UserId のビデオのみのストリームをサブスクライブして SourceType を 1 に設定する (シングルストリーム録画モードではサポートされていません) か、UserId のオリジナルストリームをサブスクライブしてアップストリーミング時に画面ストリームのみをプッシュしオーディオをプッシュしないかミュートにします。UserId の画面ストリームとオーディオストリームの両方を録画するには、UserId のオリジナルストリームをサブスクライブしてアップストリーミング時に画面ストリームとオーディオストリームの両方をプッシュするか、SourceType を 1 に設定して UserId のビデオのみのストリームをサブスクライブし (シングルストリーム録画モードではサポートされていません)、同じ UserId のオーディオのみのストリームもサブスクライブします。

    • シングルストリーム録画モードで RecordParams.StreamType がオーディオのみ (値 1) の場合、SubscribeParams にビデオのみのサブスクリプション (値 2) を含めることはできません。RecordParams.StreamType がビデオのみ (値 2) の場合、SubscribeParams にオーディオのみのサブスクリプション (値 1) を含めることはできません。

    • ストリームミキシング録画モードで RecordParams.StreamType がオーディオのみ (値 1) の場合、SubscribeParams 内のすべての UserId をビデオのみ (値 2) としてサブスクライブすることはできません。RecordParams.StreamType がビデオのみ (値 2) の場合、SubscribeParams 内のすべての UserId をオーディオのみ (値 1) としてサブスクライブすることはできません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。

    ******58-5876-****-83CA-B56278******

    TaskId

    string

    タスク ID。

    ******73-8501-****-8ac1-72295a******

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "******58-5876-****-83CA-B56278******\n",
  "TaskId": "******73-8501-****-8ac1-72295a******\n"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 NotFound.Task %s, please check the TaskId.
    400 InvalidParameter.TaskId %s, please check the TaskId.
    400 InvalidParameter.SubscribeParams.SubscribeUserIdList %s, please check the subscribeUserIdList of subscribeParams.
    400 InvalidParameter.MixLayoutParams.UserPanes %s, please check the userPanes of mixLayoutParams.
    400 InvalidParameter.MixTranscodeParams %s, please check the transcodeParams.
    400 MissingParameter %s.
    403 InvalidParameter.UserId %s, please check the UserId.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。