すべてのプロダクト
Search
ドキュメントセンター

ApsaraVideo Live:StartRtcCloudRecording

最終更新日:Sep 03, 2026

RTC クラウド録画タスクを開始します。

操作説明

クラウド録画は有料の機能です。請求明細については、「クラウド録画の料金」を参照してください。

説明
  • 録画タスクの開始後、アイドル状態 (ストリームのアップストリーミングなし) でも料金が発生します。したがって、録画が終了したら速やかに StopRtcCloudRecording を呼び出すか、必要に応じて MaxIdleTime を短くしてください。

重要 これは非同期操作です。呼び出しが成功しても、タスクがすでに録画中であるとは限りません。タスクのステータス通知を受信するには、NotifyUrl パラメーターを設定することを強く推奨します。

サービス登録

この操作に対しては、以下のエンドポイントが有効です。

リージョンリージョン IDパブリックエンドポイント
上海cn-shanghailive.aliyuncs.com
シンガポールap-southeast-1live.ap-southeast-1.aliyuncs.com
米国 (バージニア)us-east-1live.us-east-1.aliyuncs.com

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:StartRtcCloudRecording

create

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

AppId

string

必須

録画対象のチャンネルが属するアプリの ID。アプリは、この操作の呼び出し元の Alibaba Cloud アカウントに属している必要があります。

********-7074-****-9ef5-85c19a4*****

ChannelId

string

必須

録画対象のチャンネルの ID。この操作の呼び出し時に、チャンネルにアクティブなユーザーがいることを確認してください。そうでない場合、録画タスクの作成に失敗します。

room1024

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 != 1) にのみ有効です。有効な値:

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

  • 1: 画面共有。

列挙値:

  • 0 :

    カメラ。

  • 1 :

    画面共有。

0

RecordParams

object

必須

録画パラメーター。

RecordMode

integer

必須

録画モード。有効な値:

  • 0: シングルストリーム録画モード。サブスクライブされた各 UserId に対して個別の録画ファイルが生成されます。

  • 1: 混合ストリーム録画モード。サブスクライブされたすべての UserId のストリームが混合およびトランスコードされ、1 つの録画ファイルセットのみが生成されます。

列挙値:

  • 0 :

    シングルストリーム録画モード。サブスクライブされた各 UserId に対して個別の録画ファイルが生成されます。

  • 1 :

    混合ストリーム録画モード。サブスクライブされたすべての UserId のストリームが混合およびトランスコードされ、1 つの録画ファイルセットのみが生成されます。

0

StreamType

integer

任意

録画出力ストリームのメディアタイプ。有効な値:

  • 0: 音声とビデオの両方を含むオリジナルストリーム。(デフォルト)

  • 1: 音声のみのストリーム。

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

列挙値:

  • 0 :

    音声とビデオの両方を含むオリジナルストリーム。

  • 1 :

    音声のみのストリーム。

  • 2 :

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

0

MaxFileDuration

integer

任意

録画ファイルの持続時間の最大値 (秒単位)。この持続時間を超えた録画ファイルはコスト配分されます。有効な値: 180 ~ 7200 (最大値 2 時間)。デフォルト値: 7200。

7200

StorageParams

object

必須

ストレージパラメーター。

StorageType

integer

必須

ストレージメソッド。有効な値:

  • 0: VOD

  • 1: OSS

列挙値:

  • 0 :

    VOD。

  • 1 :

    OSS。

1

FileInfo

array<object>

任意

ファイルストレージ情報。録画ファイルのフォーマット、ストレージの場所、および命名規則を指定します。このパラメーターは、StorageType が OSS にセットされている場合にのみ有効です。

説明

配列内の各要素に対して、対応する構成に基づいて録画ファイルが生成されます。フォーマットが指定されていない場合、デフォルトで HLS フォーマットが使用されます。

object

任意

各ファイルフォーマットのストレージ構成。

Format

string

必須

ファイルストレージフォーマット。有効な値:

  • HLS

  • MP4

  • MP3

列挙値:

  • MP4 :

    MP4 フォーマット。

  • MP3 :

    MP3 フォーマット。

  • HLS :

    HLS フォーマット。

HLS

FileNamePattern

string

任意

ファイルの命名規則。以下の変数の呼び出しを選択し、任意の注文で組み合わせることができます。

  • AppId

  • ChannelId

  • UserId (シングルストリームモードでは必須。混合ストリームモードでは無効。選択した場合、{UserId} 文字列が保持されます。)

  • RecordMode

    • 値 0 は Single に対応します。

    • 値 1 は Mix に対応します。

  • SourceType

    • シングルストリームモードでは、ストリームタイプがビデオのみの場合にこのパラメーターが効果があります。SourceType は以下にセットできます。
      • 0: カメラビデオストリームの C (Camera) に対応します。

      • 1: 画面共有ビデオストリームの S (Screen) に対応します。

    • シングルストリームモードでストリームタイプが音声のみの場合、SourceType は自動的に A (Audio) にセットされ、録画コンテンツが音声のみのストリームであることを示します。

    • シングルストリームモードでストリームタイプがオリジナルストリームの場合、このパラメーターが効果があります。SourceType は以下にセットできます。
      • 0: カメラオリジナルストリームの OC (Original Camera) に対応します。

      • 1: 画面共有オリジナルストリームの OS (Original Screen) に対応します。

    • その他のシナリオでは、SourceType 構成は無効です。SourceType を手動で構成した場合、システムは {SourceType} プレースホルダー文字列を保持します。

  • StreamType (RecordParams の下の StreamType パラメーターを使用)

    • 値 0 は音声およびビデオストリームの AV (Audio Video) に対応します。

    • 値 1 は音声ストリームの A (Audio) に対応します。

    • 値 2 はビデオストリームの V (Video) に対応します。

  • StartTime: 録画が開始される時間。協定世界時 (UTC)+8 タイムゾーンで、2025-03-25-11:27:28 などのフォーマットで指定します。(デフォルト値を使用しない場合は必須。)

デフォルト値:

  • シングルストリーム録画モード
    • {AppId}_{ChannelId}_{UserId}_{StartTime}

    • 同じ UserId に対して異なる StreamType または SourceType の値がサブスクライブされている場合、デフォルト値は {AppId}_{ChannelId}_{UserId}_{SourceType}_{StartTime} です。

  • 混合ストリーム録画モード
    • {AppId}_{ChannelId}_{StartTime}

説明
  • 文字列には、上記のリストの変数のみを含めることができます。変数名は {} で囲む必要があります。変数は単一のアンダースコア (_) で区切ります。各変数は文字列内に最大 1 回しか出現できません。

  • ファイル名が xxx の場合、TaskId/xxx.m3u8 などのフォーマットで保存されます。ここで、TaskId はクラウド録画タスクの開始時に生成されるタスク ID であり、ストレージパスに自動的に追加されます。

{AppId}_{ChannelId}_{StartTime}_{UserId}

SliceNamePattern

string

任意

メディアセグメントファイルの命名規則。このパラメーターは HLS フォーマットでのみ有効です。FileNamePattern と似ていますが、追加の変数 Sequence があります。

  • AppId

  • ChannelId

  • UserId (シングルストリームモードでは必須。混合ストリームモードでは無効。選択した場合、{UserId} 文字列が保持されます。)

  • RecordMode

    • 値 0 は Single に対応します。

    • 値 1 は Mix に対応します。

  • SourceType

    • シングルストリームモードでは、ストリームタイプがビデオのみの場合にこのパラメーターが効果があります。SourceType は以下にセットできます。
      • 0: カメラビデオストリームの C (Camera) に対応します。

      • 1: 画面共有ストリームの S (Screen) に対応します。

    • シングルストリームモードでストリームタイプが音声のみの場合、SourceType は自動的に A (Audio) にセットされ、録画コンテンツが音声のみのストリームであることを示します。

    • シングルストリームモードでストリームタイプがオリジナルストリームの場合、このパラメーターが効果があります。SourceType は以下にセットできます。
      • 0: カメラオリジナルストリームの OC (Original Camera) に対応します。

      • 1: 画面共有オリジナルストリームの OS (Original Screen) に対応します。

    • その他のシナリオでは、SourceType 構成は無効です。このパラメーターを手動で構成した場合、システムは {SourceType} プレースホルダー文字列を保持します。

  • StreamType (RecordParams の下の StreamType パラメーターを使用)

    • 値 0 は音声およびビデオストリームの AV (Audio Video) に対応します。

    • 値 1 は音声ストリームの A (Audio) に対応します。

    • 値 2 はビデオストリームの V (Video) に対応します。

  • StartTime: 録画が開始される時間。協定世界時 (UTC)+8 タイムゾーンで、2025-03-25-11:27:28 などのフォーマットで指定します。(デフォルト値を使用しない場合は必須。)

  • Sequence: HLS フォーマットでは、ts ファイル名に Sequence が含まれます。この変数は他のフォーマットでは無効です。(デフォルト値を使用しない場合は必須。)

デフォルト値:

  • シングルストリーム録画モード
    • {AppId}_{ChannelId}_{UserId}_{StartTime}_{Sequence}

    • 同じ UserId に対して異なる StreamType または SourceType の値がサブスクライブされている場合、デフォルト値は {AppId}_{ChannelId}_{UserId}_{SourceType}_{StartTime}_{Sequence} です。

  • 混合ストリーム録画モード
    • {AppId}_{ChannelId}_{StartTime}_{Sequence}

説明
  • 文字列には、上記のリストの変数のみを含めることができます。変数名は {} で囲む必要があります。変数は単一のアンダースコア (_) で区切ります。各変数は文字列内に最大 1 回しか出現できません。

  • メディアセグメントファイル名が xxx の場合、TaskId/xxx.ts などのフォーマットで保存されます。ここで、TaskId はクラウド録画タスクの開始時に生成されるタスク ID であり、ストレージパスに自動的に追加されます。

{AppId}_{ChannelId}_{StartTime}_{Sequence}

FilePathPrefix

array

任意

ファイルストレージパス。配列内の各要素はディレクトリレベルの呼び出しに対応します。たとえば、パラメーター値が ["dir1","dir2"] の場合、xxx.m3u8 ファイルは dir1/dir2/TaskId/xxx.m3u8 として保存されます。このパラメーターが空の場合、ファイルは直接 TaskId/xxx.m3u8 として保存されます。

  • タスクの TaskId は、異なるタスクの録画ファイルが混在するイベントを防ぐため、パスの末尾に自動的に追加されます。

  • FilePathPrefix が指定されている場合、配列内の各要素には英字 (a-zA-Z)、数字 (0-9)、ハイフン (-)、アンダースコア (_) のみを含めることができ、空の文字列にすることはできません。

  • 連結されたすべてのディレクトリレベルの合計文字数は、128 文字を超えることはできません (接続用の "/" 文字を含みますが、自動的に追加される TaskId は除きます)。たとえば、パラメーター値が ["dir1","dir2"] の場合、連結されたパスは "dir1/dir2/" となり、すべての要素の文字数の合計に配列の長さ (各レベルの後の "/" に相当) を加えたものが 128 を超えないという平均値になります。

  • 配列には最大値 5 個の要素を含めることができ、最大値 5 つのディレクトリレベルをカスタマイズできます。

string

任意

各ディレクトリレベルの名前。

dir1

SliceDuration

integer

任意

セグメントの長さ (秒単位)。このパラメーターは HLS フォーマットでのみ有効です。有効な値: 10 ~ 30。デフォルト値: 30。

特別な要件がない場合は、デフォルト値を使用してください。

30

OSSParams

object

任意

OSS ストレージ構成。このパラメーターは、ストレージメソッドが OSS の場合に必須であり、ストレージメソッドが VOD の場合は無効です。

OSSEndpoint

string

必須

OSS ストレージのエンドポイント。対応するリージョン ID は、選択したサービス登録エンドポイントと同じである必要があります。

oss-cn-shanghai.aliyuncs.com

OSSBucket

string

必須

OSS バケットの名前。バケットは、この操作の呼び出し元の Alibaba Cloud アカウントに属している必要があります。

mytest-バケット

VodParams

object

任意

ビデオオンデマンド (VOD) ストレージ構成。このパラメーターは、ストレージメソッドが VOD の場合に必須であり、ストレージメソッドが OSS の場合は無効です。

説明
  • 米国 (バージニア) リージョンでは、VOD への録画はサポートされていません。

StorageLocation

string

任意

ビデオオンデマンドコンソールの [メディアアセット管理構成] > [ストレージ管理] にリストされているストレージの場所。録画ファイルは最初にこの場所に保存され、その後 VOD にアップロードされます。

説明
  • このパラメーターは、StorageType が 0 (VOD パターン) に設定されている場合に必須です。

  • このストレージの場所のエリアが、選択したサービス登録エンドポイントと同じであることを確認してください。

mytest.oss-cn-shenzhen.aliyuncs.com

VodTranscodeGroupId

string

任意

ビデオオンデマンドトランスコーディングテンプレートグループの ID。

説明
  • このパラメーターは、StorageType が 0 (VOD パターン) にセットされている場合に必須です。

  • このトランスコーディングテンプレートグループ ID のエリアが、選択したサービス登録エンドポイントと同じであることを確認してください。

****8a914d3989e9825eb90530b2****

AutoCompose

integer

任意

自動マージを有効にするかどうかを指定します。有効な値:

  • 0: 無効。(デフォルト)

  • 1: 有効。有効にした場合、ComposeVodTranscodeGroupId パラメーターを指定する必要があります。

列挙値:

  • 0 :

    無効。

  • 1 :

    有効。有効にした場合、ComposeVodTranscodeGroupId パラメーターを指定する必要があります。

0

ComposeVodTranscodeGroupId

string

任意

ビデオオンデマンドサービスで自動的に混合ストリームされた新しいビデオをトランスコードするために使用されるビデオオンデマンドトランスコーディングテンプレートグループの ID。これは、トランスコード操作に使用されるリソースファイルです。

説明
  • このパラメーターは、AutoCompose が 1 にセットされている場合にのみ必須です。

  • 録画終了時にメディアアセットリソースファイルが 1 つしか存在しない場合、有効になっていても自動混合ストリームはトリガーされません。

  • 自動混合ストリームとトランスコードに関する一般的な問題については、「Live-to-VOD よくある質問」を参照してください。

  • ビデオオンデマンドトランスコードの請求明細については、「メディアトランスコードの課金」を参照してください。

****4c34112cfe68248f2f77759c****

MixTranscodeParams

object

任意

トランスコードパラメーター。シングルストリーム録画モードでは、このパラメーターを空にしてください。このパラメーターは、混合ストリーム録画モードでは必須です。

FrameFillType

integer

任意

ストリーム中断時のフレーム塗りつぶしタイプ。有効な値:

  • 0: 最後のフレームで塗りつぶし。(デフォルト)

列挙値:

  • 0 :

    最後のフレームで塗りつぶし。

0

AudioBitrate

integer

必須

音声ビットレート (kbps 単位)。有効な値: 8 ~ 500。このパラメーターは混合ストリームモードでは必須です。

300

AudioChannels

integer

必須

音声チャンネル数。有効な値:

  • 1: モノラル。

  • 2: ステレオ。

このパラメーターは混合ストリームモードでは必須です。

列挙値:

  • 1 :

    モノラル。

  • 2 :

    ステレオ。

2

AudioSampleRate

integer

必須

音声サンプルレート (Hz 単位)。有効な値:

  • 8000

  • 16000

  • 32000

  • 44100

  • 48000

このパラメーターは混合ストリームモードでは必須です。

列挙値:

  • 8000 :

    8000HZ

  • 16000 :

    16000HZ

  • 32000 :

    32000HZ

  • 44100 :

    44100HZ

  • 48000 :

    48000HZ

32000

VideoCodec

string

任意

ビデオエンコード形式。有効な値:

  • H.264 (デフォルト)

  • H.265

列挙値:

  • H.264 :

    H.264 エンコーディング。

  • H.265 :

    H.265 エンコーディング。

H.264

VideoBitrate

integer

任意

ビデオビットレート (kbps 単位)。有効な値: 1 ~ 10000。 このパラメーターは、録画出力にビデオが含まれることが予想される場合、混合ストリームモードで必須です。その他の場合は無効です。

5000

VideoFramerate

integer

任意

ビデオフレームレート (fps 単位)。有効な値: 1 ~ 60。 このパラメーターは、録画出力にビデオが含まれることが予想される場合、混合ストリームモードで必須です。その他の場合は無効です。

30

VideoGop

integer

任意

ビデオ GOP。VideoGop フレームごとに I フレームが存在します。有効な値: 1 ~ 60。 このパラメーターは、録画出力にビデオが含まれることが予想される場合、混合ストリームモードで必須です。その他の場合は無効です。

30

VideoHeight

integer

任意

ビデオの高さ (ピクセル単位)。有効な値: 0 ~ 1920。デフォルト値: 0。

480

VideoWidth

integer

任意

ビデオの幅 (ピクセル単位)。有効な値: 0 ~ 1920。デフォルト値: 0。

640

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 が指定されていない場合、このパラメーターは無効です。有効な値:

  • 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

任意

ペインの Z 順序。0 が最下層レイヤー、1 がその上のレイヤーという順序になります。デフォルト値: 0。

0

SubBackground

object

任意

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

RenderMode

integer

任意

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

  • 0: トリミング。(デフォルト)

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

列挙値:

  • 0 :

    トリミング。

  • 1 :

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

0

Url

string

任意

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

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

NotifyUrl

string

任意

クラウド録画タスクのコールバックメッセージを受信するための URL。API 呼び出しの結果、タスクステータスメッセージは POST メソッドを使用して JSON フォーマットでこの URL に送信されます。最大長は 2048 文字です。

クラウド録画のコールバックメッセージの詳細については、ドキュメント を参照してください。

http://xxxx/test/API呼び出しコールバック

NotifyAuthKey

string

任意

コールバックメッセージの認証キー。このパラメーターが空の場合 (デフォルト)、認証は実行されません。指定する場合、値の長さは 16~64 文字で、大文字、小文字、および数字のみを含めることができます。

  • NotifyUrl が指定されていない場合、NotifyAuthKey も無効です。

  • 有効な NotifyAuthKey が指定されている場合、認証コンテンツがコールバックメッセージに含まれます。

mytestkeymytestkey

NotifyFileUploadedFormat

array

任意

録画ファイル生成イベント (RecordFileUploaded) がトリガーされたときにコールバックメッセージが送信されるファイル形式。

string

任意

コールバックを受信する特定のファイル形式。有効な値 (大文字と小文字を区別しない):

  • SLICE

  • HLS

  • MP4

  • MP3

ビデオオンデマンドストレージモードはサポートされていません。 OSS ストレージモードの場合、選択した形式は StorageParams.FileInfo で指定されたファイル形式に含まれている必要があります。

MP4

MaxIdleTime

integer

任意

アイドルタイムアウト期間。タスクが MaxIdleTime より長くアイドル状態のままである場合、タスクは自動的に停止されます。単位: 秒。有効な値: 10~14400 (最大 4 時間)。デフォルト値: 300。

  • 混合ストリーム録画モードでは、サブスクライブされたすべてのユーザーストリームがアップストリーミングを停止すると、タスクはアイドル状態と見なされます。

  • 個別ストリーム録画モードでは、サブスクライブされたストリームは互いに独立しています。いずれかのストリームがアップストリーミングを停止すると、それはアイドル状態と見なされます。MaxIdleTime に達すると、そのストリームの録画が停止されます。サブスクライブされたすべてのストリームがタイムアウトを超えてアイドル状態になった場合、クラウド録画タスク全体が停止されます。

600

  • 個別ストリーム録画モードの場合:

    • 同じ UserId のカメラストリームと画面共有ストリームの両方を同じ時間でサブスクリプションできます。ただし、録画ファイルが互いに上書きされるのを防ぐため、FileNamePattern パラメーターと SliceNamePattern パラメーターには SourceType 変数を含める必要があります。

    • 特定の UserId のビデオストリームのみ (音声なし) をサブスクリプションすることはサポートされていません。個別ストリーム録画モードでは、UserInfo.StreamType の値を 2 にセットすることはできません。

  • 個別ストリーム録画モードの場合:

    • RecordParams.StreamType が音声のみ (値 1) にセットされている場合、SubscribeParams にビデオのみのサブスクリプション (SubscribeParams 値 2) を含めることはできません。

    • RecordParams.StreamType がビデオのみ (値 2) にセットされている場合、SubscribeParams に音声のみのサブスクリプション (SubscribeParams 値 1) を含めることはできません。

  • 混合ストリーム録画モードの場合:

    • RecordParams.StreamType が音声のみ (値 1) に設定されている場合、SubscribeParams 内のすべての UserId がビデオのみのストリームを購読する (すべての SubscribeParams 値が 2 に設定されている) ことはできません。

    • RecordParams.StreamType がビデオのみ (値 2) に設定されている場合、SubscribeParams 内のすべての UserId が音声のみのストリームを購読する (すべての SubscribeParams 値が 1 に設定されている) ことはできません。

  • 録画中にチャンネルが途中で閉じられた場合、アイドルタイムアウト期間内に再参加してストリームのアップストリーミングを再開する必要があります。そうしないと、タスクは自動的に停止されます。

レスポンスフィールド

フィールド

型

説明

例

object

レスポンスパラメーター。

RequestId

string

リクエスト ID。

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

TaskId

string

タスク ID。

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

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParameter.NotifyUrl %s, please check the notifyUrl. NotifyUrl パラメーターのフォーマットが無効です。パラメーターを確認してください。
400 InvalidParameter.StorageParams.FileInfo %s, please check the fileInfo of storageParams. FileInfo パラメーターに無効なフィールドが含まれています。パラメーターを確認してください。
400 InvalidParameter.StorageParams.OSSParams %s, please check the ossParams of storageParams. OSSParams パラメーターに無効なフィールドが含まれています。パラメーターを確認してください。
400 NotFound.OSSBucket %s, please check the ossBucket of storageParams. OSSBucket パラメーターが存在しません。
400 InvalidParameter.SubscribeParams.SubscribeUserIdList %s, please check the subscribeUserIdList of subscribeParams. SubscribeUserIdList パラメーターが無効です。パラメーターを確認してください。
400 InvalidParameter.MixLayoutParams.UserPanes %s, please check the userPanes of mixLayoutParams. UserPanes パラメーターに無効なフィールドが含まれています。パラメーターを確認してください。
400 InvalidParameter.MixTranscodeParams %s, please check the transcodeParams. MixTranscodeParams パラメーターに無効なコードが含まれています。パラメーターを確認してください。
400 MissingParameter %s. 必須パラメーターが不足しています。
403 InvalidParameter.UserId %s, please check the UserId. UserId が無効です。パラメーターを確認してください。
403 QuotaExceed.RunningTask The number of active cloud recording tasks has reached the limit. アクティブなクラウド録画タスクの数が上限に達しました。
404 InvalidParameter.ChannelId %s, please check the channelId. ChannelId パラメーターが無効です。パラメーターを確認してください。
404 InvalidParameter.AppId %s, please check the appId. AppId パラメーターが無効です。パラメーターを確認してください。
405 InvalidParameter.StorageParams.VodParams %s, please check the vodParams of storageParams. VodParams パラメーターに無効なフィールドが含まれています。パラメーターを確認してください。
405 InvalidParameter.NotifyAuthKey %s, please check the notifyAuthKey. NotifyAuthKey パラメーターのフォーマットが無効です。パラメーターを確認してください。
405 InvalidParameter.MaxIdleTime %s, please check the maxIdleTime. MaxIdleTime パラメーターが無効です。パラメーターを確認してください。
405 InvalidParameter.RecordParams %s, please check the recordParams. RecordParams パラメーターに無効なフィールドが含まれています。パラメーターを確認してください。
405 InvalidParameter.StorageParams.StorageType %s, please check the storageType of storageParams. StorageType パラメーターが無効です。パラメーターを確認してください。
405 InvalidParameter.NotifyFileUploadedFormat %s, please check the notifyFileUploadedFormat. NotifyFileUploadedFormat パラメーターが無効です。パラメーターを確認してください。

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

変更履歴

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