Topik ini menjelaskan API C++, callback, dan tipe data AOQ Client SDK untuk Windows.
AoqClientEngine, serta melaporkan event asinkron melalui kelas abstrak AoqEngineEventListener. Semua definisi tipe berada dalam namespace AoqClientSdk, dan file header-nya adalah AoqClientEngine.h.
const char*. String tersebut harus tetap valid setidaknya hingga pemanggilan yang sesuai mengembalikan nilai. Engine menyalinnya secara internal sesuai kebutuhan.Indeks API
Siklus hidup engine
API | Deskripsi |
|---|---|
| Membuat instans engine (singleton) |
| Menghapus instans engine |
| Mendapatkan versi SDK |
| Menghubungkan ke server relay |
| Memutus koneksi dari server |
Manajemen perangkat audio
API | Deskripsi |
|---|---|
| Membuka perangkat capture audio (mikrofon) |
| Menutup perangkat capture audio |
| Mematikan atau mengaktifkan kembali capture audio |
| Memulai rendering audio untuk memutar audio remote |
| Menghentikan rendering audio |
| Menjeda rendering audio (fade-out didukung) |
| Melanjutkan rendering audio (fade-in didukung) |
| Menginterupsi sesi audio saat ini |
| Mengaktifkan atau menonaktifkan indikasi volume capture lokal |
Konfigurasi encoding audio
API | Deskripsi |
|---|---|
| Menetapkan parameter encoding audio |
| Menetapkan parameter decoding audio |
Manajemen perangkat video
API | Deskripsi |
|---|---|
| Membuka perangkat capture video (kamera) |
| Menutup perangkat capture video |
| Menetapkan atau menghapus jendela rendering video lokal |
| Menetapkan atau menghapus jendela rendering video remote |
Encoding video dan input eksternal
API | Deskripsi |
|---|---|
| Menetapkan parameter encoding video |
| Menetapkan parameter decoding video |
| Menyisipkan frame video yang ditangkap secara eksternal |
| Menyisipkan frame video yang di-encode secara eksternal |
Kontrol aliran media
API | Deskripsi |
|---|---|
| Mengaktifkan atau menonaktifkan pengiriman aliran media lokal |
Pemutaran file audio
API | Deskripsi |
|---|---|
| Memulai pemutaran file audio lokal ke aliran publishing |
| Menghentikan pemutaran file audio |
| Menjeda pemutaran file audio |
| Melanjutkan pemutaran file audio |
| Menanyakan durasi total file audio |
| Menanyakan posisi pemutaran saat ini dari file audio |
| Menetapkan posisi pemutaran file audio (seek) |
| Menetapkan volume file audio |
| Menanyakan volume saat ini dari file audio |
Aliran audio eksternal
API | Deskripsi |
|---|---|
| Menambahkan aliran audio eksternal |
| Memberikan data PCM audio eksternal |
| Menetapkan volume aliran audio eksternal |
| Menanyakan volume aliran audio eksternal |
| Mengosongkan buffer aliran audio eksternal |
| Menghapus aliran audio eksternal |
Pesan real-time
API | Deskripsi |
|---|---|
| Mengirim pesan data real-time |
Callback frame audio
API | Deskripsi |
|---|---|
| Menetapkan listener callback data frame audio |
| Mengaktifkan atau menonaktifkan callback frame audio pada posisi tertentu |
Callback frame video
API | Deskripsi |
|---|---|
| Menetapkan listener callback data frame video |
| Mengaktifkan atau menonaktifkan callback frame video pada posisi tertentu |
Callback AoqEngineEventListener
Callback | Deskripsi |
|---|---|
| Callback error engine |
| Callback peringatan engine |
| Callback perubahan status koneksi |
| Callback statistik engine |
| Callback perubahan status operasi perangkat audio |
| Callback perubahan rute output audio |
| Callback status pemutaran file audio |
| Callback indikasi volume capture lokal |
| Callback perubahan status operasi perangkat video |
| Callback untuk pesan data real-time yang diterima |
Detail API
Siklus hidup engine
createEngine
Membuat instans engine. SDK menyimpan engine sebagai singleton global, sehingga pemanggilan metode ini berulang akan mengembalikan instans yang sudah ada.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi pembuatan engine. Untuk informasi selengkapnya, lihat |
|
| Listener callback event. Untuk informasi selengkapnya, lihat |
nullptr dikembalikan jika gagal.
destroy
Menghapus instans engine. Setelah engine dihapus, Anda harus memanggil createEngine lagi sebelum dapat menggunakannya kembali.
getVersion
Mendapatkan versi SDK.
connect
Menghubungkan ke server relay. Server aplikasi mendapatkan parameter koneksi AOQ sementara berdasarkan protokol yang digunakan dan mengirimkannya ke klien. Untuk informasi selengkapnya, lihat Token authentication.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi autentikasi koneksi. Untuk informasi selengkapnya, lihat |
disconnect
Memutus koneksi dari server.
Manajemen perangkat audio
startAudioCapture
Membuka perangkat capture audio (mikrofon).
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi capture audio. Untuk informasi selengkapnya, lihat |
stopAudioCapture
Menutup perangkat capture audio.
muteAudioCapture
Mematikan atau mengaktifkan kembali capture audio.
Parameter | Type | Deskripsi |
|---|---|---|
|
|
|
startAudioPlayer
Memulai rendering audio untuk memutar audio remote.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi pemutaran audio. Untuk informasi selengkapnya, lihat |
stopAudioPlayer
Menghentikan rendering audio.
pauseAudioPlayer
Menjeda rendering audio, dengan dukungan fade-out.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Durasi fade-out, dalam milidetik. 0 menunjukkan penjedaan langsung. |
resumeAudioPlayer
Melanjutkan rendering audio, dengan dukungan fade-in.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Durasi fade-in, dalam milidetik. 0 menunjukkan kelanjutan langsung. |
interruptAudioPlayer
Menginterupsi sesi audio saat ini dan menghentikan audio yang sedang diputar.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Jenis track. Untuk informasi selengkapnya, lihat |
|
| Durasi fade-out, dalam milidetik. 0 menunjukkan interupsi langsung. |
enableLocalAudioVolumeIndication
Mengaktifkan atau menonaktifkan indikasi volume capture lokal. Setelah diaktifkan, callback onLocalAudioVolumeIndication dipicu pada interval yang ditentukan oleh config.interval. Jika config.interval <= 0, callback dinonaktifkan. Anda harus memanggil metode ini setelah startAudioCapture untuk mendapatkan data volume.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi indikasi volume. Untuk informasi selengkapnya, lihat |
Konfigurasi encoding audio
setAudioEncoderConfig
Menetapkan parameter encoding audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi codec audio. Untuk informasi selengkapnya, lihat |
setAudioDecoderConfig
Menetapkan parameter decoding audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi codec audio. Untuk informasi selengkapnya, lihat |
Manajemen perangkat video
startVideoCapture
Membuka perangkat capture video (kamera). Ketika isExternal=true dikonfigurasi, kamera tidak dibuka, dan frame diberikan oleh pushExternalVideoCapturedFrame.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi capture video. Untuk informasi selengkapnya, lihat |
stopVideoCapture
Menutup perangkat capture video.
setLocalView
Menetapkan atau menghapus jendela rendering video lokal. Jika canvas.view == nullptr, binding dihapus.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Track video. Gunakan |
|
| Kanvas rendering. Untuk informasi selengkapnya, lihat |
setRemoteView
Menetapkan atau menghapus jendela rendering video remote. Jika canvas.view == nullptr, binding dihapus.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Track video. Gunakan |
|
| Kanvas rendering. Untuk informasi selengkapnya, lihat |
Encoding video dan input eksternal
setVideoEncoderConfig
Menetapkan parameter encoding video dan mengarahkannya berdasarkan config.trackType.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Konfigurasi codec video. Untuk informasi selengkapnya, lihat |
setVideoDecoderConfig
Menetapkan parameter decoding video (proposal codec di sisi subscriber, yang harus dipanggil sebelum connect). Pemanggilan diarahkan berdasarkan config.trackType.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi codec video. Untuk informasi selengkapnya, lihat |
pushExternalVideoCapturedFrame
Menyisipkan frame video eksternal. Anda harus terlebih dahulu memanggil startVideoCapture dan mengonfigurasi isExternal=true. Jika capture video eksternal tidak dimulai, AoqECVideoExternalCaptureNotEnabled (211) dikembalikan. Jika format frame tidak didukung, AoqECParamInvalid dikembalikan.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Target routing. Gunakan |
|
| Data frame video eksternal. Untuk informasi selengkapnya, lihat |
AoqECVideoExternalBufferFull (210) menunjukkan buffer penuh; AoqECVideoExternalCaptureNotEnabled (211) menunjukkan capture video eksternal tidak diaktifkan; AoqECParamInvalid menunjukkan format frame tidak didukung; nilai bukan nol lainnya menunjukkan error lainnya.
pushExternalVideoEncodedFrame
Menyisipkan frame video yang di-encode secara eksternal langsung, melewati encoder. Anda harus terlebih dahulu memanggil setVideoEncoderConfig dan mengonfigurasi isExternal=true. Hanya JPEG yang saat ini didukung.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Target routing. Gunakan |
|
| Data frame yang di-encode secara eksternal. Untuk informasi selengkapnya, lihat |
Kontrol aliran media
enableSendMediaStream
Mengaktifkan atau menonaktifkan pengiriman aliran media lokal. Disarankan untuk menonaktifkan pengiriman setelah inisialisasi dan hanya mengaktifkannya setelah callback onConnectionStatusChange melaporkan AoqConnectionStatusConnected.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Target routing. |
|
|
|
Pemutaran file audio
startAudioFile
Memulai pemutaran file audio lokal ke aliran publishing.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio. Lapisan bisnis harus memastikan bahwa ID tersebut unik. |
|
| Konfigurasi mixing file audio. Untuk informasi selengkapnya, lihat |
stopAudioFile
Menghentikan pemutaran file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio |
pauseAudioFile
Menjeda pemutaran file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio |
resumeAudioFile
Melanjutkan pemutaran file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio |
getAudioFileDuration
Mendapatkan durasi total file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio |
-AoqErrorCode).
getAudioFileCurrentPosition
Mendapatkan posisi pemutaran saat ini dari file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio |
-AoqErrorCode).
setAudioFilePositionMillis
Menetapkan posisi pemutaran file audio (seek).
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio |
|
| Posisi pemutaran, dalam milidetik |
setAudioFileVolume
Menetapkan volume file audio.
Parameter | Type | Deskripsi |
|---|---|---|
|
| ID file audio |
|
| Arah aliran audio. Untuk informasi selengkapnya, lihat |
|
| Nilai volume. Nilai valid: 0 hingga 100. |
getAudioFileVolume
Mendapatkan volume saat ini dari file audio.
Parameter | Type | Deskripsi |
|---|---|---|
|
| ID file audio |
|
| Arah aliran audio. Untuk informasi selengkapnya, lihat |
-AoqErrorCode).
Aliran audio eksternal
addAudioExternalStream
Menambahkan aliran audio eksternal.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID aliran audio eksternal. Lapisan bisnis harus memastikan bahwa ID tersebut unik. |
|
| Konfigurasi aliran audio eksternal. Untuk informasi selengkapnya, lihat |
pushAudioExternalStreamData
Memberikan data PCM audio eksternal. Jika AoqECAudioExternalBufferFull (110) dikembalikan, buffer SDK penuh, dan disarankan untuk menunggu sekitar 20 ms lalu mengirim ulang frame data tersebut.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID aliran audio eksternal |
|
| Data audio eksternal mentah. Untuk informasi selengkapnya, lihat |
AoqECAudioExternalBufferFull.setAudioExternalStreamVolume
Menetapkan volume aliran audio eksternal.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID aliran audio eksternal |
|
| Jenis aliran audio eksternal. Untuk informasi selengkapnya, lihat |
|
| Nilai volume. Nilai valid: 0 hingga 100. |
getAudioExternalStreamVolume
Mendapatkan volume aliran audio eksternal.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID aliran audio eksternal |
|
| Jenis aliran audio eksternal. Untuk informasi selengkapnya, lihat |
-AoqErrorCode).
clearAudioExternalStreamBuffer
Mengosongkan buffer aliran audio eksternal.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID aliran audio eksternal |
|
| Durasi fade-out. -1 menggunakan fade-out default SDK, 0 mengosongkan semuanya tanpa fade-out, dan nilai lebih dari 0 mempertahankan fade-out selama jumlah milidetik yang ditentukan. |
removeAudioExternalStream
Menghapus aliran audio eksternal.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID aliran audio eksternal |
Pesan real-time
sendDataMsg
Mengirim pesan data real-time.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Isi pesan. Untuk informasi selengkapnya, lihat |
Callback frame audio
setAudioFrameObserver
Menetapkan listener callback data frame audio. Berikan nullptr untuk menghentikan callback. Setelah menetapkan listener, panggil enableAudioFrameObserver untuk mengaktifkan callback untuk sumber data yang sesuai.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Listener callback frame audio. Untuk informasi selengkapnya, lihat |
enableAudioFrameObserver
Mengaktifkan atau menonaktifkan callback frame audio pada posisi tertentu.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Menentukan apakah callback data diizinkan |
|
| Jenis sumber data audio mentah. Untuk informasi selengkapnya, lihat |
|
| Pengaturan parameter callback. Untuk informasi selengkapnya, lihat |
Callback frame video
setVideoFrameObserver
Menetapkan listener callback data frame video. Berikan nullptr untuk menghentikan callback. Setelah menetapkan listener, panggil enableVideoFrameObserver untuk mengaktifkan callback untuk sumber data yang sesuai.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Listener callback frame video. Untuk informasi selengkapnya, lihat |
enableVideoFrameObserver
Mengaktifkan atau menonaktifkan callback frame video pada posisi tertentu.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Menentukan apakah callback data diaktifkan pada posisi tertentu |
|
| Sumber data callback frame video (posisi dalam pipeline). Untuk informasi selengkapnya, lihat |
|
| Pengaturan parameter callback. Untuk informasi selengkapnya, lihat |
Panggilan Balik
AoqEngineEventListener
AoqEngineEventListener adalah titik masuk terpadu untuk semua notifikasi event asinkron dari SDK. Ini adalah kelas abstrak yang harus diwariskan dan diimplementasikan, lalu diberikan saat memanggil createEngine. Semua callback dapat dipicu pada thread internal, sehingga Anda harus menangani keamanan thread sendiri. Transisi status: Disconnected → Connecting → Connected/Failed → Disconnected.
onError
Callback error engine.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Kode error. Untuk informasi selengkapnya, lihat |
|
| Deskripsi error |
onWarning
Callback peringatan engine.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Kode peringatan. Untuk informasi selengkapnya, lihat |
|
| Deskripsi peringatan |
onConnectionStatusChange
Callback perubahan status koneksi engine.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Status koneksi. Untuk informasi selengkapnya, lihat |
onStats
Callback statistik engine.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Data statistik. Untuk informasi selengkapnya, lihat |
onAudioDeviceStateChanged
Callback untuk perubahan status operasi capture dan playback perangkat audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Status perangkat audio. Untuk informasi selengkapnya, lihat |
onAudioDeviceRouteChanged
Callback perubahan rute output audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Jenis rute. Untuk nilai valid, lihat |
onAudioFileState
Callback untuk status pemutaran file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Status pemutaran file. Untuk informasi selengkapnya, lihat |
onLocalAudioVolumeIndication
Callback indikasi volume capture lokal. Untuk mengaktifkannya, panggil enableLocalAudioVolumeIndication.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Informasi volume lokal. Untuk informasi selengkapnya, lihat |
onVideoDeviceStateChanged
Callback untuk perubahan status operasi capture perangkat video.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Status perangkat video. Untuk informasi selengkapnya, lihat |
onDataMsg
Callback untuk pesan data real-time yang diterima.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Pesan data. Untuk informasi selengkapnya, lihat |
IAudioFrameObserver
Antarmuka untuk callback data frame audio, yang diimplementasikan pemanggil melalui pewarisan. Hindari operasi yang memakan waktu dalam callback karena dapat menyebabkan anomali audio.
onCapturedAudioFrame
Callback untuk data capture mentah. Untuk mengaktifkannya, panggil enableAudioFrameObserver dan atur audioSource = AoqAudioSourceCaptured. Anda dapat mengatur laju sampel dan jumlah channel, serta mode baca-tulis didukung.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Data audio capture mentah. Untuk informasi selengkapnya, lihat |
onProcessCapturedAudioFrame
Callback untuk data setelah pemrosesan 3A. Untuk mengaktifkannya, panggil enableAudioFrameObserver dan atur audioSource = AoqAudioSourceProcessCaptured. Anda dapat mengatur laju sampel dan jumlah channel, serta mode baca-tulis didukung.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Data audio mentah setelah pemrosesan 3A. Untuk informasi selengkapnya, lihat |
onPublishAudioFrame
Callback untuk data publishing. Untuk mengaktifkannya, panggil enableAudioFrameObserver dan atur audioSource = AoqAudioSourcePublish. Anda dapat mengatur laju sampel dan jumlah channel, namun hanya mode read-only yang didukung.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track. Untuk informasi selengkapnya, lihat |
|
| Data audio mentah yang akan dipublikasikan. Untuk informasi selengkapnya, lihat |
onPlaybackAudioFrame
Callback untuk data playback. Untuk mengaktifkannya, panggil enableAudioFrameObserver dan atur audioSource = AoqAudioSourcePlayback. Anda dapat mengatur laju sampel dan jumlah channel, serta mode baca-tulis didukung.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Data audio mentah untuk playback. Untuk informasi selengkapnya, lihat |
IVideoFrameObserver
Antarmuka untuk callback data frame video, yang diimplementasikan pemanggil melalui pewarisan. Hindari operasi yang memakan waktu dalam callback karena dapat menyebabkan video tersendat. Nilai kembali true menunjukkan bahwa data dimodifikasi dan harus ditulis kembali ke SDK. Penulisan kembali hanya berlaku untuk I420. Nilai kembali false menunjukkan read-only. Data dalam frame hanya valid selama callback. Untuk menggunakannya secara asinkron, salin sendiri.
onCapturedVideoFrame
Callback untuk data mentah lokal setelah capture, sebelum preprocessing. Untuk mengaktifkannya, panggil enableVideoFrameObserver dan atur videoSource = AoqVideoSourceCaptured.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Data frame video yang ditangkap. Untuk informasi selengkapnya, lihat |
true menunjukkan bahwa data dimodifikasi dan harus ditulis kembali ke SDK; false menunjukkan read-only.
onPreEncodeVideoFrame
Callback untuk data mentah lokal sebelum encoding, setelah preprocessing. Untuk mengaktifkannya, panggil enableVideoFrameObserver dan atur videoSource = AoqVideoSourcePreEncode.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Jenis track video. Untuk informasi selengkapnya, lihat |
|
| Data frame video sebelum encoding. Untuk informasi selengkapnya, lihat |
true menunjukkan bahwa data dimodifikasi dan harus ditulis kembali ke SDK; false menunjukkan read-only.
onRemoteVideoFrame
Callback untuk data mentah remote setelah decoding dan sebelum rendering. Untuk mengaktifkannya, panggil enableVideoFrameObserver dan atur videoSource = AoqVideoSourceRemote.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track video. Untuk informasi selengkapnya, lihat |
|
| Data frame video remote. Untuk informasi selengkapnya, lihat |
true menunjukkan bahwa data dimodifikasi dan harus ditulis kembali ke SDK; false menunjukkan read-only.
Tipe data dan enumerasi
Tipe umum
AoqCreateConfig
Konfigurasi pembuatan engine.
Field | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Direktori kerja SDK |
|
|
| Menentukan apakah data audio disimpan (untuk debugging) |
|
|
| Parameter tambahan (string JSON) |
AoqConnectConfig
Konfigurasi untuk menghubungkan ke server relay. relayEndpoints / publishTracks / subscribeTracks adalah array gaya C dengan panjang. Memori array dipegang oleh pemanggil dan hanya perlu tetap valid selama pemanggilan connect.
Field | Type | Deskripsi |
|---|---|---|
|
| Token autentikasi koneksi |
|
| ID sesi |
|
| Sidik jari sertifikat server |
|
| ID hash ruang kerja |
|
| Array titik akses relay |
|
| Jumlah titik akses relay |
|
| Array atribut track publishing lokal |
|
| Jumlah track publishing |
|
| Array atribut track subscribing lokal |
|
| Jumlah track subscribing |
AoqRelayEndpoint
Titik akses relay.
Field | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Indeks rute |
|
|
| Alamat server (nama domain atau alamat IP) |
|
|
| Port server |
AoqTrackParam
Atribut track.
Field | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Jenis track |
|
|
| Mode streaming atau non-streaming. Hanya berlaku untuk downlink audio. |
AoqDataMsg
Struktur data pesan. Saat digunakan dalam callback, validitasnya hanya dijamin selama callback. Jika Anda perlu menggunakannya secara asinkron, salin sendiri.
Field | Type | Deskripsi |
|---|---|---|
|
| Isi pesan. Menunjuk ke memori yang dipegang oleh pemanggil. |
|
| Jumlah byte |
Tipe statistik
AoqStats
Statistik engine. Setiap array statistik disediakan sebagai pointer dan jumlah.
Field | Tipe | Deskripsi |
|---|---|---|
|
| Array statistik publishing untuk audio dan jumlah entri |
|
| Array statistik publishing untuk video dan jumlah entri |
|
| Array statistik publishing untuk pesan data dan jumlah entri |
|
| Array statistik subscribing untuk audio dan jumlah entri |
|
| Array statistik subscribing untuk video dan jumlah entri |
|
| Array statistik subscribing untuk pesan data dan jumlah entri |
|
| Statistik jaringan |
AoqNetworkStats
Statistik jaringan.
Field | Tipe | Deskripsi |
|---|---|---|
|
| Bitrate kirim, dalam bit/s |
|
| Byte kumulatif yang dikirim |
|
| Bitrate terima, dalam bit/s |
|
| Byte kumulatif yang diterima |
|
| Laju loss paket, dari 0 hingga 100 |
|
| Latensi round-trip, dalam ms |
AoqAudioPublishStats
Statistik publishing untuk audio.
Field | Type | Deskripsi |
|---|---|---|
|
| Jenis track |
|
| Bitrate, dalam bit/s |
|
| Byte kumulatif |
|
| Volume encoding aliran publishing |
AoqVideoPublishStats
Statistik publishing untuk video.
Field | Type | Deskripsi |
|---|---|---|
|
| Jenis track |
|
| Bitrate, dalam bit/s |
|
| Byte kumulatif |
|
| Laju frame encoding |
AoqDataMsgPublishStats
Statistik publishing untuk pesan data.
Field | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track |
|
| Bitrate, dalam bit/s |
|
| Byte kumulatif |
AoqAudioSubscribeStats
Statistik subscribing untuk audio.
Field | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track |
|
| Bitrate, dalam bit/s |
|
| Byte kumulatif |
|
| Volume playback |
AoqVideoSubscribeStats
Statistik subscribing untuk video.
Field | Type | Deskripsi |
|---|---|---|
|
| Jenis track |
|
| Bitrate, dalam bit/s |
|
| Byte kumulatif |
|
| Laju frame decoding |
|
| Laju frame rendering |
AoqDataMsgSubscribeStats
Statistik subscribing untuk pesan data.
Field | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track |
|
| Bitrate, dalam bit/s |
|
| Byte kumulatif |
Enumerasi
AoqErrorCode
Enumerasi kode error.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Berhasil |
| 1 | Parameter tidak valid |
| 2 | Status tidak valid |
| 3 | API dipanggil tetapi tidak diimplementasikan pada platform saat ini atau dalam mode saat ini |
| 100 | Error audio umum |
| 110 | Buffer audio eksternal penuh |
| 120 | Error perangkat audio umum |
| 121 | Izin perekaman tidak diberikan |
| 122 | Perangkat perekaman sedang digunakan |
| 123 | Memulai perekaman di latar belakang |
| 124 | Gagal memulai perekaman |
| 125 | Perangkat playback sedang digunakan |
| 126 | Memulai playback di latar belakang |
| 127 | Gagal memulai playback |
| 128 | Mode receiver memerlukan VoIP diaktifkan |
| 200 | Error video umum |
| 210 | Buffer video eksternal penuh |
| 211 | Capture video eksternal tidak diaktifkan |
| 212 | Encoding video eksternal tidak diaktifkan |
| 220 | Error perangkat video umum |
| 221 | Gagal membuka kamera |
| 222 | Izin kamera tidak diberikan |
| 223 | Kamera sedang digunakan |
| 224 | Error runtime kamera |
| 230 | Error codec video umum |
| 231 | Gagal menginisialisasi encoder |
| 240 | Error rendering video umum |
| 241 | Gagal membuat tampilan rendering |
| 242 | Error gambar rendering |
AoqWarningCode
Enumerasi kode peringatan.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Tidak ada peringatan |
| 100 | Peringatan audio umum |
| 101 | Terdeteksi howling audio |
| 120 | Peringatan perangkat audio umum |
| 121 | Error enumerasi mikrofon |
| 122 | Waktu mulai mikrofon habis |
| 123 | Error perekaman |
| 124 | Error enumerasi speaker |
| 125 | Waktu mulai speaker habis |
| 126 | Error playback |
| 200 | Peringatan video umum |
| 201 | Error enumerasi kamera |
| 202 | Encoder video dialihkan |
| 203 | Spesifikasi rendering video diturunkan. |
AoqTrackType
Jenis track.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Track audio |
| 1 | Track video |
| 2 | Track pesan data |
AoqEncoderType
Jenis encoder.
Nilai Enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Format tidak diketahui |
| 1 | Audio PCM |
| 2 | Audio Opus (berbasis plugin; hubungi tim SDK untuk membangunnya secara built-in atau mengunduhnya secara dinamis ke aplikasi) |
| 3 | Video H.264 |
| 4 | Video JPEG |
| 5 | Teks pesan |
AoqTrackMode
Mode streaming atau non-streaming. Hanya berlaku untuk downlink audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Tersegmentasi: data dikemas dan dikirim dalam segmen semantik, seperti kalimat. |
| 1 | Streaming: data dikirim secara kontinu. |
AoqConnectionStatus
Status koneksi engine.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Terputus |
| 1 | Menghubungkan |
| 2 | Tersambung |
| 3 | Koneksi gagal |
Tipe audio
AoqAudioCaptureConfig
Konfigurasi capture audio.
Field | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Menentukan apakah menggunakan capture eksternal |
|
|
| Jumlah channel capture audio. Didukung 1 dan 2. |
AoqAudioPlaybackConfig
Konfigurasi playback audio.
Field | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Menentukan apakah menggunakan playback eksternal |
|
|
| Jumlah channel playback audio. Didukung 1 dan 2. |
AoqAudioCodecConfig
Konfigurasi codec audio.
Field | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Jenis track |
|
|
| Format codec |
|
|
| Laju sampel, dalam Hz. Untuk encoding, Opus 8/16/48K dan PCM 8/16/32/48K didukung. Untuk decoding, 24K juga didukung, tetapi 24K terbatas pada mode Segment. Mode Stream tidak mendukung 24K, dan kombinasi yang tidak valid akan memicu callback onError dengan AoqECParamInvalid selama connect. |
|
|
| Jumlah channel. Didukung 1 dan 2. |
|
|
| Bitrate, dalam bit/s |
AoqAudioDeviceState
Status perangkat audio.
Field | Type | Deskripsi |
|---|---|---|
|
| Kode status |
|
| Kode error ( |
AoqAudioDeviceStateCode
Kode status perangkat audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Tidak ada status |
| 1 | Capture dimulai |
| 2 | Capture telah dimulai |
| 3 | Capture dihentikan |
| 4 | Capture telah dihentikan |
| 5 | Capture gagal |
| 6 | Playback dimulai |
| 7 | Playback telah dimulai |
| 8 | Playback dihentikan |
| 9 | Playback telah dihentikan |
| 10 | Playback gagal |
AoqAudioDeviceRouteType
Jenis rute perangkat audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Default |
| 1 | Headphone |
| 2 | Receiver |
| 3 | Headphone tanpa mikrofon |
| 4 | Speaker bawaan |
| 5 | USB |
| 6 | Bluetooth |
| 7 | Bluetooth A2DP |
AoqAudioFileMixConfig
Konfigurasi untuk memutar file audio ke aliran publishing.
Field | Type | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Nama file (termasuk path). Wajib diisi. |
|
|
| Jumlah loop. -1 berarti looping tanpa batas. |
|
|
| Posisi mulai pemutaran, dalam ms |
|
|
| Volume publishing. Nilai valid: 0 hingga 100. |
|
|
| Volume playback. Nilai valid: 0 hingga 100. |
AoqAudioFileState
Status file audio.
Field | Tipe | Deskripsi |
|---|---|---|
|
| ID file |
|
| Kode status |
|
| Kode error |
AoqAudioFileStateCode
Kode status file audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Tidak ada status |
| 1 | Mulai |
| 2 | Dihentikan |
| 3 | Dijeda |
| 4 | Dilanjutkan |
| 5 | Pemutaran selesai |
| 6 | Buffering |
| 7 | Buffering selesai |
| 8 | Pemutaran gagal |
AoqAudioFileErrorCode
Kode error pemutaran file audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Tidak ada error |
| 1 | Gagal membuka file |
| 2 | Gagal mendekode file |
AoqAudioExternalStreamConfig
Konfigurasi aliran audio eksternal.
Field | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Jenis track audio |
|
|
| Format aliran audio. PCM didukung. |
|
|
| Jumlah channel. Dibatasi oleh codec audio aliran publishing, yang mendukung 1 dan 2. Channel tambahan diabaikan. |
|
|
| Laju sampel, dalam Hz. Didukung 8, 12, 16, 24, 32, 44.1, 48, 64, 88.2, 96, 176.4, dan 192K. |
|
|
| Volume playback. Nilai valid: 0 hingga 100. |
|
|
| Volume publishing. Nilai valid: 0 hingga 100. |
|
|
| Durasi buffer maksimum, dalam ms. Nilai valid: 100 ke atas. Jika durasi buffer di SDK melebihi nilai ini, Push gagal. |
|
|
| Menentukan apakah menerapkan pemrosesan 3A pada PCM input |
AoqAudioFrameData
Data audio.
Field | Tipe | Deskripsi |
|---|---|---|
|
| Pointer ke data audio |
|
| Jumlah sampel (per channel) |
|
| Byte per sampel |
|
| Jumlah channel |
|
| Jumlah sampel per detik |
|
| Ronde input PCM (digunakan untuk notifikasi penyelesaian konsumsi |
|
| Timestamp |
|
| Panjang data |
|
| Berlaku dalam callback data. |
AoqAudioStreamDirection
Arah aliran audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Penerbitan audio |
| 1 | Audio playback |
AoqAudioExternalStreamToggle
Kontrol aliran audio eksternal.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Dipulihkan |
| 1 | Dijeda |
AoqAudioSource
Jenis sumber data audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Data audio yang ditangkap |
| 1 | Data audio setelah pemrosesan 3A |
| 2 | Data audio yang akan dipublikasikan (memerlukan Connect yang berhasil) |
| 3 | Data audio yang akan diputar |
AoqAudioObserverMode
Mode callback frame audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Read-only |
| 1 | Read-write |
AoqAudioObserverConfig
Pengaturan parameter untuk callback data audio.
Field | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Laju sampel audio callback. Dibatasi oleh sumber. Resampling dilakukan jika laju tidak cocok. Didukung 8, 12, 16, 24, 32, 44.1, 48, 64, 88.2, 96, 176.4, dan 192K. |
|
|
| Jumlah channel audio dalam callback. Didukung 1 dan 2. Parameter ini dibatasi oleh parameter codec aliran subscribing. |
|
|
| Mode callback |
AoqAudioVolumeIndicationConfig
Konfigurasi indikasi volume lokal.
Field | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Interval callback, dalam ms. Nilai kurang dari atau sama dengan 0 menonaktifkan callback. Nilai lebih dari 0 dan kurang dari 10 diperlakukan sebagai 10. |
|
|
| Koefisien penghalusan volume. Nilai valid: 0 hingga 10. Nilai lebih besar menghasilkan output yang lebih halus. |
AoqAudioVolume
Informasi volume lokal.
Field | Tipe | Deskripsi |
|---|---|---|
|
| Volume instan yang telah dihaluskan. Nilai valid: 0 hingga 255. |
Tipe video
AoqVideoCaptureConfig
Konfigurasi capture video.
Field | Type | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Lebar capture, dalam piksel. Parameter ini tidak berlaku saat |
|
|
| Tinggi capture, dalam piksel. Parameter ini tidak berlaku saat |
|
|
| Laju frame capture. Parameter ini tidak berlaku saat |
|
|
| Menentukan apakah menggunakan capture eksternal. Jika |
AoqVideoCanvas
Struktur data untuk rendering video. view adalah pointer opaque ke handle tampilan native platform. Di Windows, berikan handle jendela HWND. Pemanggil harus memastikan bahwa siklus hidup view lebih lama dari periode saat diatur oleh setLocalView / setRemoteView.
Field | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Handle tampilan ( |
|
|
| Mode rendering |
AoqRenderMode
Mode tampilan rendering.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Mode otomatis |
| 1 | Mode stretch-to-fill. Saat rasio aspek tidak cocok, gambar diregangkan ke rasio target dan menjadi terdistorsi. |
| 2 | Mode letterbox. Saat rasio aspek tidak cocok, bar hitam ditambahkan di atas dan bawah atau kiri dan kanan. |
| 3 | Mode crop. Saat rasio aspek tidak cocok, lebar atau tinggi dipotong dan bagian gambar hilang. |
AoqVideoPixelFormat
Format piksel video.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Format tidak diketahui |
| 1 | I420 |
| 2 | NV12 |
| 3 | NV21 |
| 4 | BGRA |
| 5 | RGBA |
AoqVideoFrame
Data video eksternal.
Field | Tipe | Deskripsi |
|---|---|---|
|
| Format piksel |
|
| Lebar, dalam piksel |
|
| Tinggi, dalam piksel |
|
| Pointer ke data dalam format terkemas (NV12/NV21/BGRA/RGBA) |
|
| Jumlah byte data terkompresi |
|
| Pointer ke data tiga bidang I420 |
|
| Stride tiga bidang I420 |
|
| Timestamp, dalam ms. Jika 0, SDK mengisinya dengan jam lokal. |
AoqVideoEncodedFrame
Frame video yang di-encode secara eksternal. Pemanggil melakukan encoding, dan SDK mengemas serta mengirim frame langsung tanpa re-encoding.
Field | Tipe | Deskripsi |
|---|---|---|
|
| Format codec |
|
| Pointer ke data yang di-encode |
|
| Jumlah byte data yang di-encode |
|
| Lebar, dalam piksel |
|
| Tinggi, dalam piksel |
|
| Timestamp, dalam ms. Jika 0, SDK mengisinya dengan jam lokal. |
AoqVideoCodecType
Jenis codec frame yang di-encode secara eksternal.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | JPEG |
AoqVideoDeviceState
Status perangkat video.
Field | Type | Deskripsi |
|---|---|---|
|
| Kode status |
|
| Kode error ( |
AoqVideoDeviceStateCode
Kode status perangkat video.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Tidak ada status |
| 1 | Kamera dimulai |
| 2 | Kamera telah dimulai |
| 3 | Kamera dihentikan |
| 4 | Kamera telah dihentikan |
| 5 | Gagal memulai kamera (misalnya, izin ditolak atau perangkat tidak tersedia) |
AoqMirrorMode
Mode mirror.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Menonaktifkan mirror |
| 1 | Mengaktifkan mirror |
AoqOrientationMode
Mode orientasi.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Otomatis |
| 1 | Portrait |
| 2 | Landscape |
AoqVideoCodecConfig
Parameter codec video, yang digunakan bersama untuk encoding dan decoding. Untuk decoding, hanya trackType / codecType / width / height / fps / bitrate yang berlaku dan berpartisipasi dalam negosiasi sebagai proposal subscription, sedangkan minBitrate / keyframeInterval / mirrorMode / orientationMode / isExternal hanya digunakan untuk encoding.
Field | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Mode encoding eksternal. Saat |
|
|
| Jenis track |
|
|
| Format codec |
|
|
| Lebar resolusi |
|
|
| Tinggi resolusi |
|
|
| Laju frame |
|
|
| Bitrate awal, dalam bit/s |
|
|
| Bitrate minimum, dalam bit/s |
|
|
| Interval keyframe, dalam detik |
|
|
| Mode mirror |
|
|
| Mode orientasi |
AoqVideoSource
Sumber data callback frame video (posisi dalam pipeline).
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Data video yang ditangkap sebelum preprocessing |
| 1 | Data video sebelum encoding, setelah preprocessing |
| 2 | Data video remote setelah decoding dan sebelum rendering |
AoqVideoObserverMode
Mode callback frame video.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Read-only |
| 1 | Read-write |
AoqVideoObserverAlignment
Metode penyelarasan lebar untuk output video.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Default |
| 1 | Penyelarasan angka genap |
| 2 | Penyelarasan 4-byte |
| 3 | Penyelarasan 8-byte |
| 4 | Penyelarasan 16-byte |
AoqVideoObserverConfig
Pengaturan parameter untuk callback data video.
Field | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Format piksel yang diharapkan dari data callback |
|
|
| Kebijakan penyelarasan lebar |
|
|
| Mode callback. ReadWrite hanya didukung untuk I420. |
|
|
| Menentukan apakah data callback dicerminkan |