StartCaster API で PVW-PGM キャスタースタジオを構築 - LIVE - Alibaba Cloud - ApsaraVideo Live

プロダクションスタジオを起動します。プレビュー (PVW) シナリオおよびプログラム (PGM) シナリオが存在しない場合、この操作によりそれらのシナリオが作成され、その後、シナリオと基盤となる音声・映像処理タスクが起動されます。

操作説明

プロダクションスタジオを起動する前に、CreateCaster 操作を呼び出してスタジオを作成してください。その後、この操作を呼び出して起動します。プレビュー (PVW) シナリオおよびプログラム (PGM) シナリオが存在しない場合、この操作によりそれらのシナリオが作成され、その後、シナリオと基盤となる音声・映像処理タスクが起動されます。

QPS 制限

この操作の秒間クエリ数 (QPS) 制限は、ユーザーあたり 1 秒間に 10 回です。この制限を超えると、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:StartCaster

update

*Caster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID です。	cn-shanghai
CasterId	string	必須	プロダクションスタジオの ID です。 CreateCaster 操作を呼び出してプロダクションスタジオを作成した場合は、応答で返された CasterId の値を使用します。 ApsaraVideo Live コンソールでプロダクションスタジオを作成した場合は、プロダクションスタジオ > クラウドプロダクションスタジオページに移動して ID を確認します。説明クラウドプロダクションスタジオページのリストに表示されるプロダクションスタジオの名前が、プロダクションスタジオ ID です。	80787064-1c94-4dc1-85ce-9409960a****

レスポンスフィールド

フィールド	型	説明	例
	object	プロダクションスタジオに関する情報です。
PgmSceneInfos	object
SceneInfo	array<object>	PGM シナリオのリストです。
	array<object>	PGM シナリオです。
SceneId	string	シナリオ ID です。	b5f8c837-ceeb-424f-b30b-68e94e86****
StreamInfos	object
StreamInfo	array<object>	バイパス出力ストリームのリストです。
	object	バイパス出力ストリームです。
OutputStreamUrl	string	再生 URL です。	rtmp://abclive/caster/example.net
TranscodeConfig	string	トランスコード構成です。有効な値は次のとおりです。 lsd：標準解像度。 lld：低解像度。 lud：超高解像度。 lhd：高解像度。	lld
VideoFormat	string	フォーマットです。有効な値は次のとおりです。 flv。 rtmp。 m3u8。	flv
StreamUrl	string	プロダクションスタジオの PGM シナリオ用再生ストリーム URL です。これはバイパス出力ストリームの URL ではありません。	rtmp://abclive/caster/example.edu
PvwSceneInfos	object
SceneInfo	array<object>	PVW シナリオのリストです。
	object	PVW シナリオです。
SceneId	string	シナリオ ID です。	b5f8c837-ceeb-424f-b30b-68e94e86****
StreamUrl	string	プロダクションスタジオの PVW シナリオ用再生ストリーム URL です。これはバイパス出力ストリームの URL ではありません。	rtmp://abclive/caster/example.net
RequestId	string	リクエスト ID です。	6EBD1AC4-C34D-4AE1-963E-B688A228BE31

例

成功レスポンス

JSONJSON

{
  "PgmSceneInfos": {
    "SceneInfo": [
      {
        "SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
        "StreamInfos": {
          "StreamInfo": [
            {
              "OutputStreamUrl": "rtmp://abclive/caster/example.net",
              "TranscodeConfig": "lld",
              "VideoFormat": "flv"
            }
          ]
        },
        "StreamUrl": "rtmp://abclive/caster/example.edu"
      }
    ]
  },
  "PvwSceneInfos": {
    "SceneInfo": [
      {
        "SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
        "StreamUrl": "rtmp://abclive/caster/example.net"
      }
    ]
  },
  "RequestId": "6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidUserId.Malformed	%s, please check userId.
400	InvalidCasterId.Malformed	%s, please check and try again later.
400	IncorrectSceneStatus	%s, please check and try again later.
400	IncorrectCasterStatus.Inuse	%s, please check and try again later.
400	IncorrectSceneStatus.Inuse	%s, please check and try again later.
400	InvalidParameter.Malformed	There are invalid parameters: %s.
400	IncorrectChannel.Disable	%s, please check and try again later.
400	IncorrectCasterStatus.Cease	%s, please check and try again later.
400	IncorrectCasterStatus.Expire	%s, please check and try again later.
401	IllegalOperation	%s, please check and try again later.
403	UserQuotaExceed	Quota exceeded: %s.
404	InvalidCaster.NotFound	%s, please check and try again later.
404	InvalidDomainName.NotFound	%s, please check and try again later.
404	InvalidCasterTemplate.NotFound	%s, please check and try again later.
404	InvalidConfiguration.NotFound	%s, please check and try again later.
404	InvalidResource.NotFound	%s, please check and try again later.
404	InvalidTranscode.NotFound	%s, please check and try again later.
404	InvalidDelay.NotFound	%s, please check and try again later.

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

変更履歴

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