Skip to main content

Referensi API AOQ Client SDK Electron

Topik ini menjelaskan API TypeScript, event, dan tipe data AOQ Client SDK untuk Electron. SDK mendukung macOS x64/arm64 dan Windows x64 serta memerlukan Node.js 16 atau lebih baru.

AOQ SDK menyediakan API video umum. Qwen-Audio-Realtime tidak mendukung input atau output video. Untuk kemampuan media model lain, lihat dokumentasi aksesnya.
Paket yang berlaku: aoq-electron-sdk (npm). Platform yang didukung: macOS (x64 / arm64) dan Windows x64. Node.js >= 16.

Indeks API

Entri dan siklus hidup engine

API

Deskripsi

createAoqClientEngine

Mendapatkan instans wrapper engine (singleton tingkat modul yang diinisialisasi secara lazy)

createEngine

Membuat instans engine native

destroy

Hancurkan instance engine

getVersion

Mendapatkan versi SDK

connect

Menghubungkan ke server relay

disconnect

Memutus koneksi dari server

Manajemen perangkat audio

API

Deskripsi

startAudioCapture

Membuka perangkat tangkapan audio (mikrofon)

stopAudioCapture

Menutup perangkat tangkapan audio

muteAudioCapture

Bisukan atau nyalakan kembali penangkapan audio

startAudioPlayer

Memulai rendering audio untuk memutar audio remote

stopAudioPlayer

Menghentikan rendering audio

pauseAudioPlayer

Menjeda rendering audio, dengan dukungan fade-out

resumeAudioPlayer

Melanjutkan rendering audio, dengan dukungan fade-in

interruptAudioPlayer

Menginterupsi sesi audio saat ini

Konfigurasi kodek audio

API

Deskripsi

setAudioEncoderConfig

Menetapkan parameter pengkodean audio

setAudioDecoderConfig

Menetapkan parameter dekode audio

Manajemen perangkat video

API

Deskripsi

startVideoCapture

Membuka perangkat tangkapan video (kamera)

stopVideoCapture

Menutup perangkat tangkapan video

Kodek video dan input eksternal

API

Deskripsi

setVideoEncoderConfig

Menetapkan parameter pengkodean video

setVideoDecoderConfig

Menetapkan parameter dekode video

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 penerbitan

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

removeAudioExternalStream

Menghapus 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

Pesan real-time

API

Deskripsi

sendDataMsg

Mengirim pesan data real-time

Callback frame audio

API

Deskripsi

setAudioFrameObserver

Mengaktifkan atau menonaktifkan observer data frame audio

enableAudioFrameObserver

Mengaktifkan atau menonaktifkan callback frame audio pada posisi tertentu

Indikasi volume lokal

API

Deskripsi

enableLocalAudioVolumeIndication

Mengaktifkan atau menonaktifkan callback indikasi volume tangkapan lokal

Callback frame video

API

Deskripsi

setVideoFrameObserver

Mengaktifkan atau menonaktifkan observer data frame video

enableVideoFrameObserver

Mengaktifkan atau menonaktifkan callback frame video pada posisi tertentu

Rendering video (YUVCanvasRenderer)

API

Deskripsi

bind

Mengikat elemen canvas

unbind

Melepas ikatan dan mengosongkan gambar

bound

Menanyakan apakah ikatan sedang aktif

drawFrame

Menggambar satu frame data video I420

Event mesin (IAoqEngineEvents)

Event

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 tangkapan lokal

onVideoDeviceStateChanged

Callback perubahan status operasi perangkat video

onDataMsg

Callback untuk pesan data real-time yang diterima

onCapturedAudioFrame

Callback untuk data audio mentah yang ditangkap

onProcessCapturedAudioFrame

Callback untuk data audio setelah pemrosesan 3A

onPublishAudioFrame

Callback untuk data audio penerbitan

onPlaybackAudioFrame

Callback untuk data audio pemutaran

onCapturedVideoFrame

Callback untuk data video lokal mentah setelah tangkapan

onPreEncodeVideoFrame

Callback untuk data video lokal mentah sebelum pengkodean

onRemoteVideoFrame

Callback untuk data video remote setelah dekode dan sebelum rendering

Detail API

Entri dan siklus hidup engine

createAoqClientEngine

Mendapatkan instans wrapper engine. Ini merupakan singleton tingkat modul yang diinisialisasi secara lazy. Pemanggilan ulang metode ini akan mengembalikan instans yang sama, sesuai dengan semantik singleton engine native. Metode ini juga merupakan ekspor default paket.
import createAoqClientEngine from 'aoq-electron-sdk';
export function createAoqClientEngine(): IAoqClientEngine
Mengembalikan: Instans engine IAoqClientEngine. Perlu diperhatikan bahwa metode ini hanya membuat lapisan wrapper JS dan bridge native. Untuk benar-benar membuat engine, Anda harus memanggil createEngine().

createEngine

Membuat instans engine native. Engine ini merupakan singleton global, sehingga pemanggilan ulang metode ini akan langsung mengembalikan keberhasilan.
createEngine(config: AoqCreateConfig): number

Parameter

Tipe

Deskripsi

config

AoqCreateConfig

Konfigurasi pembuatan engine

Mengembalikan: 0 jika berhasil; -1 menunjukkan pembuatan gagal atau parameter bukan JSON yang valid.
Di Windows, createEngine() melampirkan pompa pesan Win32 16 ms ke loop libuv thread JS saat ini (diperlukan untuk tangkapan kamera) dan menghentikannya pada destroy(). Oleh karena itu, hindari memblokir thread JS secara sinkron dalam waktu lama setelah createEngine().

destroy

Menghapus instans engine dan melepaskan semua sumber daya.
destroy(): number
Mengembalikan: 0 menunjukkan keberhasilan; nilai non-0 menunjukkan kegagalan. Jika engine belum dibuat, 0 dikembalikan.

getVersion

Mendapatkan versi SDK saat ini. Anda tidak perlu memanggil createEngine() terlebih dahulu.
getVersion(): string
Mengembalikan: String versi, seperti "1.2.0". String kosong dikembalikan jika versi tidak dapat diperoleh.

connect

Menghubungkan ke server relay. Server aplikasi memperoleh parameter koneksi AOQ sementara berdasarkan protokol yang digunakan dan mengirimkannya ke klien. Untuk informasi lebih lanjut, lihat Token otentikasi.
connect(config: AoqConnectConfig): number

Parameter

Tipe

Deskripsi

config

AoqConnectConfig

Konfigurasi koneksi, yang mencakup token, SID, daftar titik akses relay, serta daftar track penerbitan dan langganan

Mengembalikan: 0 menunjukkan bahwa panggilan telah dikirim dan berjalan secara asinkron; nilai non-0 menunjukkan validasi parameter gagal. Hasil koneksi diberitahukan melalui event onConnectionStatusChange.

disconnect

Memutus koneksi dari server dan melepaskan sumber daya yang terkait dengan koneksi tersebut.
disconnect(): number
Mengembalikan: 0 menunjukkan bahwa panggilan telah dikirim dan berjalan secara asinkron; nilai non-0 menunjukkan kegagalan.

Manajemen perangkat audio

startAudioCapture

startAudioCapture(config: AoqAudioCaptureConfig): number
Membuka perangkat tangkapan audio (mikrofon). Tangkapan pertama memicu permintaan otorisasi sistem. Di macOS, Anda harus mendeklarasikan NSMicrophoneUsageDescription dalam file Info.plist aplikasi.

stopAudioCapture

stopAudioCapture(): number
Menutup perangkat tangkapan audio.

muteAudioCapture

muteAudioCapture(mute: boolean): number
Merendahkan atau mengaktifkan kembali tangkapan audio. mute=true merendahkan, sedangkan false mengaktifkan kembali.

startAudioPlayer

startAudioPlayer(config: AoqAudioPlaybackConfig): number
Memulai rendering audio untuk memutar audio remote.

stopAudioPlayer / pauseAudioPlayer / resumeAudioPlayer

stopAudioPlayer(): number
pauseAudioPlayer(fadeMs: number): number
resumeAudioPlayer(fadeMs: number): number
fadeMs: durasi fade-out atau fade-in, dalam milidetik. 0 menunjukkan eksekusi langsung.

interruptAudioPlayer

interruptAudioPlayer(trackType: AoqTrackType, fadeMs: number): number
Menginterupsi sesi audio saat ini dan membuang data downlink yang telah dibuffer dari sesi tersebut.

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

fadeMs

number

Durasi fade-out, dalam milidetik

Konfigurasi kodek audio

setAudioEncoderConfig(config: AoqAudioCodecConfig): number
setAudioDecoderConfig(config: AoqAudioCodecConfig): number
Kami menyarankan Anda memanggil metode ini sebelum connect(). Untuk menggunakan Opus (AoqEncoderTypeAudioOpus), PluginOpus harus dibangun ke dalam SDK atau didistribusikan bersama paket.

Manajemen perangkat video

startVideoCapture(config: AoqVideoCaptureConfig): number
stopVideoCapture(): number
Membuka atau menutup perangkat tangkapan video. Di macOS, Anda harus mendeklarasikan NSCameraUsageDescription dalam Info.plist. Ketika config.isExternal=true, kamera tidak dibuka, dan frame dikirim melalui pushExternalVideoCapturedFrame.
Renderer Electron adalah lingkungan Chromium dan tidak dapat menyematkan tampilan native, sehingga setLocalView / setRemoteView / switchCamera tidak disediakan. Untuk pratinjau, gunakan observer frame dengan YUVCanvasRenderer (lihat 2.13).

Kodek video dan input eksternal

setVideoEncoderConfig(config: AoqVideoCodecConfig): number
setVideoDecoderConfig(config: AoqVideoCodecConfig): number
pushExternalVideoCapturedFrame(meta: AoqExternalVideoFrameMeta, buffer: Uint8Array): number
pushExternalVideoEncodedFrame(meta: AoqExternalVideoEncodedFrameMeta, buffer: Uint8Array): number

Parameter

Tipe

Deskripsi

meta

AoqExternalVideoFrameMeta / AoqExternalVideoEncodedFrameMeta

Metadata frame (dimensi, format, dan timestamp)

buffer

Uint8Array

Data frame (data piksel atau data terkode)

Catatan:
  • pushExternalVideoCapturedFrame hanya dikonsumsi setelah startVideoCapture({ isExternal: true }). Metode ini mengembalikan 211 ketika tangkapan eksternal tidak diaktifkan dan 210 ketika buffer penuh.
  • AoqVideoPixelFormatI420 dan format packed (NV12 / NV21 / BGRA / RGBA) didukung. Untuk I420, buffer harus menggunakan tata letak kompak (stride = width), dengan bidang Y / U / V dirangkai berurutan.
  • pushExternalVideoEncodedFrame memerlukan setVideoEncoderConfig({ isExternal: true }) terlebih dahulu. Metode ini mengembalikan 212 ketika tidak diaktifkan. Saat ini hanya JPEG yang didukung.
  • Ketika meta.timeStamp bernilai 0, SDK akan mengisinya dengan waktu lokal.

Kontrol aliran media

enableSendMediaStream(trackType: AoqTrackType, enable: boolean): number
Menentukan apakah akan mengirim aliran media lokal tertentu. Kami menyarankan Anda memanggil enableSendMediaStream(trackType, false) setelah inisialisasi dan hanya mengaktifkan pengiriman setelah onConnectionStatusChange melaporkan AoqConnectionStatusConnected.

Pemutaran file audio

startAudioFile(config: AoqAudioFileMixConfig): number
stopAudioFile(fileId: string): number
pauseAudioFile(fileId: string): number
resumeAudioFile(fileId: string): number
getAudioFileDuration(fileId: string): number
getAudioFileCurrentPosition(fileId: string): number
setAudioFilePositionMillis(fileId: string, positionMs: number): number
setAudioFileVolume(fileId: string, type: AoqAudioStreamDirection, volume: number): number
getAudioFileVolume(fileId: string, type: AoqAudioStreamDirection): number

Parameter

Tipe

Deskripsi

config

AoqAudioFileMixConfig

Konfigurasi pencampuran file. fileId dibawa sebagai bidang konfigurasi.

fileId

string

Identifikasi file, yang didefinisikan oleh pemanggil. Pemanggilan API berikutnya menggunakannya untuk menemukan file.

positionMs

number

Posisi pemutaran target, dalam milidetik

type

AoqAudioStreamDirection

Volume penerbitan atau volume pemutaran lokal

volume

number

Volume. Nilai valid: 0 hingga 100.

Deskripsi nilai kembali:
  • getAudioFileDuration / getAudioFileCurrentPosition mengembalikan jumlah milidetik;
  • getAudioFileVolume mengembalikan volume saat ini;
  • Getter di atas mengembalikan -1 ketika engine belum dibuat.
Perubahan status pemutaran dilaporkan melalui event onAudioFileState.

Aliran audio eksternal

addAudioExternalStream(config: AoqAudioExternalStreamConfig): number
removeAudioExternalStream(streamId: string): number
pushAudioExternalStreamData(meta: AoqAudioExternalFrameMeta, buffer: Uint8Array): number
setAudioExternalStreamVolume(streamId: string, type: AoqAudioStreamDirection, volume: number): number
getAudioExternalStreamVolume(streamId: string, type: AoqAudioStreamDirection): number
clearAudioExternalStreamBuffer(streamId: string, fadeoutMs: number): number

Parameter

Tipe

Deskripsi

config

AoqAudioExternalStreamConfig

Konfigurasi aliran audio eksternal. streamId dibawa sebagai bidang konfigurasi.

streamId

string

Identifikasi aliran, yang didefinisikan oleh pemanggil

meta

AoqAudioExternalFrameMeta

Metadata frame PCM. streamId dibawa sebagai bidang metadata.

buffer

Uint8Array

Data PCM

fadeoutMs

number

Durasi fade-out saat buffer dikosongkan, dalam milidetik

Catatan:
  • pushAudioExternalStreamData mengembalikan 110 (buffer audio eksternal penuh) ketika durasi yang dibuffer melebihi maxBufferDuration.
  • getAudioExternalStreamVolume mengembalikan volume saat ini. Metode ini mengembalikan -1 ketika engine belum dibuat.
  • clearAudioExternalStreamBuffer tidak memiliki nilai kembali di sisi native dan selalu mengembalikan 0 pada pemanggilan yang berhasil.

Pesan real-time

sendDataMsg(data: Uint8Array | string): number
Mengirim pesan data real-time. Jika Anda memberikan string, string tersebut akan dikodekan dalam UTF-8 menjadi Buffer secara internal sebelum dikirim. Pesan dari peer dilaporkan melalui callback event onDataMsg.

Callback frame audio

setAudioFrameObserver(enable: boolean): number
enableAudioFrameObserver(params: AoqAudioObserverParams): number

Parameter

Type

Deskripsi

enable

boolean

true mendaftarkan observer frame audio bawaan; false membatalkan pendaftarannya

params

AoqAudioObserverParams

Menentukan posisi callback, status on/off, dan format callback

Penggunaan: Pertama, panggil setAudioFrameObserver(true) untuk mendaftarkan observer. Kemudian, panggil enableAudioFrameObserver untuk setiap posisi yang Anda butuhkan. Data dikirim melalui event yang sesuai.
engine.setAudioFrameObserver(true)
engine.enableAudioFrameObserver({
  enabled: true,
  audioSource: AoqAudioSource.AoqAudioSourceCaptured,
  sampleRate: 48000,
  channels: 1
})
engine.on('onCapturedAudioFrame', (frame) => { /* frame.buffer berisi data PCM */ })
Observer frame di sisi Electron hanya mendukung mode read-only dan tidak mendukung penulisan data frame kembali dalam callback (sisi native tetap diatur ke ReadOnly).

Indikasi volume lokal

enableLocalAudioVolumeIndication(config: AoqAudioVolumeIndicationConfig): number
Mengaktifkan atau menonaktifkan indikasi volume tangkapan lokal. Jika config.interval <= 0, callback dinonaktifkan. Setelah diaktifkan, onLocalAudioVolumeIndication dipicu pada interval yang ditentukan oleh config.interval. Anda harus memanggil metode ini setelah startAudioCapture() untuk mendapatkan data volume.

Callback frame video

setVideoFrameObserver(enable: boolean): number
enableVideoFrameObserver(params: AoqVideoObserverParams): number

Parameter

Tipe

Deskripsi

enable

boolean

true mendaftarkan observer frame video bawaan; false membatalkan pendaftarannya

params

AoqVideoObserverParams

Menentukan posisi callback, status on/off, format piksel, dan kebijakan penyelarasan

Data callback dikirim sebagai AoqVideoFrameEvent melalui onCapturedVideoFrame / onPreEncodeVideoFrame / onRemoteVideoFrame. Untuk I420, buffer adalah bidang Y / U / V yang dirangkai berdasarkan stride. Format packed lainnya dilewatkan sebagai data aslinya. Mode read-only juga didukung.

Rendering video (YUVCanvasRenderer)

Renderer perangkat lunak yang dibangun ke dalam SDK. Renderer ini mengambil alih tanggung jawab pratinjau dari setLocalView / setRemoteView pada platform seluler.
import { YUVCanvasRenderer } from 'aoq-electron-sdk';

class YUVCanvasRenderer {
  bind(canvas: HTMLCanvasElement): void
  unbind(): void
  get bound(): boolean
  drawFrame(frame: AoqVideoFrameEvent): void
}

API

Deskripsi

bind

Ikatkan kanvas (pengikatan ulang akan menggantikan sink)

unbind

Melepas ikatan dan mengosongkan gambar

bound

Menentukan apakah ikatan telah dibuat

drawFrame

Menggambar satu frame; hanya I420 yang didukung, dan metode ini diam-diam mengembalikan hasil untuk format non-I420 atau ketika ukuran atau panjang buffer tidak mencukupi

const renderer = new YUVCanvasRenderer()
renderer.bind(document.getElementById('preview'))

engine.setVideoFrameObserver(true)
engine.enableVideoFrameObserver({
  enabled: true,
  videoSource: AoqVideoSource.AoqVideoSourceCaptured,
  format: AoqVideoPixelFormat.AoqVideoPixelFormatI420
})
engine.on('onCapturedVideoFrame', (frame) => renderer.drawFrame(frame))
Untuk mode pengisian rendering (seperti stretch atau crop), gunakan properti CSS object-fit untuk mengontrol canvas.

Event mesin (IAoqEngineEvents)

Engine mewarisi dari EventEmitter<IAoqEngineEvents>. Event merupakan jalur keluar terpadu untuk semua notifikasi asinkron dari SDK dan dipetakan satu-ke-satu ke callback native AoqEngineEventListener. Anda tidak perlu mendaftarkan event yang tidak Anda perlukan.
engine.on('onError', (code, message) => {})
engine.off('onError', handler)
engine.once('onStats', (stats) => {})
engine.removeAllListeners()

onError

onError: (code: number, message: string) => void
Callback error engine. code sesuai dengan nilai AoqErrorCode (lihat 3.3).

onWarning

onWarning: (code: number, message: string) => void
Callback peringatan engine. code sesuai dengan nilai AoqWarningCode (lihat 3.3).

onConnectionStatusChange

onConnectionStatusChange: (status: AoqConnectionStatus) => void
Callback perubahan status koneksi. Transisi status: Disconnected -> Connecting -> Connected / Failed -> Disconnected.

onStats

onStats: (stats: AoqStats) => void
Callback statistik engine. SDK secara berkala melaporkan statistik penerbitan dan langganan untuk audio dan video serta statistik jaringan, yang dapat Anda gunakan untuk memantau kualitas panggilan dan status jaringan secara real-time serta mendiagnosis masalah audio dan video.

Parameter

Type

Deskripsi

stats

AoqStats

Statistik penerbitan dan langganan serta statistik jaringan untuk audio, video, dan pesan data

onAudioDeviceStateChanged

onAudioDeviceStateChanged: (state: AoqAudioDeviceState) => void
Callback untuk perubahan status operasi tangkapan dan pemutaran perangkat audio.

onAudioDeviceRouteChanged

onAudioDeviceRouteChanged: (routeType: number) => void
Callback perubahan rute output audio. routeType sesuai dengan nilai AoqAudioDeviceRouteType (lihat 3.4).

onAudioFileState

onAudioFileState: (state: AoqAudioFileState) => void
Callback untuk status pemutaran file audio.

onLocalAudioVolumeIndication

onLocalAudioVolumeIndication: (volume: AoqAudioVolume) => void
Callback indikasi volume tangkapan lokal. Untuk mengaktifkannya, panggil enableLocalAudioVolumeIndication.

onVideoDeviceStateChanged

onVideoDeviceStateChanged: (state: AoqVideoDeviceState) => void
Callback untuk perubahan status operasi tangkapan perangkat video.

onDataMsg

onDataMsg: (data: Uint8Array) => void
Callback untuk pesan data real-time yang diterima. data adalah Buffer yang disalin di sisi native dan dapat dipegang secara aman secara asinkron. Untuk pesan teks, gunakan Buffer.from(data).toString() untuk mengonversi data menjadi string.

Event frame audio

onCapturedAudioFrame:        (frame: AoqAudioFrameEvent) => void  /* data mentah yang ditangkap */
onProcessCapturedAudioFrame: (frame: AoqAudioFrameEvent) => void  /* data setelah pemrosesan 3A */
onPublishAudioFrame:         (frame: AoqAudioFrameEvent) => void  /* data penerbitan */
onPlaybackAudioFrame:        (frame: AoqAudioFrameEvent) => void  /* data pemutaran */
Anda harus terlebih dahulu memanggil setAudioFrameObserver(true) dan enableAudioFrameObserver untuk mengaktifkannya.

Event frame video

onCapturedVideoFrame:  (frame: AoqVideoFrameEvent) => void  /* setelah tangkapan, sebelum pra-pemrosesan */
onPreEncodeVideoFrame: (frame: AoqVideoFrameEvent) => void  /* sebelum pengkodean, setelah pra-pemrosesan */
onRemoteVideoFrame:    (frame: AoqVideoFrameEvent) => void  /* remote, setelah dekode dan sebelum rendering */
Anda harus terlebih dahulu memanggil setVideoFrameObserver(true) dan enableVideoFrameObserver untuk mengaktifkannya. Event frame bersifat read-only. Modifikasi terhadap buffer dalam callback tidak ditulis kembali ke SDK.
Hindari komputasi berat dalam callback event: callback native dikirim ke thread utama JS melalui thread asinkron, dan operasi yang memakan waktu dalam event frame berfrekuensi tinggi menyebabkan backlog.

Tipe data dan enumerasi

Semua tipe diekspor dari root paket, sehingga Anda dapat langsung menggunakan import { ... } from 'aoq-electron-sdk'. Enumerasi adalah tipe enum TypeScript dan tersedia saat runtime, sedangkan antarmuka (interface) hanya merupakan batasan tipe. Jika bidang yang ditandai opsional tidak ditentukan, nilai default dalam tabel akan digunakan.

Tipe umum

AoqCreateConfig

Bidang

Tipe

Wajib

Nilai default

Deskripsi

workDir

string

Tidak

""

Direktori kerja SDK (untuk log dan file sementara)

enableDumpAudio

boolean

Tidak

false

Menentukan apakah akan menyimpan data audio (untuk debugging)

extras

string

Tidak

""

Parameter tambahan (string JSON)

Bidang isBTScoMode di Android adalah bidang khusus seluler dan tidak disediakan oleh Electron.

AoqConnectConfig

Bidang

Tipe

Wajib

Nilai default

Deskripsi

token

string

Ya

-

Token otentikasi koneksi

sid

string

Ya

-

ID Sesi

certFingerprint

string

Tidak

""

Sidik jari sertifikat server

workspaceIdHash

string

Tidak

None

Hash ID ruang kerja. String kosong setara dengan tidak melewatkan parameter.

relayEndpoints

Array

Ya

-

Daftar titik akses relay

publishTracks

Array

Ya

-

Daftar track lokal yang diterbitkan

subscribeTracks

Array

Ya

-

Daftar track lokal yang dilanggan

AoqRelayEndpoint

Bidang

Tipe

Wajib

Nilai default

Deskripsi

routeIndex

number

Tidak

-1

Indeks entri rute

endpoint

string

Ya

-

Nama domain atau alamat IP server relay

port

number

Ya

-

Port server relay

AoqTrackParam

Bidang

Tipe

Wajib

Nilai default

Deskripsi

trackType

AoqTrackType

Ya

-

Jenis track

trackMode

AoqTrackMode

Tidak

AoqTrackModeSegment

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

Tipe statistik

AoqStats

Rangkuman statistik engine, yang dilaporkan secara berkala melalui onStats. Bidang array berupa array kosong ketika tidak memiliki data, dan networkStats tidak dikirimkan ketika tidak memiliki data.

Bidang

Type

Deskripsi

audioPublishStats

Array

Statistik penerbitan untuk audio

videoPublishStats

Array

Statistik penerbitan untuk video

dataMsgPublishStats

Array

Statistik penerbitan untuk pesan data

audioSubscribeStats

Array

Statistik langganan untuk audio

videoSubscribeStats

Array

Statistik langganan untuk video

dataMsgSubscribeStats

Array

Statistik langganan untuk pesan data

networkStats

AoqNetworkStats

Statistik jaringan

AoqAudioPublishStats

Bidang

Type

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

number

Bitrate, dalam bit/s

bytes

number

Byte kumulatif yang dikirim

encodeVolume

number

Volume pengkodean aliran penerbitan

AoqAudioSubscribeStats

Bidang

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

number

Bitrate, dalam bit/s

bytes

number

Byte kumulatif yang diterima

playVolume

number

Volume pemutaran

AoqVideoPublishStats

Bidang

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

number

Bitrate, dalam bit/s

bytes

number

Byte kumulatif yang dikirim

encodeFps

number

Laju frame pengkodean

AoqVideoSubscribeStats

Bidang

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

number

Bitrate, dalam bit/s

bytes

number

Byte kumulatif yang diterima

decodeFps

number

Laju frame dekode

renderFps

number

Laju frame rendering

AoqDataMsgPublishStats / AoqDataMsgSubscribeStats

Bidang

Type

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

number

Bitrate, dalam bit/s

bytes

number

Byte kumulatif yang dikirim dan diterima

AoqNetworkStats

Bidang

Tipe

Deskripsi

sendBitrate

number

Bitrate kirim, dalam bit/s

sendBytes

number

Byte kumulatif yang dikirim

recvBitrate

number

Bitrate terima, dalam bit/s

recvBytes

number

Byte kumulatif yang diterima

loss

number

Laju kehilangan paket, dari 0 hingga 100

rtt

number

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 plug-in; memerlukan PluginOpus)

AoqEncoderTypeVideoH264

3

Video H.264

AoqEncoderTypeVideoJpeg

4

Video JPEG

AoqEncoderTypeDataText

5

Pesan teks

AoqConnectionStatus

Nilai enum

Nilai

Deskripsi

AoqConnectionStatusDisconnected

0

Terputus

AoqConnectionStatusConnecting

1

Menghubungkan

AoqConnectionStatusConnected

2

Tersambung

AoqConnectionStatusFailed

3

Koneksi gagal

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

AoqErrorCode

Kode kesalahan didefinisikan di lapisan native. Parameter code dari onError dan nilai kembali API menggunakan nilai-nilai ini (lapisan TS tidak mengekspornya sebagai enum).

Nilai enum

Nilai

Deskripsi

AoqErrorCodeOK

0

Berhasil

AoqErrorCodeParamInvalid

1

Parameter tidak valid

AoqErrorCodeStateInvalid

2

Status tidak valid

AoqErrorCodeUnSupport

3

Tidak didukung di platform saat ini atau dalam mode saat ini

AoqErrorCodeAudio

100

Kesalahan audio umum

AoqErrorCodeAudioExternalBufferFull

110

Buffer audio eksternal penuh

AoqErrorCodeAudioDevice

120

Kesalahan perangkat audio umum

AoqErrorCodeAudioDeviceRecordingAuthFailed

121

Izin perekaman tidak diberikan

AoqErrorCodeAudioDeviceRecordingOccupied

122

Perangkat perekaman sedang digunakan

AoqErrorCodeAudioDeviceRecordingBackgroundStart

123

Gagal memulai perekaman di latar belakang

AoqErrorCodeAudioDeviceRecordingStartFail

124

Gagal memulai perekaman

AoqErrorCodeAudioDevicePlayoutOccupied

125

Perangkat pemutaran sedang digunakan

AoqErrorCodeAudioDevicePlayoutBackgroundStart

126

Gagal memulai pemutaran di latar belakang

AoqErrorCodeAudioDevicePlayoutStartFail

127

Gagal memulai pemutaran

AoqErrorCodeVideo

200

Kesalahan video umum

AoqErrorCodeVideoExternalBufferFull

210

Buffer video eksternal penuh

AoqErrorCodeVideoExternalCaptureNotEnabled

211

Tangkapan video eksternal tidak diaktifkan

AoqErrorCodeVideoExternalEncoderNotEnabled

212

Pengkodean video eksternal tidak diaktifkan

AoqErrorCodeVideoDevice

220

Kesalahan perangkat video umum

AoqErrorCodeVideoDeviceCameraOpenFail

221

Gagal membuka kamera

AoqErrorCodeVideoDeviceCameraAuthFailed

222

Izin kamera tidak diberikan

AoqErrorCodeVideoDeviceCameraOccupied

223

Kamera sedang digunakan

AoqErrorCodeVideoDeviceCameraRunningError

224

Exception runtime kamera

AoqErrorCodeVideoCodec

230

Kesalahan kodek video umum

AoqErrorCodeVideoCodecEncoderInitFail

231

Gagal menginisialisasi encoder video

AoqErrorCodeVideoRender

240

Kesalahan rendering video umum

AoqErrorCodeVideoRenderCreateFail

241

Gagal membuat rendering video

AoqErrorCodeVideoRenderDrawError

242

Kesalahan penggambaran rendering video

Selain kode kesalahan native di atas, lapisan Electron mengembalikan -1 ketika engine belum dibuat atau telah dihapus, atau ketika parameter bukan JSON yang valid.

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

Kesalahan enumerasi mikrofon

AoqWCAudioDeviceMicStartTimeout

122

Waktu mulai mikrofon habis

AoqWCAudioDeviceRecordingError

123

Kesalahan selama perekaman

AoqWCAudioDeviceSpeakerEnumerateError

124

Kesalahan enumerasi speaker

AoqWCAudioDeviceSpeakerStartTimeout

125

Waktu mulai speaker habis

AoqWCAudioDevicePlayoutError

126

Kesalahan selama pemutaran

AoqWCVideo

200

Peringatan video umum

AoqWCVideoCameraEnumerateError

201

Kesalahan enumerasi kamera

AoqWCVideoEncoderSwitched

202

Encoder video dialihkan

AoqWCVideoRenderDowngrade

203

Rendering video diturunkan spesifikasinya

Tipe audio

AoqAudioCaptureConfig

Bidang

Tipe

Wajib

Nilai default

Deskripsi

isExternal

boolean

Tidak

false

Menentukan apakah akan menggunakan mode tangkapan eksternal

channel

number

Tidak

1

Jumlah kanal tangkapan audio. Didukung 1 dan 2.

AoqAudioPlaybackConfig

Bidang

Tipe

Wajib

Nilai default

Deskripsi

isExternal

boolean

Tidak

false

Menentukan apakah akan menggunakan mode pemutaran eksternal

channel

number

Tidak

1

Jumlah kanal pemutaran audio. Didukung 1 dan 2.

isVoipMode / isDefaultSpeaker adalah bidang khusus seluler dan tidak disediakan oleh Electron.

AoqAudioCodecConfig

Bidang

Tipe

Wajib

Nilai default

Deskripsi

trackType

AoqTrackType

Tidak

AoqTrackTypeAudio

Jenis track

codecType

AoqEncoderType

Tidak

AoqEncoderTypeAudioPCM

Format kodek

sampleRate

number

Tidak

48000

Laju sampel, dalam Hz. Untuk pengkodean, Opus 8/16/48K dan PCM 8/16/32/48K didukung. Untuk dekode, 24K juga didukung, tetapi hanya dalam mode Segment.

channel

number

Tidak

1

Jumlah kanal. Didukung 1 dan 2.

bitrate

number

Tidak

32000

Bitrate, dalam bit/s

AoqAudioDeviceRouteType

Tabel berikut mencantumkan nilai routeType yang valid untuk onAudioDeviceRouteChanged. Nilai-nilai ini didefinisikan oleh lapisan native dan tidak diekspor sebagai enum oleh lapisan TypeScript.

Nilai enum

Nilai

Deskripsi

AoqAudioDeviceRouteDefault

0

Rute default

AoqAudioDeviceRouteHeadset

1

Headphone dengan mikrofon

AoqAudioDeviceRouteEarpiece

2

Receiver

AoqAudioDeviceRouteHeadsetNoMic

3

Headphone tanpa mikrofon

AoqAudioDeviceRouteSpeakerPhone

4

Speaker

AoqAudioDeviceRouteUsb

5

Perangkat audio USB

AoqAudioDeviceRouteBluetooth

6

Mode Bluetooth SCO

AoqAudioDeviceRouteBluetoothA2dp

7

Mode Bluetooth A2DP

AoqAudioDeviceStateCode

Nilai enum

Nilai

Deskripsi

AoqAudioDeviceNone

0

Tidak ada status

AoqAudioDeviceRecordStarting

1

Tangkapan dimulai

AoqAudioDeviceRecordStarted

2

Tangkapan dimulai

AoqAudioDeviceRecordStopping

3

Tangkapan dihentikan

AoqAudioDeviceRecordStopped

4

Tangkapan dihentikan

AoqAudioDeviceRecordFail

5

Tangkapan gagal

AoqAudioDevicePlayStarting

6

Pemutaran dimulai

AoqAudioDevicePlayStarted

7

Pemutaran dimulai

AoqAudioDevicePlayStopping

8

Pemutaran dihentikan

AoqAudioDevicePlayStopped

9

Pemutaran dihentikan

AoqAudioDevicePlayFail

10

Pemutaran gagal

AoqAudioDeviceState

Bidang

Tipe

Deskripsi

state

AoqAudioDeviceStateCode

Status operasi perangkat

reason

number

Kode alasan kesalahan. Lihat AoqErrorCode.

Tipe file audio

AoqAudioFileMixConfig

Bidang

Type

Wajib

Nilai default

Deskripsi

fileId

string

Ya

-

Identifikasi file. Pemanggilan API berikutnya menggunakannya untuk menemukan file.

fileName

string

Ya

-

Nama file (termasuk path)

cycles

number

Tidak

-1

Jumlah putaran. -1 menunjukkan pemutaran berulang tanpa batas.

startPosMs

number

Tidak

0

Posisi awal pemutaran, dalam milidetik

publishVolume

number

Tidak

100

Volume penerbitan. Nilai valid: 0 hingga 100.

playoutVolume

number

Tidak

100

Volume pemutaran. Nilai valid: 0 hingga 100.

AoqAudioFileStateCode

Nilai enum

Nilai

Deskripsi

AoqAudioFileNone

0

Tidak ada status

AoqAudioFileStarted

1

Pemutaran dimulai

AoqAudioFileStopped

2

Pemutaran dihentikan

AoqAudioFilePaused

3

Pemutaran dijeda

AoqAudioFileResumed

4

Pemutaran dilanjutkan

AoqAudioFileEnded

5

Pemutaran selesai

AoqAudioFileBuffering

6

Pemutaran buffering

AoqAudioFileBufferingEnd

7

Buffering selesai

AoqAudioFileFailed

8

Pemutaran gagal

AoqAudioFileErrorCode

Tabel berikut mencantumkan nilai AoqAudioFileState.errorCode yang valid. Nilai-nilai ini didefinisikan oleh lapisan native dan dikirimkan sebagai nilai number oleh lapisan TypeScript.

Nilai enum

Nilai

Deskripsi

AoqAudioFileNoError

0

Tidak ada kesalahan

AoqAudioFileOpenFailed

1

Gagal membuka file

AoqAudioFileDecodeFailed

2

Gagal mendekode file

AoqAudioFileState

Bidang

Type

Deskripsi

fileId

string

Identifikasi file

stateCode

AoqAudioFileStateCode

Kode status pemutaran file

errorCode

number

Kode kesalahan file. Lihat AoqAudioFileErrorCode.

Tipe aliran audio eksternal

AoqAudioStreamDirection

Nilai enum

Nilai

Deskripsi

AoqAudioStreamPublish

0

Aliran penerbitan

AoqAudioStreamPlayout

1

Aliran pemutaran (pemutaran lokal)

AoqAudioExternalStreamConfig

Bidang

Tipe

Wajib

Nilai default

Deskripsi

streamId

string

Ya

-

Identifikasi aliran

trackType

AoqTrackType

Tidak

AoqTrackTypeAudio

Jenis track audio

codecType

AoqEncoderType

Tidak

AoqEncoderTypeAudioPCM

Format aliran audio. Saat ini hanya PCM yang didukung.

channels

number

Tidak

1

Jumlah kanal. Dibatasi oleh kodek aliran penerbitan. Didukung 1 dan 2.

sampleRate

number

Tidak

48000

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

playoutVolume

number

Tidak

100

Volume pemutaran. Nilai valid: 0 hingga 100.

publishVolume

number

Tidak

100

Volume penerbitan. Nilai valid: 0 hingga 100.

maxBufferDuration

number

Tidak

600000

Durasi buffer maksimum, dalam milidetik. Nilai valid: 100 ke atas. Jika durasi melebihi nilai ini, push gagal.

enable3A

boolean

Tidak

false

Menentukan apakah akan menerapkan pemrosesan 3A ke PCM input

AoqAudioExternalFrameMeta

Metadata frame audio eksternal. Data PCM dilewatkan secara terpisah melalui parameter buffer.

Bidang

Tipe

Wajib

Nilai default

Deskripsi

streamId

string

Ya

-

Identifikasi aliran audio eksternal target

numOfSamples

number

Ya

0

Jumlah sampel (per kanal)

bytesPerSample

number

Ya

2

Byte per sampel

numOfChannels

number

Ya

1

Jumlah kanal

samplesPerSec

number

Ya

48000

Jumlah sampel per detik (laju sampel)

pushSequence

number

Tidak

0

Ronde input PCM

timeStamp

number

Tidak

0

Timestamp

AoqAudioFrameEvent

Data peristiwa dari pengamat frame audio.

Bidang

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

numOfSamples

number

Jumlah sampel (per kanal)

bytesPerSample

number

Byte per sampel

numOfChannels

number

Jumlah kanal

samplesPerSec

number

Jumlah sampel per detik (laju sampel)

timeStamp

number

Timestamp

autoGenMute

boolean

true menunjukkan data senyap yang dihasilkan oleh SDK

buffer

Uint8Array

Data PCM audio (sudah disalin di sisi native)

AoqAudioSource

Nilai enum

Nilai

Deskripsi

AoqAudioSourceCaptured

0

Data audio yang ditangkap

AoqAudioSourceProcessCaptured

1

Data audio setelah pemrosesan 3A

AoqAudioSourcePublish

2

Data audio yang akan diterbitkan (memerlukan koneksi yang berhasil)

AoqAudioSourcePlayback

3

Data audio yang akan diputar

AoqAudioObserverParams

Bidang

Type

Wajib

Nilai default

Deskripsi

enabled

boolean

Ya

false

Mengaktifkan atau menonaktifkan callback pada posisi ini

audioSource

AoqAudioSource

Ya

AoqAudioSourceCaptured

Posisi callback

sampleRate

number

Tidak

48000

Laju sampel audio callback, dalam Hz. Resampling dilakukan jika laju tidak cocok.

channels

number

Tidak

1

Jumlah kanal audio dalam callback. Didukung 1 dan 2.

Mode callback tetap read-only. Electron tidak menyediakan mode read-write.

AoqAudioVolumeIndicationConfig

Bidang

Tipe

Wajib

Nilai default

Deskripsi

interval

number

Tidak

0

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

smooth

number

Tidak

3

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

AoqAudioVolume

Bidang

Tipe

Deskripsi

volume

number

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

Tipe video

AoqVideoCaptureConfig

Bidang

Tipe

Wajib

Nilai default

Deskripsi

width

number

Tidak

1280

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

height

number

Tidak

720

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

fps

number

Tidak

15

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

isExternal

boolean

Tidak

false

Menentukan apakah akan menggunakan tangkapan eksternal. Jika true, kamera tidak dibuka.

cameraDirection adalah bidang khusus seluler dan tidak ada di platform desktop.

AoqVideoCodecConfig

Pengkodean dan dekode berbagi struktur yang sama (setVideoEncoderConfig / setVideoDecoderConfig).

Bidang

Tipe

Wajib

Nilai default

Deskripsi

isExternal

boolean

Tidak

false

Ketika parameter ini true, SDK tidak melakukan tangkapan atau pengkodean, dan frame didorong langsung oleh pushExternalVideoEncodedFrame.

trackType

AoqTrackType

Tidak

AoqTrackTypeVideo

Jenis track

codecType

AoqEncoderType

Tidak

AoqEncoderTypeVideoH264

Format kodek

width

number

Tidak

540

Lebar pengkodean, dalam piksel

height

number

Tidak

960

Tinggi pengkodean, dalam piksel

fps

number

Tidak

5

Laju frame pengkodean

bitrate

number

Tidak

500000

Bitrate awal, dalam bit/s

minBitrate

number

Tidak

128000

Bitrate minimum, dalam bit/s

keyframeInterval

number

Tidak

2

Interval keyframe, dalam detik

mirrorMode

AoqMirrorMode

Tidak

AoqMirrorModeDisabled

Mode pencerminan

orientationMode

AoqOrientationMode

Tidak

AoqOrientationModeAuto

Mode orientasi video

AoqVideoPixelFormat

Format piksel yang didukung di sisi Electron (tidak termasuk format texture / CVPixelBuffer di platform seluler).

Nilai enum

Nilai

Deskripsi

AoqVideoPixelFormatUnknown

0

Format tidak diketahui

AoqVideoPixelFormatI420

1

I420 (format planar YUV)

AoqVideoPixelFormatNV12

2

NV12 (format semi-planar YUV)

AoqVideoPixelFormatNV21

3

NV21 (format semi-planar YUV)

AoqVideoPixelFormatBGRA

4

BGRA (32-bit)

AoqVideoPixelFormatRGBA

5

RGBA (32-bit)

AoqExternalVideoFrameMeta

Metadata frame video mentah eksternal. Data piksel dilewatkan secara terpisah melalui parameter buffer.

Bidang

Tipe

Wajib

Nilai default

Deskripsi

trackType

AoqTrackType

Tidak

AoqTrackTypeVideo

Jenis track

format

AoqVideoPixelFormat

Ya

-

Format piksel

width

number

Ya

-

Lebar video, dalam piksel

height

number

Ya

-

Tinggi video, dalam piksel

timeStamp

number

Tidak

0

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

Ketika format = I420, buffer harus menggunakan tata letak kompak (stride = width), dengan bidang Y / U / V dirangkai berurutan. Untuk format packed lainnya, lewatkan byte frame lengkap secara langsung.

AoqVideoCodecType

Nilai enum

Nilai

Deskripsi

AoqVideoCodecTypeJPEG

0

Pengkodean JPEG

AoqExternalVideoEncodedFrameMeta

Metadata frame video terkode eksternal. Data terkode dilewatkan secara terpisah melalui parameter buffer.

Bidang

Tipe

Wajib

Nilai default

Deskripsi

trackType

AoqTrackType

Tidak

AoqTrackTypeVideo

Jenis track

codec

AoqVideoCodecType

Tidak

AoqVideoCodecTypeJPEG

Format kodek

width

number

Ya

-

Lebar, dalam piksel

height

number

Ya

-

Tinggi, dalam piksel

timeStamp

number

Tidak

0

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

AoqVideoDeviceStateCode

Nilai enum

Nilai

Deskripsi

AoqVideoDeviceNone

0

Tidak ada status

AoqVideoDeviceCaptureStarting

1

Tangkapan dimulai

AoqVideoDeviceCaptureStarted

2

Tangkapan dimulai

AoqVideoDeviceCaptureStopping

3

Tangkapan dihentikan

AoqVideoDeviceCaptureStopped

4

Tangkapan dihentikan

AoqVideoDeviceCaptureFail

5

Tangkapan gagal (misalnya, izin ditolak atau perangkat tidak tersedia)

AoqVideoDeviceState

Bidang

Type

Deskripsi

state

AoqVideoDeviceStateCode

Status operasi penangkapan perangkat

reason

number

Kode alasan kesalahan. Lihat AoqErrorCode.

Tipe callback frame video

AoqVideoSource

Nilai enum

Nilai

Deskripsi

AoqVideoSourceCaptured

0

Data video yang ditangkap sebelum pra-pemrosesan

AoqVideoSourcePreEncode

1

Data video sebelum pengkodean, setelah pra-pemrosesan

AoqVideoSourceRemote

2

Data video remote setelah dekode dan sebelum rendering

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

AoqVideoObserverParams

Bidang

Tipe

Required

Nilai default

Deskripsi

enabled

boolean

Ya

false

Mengaktifkan atau menonaktifkan callback pada posisi ini

videoSource

AoqVideoSource

Ya

AoqVideoSourceCaptured

Posisi callback

format

AoqVideoPixelFormat

Tidak

AoqVideoPixelFormatI420

Format piksel yang diharapkan dari data callback

alignment

AoqVideoObserverAlignment

Tidak

AoqVideoObserverAlignmentDefault

Kebijakan penyelarasan lebar

mirrorApplied

boolean

Tidak

false

Menentukan apakah akan mencerminkan data callback

Mode callback tetap read-only. Electron tidak menyediakan mode read-write. Pilih I420 ketika Anda menggunakan YUVCanvasRenderer bawaan untuk rendering.

AoqVideoFrameEvent

Data event observer frame video.

Bidang

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

format

AoqVideoPixelFormat

Format piksel

width

number

Lebar, dalam piksel

height

number

Tinggi, dalam piksel

strideY

number

Stride bidang Y (hanya berlaku untuk I420)

strideU

number

Stride bidang U (hanya berlaku untuk I420)

strideV

number

Stride bidang V (hanya berlaku untuk I420)

timeStamp

number

Stempel waktu, dalam milidetik

buffer

Uint8Array

Data frame. Untuk I420, merupakan bidang Y / U / V yang dirangkai berdasarkan stride. Format packed lainnya dilewatkan sebagai data aslinya.

Tipe pesan data

Electron tidak menggunakan tipe wrapper AoqDataMsg. Pesan data dikirim dan diterima langsung sebagai data biner:

Arah

Tipe

Deskripsi

Kirim

Uint8Array atau string

sendDataMsg(data). String dikodekan dalam UTF-8.

Terima

Uint8Array

onDataMsg(data). Data sudah disalin di sisi native dan dapat dipegang secara asinkron.