Gunakan ModifyStudioLayout API untuk memperbarui pengaturan tata letak studio - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Deskripsi operasi

You can call this operation to modify the layout of a production studio. When you modify the layout settings, pass only the parameters that you want to change.

QPS limit

The QPS limit for this operation is 10 calls per second for each user. If you exceed the limit, 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:ModifyStudioLayout

update

*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 Studio produksi harus dibuat terlebih dahulu dan harus bertipe virtual studio. Jika Anda membuat studio produksi dengan memanggil operasi CreateCaster, gunakan nilai CasterId yang dikembalikan di tanggapan. Jika Anda membuat studio produksi di Konsol ApsaraVideo Live, buka halaman Konsol ApsaraVideo Live > Production Studio > Cloud Production Studio untuk Tampilan ID. Catatan Nama studio produksi dalam daftar di halaman Cloud Production Studio adalah ID studio produksi.	a2b8e671-2fe5-4642-a2ec-bf93880e****
LayoutId	string	Yes	ID tata letak. Jika Anda menambahkan tata letak untuk studio produksi dengan memanggil operasi AddStudioLayout, gunakan nilai LayoutId yang dikembalikan di tanggapan.	445409ec-7eaa-461d-8f29-4bec2eb9****
LayoutName	string	No	Nama tata letak studio produksi.	测试布局
CommonConfig	string	No	Konfigurasi tata letak umum. Parameter ini adalah string JSON. Untuk informasi lebih lanjut, lihat CommonConfig. Penting Parameter ini diperlukan hanya ketika LayoutType diatur ke common. .	{ "ChannelId":"RV01" }
BgImageConfig	string	No	Konfigurasi Sumber daya latar belakang. Parameter ini adalah string JSON. Untuk informasi lebih lanjut, lihat BgImageConfig. Penting Parameter ini diperlukan hanya ketika LayoutType diatur ke studio. .	{ "Id":"k12kj31**", "MaterialId":"f080575eb5f4427684fc0715159a**" }
ScreenInputConfigList	string	No	Pengaturan untuk input chroma keying. Parameter ini adalah string JSON. Untuk informasi lebih lanjut, lihat ScreenInputConfig. Penting Parameter ini diperlukan hanya ketika LayoutType diatur 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. Parameter ini adalah string JSON. Untuk informasi lebih lanjut, lihat MediaInputConfig. Penting Parameter ini valid dan opsional hanya ketika LayoutType diatur 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. Parameter ini adalah string JSON. Untuk informasi lebih lanjut, lihat layerOrderConfig. Anda dapat mengurutkan materi latar belakang dan multimedia. Layer chroma keying tidak didukung. Semakin awal item 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

ImageUrl dan MaterialId bersifat saling eksklusif.

ScreenInputConfig

Nama	Tipe	Contoh	Deskripsi
Index	Integer	1	ID sumber chroma keying. ID ini digunakan untuk tampilan frontend dan tidak memiliki fungsi logis. Harus berupa bilangan bulat positif (>0).
ChannelId	String	RV01	ID channel tempat Sumber daya video dilampirkan.
Color	String	green	Domain warna chroma keying. Nilai valid: blue: Latar belakang layar biru. green: Latar belakang layar hijau. auto: Deteksi otomatis. complex: Matting adegan dunia nyata.
PositionX	Float	0.1	Parameter posisi untuk koordinat x. Nilai harus antara 0 dan 1, inklusif. Posisi materi berdasarkan sudut kiri atas sebagai titik referensi.
PositionY	Float	0.2	Parameter posisi untuk koordinat y. Nilai harus antara 0 dan 1, inklusif. Posisi materi berdasarkan sudut kiri atas sebagai titik referensi.
HeightNormalized	Float	0.4	Tinggi ternormalisasi. Ini adalah rasio tinggi potret yang di-keying terhadap latar belakang. Nilai harus antara 0 dan 1, inklusif.

MediaInputConfig

Untuk sumber video, tentukan ChannelId.
Untuk image, tentukan ImageMaterialId.
ChannelId dan ImageMaterialId bersifat saling eksklusif. Anda hanya dapat menentukan salah satu.

Nama	Tipe	Contoh	Deskripsi
Id	String	k12kj31****	ID unik materi multimedia.
Index	Integer	1	ID materi multimedia. ID ini digunakan untuk tampilan frontend dan tidak memiliki fungsi logis. Harus berupa bilangan bulat positif (>0).
ChannelId	String	RV01	ID channel tempat Sumber daya video dilampirkan.
ImageMaterialId	String	lkajsdfsa8fd89asd8****	ID materi image VOD.
FillMode	String	none	Tipe pengisian. Atur parameter ini ke none.
PositionRefer	String	topLeft	Koordinat referensi untuk posisi materi. Atur parameter ini ke topLeft untuk menggunakan sudut kiri atas sebagai titik referensi.
WidthNormalized	Float	0.4	Lebar ternormalisasi materi. Ini adalah rasio lebar materi terhadap latar belakang. Nilai harus antara 0 dan 1, inklusif.
HeightNormalized	Float	0.4	Tinggi ternormalisasi materi. Ini adalah rasio tinggi materi terhadap latar belakang. Nilai harus antara 0 dan 1, inklusif.
PositionNormalized	Float	[0.1, 0.2]	Posisi ternormalisasi [x,y] area pengisian materi. Nilai x dan y harus antara 0 dan 1, inklusif. Misalnya, nilai [0.1, 0.2] mewakili offset horizontal 10% dan offset vertikal 20% dari sudut kiri atas.

layerOrderConfig

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

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	5c6a2a0d-f228-4a64-af62-20e91b9676b3

Contoh

Respons sukses

JSONformat

{
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9676b3"
}

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	InvalidLayout.NotFound	%s, please check and 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.