Class ZegoExpressEngineImpl
Properties
Static _listeners
Static _mediaPlayerMap
_media
PlayerMap: Map<number, ZegoMediaPlayer> = new Map<number, ZegoMediaPlayer>()Methods
addPublishCdnUrl
-
Parameters
-
targetURL: string
-
streamID: string
callExperimentalAPI
- callExperimentalAPI(params: string): Promise<string>
-
Parameters
Returns Promise<string>
createMediaPlayer
-
destroyMediaPlayer
-
Parameters
Returns Promise<void>
enableAEC
- enableAEC(enable: boolean): Promise<void>
-
Parameters
Returns Promise<void>
enableAGC
- enableAGC(enable: boolean): Promise<void>
-
Parameters
Returns Promise<void>
enableANS
- enableANS(enable: boolean): Promise<void>
-
Parameters
Returns Promise<void>
enableAudioCaptureDevice
- enableAudioCaptureDevice(enable: boolean): Promise<void>
-
Parameters
Returns Promise<void>
enableCamera
-
Parameters
Returns Promise<void>
enableCheckPoc
- enableCheckPoc(enable: boolean): Promise<void>
-
Parameters
Returns Promise<void>
enableEffectsBeauty
- enableEffectsBeauty(enable: boolean): Promise<void>
-
Parameters
Returns Promise<void>
enableHardwareDecoder
- enableHardwareDecoder(enable: boolean): Promise<void>
-
Parameters
Returns Promise<void>
enableHardwareEncoder
- enableHardwareEncoder(enable: boolean): Promise<void>
-
Parameters
Returns Promise<void>
enableHeadphoneAEC
- enableHeadphoneAEC(enable: boolean): Promise<void>
-
Parameters
Returns Promise<void>
enableHeadphoneMonitor
- enableHeadphoneMonitor(enable: boolean): Promise<void>
-
Parameters
Returns Promise<void>
enablePublishDirectToCDN
-
Parameters
Returns Promise<void>
enableTrafficControl
-
Parameters
Returns Promise<void>
enableTransientANS
- enableTransientANS(enable: boolean): Promise<void>
-
Parameters
Returns Promise<void>
enableVirtualStereo
- enableVirtualStereo(enable: boolean, angle: number): Promise<void>
-
Parameters
-
enable: boolean
-
angle: number
Returns Promise<void>
getAudioConfig
-
Parameters
getAudioRouteType
-
getCameraMaxZoomFactor
-
Parameters
Returns Promise<number>
getVideoConfig
-
Parameters
isMicrophoneMuted
- isMicrophoneMuted(): Promise<boolean>
-
Returns Promise<boolean>
isSpeakerMuted
- isSpeakerMuted(): Promise<boolean>
-
Returns Promise<boolean>
loginMultiRoom
-
Parameters
Returns Promise<void>
loginRoom
-
Parameters
Returns Promise<void>
logoutRoom
- logoutRoom(roomID?: undefined | string): Promise<void>
-
Parameters
-
Optional roomID: undefined | string
Returns Promise<void>
muteAllPlayStreamAudio
- muteAllPlayStreamAudio(mute: boolean): Promise<void>
-
Parameters
Returns Promise<void>
muteAllPlayStreamVideo
- muteAllPlayStreamVideo(mute: boolean): Promise<void>
-
Parameters
Returns Promise<void>
muteMicrophone
- muteMicrophone(mute: boolean): Promise<void>
-
Parameters
Returns Promise<void>
mutePlayStreamAudio
- mutePlayStreamAudio(streamID: string, mute: boolean): Promise<void>
-
Parameters
-
streamID: string
-
mute: boolean
Returns Promise<void>
mutePlayStreamVideo
- mutePlayStreamVideo(streamID: string, mute: boolean): Promise<void>
-
Parameters
-
streamID: string
-
mute: boolean
Returns Promise<void>
mutePublishStreamAudio
-
Parameters
Returns Promise<void>
mutePublishStreamVideo
-
Parameters
Returns Promise<void>
muteSpeaker
- muteSpeaker(mute: boolean): Promise<void>
-
Parameters
Returns Promise<void>
off
- off<EventType>(event: EventType, callback?: ZegoEventListener[EventType]): void
-
Type parameters
Parameters
-
event: EventType
-
Optional callback: ZegoEventListener[EventType]
Returns void
on
- on<EventType>(event: EventType, callback: ZegoEventListener[EventType]): void
-
Type parameters
Parameters
-
event: EventType
-
callback: ZegoEventListener[EventType]
Returns void
removePublishCdnUrl
-
Parameters
-
targetURL: string
-
streamID: string
renewToken
- renewToken(roomID: string, token: string): Promise<void>
-
Parameters
-
roomID: string
-
token: string
Returns Promise<void>
sendBarrageMessage
-
Parameters
-
roomID: string
-
message: string
sendBroadcastMessage
-
Parameters
-
roomID: string
-
message: string
sendCustomCommand
-
Parameters
-
roomID: string
-
command: string
-
Optional toUserList: ZegoUser[]
sendSEI
-
Parameters
Returns Promise<void>
setAECMode
-
Parameters
Returns Promise<void>
setANSMode
-
Parameters
Returns Promise<void>
setAllPlayStreamVolume
- setAllPlayStreamVolume(volume: number): Promise<void>
-
Parameters
Returns Promise<void>
setAppOrientation
-
Parameters
Returns Promise<void>
setAudioCaptureStereoMode
-
Parameters
Returns Promise<void>
setAudioConfig
-
Parameters
Returns Promise<void>
setAudioEqualizerGain
- setAudioEqualizerGain(bandGain: number, bandIndex: number): Promise<void>
-
Parameters
-
bandGain: number
-
bandIndex: number
Returns Promise<void>
setAudioRouteToSpeaker
- setAudioRouteToSpeaker(defaultToSpeaker: boolean): Promise<void>
-
Parameters
-
defaultToSpeaker: boolean
Returns Promise<void>
setCameraZoomFactor
-
Parameters
Returns Promise<void>
setCapturePipelineScaleMode
-
Parameters
Returns Promise<void>
setCaptureVolume
- setCaptureVolume(volume: number): Promise<void>
-
Parameters
Returns Promise<void>
setDummyCaptureImagePath
-
Parameters
Returns Promise<void>
setEffectsBeautyParam
-
Parameters
Returns Promise<void>
setHeadphoneMonitorVolume
- setHeadphoneMonitorVolume(volume: number): Promise<void>
-
Parameters
Returns Promise<void>
setMinVideoBitrateForTrafficControl
-
Parameters
Returns Promise<void>
setPlayStreamBufferIntervalRange
- setPlayStreamBufferIntervalRange(streamID: string, minBufferInterval: number, maxBufferInterval: number): Promise<void>
-
Parameters
-
streamID: string
-
minBufferInterval: number
-
maxBufferInterval: number
Returns Promise<void>
setPlayStreamDecryptionKey
- setPlayStreamDecryptionKey(key: string, streamID: string): Promise<void>
-
Parameters
-
key: string
-
streamID: string
Returns Promise<void>
setPlayStreamFocusOn
- setPlayStreamFocusOn(streamID: string): Promise<void>
-
Parameters
Returns Promise<void>
setPlayStreamVideoType
-
Parameters
Returns Promise<void>
setPlayVolume
- setPlayVolume(streamID: string, volume: number): Promise<void>
-
Parameters
-
streamID: string
-
volume: number
Returns Promise<void>
setPublishStreamEncryptionKey
-
Parameters
Returns Promise<void>
setPublishWatermark
-
Parameters
-
-
isPreviewVisible: boolean
-
Default value channel: ZegoPublishChannel = ZegoPublishChannel.Main
Returns Promise<void>
setReverbAdvancedParam
-
Parameters
Returns Promise<void>
setReverbEchoParam
-
Parameters
Returns Promise<void>
setReverbPreset
-
Parameters
Returns Promise<void>
setRoomExtraInfo
-
Parameters
-
roomID: string
-
key: string
-
value: string
setSEIConfig
-
Parameters
Returns Promise<void>
setStreamExtraInfo
-
Parameters
setTrafficControlFocusOn
-
Parameters
Returns Promise<void>
setVideoConfig
-
Parameters
Returns Promise<void>
setVideoMirrorMode
-
Parameters
Returns Promise<void>
setVideoSource
-
Parameters
Returns Promise<void>
setVoiceChangerParam
-
Parameters
Returns Promise<void>
setVoiceChangerPreset
-
Parameters
Returns Promise<void>
startAudioSpectrumMonitor
- startAudioSpectrumMonitor(millisecond: number): Promise<void>
-
Parameters
Returns Promise<void>
startAutoMixerTask
-
Parameters
startEffectsEnv
- startEffectsEnv(): Promise<void>
-
Returns Promise<void>
startMixerTask
-
Parameters
startPlayingStream
-
Parameters
Returns Promise<void>
startPreview
-
Parameters
Returns Promise<void>
startPublishingStream
-
Parameters
Returns Promise<void>
startScreenCapture
- startScreenCapture(): Promise<void>
-
Returns Promise<void>
startSoundLevelMonitor
-
Parameters
Returns Promise<void>
stopAudioSpectrumMonitor
- stopAudioSpectrumMonitor(): Promise<void>
-
Returns Promise<void>
stopAutoMixerTask
-
Parameters
stopEffectsEnv
- stopEffectsEnv(): Promise<void>
-
Returns Promise<void>
stopMixerTask
-
Parameters
stopPlayingStream
- stopPlayingStream(streamID: string): Promise<void>
-
Parameters
Returns Promise<void>
stopPreview
-
Parameters
Returns Promise<void>
stopPublishingStream
-
Parameters
Returns Promise<void>
stopScreenCapture
- stopScreenCapture(): Promise<void>
-
Returns Promise<void>
stopSoundLevelMonitor
- stopSoundLevelMonitor(): Promise<void>
-
Returns Promise<void>
switchRoom
- switchRoom(fromRoomID: string, toRoomID: string, config?: ZegoRoomConfig): Promise<void>
-
Parameters
-
fromRoomID: string
-
toRoomID: string
-
Returns Promise<void>
takePlayStreamSnapshot
-
Parameters
takePublishStreamSnapshot
-
Parameters
uploadLog
- uploadLog(): Promise<void>
-
Returns Promise<void>
useFrontCamera
-
Parameters
Returns Promise<void>
Static Private _callMethod
- _callMethod<T>(method: string, args?: undefined | {}): Promise<T>
-
Type parameters
Parameters
-
method: string
-
Optional args: undefined | {}
Returns Promise<T>
Static createEngine
-
Parameters
-
appID: number
-
appSign: string
-
isTestEnv: boolean
-
Static createEngineWithProfile
-
Parameters
Static destroyEngine
- destroyEngine(): Promise<void>
-
Returns Promise<void>
Static getInstance
-
Static getVersion
- getVersion(): Promise<string>
-
Returns Promise<string>
Static setEngineConfig
-
Parameters
Returns Promise<void>
Static setLogConfig
-
Parameters
Returns Promise<void>
Static setRoomMode
-
Parameters
Returns Promise<void>