Queries the configurations of a production studio.

Usage note

照会されるこの制作スタジオは作成されている必要があります。

QPS制限

A single user can perform a maximum of 15 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. スロットルはビジネスに影響を与える可能性があります。 Thus, we recommend that you observe the QPS limit on this operation. シングルユーザーの意味とQPSの詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。

デバッグ

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

リクエストパラメーター

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

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

CasterId String 必須 LIVEPRODUCER_POST-cn-0pp1czt ****

制作スタジオのID。

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

If you create a production studio through the ApsaraVideo Live Console, log in to the console, then check the ID of the production studio through the following path:

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

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

リージョンの ID

レスポンスパラメーター

パラメーター データ型 例 説明
CallbackUrl String http://learn.aliyundoc.com/callBackLive

The callback URL.
CasterId String LIVEPRODUCER_POST-cn-0pp1czt****

制作スタジオのID。
CasterName String liveCaster ****

The name of the production studio.
ChannelEnable Integer 1

プロダクションスタジオでチャンネルが有効になっているかどうかを示します。 設定可能な値は以下のとおりです。

  • 0: チャンネルは無効です。
  • 1: Channels are enabled.
遅延 Float 0

Indicates whether stream delay is enabled. (単位：秒)

  • 0の値は、ストリーム遅延が無効になっていることを示します。
  • 0より大きい値は遅延期間を示します。
DomainName String example.com

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

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

  • 0: カルーセル再生は無効です。
  • 1: カルーセル再生が有効になっています。
プログラム名 String program_name

カルーセル再生のエピソードリストの名前。
RecordConfig Struct

このパラメーターを指定しない場合、記録機能は無効になります。
OssBucket String liveBucket ****

プロダクションスタジオのファイルを格納するために使用されるObject Storage Service (OSS) バケット。
OssEndpoint String oss-cn-shanghai.aliyuncs.com

OSSのエンドポイント。
RecordFormat RecordFormatの配列

録音の構成。
RecordFormat
CycleDuration Integer 3600

録音時間。
形式 String m3u8

The format of the recorded file.
OssObjectPrefix String レコード /{AppName}/{StreamName}

記録されたファイルの名前。
SliceOssObjectPrefix String record/{AppName}/{StreamName}/{UnixTimestamp}

メディアセグメントファイルの名前。
RequestId String 97df6b7f-3490-47d2-ac50-8833e1b64597

リクエストの ID です。
SideOutputUrl String rtmp:// **** -developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****

カスタムスタンバイURL。
TranscodeConfig Struct

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

制作スタジオのトランスコードテンプレート。 設定可能な値は以下のとおりです。

  • lp_ld: トランスコードテンプレートによって生成されたビデオは低解像度です。
  • lp_sd: トランスコードテンプレートによって生成された動画は標準定義です。
  • lp_hd: トランスコードテンプレートによって生成されたビデオは高解像度です。
  • lp_ud: トランスコードテンプレートによって生成されたビデオは超高解像度です。
  • lp_ld_v: Videos generated by the transcoding template are in the low definition and in portrait mode.
  • lp_sd_v: トランスコードテンプレートによって生成されたビデオは、標準定義とポートレートモードです。
  • lp_hd_v: トランスコードテンプレートによって生成されたビデオは、高解像度およびポートレートモードです。
  • lp_ud_v: トランスコードテンプレートによって生成されたビデオは、超高解像度およびポートレートモードです。
LiveTemplateIds List lld

live-to-VODテンプレートの設定。 設定可能な値は以下のとおりです。

  • lsd: live-to-VODテンプレートによって生成されたビデオは標準定義です。
  • lld: live-to-VODテンプレートによって生成されたビデオは低解像度です。
  • lud: live-to-VODテンプレートによって生成されたビデオは、超高解像度です。
  • lhd: live-to-VODテンプレートによって生成されたビデオは高解像度です。
  • daobo-lsd: live-to-VODテンプレートによって生成されたビデオは、標準定義とポートレートモードです。
  • daobo-lld: live-to-VODテンプレートによって生成されたビデオは、低解像度でポートレートモードです。
  • daobo-lud: live-to-VODテンプレートによって生成されたビデオは、超高解像度とポートレートモードです。
  • daobo-lhd: live-to-VODテンプレートによって生成されたビデオは、高解像度とポートレートモードです。
UrgentMaterialId String 98646538-bcf9-4aef-bd4a-e6bb76588 ****

スタンバイビデオとして使用されるメディアライブラリの素材のID。

例

リクエストの例

http(s):// live.aliyuncs.com/?Action=DescribeCasterConfig
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt ****
&<共通リクエストパラメーター>

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

XML 形式 

<DescribeCasterConfigResponse>
      <RequestId>97df6b7f-3490-47d2-ac50-8833e1b64597</RequestId>
      <CasterName>liveCaster ****</CasterName>
      <DomainNam e>example.com</DomainName>
      <TranscodeConfig>
            <CasterTemplate>lp_hd</CasterTemplate>
            <LiveTemplate>lld</LiveTemplate>
      </TranscodeConfig>
      <Delay>0</Delay>
      <RecordConfig>
            <Endpoin t>live-cn-shanghai.aliyuncs.com</Endpoint>
            <OssBucket>liveBucket ****</OssBucket>
            <VideoFormat>
                  <フォーマット> flv</フォーマット>
                  <Prefix> レコード /{AppName}/{StreamName}</Prefix>
                  <SlicePrefix> レコード /{AppName}/{StreamName}/{UnixTimestamp}</SlicePrefix>
                  <間隔> 3600</間隔>
            </VideoFormat>
            <VideoFormat>
                  <フォーマット> m3u8</フォーマット>
                  <Prefix> レコード /{AppName}/{StreamName}</Prefix>
                  <SlicePrefix> レコード /{AppName}/{StreamName}/{UnixTimestamp}</SlicePrefix>
                  <間隔> 3600</間隔>
            </VideoFormat>
      </RecordConfig>
</DescribeCasterConfigResponse>

JSON 形式 

{
  "RequestId": "97df6b7f-3490-47d2-ac50-8833e1b64597",
      "CasterName": "liveCaster ****" 、
      "DomainName": "example.com",
      "TranscodeConfig": {
          "CasterTemplate": "lp_hd" 、
          "LiveTemplate": [
              "lld"
          ]
      },
      "遅延": 0、
      "RecordConfig": {
          "エンドポイント": "live-cn-shanghai.aliyuncs.com" 、
          "OssBucket": "liveBucket ****" 、
          "VideoFormat": [
              {
                  "フォーマット":"flv" 、
                  "Prefix": "record/{AppName}/{StreamName}" 、
                  "SlicePrefix":"record/{AppName}/{StreamName}/{UnixTimestamp}" 、
                  "インターバル":3600
               },
              {
                  "フォーマット":"m3u8" 、
                  "Prefix": "record/{AppName}/{StreamName}" 、
                  "SlicePrefix":"record/{AppName}/{StreamName}/{UnixTimestamp}" 、
                  "インターバル":3600
               }
          ]
      }
}

エラーコード

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