Skip to main content

Referensi API AOQ Client SDK Linux C++

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

AOQ SDK menyediakan API video umum. Qwen-Audio-Realtime tidak mendukung input atau output video. Untuk kemampuan media model lain, lihat dokumentasi aksesnya.

Indeks API

Siklus hidup engine

API

Deskripsi

createEngine

Membuat instans engine (metode statis, singleton)

destroy

Menghapus instans engine (metode statis)

getVersion

Mendapatkan versi SDK (metode statis)

connect

Menghubungkan ke server relay

disconnect

Memutus koneksi dari server

Manajemen perangkat audio

API

Deskripsi

startAudioCapture

Membuka perangkat capture audio (implementasi kosong pada Linux)

stopAudioCapture

Menutup perangkat capture audio (tidak berpengaruh pada Linux)

muteAudioCapture

Meredam atau membatalkan peredaman capture audio

startAudioPlayer

Memulai rendering audio (implementasi kosong pada Linux)

stopAudioPlayer

Menghentikan rendering audio (tidak berpengaruh pada Linux)

pauseAudioPlayer

Menjeda rendering audio, dengan dukungan fade-out

resumeAudioPlayer

Melanjutkan rendering audio, dengan dukungan fade-in

interruptAudioPlayer

Menginterupsi pemutaran audio saat ini

Konfigurasi codec audio

API

Deskripsi

setAudioEncoderConfig

Menetapkan parameter encoding audio

setAudioDecoderConfig

Menetapkan parameter decoding audio

Manajemen perangkat video

API

Deskripsi

startVideoCapture

Membuka perangkat capture video (hanya mode capture eksternal yang didukung di Linux)

stopVideoCapture

Menutup perangkat capture video

setLocalView

Menetapkan atau menghapus jendela rendering video lokal (tidak ada implementasi rendering di Linux)

setRemoteView

Menetapkan atau menghapus jendela rendering video remote (tidak ada implementasi rendering di Linux)

Codec video dan input eksternal

API

Deskripsi

setVideoEncoderConfig

Menetapkan parameter encoding video

setVideoDecoderConfig

Menetapkan parameter decoding video (proposal codec di sisi subscriber)

pushExternalVideoCapturedFrame

Mendorong frame video yang ditangkap secara eksternal

pushExternalVideoEncodedFrame

Mendorong frame video yang dikodekan 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

Mendaftarkan listener data frame audio (pure virtual)

enableAudioFrameObserver

Mengaktifkan atau menonaktifkan callback frame audio pada posisi tertentu (pure virtual)

Indikasi volume lokal

API

Deskripsi

enableLocalAudioVolumeIndication

Mengaktifkan atau menonaktifkan callback indikasi volume capture lokal

Callback bingkai video

API

Deskripsi

setVideoFrameObserver

Mendaftarkan listener data frame video (pure virtual)

enableVideoFrameObserver

Mengaktifkan atau menonaktifkan callback frame video pada posisi tertentu (pure virtual)

Callback AoqEngineEventListener

Callback

Deskripsi

onError

Callback kesalahan 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 (tidak dipicu di Linux)

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

Antarmuka listener data frame

API

Deskripsi

IAudioFrameObserver

Antarmuka untuk listening data frame audio (empat callback pure virtual)

IVideoFrameObserver

Antarmuka untuk listening data frame video (tiga callback pure virtual)

Detail API

Siklus hidup engine

createEngine

Membuat instans engine. SDK menyimpan engine sebagai singleton global, sehingga pemanggilan metode ini berikutnya akan mengembalikan instans yang sudah ada.
static AoqClientEngine* createEngine(const AoqCreateConfig& config,
                                    AoqEngineEventListener* listener);

Parameter

Tipe

Deskripsi

config

AoqCreateConfig

Konfigurasi pembuatan engine

listener

AoqEngineEventListener\*

Listener callback event engine, yang diimplementasikan oleh pemanggil melalui pewarisan

Mengembalikan: Pointer ke instans engine. nullptr dikembalikan jika gagal. Siklus hidup listener harus lebih lama daripada siklus hidup engine.

destroy

Menghapus instans engine dan melepaskan semua sumber daya.
static int destroy();
Mengembalikan: 0 menunjukkan keberhasilan; nilai non-0 menunjukkan kegagalan.

getVersion

Mendapatkan versi SDK saat ini.
static const char* getVersion();
Mengembalikan: String versi, yang disimpan oleh SDK.

connect

Menghubungkan ke server relay. Server aplikasi memperoleh parameter koneksi AOQ sementara berdasarkan protokol yang digunakan dan mengirimkannya ke klien. Untuk informasi selengkapnya, lihat Otentikasi token.
virtual int connect(const AoqConnectConfig& config);

Parameter

Type

Deskripsi

config

AoqConnectConfig

Konfigurasi koneksi, yang mencakup token, SID, array titik akses relay, serta array track publishing dan subscribing

Mengembalikan: 0 menunjukkan keberhasilan dan operasi berjalan secara asinkron; nilai non-0 menunjukkan kegagalan. Hasil koneksi diberitahukan melalui onConnectionStatusChange.
relayEndpoints / publishTracks / subscribeTracks semuanya merupakan struktur "pointer array gaya-C + panjang". Memori dipegang oleh pemanggil dan hanya perlu valid selama pemanggilan connect.

disconnect

Memutus koneksi dari server dan melepaskan sumber daya yang terkait dengan koneksi tersebut.
virtual int disconnect();
Mengembalikan: 0 menunjukkan keberhasilan; nilai non-0 menunjukkan kegagalan.

Manajemen perangkat audio

virtual int startAudioCapture(const AoqAudioCaptureConfig& config);
virtual int stopAudioCapture();
virtual int muteAudioCapture(bool mute);
virtual int startAudioPlayer(const AoqAudioPlaybackConfig& config);
virtual int stopAudioPlayer();
virtual int pauseAudioPlayer(int fadeMs);
virtual int resumeAudioPlayer(int fadeMs);
virtual int interruptAudioPlayer(AoqTrackType trackType, int fadeMs);

Parameter

Type

Deskripsi

config

AoqAudioCaptureConfig / AoqAudioPlaybackConfig

Konfigurasi capture dan playback

mute

bool

true meredam; false membatalkan peredaman

fadeMs

int

Durasi fade-out atau fade-in, dalam milidetik. 0 menunjukkan eksekusi langsung.

trackType

AoqTrackType

Jenis track

Batasan penting di Linux: startAudioCapture / startAudioPlayer memiliki implementasi kosong di build Linux (langsung mengembalikan 0 dan tidak membuka perangkat sound card apa pun), sedangkan stopAudioCapture / stopAudioPlayer tidak memiliki efek aktual karena status internal tidak diatur. Di Linux, gunakan aliran audio eksternal (2.8) untuk input audio dan callback frame audio (2.10) untuk memainkan output audio sendiri. Untuk informasi selengkapnya, lihat 4.3.

Konfigurasi codec audio

virtual int setAudioEncoderConfig(const AoqAudioCodecConfig& config);
virtual int setAudioDecoderConfig(const AoqAudioCodecConfig& config);
Kami menyarankan Anda memanggil metode ini sebelum connect(). Kombinasi laju sampel dan mode yang tidak valid akan memicu callback onError dengan AoqECParamInvalid selama proses connect.

Manajemen perangkat video

virtual int startVideoCapture(const AoqVideoCaptureConfig& config);
virtual int stopVideoCapture();
virtual int setLocalView(AoqTrackType trackType, const AoqVideoCanvas& canvas);
virtual int setRemoteView(AoqTrackType trackType, const AoqVideoCanvas& canvas);

Parameter

Tipe

Deskripsi

config

AoqVideoCaptureConfig

Konfigurasi capture video

trackType

AoqTrackType

Jenis track video

canvas

AoqVideoCanvas

Kanvas rendering. Jika canvas.view == nullptr, binding dihapus.

Batasan penting di Linux: Capture kamera di Linux merupakan implementasi placeholder dan tidak menghasilkan frame. Gunakan startVideoCapture({.isExternal = true}) bersama pushExternalVideoCapturedFrame untuk mengirimkan frame. setLocalView / setRemoteView tidak memiliki backend rendering di Linux (AoqVideoCanvas.view hanya mendukung Apple NSView* / Windows HWND / tampilan rendering Android). Untuk pratinjau, render sendiri melalui callback frame video (2.12). Untuk informasi selengkapnya, lihat 4.3.

Codec video dan input eksternal

virtual int setVideoEncoderConfig(const AoqVideoCodecConfig& config);
virtual int setVideoDecoderConfig(const AoqVideoCodecConfig& config);
virtual int pushExternalVideoCapturedFrame(AoqTrackType trackType, const AoqVideoFrame& frame);
virtual int pushExternalVideoEncodedFrame(AoqTrackType trackType, const AoqVideoEncodedFrame& frame);

Parameter

Tipe

Deskripsi

config

AoqVideoCodecConfig

Konfigurasi codec, yang dirutekan berdasarkan config.trackType

trackType

AoqTrackType

Target routing. Tetapkan ke AoqTrackTypeVideo.

frame

AoqVideoFrame / AoqVideoEncodedFrame

Data frame mentah atau frame yang telah dikodekan

Catatan:
  • setVideoDecoderConfig merupakan proposal codec untuk sisi subscriber dan harus dipanggil sebelum connect. Selama decoding, hanya trackType/codecType/width/height/fps/bitrate yang berlaku.
  • pushExternalVideoCapturedFrame memerlukan startVideoCapture(isExternal=true) terlebih dahulu. Metode ini mengembalikan AoqECVideoExternalCaptureNotEnabled(211) jika capture eksternal belum dimulai, AoqECParamInvalid jika format tidak didukung, dan AoqECVideoExternalBufferFull(210) jika buffer penuh.
  • pushExternalVideoEncodedFrame memerlukan setVideoEncoderConfig(isExternal=true) terlebih dahulu. SDK mengemas dan mengirim frame secara langsung tanpa re-encoding. Saat ini hanya JPEG yang didukung.
  • Jika frame.timeStamp bernilai 0, SDK akan mengisinya dengan waktu lokal.

Kontrol aliran media

virtual int enableSendMediaStream(AoqTrackType trackType, bool enable);
Menentukan apakah akan mengirim aliran media lokal tertentu. trackType dapat berupa AoqTrackTypeAudio atau AoqTrackTypeVideo. Nilai kembalian 0 menunjukkan bahwa panggilan telah dikirim dan berjalan secara asinkron. Disarankan untuk menonaktifkan pengiriman setelah inisialisasi dan hanya mengaktifkannya setelah onConnectionStatusChange melaporkan AoqConnectionStatusConnected.

Pemutaran file audio

virtual int startAudioFile(const char* fileId, const AoqAudioFileMixConfig& config);
virtual int stopAudioFile(const char* fileId);
virtual int pauseAudioFile(const char* fileId);
virtual int resumeAudioFile(const char* fileId);
virtual int64_t getAudioFileDuration(const char* fileId);
virtual int64_t getAudioFileCurrentPosition(const char* fileId);
virtual int setAudioFilePositionMillis(const char* fileId, int64_t positionMillis);
virtual int setAudioFileVolume(const char* fileId, AoqAudioStreamDirection type, int volume);
virtual int getAudioFileVolume(const char* fileId, AoqAudioStreamDirection type);

Parameter

Tipe

Deskripsi

fileId

const char\*

ID file audio. Lapisan bisnis harus memastikan keunikan global.

config

AoqAudioFileMixConfig

Konfigurasi pencampuran file

positionMillis

int64_t

Posisi pemutaran target, dalam milidetik

type

AoqAudioStreamDirection

Volume publikasi atau volume pemutaran lokal

volume

int

Volume. Nilai valid: 0 hingga 100.

Deskripsi nilai kembalian:
  • getAudioFileDuration / getAudioFileCurrentPosition: Nilai >=0 dalam milidetik; nilai <0 menunjukkan kegagalan, dan nilai absolutnya adalah -AoqErrorCode.
  • getAudioFileVolume: Nilai 0–100 menunjukkan volume; nilai <0 menunjukkan kegagalan, dan nilai absolutnya adalah -AoqErrorCode.
Perubahan status pemutaran dilaporkan melalui callback onAudioFileState. Pencampuran file menggunakan jalur publishing dan tidak bergantung pada sound card lokal. Oleh karena itu, di Linux, Anda dapat menggunakannya untuk mendorong file lokal sebagai sumber audio.

Aliran audio eksternal

virtual int addAudioExternalStream(const char* streamId, const AoqAudioExternalStreamConfig& config);
virtual int pushAudioExternalStreamData(const char* streamId, AoqAudioFrameData& data);
virtual int setAudioExternalStreamVolume(const char* streamId, AoqAudioStreamDirection type, int vol);
virtual int getAudioExternalStreamVolume(const char* streamId, AoqAudioStreamDirection type);
virtual void clearAudioExternalStreamBuffer(const char* streamId, int fadeoutMs);
virtual int removeAudioExternalStream(const char* streamId);

Parameter

Tipe

Deskripsi

streamId

const char\*

ID aliran audio eksternal. Lapisan bisnis harus memastikan keunikan global.

config

AoqAudioExternalStreamConfig

Konfigurasi aliran audio eksternal

data

AoqAudioFrameData

Data audio eksternal mentah (PCM), sebagai referensi non-const

type

AoqAudioStreamDirection

Volume publishing atau volume playback lokal

vol

int

Volume. Nilai valid: 0 hingga 100.

fadeoutMs

int

Durasi fade-out. -1 menggunakan fade-out default SDK, 0 mengosongkan buffer tanpa fade-out, dan nilai lebih besar dari 0 mempertahankan durasi fade-out yang ditentukan dalam milidetik.

Catatan:
  • Jika pushAudioExternalStreamData mengembalikan AoqECAudioExternalBufferFull(110), buffer internal SDK penuh. Disarankan untuk menunggu 20 ms lalu mengirim ulang frame data saat ini.
  • Praktik terbaik: Dalam skenario capture real-time, dorong data 10 ms sekaligus dan lakukan setiap kali data tersedia. Dalam skenario sumber file, dorong data 40 ms sekaligus setiap interval 30 ms, serta tangani nilai kembalian AoqECAudioExternalBufferFull.
  • getAudioExternalStreamVolume: Nilai 0–100 menunjukkan volume; nilai <0 menunjukkan kegagalan, dan nilai absolutnya adalah -AoqErrorCode.
  • clearAudioExternalStreamBuffer mengembalikan void dan tidak memiliki nilai kembalian.
  • data.pushSequence digunakan untuk notifikasi penyelesaian konsumsi SDK (putaran input PCM).
    Tidak ada perangkat capture nyata di Linux. Grup API ini merupakan jalur utama untuk uplink audio.

Pesan real-time

virtual int sendDataMsg(const AoqDataMsg& msg);
Mengirim pesan data real-time. msg.data menunjuk ke memori yang dipegang oleh pemanggil dan hanya perlu valid selama pemanggilan. Pesan dari peer dilaporkan melalui callback onDataMsg.

Callback frame audio

virtual int setAudioFrameObserver(IAudioFrameObserver* observer) = 0;
virtual int enableAudioFrameObserver(bool enabled, AoqAudioSource audioSource,
                                     const AoqAudioObserverConfig& config) = 0;

Parameter

Tipe

Deskripsi

observer

IAudioFrameObserver\*

Instans listener. Berikan nullptr untuk menghentikan callback.

enabled

bool

Menentukan apakah akan mengaktifkan callback data pada posisi ini

audioSource

AoqAudioSource

Posisi sumber data audio mentah

config

AoqAudioObserverConfig

Laju sampel callback, jumlah channel, dan mode baca-tulis

Penggunaan: Pertama, panggil setAudioFrameObserver(observer) untuk mendaftarkan listener. Kemudian, panggil enableAudioFrameObserver untuk setiap posisi yang dibutuhkan. Siklus hidup observer harus mencakup seluruh periode callback. Lepaskan observer hanya setelah pembatalan pendaftarannya. Dukungan mode baca-tulis (lihat deklarasi IAudioFrameObserver): onCapturedAudioFrame / onProcessCapturedAudioFrame / onPlaybackAudioFrame mendukung mode baca-tulis, sedangkan onPublishAudioFrame hanya mendukung mode read-only.
Di Linux, setAudioFrameObserver menyelesaikan pendaftaran melalui pengiriman asinkron (PostTask ke thread kontrol), sehingga callback mungkin berlaku sedikit setelah panggilan dikembalikan. Sebelum melepaskan observer, sisakan interval keamanan yang cukup atau pertahankan objek tetap aktif.

Indikasi volume lokal

virtual int enableLocalAudioVolumeIndication(const AoqAudioVolumeIndicationConfig& config);
Mengaktifkan atau menonaktifkan indikasi volume capture lokal. Jika config.interval <= 0, callback dinonaktifkan. Setelah diaktifkan, onLocalAudioVolumeIndication dipicu pada interval yang ditentukan oleh config.interval. Metode ini harus dipanggil setelah startAudioCapture untuk mendapatkan data volume.
Tidak ada capture perangkat di Linux. Data volume dalam callback ini berasal dari jalur pencampuran publishing/playback (mixer).

Callback frame video

virtual int setVideoFrameObserver(IVideoFrameObserver* observer) = 0;
virtual int enableVideoFrameObserver(bool enabled, AoqVideoSource videoSource,
                                     const AoqVideoObserverConfig& config) = 0;

Parameter

Tipe

Deskripsi

observer

IVideoFrameObserver\*

Instans listener. Berikan nullptr untuk menghentikan callback.

enabled

bool

Menentukan apakah akan mengaktifkan callback data pada posisi ini

videoSource

AoqVideoSource

Sumber data callback frame video (posisi dalam pipeline)

config

AoqVideoObserverConfig

Format piksel yang diharapkan, kebijakan penyelarasan, mode baca-tulis, dan pencerminan

Jika callback mengembalikan true, data dimodifikasi dan harus ditulis kembali ke SDK. Ini hanya berlaku untuk I420 / CVPixelBuffer, yang berarti hanya I420 di Linux. Jika callback mengembalikan false, data bersifat read-only.
Linux tidak memiliki rendering bawaan. Grup callback ini merupakan satu-satunya cara untuk mendapatkan gambar video remote (AoqVideoSourceRemote).

Callback AoqEngineEventListener

AoqEngineEventListener merupakan titik masuk terpadu untuk semua notifikasi event asinkron dari SDK. Anda harus mewarisi dan mengimplementasikannya, lalu meneruskannya saat memanggil createEngine.
Perbedaan utama dari Android: Semua callback dalam kelas ini adalah fungsi virtual murni (= 0) tanpa implementasi kosong default. Di Linux, Anda harus sepenuhnya mengimplementasikan 10 metode berikut; jika tidak, kelas turunan tidak dapat diinstansiasi. Callback dapat dipicu pada thread internal SDK.
class AOQ_API AoqEngineEventListener {
public:
    AoqEngineEventListener();
    virtual ~AoqEngineEventListener();

    virtual void onError(int code, const char* message) = 0;
    virtual void onWarning(int code, const char* message) = 0;
    virtual void onConnectionStatusChange(AoqConnectionStatus status) = 0;
    virtual void onStats(const AoqStats& stats) = 0;
    virtual void onAudioDeviceStateChanged(const AoqAudioDeviceState& state) = 0;
    virtual void onAudioDeviceRouteChanged(int routeType) = 0;
    virtual void onAudioFileState(const AoqAudioFileState& state) = 0;
    virtual void onLocalAudioVolumeIndication(const AoqAudioVolume& volume) = 0;
    virtual void onVideoDeviceStateChanged(const AoqVideoDeviceState& state) = 0;
    virtual void onDataMsg(const AoqDataMsg& msg) = 0;
};

onError

Callback error engine. code sesuai dengan nilai enum AoqErrorCode (lihat 3.3), dan message hanya valid selama callback.

onWarning

Callback peringatan engine. code sesuai dengan nilai enum AoqWarningCode (lihat 3.3).

onConnectionStatusChange

Callback perubahan status koneksi. Transisi status: Disconnected → Connecting → Connected / Failed → Disconnected.

onStats

Callback statistik engine. SDK secara berkala melaporkan statistik publishing dan subscribing untuk audio dan video serta statistik jaringan, yang dapat digunakan untuk memantau kualitas panggilan dan status jaringan secara real-time serta mendiagnosis masalah audio dan video.

Parameter

Tipe

Deskripsi

stats

AoqStats

Statistik publishing dan subscribing serta statistik jaringan untuk audio, video, dan pesan data

AoqStats secara internal menggunakan struktur "pointer array + jumlah". Pointer hanya valid selama callback, sehingga Anda harus menyalin datanya sendiri untuk penggunaan asinkron.

onAudioDeviceStateChanged

Callback untuk perubahan status operasi capture dan playback perangkat audio. state.reason merupakan nilai AoqErrorCode.

onAudioDeviceRouteChanged

Callback perubahan rute output audio. routeType sesuai dengan nilai enum AoqAudioDeviceRouteType (lihat 3.4).
Tidak dipicu di Linux: Build Linux tidak menyertakan listener perangkat platform (AOQ_HAS_NATIVE_DEVICE_MONITOR hanya didefinisikan di Windows / macOS), dan perangkat audio sisi server tidak menghasilkan event rute. Anda tetap harus mengimplementasikan metode ini (pure virtual), tetapi implementasinya bisa kosong.

onAudioFileState

Callback untuk status pemutaran file audio. state.fileId hanya valid selama callback.

onLocalAudioVolumeIndication

Callback indikasi volume capture lokal. Untuk mengaktifkannya, panggil enableLocalAudioVolumeIndication.

onVideoDeviceStateChanged

Callback untuk perubahan status operasi capture perangkat video. state.reason merupakan nilai AoqErrorCode.

onDataMsg

Callback untuk pesan data real-time yang diterima. msg.datadijamin hanya valid selama callback. Jika Anda perlu menggunakannya secara asinkron, salin sendiri.

Antarmuka listener data frame

IAudioFrameObserver

Antarmuka untuk listening data audio. Jangan melakukan operasi yang memakan waktu dalam callback. Jika tidak, anomali audio dapat terjadi. Semua metode merupakan fungsi virtual murni dan harus diimplementasikan sepenuhnya.
class AOQ_API IAudioFrameObserver {
public:
    virtual ~IAudioFrameObserver() {}
    virtual void onCapturedAudioFrame(const AoqAudioFrameData& data) = 0;
    virtual void onProcessCapturedAudioFrame(const AoqAudioFrameData& data) = 0;
    virtual void onPublishAudioFrame(AoqTrackType trackType, const AoqAudioFrameData& data) = 0;
    virtual void onPlaybackAudioFrame(const AoqAudioFrameData& data) = 0;
};

Callback

Cara mengaktifkannya (audioSource)

Mode baca-tulis

onCapturedAudioFrame

AoqAudioSourceCaptured

Didukung baca-tulis

onProcessCapturedAudioFrame

AoqAudioSourceProcessCaptured

Didukung baca-tulis

onPublishAudioFrame

AoqAudioSourcePublish (memerlukan connect yang berhasil)

Hanya didukung read-only

onPlaybackAudioFrame

AoqAudioSourcePlayback

Didukung baca-tulis

Semua callback di atas mendukung pengaturan laju sampel dan jumlah channel menggunakan AoqAudioObserverConfig.
Di Linux, onPlaybackAudioFrame merupakan jalur utama untuk mendapatkan PCM downlink remote. Karena modul 3A tidak dikompilasi di Linux, data dari onProcessCapturedAudioFrame (data setelah pemrosesan 3A) pada dasarnya sama dengan data capture mentah. Untuk informasi selengkapnya, lihat 4.3.

IVideoFrameObserver

Antarmuka untuk listening data video. Jangan melakukan operasi yang memakan waktu dalam callback. Jika tidak, video dapat tersendat. Semua metode merupakan fungsi virtual murni.
class AOQ_API IVideoFrameObserver {
public:
    virtual ~IVideoFrameObserver() {}
    virtual bool onCapturedVideoFrame(AoqVideoFrame& frame) = 0;
    virtual bool onPreEncodeVideoFrame(AoqTrackType trackType, AoqVideoFrame& frame) = 0;
    virtual bool onRemoteVideoFrame(AoqTrackType trackType, AoqVideoFrame& frame) = 0;
};

Callback

Cara mengaktifkannya (videoSource)

Deskripsi

onCapturedVideoFrame

AoqVideoSourceCaptured

Data mentah lokal setelah capture, sebelum preprocessing

onPreEncodeVideoFrame

AoqVideoSourcePreEncode

Data mentah lokal sebelum encoding, setelah preprocessing

onRemoteVideoFrame

AoqVideoSourceRemote

Data mentah remote setelah decoding dan sebelum rendering

Mengembalikan: true menunjukkan bahwa data dimodifikasi dan harus ditulis kembali ke SDK, yang hanya berlaku untuk I420 / CVPixelBuffer; false menunjukkan read-only. Pointer dalam frame hanya valid selama callback. Untuk penggunaan asinkron, salin sendiri.

Tipe data dan enumerasi

Semua tipe didefinisikan dalam AoqClientEngine.h di namespace AoqClientSdk. Semua struktur merupakan tipe POD dengan nilai default, sehingga Anda mendapatkan nilai default dalam tabel hanya dengan mendeklarasikannya. Field yang ditandai sebagai mobile-only dikecualikan oleh kompilasi kondisional di Linux dan tidak ada dalam struktur.

Tipe umum

AoqCreateConfig

Field

Tipe

Nilai default

Deskripsi

workDir

const char\*

nullptr

Direktori kerja SDK (untuk log dan file sementara)

enableDumpAudio

bool

false

Menentukan apakah akan menyimpan data audio (untuk debugging)

extras

const char\*

nullptr

Parameter tambahan (string JSON)

Field string harus tetap valid setidaknya hingga createEngine dikembalikan. Engine menyalinnya secara internal sesuai kebutuhan. Field isBTScoMode di Android merupakan field mobile-only dan tidak ada di Linux.

AoqConnectConfig

Field

Tipe

Nilai default

Deskripsi

token

const char\*

nullptr

Token otentikasi koneksi

sid

const char\*

nullptr

ID sesi

certFingerprint

const char\*

nullptr

Sidik jari sertifikat server

workspaceIdHash

const char\*

nullptr

Hash ID ruang kerja

relayEndpoints

const AoqRelayEndpoint\*

nullptr

Alamat awal array titik akses relay

relayEndpointsCount

size_t

0

Jumlah titik akses relay

publishTracks

const AoqTrackParam\*

nullptr

Alamat awal array atribut track publishing

publishTracksCount

size_t

0

Jumlah track publishing

subscribeTracks

const AoqTrackParam\*

nullptr

Alamat awal array atribut track subscribing

subscribeTracksCount

size_t

0

Jumlah Track yang Berlangganan

AoqRelayEndpoint

Field

Tipe

Nilai default

Deskripsi

route_index

int

-1

Indeks rute

endpoint

const char\*

nullptr

Nama domain atau alamat IP server relay

port

int

0

Port server relay

Perhatikan bahwa nama field route_index menggunakan snake case, berbeda dengan camel case yang digunakan oleh field lainnya.

AoqTrackParam

Field

Type

Nilai default

Deskripsi

trackType

AoqTrackType

AoqTrackTypeAudio

Jenis track

trackMode

AoqTrackMode

AoqTrackModeSegment

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

AoqDataMsg

Field

Tipe

Nilai default

Deskripsi

data

const uint8_t\*

nullptr

Isi pesan. Menunjuk ke memori yang dipegang oleh pemanggil.

dataSize

size_t

0

Jumlah byte

Ketika data digunakan dalam callback, data tersebut dijamin hanya valid selama callback. Untuk penggunaan asinkron, salin datanya sendiri.

Tipe statistik

AoqStats

Rangkuman statistik engine, yang dilaporkan secara berkala melalui onStats. Menggunakan struktur "pointer array + jumlah", di mana semua pointer default ke nullptr dan semua jumlah default ke 0.

Field

Tipe

Deskripsi

audioPublishStats

const AoqAudioPublishStats\*

Array statistik publishing untuk audio

audioPublishStatsCount

unsigned int

Jumlah entri statistik publishing untuk audio

videoPublishStats

const AoqVideoPublishStats\*

Array statistik publishing untuk video

videoPublishStatsCount

unsigned int

Jumlah entri statistik publishing untuk video

dataMsgPublishStats

const AoqDataMsgPublishStats\*

Array statistik publishing untuk pesan data

dataMsgPublishStatsCount

unsigned int

Jumlah entri statistik publishing untuk pesan data

audioSubscribeStats

const AoqAudioSubscribeStats\*

Array statistik subscribing untuk audio

audioSubscribeStatsCount

unsigned int

Jumlah entri statistik subscribing untuk audio

videoSubscribeStats

const AoqVideoSubscribeStats\*

Array statistik subscribing untuk video

videoSubscribeStatsCount

unsigned int

Jumlah entri statistik subscribing untuk video

dataMsgSubscribeStats

const AoqDataMsgSubscribeStats\*

Array statistik subscribing untuk pesan data

dataMsgSubscribeStatsCount

unsigned int

Jumlah entri statistik subscribing untuk pesan data

networkStats

const AoqNetworkStats\*

Statistik jaringan

AoqAudioPublishStats

Field

Tipe

Nilai default

Deskripsi

trackType

AoqTrackType

AoqTrackTypeAudio

Jenis track

bitrate

unsigned int

0

Bitrate, dalam bit/s

bytes

uint64_t

0

Byte kumulatif yang dikirim

encodeVolume

unsigned int

0

Volume encoding aliran publishing

AoqAudioSubscribeStats

Field

Tipe

Nilai default

Deskripsi

trackType

AoqTrackType

AoqTrackTypeAudio

Jenis track

bitrate

unsigned int

0

Bitrate, dalam bit/s

bytes

uint64_t

0

Byte kumulatif yang diterima

playVolume

unsigned int

0

Volume playback

AoqVideoPublishStats

Field

Tipe

Nilai default

Deskripsi

trackType

AoqTrackType

AoqTrackTypeVideo

Jenis track

bitrate

unsigned int

0

Bitrate, dalam bit/s

bytes

uint64_t

0

Byte kumulatif yang dikirim

encodeFps

unsigned int

0

Laju frame encoding

AoqVideoSubscribeStats

Field

Tipe

Nilai default

Deskripsi

trackType

AoqTrackType

AoqTrackTypeVideo

Jenis track

bitrate

unsigned int

0

Bitrate, dalam bit/s

bytes

uint64_t

0

Byte kumulatif yang diterima

decodeFps

unsigned int

0

Laju frame decoding

renderFps

unsigned int

0

Laju frame rendering

AoqDataMsgPublishStats / AoqDataMsgSubscribeStats

Field

Type

Nilai default

Deskripsi

trackType

AoqTrackType

AoqTrackTypeData

Jenis track

bitrate

unsigned int

0

Bitrate, dalam bit/s

bytes

uint64_t

0

Byte kumulatif yang dikirim dan diterima

AoqNetworkStats

Field

Tipe

Nilai default

Deskripsi

sendBitrate

unsigned int

0

Bitrate pengiriman, dalam bit/s

sendBytes

uint64_t

0

Byte kumulatif yang dikirim

recvBitrate

unsigned int

0

Bitrate penerimaan, dalam bit/s

recvBytes

uint64_t

0

Byte kumulatif yang diterima

loss

unsigned int

0

Laju kehilangan paket, dari 0 hingga 100

rtt

unsigned int

0

Latensi round-trip, dalam ms

Enumerasi

AoqTrackType

Nilai enum

Nilai

Deskripsi

AoqTrackTypeAudio

0

Track audio

AoqTrackTypeVideo

1

Track video

AoqTrackTypeData

2

Track pesan data

AoqTrackMode

Nilai enum

Nilai

Deskripsi

AoqTrackModeSegment

0

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

AoqTrackModeStream

1

Streaming: data dikirim secara kontinu.

AoqEncoderType

Nilai enum

Nilai

Deskripsi

AoqEncoderTypeUnknown

0

Format tidak diketahui

AoqEncoderTypeAudioPCM

1

Audio PCM

AoqEncoderTypeAudioOpus

2

Audio Opus (berbasis plugin; dibangun secara statis ke Linux dan tersedia langsung)

AoqEncoderTypeVideoH264

3

Video H.264

AoqEncoderTypeVideoJpeg

4

Video JPEG

AoqEncoderTypeDataText

5

Teks pesan

AoqConnectionStatus

Nilai enum

Nilai

Deskripsi

AoqConnectionStatusDisconnected

0

Terputus

AoqConnectionStatusConnecting

1

Menghubungkan

AoqConnectionStatusConnected

2

Tersambung

AoqConnectionStatusFailed

3

Koneksi gagal

AoqErrorCode

Catatan penamaan: Dalam header C++, literal enum menggunakan bentuk singkat AoqEC* (berbeda dengan bentuk lengkap AoqErrorCode* di Android), tetapi nilainya identik.

Nilai enum

Nilai

Deskripsi

AoqECOK

0

Berhasil

AoqECParamInvalid

1

Parameter tidak valid

AoqECStateInvalid

2

Status tidak valid

AoqECUnSupport

3

API dipanggil tetapi tidak diimplementasikan di platform atau 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

Gagal memulai perekaman di latar belakang

AoqECAudioDeviceRecordingStartFail

124

Gagal memulai perekaman

AoqECAudioDevicePlayoutOccupied

125

Perangkat pemutaran sedang digunakan

AoqECAudioDevicePlayoutBackgroundStart

126

Gagal memulai pemutaran di latar belakang

AoqECAudioDevicePlayoutStartFail

127

Gagal memulai pemutaran

AoqECAudioDeviceEarpieceRequiresVoipMode

128

Receiver memerlukan mode VoIP (skenario mobile)

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

Exception runtime kamera

AoqECVideoCodec

230

Error codec video umum

AoqECVideoCodecEncoderInitFail

231

Gagal menginisialisasi encoder video

AoqECVideoRender

240

Error rendering video umum

AoqECVideoRenderCreateFail

241

Gagal membuat rendering video

AoqECVideoRenderDrawError

242

Error penggambaran rendering video

AoqWarningCode

Nilai enum

Nilai

Deskripsi

AoqWCOK

0

Tidak ada peringatan

AoqWCAudio

100

Peringatan audio umum

AoqWCAudioHowling

101

Deteksi howling audio

AoqWCAudioDevice

120

Peringatan perangkat audio umum

AoqWCAudioDeviceMicEnumerateError

121

Error enumerasi mikrofon

AoqWCAudioDeviceMicStartTimeout

122

Waktu startup mikrofon habis

AoqWCAudioDeviceRecordingError

123

Error selama perekaman

AoqWCAudioDeviceSpeakerEnumerateError

124

Error enumerasi speaker

AoqWCAudioDeviceSpeakerStartTimeout

125

Waktu startup speaker habis

AoqWCAudioDevicePlayoutError

126

Error selama pemutaran

AoqWCVideo

200

Peringatan video umum

AoqWCVideoCameraEnumerateError

201

Error enumerasi kamera

AoqWCVideoEncoderSwitched

202

Encoder video dialihkan

AoqWCVideoRenderDowngrade

203

Rendering video diturunkan

AoqMirrorMode

Nilai enum

Nilai

Deskripsi

AoqMirrorModeDisabled

0

Menonaktifkan pencerminan

AoqMirrorModeEnabled

1

Mengaktifkan pencerminan

AoqOrientationMode

Nilai enum

Nilai

Deskripsi

AoqOrientationModeAuto

0

Auto-fit

AoqOrientationModePortrait

1

Portrait

AoqOrientationModeLandscape

2

Landscape

AoqRenderMode

Nilai enum

Nilai

Deskripsi

AoqRenderModeAuto

0

Mode adaptif

AoqRenderModeStretch

1

Stretch Mode

AoqRenderModeFill

2

Mode fill

AoqRenderModeCrop

3

Mode crop

Ini hanya digunakan sebagai AoqVideoCanvas.renderMode. Linux tidak memiliki implementasi rendering, sehingga enumerasi ini tidak benar-benar berlaku.

AoqAudioStreamDirection

Nilai enum

Nilai

Deskripsi

AoqAudioStreamPublish

0

Penerbitan audio

AoqAudioStreamPlayout

1

Audio playback

AoqAudioExternalStreamToggle

Nilai enum

Nilai

Deskripsi

AoqAudioExternalStreamToggleNormal

0

Pulih

AoqAudioExternalStreamTogglePause

1

Dijeda

Enumerasi ini dideklarasikan dalam header, tetapi tidak ada API publik yang saat ini menggunakannya. Ini merupakan definisi cadangan.

Tipe audio

AoqAudioCaptureConfig

Field

Tipe

Nilai default

Deskripsi

isExternal

bool

false

Menentukan apakah akan menggunakan capture eksternal

channel

int

1

Jumlah channel capture audio. Didukung 1 dan 2.

isVoipMode merupakan field mobile-only dan tidak ada di Linux.

AoqAudioPlaybackConfig

Field

Tipe

Nilai default

Deskripsi

isExternal

bool

false

Menentukan apakah akan menggunakan playback eksternal

channel

int

1

Jumlah channel playback audio. Didukung 1 dan 2.

isVoipMode / isDefaultSpeaker merupakan field mobile-only dan tidak ada di Linux.

AoqAudioCodecConfig

Field

Tipe

Nilai default

Deskripsi

trackType

AoqTrackType

AoqTrackTypeAudio

Jenis track

codecType

AoqEncoderType

AoqEncoderTypeAudioPCM

Jenis encoding

sampleRate

int

48000

Laju sampel, dalam Hz

channel

int

1

Jumlah channel. Didukung 1 dan 2.

bitrate

int

32000

Bitrate, dalam bit/s

Batasan laju sampel (diambil dari komentar dalam file header):
  • Encoding: Opus mendukung 8 / 16 / 48K, dan PCM mendukung 8 / 16 / 32 / 48K;
  • Decoding: 24K juga didukung, tetapi 24K terbatas pada mode Segment (mode Stream tidak mendukung 24K);
  • Kombinasi yang tidak valid memicu callback onError dengan AoqECParamInvalid selama connect.

AoqAudioDeviceRouteType

Nilai enum

Nilai

Deskripsi

AoqAudioDeviceRouteDefault

0

Rute default

AoqAudioDeviceRouteHeadset

1

Headphone

AoqAudioDeviceRouteEarpiece

2

Receiver

AoqAudioDeviceRouteHeadsetNoMic

3

Headphone tanpa mikrofon

AoqAudioDeviceRouteSpeakerPhone

4

Speaker bawaan

AoqAudioDeviceRouteUsb

5

Perangkat audio USB

AoqAudioDeviceRouteBluetooth

6

Bluetooth

AoqAudioDeviceRouteBluetoothA2dp

7

Bluetooth A2DP

Ini hanya referensi untuk nilai routeType dari onAudioDeviceRouteChanged. Linux tidak memicu callback ini.

AoqAudioDeviceStateCode

Nilai enum

Nilai

Deskripsi

AoqAudioDeviceNone

0

Tidak ada status

AoqAudioDeviceRecordStarting

1

Capture dimulai

AoqAudioDeviceRecordStarted

2

Capture dimulai

AoqAudioDeviceRecordStopping

3

Capture dihentikan

AoqAudioDeviceRecordStopped

4

Capture dihentikan

AoqAudioDeviceRecordFail

5

Capture gagal

AoqAudioDevicePlayStarting

6

Playback dimulai

AoqAudioDevicePlayStarted

7

Playback dimulai

AoqAudioDevicePlayStopping

8

Playback dihentikan

AoqAudioDevicePlayStopped

9

Playback dihentikan

AoqAudioDevicePlayFail

10

Playback gagal

AoqAudioDeviceState

Field

Tipe

Nilai default

Deskripsi

state

AoqAudioDeviceStateCode

AoqAudioDeviceNone

Status operasi perangkat

reason

int

0

Kode alasan error. Lihat AoqErrorCode.

AoqAudioFrameData

Data audio mentah. Digunakan baik untuk memberikan aliran eksternal melalui pushAudioExternalStreamData maupun callback IAudioFrameObserver.

Field

Tipe

Nilai default

Deskripsi

dataPtr

void\*

0

Pointer ke data PCM audio

numOfSamples

int

0

Jumlah sampel (per channel)

bytesPerSample

int

0

Byte per sampel

numOfChannels

int

0

Jumlah channel

samplesPerSec

int

0

Jumlah sampel per detik (laju sampel)

pushSequence

int

0

Putaran input PCM (digunakan untuk notifikasi penyelesaian konsumsi stream)

timeStamp

int64_t

0

Timestamp

dataSize

int

0

Panjang data, dalam byte

autoGenMute

bool

false

Hanya berlaku dalam callback. true menunjukkan data senyap yang dihasilkan oleh SDK.

AoqAudioSource

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 koneksi yang berhasil)

AoqAudioSourcePlayback

3

Data audio yang akan diputar

AoqAudioSourceMax

4

Placeholder, jangan digunakan

AoqAudioObserverMode

Nilai enum

Nilai

Deskripsi

AoqAudioObserverModeReadOnly

0

Mode read-only

AoqAudioObserverModeReadWrite

1

Mode baca-tulis

AoqAudioObserverConfig

Field

Tipe

Nilai default

Deskripsi

sampleRate

int

48000

Laju sampel audio callback, dalam Hz. Resampling dilakukan jika laju tidak sesuai dengan sumber.

channels

int

1

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

mode

AoqAudioObserverMode

AoqAudioObserverModeReadOnly

Mode callback

Laju sampel yang didukung: 8, 12, 16, 24, 32, 44.1, 48, 64, 88.2, 96, 176.4, dan 192K.

AoqAudioVolumeIndicationConfig

Field

Tipe

Nilai default

Deskripsi

interval

int

0

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

smooth

int

3

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

AoqAudioVolume

Field

Type

Nilai default

Deskripsi

volume

int

0

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

Tipe file audio dan aliran audio eksternal

AoqAudioFileMixConfig

Field

Type

Nilai default

Deskripsi

fileName

const char\*

nullptr

Nama file (termasuk path)

cycles

int

-1

Jumlah loop. -1 menunjukkan looping tanpa batas.

startPosMs

long

0

Posisi mulai pemutaran, dalam milidetik

publishVolume

int

100

Volume publishing. Nilai valid: 0 hingga 100.

playoutVolume

int

100

Volume playback. Nilai valid: 0 hingga 100.

fileId bukan bagian dari badan konfigurasi dan diteruskan sebagai parameter terpisah ke startAudioFile.

AoqAudioFileStateCode

Nilai enum

Nilai

Deskripsi

AoqAudioFileNone

0

Tidak ada status

AoqAudioFileStarted

1

Dimulai

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

Nilai enum

Nilai

Deskripsi

AoqAudioFileNoError

0

Tidak ada error

AoqAudioFileOpenFailed

1

Gagal membuka file

AoqAudioFileDecodeFailed

2

Gagal mendekode file

AoqAudioFileState

Field

Tipe

Nilai default

Deskripsi

fileId

const char\*

nullptr

ID file. Hanya valid selama callback.

stateCode

AoqAudioFileStateCode

AoqAudioFileNone

Kode status file

errorCode

AoqAudioFileErrorCode

AoqAudioFileNoError

Kode error file

AoqAudioExternalStreamConfig

Field

Tipe

Nilai default

Deskripsi

trackType

AoqTrackType

AoqTrackTypeAudio

Jenis track audio

codecType

AoqEncoderType

AoqEncoderTypeAudioPCM

Format aliran audio. PCM didukung.

channels

int

1

Jumlah channel. Dibatasi oleh codec audio dari aliran publishing (didukung 1 dan 2, channel tambahan diabaikan).

sampleRate

int

48000

Laju sampel, dalam Hz

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 milidetik (yaitu 10 menit). Nilai valid: 100 ke atas. Jika durasi melebihi nilai ini, Push gagal.

enable3A

bool

false

Terapkan pemrosesan 3A ke input PCM (tidak berlaku di Linux, lihat 4.3)

Laju sampel yang didukung: 8, 12, 16, 24, 32, 44.1, 48, 64, 88.2, 96, 176.4, dan 192K.
streamId bukan bagian dari badan konfigurasi dan diteruskan sebagai parameter terpisah ke addAudioExternalStream.

Tipe video

AoqVideoCanvas

Field

Tipe

Nilai default

Deskripsi

view

void\*

nullptr

Pointer opaque ke handle view native platform. Berikan nullptr untuk menghapus binding.

renderMode

AoqRenderMode

AoqRenderModeAuto

Mode fill rendering

Makna platform untuk view: NSView* di Apple, HWND di Windows, dan objek adaptor tampilan rendering internal SDK di Android. Anda harus memastikan bahwa siklus hidup view lebih lama daripada periode saat diatur oleh setLocalView / setRemoteView.
Tidak ada implementasi platform yang sesuai di Linux. Struktur ini tidak memiliki kegunaan praktis di Linux.

AoqVideoCaptureConfig

Field

Tipe

Nilai default

Deskripsi

width

int

1280

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

height

int

720

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

fps

int

15

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

isExternal

bool

false

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

cameraDirection merupakan field mobile-only dan tidak ada di platform desktop (termasuk Linux). Di Linux, disarankan untuk selalu mengatur isExternal = true.

AoqVideoCodecConfig

Encoding dan decoding menggunakan struktur yang sama. Untuk decoding, hanya trackType / codecType / width / height / fps / bitrate yang berlaku dan berpartisipasi dalam negosiasi sebagai proposal subscription. minBitrate / keyframeInterval / mirrorMode / orientationMode / isExternal hanya digunakan untuk encoding.

Field

Tipe

Nilai default

Deskripsi

isExternal

bool

false

Mode encoding eksternal. Ketika true, Anda mendorong frame yang telah dikodekan, dan SDK tidak melakukan capture atau encoding.

trackType

AoqTrackType

AoqTrackTypeVideo

Jenis track

codecType

AoqEncoderType

AoqEncoderTypeVideoH264

Jenis encoding

width

int

540

Lebar resolusi, dalam piksel

height

int

960

Tinggi resolusi, dalam piksel

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

AoqMirrorModeDisabled

Mode pencerminan

orientationMode

AoqOrientationMode

AoqOrientationModeAuto

Mode orientasi

AoqVideoPixelFormat

Nilai enum

Nilai

Deskripsi

Didukung di Linux

AoqVideoPixelFormatUnknown

0

Format tidak diketahui

-

AoqVideoPixelFormatI420

1

I420 (format planar YUV)

Didukung

AoqVideoPixelFormatNV12

2

NV12 (format semi-planar YUV)

Didukung

AoqVideoPixelFormatNV21

3

NV21 (format semi-planar YUV)

Didukung

AoqVideoPixelFormatBGRA

4

BGRA (32-bit)

Didukung

AoqVideoPixelFormatRGBA

5

RGBA (32-bit)

Didukung

AoqVideoPixelFormatCVPixelBuffer

6

Hanya berlaku di platform Apple

Tidak didukung

AoqVideoPixelFormatTextureOES

7

Texture OES eksternal Android

Tidak didukung

AoqVideoPixelFormatTexture2D

8

Texture 2D reguler Android

Tidak didukung

Nilai enum 6/7/8 masih terlihat dalam file header (tidak dikecualikan oleh kompilasi kondisional), tetapi Linux tidak memiliki kemampuan platform yang sesuai. Jika Anda memberikannya, mereka dianggap sebagai format yang tidak didukung.

AoqVideoFrame

Frame video mentah eksternal. Digunakan baik untuk pushExternalVideoCapturedFrame maupun callback IVideoFrameObserver.

Field

Tipe

Nilai default

Deskripsi

format

AoqVideoPixelFormat

AoqVideoPixelFormatUnknown

Format piksel

width

int

0

Lebar, dalam piksel

height

int

0

Tinggi, dalam piksel

dataPtr

void\*

0

Data format terpaket (NV12 / NV21 / BGRA / RGBA)

dataSize

int

0

Jumlah byte data terpaket

dataY

void\*

0

Bidang Y I420

dataU

void\*

0

Bidang U I420

dataV

void\*

0

Bidang V I420

strideY

int

0

Stride bidang Y

strideU

int

0

Stride bidang U

strideV

int

0

Stride bidang V

nativePixelBuffer

void\*

0

Digunakan untuk zero-copy Apple (CVPixelBufferRef). Field ini tidak digunakan di Linux.

textureId

int

0

ID texture Android. Field ini tidak digunakan di Linux.

transformMatrix

float array (16 elemen)

Semua nol

Matriks transformasi texture (row-major 4x4). Field ini tidak digunakan di Linux.

timeStamp

int64_t

0

Timestamp, dalam milidetik. Jika bernilai 0, SDK akan mengisinya dengan waktu lokal.

AoqVideoCodecType

Nilai enum

Nilai

Deskripsi

AoqVideoCodecTypeJPEG

0

Encoding JPEG

AoqVideoEncodedFrame

Frame video yang telah dikodekan secara eksternal. Pemanggil melakukan encoding, dan SDK mengemas serta mengirim frame langsung tanpa re-encoding.

Field

Tipe

Nilai default

Deskripsi

codec

AoqVideoCodecType

AoqVideoCodecTypeJPEG

Format codec

data

void\*

nullptr

Pointer ke data yang telah dikodekan

dataSize

int

0

Jumlah byte data yang telah dikodekan

width

int

0

Lebar, dalam piksel

height

int

0

Tinggi, dalam piksel

timeStamp

int64_t

0

Timestamp, dalam milidetik. Jika bernilai 0, SDK akan mengisinya dengan waktu lokal.

AoqVideoDeviceStateCode

Nilai enum

Nilai

Deskripsi

AoqVideoDeviceNone

0

Tidak ada status

AoqVideoDeviceCaptureStarting

1

Kamera dimulai

AoqVideoDeviceCaptureStarted

2

Kamera dimulai

AoqVideoDeviceCaptureStopping

3

Kamera dihentikan

AoqVideoDeviceCaptureStopped

4

Kamera dihentikan

AoqVideoDeviceCaptureFail

5

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

AoqVideoDeviceState

Field

Tipe

Nilai default

Deskripsi

state

AoqVideoDeviceStateCode

AoqVideoDeviceNone

Status operasi capture perangkat

reason

int

0

Kode alasan error. Lihat AoqErrorCode.

AoqVideoSource

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

AoqVideoSourceMax

3

Placeholder, jangan gunakan

AoqVideoObserverMode

Nilai enum

Nilai

Deskripsi

AoqVideoObserverModeReadOnly

0

Mode read-only

AoqVideoObserverModeReadWrite

1

Mode baca-tulis (hanya didukung untuk I420 / CVPixelBuffer)

AoqVideoObserverAlignment

Nilai enum

Nilai

Deskripsi

AoqVideoObserverAlignmentDefault

0

Penyelarasan default

AoqVideoObserverAlignmentEven

1

Penyelarasan angka genap

AoqVideoObserverAlignment4

2

Penyelarasan 4-byte

AoqVideoObserverAlignment8

3

Penyelarasan 8-byte

AoqVideoObserverAlignment16

4

Penyelarasan 16-byte

AoqVideoObserverConfig

Field

Tipe

Nilai default

Deskripsi

format

AoqVideoPixelFormat

AoqVideoPixelFormatI420

Format piksel yang diharapkan dari data callback

alignment

AoqVideoObserverAlignment

AoqVideoObserverAlignmentDefault

Kebijakan penyelarasan lebar

mode

AoqVideoObserverMode

AoqVideoObserverModeReadOnly

Mode callback. ReadWrite hanya didukung untuk I420 / CVPixelBuffer.

mirrorApplied

bool

false

Menentukan apakah akan mencerminkan data callback