制作スタジオのすべてのパラメータを設定します。

使用状況ノート

この操作を呼び出して構成を設定する前に、プロダクションスタジオを作成する必要があります。 パラメータが指定されていない場合、プロダクションスタジオには関連する設定がありません。

QPS制限

1人のユーザーが1秒あたり最大10件のクエリ (QPS) を実行できます。 1秒あたりの呼び出し数がQPS制限を超えると、スロットリングがトリガーされます。 スロットルはビジネスに影響を与える可能性があります。 したがって、この操作のQPS制限を遵守することをお勧めします。 シングルユーザーの意味とQPSの詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 SetCasterConfig

実行したい操作。 値をSetCasterConfigに設定します。

CasterId String 必須 a2b8e671-2fe5-4642-a2ec-bf93880e ****

制作スタジオのID。

CreateCaster インターフェイスを使用して制作スタジオを作成する場合は、レスポンスのCasterIdパラメーターの値を確認します。

ApsaraVideo Live Consoleを使用して制作スタジオを作成する場合は、コンソールにログインし、次のパスを使用して制作スタジオのIDを確認します。

制作スタジオ > 制作スタジオ管理

注 CasterIdは、Production Studio Managementページの [名前] 列に反映されます。
RegionId String 任意 cn-shanghai

リージョンの ID
CasterName String 任意 liveCaster ****

制作スタジオの名前。
DomainName String 任意 example.com

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

プロダクトスタジオを開始する前にドメイン名を設定します。 このパラメーターを設定しない場合、プロダクションスタジオのドメイン設定はクリアされます。

TranscodeConfig String 任意 {"casterTemplate": "lp_ld"}

制作スタジオのトランスコードに関する設定。

値をJSON文字列に設定します。 文字列のフィールドには上部ラクダケースを使用します。 このパラメーターを設定しない場合、プロダクションスタジオのトランスコード設定は解除されます。

RecordConfig String 任意 {"endpoint": "http:// oss-cn-******** .aliyuncs.com/api", "ossBucket ****": "liveBucket ****", "videoFormat": ["flv", "m3u8" ] "interval": 5}

JSON形式でのプロダクションスタジオの録音に関する設定。 次の要素を設定できます。

  • endpoint: Alibaba CloudサービスのAPIサーバーのアドレス。
  • ossBucket: Object Storage Service (OSS) バケットの名前。
  • videoFormat: ビデオファイルをエクスポートできる形式。 例: ["flv","m3u8" ] 。
  • interval: 記録が開始される間隔。 単位: ミリ秒。
注 このパラメーターを設定しない場合、記録機能は無効になります。 パラメータ内のフィールドが指定されていない場合、プロダクションスタジオの対応する設定がクリアされます。
遅延 Float 任意 0

ストリーム遅延を有効にするかどうかを指定します。 (単位：秒) 設定可能な値は以下のとおりです。

  • 0: ストリーム遅延を無効にします。 これはデフォルト値です。
  • 0より大きい値: 遅延期間。
  • Empty: ストリーム遅延設定をクリアします。
UrgentMaterialId String 任意 a2b8 ****

メディアライブラリのスタンバイビデオとして使用される素材のID。 このパラメーターが指定されていない場合、プロダクションスタジオのスタンバイ再生設定はクリアされます。
SideOutputUrl String 任意 http:// ****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201 ****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f ****

カスタムスタンバイURL。 このパラメーターが指定されていない場合、プロダクションスタジオはシステムによって生成された取り込みURLを使用します。

CallbackUrl String 任意 http:// ****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201 ****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f ****

コールバックURL。 コールバック通知を受信するための有効なHTTPアドレスを入力します。 このパラメーターが指定されていない場合、プロダクションスタジオはコールバック通知を送信しません。

ProgramEffect Integer 任意 1

カルーセル再生を有効にするかどうかを指定します。 設定可能な値は以下のとおりです。

  • 0: カルーセル再生を無効にします。
  • 1: カルーセル再生を有効にします。
プログラム名 String 任意 program_name

カルーセルリストの名前。 このパラメーターは、カルーセル再生を有効にするときに設定できます。
ChannelEnable Integer 任意 1

プロダクションスタジオでチャンネルを有効にするかどうかを指定します。

  • 0: チャンネルを無効にします。 これはデフォルト値です。
  • 1: enables channels.
注 デフォルト値は 0 です。 チャネルを有効にした後は無効にできません。 このパラメーターを0に設定すると、プロダクションスタジオはチャンネルを使用せずにレイアウト内のビデオリソースを参照します。 チャンネルを初めて有効にするときは、プロダクションスタジオがアイドル状態であることを確認してください。 この場合、元のレイアウトを置き換えるために新しいレイアウトが生成されます。 新しいレイアウトは、チャンネルを使用してビデオリソースを参照します。 したがって、チャンネルのビデオリソースを指定する必要があります。 チャンネルを使用して、再生の進行状況やステータスを変更できます。 チャンネルを有効にし、制作スタジオのビデオリソース、プレビュー、およびプログラムモジュールが同じビデオソースを使用する場合、3つのセクションに同じ画像が表示されます。

レスポンスパラメーター

パラメーター データ型 例 説明
CasterId String b4810848-bcf9-4aef-bd4a-e6bba2d9 ****

制作スタジオのID。
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

リクエストの ID です。

例

リクエストの例

http(s):// live.aliyuncs.com/?Action=SetCasterConfig
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<SetCasterConfigResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
      <casterId>b4810848-bcf9-4aef-bd4a-e6bba2d9 ****</casterId>
</SetCasterConfigResponse>

JSON 形式 

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

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。