Kueri Komponen Caster dengan DescribeCasterComponents-ApsaraVideo Live-Alibaba Cloud - ApsaraVideo Live

Mengkueri daftar komponen untuk studio produksi.

Deskripsi operasi

Call the AddCasterComponent operation to add components to a production studio. You can then call this operation to query the list of components.

QPS limit

The queries per second (QPS) limit for a single user is 15. If you exceed the limit, API calls are throttled. This may affect your business, so ensure that you call this operation within the limit.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeCasterComponents

get

*Caster

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-shanghai
CasterId	string	Yes	ID studio produksi. Jika Anda membuat studio produksi dengan memanggil operasi CreateCaster, dapatkan ID dari parameter CasterId di tanggapan. Jika Anda membuat studio produksi di konsol LIVE, buka halaman Cloud Production Studio dengan memilih Konsol LIVE > Production Studio > Cloud Production Studio. Catatan Nama studio produksi dalam daftar di halaman Cloud Production Studio adalah ID studio produksi.	LIVEPRODUCER_POST-cn-0pp1czt****
ComponentId	string	No	ID komponen. Jika Anda menambahkan komponen dengan memanggil operasi AddCasterComponent, dapatkan ID dari parameter ComponentId di tanggapan.	21926b36-7dd2-4fde-ae25-51b5bc8e****

Elemen respons

Element	Type	Description	Example
	object
Components	object
Component	array<object>	The list of components.
	array<object>
CaptionLayerContent	object	The properties of the caption element.
BorderColor	string	The color of the text border. Valid values: 0x000000 to 0xffffff. The default value is an empty string (""), which means this parameter is not used.	0x000000
BorderWidthNormalized	number	The normalized width of the text border. The value is calculated based on the font size: BorderWidth/FontSize. If the calculated value exceeds 16, the value 16 is used. Default value: 0.	0
Color	string	The color of the text. Valid values: 0x000000 to 0xffffff.	0x000000
FontName	string	The font. The value must be a preset value. Valid values: KaiTi: KaiTi AlibabaPuHuiTi-Regular: Alibaba PuHuiTi Regular AlibabaPuHuiTi-Bold: Alibaba PuHuiTi Bold NAlibabaPuHuiTi-Light: Alibaba PuHuiTi Light NotoSansHans-Regular: Noto Sans CJK Regular NotoSansHans-Bold: Noto Sans CJK Bold NotoSansHans-Light: Noto Sans CJK Light Default value: KaiTi.	KaiTi
LineSpaceNormalized	number	The line spacing. This parameter specifies the space between two lines of text. Default value: 0.	0
LocationId	string	If the component type is caption, this parameter specifies the location of the referenced video source (the channel ID).	RV01
PtsOffset	integer	The value used to correct the drift between the presentation timestamp (PTS) of the caption and the PTS of the audio. Valid values: -10000 to +10000. Default value: 0.	0
ShowSourceLan	boolean	Specifies whether to display the source language. Valid values: true: The source language is displayed. false (default): The source language is not displayed.	false
SizeNormalized	number	The normalized font size. The font size is set to `[font_size,output_height]`. If the calculated font size is greater than 1024, the value 1024 is used. The default value is -1, which means this parameter is not used.	0.1
SourceLan	string	The source language of the video source audio. Valid values: en: English cn (default): Chinese es: Spanish ru: Russian	cn
TargetLan	string	The target language of the video source audio. Valid values: en: English cn (default): Chinese es: Spanish ru: Russian	cn
WordCountPerLine	integer	The maximum number of characters to display per line.	15
WordSpaceNormalized	number	The character spacing. This parameter specifies the space between two characters. Default value: 0.	0
WordsCount	integer	The number of characters to display. You can adjust this value along with the font size. Valid values: 10 to 50. Default value: 35.	35
ComponentId	string	The component ID.	72d2ec7a-4cd7-4a01-974b-7cd53947****
ComponentLayer	object	The size, layout, and other information of the component layer.
HeightNormalized	number	The normalized height of the layer element. The width of the element is scaled proportionally based on this height. The default value is 0, which means the element is displayed in its original size.	0.5
PositionNormalizeds	object
Position	array	The normalized coordinates of the layer element, in the format `[x,y]`. Default value: `[0,0]`. Catatan The values of x and y must be normalized.
	number	The value.	0.3
PositionRefer	string	The reference point for the element's position. Valid values: topLeft (default): The top-left corner. topRight: The top-right corner. bottomLeft: The bottom-left corner. bottomRight: The bottom-right corner.	topLeft
Transparency	integer	The transparency of the layer. Valid values: 0 to 255. A value of 0 indicates that the layer is fully transparent. A value of 255 (default) indicates that the layer is fully opaque.	200
WidthNormalized	number	The normalized width of the layer element. The height of the element is scaled proportionally based on this width. The default value is 0, which means the element is displayed in its original size. Catatan This parameter conflicts with HeightNormalized. If both are set, only HeightNormalized takes effect. If you set only one, the value set later overrides the previous one.	0.5
ComponentName	string	The component name. The default value is the component ID.	component_name
ComponentType	string	The component type. Valid values: text: Text component. image: Image component. caption: Translated caption component.	text
Effect	string	The display effect of the component. Valid values: none: No effect. animateH: Horizontal scroll. animateV: Vertical scroll.	animateV
ImageLayerContent	object	The properties of the image element.
MaterialId	string	The ID of the media asset.	6cf724c6ebfd4a59b5b3cec6f10d****
LocationId	string	The position of the component. You can set only one component for each position. The format must be "RC01" to "RC12".	RC01
TextLayerContent	object	The properties of the text element.
BorderColor	string	The color of the text border. Valid values: 0x000000 to 0xffffff. The default value is an empty string (""), which means this parameter is not used.	0x000000
BorderWidthNormalized	number	The normalized width of the text border. The value is calculated based on the font size: BorderWidth/FontSize. If the calculated value exceeds 16, the value 16 is used. Default value: 0.	0
Color	string	The color of the text. Valid values: 0x000000 to 0xffffff.	0xff0000
FontName	string	The font. The value must be a preset value. Valid values: KaiTi: KaiTi AlibabaPuHuiTi-Regular: Alibaba PuHuiTi Regular AlibabaPuHuiTi-Bold: Alibaba PuHuiTi Bold NAlibabaPuHuiTi-Light: Alibaba PuHuiTi Light NotoSansHans-Regular: Noto Sans CJK Regular NotoSansHans-Bold: Noto Sans CJK Bold NotoSansHans-Light: Noto Sans CJK Light Default value: KaiTi.	KaiTi
SizeNormalized	number	The normalized font size. The size is set to font_size/output_height. If the calculated font size is greater than 1024, the value 1024 is used. The default value is -1, which means this parameter is not used.	16
Text	string	The text content.	hello world
RequestId	string	The request ID.	3be7ade8-d907-483c-b24a-0dad45******
Total	integer	The total number of records.	3

Contoh

Respons sukses

JSONformat

{
  "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
}

Kode kesalahan

HTTP status code	Error code	Error message
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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.