Konfigurasi Production Studio melalui SetCasterConfig - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Mengonfigurasi pengaturan detail untuk studio produksi, termasuk nama, konfigurasi transkoding, konfigurasi rekaman, dan parameter lainnya.

Deskripsi operasi

Buat studio produksi dengan memanggil operasi CreateCaster terlebih dahulu, lalu panggil operasi ini untuk mengonfigurasi pengaturan detail studio produksi.

Peringatan Operasi ini sepenuhnya menggantikan konfigurasi yang ada. Jika Anda mengatur parameter menjadi kosong, konfigurasi yang ada dari parameter tersebut di studio produksi akan dihapus.

Batas QPS

Batas QPS per pengguna tunggal untuk operasi ini adalah 10 panggilan per detik. Jika batas ini terlampaui, panggilan API akan dibatasi (throttled), yang dapat memengaruhi bisnis Anda. Panggil operasi ini dengan tepat.

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

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. Jika Anda membuat studio produksi dengan memanggil operasi CreateCaster, periksa nilai CasterId yang dikembalikan oleh operasi CreateCaster. Jika Anda membuat studio produksi di Konsol ApsaraVideo Live, buka Konsol ApsaraVideo Live > Studio Produksi > Cloud Production Studio untuk melihat ID. Catatan Nama studio produksi dalam daftar studio produksi pada halaman Cloud Production Studio di Konsol ApsaraVideo Live adalah ID studio produksi.	a2b8e671-2fe5-4642-a2ec-bf93880e****
CasterName	string	No	Nama studio produksi.	liveCaster****
DomainName	string	No	Domain streaming utama. Selesaikan konfigurasi nama domain sebelum memulai studio produksi. Jika parameter ini kosong, konfigurasi nama domain studio produksi akan dihapus secara default.	example.com
TranscodeConfig	string	No	Konfigurasi transkoding. String berformat JSON. Gunakan upper camel case untuk bidang internal struct. Jika parameter ini diatur menjadi kosong, konfigurasi transkoding akan dihapus secara default. Jika template transkoding kosong, error akan dikembalikan saat studio produksi dimulai.	{"casterTemplate": "lp_ld"}
RecordConfig	string	No	Konfigurasi rekaman dalam format JSON. Elemen konfigurasinya adalah sebagai berikut: endpoint: titik akhir API layanan Alibaba Cloud. ossBucket: nama bucket OSS. videoFormat: format file video yang didukung untuk ekspor. Contoh: `[{\"OssObjectPrefix\":\"Catatan/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"m3u8\",\"CycleDuration\":21600,\"SliceOssObjectPrefix\":\"Catatan/{AppName}/{StreamName}/{UnixTimestamp}\"},{\"OssObjectPrefix\":\"Catatan/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"flv\",\"CycleDuration\":21600}]`. interval: interval waktu, dalam milidetik (ms). Catatan Jika parameter ini diatur menjadi kosong, fitur rekaman tidak diaktifkan. Jika parameter ini diatur menjadi kosong, konfigurasi rekaman akan dihapus secara default.	{ "endpoint": "http://oss-cn-******.aliyuncs.com/api", "ossBucket": "liveBucket**", "VideoFormat":[{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"m3u8\",\"CycleDuration\":21600,\"SliceOssObjectPrefix\":\"record/{AppName}/{StreamName}/{UnixTimestamp}\"},{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"flv\",\"CycleDuration\":21600}] "interval": 5 }
Delay	number	No	Penundaan aliran, dalam detik. 0 (default): menonaktifkan penundaan aliran. Lebih besar dari 0: mengaktifkan penundaan aliran. Kosong: menghapus konfigurasi penundaan aliran secara default. Catatan Nilai maksimum adalah 300 detik.	0
UrgentMaterialId	string	No	ID aset media untuk video cadangan di pustaka media. Jika parameter ini diatur menjadi kosong, konfigurasi cadangan akan dihapus secara default.	a2b8e671
UrgentLiveStreamUrl	string	No	URL aliran langsung cadangan.	rtmp://demo.aliyundoc.com
SideOutputUrl	string	No	URL ingest yang sesuai dengan alamat output bypass kustom studio produksi. Jika parameter ini kosong, URL ingest yang sesuai dengan alamat output yang dibuat otomatis oleh Alibaba Cloud akan digunakan secara default. Catatan Saat ini, SideOutputUrl hanya mendukung protokol RTMP untuk pengambilan aliran.	rtmp://**/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**
SideOutputUrlList	string	No	Daftar alamat relay aliran multi-tujuan. Alamat dapat berupa URL ingest CDN dari Alibaba Cloud atau penyedia pihak ketiga. Maksimal 20 alamat relay RTMP dapat ditambahkan ke satu studio produksi. Catatan Tentukan beberapa alamat dalam format array: ["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"].	rtmp://domain/app/stream?***
CallbackUrl	string	No	URL callback. Untuk menerima notifikasi callback, masukkan alamat penerima yang valid yang menerima protokol HTTP. Jika parameter ini diatur menjadi kosong, notifikasi callback untuk studio produksi akan dibatalkan secara default. Catatan Untuk informasi lebih lanjut tentang callback studio produksi, lihat Informasi callback cloud production studio.	http://**/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**
ProgramEffect	integer	No	Apakah daftar program berlaku. 0: tidak berlaku. 1: berlaku.	1
ProgramName	string	No	Nama daftar program. Parameter ini dapat dikonfigurasi saat fitur daftar program digunakan.	program_name
ChannelEnable	integer	No	Apakah akan mengaktifkan saluran. Jika saluran sebelumnya diaktifkan (ChannelEnable=1), Anda harus secara eksplisit meneruskan ChannelEnable=1 di setiap panggilan untuk mempertahankan status saluran. Jika tidak, error InvalidCaster.ChannelDisableUnsupported akan dikembalikan. 0 (default): dinonaktifkan. 1: diaktifkan. Catatan Saluran dinonaktifkan secara default dan tidak dapat dinonaktifkan setelah diaktifkan. Saat saluran dinonaktifkan, sumber daya direferensikan langsung oleh layout. Untuk mengaktifkan saluran untuk pertama kalinya, studio produksi harus dihentikan. Layout yang ada akan dibuang. Sumber daya harus terlebih dahulu ditetapkan ke saluran, dan layout baru mereferensikan saluran secara langsung. Melalui saluran, Anda dapat menyesuaikan progres pemutaran dan status sumber video. Dalam mode ini, jika area sumber video, PVW, dan PGM mereferensikan sumber daya yang sama, tampilan yang bersangkutan tetap tersinkronisasi.	1
SyncGroupsConfig	string	No	Konfigurasi sinkronisasi multi-tampilan yang menyinkronkan beberapa sumber video. Sinkronisasi multi-tampilan memiliki dua mode: mode: 0 (mode Streamer. Beberapa sumber video disinkronkan berdasarkan mode yang ditentukan.) mode: 1 (mode konferensi. Tidak ada konsep video Streamer. Semua sumber video disinkronkan satu sama lain.) Mode Streamer: hostResourceId: sumber video Streamer dalam mode Streamer. Mode konferensi: bidang hostResourceId tidak diperlukan. Hanya ID sumber daya dalam resourceIds yang perlu disediakan.	"[{\"mode\":0,\"resourceIds\":[\"5a6c1c33-8424-46f6-813c-c152220a**\",\"4e6521dc-a40a-4077-b6bf-1fb12a76\"],\"hostResourceId\":\"3aa2b39a-fd0e-4b8c-be73-b7af31c4**\"}]"
UrgentImageId	string	No	ID aset media untuk gambar cadangan di pustaka media.	a089175eb5f4427684fc0715159a****
UrgentImageUrl	string	No	URL gambar cadangan.	http://learn.aliyundoc.com/AppName/image.jpg
AutoSwitchUrgentOn	boolean	No	Apakah akan mengaktifkan alih otomatis ke video cadangan saat aliran terputus. true: diaktifkan. false: dinonaktifkan.	true
AutoSwitchUrgentConfig	string	No	Konfigurasi alih otomatis ke cadangan. `eofThres`: durasi pemutusan aliran setelah sistem secara otomatis beralih ke video cadangan, dalam detik.	{"eofThres":3}

Elemen respons

Element	Type	Description	Example
	object
CasterId	string	ID studio produksi. ID ini dapat digunakan sebagai parameter permintaan untuk mengkueri alamat aliran studio produksi, memulai studio produksi, menambahkan sumber daya video, menambahkan layout, mengkueri daftar layout, menambahkan komponen, dan menambahkan daftar program.	b4810848-bcf9-4aef-bd4a-e6bba2d9****
RequestId	string	ID permintaan.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Contoh

Respons sukses

JSONformat

{
  "CasterId": "b4810848-bcf9-4aef-bd4a-e6bba2d9****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidUserId.Malformed	%s, please check userId.	userId yang ditentukan tidak valid. Periksa nilai parameter.
400	InvalidCasterId.Malformed	%s, please check and try again later.	Parameter CasterId tidak valid. Periksa parameter dan coba lagi.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	Parameter berikut tidak valid: %s.
400	IncorrectCasterStatus.Inuse	%s, please check and try again later.	Studio produksi sudah diaktifkan. Periksa permintaan dan coba lagi.
400	MissingParameter	%s.	Parameter yang diperlukan hilang.
400	InvalidCaster.ChannelDisableUnsupported	%s, please check.	Saluran yang sudah diaktifkan tidak dapat dinonaktifkan.
400	IncorrectCasterStatus.EnableChannel	%s, please check and try again later.	Status studio produksi tidak mendukung pengaturan EnableChannel. Periksa status lalu coba lagi.
403	PermissionDenied	%s, please check and try again later.	Akses ditolak. Periksa dan coba lagi.
404	InvalidCaster.NotFound	%s, please check and try again later.	Studio produksi tidak ada. Periksa konfigurasi dan coba lagi.
404	InvalidDomainName.NotFound	%s, please check and try again later.	Nama domain tidak ada. Periksa nama domain lalu coba lagi.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.