Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ZegoExpressEngineImpl

Hierarchy

  • ZegoExpressEngineImpl

Index

Constructors

Methods

Constructors

constructor

Methods

addPublishCdnUrl

callEmit

  • callEmit(...args: any[]): void

  • Parameters

    • Rest ...args: any[]

    Returns void

callExperimentalAPI

  • callExperimentalAPI(param: string): string

  • Parameters

    • param: string

    Returns string

createAudioEffectPlayer

createMediaPlayer

createRangeAudio

  • Returns ZegoRangeAudio | null

destroyAudioEffectPlayer

destroyMediaPlayer

  • Parameters

    Returns void

destroyRangeAudio

  • Parameters

    Returns void

emit

  • emit(eventName: string, ...args: any[]): void

  • Parameters

    • eventName: string
    • Rest ...args: any[]

    Returns void

enableAEC

  • enableAEC(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

enableAGC

  • enableAGC(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

enableANS

  • enableANS(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

enableAudioCaptureDevice

  • enableAudioCaptureDevice(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

enableAudioMixing

  • enableAudioMixing(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

enableCamera

  • Parameters

    • enable: boolean
    • Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main

    Returns void

enableCustomAudioCaptureProcessing

enableCustomAudioIO

enableCustomAudioPlaybackProcessing

enableCustomAudioRemoteProcessing

enableCustomVideoProcessing

enableDebugAssistant

  • enableDebugAssistant(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

enableEffectsBeauty

  • enableEffectsBeauty(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

enableHardwareDecoder

  • enableHardwareDecoder(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

enableHardwareEncoder

  • enableHardwareEncoder(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

enableHeadphoneAEC

  • enableHeadphoneAEC(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

enableHeadphoneMonitor

  • enableHeadphoneMonitor(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

enablePublishDirectToCDN

  • Parameters

    Returns void

enableTrafficControl

  • enableTrafficControl(enable: boolean, property: number, channel?: ZegoPublishChannel): void

  • Parameters

    • enable: boolean
    • property: number
    • Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main

    Returns void

enableTransientANS

  • enableTransientANS(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

enableVirtualStereo

  • enableVirtualStereo(enable: boolean, angle: number): void

  • Parameters

    • enable: boolean
    • angle: number

    Returns void

getAudioConfig

getAudioDeviceList

getAudioDeviceVolume

  • Parameters

    Returns number

getAudioRouteType

getCameraMaxZoomFactor

  • Parameters

    Returns number

getCaptureVolume

  • getCaptureVolume(): number

  • Returns number

getDefaultAudioDeviceID

  • Parameters

    Returns string

getNetworkTimeInfo

getVideoConfig

isAudioDeviceMuted

  • Parameters

    Returns boolean

isCameraFocusSupported

  • Parameters

    Returns boolean

isMicrophoneMuted

  • isMicrophoneMuted(): boolean

  • Returns boolean

isSpeakerMuted

  • isSpeakerMuted(): boolean

  • Returns boolean

isVideoDecoderSupported

isVideoEncoderSupported

loginRoom

  • Parameters

    Returns void

logoutRoom

  • logoutRoom(roomID?: string): void

  • Parameters

    • Optional roomID: string

    Returns void

muteAllPlayStreamAudio

  • muteAllPlayStreamAudio(mute: boolean): void

  • Parameters

    • mute: boolean

    Returns void

muteAudioDevice

  • Parameters

    Returns void

muteLocalAudioMixing

  • muteLocalAudioMixing(mute: boolean): void

  • Parameters

    • mute: boolean

    Returns void

muteMicrophone

  • muteMicrophone(mute: boolean): void

  • Parameters

    • mute: boolean

    Returns void

mutePlayStreamAudio

  • mutePlayStreamAudio(streamID: string, mute: boolean): void

  • Parameters

    • streamID: string
    • mute: boolean

    Returns void

mutePlayStreamVideo

  • mutePlayStreamVideo(streamID: string, mute: boolean): void

  • Parameters

    • streamID: string
    • mute: boolean

    Returns void

mutePublishStreamAudio

  • Parameters

    Returns void

mutePublishStreamVideo

  • Parameters

    Returns void

muteSpeaker

  • muteSpeaker(mute: boolean): void

  • Parameters

    • mute: boolean

    Returns void

off

  • off<EventType>(event: EventType, callback: ZegoEventListener[EventType]): void

  • Type parameters

    Parameters

    • event: EventType
    • callback: ZegoEventListener[EventType]

    Returns void

on

  • on<EventType>(event: EventType, callback: ZegoEventListener[EventType]): void

  • Type parameters

    Parameters

    • event: EventType
    • callback: ZegoEventListener[EventType]

    Returns void

registerAudioPlugin

  • registerAudioPlugin(type: number, plugin: number): boolean

  • Parameters

    • type: number
    • plugin: number

    Returns boolean

registerCustomAudioCapturePlugin

  • Parameters

    Returns boolean

registerVideoPlugin

  • registerVideoPlugin(type: number, plugin: number, channel?: ZegoPublishChannel): boolean

  • Parameters

    • type: number
    • plugin: number
    • Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main

    Returns boolean

removeAllLister

  • removeAllLister(): void

  • Returns void

removePublishCdnUrl

renewToken

  • renewToken(roomID: string, token: string): void

  • Parameters

    • roomID: string
    • token: string

    Returns void

sendAudioSideInfo

  • sendAudioSideInfo(data: ArrayBuffer, timeStampMs: number, channel?: ZegoPublishChannel): void

  • Parameters

    • data: ArrayBuffer
    • timeStampMs: number
    • Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main

    Returns void

sendBarrageMessage

sendBroadcastMessage

sendCustomCommand

sendSEI

  • Parameters

    • data: ArrayBuffer
    • Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main

    Returns void

setAECMode

  • Parameters

    Returns void

setANSMode

  • Parameters

    Returns void

setAllPlayStreamVolume

  • setAllPlayStreamVolume(volume: number): void

  • Parameters

    • volume: number

    Returns void

setAppOrientation

  • Parameters

    Returns void

setAppOrientationMode

setAudioCaptureStereoMode

setAudioConfig

setAudioDeviceMode

setAudioDeviceVolume

  • setAudioDeviceVolume(deviceType: ZegoAudioDeviceType, deviceID: string, volume: number): void

  • Parameters

    Returns void

setAudioEqualizerGain

  • setAudioEqualizerGain(bandIndex: number, bandGain: number): void

  • Parameters

    • bandIndex: number
    • bandGain: number

    Returns void

setAudioMixMode

  • Parameters

    Returns void

setAudioMixingVolume

  • Parameters

    Returns void

setAudioRouteToSpeaker

  • setAudioRouteToSpeaker(defaultToSpeaker: boolean): void

  • Parameters

    • defaultToSpeaker: boolean

    Returns void

setAudioSource

setCameraExposureCompensation

  • Parameters

    Returns void

setCameraExposureMode

setCameraExposurePointInPreview

  • setCameraExposurePointInPreview(x: number, y: number, channel?: ZegoPublishChannel): void

  • Parameters

    • x: number
    • y: number
    • Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main

    Returns void

setCameraFocusMode

setCameraFocusPointInPreview

  • Parameters

    • x: number
    • y: number
    • Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main

    Returns void

setCameraZoomFactor

  • Parameters

    Returns void

setCapturePipelineScaleMode

setCaptureVolume

  • setCaptureVolume(volume: number): void

  • Parameters

    • volume: number

    Returns void

setEffectsBeautyParam

setElectronicEffects

  • Parameters

    Returns void

setHeadphoneMonitorVolume

  • setHeadphoneMonitorVolume(volume: number): void

  • Parameters

    • volume: number

    Returns void

setMinVideoBitrateForTrafficControl

setMinVideoFpsForTrafficControl

  • Parameters

    Returns void

setMinVideoResolutionForTrafficControl

  • setMinVideoResolutionForTrafficControl(width: number, height: number, channel?: ZegoPublishChannel): void

  • Parameters

    • width: number
    • height: number
    • Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main

    Returns void

setPlayStreamBufferIntervalRange

  • setPlayStreamBufferIntervalRange(streamID: string, minBufferInterval: number, maxBufferInterval: number): void

  • Parameters

    • streamID: string
    • minBufferInterval: number
    • maxBufferInterval: number

    Returns void

setPlayStreamDecryptionKey

  • setPlayStreamDecryptionKey(streamID: string, key: string): void

  • Parameters

    • streamID: string
    • key: string

    Returns void

setPlayStreamVideoType

  • Parameters

    Returns void

setPlayStreamsAlignmentProperty

setPlayVolume

  • setPlayVolume(streamID: string, volume: number): void

  • Parameters

    • streamID: string
    • volume: number

    Returns void

setPublishDualStreamConfig

setPublishStreamEncryptionKey

  • Parameters

    Returns void

setPublishWatermark

  • Parameters

    Returns void

setReverbAdvancedParam

setReverbEchoParam

setReverbPreset

  • Parameters

    Returns void

setRoomExtraInfo

setRoomScenario

  • Parameters

    Returns void

setSEIConfig

  • Parameters

    Returns void

setStreamAlignmentProperty

  • Parameters

    • alignment: number
    • Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main

    Returns void

setStreamExtraInfo

setTrafficControlFocusOn

setVideoConfig

setVideoMirrorMode

setVoiceChangerParam

setVoiceChangerPreset

startAudioDataObserver

  • Parameters

    Returns void

startAudioSpectrumMonitor

  • startAudioSpectrumMonitor(millisecond: number): void

  • Parameters

    • millisecond: number

    Returns void

startAudioVADStableStateMonitor

startMixerTask

startNetworkSpeedTest

startPlayingStream

  • Parameters

    Returns void

startPreview

  • Parameters

    Returns void

startPublishingStream

  • Parameters

    Returns void

startRecordingCapturedData

startSoundLevelMonitor

stopAudioDataObserver

  • stopAudioDataObserver(): void

  • Returns void

stopAudioSpectrumMonitor

  • stopAudioSpectrumMonitor(): void

  • Returns void

stopAudioVADStableStateMonitor

stopMixerTask

stopNetworkSpeedTest

  • stopNetworkSpeedTest(): void

  • Returns void

stopPlayingStream

  • stopPlayingStream(streamID: string): void

  • Parameters

    • streamID: string

    Returns void

stopPreview

  • Parameters

    Returns void

stopPublishingStream

  • Parameters

    Returns void

stopRecordingCapturedData

  • Parameters

    Returns void

stopSoundLevelMonitor

  • stopSoundLevelMonitor(): void

  • Returns void

switchRoom

  • switchRoom(fromRoomID: string, toRoomID: string, config?: ZegoRoomConfig): void

  • Parameters

    Returns void

takePlayStreamSnapshot

takePublishStreamSnapshot

unregisterAudioPlugin

  • unregisterAudioPlugin(type: number): boolean

  • Parameters

    • type: number

    Returns boolean

unregisterCustomAudioCapturePlugin

  • Parameters

    Returns boolean

unregisterVideoPlugin

  • Parameters

    Returns boolean

updatePlayingCanvas

  • updatePlayingCanvas(streamID: string, view: ZegoView): number

  • Parameters

    Returns number

uploadLog

  • uploadLog(): void

  • Returns void

useAudioDevice

  • Parameters

    Returns void

useFrontCamera

  • Parameters

    • enable: boolean
    • Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main

    Returns void

Static createEngine

Static destroyEngine

  • destroyEngine(): Promise<void>

  • Returns Promise<void>

Static getInstance

Static getSDKVersion

  • getSDKVersion(): string

  • Returns string

Static isFeatureSupported

  • Parameters

    Returns boolean

Static setEngineConfig

  • Parameters

    Returns void

Static setLogConfig

  • Parameters

    Returns void

Static setRoomMode

  • Parameters

    Returns void

Generated using TypeDoc