DescribeCasterComponents でキャスターコンポーネントをクエリ - LIVE

プロダクションスタジオのコンポーネント一覧を照会します。

操作説明

AddCasterComponent 操作を呼び出して、プロダクションスタジオにコンポーネントを追加します。その後、この操作を呼び出して、コンポーネントの一覧を照会できます。

QPS 制限

1 ユーザーあたりのクエリ/秒 (QPS) 制限は 15 です。制限を超えると、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:DescribeCasterComponents

get

*Caster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
CasterId	string	必須	プロダクションスタジオの ID。 CreateCaster 操作を呼び出してプロダクションスタジオを作成した場合は、レスポンスの CasterId パラメーターから ID を取得します。 [LIVE コンソール] > [プロダクションスタジオ] > [クラウドプロダクションスタジオ] を選択して、クラウドプロダクションスタジオページに移動します。説明クラウドプロダクションスタジオページのリストにあるプロダクションスタジオの名前が、プロダクションスタジオ ID です。	LIVEPRODUCER_POST-cn-0pp1czt****
ComponentId	string	任意	コンポーネント ID。AddCasterComponent 操作を呼び出してコンポーネントを追加した場合は、レスポンスの ComponentId パラメーターから ID を取得します。	21926b36-7dd2-4fde-ae25-51b5bc8e****

レスポンスフィールド

フィールド	型	説明	例
	object
Components	object
Component	array<object>	コンポーネントのリスト。
	array<object>
CaptionLayerContent	object	字幕要素のプロパティ。
BorderColor	string	テキストの境界線の色。有効な値： 0x000000 ～ 0xffffff 。デフォルト値は空の文字列（""）で、これはこのパラメーターが使用されていないことを意味します。	0x000000
BorderWidthNormalized	number	テキスト境界線の正規化された幅。値はフォントサイズに基づいて計算されます： BorderWidth / FontSize 。計算された値が 16 を超える場合、値 16 が使用されます。デフォルト値： 0 。	0
Color	string	テキストの色。有効な値： 0x000000 ～ 0xffffff 。	0x000000
FontName	string	フォント。値はプリセット値である必要があります。有効な値： KaiTi：楷体 AlibabaPuHuiTi-Regular：阿里巴巴普惠体 Regular AlibabaPuHuiTi-Bold：阿里巴巴普惠体 Bold NAlibabaPuHuiTi-Light：阿里巴巴普惠体 Light NotoSansHans-Regular：Noto Sans CJK Regular NotoSansHans-Bold：Noto Sans CJK Bold NotoSansHans-Light：Noto Sans CJK Light デフォルト値： KaiTi 。	KaiTi
LineSpaceNormalized	number	行間隔。このパラメーターは、2行のテキスト間のスペースを指定します。デフォルト値： 0 。	0
LocationId	string	コンポーネントタイプが字幕の場合、このパラメーターは参照されるビデオソースの位置（チャネル ID ）を指定します。	RV01
PtsOffset	integer	字幕のプレゼンテーションタイムスタンプ（ PTS ）と音声の PTS とのずれを修正するために使用される値。有効な値： -10000 ～ +10000 。デフォルト値： 0 。	0
ShowSourceLan	boolean	ソース言語を表示するかどうかを指定します。有効な値： true：ソース言語が表示されます。 false （デフォルト）：ソース言語は表示されません。	false
SizeNormalized	number	正規化されたフォントサイズ。フォントサイズは `[font_size, output_height]` に設定されます。計算されたフォントサイズが 1024 より大きい場合、値 1024 が使用されます。デフォルト値は -1 で、これはこのパラメーターが使用されていないことを意味します。	0.1
SourceLan	string	ビデオソース音声のソース言語。有効な値： en：英語 cn （デフォルト）：中国語 es：スペイン語 ru：ロシア語	cn
TargetLan	string	ビデオソース音声のターゲット言語。有効な値： en：英語 cn （デフォルト）：中国語 es：スペイン語 ru：ロシア語	cn
WordCountPerLine	integer	1行あたりに表示する最大文字数。	15
WordSpaceNormalized	number	文字間隔。このパラメーターは、2 つの文字間のスペースを指定します。デフォルト値： 0 。	0
WordsCount	integer	表示する文字数。フォントサイズに合わせてこの値を調整できます。有効な値： 10 ～ 50 。デフォルト値： 35 。	35
ComponentId	string	コンポーネント ID 。	72d2ec7a-4cd7-4a01-974b-7cd53947****
ComponentLayer	object	コンポーネントレイヤーのサイズ、レイアウト、その他の情報。
HeightNormalized	number	レイヤー要素の正規化された高さ。要素の幅はこの高さに基づいて比例的にスケーリングされます。デフォルト値は 0 で、これは要素が元のサイズで表示されることを意味します。	0.5
PositionNormalizeds	object
Position	array	レイヤー要素の正規化された座標。 `[x, y]` の形式。デフォルト値： `[0, 0]` 。説明 x と y の値は正規化されている必要があります。
	number	値。	0.3
PositionRefer	string	要素の位置の基準点。有効な値： topLeft （デフォルト）：左上隅。 topRight：右上隅。 bottomLeft：左下隅。 bottomRight：右下隅。	topLeft
Transparency	integer	レイヤーの透明度。有効な値： 0 ～ 255 。値 0 は、レイヤーが完全に透明であることを示します。値 255 （デフォルト）は、レイヤーが完全に不透明であることを示します。	200
WidthNormalized	number	レイヤー要素の正規化された幅。要素の高さはこの幅に基づいて比例的にスケーリングされます。デフォルト値は 0 で、これは要素が元のサイズで表示されることを意味します。説明このパラメーターは HeightNormalized と競合します。両方が設定されている場合、HeightNormalized のみが有効になります。1つだけ設定した場合、後で設定した値が前の値をオーバーライドします。	0.5
ComponentName	string	コンポーネント名。デフォルト値はコンポーネント ID です。	component_name
ComponentType	string	コンポーネントタイプ。有効な値： text：テキストコンポーネント。 image：イメージコンポーネント。 caption：翻訳された字幕コンポーネント。	text
Effect	string	コンポーネントの表示効果。有効な値： none：効果なし。 animateH：水平スクロール。 animateV：垂直スクロール。	animateV
ImageLayerContent	object	イメージ要素のプロパティ。
MaterialId	string	メディアアセットの ID 。	6cf724c6ebfd4a59b5b3cec6f10d****
LocationId	string	コンポーネントの位置。各位置に設定できるコンポーネントは1つだけです。フォーマットは「 RC01 」～「 RC12 」である必要があります。	RC01
TextLayerContent	object	テキスト要素のプロパティ。
BorderColor	string	テキストの境界線の色。有効な値： 0x000000 ～ 0xffffff 。デフォルト値は空の文字列（""）で、これはこのパラメーターが使用されていないことを意味します。	0x000000
BorderWidthNormalized	number	テキスト境界線の正規化された幅。値はフォントサイズに基づいて計算されます： BorderWidth / FontSize 。計算された値が 16 を超える場合、値 16 が使用されます。デフォルト値： 0 。	0
Color	string	テキストの色。有効な値： 0x000000 ～ 0xffffff 。	0xff0000
FontName	string	フォント。値はプリセット値である必要があります。有効な値： KaiTi：楷体 AlibabaPuHuiTi-Regular：阿里巴巴普惠体 Regular AlibabaPuHuiTi-Bold：阿里巴巴普惠体 Bold NAlibabaPuHuiTi-Light：阿里巴巴普惠体 Light NotoSansHans-Regular：Noto Sans CJK Regular NotoSansHans-Bold：Noto Sans CJK Bold NotoSansHans-Light：Noto Sans CJK Light デフォルト値： KaiTi 。	KaiTi
SizeNormalized	number	正規化されたフォントサイズ。サイズは font_size / output_height に設定されます。計算されたフォントサイズが 1024 より大きい場合、値 1024 が使用されます。デフォルト値は -1 で、これはこのパラメーターが使用されていないことを意味します。	16
Text	string	テキストコンテンツ。	hello world
RequestId	string	リクエスト ID 。	3be7ade8-d907-483c-b24a-0dad45******
Total	integer	レコードの総数。	3

例

成功レスポンス

JSONJSON

{
  "Components": {
    "Component": [
      {
        "CaptionLayerContent": {
          "BorderColor": "0x000000",
          "BorderWidthNormalized": 0,
          "Color": "0x000000",
          "FontName": "KaiTi",
          "LineSpaceNormalized": 0,
          "LocationId": "RV01",
          "PtsOffset": 0,
          "ShowSourceLan": false,
          "SizeNormalized": 0.1,
          "SourceLan": "cn",
          "TargetLan": "cn",
          "WordCountPerLine": 15,
          "WordSpaceNormalized": 0,
          "WordsCount": 35
        },
        "ComponentId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
        "ComponentLayer": {
          "HeightNormalized": 0.5,
          "PositionNormalizeds": {
            "Position": [
              0.3
            ]
          },
          "PositionRefer": "topLeft",
          "Transparency": 200,
          "WidthNormalized": 0.5
        },
        "ComponentName": "component_name",
        "ComponentType": "text",
        "Effect": "animateV",
        "ImageLayerContent": {
          "MaterialId": "6cf724c6ebfd4a59b5b3cec6f10d****"
        },
        "LocationId": "RC01",
        "TextLayerContent": {
          "BorderColor": "0x000000",
          "BorderWidthNormalized": 0,
          "Color": "0xff0000",
          "FontName": "KaiTi",
          "SizeNormalized": 16,
          "Text": "hello world"
        }
      }
    ]
  },
  "RequestId": "3be7ade8-d907-483c-b24a-0dad45******",
  "Total": 3
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidCasterId.Malformed	%s, please check and try again later.
401	IllegalOperation	%s, please check and try again later.
500	InternalError	%s, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.

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

変更履歴

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