AOQ Client SDK Electron API 参考

import createAoqClientEngine from 'aoq-electron-sdk';
export function createAoqClientEngine(): IAoqClientEngine

createEngine(config: AoqCreateConfig): number

destroy(): number

getVersion(): string

connect(config: AoqConnectConfig): number

disconnect(): number

startAudioCapture(config: AoqAudioCaptureConfig): number

stopAudioCapture(): number

muteAudioCapture(mute: boolean): number

startAudioPlayer(config: AoqAudioPlaybackConfig): number

stopAudioPlayer(): number
pauseAudioPlayer(fadeMs: number): number
resumeAudioPlayer(fadeMs: number): number

interruptAudioPlayer(trackType: AoqTrackType, fadeMs: number): number

setAudioEncoderConfig(config: AoqAudioCodecConfig): number
setAudioDecoderConfig(config: AoqAudioCodecConfig): number

startVideoCapture(config: AoqVideoCaptureConfig): number
stopVideoCapture(): number

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

startScreenCapture(config: AoqScreenCaptureConfig): number
stopScreenCapture(): number

getScreenSourceList(): AoqScreenSourceInfo[]

enableSendMediaStream(trackType: AoqTrackType, enable: boolean): number

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

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

sendDataMsg(data: Uint8Array | string): number

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

engine.setAudioFrameObserver(true)
engine.enableAudioFrameObserver({
  enabled: true,
  audioSource: AoqAudioSource.AoqAudioSourceCaptured,
  sampleRate: 48000,
  channels: 1
})
engine.on('onCapturedAudioFrame', (frame) => { /* frame.buffer 为 PCM 数据 */ })

enableLocalAudioVolumeIndication(config: AoqAudioVolumeIndicationConfig): number

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

import { YUVCanvasRenderer } from 'aoq-electron-sdk';

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

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))

engine.on('onError', (code, message) => {})
engine.off('onError', handler)
engine.once('onStats', (stats) => {})
engine.removeAllListeners()

onError: (code: number, message: string) => void

onWarning: (code: number, message: string) => void

onConnectionStatusChange: (status: AoqConnectionStatus) => void

onStats: (stats: AoqStats) => void

onAudioDeviceStateChanged: (state: AoqAudioDeviceState) => void

onAudioDeviceRouteChanged: (routeType: number) => void

onAudioFileState: (state: AoqAudioFileState) => void

onLocalAudioVolumeIndication: (volume: AoqAudioVolume) => void

onVideoDeviceStateChanged: (state: AoqVideoDeviceState) => void

onDataMsg: (data: Uint8Array) => void

onCapturedAudioFrame:        (frame: AoqAudioFrameEvent) => void  /* 采集裸数据 */
onProcessCapturedAudioFrame: (frame: AoqAudioFrameEvent) => void  /* 3A 后数据 */
onPublishAudioFrame:         (frame: AoqAudioFrameEvent) => void  /* 推流数据 */
onPlaybackAudioFrame:        (frame: AoqAudioFrameEvent) => void  /* 播放数据 */

engine.on('onCapturedAudioFrame', (frame: AoqAudioFrameEvent) => { ... })

engine.on('onProcessCapturedAudioFrame', (frame: AoqAudioFrameEvent) => { ... })

engine.on('onPublishAudioFrame', (frame: AoqAudioFrameEvent) => { ... })

engine.on('onPlaybackAudioFrame', (frame: AoqAudioFrameEvent) => { ... })

onCapturedVideoFrame:  (frame: AoqVideoFrameEvent) => void  /* 采集后（前处理前） */
onPreEncodeVideoFrame: (frame: AoqVideoFrameEvent) => void  /* 编码前（前处理后） */
onRemoteVideoFrame:    (frame: AoqVideoFrameEvent) => void  /* 远端解码后、渲染前 */

engine.on('onCapturedVideoFrame', (frame: AoqVideoFrameEvent) => { ... })

engine.on('onPreEncodeVideoFrame', (frame: AoqVideoFrameEvent) => { ... })

engine.on('onRemoteVideoFrame', (frame: AoqVideoFrameEvent) => { ... })