制作スタジオにエピソードを追加します。

使用状況ノート

エピソードが追加されるプロダクションスタジオが作成されている必要があります。 方法については、CreateCasterを参照してください。

QPS制限

A single user can perform a maximum of 4 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. したがって、この操作のQPS制限を遵守することをお勧めします。 シングルユーザーの意味とQPSの詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 AddCasterEpisode

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

CasterId String 必須 9ff2d96b-37ef-40a3-8cb0-4c7b1e2e ****

制作スタジオのID。

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

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

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

CasterIdは、Production Studio Managementページの [名前] 列に反映されます。
EndTime String 必須 2016-06-29T09:10:00Z

エピソードが終了する時間。 ISO 8601標準のyyyy-MM-dd T HH:mm:ss Z形式で時刻を指定します。 時刻はUTCである必要があります。

EpisodeType String 必須 リソース

エピソードのタイプ。 設定可能な値は以下のとおりです。

  • Resource: ビデオリソース。
  • Component: コンポーネント。
StartTime String 必須 2016-06-29T08:00:00Z

エピソードが始まる時間。 ISO 8601標準のyyyy-MM-dd T HH:mm:ss Z形式で時刻を指定します。 時刻はUTCである必要があります。

SwitchType String 必須 TimeFirst

エピソードを切り替えるためのポリシー。 設定可能な値は以下のとおりです。

  • TimeFirst: エピソードは前のエピソードの終了時に開始し、次のエピソードの開始時に終了します。 次のエピソードが存在しない場合、新しいエピソードが追加されるか、制作スタジオが停止するまで、エピソードは繰り返し続けます。
  • ContentFirst: エピソードは予定通りに開始および終了します。

このパラメーターは、EpisodeTypeパラメーターがResourceに設定されている場合にのみ有効です。

ビデオリソースがライブストリームの場合、このパラメーターはTimeFirstに設定する必要があります。
RegionId String 任意 cn-shanghai

リージョンの ID

EpisodeName String 任意 episode_1

エピソードの名前。

ResourceId String 任意 a2b8e671-2fe5-4642-a2ec-bf93880e ****

ビデオリソースのID。 AddCasterVideoResource 操作を呼び出したときの応答に含まれます。

このパラメーターは有効で、EpisodeTypeパラメーターがResourceに設定されている場合にのみ必要です。

ComponentId.N RepeatList 任意 ["a2b8e671-2fe5-4642-a2ec-bf93880e ****"]

コンポーネントのID。 AddCasterComponent 操作を呼び出したときの応答に含まれます。 制作スタジオのコンポーネントは、配列の下から上にリストされます。

  • このパラメーターは有効で、EpisodeTypeパラメーターがComponentに設定されている場合に必要です。
  • EpisodeTypeパラメーターがResourceに設定されている場合、このパラメーターはオプションです。 この場合、このパラメーターを指定すると、コンポーネントはビデオリソースとバインドされ、一緒に切り替えられます。
The variable N indicates the sequence number of the component. For example, the ComponentId.1 parameter specifies the ID of the first component. ComponentId.2パラメーターは、2番目のコンポーネントのIDを指定します。

レスポンスパラメーター

パラメーター データ型 説明
EpisodeId String 21926b36-7dd2-4fde-ae25-51b5bc8e ****

追加されたエピソードのID。 追加されるエピソードの管理に使用できるIDを記録します。

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

リクエストの ID です。

リクエストの例

http(s):// live.aliyuncs.com/?Action=AddCasterEpisode
&CasterId=9ff2d96b-37ef-40a3-8cb0-4c7b1e2e ****
&EndTime=2016-06-29T09:10:00Z
&EpisodeType=リソース
&StartTime=2016-06-29T08:00:00Z
&SwitchType=TimeFirst
&<共通リクエストパラメーター>

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

XML 形式

<AddCasterEpisodeResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
      <EpisodeId>21926b36-7dd2-4fde-ae25-51b5bc8e ****</EpisodeId>
</AddCasterEpisodeResponse>

JSON 形式

{
    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
    "EpisodeId": "21926b36-7dd2-4fde-ae25-51b5bc8e52d8"
}

エラーコード

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