AddCasterComponent - ApsaraVideo Live

Panggil operasi AddCasterComponent untuk menambahkan komponen ke studio produksi.

Deskripsi operasi

Sebelum memanggil operasi ini, buat studio produksi dan tinjau daftar tata letaknya. Operasi ini menambahkan komponen berupa citra, teks, dan keterangan. Untuk informasi selengkapnya tentang cara membuat studio produksi melalui API, lihat Create a production studio.

Batas QPS

Batas permintaan per detik (QPS) untuk satu pengguna adalah 10. Jika batas ini terlampaui, panggilan API akan mengalami pengendalian aliran yang dapat memengaruhi bisnis Anda. Rencanakan panggilan API sesuai kebutuhan.

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:AddCasterComponent

create

*Caster

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
CasterId	string	Yes	ID Wilayah.	LIVEPRODUCER_POST-cn-0pp1czt****
ComponentName	string	No	ID studio produksi. Jika Anda membuat studio produksi dengan memanggil operasi CreateCaster, temukan ID tersebut pada parameter CasterId dalam respons. Jika Anda membuat studio produksi di Konsol Live, buka halaman Live Console > Production Studio > Cloud Production Studio. Nama studio produksi dalam daftar tersebut merupakan ID-nya. Catatan Nama studio produksi dalam daftar pada halaman Cloud Production Studio adalah ID studio produksi.	text01
LocationId	string	Yes	Nama komponen. Nilai default-nya adalah ID komponen.	RC01
ComponentType	string	Yes	Menentukan posisi komponen. Formatnya RC01 hingga RC99. Setiap posisi hanya dapat menampung satu komponen. Catatan Jika tipe komponen adalah caption, parameter ini menentukan Lokasi dari sumber video yang dirujuk.	text
Effect	string	No	Tipe komponen. Nilai yang valid: text: Komponen teks. Parameter TextLayerContent juga diperlukan. image: Komponen citra. Parameter ImageLayerContent juga diperlukan. caption: Komponen keterangan. Parameter CaptionLayerContent juga diperlukan.	animateH
ComponentLayer	string	Yes	Efek komponen. Nilai yang valid: none (default): Tidak ada efek. animateH: Menggulir secara horizontal. animateV: Menggulir secara vertikal.	{"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]}
LayerOrder	string	No	Ukuran dan tata letak lapisan komponen. Tata letak ditentukan oleh elemen-elemen berikut: HeightNormalized: Nilai tinggi ternormalisasi. WidthNormalized: Nilai lebar ternormalisasi. PositionNormalized: Nilai posisi ternormalisasi untuk lapisan. PositionRefer: Koordinat referensi untuk posisi lapisan. Nilainya berupa string JSON. Gunakan UpperCamelCase untuk nama bidang.	cover
TextLayerContent	string	No	Urutan lapisan komponen. cover: Komponen berada di latar depan. background: Komponen berada di latar belakang.	{"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"}
ImageLayerContent	string	No	Properti elemen lapisan adalah sebagai berikut: Penting Parameter ini wajib hanya ketika ComponentType diatur ke text. SizeNormalized: Ukuran font ternormalisasi. Nilai ini dihitung sebagai font_size/output_height. Rentang nilai yang valid adalah `[0,1]`. Jika ukuran font yang dihitung dari nilai ternormalisasi melebihi 1024, ukurannya diatur ke 1024. BorderWidthNormalized: Lebar tepi teks ternormalisasi. Nilai ini dihitung berdasarkan ukuran font: BorderWidth/FontSize. Rentang nilai yang valid adalah `[0,1]`. Jika lebar yang dihitung dari nilai ternormalisasi melebihi 16, lebarnya diatur ke 16. Nilai default-nya adalah 0. FontName: Nama font. Untuk daftar font yang valid, lihat Production studio fonts. Font default-nya adalah KaiTi. BorderColor: Warna tepi teks. Nilai yang valid berkisar antara 0x000000 hingga 0xffffff. Nilai default-nya adalah string kosong (""), yang berarti tidak ada tepi yang muncul. Text: Konten teks. Nilai default-nya adalah string kosong (""). Color: Warna teks. Nilai default-nya adalah 0xff0000, yang merepresentasikan merah. Nilainya harus berupa string dalam format JSON. Nama parameter harus menggunakan UpperCamelCase.	{"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d****"}
CaptionLayerContent	string	No	Properti komponen lapisan. Penting Parameter ini wajib ketika ComponentType diatur ke image. MaterialId: ID aset media. Ini adalah nama yang diberikan kepada aset saat diunggah. Nilainya berupa string JSON. Nama parameter harus menggunakan UpperCamelCase.	{"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"}
HtmlLayerContent	string	No	Properti elemen lapisan adalah sebagai berikut: Penting Parameter ini wajib ketika ComponentType diatur ke caption. SizeNormalized: Ukuran font ternormalisasi. Nilai ini dihitung sebagai `font_size/output_height`. Rentang nilai yang valid adalah `[0,1]`, akurat hingga dua tempat desimal. Jika ukuran font yang diturunkan dari nilai ternormalisasi lebih besar dari 1024, nilainya dibatasi pada 1024. BorderWidthNormalized: Lebar tepi teks ternormalisasi, relatif terhadap ukuran font. Nilai ini dihitung sebagai `BorderWidth/FontSize`. Rentang nilai yang valid adalah `[0,1]`, akurat hingga dua tempat desimal. Jika lebar tepi yang diturunkan dari nilai ternormalisasi lebih besar dari 16, nilainya dibatasi pada 16. Nilai default-nya adalah 0. FontName: Nama font. Untuk nilai yang valid, lihat Caster font instructions. Nilai default-nya adalah "KaiTi". BorderColor: Warna tepi teks. Nilainya berupa kode warna heksadesimal yang berkisar dari `0x000000` hingga `0xffffff`. Nilai default-nya adalah string kosong `""`, yang menunjukkan bahwa tidak ada warna tepi yang diatur. LocationId: ID channel dari sumber terjemahan. SourceLan: Bahasa audio asli dari sumber video. Nilai yang valid: `en` (Inggris), `cn` (Tiongkok), `es` (Spanyol), dan `ru` (Rusia). Nilai default-nya adalah `cn`. TargetLan: Bahasa audio target untuk sumber video. Biarkan parameter ini kosong untuk hanya melakukan pengenalan ucapan. Atur parameter ini ke kode bahasa untuk menerjemahkan audio. Nilai yang valid: `en` (Inggris), `cn` (Tiongkok), `es` (Spanyol), dan `ru` (Rusia). ShowSourceLan: Menentukan apakah bahasa sumber ditampilkan dalam keterangan. Nilai yang valid: `true` dan `false`. Nilai default-nya adalah `false`. Truncation: Menentukan apakah keterangan dapat dipotong. Nilai yang valid: `true` dan `false`. Nilai default-nya adalah `false`. SourceLanPerLineWordCount: Jumlah maksimum kata per baris untuk keterangan bahasa sumber. Nilai default-nya adalah 20. TargetLanPerLineWordCount: Jumlah maksimum kata per baris untuk keterangan bahasa target. Nilai default-nya adalah 20. SourceLanReservePages: Jumlah baris yang dicadangkan untuk keterangan bahasa sumber. Parameter ini hanya berlaku ketika `Truncation` diatur ke `true`. Nilai default-nya adalah 2. TargetLanReservePages: Jumlah baris yang dicadangkan untuk keterangan bahasa target. Parameter ini hanya berlaku ketika `Truncation` diatur ke `true`. Nilai default-nya adalah 2. Nilainya harus berupa string dalam format JSON. Nama properti harus menggunakan UpperCamelCase.	{"htmlUrl":http://caster.example.com}

Font Cloud Director

Font	Nilai FontName
KaiTi	KaiTi
Alibaba PuHuiTi - Regular	AlibabaPuHuiTi-Regular
Alibaba PuHuiTi - Bold	AlibabaPuHuiTi-Bold
Alibaba PuHuiTi - Light	AlibabaPuHuiTi-Light
Source Han Sans - Regular	NotoSansHans-Regular
Source Han Sans - Bold	NotoSansHans-Bold
Source Han Sans - Light	NotoSansHans-Light

Elemen respons

Element	Type	Description	Example
	object
ComponentId	string	ID komponen. Gunakan ID ini untuk mengkueri, mengubah, atau menghapus komponen.	21926b36-7dd2-4fde-ae25-51b5bc8e****
RequestId	string	ID permintaan.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Contoh

Respons sukses

JSONformat

{
  "ComponentId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidUserId.Malformed	%s, please check userId.
400	InvalidCasterId.Malformed	%s, please check and try again later.
400	MissingParameter	%s.
400	InvalidParameter.Malformed	There are invalid parameters: %s.
400	InvalidPositionNormalized.Malformed	%s, please check and try again later.
400	DuplicateLocationID	%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.
404	CanvasNotExist	%s, please check and try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.