AOQ Web SDK mendukung interaksi audio, video, dan data real-time di browser. Referensi ini menjelaskan API untuk manajemen engine, perekaman dan pemutaran audio serta video, pesan data, dan callback peristiwa.
Instal SDK
AOQ Web SDK terhubung ke server menggunakan WebTransport (HTTP/3 / QUIC) dan bertukar audio, video, serta pesan data di Worker. SDK memerlukan browser yang mendukung WebTransport dan konteks aman HTTPS. Gunakan AoqClientEngine.isAoqSupported() untuk memeriksa kemampuan dasar browser.
Instal SDK menggunakan npm:
Daftar API
Siklus hidup engine
| API | Deskripsi |
|---|---|
| createEngine | Membuat engine singleton |
| createAoqClientEngine | Fungsi factory bernama yang setara |
| destroy | Menghancurkan engine |
| getVersion | Mendapatkan versi SDK |
| isAoqSupported | Memeriksa kemampuan browser |
| connect | Memulai koneksi |
| disconnect | Memutuskan koneksi |
Manajemen perangkat audio
| API | Deskripsi |
|---|---|
| startAudioCapture | Memulai perekaman audio |
| stopAudioCapture | Menghentikan perekaman audio |
| muteAudioCapture | Membisukan perekaman audio |
| startAudioPlayer | Memulai pemutaran audio |
| stopAudioPlayer | Menghentikan pemutaran audio |
| pauseAudioPlayer | Menjeda pemutaran dengan fade-out |
| resumeAudioPlayer | Melanjutkan pemutaran dengan fade-in default |
| interruptAudioPlayer | Menginterupsi pemutaran |
Konfigurasi enkode audio
| API | Deskripsi |
|---|---|
| setAudioEncoderConfig | Mengatur parameter enkode audio |
| setAudioDecoderConfig | Mengatur parameter dekode audio |
Indikasi volume lokal
| API | Deskripsi |
|---|---|
| enableLocalAudioVolumeIndication | Mengaktifkan indikasi volume lokal |
Manajemen perangkat video
| API | Deskripsi |
|---|---|
| startVideoCapture | Memulai perekaman video |
| getCameras | Mendaftar kamera |
| switchCamera | Beralih kamera berdasarkan preferensi arah atau ID perangkat |
| stopVideoCapture | Menghentikan perekaman video |
| setLocalView | Mengatur kontainer video lokal |
| setRemoteView | Mengatur kontainer video jarak jauh |
Konfigurasi enkode video
| API | Deskripsi |
|---|---|
| setVideoEncoderConfig | Mengatur parameter enkode video |
| setVideoDecoderConfig | Mengatur parameter dekode video |
Kontrol pengiriman stream media
| API | Deskripsi |
|---|---|
| enableSendMediaStream | Mengaktifkan atau menonaktifkan pengiriman stream media |
Pesan real-time
| API | Deskripsi |
|---|---|
| sendDataMsg | Mengirim pesan data |
Callback peristiwa
| API | Deskripsi |
|---|---|
| onError | Callback kesalahan |
| onWarning | Callback peringatan |
| onConnectionStatusChange | Perubahan status koneksi |
| onStats | Statistik |
| onAudioDeviceStateChanged | Perubahan status perangkat audio |
| onAudioDeviceRouteChanged | Perubahan rute audio |
| onAudioFileState | Peristiwa status file audio yang dicadangkan; saat ini tidak dipancarkan |
| onLocalAudioVolumeIndication | Indikasi volume lokal |
| onVideoDeviceStateChanged | Perubahan status perangkat video |
| onDataMsg | Pesan data |
Detail API
Siklus hidup engine
createEngine
Membuat engine singleton. Pemanggilan berulang mengembalikan instance yang sudah ada.
| Parameter | Tipe | Deskripsi |
|---|---|---|
config | AoqCreateConfig | Konfigurasi pembuatan engine |
AoqClientEngine jika berhasil, atau null jika gagal.
Singleton yang sudah diinisialisasi dikembalikan tanpa menerapkan ulang konfigurasi. Hancurkan sebelum membuat engine dengan konfigurasi baru.
createAoqClientEngine
Factory bernama yang diekspor paket, setara dengan AoqClientEngine.createEngine(config). Ini bukan metode instance dan tidak memerlukan inisialisasi tambahan.
| Parameter | Tipe | Deskripsi |
|---|---|---|
config | AoqCreateConfig | Wajib; {} valid. Pembuatan berulang tidak menerapkan ulang konfigurasi. |
null jika gagal.
destroy
Menghancurkan engine, memulai pelepasan sumber daya, dan menghapus semua listener peristiwa.
0 jika berhasil, atau AoqECStateInvalid(2) jika tidak ada instance.
Metode ini kembali secara sinkron. Penyimpanan log dan ekspor dump opsional berjalan asinkron di latar belakang dan mungkin belum selesai saat metode kembali. Buat engine baru dengan createEngine sebelum menggunakan SDK kembali; instance yang dihancurkan tidak dapat digunakan ulang.
getVersion
Mendapatkan versi SDK.
isAoqSupported
Memeriksa kemampuan dasar browser yang diperlukan untuk koneksi AOQ.
Promise<AoqSupportResult> berisi hasil dukungan dan kemampuan yang tidak tersedia.
Pemeriksaan menguji WebTransport di Worker dengan timeout 5 detik. Jangkauan jaringan, konfigurasi server, autentikasi, izin perangkat, dan konfigurasi media tertentu tidak diperiksa. supported: true tidak menjamin koneksi atau panggilan berhasil.
connect
Memulai koneksi ke server.
| Parameter | Tipe | Deskripsi |
|---|---|---|
config | AoqConnectConfig | Kredensial koneksi, termasuk token, ID sesi, dan endpoint relay |
0 ketika permintaan diterima.
Panggil setelah membuat engine, mendaftarkan peristiwa, dan mengonfigurasi codec. Koneksi biasanya dimulai dari Disconnected; mencoba ulang dari Failed juga diizinkan. Status lain mengembalikan AoqECStateInvalid(2). Track, media, atau parameter koneksi tidak valid, atau pemilihan Opus tanpa kemampuan WebCodecs yang diperlukan, dapat mengembalikan AoqECParamInvalid(1). Network Worker yang tidak tersedia mengembalikan AoqECStateInvalid(2).
Hasil koneksi dilaporkan asinkron melalui onConnectionStatusChange. Connected berarti MEDIA_SETUP selesai dan track media terikat. Konfigurasikan sesi sesuai protokol data model dan pastikan aplikasi siap sebelum mengaktifkan pengiriman audio atau video.
disconnect
Memutuskan koneksi dari server.
0 ketika permintaan diterima.
Hasil dilaporkan melalui onConnectionStatusChange. Tunggu AoqConnectionStatusDisconnected sebelum mengubah konfigurasi codec dan menyambung kembali. Pemanggilan saat sudah terputus mengembalikan AoqECStateInvalid(2). Pemutusan koneksi tidak menghentikan perangkat; panggil juga metode penghentian perekaman dan pemutaran saat mengakhiri panggilan.
Manajemen perangkat audio
startAudioCapture
Memulai perekaman mikrofon dan meminta izin perangkat secara asinkron.
| Parameter | Tipe | Deskripsi |
|---|---|---|
config | AoqAudioCaptureConfig | Konfigurasi perekaman audio |
Promise<number>; 0 menunjukkan keberhasilan.
Browser dapat meminta izin mikrofon saat pertama digunakan atau jika izin belum diberikan. Perubahan status perekaman dilaporkan melalui onAudioDeviceStateChanged.
Saat terjadi kemacetan, audio uplink yang menunggu sekitar 100 ms dalam antrean pengiriman dibuang agar latensi tidak menumpuk. Audio yang mulai dikirim tidak ditarik kembali. Ambang ini bukan batas latensi end-to-end.
stopAudioCapture
Menghentikan perekaman audio.
0 jika berhasil.
Mengembalikan AoqECStateInvalid(2) jika perangkat belum dimulai atau sudah dihentikan.
muteAudioCapture
Membisukan atau mengaktifkan kembali audio perekaman. Perekaman tetap berjalan saat dibisukan, tetapi frame senyap dikirim.
| Parameter | Tipe | Deskripsi |
|---|---|---|
mute | boolean | true: bisukan; false: aktifkan suara |
0 jika berhasil.
startAudioPlayer
Memulai pemutar audio dan menginisialisasi perangkat keluaran secara asinkron.
| Parameter | Tipe | Deskripsi |
|---|---|---|
config | AoqAudioPlaybackConfig | Konfigurasi pemutaran audio |
Promise<number>; 0 menunjukkan keberhasilan.
Perubahan status pemutaran dilaporkan melalui onAudioDeviceStateChanged.
Panggil dari handler klik pengguna dan tangani pembatasan autoplay browser. Pemanggilan saat pemutar sedang dimulai atau sudah berjalan mengembalikan AoqECStateInvalid(2).
Dalam mode Realtime (trackMode downlink audio adalah Stream), audio sebelum pemutar dimulai terus dikonsumsi tanpa menumpuk. Setiap start, termasuk yang pertama, menghapus audio sebelumnya dan hanya memutar audio yang baru diterima. Mode Segment menyimpan audio yang belum diputar.
stopAudioPlayer
Menghentikan pemutar audio.
0 jika berhasil.
Mengembalikan AoqECStateInvalid(2) jika perangkat belum dimulai atau sudah dihentikan.
Dalam mode Realtime, audio masuk tetap dikonsumsi setelah keluaran perangkat dihentikan, dan video tetap diputar. Memulai kembali hanya memutar audio baru. Status jeda atau interupsi tetap dipertahankan setelah restart. Mode Segment menyimpan audio yang belum diputar.
pauseAudioPlayer
Menjeda pemutaran setelah fade-out. Panggil resumeAudioPlayer untuk melanjutkan.
| Parameter | Tipe | Deskripsi |
|---|---|---|
fadeMs | number | Durasi fade-out dalam ms, dibulatkan menjadi jumlah sampel pada laju sampel perangkat sebenarnya. 0 menonaktifkan fade; nilai negatif atau tidak hingga menggunakan 100 ms. |
0 saat permintaan kontrol diterima. Pemutaran atau fade-out mungkin belum selesai, dan pemutar mungkin tidak sedang memutar.
Mode Segment menyimpan audio yang belum diputar dan posisi baca, lalu melanjutkan dari posisi tersebut. Mode Realtime membuang audio antrean dan terus mengonsumsi audio masuk saat dijeda, lalu melanjutkan dari posisi real-time saat ini tanpa memutar ulang audio selama jeda.
resumeAudioPlayer
Melanjutkan pemutaran yang dijeda atau diinterupsi dengan fade-in default: 2 ms dalam mode Segment dan 100 ms dalam mode Realtime.
| Parameter | Tipe | Deskripsi |
|---|---|---|
fadeMs | number | Dicadangkan dan saat ini diabaikan. Fade-in default digunakan; 0 tidak menonaktifkannya. |
0 ketika permintaan kontrol diterima; proses melanjutkan mungkin belum selesai.
interruptAudioPlayer
Menginterupsi pemutaran dan membuang sisa audio yang belum diputar setelah fade-out. Berbeda dari jeda mode Segment, audio yang dibuang tidak diputar ulang setelah dilanjutkan.
| Parameter | Tipe | Deskripsi |
|---|---|---|
trackType | AoqTrackType | Parameter kompatibilitas. Gunakan Audio. Saat ini parameter ini tidak memilih stream pemutaran. |
fadeMs | number | Durasi fade-out dalam ms, dibulatkan menjadi jumlah sampel pada laju sampel perangkat sebenarnya. 0 menonaktifkan fade; nilai negatif atau tidak hingga menggunakan 100 ms. |
0 ketika permintaan kontrol diterima. Interupsi mungkin belum selesai, dan pemutar mungkin tidak sedang memutar.
Pemutaran dilanjutkan otomatis ketika server mengirim audio putaran baru. Anda juga dapat memanggil resumeAudioPlayer.
Permintaan interupsi saat dijeda diabaikan tetapi masih dapat mengembalikan 0. Mode Segment kemudian melanjutkan audio yang disimpan sebelum jeda. Jeda yang diikuti interupsi tidak mengosongkan antrean pemutaran.
Konfigurasi enkode audio
setAudioEncoderConfig
Mengatur parameter enkode audio.
| Parameter | Tipe | Deskripsi |
|---|---|---|
config | AoqAudioCodecConfig | Konfigurasi enkode audio |
0 jika berhasil.
Panggil sebelum connect() saat engine Disconnected. Perubahan saat menghubungkan atau terhubung mengembalikan AoqECStateInvalid(2). Putuskan koneksi dan tunggu Disconnected, konfigurasikan codec, lalu hubungkan kembali.
Nilai 0 berarti permintaan konfigurasi diterima. Format audio divalidasi kembali saat membuat koneksi. Opus juga memerlukan dukungan WebCodecs browser.
setAudioDecoderConfig
Mengatur parameter dekode audio.
| Parameter | Tipe | Deskripsi |
|---|---|---|
config | AoqAudioCodecConfig | Konfigurasi dekode audio |
0 jika berhasil.
Panggil sebelum connect() saat engine Disconnected. Perubahan saat menghubungkan atau terhubung mengembalikan AoqECStateInvalid(2).
Indikasi volume lokal
enableLocalAudioVolumeIndication
Mengaktifkan atau menonaktifkan notifikasi volume perekaman lokal berkala melalui onLocalAudioVolumeIndication.
| Parameter | Tipe | Deskripsi |
|---|---|---|
config | AoqAudioVolumeIndicationConfig | Konfigurasi indikasi volume |
0 jika berhasil.
Atur interval ke 0 atau nilai negatif untuk menonaktifkan callback.
Manajemen perangkat video
startVideoCapture
Memulai perekaman kamera.
| Parameter | Tipe | Deskripsi |
|---|---|---|
config | AoqVideoCaptureConfig | Konfigurasi perekaman video |
0 jika berhasil.
Nilai 0 berarti permintaan perekaman asinkron diterima. Keberhasilan atau kegagalan dilaporkan melalui onVideoDeviceStateChanged; kamera belum tentu sudah berjalan.
cameraPreference menerima enum arah atau ID perangkat. Jika dihilangkan, browser memilih kamera. Browser dapat beralih ke kamera lain yang tersedia jika arah atau ID yang diminta tidak dapat dipenuhi.
getCameras
videoinput yang terlihat oleh browser tanpa membuka kamera atau meminta izin. Nama atau ID mungkin tidak lengkap sebelum izin diberikan. Daftar ulang setelah otorisasi atau perubahan perangkat. Promise ditolak jika engine belum diinisialisasi atau pendaftaran gagal.
switchCamera
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
cameraPreference | AoqCameraDirection | string | Tidak | Preferensi arah atau ID perangkat. Hilangkan untuk menghapus preferensi sebelumnya dan membiarkan browser memilih ulang. |
0 berarti permintaan diterima. Status dilaporkan melalui onVideoDeviceStateChanged, dan kegagalan melalui onError. Mengembalikan AoqECStateInvalid(2) saat perekaman tidak aktif, sedang dimulai, atau beralih; AoqECParamInvalid(1) untuk arah tidak valid atau ID kosong.
Peralihan melepaskan perangkat lama, membuka target, dan menunggu frame pertama. Jika track kamera lama ditransfer ke Worker, termasuk yang kemudian kembali ke thread utama, konfirmasi pelepasan ditunggu hingga 2 detik. Timeout konfirmasi melaporkan kegagalan tanpa membuka atau memulihkan perangkat. Setiap percobaan maksimum 15 detik. Jika gagal, dilakukan satu upaya pemulihan dengan preferensi perangkat semula; pemulihan berhasil tetap melaporkan peralihan gagal. Keberhasilan: CaptureStarted(reason=0); gagal tetapi perekaman pulih: CaptureStarted(reason=kode kesalahan); pemulihan gagal: CaptureFail(reason=kode kesalahan). Jika target eksplisit sudah terpenuhi, CaptureStarted dipancarkan asinkron tanpa membuka ulang. Callback tidak menyertakan ID perangkat aktual. Peralihan mempertahankan sakelar pengiriman, konfigurasi codec, dan pengikatan pratinjau. Penghentian perekaman membatalkan peralihan; penghancuran engine menghentikan callback berikutnya.
Peralihan dapat mengganggu video sesaat. Linimasa perekaman tetap berkelanjutan, tetapi sinkronisasi audio/video tingkat perangkat keras tidak dijamin. Browser memilih perangkat aktual; jangan tampilkan preferensi yang diminta sebagai perangkat yang telah dikonfirmasi.
stopVideoCapture
Menghentikan perekaman video.
0 jika berhasil.
Mengembalikan AoqECStateInvalid(2) jika perangkat belum dimulai atau sudah dihentikan.
setLocalView
Mengatur kontainer video lokal. SDK membuat elemen rendering di dalamnya.
| Parameter | Tipe | Deskripsi |
|---|---|---|
trackType | AoqTrackType | Hanya AoqTrackTypeVideo yang didukung. Tipe lain mengembalikan AoqECUnSupport(3). |
canvas | AoqVideoCanvas | null | Konfigurasi kontainer rendering. Gunakan null untuk melepas pengikatan. |
0 jika berhasil.
Tetapkan dimensi kontainer secara eksplisit. SDK membuat elemen rendering di dalamnya.
Gunakan kontainer DOM biasa berdimensi eksplisit, misalnya div. Jangan langsung menggunakan elemen video, audio, canvas, img, atau elemen void. Kontainer tidak valid, ID tidak ditemukan, atau renderMode tidak valid mengembalikan AoqECParamInvalid(1) dan mempertahankan pengikatan lama. 0 berarti pengikatan diterima; frame pertama mungkin belum dirender.
setRemoteView
Mengatur kontainer video jarak jauh. SDK membuat elemen rendering di dalamnya.
| Parameter | Tipe | Deskripsi |
|---|---|---|
trackType | AoqTrackType | Hanya AoqTrackTypeVideo yang didukung. Tipe lain mengembalikan AoqECUnSupport(3). |
canvas | AoqVideoCanvas | null | Konfigurasi kontainer rendering. Gunakan null untuk melepas pengikatan. |
0 jika berhasil.
Gunakan kontainer DOM biasa berdimensi eksplisit, misalnya div. Jangan langsung menggunakan elemen video, audio, canvas, img, atau elemen void. Kontainer tidak valid, ID tidak ditemukan, atau renderMode tidak valid mengembalikan AoqECParamInvalid(1) dan mempertahankan pengikatan lama. 0 berarti pengikatan diterima; frame pertama mungkin belum dirender.
Konfigurasi enkode video
setVideoEncoderConfig
Mengatur parameter enkode video.
| Parameter | Tipe | Deskripsi |
|---|---|---|
config | AoqVideoCodecConfig | Konfigurasi enkode video |
0 jika berhasil.
Panggil saat engine Disconnected. Pemanggilan saat menghubungkan atau terhubung mengembalikan AoqECStateInvalid(2). Konfigurasikan sebelum koneksi dan perekaman video pertama. Konfigurasi digabung dan disimpan untuk pembuatan stream berikutnya; perekaman atau encoder yang sudah berjalan tidak langsung dikonfigurasi ulang.
setVideoDecoderConfig
Mengatur parameter dekode video.
| Parameter | Tipe | Deskripsi |
|---|---|---|
config | AoqVideoCodecConfig | Konfigurasi dekode video |
0 jika berhasil.
Panggil sebelum connect() saat engine Disconnected. Perubahan saat menghubungkan atau terhubung mengembalikan AoqECStateInvalid(2).
Kontrol pengiriman stream media
enableSendMediaStream
Mengaktifkan atau menonaktifkan pengiriman track audio atau video.
| Parameter | Tipe | Deskripsi |
|---|---|---|
trackType | AoqTrackType | Tipe track media |
enable | boolean | true: aktifkan pengiriman; false: nonaktifkan pengiriman |
0 jika berhasil.
Hanya mengontrol Audio dan Video, bukan Data. Nilai track lain dapat mengembalikan 0 tanpa efek. Menonaktifkan pengiriman tidak menghentikan perangkat perekaman; panggil stop...Capture() yang sesuai untuk menghentikan perangkat.
Pesan real-time
sendDataMsg
Mengirim teks UTF-8 dalam Uint8Array ke peer, misalnya JSON aplikasi. Jalur WT saat ini tidak mendukung payload biner sembarang atau pengiriman pesan kontrol internal SDK melalui metode ini.
| Parameter | Tipe | Deskripsi |
|---|---|---|
msg | AoqDataMsg | Objek pesan; msg.data harus berisi byte UTF-8 yang tidak kosong |
0 jika berhasil.
Memerlukan engine terhubung dengan track media siap dan Data dalam publishTracks. Pesan yang tidak ada atau msg.data bukan Uint8Array mengembalikan AoqECParamInvalid(1). Koneksi belum siap mengembalikan AoqECStateInvalid(2). Stream pengiriman tidak aktif atau pesan kosong saat ini mengembalikan -1. 0 berarti penerimaan lokal, bukan konfirmasi penerimaan peer. Validasi UTF-8 atau pengiriman berikutnya masih dapat gagal melalui onError.
ArrayBuffer yang mendasari msg.data dapat ditransfer dan dilepas, termasuk view lain yang berbagi buffer. Gunakan salinan data.slice() jika data asli harus tetap tersedia. Jangan kirim API key atau kredensial sementara dalam pesan frontend atau log.
Callback peristiwa
Berlangganan dengan engine.on('eventName', callback), dengarkan sekali dengan engine.once(...), dan batalkan dengan engine.off('eventName', callback) memakai referensi fungsi yang sama. Penghancuran engine menghapus semua listener. Daftarkan sebelum menghubungkan atau memulai perangkat, dan jaga callback tetap ringan.
| Peristiwa | Signature callback | Deskripsi |
|---|---|---|
onError | (code: number, message: string) => void | Callback kesalahan |
onWarning | (code: number, message: string) => void | Callback peringatan |
onConnectionStatusChange | (status: AoqConnectionStatus) => void | Perubahan status koneksi |
onStats | (stats: AoqStats) => void | Statistik |
onAudioDeviceStateChanged | (state: AoqAudioDeviceState) => void | Perubahan status perangkat audio |
onAudioDeviceRouteChanged | (routeType: AoqAudioDeviceRouteType) => void | Perubahan rute audio |
onAudioFileState | (state: AoqAudioFileState) => void | Dicadangkan; saat ini tidak dipancarkan |
onLocalAudioVolumeIndication | (volume: AoqAudioVolume) => void | Indikasi volume lokal |
onVideoDeviceStateChanged | (state: AoqVideoDeviceState) => void | Perubahan status perangkat video |
onDataMsg | (msg: AoqDataMsg) => void | Pesan data |
onError
Melaporkan kesalahan asinkron atau runtime di luar nilai kembali sinkron. Gunakan code dan message bersama status koneksi dan perangkat untuk pemecahan masalah. Kesalahan belum tentu mengakhiri koneksi. Kesalahan jaringan dapat memakai kode status umum; angka saja tidak menentukan tahap kegagalan.
| Parameter | Tipe | Deskripsi |
|---|---|---|
code | number | Kode kesalahan; lihat AoqErrorCode |
message | string | Deskripsi kesalahan |
onWarning
Melaporkan peringatan engine untuk kondisi nonfatal yang memerlukan perhatian.
| Parameter | Tipe | Deskripsi |
|---|---|---|
code | number | Kode peringatan; lihat AoqWarningCode |
message | string | Deskripsi peringatan |
onConnectionStatusChange
Melaporkan perubahan status koneksi.
| Parameter | Tipe | Deskripsi |
|---|---|---|
status | AoqConnectionStatus | Status koneksi saat ini |
onStats
Melaporkan statistik sekitar sekali per detik saat Connected dan berhenti setelah keluar dari status tersebut. Lihat AoqStats untuk ketersediaan kolom. Nilai placeholder bukan hasil pengukuran.
| Parameter | Tipe | Deskripsi |
|---|---|---|
stats | AoqStats | Objek statistik |
onAudioDeviceStateChanged
Melaporkan perubahan status operasi perangkat perekaman dan pemutaran audio.
| Parameter | Tipe | Deskripsi |
|---|---|---|
state | AoqAudioDeviceState | Status perangkat audio |
onAudioDeviceRouteChanged
Saat daftar perangkat keluaran berubah, SDK berupaya menyimpulkan tipe rute dari label perangkat browser. Hasil dapat keliru atau perubahan terlewat dan bukan konfirmasi rute keluaran aktual. Tipe default dapat dikembalikan sebelum otorisasi atau jika informasi perangkat tidak lengkap.
| Parameter | Tipe | Deskripsi |
|---|---|---|
routeType | AoqAudioDeviceRouteType | Tipe rute yang disimpulkan dari label perangkat, bukan konfirmasi perangkat keluaran aktual |
onAudioFileState
Callback status file audio yang dicadangkan. AoqClientEngine saat ini tidak menyediakan kontrol pemutaran file dan tidak memancarkan peristiwa ini.
| Parameter | Tipe | Deskripsi |
|---|---|---|
state | AoqAudioFileState | Status file audio |
onLocalAudioVolumeIndication
Melaporkan volume perekaman lokal. Panggil enableLocalAudioVolumeIndication terlebih dahulu untuk mengaktifkannya.
| Parameter | Tipe | Deskripsi |
|---|---|---|
volume | AoqAudioVolume | Informasi volume |
onVideoDeviceStateChanged
Melaporkan perubahan status operasi perangkat perekaman video.
| Parameter | Tipe | Deskripsi |
|---|---|---|
state | AoqVideoDeviceState | Status perangkat video |
onDataMsg
Melaporkan pesan data yang diterima.
| Parameter | Tipe | Deskripsi |
|---|---|---|
msg | AoqDataMsg | Objek pesan yang diterima. Gunakan TextDecoder untuk membaca teks UTF-8 dari msg.data. |
subscribeTracks untuk menerima pesan. Callback menerima objek, bukan Uint8Array langsung. Kode aplikasi harus mengurai dan memvalidasi JSON aplikasi.
Tipe data dan enum
Tipe umum
AoqCreateConfig
Konfigurasi pembuatan engine.
| Kolom | Tipe | Wajib | Default | Deskripsi |
|---|---|---|---|---|
workDir | string | Tidak | — | Dicadangkan; Web SDK tidak menggunakan kolom ini untuk memilih direktori penyimpanan |
enableDumpAudio | boolean | Tidak | false | Menyimpan data debug audio. Dapatkan otorisasi dan kendalikan akses ke audio pengguna. |
enableDumpExport | boolean | Tidak | false | Hanya berlaku saat enableDumpAudio=true. Mengekspor ZIP dump dan menghapus file OPFS terkait secara asinkron saat penghancuran. |
maxEncodedVideoFrameBytes | number | Tidak | 194560 (190×1024) | Target ukuran maksimum frame JPEG dalam byte. 0 menonaktifkan batas. Kualitas frame berlebih dikurangi; nilai tidak valid memakai default. |
enableDropOversizedVideoFrame | boolean | Tidak | false | Membuang frame JPEG yang masih melebihi batas pada kualitas minimum. Jika false, frame berlebih masih dapat dikirim. Tidak dibuang karena alasan ini jika batas ukuran 0. |
extras | string | Tidak | — | String objek JSON. JSON tidak valid, nilai non-objek, atau kebijakan rendering jarak jauh tidak valid membuat createEngine mengembalikan null. |
extras yang didukung:
| Kolom JSON | Tipe | Default | Deskripsi |
|---|---|---|---|
remoteVideoRenderer | 'auto' | 'video' | 'canvas' | 'auto' | Kebijakan rendering jarak jauh. auto memilih video terlebih dahulu dan beralih ke canvas jika diperlukan. |
user_specified_enable_av_sync | boolean | true | Mengaktifkan sinkronisasi audio/video. Gunakan boolean JSON. |
user_specified_audio_playback_transport | 'message-port' | Otomatis | Memaksa pemutaran MessagePort. Jika dihilangkan, memori bersama atau MessagePort dipilih sesuai lingkungan. |
AoqConnectConfig
Konfigurasi autentikasi koneksi.
| Kolom | Tipe | Wajib | Default | Deskripsi |
|---|---|---|---|---|
token | string | Ya | — | Token klien sementara tidak kosong yang sesuai dengan aoqTokenForClient, bukan API key |
sid | string | Ya | — | ID sesi tidak kosong. Gunakan string sid lengkap dari respons autentikasi. |
wtBaseUrl | string | Tidak | Dibentuk dari Relay | URL HTTPS WT yang diprioritaskan untuk satu rute. Diabaikan untuk beberapa rute, yang terhubung ke /aoq pada host dan port masing-masing. |
signedSid | string | Ya (saat runtime) | — | SID bertanda tangan lengkap, biasanya sid lengkap dari autentikasi. Opsional di TypeScript, tetapi wajib pada alur koneksi WT saat ini. |
certFingerprint | string | string[] | Bersyarat | — | Sidik jari SHA-256 sertifikat WT bersama. Rute tanpa sidik jari sendiri harus dapat memakai nilai ini. |
workspaceIdHash | string | Tidak | — | Sesuai dengan extraInfo.workspaceIdHash. Jangan ganti dengan Workspace ID asli. |
relayEndpoints | AoqRelayEndpoint[] | Ya | — | Daftar endpoint lengkap dengan minimal satu entri |
publishTracks | AoqTrackParam[] | Ya | — | Track uplink. Boleh kosong, tetapi tidak boleh kosong bersamaan dengan subscribeTracks. |
subscribeTracks | AoqTrackParam[] | Ya | — | Track downlink. Boleh kosong. Track duplikat dalam satu arah dan track Screen tidak didukung. |
clientRelayEndpoints[].route_index ke routeIndex di adapter. Jangan membuat SID, endpoint, indeks rute, atau sidik jari sendiri.
Sidik jari WT harus cocok dengan sertifikat endpoint WebTransport sebenarnya. Untuk format sha256/<hex>, hapus prefiks dan validasi 64 digit heksadesimal. Sidik jari bersama maupun per-rute menerima string atau array string; semua entri array harus valid, dan satu kecocokan sudah cukup. Sidik jari rute tidak kosong menimpa nilai bersama; array kosong dianggap belum dikonfigurasi. SDK tidak menyediakan sidik jari universal atau opsi melewati validasi.
signedSid atau sidik jari valid yang tidak ada dapat menyebabkan kegagalan koneksi asinkron meskipun connect() mengembalikan 0. Tangani peristiwa status dan onError.
AoqRelayEndpoint
Endpoint Relay.
| Kolom | Tipe | Wajib | Default | Deskripsi |
|---|---|---|---|---|
routeIndex | number | Ya (saat runtime) | — | Bilangan bulat unik 0 hingga 2147483647. Indeks terendah digunakan di awal. Opsional di TypeScript. |
certFingerprint | string | string[] | Bersyarat | Sidik jari bersama | Sidik jari rute tidak kosong menimpa nilai bersama. Wajib jika sidik jari bersama tidak tersedia. |
endpoint | string | Ya | — | Nama host atau IP WT tanpa skema, path, spasi, informasi pengguna, atau kueri. IPv6 didukung. |
port | number | Ya | — | Port WT berupa bilangan bulat 1 hingga 65535 |
AoqTrackParam
Properti track.
| Kolom | Tipe | Wajib | Default | Deskripsi |
|---|---|---|---|---|
trackType | AoqTrackType | Ya | — | Audio, Video, atau Data. Tidak boleh duplikat dalam satu arah. Screen saat ini tidak didukung. |
trackMode | AoqTrackMode | Tidak | Segment untuk downlink audio | Hanya mengontrol downlink audio. PCM / Opus default ke Segment; pilih Stream secara eksplisit untuk Realtime. Uplink audio selalu Realtime. Uplink, video, dan data mengabaikan kolom ini. |
AoqSupportResult
Hasil pemeriksaan kemampuan browser.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
supported | boolean | — | Apakah lingkungan memiliki kemampuan koneksi AOQ dasar |
missingFeatures | AoqMissingFeature[] | — | Kegagalan prapemeriksaan yang teramati, dapat mencakup 'secure-context', 'worker', dan 'web-transport' |
AoqMissingFeature
Kegagalan prapemeriksaan dasar: 'secure-context' | 'worker' | 'web-transport'. worker juga dapat berarti kebijakan penerapan memblokir, startup atau eksekusi gagal, atau pengujian timeout, bukan hanya API Worker tidak tersedia. Daftar ini bukan penilaian lengkap kemampuan media.
Tipe audio
AoqAudioCaptureConfig
Konfigurasi perekaman audio.
| Kolom | Tipe | Wajib | Default | Deskripsi |
|---|---|---|---|---|
channel | number | Tidak | 1 | Jumlah kanal perekaman yang diminta: 1 (mono) atau 2 (stereo). Pengaturan aktual dapat ditentukan track perangkat. |
AoqAudioPlaybackConfig
Konfigurasi pemutaran audio.
| Kolom | Tipe | Wajib | Default | Deskripsi |
|---|---|---|---|---|
channel | number | Tidak | 1 | Jumlah kanal pemutaran yang diminta: 1 atau 2. Keluaran memakai laju sampel AudioContext aktual. |
playOnlyAndIgnoreMute | boolean | Tidak | false | Untuk pemutaran saja. Mengatur audioSession ke playback jika didukung agar sakelar senyap iOS tidak memengaruhi pemutaran. Pertahankan false jika mikrofon diperlukan. Pengabaian senyap tidak dijamin tanpa dukungan browser. |
AoqAudioCodecConfig
Konfigurasi codec audio.
| Kolom | Tipe | Wajib | Default | Deskripsi |
|---|---|---|---|---|
trackType | AoqTrackType | Tidak | — | Dicadangkan; saat ini tidak digunakan untuk memilih stream audio |
codecType | AoqEncoderType | Tidak | AoqEncoderTypeAudioPCM | PCM / Opus. Harus cocok dengan konfigurasi yang dinegosiasikan peer. |
sampleRate | number | Tidak | 48000 | Laju sampel dalam Hz. Nilai negosiasi: 8000, 12000, 16000, 24000, 32000, 44100, 48000. Browser juga harus mendukung enkode yang dipilih. |
channel | number | Tidak | 1 | Jumlah kanal: 1 atau 2 |
bitrate | number | Tidak | 32000 (enkode Opus) | Dalam bps; hanya untuk enkode Opus. Bitrate PCM mengikuti laju sampel, jumlah kanal, dan kedalaman bit. Tidak untuk dekode. |
AoqAudioVolumeIndicationConfig
Konfigurasi indikasi volume lokal.
| Kolom | Tipe | Wajib | Default | Deskripsi |
|---|---|---|---|---|
interval | number | Tidak | 0 | Interval callback dalam ms. Nilai <=0 menonaktifkan callback; nilai positif di bawah 10 diperlakukan sebagai 10. |
smooth | number | Tidak | 3 | Faktor penghalusan volume, 0..10. Nilai lebih besar lebih halus. |
reportSpeech | boolean | Tidak | false | Apakah melaporkan aktivitas suara (VAD) |
AoqAudioVolume
Informasi volume lokal.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
volume | number | — | Volume sesaat yang dihaluskan, rentang [0-255] |
isSpeech | boolean | — | Penanda aktivitas suara opsional, hanya bermakna saat reportSpeech=true. Tangani nilai yang tidak ada. |
AoqAudioDeviceState
Data callback status perangkat audio.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
state | AoqAudioDeviceStateCode | — | Kode status perangkat audio |
reason | number | — | Kode alasan; lihat AoqErrorCode |
AoqAudioFileState
Struktur status pemutaran file audio yang dicadangkan; Web SDK belum memancarkan peristiwa terkait.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
fileId | string | — | ID file audio |
stateCode | AoqAudioFileStateCode | — | Kode status pemutaran file |
errorCode | number | — | Kode kesalahan |
Tipe video
AoqVideoCaptureConfig
Konfigurasi perekaman video.
| Kolom | Tipe | Wajib | Default | Deskripsi |
|---|---|---|---|---|
width | number | Tidak | 1280 | Lebar perekaman yang diminta dalam piksel dengan batasan ideal. Lebar aktual dipilih browser/perangkat. |
height | number | Tidak | 720 | Tinggi perekaman yang diminta dalam piksel dengan batasan ideal. Tinggi aktual dipilih browser/perangkat. |
fps | number | Tidak | 15 | Frame rate perekaman yang diminta, memakai batasan ideal dan max |
cameraPreference | AoqCameraDirection | string | Tidak | Pilihan browser | Preferensi arah kamera atau ID perangkat dengan batasan ideal. Alternatif diizinkan; string kosong tidak valid. |
AoqVideoCodecConfig
Konfigurasi codec video.
| Kolom | Tipe | Wajib | Default | Deskripsi |
|---|---|---|---|---|
trackType | AoqTrackType | Tidak | — | Dicadangkan; saat ini tidak digunakan untuk memilih stream video |
codecType | AoqEncoderType | Tidak | AoqEncoderTypeVideoH264 | H.264 / JPEG. Harus cocok dengan konfigurasi yang dinegosiasikan peer. |
width | number | Tidak | 540 | Lebar target enkode atau lebar downlink hasil negosiasi dalam piksel. Harus bilangan bulat positif saat menghubungkan. |
height | number | Tidak | 960 | Tinggi target enkode atau tinggi downlink hasil negosiasi dalam piksel. Harus bilangan bulat positif saat menghubungkan. |
fps | number | Tidak | 5 | Frame rate enkode atau downlink hasil negosiasi. Harus bilangan bulat positif saat menghubungkan. |
bitrate | number | Tidak | 500000 (enkode) | Target bitrate enkode positif dalam bps. Tidak digunakan untuk dekode. |
minBitrate | number | Tidak | 128000 | Target bitrate enkode minimum dalam bps. Jika tidak diisi atau 0, gunakan 128000, dibatasi target pengguna. Enkode H.264 tidak dijeda saat anggaran BWE mencapai 0. Tidak untuk dekode. |
keyframeInterval | number | Tidak | 2 | Interval keyframe H.264 dalam detik, minimal 1 detik untuk enkode. Tidak untuk JPEG atau dekode. |
AoqVideoCanvas
Konfigurasi kontainer rendering video.
| Kolom | Tipe | Wajib | Default | Deskripsi |
|---|---|---|---|---|
view | HTMLElement | string | Ya | — | Elemen kontainer biasa atau ID DOM tanpa #. Jangan langsung memakai video, audio, canvas, img, atau elemen void. |
renderMode | AoqRenderMode | Tidak | AoqRenderModeAuto(0) | Mode penyesuaian video |
AoqVideoDeviceState
Data callback status perangkat video.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
state | AoqVideoDeviceStateCode | — | Kode status perangkat video |
reason | number | — | Kode alasan: 0 untuk penghentian eksplisit; AoqECVideoDevice(220) untuk track Web yang berakhir tak terduga |
Tipe pesan data
AoqDataMsg
Struktur bersama untuk sendDataMsg dan onDataMsg publik. API ini tidak menerima string atau Uint8Array langsung. Jalur WT membawa teks UTF-8 dalam array byte.
| Kolom | Tipe | Wajib | Default | Deskripsi |
|---|---|---|---|---|
data | Uint8Array | Ya | — | UTF-8 valid dan tidak kosong saat mengirim. Baca msg.data saat menerima. |
Tipe statistik
AoqStats
Ringkasan statistik engine. Semua kolom berikut opsional dalam definisi tipe; tangani nilai yang tidak ada.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
audioPublishStats | AoqAudioPublishStats[] | — | Statistik publikasi audio |
audioSubscribeStats | AoqAudioSubscribeStats[] | — | Statistik langganan audio |
videoPublishStats | AoqVideoPublishStats[] | — | Statistik publikasi video |
videoSubscribeStats | AoqVideoSubscribeStats[] | — | Statistik langganan video |
dataMsgPublishStats | AoqDataMsgPublishStats[] | — | Statistik publikasi pesan data |
dataMsgSubscribeStats | AoqDataMsgSubscribeStats[] | — | Statistik langganan pesan data |
networkStats | AoqNetworkStats | — | Statistik jaringan |
AoqAudioPublishStats
Statistik publikasi audio.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
trackType | AoqTrackType | — | Tipe track |
bitrate | number | — | Total bitrate aplikasi uplink koneksi dalam bps, bukan bitrate audio terpisah |
bytes | number | — | Total byte aplikasi uplink koneksi, bukan total audio terpisah |
encodeVolume | number | 0 | Placeholder. Gunakan onLocalAudioVolumeIndication untuk volume perekaman. |
AoqAudioSubscribeStats
Statistik langganan audio.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
trackType | AoqTrackType | — | Tipe track |
bitrate | number | — | Total bitrate aplikasi downlink koneksi dalam bps, bukan bitrate audio terpisah |
bytes | number | — | Total byte aplikasi downlink koneksi, bukan total audio terpisah |
playVolume | number | 0 | Placeholder; tidak menunjukkan apakah pemutaran dibisukan |
AoqVideoPublishStats
Statistik publikasi video.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
trackType | AoqTrackType | — | Tipe track |
bitrate | number | 0 | Placeholder; bitrate video terpisah belum dilaporkan |
bytes | number | 0 | Placeholder; jumlah byte video terpisah belum dilaporkan |
encodeFps | number | — | Frame rate enkode |
AoqVideoSubscribeStats
Statistik langganan video.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
trackType | AoqTrackType | — | Tipe track |
bitrate | number | 0 | Placeholder; bitrate video terpisah belum dilaporkan |
bytes | number | 0 | Placeholder; jumlah byte video terpisah belum dilaporkan |
decodeFps | number | — | Frame rate dekode |
renderFps | number | — | Frame rate rendering |
AoqDataMsgPublishStats
Statistik publikasi pesan data.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
trackType | AoqTrackType | — | Tipe track |
bitrate | number | — | Bitrate saat ini dalam bps |
bytes | number | — | Jumlah kumulatif byte terkirim |
AoqDataMsgSubscribeStats
Statistik langganan pesan data.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
trackType | AoqTrackType | — | Tipe track |
bitrate | number | — | Bitrate saat ini dalam bps |
bytes | number | — | Jumlah kumulatif byte diterima |
AoqNetworkStats
Statistik jaringan. Bitrate mengukur bit/detik payload aplikasi, dan total memakai basis payload yang sama dalam byte. Overhead probe dan protokol transport tidak disertakan.
| Kolom | Tipe | Default | Deskripsi |
|---|---|---|---|
sendBitrate | number | — | Bitrate uplink dalam bps |
sendBytes | number | — | Jumlah kumulatif byte uplink |
recvBitrate | number | — | Bitrate downlink dalam bps |
recvBytes | number | — | Jumlah kumulatif byte downlink |
loss | number | — | Rasio kehilangan uplink opsional (0–1). Memakai pengamatan QUIC browser jika tersedia, jika tidak estimasi Relay Datagram. Dihilangkan jika tidak diketahui. |
rtt | number | — | Round-trip time opsional dalam ms; dihilangkan jika tidak diketahui |
bwe | number | — | Anggaran pengiriman aplikasi efektif Client→Relay opsional dalam bps; dihilangkan jika tidak diketahui atau kedaluwarsa |
audioReserveBps | number | — | Bitrate payload yang dicadangkan untuk audio terenkode saat ini dalam bps, opsional. Tidak termasuk redundansi RED dan overhead transport; bukan lalu lintas audio aktual. |
Enum
AoqTrackType
Tipe media track.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqTrackTypeAudio | 0 | Audio |
AoqTrackTypeVideo | 1 | Video |
AoqTrackTypeData | 2 | Pesan data |
AoqTrackTypeScreen | 3 | Dicadangkan; tidak didukung dalam alur koneksi saat ini |
AoqTrackMode
Mode transport audio.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqTrackModeSegment | 0 | Mode Segment |
AoqTrackModeStream | 1 | Mode stream Realtime |
AoqEncoderType
Format media track.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqEncoderTypeUnknown | 0 | Tidak diketahui |
AoqEncoderTypeAudioPCM | 1 | Audio PCM |
AoqEncoderTypeAudioOpus | 2 | Audio Opus |
AoqEncoderTypeVideoH264 | 3 | Video H.264 |
AoqEncoderTypeVideoJpeg | 4 | Video JPEG |
AoqEncoderTypeDataText | 5 | Data teks |
AoqConnectionStatus
Status koneksi engine.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqConnectionStatusDisconnected | 0 | Terputus |
AoqConnectionStatusConnecting | 1 | Menghubungkan |
AoqConnectionStatusConnected | 2 | Terhubung |
AoqConnectionStatusFailed | 3 | Koneksi gagal |
AoqErrorCode
Kode kesalahan.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqECOK | 0 | Berhasil |
AoqECParamInvalid | 1 | Parameter tidak valid |
AoqECStateInvalid | 2 | Status tidak valid |
AoqECUnSupport | 3 | Belum diimplementasikan untuk platform/mode saat ini |
AoqECAudio | 100 | Kesalahan audio umum |
AoqECAudioExternalBufferFull | 110 | Buffer audio eksternal penuh |
AoqECAudioDevice | 120 | Kesalahan perangkat audio umum |
AoqECAudioDeviceRecordingAuthFailed | 121 | Izin mikrofon ditolak |
AoqECAudioDeviceRecordingOccupied | 122 | Mikrofon sedang digunakan |
AoqECAudioDeviceRecordingBackgroundStart | 123 | Perekaman dimulai di latar belakang |
AoqECAudioDeviceRecordingStartFail | 124 | Perekaman gagal dimulai |
AoqECAudioDevicePlayoutOccupied | 125 | Perangkat pemutaran sedang digunakan |
AoqECAudioDevicePlayoutBackgroundStart | 126 | Pemutaran dimulai di latar belakang |
AoqECAudioDevicePlayoutStartFail | 127 | Pemutaran gagal dimulai |
AoqECAudioDeviceEarpieceRequiresVoipMode | 128 | Earpiece memerlukan mode VoIP |
AoqECVideo | 200 | Kesalahan video umum |
AoqECVideoExternalBufferFull | 210 | Buffer video eksternal penuh |
AoqECVideoExternalCaptureNotEnabled | 211 | Perekaman video eksternal belum diaktifkan |
AoqECVideoExternalEncoderNotEnabled | 212 | Encoder video eksternal belum diaktifkan |
AoqECVideoDevice | 220 | Kesalahan perangkat video umum |
AoqECVideoDeviceCameraOpenFail | 221 | Kamera gagal dibuka |
AoqECVideoDeviceCameraAuthFailed | 222 | Izin kamera ditolak |
AoqECVideoDeviceCameraOccupied | 223 | Kamera sedang digunakan |
AoqECVideoDeviceCameraRunningError | 224 | Kesalahan runtime kamera |
AoqECVideoCodec | 230 | Kesalahan codec video umum |
AoqECVideoCodecEncoderInitFail | 231 | Inisialisasi encoder video gagal |
AoqECVideoRender | 240 | Kesalahan rendering video umum |
AoqECVideoRenderCreateFail | 241 | Pembuatan renderer gagal |
AoqECVideoRenderDrawError | 242 | Kesalahan penggambaran rendering |
AoqWarningCode
Kode peringatan.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqWCOK | 0 | Normal |
AoqWCAudio | 100 | Peringatan audio umum |
AoqWCAudioHowling | 101 | Umpan balik akustik terdeteksi |
AoqWCAudioDevice | 120 | Peringatan perangkat audio umum |
AoqWCAudioDeviceMicEnumerateError | 121 | Kesalahan pendaftaran mikrofon |
AoqWCAudioDeviceMicStartTimeout | 122 | Timeout memulai mikrofon |
AoqWCAudioDeviceRecordingError | 123 | Kesalahan perekaman |
AoqWCAudioDeviceSpeakerEnumerateError | 124 | Kesalahan pendaftaran speaker |
AoqWCAudioDeviceSpeakerStartTimeout | 125 | Timeout memulai speaker |
AoqWCAudioDevicePlayoutError | 126 | Kesalahan pemutaran |
AoqWCAudioDeviceSilentMode | 127 | Perangkat dalam mode senyap |
AoqWCVideo | 200 | Peringatan video umum |
AoqWCVideoCameraEnumerateError | 201 | Kesalahan pendaftaran kamera |
AoqWCVideoEncoderSwitched | 202 | Encoder video dialihkan |
AoqWCVideoRenderDowngrade | 203 | Rendering beralih ke alternatif |
AoqAudioDeviceStateCode
Kode status perangkat audio.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqAudioDeviceNone | 0 | Tidak ada status |
AoqAudioDeviceRecordStarting | 1 | Perekaman sedang dimulai |
AoqAudioDeviceRecordStarted | 2 | Perekaman dimulai |
AoqAudioDeviceRecordStopping | 3 | Perekaman sedang dihentikan |
AoqAudioDeviceRecordStopped | 4 | Perekaman dihentikan |
AoqAudioDeviceRecordFail | 5 | Perekaman gagal |
AoqAudioDevicePlayStarting | 6 | Pemutaran sedang dimulai |
AoqAudioDevicePlayStarted | 7 | Pemutaran dimulai |
AoqAudioDevicePlayStopping | 8 | Pemutaran sedang dihentikan |
AoqAudioDevicePlayStopped | 9 | Pemutaran dihentikan |
AoqAudioDevicePlayFail | 10 | Pemutaran gagal |
AoqAudioDeviceRouteType
Tipe rute perangkat audio.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqAudioDeviceRouteDefault | 0 | Rute default |
AoqAudioDeviceRouteHeadset | 1 | Headset |
AoqAudioDeviceRouteSpeakerPhone | 4 | Speaker internal |
AoqAudioDeviceRouteUsb | 5 | Perangkat USB |
AoqAudioDeviceRouteBluetooth | 6 | Perangkat Bluetooth |
AoqAudioFileStateCode
Kode status pemutaran file audio.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqAudioFileNone | 0 | Tidak ada status |
AoqAudioFileStarted | 1 | Pemutaran dimulai |
AoqAudioFileStopped | 2 | Pemutaran dihentikan |
AoqAudioFilePaused | 3 | Pemutaran dijeda |
AoqAudioFileResumed | 4 | Pemutaran dilanjutkan |
AoqAudioFileEnded | 5 | Pemutaran berakhir |
AoqAudioFileBuffering | 6 | Buffering |
AoqAudioFileBufferingEnd | 7 | Buffering selesai |
AoqAudioFileFailed | 8 | Pemutaran gagal |
AoqCameraDirection
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqCameraDirectionFront | 0 | Utamakan kamera depan |
AoqCameraDirectionBack | 1 | Utamakan kamera belakang |
AoqVideoDeviceStateCode
Kode status perangkat video.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqVideoDeviceNone | 0 | Tidak ada status |
AoqVideoDeviceCaptureStarting | 1 | Perekaman sedang dimulai |
AoqVideoDeviceCaptureStarted | 2 | Perekaman dimulai |
AoqVideoDeviceCaptureStopping | 3 | Perekaman sedang dihentikan |
AoqVideoDeviceCaptureStopped | 4 | Perekaman dihentikan |
AoqVideoDeviceCaptureFail | 5 | Perekaman gagal |
AoqMirrorMode
Enum mode cermin yang dicadangkan. Web SDK tidak memiliki konfigurasi atau API yang menggunakannya.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqMirrorModeDisabled | 0 | Pencerminan dinonaktifkan |
AoqMirrorModeEnabled | 1 | Pencerminan diaktifkan |
AoqOrientationMode
Enum mode orientasi yang dicadangkan. Web SDK tidak memiliki konfigurasi atau API yang menggunakannya.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqOrientationModeAuto | 0 | Otomatis |
AoqOrientationModePortrait | 1 | Potret |
AoqOrientationModeLandscape | 2 | Lanskap |
AoqRenderMode
Mode penyesuaian video.
| Anggota enum | Nilai | Deskripsi |
|---|---|---|
AoqRenderModeAuto | 0 | Default: tampilkan gambar penuh dengan rasio aspek tetap |
AoqRenderModeStretch | 1 | Regangkan hingga memenuhi kontainer |
AoqRenderModeFill | 2 | Tampilkan gambar penuh dengan rasio aspek tetap; bilah hitam diizinkan |
AoqRenderModeCrop | 3 | Penuhi kontainer dengan rasio aspek tetap; potong bagian berlebih |
Deklarasi publik lainnya
IAoqEngineEvents mendefinisikan 10 signature callback peristiwa, termasuk peristiwa cadangan onAudioFileState. Berlangganan berdasarkan nama peristiwa menyediakan inferensi parameter TypeScript.
Tipe dan enum berikut diekspor, tetapi engine Web saat ini tidak menyediakan API kontrol atau observer terkait. Nama deklarasi yang sama pada platform lain tidak berarti dukungan Web.
| Kategori | Deklarasi publik | Cakupan saat ini |
|---|---|---|
| Mixing file audio | AoqAudioFileMixConfig, AoqAudioFileState, AoqAudioFileStateCode | Tidak ada kontrol pemutaran atau mixing file; peristiwa status file tidak dipancarkan |
| Audio eksternal dan observer | AoqAudioExternalStreamConfig, AoqAudioExternalFrameMeta, AoqAudioObserverParams, AoqAudioSource, AoqAudioStreamDirection | Tidak ada metode input audio eksternal atau pendaftaran observer frame audio |
| Video eksternal dan observer | AoqExternalVideoFrameMeta, AoqExternalVideoEncodedFrameMeta, AoqVideoObserverParams, AoqVideoSource, AoqVideoPixelFormat, AoqVideoObserverAlignment, AoqVideoCodecType | Tidak ada metode input frame video eksternal atau pendaftaran observer frame video. Konfigurasi codec menggunakan AoqEncoderType. |
| Pencerminan dan orientasi | AoqMirrorMode, AoqOrientationMode | Tidak ada kolom konfigurasi atau metode terkait. Pencerminan pratinjau lokal otomatis. |
| Perangkat audio tingkat rendah | AoqAudioDeviceEvent, AudioDeviceApiError, AudioDeviceErrorCode | Deklarasi perangkat tingkat rendah, bukan peristiwa engine tambahan atau kontrak lengkap kode kembali engine |
AOQ_TRACK_AUDIO dan AOQ_TRACK_DATA adalah konstanta string 'aoq_track_audio' dan 'aoq_track_data'. Keduanya bukan pemilih track untuk metode koneksi atau view; gunakan AoqTrackType untuk API tersebut.
Enum kesalahan dan peringatan mempertahankan nilai lintas platform. Tidak semua nilai dihasilkan Web SDK. Tentukan ketersediaan berdasarkan metode dan syarat yang dijelaskan di sini.