Konfigurasi Tata Letak Studio Virtual melalui API AddStudioLayout - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Deskripsi operasi

You can call this operation to add layout settings for a virtual production studio. This operation supports both common and studio layouts.

QPS limit

The queries per second (QPS) limit for this operation is 10 per user. If you exceed this limit, your API calls are throttled. This may affect your business. We recommend that you call this operation at a reasonable rate.

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 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 Konsol ApsaraVideo Live > Studio Produksi > Cloud Production Studio. Nama studio produksi dalam daftar adalah ID-nya. Catatan Nama studio produksi dalam daftar di halaman Cloud Production Studio adalah ID studio produksi.	a2b8e671-2fe5-4642-a2ec-bf93880e****
LayoutName	string	Yes	Nama tata letak studio.	测试布局
LayoutType	string	Yes	Tipe tata letak studio. Nilai 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 lebih lanjut, lihat CommonConfig. Penting Parameter ini diperlukan hanya jika Anda mengatur LayoutType ke common. .	{"ChannelId":"RV01" }
BgImageConfig	string	No	Konfigurasi sumber daya latar belakang. Nilainya berupa string JSON. Untuk informasi lebih lanjut, lihat BgImageConfig. Penting Parameter ini diperlukan hanya jika Anda mengatur LayoutType ke studio.	{ "Id":"k12kj31**", "MaterialId":"f080575eb5f4427684fc0715159a**" }
ScreenInputConfigList	string	No	Pengaturan untuk input chroma keying. Nilainya berupa string JSON. Untuk informasi lebih lanjut, lihat ScreenInputConfig. Penting Parameter ini diperlukan 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 untuk sumber daya input multimedia. Nilainya berupa string JSON. Untuk informasi lebih lanjut, lihat MediaInputConfig. Penting Parameter ini valid dan 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 pesanan layer. Nilainya berupa string JSON. Untuk informasi lebih lanjut, lihat LayerOrderConfig. Anda dapat mengurutkan material latar belakang dan material multimedia. Layer chroma keying tidak didukung. Semakin awal material muncul dalam daftar, semakin rendah layer-nya.	[ { "Type":"media", "Id":"k12kj31**" }, { "Type":"media", "Id":"k12kj31**" } ]

CommonConfig

Nama	Tipe	Contoh	Deskripsi
ChannelId	String	RV01	ID channel tempat sumber daya video dilampirkan.

BgImageConfig

Catatan

Tentukan hanya salah satu dari ImageUrl atau MaterialId.

Nama	Tipe	Contoh	Deskripsi
Id	String	k12kj31****	ID unik material latar belakang.
ImageUrl	String	http://aliyundoc.com	URL material.
MaterialId	String	f080575eb5f4427684fc0715159a****	ID material video on demand (VOD).

ScreenInputConfig

Nama	Tipe	Contoh	Deskripsi
Index	Integer	1	Nomor sumber chroma keying. Parameter ini untuk ditampilkan di frontend dan tidak memiliki fungsi logis. Nilainya harus berupa bilangan bulat positif lebih besar dari 0.
ChannelId	String	RV01	ID channel tempat sumber daya video dilampirkan.
Color	String	green	Warna untuk chroma keying. Nilai valid: blue: Latar belakang layar biru. green: Latar belakang layar hijau. auto: Deteksi otomatis. complex: Chroma keying pemandangan nyata.
PositionX	Float	0.1	Koordinat x. Nilainya harus dalam rentang [0, 1]. Sudut kiri atas adalah titik referensi untuk posisi material.
PositionY	Float	0.2	Koordinat y. Nilainya harus dalam rentang [0, 1]. Sudut kiri atas adalah titik referensi untuk posisi material.
HeightNormalized	Float	0.4	Tinggi ternormalisasi. Ini adalah rasio tinggi potret yang di-keying terhadap tinggi latar belakang. Nilainya harus dalam rentang [0, 1].

MediaInputConfig

Jika material multimedia adalah sumber video, tentukan ChannelId.
Jika material multimedia adalah gambar, tentukan ImageMaterialId.
ChannelId dan ImageMaterialId bersifat saling eksklusif. Tentukan hanya salah satu.

Nama	Tipe	Contoh	Deskripsi
Id	String	k12kj31****	ID unik material multimedia.
Index	Integer	1	Nomor material multimedia. Parameter ini untuk ditampilkan di frontend dan tidak memiliki fungsi logis. Nilainya harus berupa bilangan bulat positif lebih besar dari 0.
ChannelId	String	RV01	ID channel tempat sumber daya video dilampirkan.
ImageMaterialId	String	lkajsdfsa8fd89asd8****	ID material gambar VOD.
FillMode	String	none	Tipe pengisian. Atur ke none.
PositionRefer	String	topLeft	Titik referensi untuk posisi material. Atur ke topLeft. Ini menunjukkan bahwa sudut kiri atas adalah titik referensi.
WidthNormalized	Float	0.4	Lebar ternormalisasi material. Ini adalah rasio lebar material terhadap lebar latar belakang. Nilainya harus dalam rentang [0, 1].
HeightNormalized	Float	0.4	Tinggi ternormalisasi material. Ini adalah rasio tinggi material terhadap tinggi latar belakang. Nilainya harus dalam rentang [0, 1].
PositionNormalized	Float	[0.1, 0.2]	Posisi ternormalisasi area pengisian material [x, y]. Nilai x dan y harus dalam rentang [0, 1]. Misalnya, [0.1, 0.2] menunjukkan offset horizontal 10% dan offset vertikal 20% dari sudut kiri atas.

LayerOrderConfig

Nama	Tipe	Contoh	Deskripsi
Type	String	media	Tipe konfigurasi sumber daya. background: Material latar belakang. media: Material multimedia.
Id	String	k12kj31****	ID unik sumber daya.

Elemen respons

Element	Type	Description	Example
	object
LayoutId	string	The layout ID. Use this ID to delete, modify, or query a virtual production studio layout.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	The request ID.	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.