制作スタジオのシーンに関する情報を照会します。

使用状況ノート

リクエストにはCasterIdパラメーターが必要です。

QPS制限

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

デバッグ

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

リクエストパラメーター

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

実行したい操作。 Set the value to DescribeCasterScenes.

CasterId String 必須 80787064-1c94-4dc1-85ce-9409960a ****

The ID of the production studio.

If you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response.

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

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

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

リージョンの ID
SceneId String 任意 b5f8c837-ceeb-424f-b30b-68e94e86 ****

シーンのID。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String CF60DB6A-7FD6-426E-9288-122CC1A52FA7

リクエストの ID です。
SceneList シーンの配列

照会されたシーンに関する情報。
Scene
SceneId String b5f8c837-ceeb-424f-b30b-68e94e86****

シーンのID。
SceneName String scene1

シーンの名前。
OutputType String 0

出力ビデオがプレビューモードかプログラムモードかを示します。 設定可能な値は以下のとおりです。

  • 0: シーンの出力ビデオがプレビューモードであることを示します。
  • 1: シーンの出力ビデオがプログラムモードであることを示します。
LayoutId String 37cb2f8b-f152-4338-b928-6704f71d ****

レイアウトのID。
StreamUrl String rtmp:// developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****

ストリーミングURL。
ComponentId List ["1506396160-0-0-7de771a77102680861853af862d5 ****"]

コンポーネントのID。
ステータス Integer 0

シーンのステータス。 設定可能な値は以下のとおりです。

  • 0: disabled.
  • 1: enabled。
StreamInfos StreamInfoの配列

ストリームに関する情報。
StreamInfo
OutputStreamUrl String http:// live/caste r/example.net

ストリーミングURL。
TranscodeConfig String lld

シーンが再生のためにストリームをトランスコードする解像度。 設定可能な値は以下のとおりです。

  • sd: 標準定義。
  • lld: 低い定義。
  • lud: 超高い定義。
  • lhd: 高解像度。
VideoFormat String flv

シーンが再生のためにストリームをトランスコードするフォーマット。 設定可能な値は以下のとおりです。

  • flv
  • mp4
  • m3u8
Total Integer 2

返されたエントリの総数。

例

リクエストの例

http(s):// live.aliyuncs.com/?Action=DescribeCasterScenes
&CasterId=80787064-1c94-4dc1-85ce-9409960a ****
&<共通リクエストパラメーター>

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

XML 形式 

<DescribeCasterScenesResponse>
  <RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>
  <Total>2</Total>
  <SceneList>
        <シーン>
              <ステータス> 0</ステータス>
              <SceneId>b5f8c837-ceeb-424f-b30b-68e94e86 ****</SceneId>
              <SceneName>scene1</SceneName>
              <LayoutId>37cb2f8b-f152-4338-b928-6704f71d ****</LayoutId>
              <StreamUrl>rtmp:// developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****</StreamUrl>
              <OutputType>0</OutputType>
              <StreamInfos>
                    <StreamInfo>
                          <OutputStreamUrl>http:// live/caste r/example.net</OutputStreamUrl>
                          <VideoFormat>flv</VideoFormat>
                          <TranscodeConfig>lld</TranscodeConfig>
                    </StreamInfo>
              </StreamInfos>
              <ComponentId>
                    <componentId>["1506396160-0-0-7de771a77102680861853af862d5 ****"]</componentId>
              </ComponentIds>
        </シーン>
  </SceneList>
</DescribeCasterScenesResponse>

JSON 形式 

{
    "DescribeCasterScenesResponse": {
        "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7" 、
        "合計": 2、
        "SceneList": {
            "シーン": {
                "Status": 0,
                "SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86 ****" 、
                "SceneName": "scene1" 、
                "LayoutId": "37cb2f8b-f152-4338-b928-6704f71d ****" 、
                "StreamUrl": "rtmp:// developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****" 、
                "OutputType": 0、
                "StreamInfos": {
                    "StreamInfo": {
                        "OutputStreamUrl": "http:// live/caste r/example.net" 、
                        "VideoFormat": "flv" 、
                        "TranscodeConfig": "lld"
                    }
                },
                "ComponentIds": {
                    "componentId": "[\" 1506396160-0-0-7de771a77102680861853af862d5 ****\"]"
                }
            }
        }
    }
}

エラーコード

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