SetCasterConfig - - 阿里云

Gunakan operasi ini untuk mengonfigurasi studio produksi secara detail, termasuk nama, konfigurasi transkoding, konfigurasi perekaman, serta parameter lainnya.

Deskripsi operasi

Anda harus memanggil operasi CreateCaster untuk membuat studio produksi sebelum menggunakan operasi ini. Operasi ini menggantikan seluruh konfigurasi yang ada. Jika Anda menetapkan suatu parameter ke nilai kosong, konfigurasi yang ada untuk parameter tersebut akan dihapus.

Batas QPS

Batas permintaan per detik (QPS) untuk satu pengguna adalah 10 panggilan per detik. Panggilan API yang melebihi batas ini akan dikenai throttle, yang dapat memengaruhi bisnis Anda. Rencanakan panggilan API Anda dengan cermat.

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, gunakan nilai CasterId yang dikembalikan dalam respons. Jika Anda membuat studio produksi di konsol ApsaraVideo Live, buka halaman ApsaraVideo Live console > Production Studio > Cloud Production Studio untuk melihat ID tersebut. Catatan Nama studio produksi dalam daftar pada halaman Cloud Production Studio adalah ID studio produksi.	a2b8e671-2fe5-4642-a2ec-bf93880e****
CasterName	string	No	Nama studio produksi.	liveCaster****
DomainName	string	No	Domain streaming untuk streamer. Konfigurasikan nama domain sebelum memulai studio produksi. Jika Anda membiarkan parameter ini kosong, konfigurasi nama domain studio produksi akan dihapus.	example.com
TranscodeConfig	string	No	Konfigurasi transcoding. Berupa string JSON. Field dalam struktur harus menggunakan UpperCamelCase. Jika Anda membiarkan parameter ini kosong, konfigurasi transcoding akan dihapus. Jika tidak ada template transkoding yang ditentukan, sistem akan mengembalikan error saat Anda memulai studio produksi.	{"casterTemplate": "lp_ld"}
RecordConfig	string	No	Konfigurasi perekaman. Parameter ini berupa string JSON. Elemen-elemennya dijelaskan sebagai berikut: endpoint: Titik akhir API layanan Alibaba Cloud. ossBucket: Nama bucket OSS. videoFormat: Format file video yang dapat diekspor. Contoh: `[{\"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: Interval waktu. Satuan: milidetik (ms). Catatan Jika Anda membiarkan parameter ini kosong, fitur perekaman dinonaktifkan dan konfigurasi perekaman yang ada dihapus.	{ "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. Satuan: detik. 0 (default): Menonaktifkan penundaan aliran. Nilai lebih besar dari 0: Mengaktifkan penundaan aliran. Kosong: Menghapus konfigurasi penundaan aliran. Catatan Nilai maksimum adalah 300.	0
UrgentMaterialId	string	No	ID video cadangan, yang merupakan aset media. Jika Anda membiarkan parameter ini kosong, konfigurasi video cadangan akan dihapus.	a2b8e671
UrgentLiveStreamUrl	string	No	URL aliran live cadangan.	rtmp://demo.aliyundoc.com
SideOutputUrl	string	No	URL ingest kustom untuk output bypass dari studio produksi. Jika Anda membiarkan parameter ini kosong, sistem akan menggunakan URL ingest yang dihasilkan secara otomatis untuk output tersebut. Catatan Parameter SideOutputUrl hanya mendukung pengambilan aliran melalui RTMP.	rtmp://**/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**
SideOutputUrlList	string	No	Daftar URL ingest untuk pengambilan aliran multi-channel. URL tersebut dapat berupa URL ingest CDN Alibaba Cloud atau CDN pihak ketiga. Anda dapat menambahkan hingga 20 URL ingest RTMP untuk satu studio produksi. Catatan Tentukan beberapa URL dalam bentuk array. Contoh: ["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"].	rtmp://domain/app/stream?***
CallbackUrl	string	No	Alamat webhook. Untuk menerima notifikasi callback, masukkan alamat yang valid yang menerima permintaan HTTP. Jika Anda membiarkan parameter ini kosong, notifikasi callback untuk studio produksi akan dibatalkan. Catatan Untuk informasi selengkapnya tentang callback studio produksi, lihat Informasi callback untuk studio produksi.	http://**/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**
ProgramEffect	integer	No	Flag yang menunjukkan apakah carousel berlaku. 0: Tidak berlaku. 1: Berlaku.	1
ProgramName	string	No	Nama carousel. Anda dapat mengonfigurasi parameter ini saat menggunakan fitur carousel.	program_name
ChannelEnable	integer	No	Menentukan apakah channel diaktifkan. 0 (default): Menonaktifkan channel. 1: Mengaktifkan channel. Catatan Secara default, fitur ini dinonaktifkan. Setelah Anda mengaktifkan fitur ini, Anda tidak dapat menonaktifkannya kembali. Jika channel dinonaktifkan, resource dirujuk langsung oleh layout. Untuk mengaktifkan channel pertama kali, studio produksi harus berada dalam status Stopped. Layout yang ada akan dibuang. Anda harus terlebih dahulu menambahkan resource ke channel. Layout baru akan langsung merujuk ke channel. Anda dapat menggunakan channel untuk menyesuaikan progres pemutaran dan status sumber video. Dalam mode ini, jika area sumber video, Preview (PVW), dan Program (PGM) merujuk ke resource yang sama, tampilannya tetap tersinkronisasi.	1
SyncGroupsConfig	string	No	Konfigurasi untuk 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. Semua sumber video saling tersinkronisasi. Tidak ada konsep video streamer.) Mode Streamer: Parameter hostResourceId menentukan sumber video streamer. Mode Konferensi: Parameter hostResourceId tidak digunakan. Anda hanya perlu memberikan ID resource dalam parameter resourceIds.	"[{\"mode\":0,\"resourceIds\":[\"5a6c1c33-8424-46f6-813c-c152220a**\",\"4e6521dc-a40a-4077-b6bf-1fb12a76\"],\"hostResourceId\":\"3aa2b39a-fd0e-4b8c-be73-b7af31c4**\"}]"
UrgentImageId	string	No	ID gambar cadangan, yang merupakan aset media.	a089175eb5f4427684fc0715159a****
UrgentImageUrl	string	No	URL gambar cadangan.	http://learn.aliyundoc.com/AppName/image.jpg
AutoSwitchUrgentOn	boolean	No	Menentukan apakah alih otomatis ke resource cadangan diaktifkan. true: Aktifkan. false: Nonaktifkan.	true
AutoSwitchUrgentConfig	string	No	Konfigurasi untuk alih otomatis ke resource cadangan. `eofThres`: periode waktu setelah sistem secara otomatis beralih ke resource cadangan jika aliran terputus. Satuan: detik.	{"eofThres":3}

Elemen respons

Element	Type	Description	Example
	object
CasterId	string	ID studio produksi. Anda dapat menggunakan ID ini untuk mengkueri URL ingest, memulai studio, menambahkan resource video, menambahkan layout, mengkueri layout, menambahkan komponen, dan menambahkan daftar putar.	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
400	InvalidUserId.Malformed	%s
400	InvalidCasterId.Malformed	%s
400	InvalidParameter.Malformed	%s
400	IncorrectCasterStatus.Inuse	%s
400	InvalidCaster.ChannelDisableUnsupported	%s
400	IncorrectCasterStatus.EnableChannel	%s
400	MissingParameter	%s
500	InternalError	%s
403	PermissionDenied	%s
404	InvalidCaster.NotFound	%s
404	InvalidDomainName.NotFound	%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.