プロダクションスタジオの詳細設定（名前、トランスコード中構成、録画構成、その他のパラメーターなど）を設定します。
操作説明
まず CreateCaster 操作を呼び出してプロダクションスタジオを作成し、その後この操作を呼び出してプロダクションスタジオの詳細設定を設定します。
<警告>この操作は既存の構成を完全に置き換えます。パラメーターを空に設定すると、プロダクションスタジオ内のそのパラメーターの既存の構成がクリアされます。></警告>
QPS 制限
この操作の単一ユーザー QPS 制限は、1 秒あたり 10 回の呼び出しです。この制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響が出る可能性があります。この操作は適切に呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:SetCasterConfig |
update |
*Caster
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-shanghai |
| CasterId |
string |
必須 |
プロダクションスタジオの ID。
説明
ApsaraVideo Live コンソールのクラウドプロダクションスタジオページにあるプロダクションスタジオリストのプロダクションスタジオ名が、プロダクションスタジオの ID です。 |
a2b8e671-2fe5-4642-a2ec-bf93880e**** |
| CasterName |
string |
任意 |
プロダクションスタジオの名前。 |
liveCaster**** |
| DomainName |
string |
任意 |
プライマリストリームドメイン。 プロダクションスタジオを開始する前に、ドメイン名の構成を完了してください。このパラメーターが空の場合、デフォルトでプロダクションスタジオのドメイン名構成がクリアされます。 |
example.com |
| TranscodeConfig |
string |
任意 |
トランスコード中構成。 JSON フォーマットの文字列。構造体の内部フィールドにはアッパーキャメルケースを使用してください。このパラメーターが空に設定されている場合、デフォルトでトランスコード中構成がクリアされます。トランスコーディングテンプレートが空の場合、プロダクションスタジオの開始時にエラーが返されます。 |
{"casterTemplate": "lp_ld"} |
| RecordConfig |
string |
任意 |
JSON フォーマットの録画構成。構成要素は以下のとおりです。
説明
このパラメーターが空に設定されている場合、録画機能は有効になりません。このパラメーターが空に設定されている場合、デフォルトで録画構成がクリアされます。 |
{ "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 |
任意 |
ストリーム遅延（秒単位）。
説明
最大値は 300 秒です。 |
0 |
| UrgentMaterialId |
string |
任意 |
メディアライブラリ内のスタンバイビデオのメディアアセット ID。このパラメーターが空に設定されている場合、デフォルトでスタンバイ構成がクリアされます。 |
a2b8e671 |
| UrgentLiveStreamUrl |
string |
任意 |
スタンバイライブストリームの URL。 |
rtmp://demo.aliyundoc.com |
| SideOutputUrl |
string |
任意 |
プロダクションスタジオのカスタムバイパス出力アドレスに対応するアップストリーミング URL。 このパラメーターが空の場合、デフォルトで Alibaba Cloud によって自動生成された出力アドレスに対応するアップストリーミング URL が使用されます。 説明
現在、SideOutputUrl はストリームアップストリーミングに RTMP プロトコルのみをサポートしています。 |
rtmp://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**** |
| SideOutputUrlList |
string |
任意 |
複数送信先リレーストリーミングアドレスのリスト。アドレスには、Alibaba Cloud またはサードパーティプロバイダーの CDN アップストリーミング URL を指定できます。1 つのプロダクションスタジオに最大 20 個の RTMP リレーアドレスを追加できます。 説明
複数のアドレスを配列フォーマットで指定します: ["rtmp://ドメイン/app1/ストリーム1","rtmp://ドメイン/app2/ストリーム2"]。 |
rtmp://domain/app/stream?*** |
| CallbackUrl |
string |
任意 |
コールバック URL。コールバック通知を受信するには、HTTP プロトコルを受け入れる有効な受信アドレスを入力してください。このパラメーターが空に設定されている場合、デフォルトでプロダクションスタジオのコールバック通知がキャンセルされます。 説明
プロダクションスタジオのコールバックの詳細については、「クラウドプロダクションスタジオのコールバック情報」を参照してください。 |
http://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**** |
| ProgramEffect |
integer |
任意 |
プログラムリストの効果があるかどうかを指定します。
|
1 |
| ProgramName |
string |
任意 |
プログラムリストの名前。このパラメーターは、プログラムリスト機能を使用する場合に設定できます。 |
program_name |
| ChannelEnable |
integer |
任意 |
チャンネルを有効にするかどうかを指定します。以前にチャンネルが有効になっていた場合（ChannelEnable=1）、チャンネルの状態を維持するために、各呼び出しで明示的に ChannelEnable=1 を渡す必要があります。そうしないと、InvalidCaster.ChannelDisableUnsupported エラーが返されます。
説明
チャンネルはデフォルトで無効になっており、一度有効にすると無効にすることはできません。チャンネルが無効になっている場合、リソースはレイアウトによって直接参照されます。初めてチャンネルを有効にするには、プロダクションスタジオを停止する必要があります。既存のレイアウトは破棄されます。まずリソースをチャンネルに割り当てる必要があり、新しいレイアウトはチャンネルを直接参照します。チャンネルを通じて、ビデオソースの再生進行状況とステータスを調整できます。このモードでは、ビデオソース、PVW、および PGM エリアが同じリソースを参照している場合、対応するビューは同期されたままになります。 |
1 |
| SyncGroupsConfig |
string |
任意 |
複数のビデオソースを同期させるマルチビュー同期構成。 マルチビュー同期には 2 つのモードがあります。
ストリーマーモード: 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 |
| AutoSwitchUrgentConfig |
string |
任意 |
自動スタンバイスイッチオーバー構成。
|
{"eofThres":3} |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| CasterId |
string |
プロダクションスタジオの ID。この ID は、プロダクションスタジオのストリームアドレスの照会、プロダクションスタジオの開始、ビデオリソースの追加、レイアウトの追加、レイアウトリストの照会、コンポーネントの追加、プログラムリストの追加などのリクエストパラメーターとして使用できます。 |
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, please check userId. | 指定された userId が無効です。パラメーター値を確認してください。 |
| 400 | InvalidCasterId.Malformed | %s, please check and try again later. | CasterId パラメーターが無効です。パラメーターを確認して再試行してください。 |
| 400 | InvalidParameter.Malformed | There are invalid parameters: %s. | 次のパラメーターが無効です: %s。 |
| 400 | IncorrectCasterStatus.Inuse | %s, please check and try again later. | プロダクションスタジオは既に有効になっています。リクエストを確認して再試行してください。 |
| 400 | MissingParameter | %s. | 必須パラメーターが不足しています。 |
| 400 | InvalidCaster.ChannelDisableUnsupported | %s, please check. | 有効なチャンネルを無効にすることはできません。 |
| 400 | IncorrectCasterStatus.EnableChannel | %s, please check and try again later. | プロダクションスタジオのステータスが EnableChannel 設定をサポートしていません。ステータスを確認して再試行してください。 |
| 403 | PermissionDenied | %s, please check and try again later. | アクセスが拒否されました。確認して再試行してください。 |
| 404 | InvalidCaster.NotFound | %s, please check and try again later. | プロダクションスタジオが存在しません。構成を確認して再試行してください。 |
| 404 | InvalidDomainName.NotFound | %s, please check and try again later. | ドメイン名が存在しません。ドメイン名を確認して再試行してください。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。