Menambahkan pengaturan tata letak untuk studio virtual.
Deskripsi operasi
Menambahkan pengaturan tata letak untuk studio virtual. Operasi ini saat ini mendukung tipe tata letak studio berikut: tata letak umum dan tata letak studio.
Batas QPS
Batas QPS untuk satu pengguna adalah 10 panggilan per detik. Jika batas terlampaui, panggilan API akan dibatasi (throttled), yang dapat memengaruhi layanan Anda. Panggil operasi ini dengan frekuensi yang wajar.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
live:AddStudioLayout |
create |
*Caster.
|
None | 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 studio virtual. Anda dapat membuat studio produksi di konsol atau dengan memanggil operasi CreateCaster. Pastikan untuk memilih tipe studio virtual.
Catatan
Nama studio produksi dalam daftar studio produksi pada halaman Cloud Production Studios adalah ID studio produksi. |
a2b8e671-2fe5-4642-a2ec-bf93880e**** |
| LayoutName |
string |
Yes |
Nama tata letak studio. |
Test layout |
| LayoutType |
string |
Yes |
Tipe tata letak studio. Nilai valid:
|
studio |
| CommonConfig |
string |
No |
Konfigurasi tata letak umum. Nilai harus berupa string JSON. Untuk informasi lebih lanjut, lihat CommonConfig. Penting Parameter ini hanya diperlukan ketika parameter permintaan LayoutType diatur ke common.
|
{"ChannelId":"RV01" } |
| BgImageConfig |
string |
No |
Konfigurasi resource latar belakang. Nilai harus berupa string JSON. Untuk informasi lebih lanjut, lihat BgImageConfig. Penting Parameter ini hanya diperlukan ketika parameter permintaan LayoutType diatur ke studio.
|
{ "Id":"k12kj31****", "MaterialId":"f080575eb5f4427684fc0715159a****" } |
| ScreenInputConfigList |
string |
No |
Pengaturan input chroma keying. Nilai harus berupa string JSON. Untuk informasi lebih lanjut, lihat ScreenInputConfig. Penting Parameter ini hanya diperlukan ketika parameter permintaan LayoutType diatur ke studio.
|
[ { "Index":"1", "ChannelId":"RV01", "Color":"green", "PositionX":"0.1", "PositionY":"0.2", "HeightNormalized":"0.4" } ] |
| MediaInputConfigList |
string |
No |
Pengaturan resource input multimedia. Nilai harus berupa string JSON. Untuk informasi lebih lanjut, lihat MediaInputConfig. Penting Parameter ini valid dan bersifat opsional hanya ketika parameter permintaan 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 urutan layer. Nilai harus berupa string JSON. Untuk informasi lebih lanjut, lihat layerOrderConfig. Anda dapat mengurutkan material latar belakang dan material multimedia. Layer chroma keying tidak didukung. Layer yang muncul lebih awal dalam daftar ditempatkan pada level yang lebih rendah. |
[ { "Type":"media", "Id":"k12kj31****" }, { "Type":"media", "Id":"k12kj31****" } ] |
CommonConfig
| Parameter | Tipe | Contoh | Deskripsi |
| ChannelId | String | RV01 | ID posisi channel tempat resource video terikat. |
BgImageConfig
Anda hanya dapat menentukan salah satu dari parameter ImageUrl dan MaterialId.
| Parameter | 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
| Parameter | Tipe | Contoh | Deskripsi |
| Index | Integer | 1 | Nomor sumber chroma keying. Parameter ini digunakan untuk tampilan frontend dan tidak memiliki efek logis. Nilai harus berupa bilangan bulat positif lebih besar dari 0. |
| ChannelId | String | RV01 | ID posisi channel tempat resource video terikat. |
| Color | String | green | Warna chroma key. Nilai valid: blue: latar belakang layar biru. green: latar belakang layar hijau. auto: pengenalan otomatis. complex: keying latar nyata. |
| PositionX | Float | 0.1 | Koordinat X posisi. Nilai valid: [0,1]. Sudut kiri atas digunakan sebagai titik referensi untuk posisi material. |
| PositionY | Float | 0.2 | Koordinat Y posisi. Nilai valid: [0,1]. Sudut kiri atas digunakan sebagai titik referensi untuk posisi material. |
| HeightNormalized | Float | 0.4 | Nilai tinggi ternormalisasi, yaitu rasio tinggi potret yang di-key terhadap tinggi latar belakang. Nilai valid: [0,1]. |
MediaInputConfig
Jika material multimedia adalah sumber video, tentukan ChannelId.
Jika material multimedia adalah gambar, tentukan ImageMaterialId.
ChannelId dan ImageMaterialId saling eksklusif. Tentukan hanya salah satunya.
| Parameter | Tipe | Contoh | Deskripsi |
| Id | String | k12kj31**** | ID unik material multimedia. |
| Index | Integer | 1 | Nomor material multimedia. Parameter ini digunakan untuk tampilan frontend dan tidak memiliki efek logis. Nilai harus berupa bilangan bulat positif lebih besar dari 0. |
| ChannelId | String | RV01 | ID posisi channel tempat resource video terikat. |
| ImageMaterialId | String | lkajsdfsa8fd89asd8**** | ID material gambar VOD. |
| FillMode | String | none | Mode pengisian. Atur nilai ke none. |
| PositionRefer | String | topLeft | Nilai koordinat referensi untuk posisi material. Atur nilai ke topLeft, yang menunjukkan bahwa sudut kiri atas digunakan sebagai titik referensi untuk pengaturan posisi. |
| WidthNormalized | Float | 0.4 | Nilai lebar ternormalisasi material, yaitu rasio lebar material terhadap lebar latar belakang. Nilai valid: [0,1]. |
| HeightNormalized | Float | 0.4 | Nilai tinggi ternormalisasi material, yaitu rasio tinggi material terhadap tinggi latar belakang. Nilai valid: [0,1]. |
| PositionNormalized | Float | [0.1, 0.2] | Nilai posisi ternormalisasi [x,y] dari area pengisian untuk material. Nilai valid untuk x dan y: [0,1]. Sebagai contoh, [0.1,0.2] menunjukkan offset horizontal sebesar 10% dan offset vertikal sebesar 20% dari sudut kiri atas. |
LayerOrderConfig
| Parameter | Tipe | Contoh | Deskripsi |
| Type | String | media | Tipe konfigurasi resource. Nilai valid: 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. Anda dapat menggunakan ID ini sebagai parameter permintaan saat menghapus, mengubah, atau mengkueri tata letak studio 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 |
Description |
|---|---|---|---|
| 400 | MissingParameter | %s. | Parameter yang diperlukan tidak ada. |
| 400 | InvalidParameter.Malformed | There are invalid parameters: %s. | Terdapat parameter yang tidak valid: %s. |
| 400 | InvalidCasterId.Malformed | %s, please check and try again later. | Parameter CasterId tidak valid. Periksa parameter dan coba lagi. |
| 400 | InvalidUserId.Malformed | %s, please check userId. | ID pengguna tidak valid. |
| 400 | InvalidPositionNormalized.Malformed | %s, please check and try again later. | Parameter PositionNormalized tidak valid. Periksa parameter tersebut dan coba lagi. |
| 400 | InvalidHeightOrWidthNormalized | %s, please check and try again later. | Parameter HeightNormalized atau WidthNormalized tidak valid. |
| 401 | IllegalOperation | %s, please check and try again later. | Anda tidak memiliki izin yang cukup untuk operasi ini. Hubungi administrator Anda untuk mengonfigurasi izin akses. |
| 500 | InternalError | %s, please try again later. | Terjadi error internal. Coba lagi. Jika error tetap muncul setelah beberapa kali percobaan ulang, kirim tiket. |
| 404 | InvalidCaster.NotFound | %s, please check and try again later. | Studio produksi tidak ada. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.