Skip to main content

Referensi API AOQ Web SDK

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:
npm install aoq-web-sdk@1.0.1-60040320
Sebagai alternatif, unduh paket instalasi dari Unduh SDK, lalu jalankan perintah berikut di direktori proyek. Ganti path paket dengan lokasi sebenarnya.
npm install ./aoq-web-sdk-1.0.1-60040320.tgz

Daftar API

Siklus hidup engine

APIDeskripsi
createEngineMembuat engine singleton
createAoqClientEngineFungsi factory bernama yang setara
destroyMenghancurkan engine
getVersionMendapatkan versi SDK
isAoqSupportedMemeriksa kemampuan browser
connectMemulai koneksi
disconnectMemutuskan koneksi

Manajemen perangkat audio

APIDeskripsi
startAudioCaptureMemulai perekaman audio
stopAudioCaptureMenghentikan perekaman audio
muteAudioCaptureMembisukan perekaman audio
startAudioPlayerMemulai pemutaran audio
stopAudioPlayerMenghentikan pemutaran audio
pauseAudioPlayerMenjeda pemutaran dengan fade-out
resumeAudioPlayerMelanjutkan pemutaran dengan fade-in default
interruptAudioPlayerMenginterupsi pemutaran

Konfigurasi enkode audio

APIDeskripsi
setAudioEncoderConfigMengatur parameter enkode audio
setAudioDecoderConfigMengatur parameter dekode audio

Indikasi volume lokal

APIDeskripsi
enableLocalAudioVolumeIndicationMengaktifkan indikasi volume lokal

Manajemen perangkat video

APIDeskripsi
startVideoCaptureMemulai perekaman video
getCamerasMendaftar kamera
switchCameraBeralih kamera berdasarkan preferensi arah atau ID perangkat
stopVideoCaptureMenghentikan perekaman video
setLocalViewMengatur kontainer video lokal
setRemoteViewMengatur kontainer video jarak jauh

Konfigurasi enkode video

APIDeskripsi
setVideoEncoderConfigMengatur parameter enkode video
setVideoDecoderConfigMengatur parameter dekode video

Kontrol pengiriman stream media

APIDeskripsi
enableSendMediaStreamMengaktifkan atau menonaktifkan pengiriman stream media

Pesan real-time

APIDeskripsi
sendDataMsgMengirim pesan data

Callback peristiwa

APIDeskripsi
onErrorCallback kesalahan
onWarningCallback peringatan
onConnectionStatusChangePerubahan status koneksi
onStatsStatistik
onAudioDeviceStateChangedPerubahan status perangkat audio
onAudioDeviceRouteChangedPerubahan rute audio
onAudioFileStatePeristiwa status file audio yang dicadangkan; saat ini tidak dipancarkan
onLocalAudioVolumeIndicationIndikasi volume lokal
onVideoDeviceStateChangedPerubahan status perangkat video
onDataMsgPesan data

Detail API

Siklus hidup engine

createEngine

Membuat engine singleton. Pemanggilan berulang mengembalikan instance yang sudah ada.
static createEngine(config: AoqCreateConfig): AoqClientEngine | null
ParameterTipeDeskripsi
configAoqCreateConfigKonfigurasi pembuatan engine
Mengembalikan instance 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.
function createAoqClientEngine(config: AoqCreateConfig): AoqClientEngine | null
ParameterTipeDeskripsi
configAoqCreateConfigWajib; {} valid. Pembuatan berulang tidak menerapkan ulang konfigurasi.
Mengembalikan engine singleton jika berhasil, atau null jika gagal.
import { createAoqClientEngine } from 'aoq-web-sdk';

const engine = createAoqClientEngine({});
if (!engine) throw new Error('创建引擎失败');

destroy

Menghancurkan engine, memulai pelepasan sumber daya, dan menghapus semua listener peristiwa.
static destroy(): number
Mengembalikan 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.
static getVersion(): string
Mengembalikan versi paket terinstal sebagai string, bukan revisi dokumen atau ID commit sumber.

isAoqSupported

Memeriksa kemampuan dasar browser yang diperlukan untuk koneksi AOQ.
static isAoqSupported(): Promise<AoqSupportResult>
Mengembalikan 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.
connect(config: AoqConnectConfig): number
ParameterTipeDeskripsi
configAoqConnectConfigKredensial koneksi, termasuk token, ID sesi, dan endpoint relay
Mengembalikan 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.
disconnect(): number
Mengembalikan 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.
startAudioCapture(config: AoqAudioCaptureConfig): Promise<number>
ParameterTipeDeskripsi
configAoqAudioCaptureConfigKonfigurasi perekaman audio
Mengembalikan 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.
stopAudioCapture(): number
Mengembalikan 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.
muteAudioCapture(mute: boolean): number
ParameterTipeDeskripsi
mutebooleantrue: bisukan; false: aktifkan suara
Mengembalikan 0 jika berhasil.

startAudioPlayer

Memulai pemutar audio dan menginisialisasi perangkat keluaran secara asinkron.
startAudioPlayer(config: AoqAudioPlaybackConfig): Promise<number>
ParameterTipeDeskripsi
configAoqAudioPlaybackConfigKonfigurasi pemutaran audio
Mengembalikan 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.
stopAudioPlayer(): number
Mengembalikan 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.
pauseAudioPlayer(fadeMs: number): number
ParameterTipeDeskripsi
fadeMsnumberDurasi fade-out dalam ms, dibulatkan menjadi jumlah sampel pada laju sampel perangkat sebenarnya. 0 menonaktifkan fade; nilai negatif atau tidak hingga menggunakan 100 ms.
Mengembalikan 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.
resumeAudioPlayer(fadeMs: number): number
ParameterTipeDeskripsi
fadeMsnumberDicadangkan dan saat ini diabaikan. Fade-in default digunakan; 0 tidak menonaktifkannya.
Mengembalikan 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.
interruptAudioPlayer(trackType: AoqTrackType, fadeMs: number): number
ParameterTipeDeskripsi
trackTypeAoqTrackTypeParameter kompatibilitas. Gunakan Audio. Saat ini parameter ini tidak memilih stream pemutaran.
fadeMsnumberDurasi fade-out dalam ms, dibulatkan menjadi jumlah sampel pada laju sampel perangkat sebenarnya. 0 menonaktifkan fade; nilai negatif atau tidak hingga menggunakan 100 ms.
Mengembalikan 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.
setAudioEncoderConfig(config: AoqAudioCodecConfig): number
ParameterTipeDeskripsi
configAoqAudioCodecConfigKonfigurasi enkode audio
Mengembalikan 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.
setAudioDecoderConfig(config: AoqAudioCodecConfig): number
ParameterTipeDeskripsi
configAoqAudioCodecConfigKonfigurasi dekode audio
Mengembalikan 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.
enableLocalAudioVolumeIndication(config: AoqAudioVolumeIndicationConfig): number
ParameterTipeDeskripsi
configAoqAudioVolumeIndicationConfigKonfigurasi indikasi volume
Mengembalikan 0 jika berhasil. Atur interval ke 0 atau nilai negatif untuk menonaktifkan callback.

Manajemen perangkat video

startVideoCapture

Memulai perekaman kamera.
startVideoCapture(config: AoqVideoCaptureConfig): number
ParameterTipeDeskripsi
configAoqVideoCaptureConfigKonfigurasi perekaman video
Mengembalikan 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

getCameras(): Promise<MediaDeviceInfo[]>
Mendaftar perangkat 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

switchCamera(cameraPreference?: AoqCameraDirection | string): number
ParameterTipeWajibDeskripsi
cameraPreferenceAoqCameraDirection | stringTidakPreferensi arah atau ID perangkat. Hilangkan untuk menghapus preferensi sebelumnya dan membiarkan browser memilih ulang.
Arah dan ID perangkat menggunakan batasan ideal yang mengizinkan kamera alternatif. 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.
stopVideoCapture(): number
Mengembalikan 0 jika berhasil. Mengembalikan AoqECStateInvalid(2) jika perangkat belum dimulai atau sudah dihentikan.

setLocalView

Mengatur kontainer video lokal. SDK membuat elemen rendering di dalamnya.
setLocalView(trackType: AoqTrackType, canvas: AoqVideoCanvas | null): number
ParameterTipeDeskripsi
trackTypeAoqTrackTypeHanya AoqTrackTypeVideo yang didukung. Tipe lain mengembalikan AoqECUnSupport(3).
canvasAoqVideoCanvas | nullKonfigurasi kontainer rendering. Gunakan null untuk melepas pengikatan.
Mengembalikan 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.
setRemoteView(trackType: AoqTrackType, canvas: AoqVideoCanvas | null): number
ParameterTipeDeskripsi
trackTypeAoqTrackTypeHanya AoqTrackTypeVideo yang didukung. Tipe lain mengembalikan AoqECUnSupport(3).
canvasAoqVideoCanvas | nullKonfigurasi kontainer rendering. Gunakan null untuk melepas pengikatan.
Mengembalikan 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.
setVideoEncoderConfig(config: AoqVideoCodecConfig): number
ParameterTipeDeskripsi
configAoqVideoCodecConfigKonfigurasi enkode video
Mengembalikan 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.
setVideoDecoderConfig(config: AoqVideoCodecConfig): number
ParameterTipeDeskripsi
configAoqVideoCodecConfigKonfigurasi dekode video
Mengembalikan 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.
enableSendMediaStream(trackType: AoqTrackType, enable: boolean): number
ParameterTipeDeskripsi
trackTypeAoqTrackTypeTipe track media
enablebooleantrue: aktifkan pengiriman; false: nonaktifkan pengiriman
Mengembalikan 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.
sendDataMsg(msg: AoqDataMsg): number
ParameterTipeDeskripsi
msgAoqDataMsgObjek pesan; msg.data harus berisi byte UTF-8 yang tidak kosong
Mengembalikan 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.
const data = new TextEncoder().encode(JSON.stringify({ type: 'user_message', text: '你好' }));
const code = engine.sendDataMsg({ data });
if (code !== 0) console.error('消息未受理', code);
Contoh JSON hanya menunjukkan enkode. Ikuti protokol pesan data model yang dipilih untuk kolom aktual dan kesiapan aplikasi.

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.
import { AoqConnectionStatus } from 'aoq-web-sdk';

const handleStatus = (status: AoqConnectionStatus) => console.log('连接状态', status);
engine.on('onConnectionStatusChange', handleStatus);
engine.off('onConnectionStatusChange', handleStatus);
PeristiwaSignature callbackDeskripsi
onError(code: number, message: string) => voidCallback kesalahan
onWarning(code: number, message: string) => voidCallback peringatan
onConnectionStatusChange(status: AoqConnectionStatus) => voidPerubahan status koneksi
onStats(stats: AoqStats) => voidStatistik
onAudioDeviceStateChanged(state: AoqAudioDeviceState) => voidPerubahan status perangkat audio
onAudioDeviceRouteChanged(routeType: AoqAudioDeviceRouteType) => voidPerubahan rute audio
onAudioFileState(state: AoqAudioFileState) => voidDicadangkan; saat ini tidak dipancarkan
onLocalAudioVolumeIndication(volume: AoqAudioVolume) => voidIndikasi volume lokal
onVideoDeviceStateChanged(state: AoqVideoDeviceState) => voidPerubahan status perangkat video
onDataMsg(msg: AoqDataMsg) => voidPesan 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.
engine.on('onError', (code: number, message: string) => { /* 在此处理回调 */ });
ParameterTipeDeskripsi
codenumberKode kesalahan; lihat AoqErrorCode
messagestringDeskripsi kesalahan

onWarning

Melaporkan peringatan engine untuk kondisi nonfatal yang memerlukan perhatian.
engine.on('onWarning', (code: number, message: string) => { /* 在此处理回调 */ });
ParameterTipeDeskripsi
codenumberKode peringatan; lihat AoqWarningCode
messagestringDeskripsi peringatan

onConnectionStatusChange

Melaporkan perubahan status koneksi.
engine.on('onConnectionStatusChange', (status: AoqConnectionStatus) => { /* 在此处理回调 */ });
ParameterTipeDeskripsi
statusAoqConnectionStatusStatus 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.
engine.on('onStats', (stats: AoqStats) => { /* 在此处理回调 */ });
ParameterTipeDeskripsi
statsAoqStatsObjek statistik

onAudioDeviceStateChanged

Melaporkan perubahan status operasi perangkat perekaman dan pemutaran audio.
engine.on('onAudioDeviceStateChanged', (state: AoqAudioDeviceState) => { /* 在此处理回调 */ });
ParameterTipeDeskripsi
stateAoqAudioDeviceStateStatus 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.
engine.on('onAudioDeviceRouteChanged', (routeType: AoqAudioDeviceRouteType) => { /* 在此处理回调 */ });
ParameterTipeDeskripsi
routeTypeAoqAudioDeviceRouteTypeTipe 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.
engine.on('onAudioFileState', (state: AoqAudioFileState) => { /* 在此处理回调 */ });
ParameterTipeDeskripsi
stateAoqAudioFileStateStatus file audio

onLocalAudioVolumeIndication

Melaporkan volume perekaman lokal. Panggil enableLocalAudioVolumeIndication terlebih dahulu untuk mengaktifkannya.
engine.on('onLocalAudioVolumeIndication', (volume: AoqAudioVolume) => { /* 在此处理回调 */ });
ParameterTipeDeskripsi
volumeAoqAudioVolumeInformasi volume

onVideoDeviceStateChanged

Melaporkan perubahan status operasi perangkat perekaman video.
engine.on('onVideoDeviceStateChanged', (state: AoqVideoDeviceState) => { /* 在此处理回调 */ });
ParameterTipeDeskripsi
stateAoqVideoDeviceStateStatus perangkat video

onDataMsg

Melaporkan pesan data yang diterima.
engine.on('onDataMsg', (msg: AoqDataMsg) => { /* 使用 msg.data 读取消息数据 */ });
ParameterTipeDeskripsi
msgAoqDataMsgObjek pesan yang diterima. Gunakan TextDecoder untuk membaca teks UTF-8 dari msg.data.
Sertakan Data dalam 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.
KolomTipeWajibDefaultDeskripsi
workDirstringTidak—Dicadangkan; Web SDK tidak menggunakan kolom ini untuk memilih direktori penyimpanan
enableDumpAudiobooleanTidakfalseMenyimpan data debug audio. Dapatkan otorisasi dan kendalikan akses ke audio pengguna.
enableDumpExportbooleanTidakfalseHanya berlaku saat enableDumpAudio=true. Mengekspor ZIP dump dan menghapus file OPFS terkait secara asinkron saat penghancuran.
maxEncodedVideoFrameBytesnumberTidak194560 (190×1024)Target ukuran maksimum frame JPEG dalam byte. 0 menonaktifkan batas. Kualitas frame berlebih dikurangi; nilai tidak valid memakai default.
enableDropOversizedVideoFramebooleanTidakfalseMembuang 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.
extrasstringTidak—String objek JSON. JSON tidak valid, nilai non-objek, atau kebijakan rendering jarak jauh tidak valid membuat createEngine mengembalikan null.
Kolom extras yang didukung:
Kolom JSONTipeDefaultDeskripsi
remoteVideoRenderer'auto' | 'video' | 'canvas''auto'Kebijakan rendering jarak jauh. auto memilih video terlebih dahulu dan beralih ke canvas jika diperlukan.
user_specified_enable_av_syncbooleantrueMengaktifkan sinkronisasi audio/video. Gunakan boolean JSON.
user_specified_audio_playback_transport'message-port'OtomatisMemaksa pemutaran MessagePort. Jika dihilangkan, memori bersama atau MessagePort dipilih sesuai lingkungan.
Kolom ini tidak mengubah header respons HTTP atau mengaktifkan API diagnostik publik.

AoqConnectConfig

Konfigurasi autentikasi koneksi.
KolomTipeWajibDefaultDeskripsi
tokenstringYa—Token klien sementara tidak kosong yang sesuai dengan aoqTokenForClient, bukan API key
sidstringYa—ID sesi tidak kosong. Gunakan string sid lengkap dari respons autentikasi.
wtBaseUrlstringTidakDibentuk dari RelayURL HTTPS WT yang diprioritaskan untuk satu rute. Diabaikan untuk beberapa rute, yang terhubung ke /aoq pada host dan port masing-masing.
signedSidstringYa (saat runtime)—SID bertanda tangan lengkap, biasanya sid lengkap dari autentikasi. Opsional di TypeScript, tetapi wajib pada alur koneksi WT saat ini.
certFingerprintstring | string[]Bersyarat—Sidik jari SHA-256 sertifikat WT bersama. Rute tanpa sidik jari sendiri harus dapat memakai nilai ini.
workspaceIdHashstringTidak—Sesuai dengan extraInfo.workspaceIdHash. Jangan ganti dengan Workspace ID asli.
relayEndpointsAoqRelayEndpoint[]Ya—Daftar endpoint lengkap dengan minimal satu entri
publishTracksAoqTrackParam[]Ya—Track uplink. Boleh kosong, tetapi tidak boleh kosong bersamaan dengan subscribeTracks.
subscribeTracksAoqTrackParam[]Ya—Track downlink. Boleh kosong. Track duplikat dalam satu arah dan track Screen tidak didukung.
Backend aplikasi harus mengembalikan kredensial koneksi yang lengkap dan valid. Petakan 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.
KolomTipeWajibDefaultDeskripsi
routeIndexnumberYa (saat runtime)—Bilangan bulat unik 0 hingga 2147483647. Indeks terendah digunakan di awal. Opsional di TypeScript.
certFingerprintstring | string[]BersyaratSidik jari bersamaSidik jari rute tidak kosong menimpa nilai bersama. Wajib jika sidik jari bersama tidak tersedia.
endpointstringYa—Nama host atau IP WT tanpa skema, path, spasi, informasi pengguna, atau kueri. IPv6 didukung.
portnumberYa—Port WT berupa bilangan bulat 1 hingga 65535

AoqTrackParam

Properti track.
KolomTipeWajibDefaultDeskripsi
trackTypeAoqTrackTypeYa—Audio, Video, atau Data. Tidak boleh duplikat dalam satu arah. Screen saat ini tidak didukung.
trackModeAoqTrackModeTidakSegment untuk downlink audioHanya 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.
KolomTipeDefaultDeskripsi
supportedboolean—Apakah lingkungan memiliki kemampuan koneksi AOQ dasar
missingFeaturesAoqMissingFeature[]—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.
KolomTipeWajibDefaultDeskripsi
channelnumberTidak1Jumlah kanal perekaman yang diminta: 1 (mono) atau 2 (stereo). Pengaturan aktual dapat ditentukan track perangkat.

AoqAudioPlaybackConfig

Konfigurasi pemutaran audio.
KolomTipeWajibDefaultDeskripsi
channelnumberTidak1Jumlah kanal pemutaran yang diminta: 1 atau 2. Keluaran memakai laju sampel AudioContext aktual.
playOnlyAndIgnoreMutebooleanTidakfalseUntuk 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.
KolomTipeWajibDefaultDeskripsi
trackTypeAoqTrackTypeTidak—Dicadangkan; saat ini tidak digunakan untuk memilih stream audio
codecTypeAoqEncoderTypeTidakAoqEncoderTypeAudioPCMPCM / Opus. Harus cocok dengan konfigurasi yang dinegosiasikan peer.
sampleRatenumberTidak48000Laju sampel dalam Hz. Nilai negosiasi: 8000, 12000, 16000, 24000, 32000, 44100, 48000. Browser juga harus mendukung enkode yang dipilih.
channelnumberTidak1Jumlah kanal: 1 atau 2
bitratenumberTidak32000 (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.
KolomTipeWajibDefaultDeskripsi
intervalnumberTidak0Interval callback dalam ms. Nilai <=0 menonaktifkan callback; nilai positif di bawah 10 diperlakukan sebagai 10.
smoothnumberTidak3Faktor penghalusan volume, 0..10. Nilai lebih besar lebih halus.
reportSpeechbooleanTidakfalseApakah melaporkan aktivitas suara (VAD)

AoqAudioVolume

Informasi volume lokal.
KolomTipeDefaultDeskripsi
volumenumber—Volume sesaat yang dihaluskan, rentang [0-255]
isSpeechboolean—Penanda aktivitas suara opsional, hanya bermakna saat reportSpeech=true. Tangani nilai yang tidak ada.

AoqAudioDeviceState

Data callback status perangkat audio.
KolomTipeDefaultDeskripsi
stateAoqAudioDeviceStateCode—Kode status perangkat audio
reasonnumber—Kode alasan; lihat AoqErrorCode

AoqAudioFileState

Struktur status pemutaran file audio yang dicadangkan; Web SDK belum memancarkan peristiwa terkait.
KolomTipeDefaultDeskripsi
fileIdstring—ID file audio
stateCodeAoqAudioFileStateCode—Kode status pemutaran file
errorCodenumber—Kode kesalahan

Tipe video

AoqVideoCaptureConfig

Konfigurasi perekaman video.
KolomTipeWajibDefaultDeskripsi
widthnumberTidak1280Lebar perekaman yang diminta dalam piksel dengan batasan ideal. Lebar aktual dipilih browser/perangkat.
heightnumberTidak720Tinggi perekaman yang diminta dalam piksel dengan batasan ideal. Tinggi aktual dipilih browser/perangkat.
fpsnumberTidak15Frame rate perekaman yang diminta, memakai batasan ideal dan max
cameraPreferenceAoqCameraDirection | stringTidakPilihan browserPreferensi arah kamera atau ID perangkat dengan batasan ideal. Alternatif diizinkan; string kosong tidak valid.

AoqVideoCodecConfig

Konfigurasi codec video.
KolomTipeWajibDefaultDeskripsi
trackTypeAoqTrackTypeTidak—Dicadangkan; saat ini tidak digunakan untuk memilih stream video
codecTypeAoqEncoderTypeTidakAoqEncoderTypeVideoH264H.264 / JPEG. Harus cocok dengan konfigurasi yang dinegosiasikan peer.
widthnumberTidak540Lebar target enkode atau lebar downlink hasil negosiasi dalam piksel. Harus bilangan bulat positif saat menghubungkan.
heightnumberTidak960Tinggi target enkode atau tinggi downlink hasil negosiasi dalam piksel. Harus bilangan bulat positif saat menghubungkan.
fpsnumberTidak5Frame rate enkode atau downlink hasil negosiasi. Harus bilangan bulat positif saat menghubungkan.
bitratenumberTidak500000 (enkode)Target bitrate enkode positif dalam bps. Tidak digunakan untuk dekode.
minBitratenumberTidak128000Target 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.
keyframeIntervalnumberTidak2Interval keyframe H.264 dalam detik, minimal 1 detik untuk enkode. Tidak untuk JPEG atau dekode.

AoqVideoCanvas

Konfigurasi kontainer rendering video.
KolomTipeWajibDefaultDeskripsi
viewHTMLElement | stringYa—Elemen kontainer biasa atau ID DOM tanpa #. Jangan langsung memakai video, audio, canvas, img, atau elemen void.
renderModeAoqRenderModeTidakAoqRenderModeAuto(0)Mode penyesuaian video
Pratinjau lokal otomatis dicerminkan melalui CSS jika track kamera aktual menghadap depan; arah tidak diketahui tidak dicerminkan. Piksel terenkode tidak berubah. Tidak ada konfigurasi cermin atau orientasi terpisah. Penggantian tidak valid mempertahankan pengikatan lama. Pelepasan dengan null hanya menghapus node rendering milik SDK, bukan node aplikasi.

AoqVideoDeviceState

Data callback status perangkat video.
KolomTipeDefaultDeskripsi
stateAoqVideoDeviceStateCode—Kode status perangkat video
reasonnumber—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.
KolomTipeWajibDefaultDeskripsi
dataUint8ArrayYa—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.
KolomTipeDefaultDeskripsi
audioPublishStatsAoqAudioPublishStats[]—Statistik publikasi audio
audioSubscribeStatsAoqAudioSubscribeStats[]—Statistik langganan audio
videoPublishStatsAoqVideoPublishStats[]—Statistik publikasi video
videoSubscribeStatsAoqVideoSubscribeStats[]—Statistik langganan video
dataMsgPublishStatsAoqDataMsgPublishStats[]—Statistik publikasi pesan data
dataMsgSubscribeStatsAoqDataMsgSubscribeStats[]—Statistik langganan pesan data
networkStatsAoqNetworkStats—Statistik jaringan
onStats belum mengisi dataMsgPublishStats atau dataMsgSubscribeStats. bitrate / bytes audio berisi total koneksi, bukan lalu lintas audio terpisah; encodeVolume / playVolume selalu 0. bitrate / bytes video juga selalu 0; hanya frame rate berasal dari engine video. Gunakan networkStats untuk total lalu lintas dan onLocalAudioVolumeIndication untuk volume perekaman.

AoqAudioPublishStats

Statistik publikasi audio.
KolomTipeDefaultDeskripsi
trackTypeAoqTrackType—Tipe track
bitratenumber—Total bitrate aplikasi uplink koneksi dalam bps, bukan bitrate audio terpisah
bytesnumber—Total byte aplikasi uplink koneksi, bukan total audio terpisah
encodeVolumenumber0Placeholder. Gunakan onLocalAudioVolumeIndication untuk volume perekaman.

AoqAudioSubscribeStats

Statistik langganan audio.
KolomTipeDefaultDeskripsi
trackTypeAoqTrackType—Tipe track
bitratenumber—Total bitrate aplikasi downlink koneksi dalam bps, bukan bitrate audio terpisah
bytesnumber—Total byte aplikasi downlink koneksi, bukan total audio terpisah
playVolumenumber0Placeholder; tidak menunjukkan apakah pemutaran dibisukan

AoqVideoPublishStats

Statistik publikasi video.
KolomTipeDefaultDeskripsi
trackTypeAoqTrackType—Tipe track
bitratenumber0Placeholder; bitrate video terpisah belum dilaporkan
bytesnumber0Placeholder; jumlah byte video terpisah belum dilaporkan
encodeFpsnumber—Frame rate enkode

AoqVideoSubscribeStats

Statistik langganan video.
KolomTipeDefaultDeskripsi
trackTypeAoqTrackType—Tipe track
bitratenumber0Placeholder; bitrate video terpisah belum dilaporkan
bytesnumber0Placeholder; jumlah byte video terpisah belum dilaporkan
decodeFpsnumber—Frame rate dekode
renderFpsnumber—Frame rate rendering

AoqDataMsgPublishStats

Statistik publikasi pesan data.
KolomTipeDefaultDeskripsi
trackTypeAoqTrackType—Tipe track
bitratenumber—Bitrate saat ini dalam bps
bytesnumber—Jumlah kumulatif byte terkirim
Tipe telah didefinisikan, tetapi onStats belum mengisi array ini.

AoqDataMsgSubscribeStats

Statistik langganan pesan data.
KolomTipeDefaultDeskripsi
trackTypeAoqTrackType—Tipe track
bitratenumber—Bitrate saat ini dalam bps
bytesnumber—Jumlah kumulatif byte diterima
Tipe telah didefinisikan, tetapi onStats belum mengisi array ini.

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.
KolomTipeDefaultDeskripsi
sendBitratenumber—Bitrate uplink dalam bps
sendBytesnumber—Jumlah kumulatif byte uplink
recvBitratenumber—Bitrate downlink dalam bps
recvBytesnumber—Jumlah kumulatif byte downlink
lossnumber—Rasio kehilangan uplink opsional (0–1). Memakai pengamatan QUIC browser jika tersedia, jika tidak estimasi Relay Datagram. Dihilangkan jika tidak diketahui.
rttnumber—Round-trip time opsional dalam ms; dihilangkan jika tidak diketahui
bwenumber—Anggaran pengiriman aplikasi efektif Client→Relay opsional dalam bps; dihilangkan jika tidak diketahui atau kedaluwarsa
audioReserveBpsnumber—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 enumNilaiDeskripsi
AoqTrackTypeAudio0Audio
AoqTrackTypeVideo1Video
AoqTrackTypeData2Pesan data
AoqTrackTypeScreen3Dicadangkan; tidak didukung dalam alur koneksi saat ini

AoqTrackMode

Mode transport audio.
Anggota enumNilaiDeskripsi
AoqTrackModeSegment0Mode Segment
AoqTrackModeStream1Mode stream Realtime

AoqEncoderType

Format media track.
Anggota enumNilaiDeskripsi
AoqEncoderTypeUnknown0Tidak diketahui
AoqEncoderTypeAudioPCM1Audio PCM
AoqEncoderTypeAudioOpus2Audio Opus
AoqEncoderTypeVideoH2643Video H.264
AoqEncoderTypeVideoJpeg4Video JPEG
AoqEncoderTypeDataText5Data teks

AoqConnectionStatus

Status koneksi engine.
Anggota enumNilaiDeskripsi
AoqConnectionStatusDisconnected0Terputus
AoqConnectionStatusConnecting1Menghubungkan
AoqConnectionStatusConnected2Terhubung
AoqConnectionStatusFailed3Koneksi gagal

AoqErrorCode

Kode kesalahan.
Anggota enumNilaiDeskripsi
AoqECOK0Berhasil
AoqECParamInvalid1Parameter tidak valid
AoqECStateInvalid2Status tidak valid
AoqECUnSupport3Belum diimplementasikan untuk platform/mode saat ini
AoqECAudio100Kesalahan audio umum
AoqECAudioExternalBufferFull110Buffer audio eksternal penuh
AoqECAudioDevice120Kesalahan perangkat audio umum
AoqECAudioDeviceRecordingAuthFailed121Izin mikrofon ditolak
AoqECAudioDeviceRecordingOccupied122Mikrofon sedang digunakan
AoqECAudioDeviceRecordingBackgroundStart123Perekaman dimulai di latar belakang
AoqECAudioDeviceRecordingStartFail124Perekaman gagal dimulai
AoqECAudioDevicePlayoutOccupied125Perangkat pemutaran sedang digunakan
AoqECAudioDevicePlayoutBackgroundStart126Pemutaran dimulai di latar belakang
AoqECAudioDevicePlayoutStartFail127Pemutaran gagal dimulai
AoqECAudioDeviceEarpieceRequiresVoipMode128Earpiece memerlukan mode VoIP
AoqECVideo200Kesalahan video umum
AoqECVideoExternalBufferFull210Buffer video eksternal penuh
AoqECVideoExternalCaptureNotEnabled211Perekaman video eksternal belum diaktifkan
AoqECVideoExternalEncoderNotEnabled212Encoder video eksternal belum diaktifkan
AoqECVideoDevice220Kesalahan perangkat video umum
AoqECVideoDeviceCameraOpenFail221Kamera gagal dibuka
AoqECVideoDeviceCameraAuthFailed222Izin kamera ditolak
AoqECVideoDeviceCameraOccupied223Kamera sedang digunakan
AoqECVideoDeviceCameraRunningError224Kesalahan runtime kamera
AoqECVideoCodec230Kesalahan codec video umum
AoqECVideoCodecEncoderInitFail231Inisialisasi encoder video gagal
AoqECVideoRender240Kesalahan rendering video umum
AoqECVideoRenderCreateFail241Pembuatan renderer gagal
AoqECVideoRenderDrawError242Kesalahan penggambaran rendering

AoqWarningCode

Kode peringatan.
Anggota enumNilaiDeskripsi
AoqWCOK0Normal
AoqWCAudio100Peringatan audio umum
AoqWCAudioHowling101Umpan balik akustik terdeteksi
AoqWCAudioDevice120Peringatan perangkat audio umum
AoqWCAudioDeviceMicEnumerateError121Kesalahan pendaftaran mikrofon
AoqWCAudioDeviceMicStartTimeout122Timeout memulai mikrofon
AoqWCAudioDeviceRecordingError123Kesalahan perekaman
AoqWCAudioDeviceSpeakerEnumerateError124Kesalahan pendaftaran speaker
AoqWCAudioDeviceSpeakerStartTimeout125Timeout memulai speaker
AoqWCAudioDevicePlayoutError126Kesalahan pemutaran
AoqWCAudioDeviceSilentMode127Perangkat dalam mode senyap
AoqWCVideo200Peringatan video umum
AoqWCVideoCameraEnumerateError201Kesalahan pendaftaran kamera
AoqWCVideoEncoderSwitched202Encoder video dialihkan
AoqWCVideoRenderDowngrade203Rendering beralih ke alternatif

AoqAudioDeviceStateCode

Kode status perangkat audio.
Anggota enumNilaiDeskripsi
AoqAudioDeviceNone0Tidak ada status
AoqAudioDeviceRecordStarting1Perekaman sedang dimulai
AoqAudioDeviceRecordStarted2Perekaman dimulai
AoqAudioDeviceRecordStopping3Perekaman sedang dihentikan
AoqAudioDeviceRecordStopped4Perekaman dihentikan
AoqAudioDeviceRecordFail5Perekaman gagal
AoqAudioDevicePlayStarting6Pemutaran sedang dimulai
AoqAudioDevicePlayStarted7Pemutaran dimulai
AoqAudioDevicePlayStopping8Pemutaran sedang dihentikan
AoqAudioDevicePlayStopped9Pemutaran dihentikan
AoqAudioDevicePlayFail10Pemutaran gagal

AoqAudioDeviceRouteType

Tipe rute perangkat audio.
Anggota enumNilaiDeskripsi
AoqAudioDeviceRouteDefault0Rute default
AoqAudioDeviceRouteHeadset1Headset
AoqAudioDeviceRouteSpeakerPhone4Speaker internal
AoqAudioDeviceRouteUsb5Perangkat USB
AoqAudioDeviceRouteBluetooth6Perangkat Bluetooth

AoqAudioFileStateCode

Kode status pemutaran file audio.
Anggota enumNilaiDeskripsi
AoqAudioFileNone0Tidak ada status
AoqAudioFileStarted1Pemutaran dimulai
AoqAudioFileStopped2Pemutaran dihentikan
AoqAudioFilePaused3Pemutaran dijeda
AoqAudioFileResumed4Pemutaran dilanjutkan
AoqAudioFileEnded5Pemutaran berakhir
AoqAudioFileBuffering6Buffering
AoqAudioFileBufferingEnd7Buffering selesai
AoqAudioFileFailed8Pemutaran gagal

AoqCameraDirection

Anggota enumNilaiDeskripsi
AoqCameraDirectionFront0Utamakan kamera depan
AoqCameraDirectionBack1Utamakan kamera belakang

AoqVideoDeviceStateCode

Kode status perangkat video.
Anggota enumNilaiDeskripsi
AoqVideoDeviceNone0Tidak ada status
AoqVideoDeviceCaptureStarting1Perekaman sedang dimulai
AoqVideoDeviceCaptureStarted2Perekaman dimulai
AoqVideoDeviceCaptureStopping3Perekaman sedang dihentikan
AoqVideoDeviceCaptureStopped4Perekaman dihentikan
AoqVideoDeviceCaptureFail5Perekaman gagal

AoqMirrorMode

Enum mode cermin yang dicadangkan. Web SDK tidak memiliki konfigurasi atau API yang menggunakannya.
Anggota enumNilaiDeskripsi
AoqMirrorModeDisabled0Pencerminan dinonaktifkan
AoqMirrorModeEnabled1Pencerminan diaktifkan

AoqOrientationMode

Enum mode orientasi yang dicadangkan. Web SDK tidak memiliki konfigurasi atau API yang menggunakannya.
Anggota enumNilaiDeskripsi
AoqOrientationModeAuto0Otomatis
AoqOrientationModePortrait1Potret
AoqOrientationModeLandscape2Lanskap

AoqRenderMode

Mode penyesuaian video.
Anggota enumNilaiDeskripsi
AoqRenderModeAuto0Default: tampilkan gambar penuh dengan rasio aspek tetap
AoqRenderModeStretch1Regangkan hingga memenuhi kontainer
AoqRenderModeFill2Tampilkan gambar penuh dengan rasio aspek tetap; bilah hitam diizinkan
AoqRenderModeCrop3Penuhi 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.
KategoriDeklarasi publikCakupan saat ini
Mixing file audioAoqAudioFileMixConfig, AoqAudioFileState, AoqAudioFileStateCodeTidak ada kontrol pemutaran atau mixing file; peristiwa status file tidak dipancarkan
Audio eksternal dan observerAoqAudioExternalStreamConfig, AoqAudioExternalFrameMeta, AoqAudioObserverParams, AoqAudioSource, AoqAudioStreamDirectionTidak ada metode input audio eksternal atau pendaftaran observer frame audio
Video eksternal dan observerAoqExternalVideoFrameMeta, AoqExternalVideoEncodedFrameMeta, AoqVideoObserverParams, AoqVideoSource, AoqVideoPixelFormat, AoqVideoObserverAlignment, AoqVideoCodecTypeTidak ada metode input frame video eksternal atau pendaftaran observer frame video. Konfigurasi codec menggunakan AoqEncoderType.
Pencerminan dan orientasiAoqMirrorMode, AoqOrientationModeTidak ada kolom konfigurasi atau metode terkait. Pencerminan pratinjau lokal otomatis.
Perangkat audio tingkat rendahAoqAudioDeviceEvent, AudioDeviceApiError, AudioDeviceErrorCodeDeklarasi 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.