DescribeCasterLayouts - ApsaraVideo Live

Mengambil informasi layout dari sebuah studio produksi.

Deskripsi operasi

Anda dapat memanggil Operasi API ini untuk mengambil informasi layout dari sebuah studio produksi. Jika Anda tidak menentukan ID layout, semua layout dalam studio tersebut akan dikembalikan.

Batas QPS

Batas permintaan per detik (QPS) untuk Operasi API ini adalah 15 panggilan per detik per pengguna. Jika batas ini dilampaui, panggilan API akan dikenai pengendalian aliran, yang dapat memengaruhi operasional bisnis Anda. Oleh karena itu, sebaiknya Anda memanggil Operasi API 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:DescribeCasterLayouts

get

*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 dari studio produksi. Jika Anda membuat studio produksi dengan memanggil operasi CreateCaster, gunakan nilai CasterId yang dikembalikan dalam respons. Jika Anda membuat studio produksi di Konsol LIVE, temukan ID-nya pada halaman Production Studio > Cloud Production Studio. Catatan Nama studio produksi dalam daftar pada halaman Cloud Production Studio adalah ID studio produksi tersebut.	LIVEPRODUCER_POST-cn-0pp1czt****
LayoutId	string	No	ID layout. Jika Anda tidak memberikan nilai untuk LayoutId, semua layout dari studio produksi akan dikembalikan.	72d2ec7a-4cd7-4a01-974b-7cd53947****

Elemen respons

Element	Type	Description	Example
	object
Layouts	object
Layout	array<object>	Daftar layout.
	array<object>	Daftar layout.
AudioLayers	object
AudioLayer	array<object>	Daftar konfigurasi AudioLayer.
	object	Daftar konfigurasi AudioLayer.
FixedDelayDuration	integer	Latensi tetap untuk audio. Ini dapat digunakan untuk sinkronisasi teks. Unit: milidetik (ms). Nilai default: 0. Nilai yang valid: 0 hingga 5000.	20
ValidChannel	string	Saluran suara yang dapat digunakan untuk input audio. Nilai yang valid: leftChannel: Saluran suara kiri. rightChannel: Saluran suara kanan. all (default): Kedua saluran suara.	all
VolumeRate	number	Laju volume. Nilai 1 menunjukkan volume asli. Catatan Nilai default adalah 0. Ini menampilkan elemen dalam ukuran aslinya.	1
BlendList	object
LocationId	array	Daftar posisi terkait. Urutannya sama dengan VideoLayers.
	string	ID posisi.	RV01
LayoutId	string	ID layout.	72d2ec7a-4cd7-4a01-974b-7cd53947****
MixList	object
LocationId	array	Daftar posisi terkait. Urutannya sama dengan AudioLayers.
	string	ID posisi.	RV01
VideoLayers	object
VideoLayer	array<object>	Daftar konfigurasi VideoLayer. Urutan array default digunakan.
	array<object>	Daftar konfigurasi VideoLayer. Urutan array default digunakan.
FillMode	string	Mode pengisian elemen. Nilai yang valid: none (default): Tidak ada pengisian. Layer dikonfigurasi berdasarkan frame video. fit: Fit. Layer dikonfigurasi berdasarkan area pengisian. Frame video diskalakan dengan rasio aspek aslinya agar sesuai dengan tepi yang lebih panjang dari area pengisian dan diposisikan di tengah. Jika rasio aspek area pengisian berbeda dari frame video, layer di bawahnya akan ditampilkan di area yang tidak terisi. Jika tidak ada layer yang dikonfigurasi di bawahnya, latar belakang akan berwarna hitam.	fit
FixedDelayDuration	integer	Latensi tetap yang ditetapkan untuk video. Ini dapat digunakan untuk sinkronisasi teks. Unit: milidetik (ms). Nilai default: 0. Nilai yang valid: 0 hingga 5000.	20
HeightNormalized	number	Tinggi ternormalisasi dari elemen layer. Jika mode pengisian adalah none, lebar elemen diskalakan secara proporsional berdasarkan tinggi ini. Nilai default adalah 0, yang berarti video ditampilkan dalam ukuran aslinya. Jika mode pengisian adalah fit, parameter ini wajib diisi dan harus lebih besar dari 0. Parameter ini merepresentasikan tinggi ternormalisasi dari area pengisian.	0.5
PositionNormalizeds	object
Position	array	Posisi ternormalisasi dari elemen layer dalam format `[x,y]`. Nilai default adalah `[0,0]`. Catatan Koordinat x dan y harus ternormalisasi.
	number	Nilai.	0
PositionRefer	string	Titik referensi untuk posisi elemen. Nilai yang valid: topLeft (default): Atas kiri. topRight: Atas kanan. bottomLeft: Bawah kiri. bottomRight: Bawah kanan. center: Tengah. topCenter: Atas tengah. bottomCenter: Bawah tengah. leftCenter: Kiri tengah. rightCenter: Kanan tengah.	topLeft
WidthNormalized	number	Lebar ternormalisasi dari elemen layer. Jika mode pengisian adalah none, tinggi elemen diskalakan secara proporsional berdasarkan lebar ini. Nilai default adalah 0, yang berarti video ditampilkan dalam ukuran aslinya. Jika mode pengisian adalah fit, parameter ini wajib diisi dan harus lebih besar dari 0. Parameter ini merepresentasikan lebar ternormalisasi dari area pengisian.	0.5
RequestId	string	ID permintaan.	3be7ade8-d907-483c-b24a-0dad45****
Total	integer	Jumlah total catatan.	3

Contoh

Respons sukses

JSONformat

{
  "Layouts": {
    "Layout": [
      {
        "AudioLayers": {
          "AudioLayer": [
            {
              "FixedDelayDuration": 20,
              "ValidChannel": "all",
              "VolumeRate": 1
            }
          ]
        },
        "BlendList": {
          "LocationId": [
            "RV01"
          ]
        },
        "LayoutId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
        "MixList": {
          "LocationId": [
            "RV01"
          ]
        },
        "VideoLayers": {
          "VideoLayer": [
            {
              "FillMode": "fit",
              "FixedDelayDuration": 20,
              "HeightNormalized": 0.5,
              "PositionNormalizeds": {
                "Position": [
                  0
                ]
              },
              "PositionRefer": "topLeft",
              "WidthNormalized": 0.5
            }
          ]
        }
      }
    ]
  },
  "RequestId": "3be7ade8-d907-483c-b24a-0dad45****",
  "Total": 3
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidCasterId.Malformed	%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.