AddStudioLayout - ApsaraVideo Live

Deskripsi operasi

Anda dapat memanggil operasi ini untuk menambahkan pengaturan tata letak untuk studio produksi virtual. Operasi ini mendukung tata letak umum maupun tata letak studio.

Batas QPS

Batas permintaan per detik (QPS) untuk operasi ini adalah 10 per pengguna. Jika batas tersebut dilampaui, panggilan API Anda akan dikenai pengendalian aliran (throttled), yang dapat memengaruhi bisnis Anda. Kami menyarankan agar Anda memanggil operasi ini dengan laju yang wajar.

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

create

*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. Penting Buat studio produksi virtual terlebih dahulu. Anda dapat membuat studio produksi di Konsol atau dengan memanggil operasi API CreateCaster. Studio produksi tersebut harus berupa studio produksi virtual. Jika Anda memanggil operasi API CreateCaster untuk membuat studio produksi, gunakan nilai CasterId yang dikembalikan. Jika Anda membuat studio produksi di Konsol ApsaraVideo Live, buka halaman ApsaraVideo 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 tersebut.	a2b8e671-2fe5-4642-a2ec-bf93880e****
LayoutName	string	Yes	Nama tata letak studio.	测试布局
LayoutType	string	Yes	Tipe tata letak studio. Nilai yang valid: common: Tata letak umum. Jika Anda mengatur LayoutType ke common, Anda juga harus menentukan CommonConfig. studio: Tata letak studio. Jika Anda mengatur LayoutType ke studio, Anda juga harus menentukan BgImageConfig dan ScreenInputConfigList. Parameter MediaInputConfigList bersifat opsional.	studio
CommonConfig	string	No	Konfigurasi tata letak umum. Nilainya berupa string JSON. Untuk informasi selengkapnya, lihat CommonConfig. Penting Parameter ini wajib hanya jika Anda mengatur LayoutType ke common.	{"ChannelId":"RV01" }
BgImageConfig	string	No	Konfigurasi resource latar belakang. Nilainya berupa string JSON. Untuk informasi selengkapnya, lihat BgImageConfig. Penting Parameter ini wajib hanya jika Anda mengatur LayoutType ke studio.	{ "Id":"k12kj31**", "MaterialId":"f080575eb5f4427684fc0715159a**" }
ScreenInputConfigList	string	No	Pengaturan input chroma keying. Nilainya berupa string JSON. Untuk informasi selengkapnya, lihat ScreenInputConfig. Penting Parameter ini wajib hanya jika Anda mengatur LayoutType ke studio.	[ { "Index":"1", "ChannelId":"RV01", "Color":"green", "PositionX":"0.1", "PositionY":"0.2", "HeightNormalized":"0.4" } ]
MediaInputConfigList	string	No	Pengaturan resource input multimedia. Nilainya berupa string JSON. Untuk informasi selengkapnya, lihat MediaInputConfig. Penting Parameter ini berlaku dan bersifat opsional hanya jika Anda mengatur LayoutType ke studio.	[ { "Id":"k12kj31**", "Index":"1", "ChannelId":"RV01", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.4", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" }, { "Id":"k12kj31", "Index":"2", "ImageMaterialId":"lkajsdfsa8fd89asd8**", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.6", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" } ]
LayerOrderConfigList	string	No	Pengaturan urutan layer. Nilainya berupa string JSON. Untuk informasi selengkapnya, lihat LayerOrderConfig. Anda dapat mengurutkan material latar belakang dan material multimedia. Layer chroma keying tidak didukung. Semakin awal suatu material muncul dalam daftar, semakin rendah posisi layernya.	[ { "Type":"media", "Id":"k12kj31**" }, { "Type":"media", "Id":"k12kj31**" } ]

CommonConfig

Name	Type	Example	Description
ChannelId	String	RV01	ID channel tempat resource video disambungkan.

BgImageConfig

Catatan

Tentukan hanya salah satu dari ImageUrl atau MaterialId.

Name	Type	Example	Description
Id	String	k12kj31****	ID unik material latar belakang.
ImageUrl	String	http://aliyundoc.com	URL material.
MaterialId	String	f080575eb5f4427684fc0715159a****	ID material Video sesuai permintaan (VOD).

ScreenInputConfig

Name	Type	Example	Description
Index	Integer	1	Nomor sumber chroma keying. Parameter ini hanya untuk ditampilkan di antarmuka depan dan tidak memiliki fungsi logis. Nilainya harus berupa bilangan bulat positif lebih besar dari 0.
ChannelId	String	RV01	ID channel tempat resource video disambungkan.
Color	String	green	Warna untuk chroma keying. Nilai yang valid: blue: Latar belakang layar biru. green: Latar belakang layar hijau. auto: Deteksi otomatis. complex: Chroma keying adegan nyata.
PositionX	Float	0.1	Koordinat x. Nilainya harus berada dalam rentang [0, 1]. Titik acuan posisi material adalah pojok kiri atas.
PositionY	Float	0.2	Koordinat y. Nilainya harus berada dalam rentang [0, 1]. Titik acuan posisi material adalah pojok kiri atas.
HeightNormalized	Float	0.4	Tinggi ternormalisasi. Ini adalah rasio tinggi potret hasil keyed-out terhadap tinggi latar belakang. Nilainya harus berada dalam rentang [0, 1].

MediaInputConfig

Jika material multimedia berupa sumber video, tentukan ChannelId.
Jika material multimedia berupa citra, tentukan ImageMaterialId.
ChannelId dan ImageMaterialId saling eksklusif. Tentukan hanya salah satu.

Name	Type	Example	Description
Id	String	k12kj31****	ID unik material multimedia.
Index	Integer	1	Nomor material multimedia. Parameter ini hanya untuk ditampilkan di antarmuka depan dan tidak memiliki fungsi logis. Nilainya harus berupa bilangan bulat positif lebih besar dari 0.
ChannelId	String	RV01	ID channel tempat resource video disambungkan.
ImageMaterialId	String	lkajsdfsa8fd89asd8****	ID material citra VOD.
FillMode	String	none	Tipe pengisian. Atur ke none.
PositionRefer	String	topLeft	Titik acuan posisi material. Atur ke topLeft. Ini menunjukkan bahwa pojok kiri atas adalah titik acuan.
WidthNormalized	Float	0.4	Lebar ternormalisasi material. Ini adalah rasio lebar material terhadap lebar latar belakang. Nilainya harus berada dalam rentang [0, 1].
HeightNormalized	Float	0.4	Tinggi ternormalisasi material. Ini adalah rasio tinggi material terhadap tinggi latar belakang. Nilainya harus berada dalam rentang [0, 1].
PositionNormalized	Float	[0.1, 0.2]	Posisi ternormalisasi area isian material [x, y]. Nilai x dan y harus berada dalam rentang [0, 1]. Misalnya, [0.1, 0.2] menunjukkan offset horizontal 10% dan offset vertikal 20% dari pojok kiri atas.

LayerOrderConfig

Name	Type	Example	Description
Type	String	media	Tipe konfigurasi resource. background: Material latar belakang. media: Material multimedia.
Id	String	k12kj31****	ID unik resource.

Elemen respons

Element	Type	Description	Example
	object
LayoutId	string	ID tata letak. Gunakan ID ini untuk menghapus, mengubah, atau mengkueri tata letak studio produksi virtual.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	ID permintaan.	5c6a2a0d-f228-4a64-af62-20e91b96****

Contoh

Respons sukses

JSONformat

{
  "LayoutId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}

Kode kesalahan

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