すべてのプロダクト
Search

このプロダクト

    :SetCasterConfig

    ドキュメントセンター

    :SetCasterConfig

    最終更新日:Jan 23, 2026

    このオペレーションを呼び出して、プロダクションスタジオの名前、トランスコード設定、録画設定、その他のパラメーターを含むプロダクションスタジオの詳細を設定します。

    操作説明

    この操作を呼び出す前に、CreateCaster 操作を呼び出してプロダクションスタジオを作成する必要があります。この操作は、既存のすべての構成を置き換えます。パラメーターを空の値に設定すると、そのパラメーターの既存の構成はクリアされます。

    QPS 制限

    1 ユーザーあたりの 1 秒あたりのクエリ数 (QPS) 制限は、1 秒あたり 10 回の呼び出しです。この制限を超えた API 呼び出しはスロットリングの対象となり、お客様のビジネスに影響を及ぼす可能性があります。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:SetCasterConfig

    update

    *Caster

    acs:live:*:{#accountId}:caster/{#CasterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID。

    cn-shanghai
    CasterId

    string

    必須

    プロダクションスタジオの ID。

    • CreateCaster 操作を呼び出してプロダクションスタジオを作成する場合は、応答で返される CasterId 値を使用します。

    • ApsaraVideo Live コンソールでプロダクションスタジオを作成する場合は、[ApsaraVideo Live コンソール] > [プロダクションスタジオ] > [クラウドプロダクションスタジオ] ページに移動して ID を表示します。

    説明

    クラウドプロダクションスタジオページのリストにあるプロダクションスタジオの名前は、プロダクションスタジオ ID です。

    a2b8e671-2fe5-4642-a2ec-bf93880e****
    CasterName

    string

    任意

    プロダクションスタジオの名前。

    liveCaster****
    DomainName

    string

    任意

    ストリーマーのストリーミングドメイン。

    プロダクションスタジオを開始する前にドメイン名を設定します。このパラメーターを空に設定すると、プロダクションスタジオのドメイン名構成がクリアされます。

    example.com
    TranscodeConfig

    string

    任意

    トランスコーディング構成。

    JSON 文字列です。構造体のフィールドは UpperCamelCase である必要があります。このパラメーターを空に設定すると、トランスコーディング構成はクリアされます。トランスコーディングテンプレートが指定されていない場合、プロダクションスタジオを開始するとエラーが報告されます。

    {"casterTemplate": "lp_ld"}
    RecordConfig

    string

    任意

    録画構成。このパラメーターは JSON 文字列です。要素は次のように記述されます：

    • endpoint：Alibaba Cloud サービスの API エンドポイント。

    • ossBucket：OSS バケットの名前。

    • videoFormat：エクスポートできるビデオのファイル形式。例：[{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"m3u8\",\"CycleDuration\":21600,\"SliceOssObjectPrefix\":\"record/{AppName}/{StreamName}/{UnixTimestamp}\"},{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"flv\",\"CycleDuration\":21600}]。

    • interval：時間間隔。単位：ミリ秒 (ms)。

    説明

    このパラメーターを空に設定すると、録画機能が無効になり、既存の録画構成がクリアされます。

    { "endpoint": "http://oss-cn-********.aliyuncs.com/api", "ossBucket****": "liveBucket****", "VideoFormat":[{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"m3u8\",\"CycleDuration\":21600,\"SliceOssObjectPrefix\":\"record/{AppName}/{StreamName}/{UnixTimestamp}\"},{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"flv\",\"CycleDuration\":21600}] "interval": 5 }
    Delay

    number

    任意

    ストリーム遅延。単位：秒。

    • 0 (デフォルト)：ストリーム遅延を無効にします。

    • 0 より大きい値：ストリーム遅延を有効にします。

    • 空：ストリーム遅延構成をクリアします。

    説明

    最大値は 300 です。

    0
    UrgentMaterialId

    string

    任意

    スタンバイビデオの ID。これはメディアアセットです。このパラメーターを空に設定すると、スタンバイビデオ構成がクリアされます。

    a2b8e671
    UrgentLiveStreamUrl

    string

    任意

    スタンバイライブストリームの URL。

    rtmp://demo.aliyundoc.com
    SideOutputUrl

    string

    任意

    プロダクションスタジオからのバイパス出力用のカスタムアップストリーミング URL。このパラメーターを空に設定すると、システムは自動的に生成されたアップストリーミング URL を出力に使用します。

    説明

    SideOutputUrl パラメーターは、RTMP 経由のアップストリーミングのみをサポートします。

    rtmp://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****
    SideOutputUrlList

    string

    任意

    マルチチャンネルアップストリーミング用のアップストリーミング URL のリスト。URL は、Alibaba Cloud CDN またはサードパーティ CDN のアップストリーミング URL にすることができます。プロダクションスタジオには最大 20 個の RTMP アップストリーミング URL を追加できます。

    説明

    複数の URL を配列で指定します。例：["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]。

    rtmp://domain/app/stream?***
    CallbackUrl

    string

    任意

    Webhook アドレス。コールバック通知を受信するには、HTTP リクエストを受け入れる有効なアドレスを入力します。このパラメーターを空に設定すると、プロダクションスタジオのコールバック通知はキャンセルされます。

    説明

    プロダクションスタジオのコールバックの詳細については、「プロダクションスタジオのコールバック情報」をご参照ください。

    http://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****
    ProgramEffect

    integer

    任意

    カルーセルが有効かどうかを示すフラグ。

    • 0：無効。

    • 1：有効。

    1
    ProgramName

    string

    任意

    カルーセルの名前。カルーセル機能を使用するときにこのパラメーターを設定できます。

    program_name
    ChannelEnable

    integer

    任意

    チャンネルを有効にするかどうかを指定します。

    • 0 (デフォルト)：チャンネルを無効にします。

    • 1：チャンネルを有効にします。

    説明

    デフォルトでは、この機能は無効になっています。この機能を有効にすると、無効にすることはできません。チャンネルが無効になっている場合、リソースはレイアウトによって直接参照されます。初めてチャンネルを有効にするには、プロダクションスタジオが停止状態である必要があります。既存のレイアウトは破棄されます。まずリソースをチャンネルに追加する必要があります。新しいレイアウトはチャンネルを直接参照します。チャンネルを使用して、ビデオソースの再生の進行状況とステータスを調整できます。このモードでは、ビデオソース、プレビュー (PVW)、およびプログラム (PGM) エリアが同じリソースを参照している場合、それらの画面は同期されたままになります。

    1
    SyncGroupsConfig

    string

    任意

    複数のビデオソースを同期するマルチビュー同期の構成。マルチビュー同期には 2 つのモードがあります：

    • mode: 0 (ストリーマーモード。複数のビデオソースが指定されたモードに基づいて同期されます。)

    • mode: 1 (カンファレンスモード。すべてのビデオソースが相互に同期されます。ストリーマービデオの概念はありません。)

    ストリーマーモード：hostResourceId パラメーターは、ストリーマーのビデオソースを指定します。

    カンファレンスモード：hostResourceId パラメーターは使用されません。resourceIds パラメーターにリソース ID を指定するだけで済みます。

    "[{\"mode\":0,\"resourceIds\":[\"5a6c1c33-8424-46f6-813c-c152220a****\",\"4e6521dc-a40a-4077-b6bf-1fb12a76****\"],\"hostResourceId\":\"3aa2b39a-fd0e-4b8c-be73-b7af31c4****\"}]"
    UrgentImageId

    string

    任意

    スタンバイイメージの ID。これはメディアアセットです。

    a089175eb5f4427684fc0715159a****
    UrgentImageUrl

    string

    任意

    スタンバイイメージの URL。

    http://learn.aliyundoc.com/AppName/image.jpg
    AutoSwitchUrgentOn

    boolean

    任意

    スタンバイリソースへの自動スイッチオーバーを有効にするかどうかを指定します。

    • true：有効。

    • false：無効。

    true
    AutoSwitchUrgentConfig

    string

    任意

    スタンバイリソースへの自動スイッチオーバーの構成。eofThres：ストリームが中断された場合にシステムが自動的にスタンバイリソースに切り替わるまでの時間。単位：秒。

    {"eofThres":3}

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    CasterId

    string

    プロダクションスタジオの ID。この ID を使用して、アップストリーミング URL のクエリ、スタジオの開始、ビデオソースの追加、レイアウトの追加、レイアウトのクエリ、コンポーネントの追加、プレイリストの追加ができます。

    b4810848-bcf9-4aef-bd4a-e6bba2d9****
    RequestId

    string

    リクエスト ID。

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

    例

    成功レスポンス

    JSONJSON

    {
  "CasterId": "b4810848-bcf9-4aef-bd4a-e6bba2d9****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidUserId.Malformed %s
    400 InvalidCasterId.Malformed %s
    400 InvalidParameter.Malformed %s
    400 IncorrectCasterStatus.Inuse %s
    400 InvalidCaster.ChannelDisableUnsupported %s
    400 IncorrectCasterStatus.EnableChannel %s
    400 MissingParameter %s
    500 InternalError %s
    403 PermissionDenied %s
    404 InvalidCaster.NotFound %s
    404 InvalidDomainName.NotFound %s

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

    変更履歴

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