すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:StartRtcCloudRecording

    ドキュメントセンター

    ApsaraVideo Live:StartRtcCloudRecording

    最終更新日:Jul 14, 2026

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

    操作説明

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

    エンドポイント

    この操作では、以下のエンドポイントがアクティブな状態です。

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

    レート制限

    この操作におけるユーザー単位の QPS 上限は、毎秒 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

    *All resources.

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    AppId

    string

    必須

    録画対象のチャンネルが属するアプリの ID です。アプリは、現在の API 呼び出し元のプライマリアカウントに属している必要があります。

    ********-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 時間です。指定しない場合、デフォルト値は 2 時間です。

    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 ストレージのバケット名。バケットは、現在の API 呼び出し元のプライマリアカウントに属している必要があります。

    mytest-bucket
    VodParams

    object

    任意

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

    説明

    • 米国 (バージニア) リージョンは現在、VOD への録画をサポートしていません。

    StorageLocation

    string

    任意

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

    説明

    • ストレージの場所のリージョンが選択したエンドポイントと一致していることを確認してください。

    mytest.oss-cn-shenzhen.aliyuncs.com
    VodTranscodeGroupId

    string

    任意

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

    説明

    • トランスコーディングテンプレートグループ ID のエリアが選択したエンドポイントと一致していることを確認してください。

    ****8a914d3989e9825eb90530b2****
    AutoCompose

    integer

    任意

    自動結合を有効にするかどうかを指定します。有効な値:

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

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

    列挙値:

    • 0 :

      無効。

    • 1 :

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

    0
    ComposeVodTranscodeGroupId

    string

    任意

    ビデオオンデマンドサービスで自動結合によって生成された新しいビデオをトランスコードするために使用される VOD トランスコーディングテンプレートグループ ID。

    説明

    • このパラメーターは、AutoCompose (自動結合を有効にするかどうか) が 1 に設定されている場合にのみ必須です。

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

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

    • 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 フレームごとに 1 つの 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 が指定されていない場合、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
    SubBackground

    object

    任意

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

    RenderMode

    integer

    任意

    The display mode for the sub-pane output. Valid values:

    • 0: Crop. (Default)

    • 1: Scale and display with black borders.

    列挙値:

    • 0 :

      クロップ。

    • 1 :

      scale and display with black borders.

    0
    Url

    string

    任意

    The URL of the background image. The maximum length is 2048 characters.

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

    string

    任意

    コールバックメッセージを受信するための URL。タスクステータスメッセージは、POST を介して JSON フォーマットでこの URL にプッシュされます。最大長は 2048 文字です。

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

    http://xxxx/test/mycallback
    NotifyAuthKey

    string

    任意

    コールバックメッセージの認証キー。指定しない場合、認証は実行されません。指定する場合、長さは [16, 64] 文字の範囲内であり、大文字・小文字の英字と数字のみで構成する必要があります。

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

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

    mytestkeymytestkey
    NotifyFileUploadedFormat

    array

    任意

    録画ファイル生成イベント (RecordFileUploaded) がトリガーされた際にコールバックメッセージを送信する指定フォーマット。

    string

    任意

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

    • SLICE

    • HLS

    • MP4

    • MP3

    VOD ストレージモードは現在サポートされていません。 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.
    404 InvalidParameter.AppId %s, please check the appId. AppId パラメーターが無効です。パラメーター値を確認してください。
    405 InvalidParameter.StorageParams.VodParams %s, please check the vodParams of storageParams.
    405 InvalidParameter.NotifyAuthKey %s, please check the notifyAuthKey.
    405 InvalidParameter.MaxIdleTime %s, please check the maxIdleTime.
    405 InvalidParameter.RecordParams %s, please check the recordParams.
    405 InvalidParameter.StorageParams.StorageType %s, please check the storageType of storageParams. StorageType パラメーターが無効です。パラメーター値を確認してください。
    405 InvalidParameter.NotifyFileUploadedFormat %s, please check the notifyFileUploadedFormat. NotifyFileUploadedFormat パラメーターが無効です。パラメーター値を確認してください。

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

    変更履歴

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