Skip to main content

Referensi API AOQ Client SDK Windows

Topik ini menjelaskan API C++, callback, dan tipe data AOQ Client SDK untuk Windows.

AOQ SDK menyediakan API video umum. Qwen-Audio-Realtime tidak mendukung input atau output video. Untuk kemampuan media model lain, lihat dokumentasi aksesnya.
SDK menyimpan instans engine sebagai singleton global, menyediakan API melalui kelas AoqClientEngine, serta melaporkan event asinkron melalui kelas abstrak AoqEngineEventListener. Semua definisi tipe berada dalam namespace AoqClientSdk, dan file header-nya adalah AoqClientEngine.h.
Pemanggil bertanggung jawab atas siklus hidup semua string 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

createEngine

Membuat instans engine (singleton)

destroy

Menghapus instans engine

getVersion

Mendapatkan versi SDK

connect

Menghubungkan ke server relay

disconnect

Memutus koneksi dari server

Manajemen perangkat audio

API

Deskripsi

startAudioCapture

Membuka perangkat capture audio (mikrofon)

stopAudioCapture

Menutup perangkat capture audio

muteAudioCapture

Mematikan atau mengaktifkan kembali capture audio

startAudioPlayer

Memulai rendering audio untuk memutar audio remote

stopAudioPlayer

Menghentikan rendering audio

pauseAudioPlayer

Menjeda rendering audio (fade-out didukung)

resumeAudioPlayer

Melanjutkan rendering audio (fade-in didukung)

interruptAudioPlayer

Menginterupsi sesi audio saat ini

enableLocalAudioVolumeIndication

Mengaktifkan atau menonaktifkan indikasi volume capture lokal

Konfigurasi encoding audio

API

Deskripsi

setAudioEncoderConfig

Menetapkan parameter encoding audio

setAudioDecoderConfig

Menetapkan parameter decoding audio

Manajemen perangkat video

API

Deskripsi

startVideoCapture

Membuka perangkat capture video (kamera)

stopVideoCapture

Menutup perangkat capture video

setLocalView

Menetapkan atau menghapus jendela rendering video lokal

setRemoteView

Menetapkan atau menghapus jendela rendering video remote

Encoding video dan input eksternal

API

Deskripsi

setVideoEncoderConfig

Menetapkan parameter encoding video

setVideoDecoderConfig

Menetapkan parameter decoding video

pushExternalVideoCapturedFrame

Menyisipkan frame video yang ditangkap secara eksternal

pushExternalVideoEncodedFrame

Menyisipkan frame video yang di-encode secara eksternal

Kontrol aliran media

API

Deskripsi

enableSendMediaStream

Mengaktifkan atau menonaktifkan pengiriman aliran media lokal

Pemutaran file audio

API

Deskripsi

startAudioFile

Memulai pemutaran file audio lokal ke aliran publishing

stopAudioFile

Menghentikan pemutaran file audio

pauseAudioFile

Menjeda pemutaran file audio

resumeAudioFile

Melanjutkan pemutaran file audio

getAudioFileDuration

Menanyakan durasi total file audio

getAudioFileCurrentPosition

Menanyakan posisi pemutaran saat ini dari file audio

setAudioFilePositionMillis

Menetapkan posisi pemutaran file audio (seek)

setAudioFileVolume

Menetapkan volume file audio

getAudioFileVolume

Menanyakan volume saat ini dari file audio

Aliran audio eksternal

API

Deskripsi

addAudioExternalStream

Menambahkan aliran audio eksternal

pushAudioExternalStreamData

Memberikan data PCM audio eksternal

setAudioExternalStreamVolume

Menetapkan volume aliran audio eksternal

getAudioExternalStreamVolume

Menanyakan volume aliran audio eksternal

clearAudioExternalStreamBuffer

Mengosongkan buffer aliran audio eksternal

removeAudioExternalStream

Menghapus aliran audio eksternal

Pesan real-time

API

Deskripsi

sendDataMsg

Mengirim pesan data real-time

Callback frame audio

API

Deskripsi

setAudioFrameObserver

Menetapkan listener callback data frame audio

enableAudioFrameObserver

Mengaktifkan atau menonaktifkan callback frame audio pada posisi tertentu

Callback frame video

API

Deskripsi

setVideoFrameObserver

Menetapkan listener callback data frame video

enableVideoFrameObserver

Mengaktifkan atau menonaktifkan callback frame video pada posisi tertentu

Callback AoqEngineEventListener

Callback

Deskripsi

onError

Callback error engine

onWarning

Callback peringatan engine

onConnectionStatusChange

Callback perubahan status koneksi

onStats

Callback statistik engine

onAudioDeviceStateChanged

Callback perubahan status operasi perangkat audio

onAudioDeviceRouteChanged

Callback perubahan rute output audio

onAudioFileState

Callback status pemutaran file audio

onLocalAudioVolumeIndication

Callback indikasi volume capture lokal

onVideoDeviceStateChanged

Callback perubahan status operasi perangkat video

onDataMsg

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.
static AoqClientEngine* createEngine(const AoqCreateConfig& config,
                                     AoqEngineEventListener* listener);
Parameter

Parameter

Tipe

Deskripsi

config

const AoqCreateConfig&

Konfigurasi pembuatan engine. Untuk informasi selengkapnya, lihat AoqCreateConfig.

listener

AoqEngineEventListener*

Listener callback event. Untuk informasi selengkapnya, lihat AoqEngineEventListener.

Mengembalikan: Pointer ke instans engine. nullptr dikembalikan jika gagal.

destroy

Menghapus instans engine. Setelah engine dihapus, Anda harus memanggil createEngine lagi sebelum dapat menggunakannya kembali.
static int destroy();
Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

getVersion

Mendapatkan versi SDK.
static const char* getVersion();
Mengembalikan: String versi.

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.
virtual int connect(const AoqConnectConfig& config);
Parameter

Parameter

Tipe

Deskripsi

config

const AoqConnectConfig&

Konfigurasi autentikasi koneksi. Untuk informasi selengkapnya, lihat AoqConnectConfig.

Mengembalikan: 0 menunjukkan bahwa pemanggilan telah diproses dan berjalan secara asinkron; bukan nol menunjukkan validasi parameter gagal.

disconnect

Memutus koneksi dari server.
virtual int disconnect();
Mengembalikan: 0 menunjukkan bahwa pemanggilan telah diproses dan berjalan secara asinkron; bukan nol menunjukkan kegagalan.

Manajemen perangkat audio

startAudioCapture

Membuka perangkat capture audio (mikrofon).
virtual int startAudioCapture(const AoqAudioCaptureConfig& config);
Parameter

Parameter

Tipe

Deskripsi

config

const AoqAudioCaptureConfig&

Konfigurasi capture audio. Untuk informasi selengkapnya, lihat AoqAudioCaptureConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

stopAudioCapture

Menutup perangkat capture audio.
virtual int stopAudioCapture();
Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

muteAudioCapture

Mematikan atau mengaktifkan kembali capture audio.
virtual int muteAudioCapture(bool mute);
Parameter

Parameter

Type

Deskripsi

mute

bool

true mematikan; false mengaktifkan kembali

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

startAudioPlayer

Memulai rendering audio untuk memutar audio remote.
virtual int startAudioPlayer(const AoqAudioPlaybackConfig& config);
Parameter

Parameter

Tipe

Deskripsi

config

const AoqAudioPlaybackConfig&

Konfigurasi pemutaran audio. Untuk informasi selengkapnya, lihat AoqAudioPlaybackConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

stopAudioPlayer

Menghentikan rendering audio.
virtual int stopAudioPlayer();
Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

pauseAudioPlayer

Menjeda rendering audio, dengan dukungan fade-out.
virtual int pauseAudioPlayer(int fadeMs);
Parameter

Parameter

Tipe

Deskripsi

fadeMs

int

Durasi fade-out, dalam milidetik. 0 menunjukkan penjedaan langsung.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

resumeAudioPlayer

Melanjutkan rendering audio, dengan dukungan fade-in.
virtual int resumeAudioPlayer(int fadeMs);
Parameter

Parameter

Tipe

Deskripsi

fadeMs

int

Durasi fade-in, dalam milidetik. 0 menunjukkan kelanjutan langsung.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

interruptAudioPlayer

Menginterupsi sesi audio saat ini dan menghentikan audio yang sedang diputar.
virtual int interruptAudioPlayer(AoqTrackType trackType, int fadeMs);
Parameter

Parameter

Type

Deskripsi

trackType

AoqTrackType

Jenis track. Untuk informasi selengkapnya, lihat AoqTrackType.

fadeMs

int

Durasi fade-out, dalam milidetik. 0 menunjukkan interupsi langsung.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
virtual int enableLocalAudioVolumeIndication(const AoqAudioVolumeIndicationConfig& config);
Parameter

Parameter

Tipe

Deskripsi

config

const AoqAudioVolumeIndicationConfig&

Konfigurasi indikasi volume. Untuk informasi selengkapnya, lihat AoqAudioVolumeIndicationConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

Konfigurasi encoding audio

setAudioEncoderConfig

Menetapkan parameter encoding audio.
virtual int setAudioEncoderConfig(const AoqAudioCodecConfig& config);
Parameter

Parameter

Tipe

Deskripsi

config

const AoqAudioCodecConfig&

Konfigurasi codec audio. Untuk informasi selengkapnya, lihat AoqAudioCodecConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

setAudioDecoderConfig

Menetapkan parameter decoding audio.
virtual int setAudioDecoderConfig(const AoqAudioCodecConfig& config);
Parameter

Parameter

Tipe

Deskripsi

config

const AoqAudioCodecConfig&

Konfigurasi codec audio. Untuk informasi selengkapnya, lihat AoqAudioCodecConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

Manajemen perangkat video

startVideoCapture

Membuka perangkat capture video (kamera). Ketika isExternal=true dikonfigurasi, kamera tidak dibuka, dan frame diberikan oleh pushExternalVideoCapturedFrame.
virtual int startVideoCapture(const AoqVideoCaptureConfig& config);
Parameter

Parameter

Tipe

Deskripsi

config

const AoqVideoCaptureConfig&

Konfigurasi capture video. Untuk informasi selengkapnya, lihat AoqVideoCaptureConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

stopVideoCapture

Menutup perangkat capture video.
virtual int stopVideoCapture();
Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

setLocalView

Menetapkan atau menghapus jendela rendering video lokal. Jika canvas.view == nullptr, binding dihapus.
virtual int setLocalView(AoqTrackType trackType, const AoqVideoCanvas& canvas);
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Track video. Gunakan AoqTrackTypeVideo.

canvas

const AoqVideoCanvas&

Kanvas rendering. Untuk informasi selengkapnya, lihat AoqVideoCanvas. Jika view adalah nullptr, binding dihapus.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

setRemoteView

Menetapkan atau menghapus jendela rendering video remote. Jika canvas.view == nullptr, binding dihapus.
virtual int setRemoteView(AoqTrackType trackType, const AoqVideoCanvas& canvas);
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Track video. Gunakan AoqTrackTypeVideo.

canvas

const AoqVideoCanvas&

Kanvas rendering. Untuk informasi selengkapnya, lihat AoqVideoCanvas. Jika view adalah nullptr, binding dihapus.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

Encoding video dan input eksternal

setVideoEncoderConfig

Menetapkan parameter encoding video dan mengarahkannya berdasarkan config.trackType.
virtual int setVideoEncoderConfig(const AoqVideoCodecConfig& config);
Parameter

Parameter

Type

Deskripsi

config

const AoqVideoCodecConfig&

Konfigurasi codec video. Untuk informasi selengkapnya, lihat AoqVideoCodecConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

setVideoDecoderConfig

Menetapkan parameter decoding video (proposal codec di sisi subscriber, yang harus dipanggil sebelum connect). Pemanggilan diarahkan berdasarkan config.trackType.
virtual int setVideoDecoderConfig(const AoqVideoCodecConfig& config);
Parameter

Parameter

Tipe

Deskripsi

config

const AoqVideoCodecConfig&

Konfigurasi codec video. Untuk informasi selengkapnya, lihat AoqVideoCodecConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
virtual int pushExternalVideoCapturedFrame(AoqTrackType trackType, const AoqVideoFrame& frame);
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Target routing. Gunakan AoqTrackTypeVideo.

frame

const AoqVideoFrame&

Data frame video eksternal. Untuk informasi selengkapnya, lihat AoqVideoFrame.

Mengembalikan: 0 jika berhasil; 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.
virtual int pushExternalVideoEncodedFrame(AoqTrackType trackType, const AoqVideoEncodedFrame& frame);
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Target routing. Gunakan AoqTrackTypeVideo.

frame

const AoqVideoEncodedFrame&

Data frame yang di-encode secara eksternal. Untuk informasi selengkapnya, lihat AoqVideoEncodedFrame.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
virtual int enableSendMediaStream(AoqTrackType trackType, bool enable);
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Target routing. AoqTrackTypeAudio dan AoqTrackTypeVideo didukung.

enable

bool

true mengaktifkan pengiriman; false menonaktifkan pengiriman

Mengembalikan: 0 menunjukkan bahwa pemanggilan telah diproses dan berjalan secara asinkron; bukan nol menunjukkan kegagalan.

Pemutaran file audio

startAudioFile

Memulai pemutaran file audio lokal ke aliran publishing.
virtual int startAudioFile(const char* fileId, const AoqAudioFileMixConfig& config);
Parameter

Parameter

Tipe

Deskripsi

fileId

const char*

ID file audio. Lapisan bisnis harus memastikan bahwa ID tersebut unik.

config

const AoqAudioFileMixConfig&

Konfigurasi mixing file audio. Untuk informasi selengkapnya, lihat AoqAudioFileMixConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

stopAudioFile

Menghentikan pemutaran file audio.
virtual int stopAudioFile(const char* fileId);
Parameter

Parameter

Tipe

Deskripsi

fileId

const char*

ID file audio

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

pauseAudioFile

Menjeda pemutaran file audio.
virtual int pauseAudioFile(const char* fileId);
Parameter

Parameter

Tipe

Deskripsi

fileId

const char*

ID file audio

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

resumeAudioFile

Melanjutkan pemutaran file audio.
virtual int resumeAudioFile(const char* fileId);
Parameter

Parameter

Tipe

Deskripsi

fileId

const char*

ID file audio

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

getAudioFileDuration

Mendapatkan durasi total file audio.
virtual int64_t getAudioFileDuration(const char* fileId);
Parameter

Parameter

Tipe

Deskripsi

fileId

const char*

ID file audio

Mengembalikan: Nilai lebih besar atau sama dengan 0 menunjukkan durasi file audio, dalam milidetik; nilai kurang dari 0 menunjukkan kegagalan (-AoqErrorCode).

getAudioFileCurrentPosition

Mendapatkan posisi pemutaran saat ini dari file audio.
virtual int64_t getAudioFileCurrentPosition(const char* fileId);
Parameter

Parameter

Tipe

Deskripsi

fileId

const char*

ID file audio

Mengembalikan: Nilai lebih besar atau sama dengan 0 menunjukkan posisi pemutaran saat ini, dalam milidetik; nilai kurang dari 0 menunjukkan kegagalan (-AoqErrorCode).

setAudioFilePositionMillis

Menetapkan posisi pemutaran file audio (seek).
virtual int setAudioFilePositionMillis(const char* fileId, int64_t positionMillis);
Parameter

Parameter

Tipe

Deskripsi

fileId

const char*

ID file audio

positionMillis

int64_t

Posisi pemutaran, dalam milidetik

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

setAudioFileVolume

Menetapkan volume file audio.
virtual int setAudioFileVolume(const char* fileId, AoqAudioStreamDirection type, int volume);
Parameter

Parameter

Type

Deskripsi

fileId

const char*

ID file audio

type

AoqAudioStreamDirection

Arah aliran audio. Untuk informasi selengkapnya, lihat AoqAudioStreamDirection.

volume

int

Nilai volume. Nilai valid: 0 hingga 100.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

getAudioFileVolume

Mendapatkan volume saat ini dari file audio.
virtual int getAudioFileVolume(const char* fileId, AoqAudioStreamDirection type);
Parameter

Parameter

Type

Deskripsi

fileId

const char*

ID file audio

type

AoqAudioStreamDirection

Arah aliran audio. Untuk informasi selengkapnya, lihat AoqAudioStreamDirection.

Mengembalikan: Nilai dari 0 hingga 100 menunjukkan volume; nilai kurang dari 0 menunjukkan kegagalan (-AoqErrorCode).

Aliran audio eksternal

addAudioExternalStream

Menambahkan aliran audio eksternal.
virtual int addAudioExternalStream(const char* streamId, const AoqAudioExternalStreamConfig& config);
Parameter

Parameter

Tipe

Deskripsi

streamId

const char*

ID aliran audio eksternal. Lapisan bisnis harus memastikan bahwa ID tersebut unik.

config

const AoqAudioExternalStreamConfig&

Konfigurasi aliran audio eksternal. Untuk informasi selengkapnya, lihat AoqAudioExternalStreamConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
virtual int pushAudioExternalStreamData(const char* streamId, AoqAudioFrameData& data);
Parameter

Parameter

Tipe

Deskripsi

streamId

const char*

ID aliran audio eksternal

data

AoqAudioFrameData&

Data audio eksternal mentah. Untuk informasi selengkapnya, lihat AoqAudioFrameData.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.
Praktik terbaik: Dalam skenario capture real-time, dorong data 10 ms sekaligus dan dorong kapan pun data tersedia. Ketika data berasal dari file, dorong data 40 ms sekaligus setiap interval 30 ms, dan tangani nilai kembalian AoqECAudioExternalBufferFull.

setAudioExternalStreamVolume

Menetapkan volume aliran audio eksternal.
virtual int setAudioExternalStreamVolume(const char* streamId, AoqAudioStreamDirection type, int vol);
Parameter

Parameter

Tipe

Deskripsi

streamId

const char*

ID aliran audio eksternal

type

AoqAudioStreamDirection

Jenis aliran audio eksternal. Untuk informasi selengkapnya, lihat AoqAudioStreamDirection.

vol

int

Nilai volume. Nilai valid: 0 hingga 100.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

getAudioExternalStreamVolume

Mendapatkan volume aliran audio eksternal.
virtual int getAudioExternalStreamVolume(const char* streamId, AoqAudioStreamDirection type);
Parameter

Parameter

Tipe

Deskripsi

streamId

const char*

ID aliran audio eksternal

type

AoqAudioStreamDirection

Jenis aliran audio eksternal. Untuk informasi selengkapnya, lihat AoqAudioStreamDirection.

Mengembalikan: Nilai dari 0 hingga 100 menunjukkan volume; nilai kurang dari 0 menunjukkan kegagalan (-AoqErrorCode).

clearAudioExternalStreamBuffer

Mengosongkan buffer aliran audio eksternal.
virtual void clearAudioExternalStreamBuffer(const char* streamId, int fadeoutMs);
Parameter

Parameter

Tipe

Deskripsi

streamId

const char*

ID aliran audio eksternal

fadeoutMs

int

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.

Mengembalikan: Tidak ada.

removeAudioExternalStream

Menghapus aliran audio eksternal.
virtual int removeAudioExternalStream(const char* streamId);
Parameter

Parameter

Tipe

Deskripsi

streamId

const char*

ID aliran audio eksternal

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

Pesan real-time

sendDataMsg

Mengirim pesan data real-time.
virtual int sendDataMsg(const AoqDataMsg& msg);
Parameter

Parameter

Tipe

Deskripsi

msg

const AoqDataMsg&

Isi pesan. Untuk informasi selengkapnya, lihat AoqDataMsg.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
virtual int setAudioFrameObserver(IAudioFrameObserver* observer) = 0;
Parameter

Parameter

Type

Deskripsi

observer

IAudioFrameObserver*

Listener callback frame audio. Untuk informasi selengkapnya, lihat IAudioFrameObserver. Berikan nullptr untuk menghentikan callback.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

enableAudioFrameObserver

Mengaktifkan atau menonaktifkan callback frame audio pada posisi tertentu.
virtual int enableAudioFrameObserver(bool enabled, AoqAudioSource audioSource,
                                     const AoqAudioObserverConfig& config) = 0;
Parameter

Parameter

Tipe

Deskripsi

enabled

bool

Menentukan apakah callback data diizinkan

audioSource

AoqAudioSource

Jenis sumber data audio mentah. Untuk informasi selengkapnya, lihat AoqAudioSource.

config

const AoqAudioObserverConfig&

Pengaturan parameter callback. Untuk informasi selengkapnya, lihat AoqAudioObserverConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
virtual int setVideoFrameObserver(IVideoFrameObserver* observer) = 0;
Parameter

Parameter

Tipe

Deskripsi

observer

IVideoFrameObserver*

Listener callback frame video. Untuk informasi selengkapnya, lihat IVideoFrameObserver. Berikan nullptr untuk menghentikan callback.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

enableVideoFrameObserver

Mengaktifkan atau menonaktifkan callback frame video pada posisi tertentu.
virtual int enableVideoFrameObserver(bool enabled, AoqVideoSource videoSource,
                                     const AoqVideoObserverConfig& config) = 0;
Parameter

Parameter

Tipe

Deskripsi

enabled

bool

Menentukan apakah callback data diaktifkan pada posisi tertentu

videoSource

AoqVideoSource

Sumber data callback frame video (posisi dalam pipeline). Untuk informasi selengkapnya, lihat AoqVideoSource.

config

const AoqVideoObserverConfig&

Pengaturan parameter callback. Untuk informasi selengkapnya, lihat AoqVideoObserverConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
virtual void onError(int code, const char* message) = 0;
Parameter

Parameter

Tipe

Deskripsi

code

int

Kode error. Untuk informasi selengkapnya, lihat AoqErrorCode.

message

const char*

Deskripsi error

onWarning

Callback peringatan engine.
virtual void onWarning(int code, const char* message) = 0;
Parameter

Parameter

Tipe

Deskripsi

code

int

Kode peringatan. Untuk informasi selengkapnya, lihat AoqWarningCode.

message

const char*

Deskripsi peringatan

onConnectionStatusChange

Callback perubahan status koneksi engine.
virtual void onConnectionStatusChange(AoqConnectionStatus status) = 0;
Parameter

Parameter

Tipe

Deskripsi

status

AoqConnectionStatus

Status koneksi. Untuk informasi selengkapnya, lihat AoqConnectionStatus.

onStats

Callback statistik engine.
virtual void onStats(const AoqStats& stats) = 0;
Parameter

Parameter

Type

Deskripsi

stats

const AoqStats&

Data statistik. Untuk informasi selengkapnya, lihat AoqStats.

onAudioDeviceStateChanged

Callback untuk perubahan status operasi capture dan playback perangkat audio.
virtual void onAudioDeviceStateChanged(const AoqAudioDeviceState& state) = 0;
Parameter

Parameter

Tipe

Deskripsi

state

const AoqAudioDeviceState&

Status perangkat audio. Untuk informasi selengkapnya, lihat AoqAudioDeviceState.

onAudioDeviceRouteChanged

Callback perubahan rute output audio.
virtual void onAudioDeviceRouteChanged(int routeType) = 0;
Parameter

Parameter

Tipe

Deskripsi

routeType

int

Jenis rute. Untuk nilai valid, lihat AoqAudioDeviceRouteType.

onAudioFileState

Callback untuk status pemutaran file audio.
virtual void onAudioFileState(const AoqAudioFileState& state) = 0;
Parameter

Parameter

Tipe

Deskripsi

state

const AoqAudioFileState&

Status pemutaran file. Untuk informasi selengkapnya, lihat AoqAudioFileState.

onLocalAudioVolumeIndication

Callback indikasi volume capture lokal. Untuk mengaktifkannya, panggil enableLocalAudioVolumeIndication.
virtual void onLocalAudioVolumeIndication(const AoqAudioVolume& volume) = 0;
Parameter

Parameter

Tipe

Deskripsi

volume

const AoqAudioVolume&

Informasi volume lokal. Untuk informasi selengkapnya, lihat AoqAudioVolume.

onVideoDeviceStateChanged

Callback untuk perubahan status operasi capture perangkat video.
virtual void onVideoDeviceStateChanged(const AoqVideoDeviceState& state) = 0;
Parameter

Parameter

Type

Deskripsi

state

const AoqVideoDeviceState&

Status perangkat video. Untuk informasi selengkapnya, lihat AoqVideoDeviceState.

onDataMsg

Callback untuk pesan data real-time yang diterima.
virtual void onDataMsg(const AoqDataMsg& msg) = 0;
Parameter

Parameter

Type

Deskripsi

msg

const AoqDataMsg&

Pesan data. Untuk informasi selengkapnya, lihat AoqDataMsg.

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.
virtual void onCapturedAudioFrame(const AoqAudioFrameData& data) = 0;
Parameter

Parameter

Tipe

Deskripsi

data

const AoqAudioFrameData&

Data audio capture mentah. Untuk informasi selengkapnya, lihat AoqAudioFrameData.

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.
virtual void onProcessCapturedAudioFrame(const AoqAudioFrameData& data) = 0;
Parameter

Parameter

Tipe

Deskripsi

data

const AoqAudioFrameData&

Data audio mentah setelah pemrosesan 3A. Untuk informasi selengkapnya, lihat AoqAudioFrameData.

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.
virtual void onPublishAudioFrame(AoqTrackType trackType, const AoqAudioFrameData& data) = 0;
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track. Untuk informasi selengkapnya, lihat AoqTrackType.

data

const AoqAudioFrameData&

Data audio mentah yang akan dipublikasikan. Untuk informasi selengkapnya, lihat AoqAudioFrameData.

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.
virtual void onPlaybackAudioFrame(const AoqAudioFrameData& data) = 0;
Parameter

Parameter

Tipe

Deskripsi

data

const AoqAudioFrameData&

Data audio mentah untuk playback. Untuk informasi selengkapnya, lihat AoqAudioFrameData.

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.
virtual bool onCapturedVideoFrame(AoqVideoFrame& frame) = 0;
Parameter

Parameter

Tipe

Deskripsi

frame

AoqVideoFrame&

Data frame video yang ditangkap. Untuk informasi selengkapnya, lihat AoqVideoFrame.

Mengembalikan: 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.
virtual bool onPreEncodeVideoFrame(AoqTrackType trackType, AoqVideoFrame& frame) = 0;
Parameter

Parameter

Type

Deskripsi

trackType

AoqTrackType

Jenis track video. Untuk informasi selengkapnya, lihat AoqTrackType.

frame

AoqVideoFrame&

Data frame video sebelum encoding. Untuk informasi selengkapnya, lihat AoqVideoFrame.

Mengembalikan: 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.
virtual bool onRemoteVideoFrame(AoqTrackType trackType, AoqVideoFrame& frame) = 0;
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track video. Untuk informasi selengkapnya, lihat AoqTrackType.

frame

AoqVideoFrame&

Data frame video remote. Untuk informasi selengkapnya, lihat AoqVideoFrame.

Mengembalikan: 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

workDir

const char*

nullptr

Direktori kerja SDK

enableDumpAudio

bool

false

Menentukan apakah data audio disimpan (untuk debugging)

extras

const char*

nullptr

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

const char*

Token autentikasi koneksi

sid

const char*

ID sesi

certFingerprint

const char*

Sidik jari sertifikat server

workspaceIdHash

const char*

ID hash ruang kerja

relayEndpoints

const AoqRelayEndpoint*

Array titik akses relay

relayEndpointsCount

size_t

Jumlah titik akses relay

publishTracks

const AoqTrackParam*

Array atribut track publishing lokal

publishTracksCount

size_t

Jumlah track publishing

subscribeTracks

const AoqTrackParam*

Array atribut track subscribing lokal

subscribeTracksCount

size_t

Jumlah track subscribing

AoqRelayEndpoint

Titik akses relay.

Field

Tipe

Nilai default

Deskripsi

route_index

int

-1

Indeks rute

endpoint

const char*

nullptr

Alamat server (nama domain atau alamat IP)

port

int

0

Port server

AoqTrackParam

Atribut track.

Field

Tipe

Nilai default

Deskripsi

trackType

AoqTrackType

Audio

Jenis track

trackMode

AoqTrackMode

Segment

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

data

const uint8_t*

Isi pesan. Menunjuk ke memori yang dipegang oleh pemanggil.

dataSize

size_t

Jumlah byte

Tipe statistik

AoqStats

Statistik engine. Setiap array statistik disediakan sebagai pointer dan jumlah.

Field

Tipe

Deskripsi

audioPublishStats / audioPublishStatsCount

const AoqAudioPublishStats* / unsigned int

Array statistik publishing untuk audio dan jumlah entri

videoPublishStats / videoPublishStatsCount

const AoqVideoPublishStats* / unsigned int

Array statistik publishing untuk video dan jumlah entri

dataMsgPublishStats / dataMsgPublishStatsCount

const AoqDataMsgPublishStats* / unsigned int

Array statistik publishing untuk pesan data dan jumlah entri

audioSubscribeStats / audioSubscribeStatsCount

const AoqAudioSubscribeStats* / unsigned int

Array statistik subscribing untuk audio dan jumlah entri

videoSubscribeStats / videoSubscribeStatsCount

const AoqVideoSubscribeStats* / unsigned int

Array statistik subscribing untuk video dan jumlah entri

dataMsgSubscribeStats / dataMsgSubscribeStatsCount

const AoqDataMsgSubscribeStats* / unsigned int

Array statistik subscribing untuk pesan data dan jumlah entri

networkStats

const AoqNetworkStats*

Statistik jaringan

AoqNetworkStats

Statistik jaringan.

Field

Tipe

Deskripsi

sendBitrate

unsigned int

Bitrate kirim, dalam bit/s

sendBytes

uint64_t

Byte kumulatif yang dikirim

recvBitrate

unsigned int

Bitrate terima, dalam bit/s

recvBytes

uint64_t

Byte kumulatif yang diterima

loss

unsigned int

Laju loss paket, dari 0 hingga 100

rtt

unsigned int

Latensi round-trip, dalam ms

AoqAudioPublishStats

Statistik publishing untuk audio.

Field

Type

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

unsigned int

Bitrate, dalam bit/s

bytes

uint64_t

Byte kumulatif

encodeVolume

unsigned int

Volume encoding aliran publishing

AoqVideoPublishStats

Statistik publishing untuk video.

Field

Type

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

unsigned int

Bitrate, dalam bit/s

bytes

uint64_t

Byte kumulatif

encodeFps

unsigned int

Laju frame encoding

AoqDataMsgPublishStats

Statistik publishing untuk pesan data.

Field

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

unsigned int

Bitrate, dalam bit/s

bytes

uint64_t

Byte kumulatif

AoqAudioSubscribeStats

Statistik subscribing untuk audio.

Field

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

unsigned int

Bitrate, dalam bit/s

bytes

uint64_t

Byte kumulatif

playVolume

unsigned int

Volume playback

AoqVideoSubscribeStats

Statistik subscribing untuk video.

Field

Type

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

unsigned int

Bitrate, dalam bit/s

bytes

uint64_t

Byte kumulatif

decodeFps

unsigned int

Laju frame decoding

renderFps

unsigned int

Laju frame rendering

AoqDataMsgSubscribeStats

Statistik subscribing untuk pesan data.

Field

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

unsigned int

Bitrate, dalam bit/s

bytes

uint64_t

Byte kumulatif

Enumerasi

AoqErrorCode

Enumerasi kode error.

Nilai enum

Nilai

Deskripsi

AoqECOK

0

Berhasil

AoqECParamInvalid

1

Parameter tidak valid

AoqECStateInvalid

2

Status tidak valid

AoqECUnSupport

3

API dipanggil tetapi tidak diimplementasikan pada platform saat ini atau dalam mode saat ini

AoqECAudio

100

Error audio umum

AoqECAudioExternalBufferFull

110

Buffer audio eksternal penuh

AoqECAudioDevice

120

Error perangkat audio umum

AoqECAudioDeviceRecordingAuthFailed

121

Izin perekaman tidak diberikan

AoqECAudioDeviceRecordingOccupied

122

Perangkat perekaman sedang digunakan

AoqECAudioDeviceRecordingBackgroundStart

123

Memulai perekaman di latar belakang

AoqECAudioDeviceRecordingStartFail

124

Gagal memulai perekaman

AoqECAudioDevicePlayoutOccupied

125

Perangkat playback sedang digunakan

AoqECAudioDevicePlayoutBackgroundStart

126

Memulai playback di latar belakang

AoqECAudioDevicePlayoutStartFail

127

Gagal memulai playback

AoqECAudioDeviceEarpieceRequiresVoipMode

128

Mode receiver memerlukan VoIP diaktifkan

AoqECVideo

200

Error video umum

AoqECVideoExternalBufferFull

210

Buffer video eksternal penuh

AoqECVideoExternalCaptureNotEnabled

211

Capture video eksternal tidak diaktifkan

AoqECVideoExternalEncoderNotEnabled

212

Encoding video eksternal tidak diaktifkan

AoqECVideoDevice

220

Error perangkat video umum

AoqECVideoDeviceCameraOpenFail

221

Gagal membuka kamera

AoqECVideoDeviceCameraAuthFailed

222

Izin kamera tidak diberikan

AoqECVideoDeviceCameraOccupied

223

Kamera sedang digunakan

AoqECVideoDeviceCameraRunningError

224

Error runtime kamera

AoqECVideoCodec

230

Error codec video umum

AoqECVideoCodecEncoderInitFail

231

Gagal menginisialisasi encoder

AoqECVideoRender

240

Error rendering video umum

AoqECVideoRenderCreateFail

241

Gagal membuat tampilan rendering

AoqECVideoRenderDrawError

242

Error gambar rendering

AoqWarningCode

Enumerasi kode peringatan.

Nilai enum

Nilai

Deskripsi

AoqWCOK

0

Tidak ada peringatan

AoqWCAudio

100

Peringatan audio umum

AoqWCAudioHowling

101

Terdeteksi howling audio

AoqWCAudioDevice

120

Peringatan perangkat audio umum

AoqWCAudioDeviceMicEnumerateError

121

Error enumerasi mikrofon

AoqWCAudioDeviceMicStartTimeout

122

Waktu mulai mikrofon habis

AoqWCAudioDeviceRecordingError

123

Error perekaman

AoqWCAudioDeviceSpeakerEnumerateError

124

Error enumerasi speaker

AoqWCAudioDeviceSpeakerStartTimeout

125

Waktu mulai speaker habis

AoqWCAudioDevicePlayoutError

126

Error playback

AoqWCVideo

200

Peringatan video umum

AoqWCVideoCameraEnumerateError

201

Error enumerasi kamera

AoqWCVideoEncoderSwitched

202

Encoder video dialihkan

AoqWCVideoRenderDowngrade

203

Spesifikasi rendering video diturunkan.

AoqTrackType

Jenis track.

Nilai enum

Nilai

Deskripsi

AoqTrackTypeAudio

0

Track audio

AoqTrackTypeVideo

1

Track video

AoqTrackTypeData

2

Track pesan data

AoqEncoderType

Jenis encoder.

Nilai Enum

Nilai

Deskripsi

AoqEncoderTypeUnknown

0

Format tidak diketahui

AoqEncoderTypeAudioPCM

1

Audio PCM

AoqEncoderTypeAudioOpus

2

Audio Opus (berbasis plugin; hubungi tim SDK untuk membangunnya secara built-in atau mengunduhnya secara dinamis ke aplikasi)

AoqEncoderTypeVideoH264

3

Video H.264

AoqEncoderTypeVideoJpeg

4

Video JPEG

AoqEncoderTypeDataText

5

Teks pesan

AoqTrackMode

Mode streaming atau non-streaming. Hanya berlaku untuk downlink audio.

Nilai enum

Nilai

Deskripsi

AoqTrackModeSegment

0

Tersegmentasi: data dikemas dan dikirim dalam segmen semantik, seperti kalimat.

AoqTrackModeStream

1

Streaming: data dikirim secara kontinu.

AoqConnectionStatus

Status koneksi engine.

Nilai enum

Nilai

Deskripsi

AoqConnectionStatusDisconnected

0

Terputus

AoqConnectionStatusConnecting

1

Menghubungkan

AoqConnectionStatusConnected

2

Tersambung

AoqConnectionStatusFailed

3

Koneksi gagal

Tipe audio

AoqAudioCaptureConfig

Konfigurasi capture audio.

Field

Tipe

Nilai default

Deskripsi

isExternal

bool

false

Menentukan apakah menggunakan capture eksternal

channel

int

1

Jumlah channel capture audio. Didukung 1 dan 2.

AoqAudioPlaybackConfig

Konfigurasi playback audio.

Field

Tipe

Nilai default

Deskripsi

isExternal

bool

false

Menentukan apakah menggunakan playback eksternal

channel

int

1

Jumlah channel playback audio. Didukung 1 dan 2.

AoqAudioCodecConfig

Konfigurasi codec audio.

Field

Tipe

Nilai default

Deskripsi

trackType

AoqTrackType

Audio

Jenis track

codecType

AoqEncoderType

AudioPCM

Format codec

sampleRate

int

48000

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.

channel

int

1

Jumlah channel. Didukung 1 dan 2.

bitrate

int

32000

Bitrate, dalam bit/s

AoqAudioDeviceState

Status perangkat audio.

Field

Type

Deskripsi

state

AoqAudioDeviceStateCode

Kode status

reason

int

Kode error (AoqErrorCode)

AoqAudioDeviceStateCode

Kode status perangkat audio.

Nilai enum

Nilai

Deskripsi

AoqAudioDeviceNone

0

Tidak ada status

AoqAudioDeviceRecordStarting

1

Capture dimulai

AoqAudioDeviceRecordStarted

2

Capture telah dimulai

AoqAudioDeviceRecordStopping

3

Capture dihentikan

AoqAudioDeviceRecordStopped

4

Capture telah dihentikan

AoqAudioDeviceRecordFail

5

Capture gagal

AoqAudioDevicePlayStarting

6

Playback dimulai

AoqAudioDevicePlayStarted

7

Playback telah dimulai

AoqAudioDevicePlayStopping

8

Playback dihentikan

AoqAudioDevicePlayStopped

9

Playback telah dihentikan

AoqAudioDevicePlayFail

10

Playback gagal

AoqAudioDeviceRouteType

Jenis rute perangkat audio.

Nilai enum

Nilai

Deskripsi

AoqAudioDeviceRouteDefault

0

Default

AoqAudioDeviceRouteHeadset

1

Headphone

AoqAudioDeviceRouteEarpiece

2

Receiver

AoqAudioDeviceRouteHeadsetNoMic

3

Headphone tanpa mikrofon

AoqAudioDeviceRouteSpeakerPhone

4

Speaker bawaan

AoqAudioDeviceRouteUsb

5

USB

AoqAudioDeviceRouteBluetooth

6

Bluetooth

AoqAudioDeviceRouteBluetoothA2dp

7

Bluetooth A2DP

AoqAudioFileMixConfig

Konfigurasi untuk memutar file audio ke aliran publishing.

Field

Type

Nilai default

Deskripsi

fileName

const char*

nullptr

Nama file (termasuk path). Wajib diisi.

cycles

int

-1

Jumlah loop. -1 berarti looping tanpa batas.

startPosMs

long

0

Posisi mulai pemutaran, dalam ms

publishVolume

int

100

Volume publishing. Nilai valid: 0 hingga 100.

playoutVolume

int

100

Volume playback. Nilai valid: 0 hingga 100.

AoqAudioFileState

Status file audio.

Field

Tipe

Deskripsi

fileId

const char*

ID file

stateCode

AoqAudioFileStateCode

Kode status

errorCode

AoqAudioFileErrorCode

Kode error

AoqAudioFileStateCode

Kode status file audio.

Nilai enum

Nilai

Deskripsi

AoqAudioFileNone

0

Tidak ada status

AoqAudioFileStarted

1

Mulai

AoqAudioFileStopped

2

Dihentikan

AoqAudioFilePaused

3

Dijeda

AoqAudioFileResumed

4

Dilanjutkan

AoqAudioFileEnded

5

Pemutaran selesai

AoqAudioFileBuffering

6

Buffering

AoqAudioFileBufferingEnd

7

Buffering selesai

AoqAudioFileFailed

8

Pemutaran gagal

AoqAudioFileErrorCode

Kode error pemutaran file audio.

Nilai enum

Nilai

Deskripsi

AoqAudioFileNoError

0

Tidak ada error

AoqAudioFileOpenFailed

1

Gagal membuka file

AoqAudioFileDecodeFailed

2

Gagal mendekode file

AoqAudioExternalStreamConfig

Konfigurasi aliran audio eksternal.

Field

Tipe

Nilai default

Deskripsi

trackType

AoqTrackType

Audio

Jenis track audio

codecType

AoqEncoderType

AudioPCM

Format aliran audio. PCM didukung.

channels

int

1

Jumlah channel. Dibatasi oleh codec audio aliran publishing, yang mendukung 1 dan 2. Channel tambahan diabaikan.

sampleRate

int

48000

Laju sampel, dalam Hz. Didukung 8, 12, 16, 24, 32, 44.1, 48, 64, 88.2, 96, 176.4, dan 192K.

playoutVolume

int

100

Volume playback. Nilai valid: 0 hingga 100.

publishVolume

int

100

Volume publishing. Nilai valid: 0 hingga 100.

maxBufferDuration

int

600000

Durasi buffer maksimum, dalam ms. Nilai valid: 100 ke atas. Jika durasi buffer di SDK melebihi nilai ini, Push gagal.

enable3A

bool

false

Menentukan apakah menerapkan pemrosesan 3A pada PCM input

AoqAudioFrameData

Data audio.

Field

Tipe

Deskripsi

dataPtr

void*

Pointer ke data audio

numOfSamples

int

Jumlah sampel (per channel)

bytesPerSample

int

Byte per sampel

numOfChannels

int

Jumlah channel

samplesPerSec

int

Jumlah sampel per detik

pushSequence

int

Ronde input PCM (digunakan untuk notifikasi penyelesaian konsumsi pushAudioExternalStreamData)

timeStamp

int64_t

Timestamp

dataSize

int

Panjang data

autoGenMute

bool

Berlaku dalam callback data. true menunjukkan data senyap yang dihasilkan oleh SDK.

AoqAudioStreamDirection

Arah aliran audio.

Nilai enum

Nilai

Deskripsi

AoqAudioStreamPublish

0

Penerbitan audio

AoqAudioStreamPlayout

1

Audio playback

AoqAudioExternalStreamToggle

Kontrol aliran audio eksternal.

Nilai enum

Nilai

Deskripsi

AoqAudioExternalStreamToggleNormal

0

Dipulihkan

AoqAudioExternalStreamTogglePause

1

Dijeda

AoqAudioSource

Jenis sumber data audio.

Nilai enum

Nilai

Deskripsi

AoqAudioSourceCaptured

0

Data audio yang ditangkap

AoqAudioSourceProcessCaptured

1

Data audio setelah pemrosesan 3A

AoqAudioSourcePublish

2

Data audio yang akan dipublikasikan (memerlukan Connect yang berhasil)

AoqAudioSourcePlayback

3

Data audio yang akan diputar

AoqAudioObserverMode

Mode callback frame audio.

Nilai enum

Nilai

Deskripsi

AoqAudioObserverModeReadOnly

0

Read-only

AoqAudioObserverModeReadWrite

1

Read-write

AoqAudioObserverConfig

Pengaturan parameter untuk callback data audio.

Field

Tipe

Nilai default

Deskripsi

sampleRate

int

48000

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.

channels

int

1

Jumlah channel audio dalam callback. Didukung 1 dan 2. Parameter ini dibatasi oleh parameter codec aliran subscribing.

mode

AoqAudioObserverMode

ReadOnly

Mode callback

AoqAudioVolumeIndicationConfig

Konfigurasi indikasi volume lokal.

Field

Tipe

Nilai default

Deskripsi

interval

int

0

Interval callback, dalam ms. Nilai kurang dari atau sama dengan 0 menonaktifkan callback. Nilai lebih dari 0 dan kurang dari 10 diperlakukan sebagai 10.

smooth

int

3

Koefisien penghalusan volume. Nilai valid: 0 hingga 10. Nilai lebih besar menghasilkan output yang lebih halus.

AoqAudioVolume

Informasi volume lokal.

Field

Tipe

Deskripsi

volume

int

Volume instan yang telah dihaluskan. Nilai valid: 0 hingga 255.

Tipe video

AoqVideoCaptureConfig

Konfigurasi capture video.

Field

Type

Nilai default

Deskripsi

width

int

1280

Lebar capture, dalam piksel. Parameter ini tidak berlaku saat isExternal=true.

height

int

720

Tinggi capture, dalam piksel. Parameter ini tidak berlaku saat isExternal=true.

fps

int

15

Laju frame capture. Parameter ini tidak berlaku saat isExternal=true (kecepatan ditentukan oleh pengiriman frame).

isExternal

bool

false

Menentukan apakah menggunakan capture eksternal. Jika true, kamera tidak dibuka, dan frame diberikan oleh pushExternalVideoCapturedFrame.

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

view

void*

nullptr

Handle tampilan (HWND). Berikan nullptr untuk menghapus binding rendering.

renderMode

AoqRenderMode

Auto

Mode rendering

AoqRenderMode

Mode tampilan rendering.

Nilai enum

Nilai

Deskripsi

AoqRenderModeAuto

0

Mode otomatis

AoqRenderModeStretch

1

Mode stretch-to-fill. Saat rasio aspek tidak cocok, gambar diregangkan ke rasio target dan menjadi terdistorsi.

AoqRenderModeFill

2

Mode letterbox. Saat rasio aspek tidak cocok, bar hitam ditambahkan di atas dan bawah atau kiri dan kanan.

AoqRenderModeCrop

3

Mode crop. Saat rasio aspek tidak cocok, lebar atau tinggi dipotong dan bagian gambar hilang.

AoqVideoPixelFormat

Format piksel video.

Nilai enum

Nilai

Deskripsi

AoqVideoPixelFormatUnknown

0

Format tidak diketahui

AoqVideoPixelFormatI420

1

I420

AoqVideoPixelFormatNV12

2

NV12

AoqVideoPixelFormatNV21

3

NV21

AoqVideoPixelFormatBGRA

4

BGRA

AoqVideoPixelFormatRGBA

5

RGBA

AoqVideoFrame

Data video eksternal.

Field

Tipe

Deskripsi

format

AoqVideoPixelFormat

Format piksel

width

int

Lebar, dalam piksel

height

int

Tinggi, dalam piksel

dataPtr

void*

Pointer ke data dalam format terkemas (NV12/NV21/BGRA/RGBA)

dataSize

int

Jumlah byte data terkompresi

dataY / dataU / dataV

void*

Pointer ke data tiga bidang I420

strideY / strideU / strideV

int

Stride tiga bidang I420

timeStamp

int64_t

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

codec

AoqVideoCodecType

Format codec

data

void*

Pointer ke data yang di-encode

dataSize

int

Jumlah byte data yang di-encode

width

int

Lebar, dalam piksel

height

int

Tinggi, dalam piksel

timeStamp

int64_t

Timestamp, dalam ms. Jika 0, SDK mengisinya dengan jam lokal.

AoqVideoCodecType

Jenis codec frame yang di-encode secara eksternal.

Nilai enum

Nilai

Deskripsi

AoqVideoCodecTypeJPEG

0

JPEG

AoqVideoDeviceState

Status perangkat video.

Field

Type

Deskripsi

state

AoqVideoDeviceStateCode

Kode status

reason

int

Kode error (AoqErrorCode)

AoqVideoDeviceStateCode

Kode status perangkat video.

Nilai enum

Nilai

Deskripsi

AoqVideoDeviceNone

0

Tidak ada status

AoqVideoDeviceCaptureStarting

1

Kamera dimulai

AoqVideoDeviceCaptureStarted

2

Kamera telah dimulai

AoqVideoDeviceCaptureStopping

3

Kamera dihentikan

AoqVideoDeviceCaptureStopped

4

Kamera telah dihentikan

AoqVideoDeviceCaptureFail

5

Gagal memulai kamera (misalnya, izin ditolak atau perangkat tidak tersedia)

AoqMirrorMode

Mode mirror.

Nilai enum

Nilai

Deskripsi

AoqMirrorModeDisabled

0

Menonaktifkan mirror

AoqMirrorModeEnabled

1

Mengaktifkan mirror

AoqOrientationMode

Mode orientasi.

Nilai enum

Nilai

Deskripsi

AoqOrientationModeAuto

0

Otomatis

AoqOrientationModePortrait

1

Portrait

AoqOrientationModeLandscape

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

isExternal

bool

false

Mode encoding eksternal. Saat true, Anda mendorong frame yang di-encode, dan SDK tidak melakukan capture atau encoding.

trackType

AoqTrackType

Video

Jenis track

codecType

AoqEncoderType

VideoH264

Format codec

width

int

540

Lebar resolusi

height

int

960

Tinggi resolusi

fps

int

5

Laju frame

bitrate

int

500000

Bitrate awal, dalam bit/s

minBitrate

int

128000

Bitrate minimum, dalam bit/s

keyframeInterval

int

2

Interval keyframe, dalam detik

mirrorMode

AoqMirrorMode

Disabled

Mode mirror

orientationMode

AoqOrientationMode

Auto

Mode orientasi

AoqVideoSource

Sumber data callback frame video (posisi dalam pipeline).

Nilai enum

Nilai

Deskripsi

AoqVideoSourceCaptured

0

Data video yang ditangkap sebelum preprocessing

AoqVideoSourcePreEncode

1

Data video sebelum encoding, setelah preprocessing

AoqVideoSourceRemote

2

Data video remote setelah decoding dan sebelum rendering

AoqVideoObserverMode

Mode callback frame video.

Nilai enum

Nilai

Deskripsi

AoqVideoObserverModeReadOnly

0

Read-only

AoqVideoObserverModeReadWrite

1

Read-write

AoqVideoObserverAlignment

Metode penyelarasan lebar untuk output video.

Nilai enum

Nilai

Deskripsi

AoqVideoObserverAlignmentDefault

0

Default

AoqVideoObserverAlignmentEven

1

Penyelarasan angka genap

AoqVideoObserverAlignment4

2

Penyelarasan 4-byte

AoqVideoObserverAlignment8

3

Penyelarasan 8-byte

AoqVideoObserverAlignment16

4

Penyelarasan 16-byte

AoqVideoObserverConfig

Pengaturan parameter untuk callback data video.

Field

Tipe

Nilai default

Deskripsi

format

AoqVideoPixelFormat

I420

Format piksel yang diharapkan dari data callback

alignment

AoqVideoObserverAlignment

Default

Kebijakan penyelarasan lebar

mode

AoqVideoObserverMode

ReadOnly

Mode callback. ReadWrite hanya didukung untuk I420.

mirrorApplied

bool

false

Menentukan apakah data callback dicerminkan