Membuat tugas pencampuran aliran dan transkoding.
Deskripsi operasi
Secara default, setiap ID aplikasi mendukung maksimum 200 tugas pengambilan aliran tunggal dan 40 tugas pencampuran aliran dan transkoding. Untuk meningkatkan kuota, kirim tiket.
Siklus hidup tugas pengambilan aliran
Mulai
-
Saat streamer mulai melakukan streaming untuk pertama kalinya, Anda dapat memanggil StartLiveMPUTask untuk memulai tugas bypass.
-
Jika tidak ada pengguna di saluran, error "channel does not exist" akan dikembalikan.
-
Aliran bypass hanya dikeluarkan saat pengguna mulai melakukan pengambilan aliran. Jika pengguna dalam tugas aliran tunggal tidak melakukan pengambilan aliran, aliran bypass tidak dapat diputar.
-
Untuk tugas pengambilan aliran, setidaknya satu pengguna harus melakukan pengambilan aliran agar aliran bypass dapat diputar. Area tata letak untuk pengguna yang tidak melakukan pengambilan aliran menampilkan layar hitam.
-
-
Anda dapat membuat Catatan status tugas bypass, tipe tugas, dan parameter tugas di server bisnis Anda.
-
Status tugas: Started, Stopped.
-
Tipe tugas: Single-stream, Stream mixing.
-
Parameter tugas: Parameter input terbaru. Misalnya, setelah pemanggilan UpdateLiveMPUTask berhasil, catat parameter tugas terbaru.
-
-
Dalam skenario co-streaming atau PK, jika tugas telah diperbarui menjadi tugas pengambilan aliran dan streamer keluar secara tidak terduga lalu bergabung kembali ke saluran, server bisnis Anda dapat memanggil StartLiveMPUTask untuk memulai ulang tugas pengambilan aliran berdasarkan tipe dan parameter tugas yang disimpan.
-
Jika sistem belum secara otomatis menghapus tugas sebelum Anda memulainya, tugas akan berhasil dimulai.
-
Jika sistem belum menghapus tugas, kode kesalahan Task already exists akan dikembalikan.
-
Selesai
-
Saat streamer keluar dari saluran, panggil StopLiveMPUTask untuk menghentikan tugas bypass.
-
Jika semua pengguna dalam tugas keluar dari saluran dan StopLiveMPUTask tidak dipanggil, sistem secara otomatis menghentikan tugas bypass setelah 2 menit.
Batas QPS
Batas queries per second (QPS) untuk satu pengguna untuk API ini adalah 500 panggilan/detik. Jika Anda melebihi batas ini, panggilan API akan dibatasi (throttled). Hal ini dapat memengaruhi bisnis Anda. Kami menyarankan Anda memanggil API ini secara wajar.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
live:StartLiveMPUTask |
create |
*Semua sumber daya.
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| AppId |
string |
Yes |
ID aplikasi. Hanya satu ID yang didukung. Dapat berisi huruf besar, huruf kecil, angka, garis bawah (_), dan tanda hubung (-). Panjang maksimum adalah 64 karakter. |
yourAppId |
| ChannelId |
string |
Yes |
ID saluran. Hanya satu ID yang didukung. Dapat berisi huruf besar, huruf kecil, angka, garis bawah (_), dan tanda hubung (-). Panjang maksimum adalah 64 karakter. |
yourChannelId |
| TaskId |
string |
Yes |
ID tugas. Hanya satu ID yang didukung. Dapat berisi huruf besar, huruf kecil, angka, garis bawah (_), dan tanda hubung (-). Panjang maksimum adalah 55 karakter. ID ini adalah pengenal unik untuk tugas ingest bypass. Jika tugas dengan ID yang sama masih ada dan belum dihapus saat Anda memulai tugas baru, `InvalidParam` akan dikembalikan. |
yourTaskId |
| MixMode |
string |
Yes |
Mode pengambilan aliran. Nilai valid:
|
0 |
| StreamURL |
string |
No |
URL pengambilan aliran langsung. Hanya protokol RTMP yang didukung. Hanya satu URL yang didukung. Panjang maksimum adalah 2048 karakter. Untuk informasi tentang cara membuat URL, lihat URL ingest dan URL pemutaran. Catatan
|
rtmp://example.com/live/stream |
| MultiStreamURL |
array<object> |
No |
Parameter untuk ingest ke beberapa URL. Anda dapat menentukan beberapa URL ingest langsung. Catatan
Saat Anda mengatur URL ingest untuk sebuah tugas, Anda harus mengonfigurasi parameter StreamURL atau parameter MultiStreamURL, tetapi tidak keduanya. |
|
|
object |
No |
|||
| URL |
string |
No |
URL pengambilan aliran langsung. Hanya protokol RTMP yang didukung. Panjang maksimum adalah 2048 karakter. Untuk informasi tentang cara membuat URL, lihat URL ingest dan URL pemutaran. |
rtmp://example.com/live/stream**** |
| IsAliCdn |
boolean |
No |
Apakah akan melakukan ingest aliran ke Alibaba Cloud CDN.
Catatan
Nilai default adalah false. |
false |
| Region |
string |
No |
Wilayah tempat layanan pencampuran aliran berada. Nilai valid:
|
CN-Shanghai |
| MaxIdleTime |
string |
No |
Periode waktu tunggu idle. Unit: detik. Nilai harus berada dalam rentang [10, 86400]. Catatan
Jika Anda mengatur parameter ini, tugas akan secara otomatis dihentikan saat telah idle lebih lama dari MaxIdleTime. Jika Anda tidak mengatur parameter ini, tugas akan dihentikan segera setelah saluran ditutup. |
10 |
| SingleSubParams |
object |
No |
Parameter untuk pengambilan aliran tunggal. Parameter ini wajib diisi saat MixMode diatur ke 0. Jangan atur parameter ini untuk pencampuran aliran dan transkoding. |
|
| SourceType |
string |
No |
Tipe aliran input video dalam mode pengambilan aliran tunggal. Parameter ini hanya valid untuk aliran video (StreamType=2). Nilai valid:
|
camera |
| StreamType |
string |
No |
Tipe aliran yang akan di-ingest dalam mode pengambilan aliran tunggal. Nilai valid:
|
0 |
| UserId |
string |
Yes |
ID pengguna yang alirannya di-ingest. Hanya satu aliran yang dapat di-ingest dalam satu waktu. |
yourSubUserId |
| TranscodeParams |
object |
No |
Parameter untuk pencampuran aliran dan transkoding. Parameter ini wajib diisi saat MixMode diatur ke 1. Jangan atur parameter ini untuk pengambilan aliran tunggal. |
|
| Background |
object |
No |
Gambar latar belakang global untuk aliran campuran. |
|
| RenderMode |
string |
No |
Mode tampilan video keluaran. Nilai valid:
|
1 |
| URL |
string |
No |
URL gambar latar belakang global. Panjang maksimum adalah 2048 karakter. |
yourImageUrl |
| EncodeParams |
object |
No |
Parameter pengkodean untuk aliran keluaran. |
|
| AudioOnly |
string |
No |
Apakah aliran hanya audio. Nilai valid:
|
false |
| AudioBitrate |
string |
No |
Laju bitrate audio. Unit: kbps. Nilai harus berada dalam rentang [8, 500]. |
128 |
| AudioChannels |
string |
No |
Jumlah saluran audio. Nilai valid: 1, 2. |
2 |
| AudioSampleRate |
string |
No |
Laju pengambilan sampel audio. Unit: Hz. Nilai valid: 8000, 16000, 32000, 44100, 48000. |
44100 |
| VideoCodec |
string |
No |
Format Pengkodean video. Nilai valid:
|
H.264 |
| VideoBitrate |
string |
No |
Laju bitrate video. Unit: kbps. Nilai harus berada dalam rentang [1, 10000]. |
3500 |
| VideoFramerate |
string |
No |
Laju frame video. Unit: fps. Nilai harus berada dalam rentang [1, 60]. |
25 |
| VideoGop |
string |
No |
Ukuran GOP video. Nilai harus berada dalam rentang [1, 60]. |
20 |
| VideoHeight |
string |
No |
Tinggi video. Unit: piksel. Nilai harus berada dalam rentang [0, 1920]. |
1000 |
| VideoWidth |
string |
No |
Lebar video. Unit: piksel. Nilai harus berada dalam rentang [0, 1920]. |
1920 |
| EnhancedParam |
string |
No |
Parameter pengkodean yang ditingkatkan. Ini adalah string JSON. Konfigurasi opsional yang didukung mencakup `profile` dan `preset`.
Catatan
Misalnya, "superfast" terutama digunakan untuk komunikasi waktu nyata. Jika Anda bukan ahli dalam encoder, jangan atur opsi ini. |
{"profile": "high", "preset": "veryfast"} |
| Layout |
object |
No |
Informasi tata letak video. Catatan
Untuk transkoding video, Anda harus menentukan informasi tata letak video, termasuk koordinat (X, Y), dimensi panel (Width, Height), dan Pesanan penumpukan (ZOrder). Untuk transkoding hanya audio, jangan tentukan informasi tata letak video. |
|
| UserPanes |
array<object> |
No |
Informasi tentang panel pengguna dalam aliran campuran. |
|
|
array<object> |
No |
Informasi tentang panel pengguna dalam aliran campuran. |
||
| UserInfo |
object |
No |
Informasi tentang pengguna yang sesuai dengan panel ini. Jika Anda tidak mengatur parameter ini, sistem akan mengisinya secara otomatis berdasarkan Pesanan streamer bergabung ke saluran. Catatan
|
|
| SourceType |
string |
No |
Tipe aliran input video dalam mode pencampuran aliran dan transkoding. Parameter ini hanya valid untuk aliran video (StreamType=2). Nilai valid:
|
camera |
| ChannelId |
string |
No |
ID saluran tempat pengguna berada. Anda tidak perlu mengatur parameter ini untuk pengguna di saluran yang sama. Untuk pencampuran aliran lintas saluran, atur parameter ini. |
yourChannelId |
| UserId |
string |
No |
ID pengguna. |
yourSubUserId |
| Height |
string |
No |
Tinggi panel, sebagai persentase yang dinormalisasi. |
0.2632 |
| Width |
string |
No |
Lebar panel, sebagai persentase yang dinormalisasi. |
0.3564 |
| X |
string |
No |
Koordinat X, sebagai persentase yang dinormalisasi. |
0.2456 |
| Y |
string |
No |
Koordinat Y, sebagai persentase yang dinormalisasi. |
0.3789 |
| ZOrder |
string |
No |
Pesanan penumpukan. 0 adalah lapisan paling bawah. Lapisan 1 berada di atas lapisan 0, dan seterusnya. |
0 |
| BackgroundImageUrl |
string |
No |
URL gambar latar belakang untuk panel video. Panjang maksimum adalah 2048 karakter. Saat pengguna mematikan kamera atau belum bergabung ke saluran, gambar ini ditampilkan di posisi tata letak mereka. |
yourImageUrl |
| RenderMode |
string |
No |
Mode tampilan panel video keluaran. Nilai valid:
|
1 |
| UserInfos |
array<object> |
No |
Informasi tentang pengguna yang akan berlangganan untuk pencampuran aliran. Jika Anda tidak menentukan pengguna, semua pengguna akan disertakan dalam aliran campuran. |
|
|
object |
No |
Informasi pengguna untuk pencampuran aliran. |
||
| SourceType |
string |
No |
Tipe aliran input video yang akan berlangganan untuk pencampuran aliran. Parameter ini hanya valid untuk aliran video (StreamType=2). Nilai valid:
|
camera |
| StreamType |
string |
No |
Tipe aliran yang akan berlangganan untuk pencampuran aliran. Nilai valid:
|
0 |
| ChannelId |
string |
No |
ID saluran tempat pengguna berlangganan berada. Anda tidak perlu mengatur parameter ini untuk pengguna di saluran yang sama. Untuk pencampuran aliran lintas saluran, atur parameter ini. |
yourChannelId |
| UserId |
string |
Yes |
ID pengguna yang akan berlangganan untuk pencampuran aliran. |
yourSubUserId |
| SeiParams |
object |
No |
Parameter konfigurasi SEI. |
|
| LayoutVolume |
object |
No |
SEI tata letak dan volume. Konten parameter ini dapat kosong, yang berarti SEI tata letak dan volume default dibawa. |
|
| FollowIdr |
string |
No |
Apakah akan memastikan SEI dibawa saat mengirim keyframe IDR. Nilai valid:
|
0 |
| Interval |
string |
No |
Interval pengiriman SEI. Unit: milidetik. Nilai harus berada dalam rentang [1000, 5000]. |
1000 |
| PassThrough |
object |
No |
SEI pass-through. |
|
| FollowIdr |
string |
No |
Apakah akan memastikan SEI dibawa saat mengirim keyframe IDR. Nilai valid:
|
0 |
| Interval |
string |
No |
Interval pengiriman SEI. Unit: milidetik. Nilai harus berada dalam rentang [1000, 5000]. |
1000 |
| PayloadContent |
string |
No |
Konten muatan dari SEI pass-through. |
yourPayloadContent |
| PayloadContentKey |
string |
No |
Kunci yang sesuai dengan konten muatan dari SEI pass-through. Jika tidak diatur, kunci default adalah `udd`. |
yourPayloadContentKey |
| PayloadType |
string |
No |
muatan_type kustom dari Paket SEI. Nilai harus berada dalam rentang 100-254. Jika tidak diatur, muatan_type default adalah 5. |
100 |
SEI tata letak dan volume
| Parameter | Deskripsi |
| canvas | Informasi kanvas. Parameter: - w: Lebar kanvas dalam piksel. - h: Tinggi kanvas dalam piksel. - bgnd: Warna latar belakang kanvas, sebagai bilangan heksadesimal dalam format RGB. |
| stream | Informasi aliran video. Parameter: - uid: ID pengguna streamer. - paneid: ID panel wilayah, dalam rentang [0, 8]. - zorder: Pesanan penumpukan wilayah, dalam rentang [0, 99]. - x: Koordinat X wilayah pada kanvas, sebagai persentase yang dinormalisasi. - y: Koordinat Y wilayah pada kanvas, sebagai persentase yang dinormalisasi. - w: Lebar wilayah, sebagai persentase yang dinormalisasi. - h: Tinggi wilayah, sebagai persentase yang dinormalisasi. - type: Tipe aliran video di wilayah. 0: Kamera. 1: Berbagi layar. - status: Status aliran video di wilayah. 0: Belum ditarik. 1: Sudah ditarik. - muted: Status bisu streamer. 0: Tidak dibisukan. 1: Dibisukan. Dalam skenario PK, jika streamer A membisukan streamer B, kolom muted untuk streamer B menunjukkan status dibisukan.- vol: Volume streamer dalam desibel, dalam rentang [0, 255]. - vad: Deteksi aktivitas suara. Nilai berada dalam rentang [0, 150]. 150 menunjukkan bahwa suara terdeteksi. Nilai selain 150 menunjukkan waktu jeda dari suara ke keheningan. |
| ts | Stempel waktu sistem operasi saat informasi ini dibuat, dalam milidetik. |
| ver | Versi format SEI, seperti 1.0.0.20220915. |
| udd | Acara berbasis skenario kustom yang dikirim melalui parameter PassThrough. Konten ditentukan oleh parameter PayloadContent. |
Saat pengguna menarik aliran yang di-ingest, data media streaming berisi informasi SEI. Anda dapat menggunakan fitur ini untuk meneruskan informasi kustom. Informasi SEI dapat diambil dari data frame video selama dekoding aliran video. Untuk format spesifik, lihat parameter `PassThrough`.
Contoh untuk skenario co-streaming:
Jika hanya ada satu streamer, koleksi `stream` dalam informasi SEI yang diterima penonton berisi informasi untuk hanya satu anggota. Jika streamer berada dalam sesi co-streaming atau PK, koleksi `stream` berisi informasi untuk beberapa anggota.
Misalnya, saat streamer `streamer111` melakukan streaming sendirian, format frame SEI yang diterima penonton adalah sebagai berikut:{"canvas":{"w":1920,"h":1080,"bgnd":0},"stream":[{"uid":"streamer111","paneid":-1,"zorder":0,"x":0,"y":0,"w":0,"h":0,"type":0,"status":1,"muted":0,"vol":0,"vad":0}],"ver":"1.0.0.20220915","ts":1697696105170}
Saat streamer `streamer111` melakukan co-streaming dengan penonton `viewer222`, format frame SEI yang diterima penonton adalah sebagai berikut:{"canvas":{"w":1920,"h":1080,"bgnd":0},"stream":[{"uid":"streamer111","paneid":0,"zorder":1,"x":0,"y":0.25,"w":0.5,"h":0.5,"type":0,"status":1,"muted":0,"vol":1,"vad":119},{"uid":"viewer222","paneid":1,"zorder":1,"x":0.5018382,"y":0.25,"w":0.5,"h":0.5,"type":0,"status":1,"muted":0,"vol":60,"vad":123}],"ver":"1.0.0.20220915","ts":1697696106230}
Dengan memeriksa jumlah elemen dalam array `stream`, Anda dapat menentukan apakah tata letak langsung telah berubah. Jika array `stream` memiliki satu elemen, satu streamer sedang melakukan pengambilan aliran. Jika array `stream` memiliki lebih dari satu elemen, streamer berada dalam sesi co-streaming atau PK. Informasi tata letak untuk setiap anggota menunjukkan posisi spesifik mereka dalam tata letak aliran campuran.
SEI pass-through
-
Untuk menggunakan SEI kustom, Anda dapat memanggil perintah StartLiveMPUTask untuk memulai tugas pencampuran dan pengambilan aliran serta menentukan `PayloadContent` di parameter `PassThrough`. Anda juga dapat memanggil perintah UpdateLiveMPUTask untuk memperbarui tugas dan menentukan `PayloadContent` di parameter `PassThrough`.
-
SEI kustom dapat dikirim secara berkala. Anda dapat mengatur periode menggunakan parameter `Interval` di `PassThrough`. Unitnya adalah milidetik.
-
SEI kustom juga dapat dikirim bersama keyframe. Anda dapat mengaturnya menggunakan parameter `FollowIdr` di `PassThrough`.
-
Anda dapat mengirim SEI secara berkala dan bersama keyframe. Misalnya, `Interval:1000` dan `FollowIdr: 1` berarti SEI kustom dikirim setiap 1000 ms dan juga bersama setiap keyframe.
-
Jika Anda tidak mengatur `Interval` atau `FollowIdr`, SEI kustom hanya dikirim sekali saat API dipanggil.
-
Misalnya, saat streamer `streamer111` melakukan streaming sendirian, Anda dapat memanggil perintah UpdateLiveMPUTask untuk mengirim SEI berkala. Di parameter `PassThrough`, atur `Interval` ke 1000, `FollowIdr` ke 0, dan `PayloadContent` ke "hello world". Paket SEI kustom kemudian dikirim setiap 1000 ms. Format frame SEI yang diterima penonton adalah sebagai berikut:{"canvas":{"w":1920,"h":1080,"bgnd":0},"stream":[{"uid":"streamer111","paneid":-1,"zorder":0,"x":0,"y":0,"w":0,"h":0,"type":0,"status":1,"muted":0,"vol":0,"vad":0}],"ver":"1.0.0.20220915","ts":1697696109876,"udd":"hello world"}
Pencampuran aliran multi-pengguna lintas saluran
Untuk mencampur aliran dari beberapa streamer di beberapa saluran dan meng-ingest aliran campuran ke layanan streaming langsung, Anda harus menyediakan UserID dan ChannelID dari streamer yang memulai panggilan lintas saluran, bersama dengan UserID dari peserta lainnya, sebagai parameter input saat Anda membuat tugas pencampuran aliran. Lihat contoh berikut: Dalam skenario PK langsung, streamer `userA` di saluran `channelA` memulai PK lintas saluran dengan streamer `userB` di saluran `channelB` menggunakan API klien. Aliran campuran dari kedua streamer dikeluarkan ke penonton di saluran `channelA`. Dalam hal ini, parameter saluran dan pengguna untuk membuat tugas pencampuran aliran ditentukan sebagai berikut:
-
ChannelID: Tentukan `channelA`.
-
UserInfos->UserId: Tentukan `userA` dan `userB` masing-masing.
Sebelum Anda dapat membuat tugas pencampuran aliran multi-pengguna lintas saluran, panggilan lintas saluran harus dimulai melalui software development kit (SDK) klien. Jika pengguna di saluran yang berbeda tidak sedang dalam panggilan, Anda tidak dapat membuat tugas pencampuran aliran lintas saluran. Untuk informasi lebih lanjut tentang cara memulai panggilan lintas saluran, lihat Langganan lintas saluran.
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
ID permintaan. |
||
| RequestId |
string |
ID permintaan. |
0F72851F-5DC1-1979-9B2C-450040316C3E |
Contoh
Respons sukses
JSONformat
{
"RequestId": "0F72851F-5DC1-1979-9B2C-450040316C3E"
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParam | %s. | Validasi parameter gagal. |
| 400 | InvalidAppId | %s, please check and try again later. | AppId tidak valid. Periksa dan coba lagi. |
| 400 | MissingParam | %s, please check and try again later. | Parameter yang diperlukan tidak ada. Periksa dan coba lagi. |
| 500 | InternalError | InternalError | |
| 403 | OperationDenied | Your account has not enabled the Live service | |
| 403 | Forbidden | %s, please check and try again later. | Anda tidak memiliki izin yang diperlukan. Periksa dan coba lagi. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.