Class ZegoExpressEngineImpl

Hierarchy

ZegoExpressEngineImpl

Index

Properties

Methods

Properties

Static _audioEffectPlayerMap

_audioEffectPlayerMap: Map<number, ZegoAudioEffectPlayer> = new Map<number, ZegoAudioEffectPlayer>()

Static _listeners

_listeners: Map<string, Map<any, any>> = new Map<string, Map<ZegoAnyCallback, ZegoAnyCallback>>()

Static _mediaPlayerMap

_mediaPlayerMap: Map<number, ZegoMediaPlayer> = new Map<number, ZegoMediaPlayer>()

Methods

addPublishCdnUrl

addPublishCdnUrl(streamID: string, targetURL: string): Promise<ZegoPublisherUpdateCdnUrlResult>

- Defined in impl/ZegoExpressEngineImpl.ts:253
Parameters
- streamID: string
- targetURL: string
Returns Promise<ZegoPublisherUpdateCdnUrlResult>

callExperimentalAPI

callExperimentalAPI(params: string): Promise<string>

- Defined in impl/ZegoExpressEngineImpl.ts:130
Parameters
- params: string
Returns Promise<string>

createAudioEffectPlayer

createAudioEffectPlayer(): Promise<ZegoAudioEffectPlayer | null>

- Defined in impl/ZegoExpressEngineImpl.ts:453
Returns Promise<ZegoAudioEffectPlayer | null>

createMediaPlayer

createMediaPlayer(): Promise<ZegoMediaPlayer | null>

- Defined in impl/ZegoExpressEngineImpl.ts:429
Returns Promise<ZegoMediaPlayer | null>

destroyAudioEffectPlayer

destroyAudioEffectPlayer(audioEffectPlayer: ZegoAudioEffectPlayer): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:463
Parameters
- audioEffectPlayer: ZegoAudioEffectPlayer
Returns Promise<void>

destroyMediaPlayer

destroyMediaPlayer(mediaPlayer: ZegoMediaPlayer): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:441
Parameters
- mediaPlayer: ZegoMediaPlayer
Returns Promise<void>

enableAEC

enableAEC(enable: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:381
Parameters
- enable: boolean
Returns Promise<void>

enableAGC

enableAGC(enable: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:393
Parameters
- enable: boolean
Returns Promise<void>

enableANS

enableANS(enable: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:397
Parameters
- enable: boolean
Returns Promise<void>

enableAudioCaptureDevice

enableAudioCaptureDevice(enable: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:349
Parameters
- enable: boolean
Returns Promise<void>

enableBeautify

enableBeautify(feature: number, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:405
Parameters
- feature: number
- Optional channel: ZegoPublishChannel
Returns Promise<void>

enableCamera

enableCamera(enable: boolean, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:361
Parameters
- enable: boolean
- Optional channel: ZegoPublishChannel
Returns Promise<void>

enableCustomAudioIO

enableCustomAudioIO(enable: boolean, config: ZegoCustomAudioConfig, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:421
Parameters
- enable: boolean
- config: ZegoCustomAudioConfig
- Optional channel: ZegoPublishChannel
Returns Promise<void>

enableCustomVideoProcessing

enableCustomVideoProcessing(enable: boolean, config?: ZegoCustomVideoProcessConfig, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:425
Parameters
- enable: boolean
- Optional config: ZegoCustomVideoProcessConfig
- Optional channel: ZegoPublishChannel
Returns Promise<void>

enableEffectsBeauty

enableEffectsBeauty(enable: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:489
Parameters
- enable: boolean
Returns Promise<void>

enableH265EncodeFallback

enableH265EncodeFallback(enable: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:273
Parameters
- enable: boolean
Returns Promise<void>

enableHardwareDecoder

enableHardwareDecoder(enable: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:325
Parameters
- enable: boolean
Returns Promise<void>

enableHardwareEncoder

enableHardwareEncoder(enable: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:269
Parameters
- enable: boolean
Returns Promise<void>

enableHeadphoneAEC

enableHeadphoneAEC(enable: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:385
Parameters
- enable: boolean
Returns Promise<void>

enableHeadphoneMonitor

enableHeadphoneMonitor(enable: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:377
Parameters
- enable: boolean
Returns Promise<void>

enablePublishDirectToCDN

enablePublishDirectToCDN(enable: boolean, config: ZegoCDNConfig, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:261
Parameters
- enable: boolean
- config: ZegoCDNConfig
- Default value channel: ZegoPublishChannel = ZegoPublishChannel.Main
Returns Promise<void>

getAudioConfig

getAudioConfig(): Promise<ZegoAudioConfig>

- Defined in impl/ZegoExpressEngineImpl.ts:237
Returns Promise<ZegoAudioConfig>

getAudioRouteType

getAudioRouteType(): Promise<ZegoAudioRoute>

- Defined in impl/ZegoExpressEngineImpl.ts:353
Returns Promise<ZegoAudioRoute>

getVersion

getVersion(): Promise<string>

- Defined in impl/ZegoExpressEngineImpl.ts:122
Returns Promise<string>

getVideoConfig

getVideoConfig(channel?: ZegoPublishChannel): Promise<ZegoVideoConfig>

- Defined in impl/ZegoExpressEngineImpl.ts:221
Parameters
- Optional channel: ZegoPublishChannel
Returns Promise<ZegoVideoConfig>

isMicrophoneMuted

isMicrophoneMuted(): Promise<boolean>

- Defined in impl/ZegoExpressEngineImpl.ts:337
Returns Promise<boolean>

isSpeakerMuted

isSpeakerMuted(): Promise<boolean>

- Defined in impl/ZegoExpressEngineImpl.ts:345
Returns Promise<boolean>

isVideoDecoderSupported

isVideoDecoderSupported(codecID: ZegoVideoCodecID): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:329
Parameters
- codecID: ZegoVideoCodecID
Returns Promise<void>

isVideoEncoderSupported

isVideoEncoderSupported(codecID: ZegoVideoCodecID): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:277
Parameters
- codecID: ZegoVideoCodecID
Returns Promise<void>

loginRoom

loginRoom(roomID: string, user: ZegoUser, config?: ZegoRoomConfig): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:165
Parameters
- roomID: string
- user: ZegoUser
- Optional config: ZegoRoomConfig
Returns Promise<void>

logoutRoom

logoutRoom(roomID: string): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:169
Parameters
- roomID: string
Returns Promise<void>

muteAllPlayStreamAudio

muteAllPlayStreamAudio(mute: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:317
Parameters
- mute: boolean
Returns Promise<void>

muteAllPlayStreamVideo

muteAllPlayStreamVideo(mute: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:321
Parameters
- mute: boolean
Returns Promise<void>

muteMicrophone

muteMicrophone(mute: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:333
Parameters
- mute: boolean
Returns Promise<void>

mutePlayStreamAudio

mutePlayStreamAudio(streamID: string, mute: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:309
Parameters
- streamID: string
- mute: boolean
Returns Promise<void>

mutePlayStreamVideo

mutePlayStreamVideo(streamID: string, mute: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:313
Parameters
- streamID: string
- mute: boolean
Returns Promise<void>

mutePublishStreamAudio

mutePublishStreamAudio(mute: boolean, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:241
Parameters
- mute: boolean
- Optional channel: ZegoPublishChannel
Returns Promise<void>

mutePublishStreamVideo

mutePublishStreamVideo(mute: boolean, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:245
Parameters
- mute: boolean
- Optional channel: ZegoPublishChannel
Returns Promise<void>

muteSpeaker

muteSpeaker(mute: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:341
Parameters
- mute: boolean
Returns Promise<void>

off

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

- Defined in impl/ZegoExpressEngineImpl.ts:151
Type parameters
- EventType: keyof ZegoEventListener
Parameters
- event: EventType
- Optional callback: ZegoEventListener[EventType]
Returns void

on

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

- Defined in impl/ZegoExpressEngineImpl.ts:134
Type parameters
- EventType: keyof ZegoEventListener
Parameters
- event: EventType
- callback: ZegoEventListener[EventType]
Returns void

removePublishCdnUrl

removePublishCdnUrl(streamID: string, targetURL: string): Promise<ZegoPublisherUpdateCdnUrlResult>

- Defined in impl/ZegoExpressEngineImpl.ts:257
Parameters
- streamID: string
- targetURL: string
Returns Promise<ZegoPublisherUpdateCdnUrlResult>

renewToken

renewToken(roomID: string, token: string): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:177
Parameters
- roomID: string
- token: string
Returns Promise<void>

sendBarrageMessage

sendBarrageMessage(roomID: string, message: string): Promise<ZegoIMSendBarrageMessageResult>

- Defined in impl/ZegoExpressEngineImpl.ts:193
Parameters
- roomID: string
- message: string
Returns Promise<ZegoIMSendBarrageMessageResult>

sendBroadcastMessage

sendBroadcastMessage(roomID: string, message: string): Promise<ZegoIMSendBroadcastMessageResult>

- Defined in impl/ZegoExpressEngineImpl.ts:189
Parameters
- roomID: string
- message: string
Returns Promise<ZegoIMSendBroadcastMessageResult>

sendCustomCommand

sendCustomCommand(roomID: string, command: string, toUserList?: ZegoUser[]): Promise<ZegoIMSendCustomCommandResult>

- Defined in impl/ZegoExpressEngineImpl.ts:197
Parameters
- roomID: string
- command: string
- Optional toUserList: ZegoUser[]
Returns Promise<ZegoIMSendCustomCommandResult>

sendSEI

sendSEI(data: Uint8Array, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:265
Parameters
- data: Uint8Array
- Optional channel: ZegoPublishChannel
Returns Promise<void>

setAECMode

setAECMode(mode: ZegoAECMode): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:389
Parameters
- mode: ZegoAECMode
Returns Promise<void>

setANSMode

setANSMode(mode: ZegoANSMode): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:401
Parameters
- mode: ZegoANSMode
Returns Promise<void>

setAllPlayStreamVolume

setAllPlayStreamVolume(volume: number): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:293
Parameters
- volume: number
Returns Promise<void>

setAppOrientation

setAppOrientation(mode: ZegoOrientation, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:229
Parameters
- mode: ZegoOrientation
- Optional channel: ZegoPublishChannel
Returns Promise<void>

setAudioConfig

setAudioConfig(config: ZegoAudioConfig): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:233
Parameters
- config: ZegoAudioConfig
Returns Promise<void>

setAudioEqualizerGain

setAudioEqualizerGain(bandIndex: number, bandGain: number): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:505
Parameters
- bandIndex: number
- bandGain: number
Returns Promise<void>

setAudioRouteToSpeaker

setAudioRouteToSpeaker(defaultToSpeaker: boolean): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:357
Parameters
- defaultToSpeaker: boolean
Returns Promise<void>

setBeautifyOption

setBeautifyOption(option: ZegoBeautifyOption, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:409
Parameters
- option: ZegoBeautifyOption
- Optional channel: ZegoPublishChannel
Returns Promise<void>

setCaptureVolume

setCaptureVolume(volume: number): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:249
Parameters
- volume: number
Returns Promise<void>

setEffectsBeautyParam

setEffectsBeautyParam(param: ZegoEffectsBeautyParam): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:493
Parameters
- param: ZegoEffectsBeautyParam
Returns Promise<void>

setElectronicEffects

setElectronicEffects(enable: boolean, mode: ZegoElectronicEffectsMode, tonal: number): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:521
Parameters
- enable: boolean
- mode: ZegoElectronicEffectsMode
- tonal: number
Returns Promise<void>

setPlayStreamVideoType

setPlayStreamVideoType(streamID: string, streamType: ZegoVideoStreamType): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:297
Parameters
- streamID: string
- streamType: ZegoVideoStreamType
Returns Promise<void>

setPlayVolume

setPlayVolume(streamID: string, volume: number): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:289
Parameters
- streamID: string
- volume: number
Returns Promise<void>

setReverbAdvancedParam

setReverbAdvancedParam(param: ZegoReverbAdvancedParam): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:513
Parameters
- param: ZegoReverbAdvancedParam
Returns Promise<void>

setReverbEchoParam

setReverbEchoParam(param: ZegoReverbEchoParam): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:517
Parameters
- param: ZegoReverbEchoParam
Returns Promise<void>

setReverbPreset

setReverbPreset(preset: ZegoReverbPreset): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:509
Parameters
- preset: ZegoReverbPreset
Returns Promise<void>

setRoomExtraInfo

setRoomExtraInfo(roomID: string, key: string, value: string): Promise<ZegoRoomSetRoomExtraInfoResult>

- Defined in impl/ZegoExpressEngineImpl.ts:181
Parameters
- roomID: string
- key: string
- value: string
Returns Promise<ZegoRoomSetRoomExtraInfoResult>

setStreamExtraInfo

setStreamExtraInfo(extraInfo: string, channel?: ZegoPublishChannel): Promise<ZegoPublisherSetStreamExtraInfoResult>

- Defined in impl/ZegoExpressEngineImpl.ts:185
Parameters
- extraInfo: string
- Default value channel: ZegoPublishChannel = ZegoPublishChannel.Main
Returns Promise<ZegoPublisherSetStreamExtraInfoResult>

setVideoConfig

setVideoConfig(config: ZegoVideoConfig, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:217
Parameters
- config: ZegoVideoConfig
- Optional channel: ZegoPublishChannel
Returns Promise<void>

setVideoMirrorMode

setVideoMirrorMode(mode: ZegoVideoMirrorMode, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:225
Parameters
- mode: ZegoVideoMirrorMode
- Optional channel: ZegoPublishChannel
Returns Promise<void>

setVoiceChangerParam

setVoiceChangerParam(param: ZegoVoiceChangerParam): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:501
Parameters
- param: ZegoVoiceChangerParam
Returns Promise<void>

setVoiceChangerPreset

setVoiceChangerPreset(preset: ZegoVoiceChangerPreset): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:497
Parameters
- preset: ZegoVoiceChangerPreset
Returns Promise<void>

startEffectsEnv

startEffectsEnv(): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:481
Returns Promise<void>

startMixerTask

startMixerTask(task: ZegoMixerTask): Promise<ZegoMixerStartResult>

- Defined in impl/ZegoExpressEngineImpl.ts:473
Parameters
- task: ZegoMixerTask
Returns Promise<ZegoMixerStartResult>

startNetworkSpeedTest

startNetworkSpeedTest(config: ZegoNetworkSpeedTestConfig, interval?: number): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:413
Parameters
- config: ZegoNetworkSpeedTestConfig
- Default value interval: number = 3000
Returns Promise<void>

startPlayingStream

startPlayingStream(streamID: string, view?: ZegoView, config?: ZegoPlayerConfig): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:281
Parameters
- streamID: string
- Optional view: ZegoView
- Optional config: ZegoPlayerConfig
Returns Promise<void>

startPreview

startPreview(view?: ZegoView, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:209
Parameters
- Optional view: ZegoView
- Optional channel: ZegoPublishChannel
Returns Promise<void>

startPublishingStream

startPublishingStream(streamID: string, channel?: ZegoPublishChannel, config?: ZegoPublisherConfig): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:201
Parameters
- streamID: string
- Optional channel: ZegoPublishChannel
- Optional config: ZegoPublisherConfig
Returns Promise<void>

startSoundLevelMonitor

startSoundLevelMonitor(): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:369
Returns Promise<void>

stopEffectsEnv

stopEffectsEnv(): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:485
Returns Promise<void>

stopMixerTask

stopMixerTask(task: ZegoMixerTask): Promise<ZegoMixerStopResult>

- Defined in impl/ZegoExpressEngineImpl.ts:477
Parameters
- task: ZegoMixerTask
Returns Promise<ZegoMixerStopResult>

stopNetworkSpeedTest

stopNetworkSpeedTest(): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:417
Returns Promise<void>

stopPlayingStream

stopPlayingStream(streamID: string): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:285
Parameters
- streamID: string
Returns Promise<void>

stopPreview

stopPreview(channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:213
Parameters
- Optional channel: ZegoPublishChannel
Returns Promise<void>

stopPublishingStream

stopPublishingStream(channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:205
Parameters
- Optional channel: ZegoPublishChannel
Returns Promise<void>

stopSoundLevelMonitor

stopSoundLevelMonitor(): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:373
Returns Promise<void>

switchRoom

switchRoom(fromRoomID: string, toRoomID: string): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:173
Parameters
- fromRoomID: string
- toRoomID: string
Returns Promise<void>

takePlayStreamSnapshot

takePlayStreamSnapshot(streamID: string): Promise<ZegoPlayerTakeSnapshotResult>

- Defined in impl/ZegoExpressEngineImpl.ts:305
Parameters
- streamID: string
Returns Promise<ZegoPlayerTakeSnapshotResult>

takePublishStreamSnapshot

takePublishStreamSnapshot(channel?: ZegoPublishChannel): Promise<ZegoPublisherTakeSnapshotResult>

- Defined in impl/ZegoExpressEngineImpl.ts:301
Parameters
- Default value channel: ZegoPublishChannel = ZegoPublishChannel.Main
Returns Promise<ZegoPublisherTakeSnapshotResult>

uploadLog

uploadLog(): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:126
Returns Promise<void>

useFrontCamera

useFrontCamera(enable: boolean, channel?: ZegoPublishChannel): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:365
Parameters
- enable: boolean
- Optional channel: ZegoPublishChannel
Returns Promise<void>

Static createEngine

createEngine(appID: number, appSign: string, isTestEnv: boolean, scenario: ZegoScenario): Promise<ZegoExpressEngineImpl>

- Defined in impl/ZegoExpressEngineImpl.ts:78
Parameters
- appID: number
- appSign: string
- isTestEnv: boolean
- scenario: ZegoScenario
Returns Promise<ZegoExpressEngineImpl>

Static createEngineWithProfile

createEngineWithProfile(profile: ZegoEngineProfile): Promise<ZegoExpressEngineImpl>

- Defined in impl/ZegoExpressEngineImpl.ts:89
Parameters
- profile: ZegoEngineProfile
Returns Promise<ZegoExpressEngineImpl>

Static destroyEngine

destroyEngine(): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:99
Returns Promise<void>

Static getInstance

getInstance(): ZegoExpressEngineImpl

- Defined in impl/ZegoExpressEngineImpl.ts:70
Returns ZegoExpressEngineImpl

Static setEngineConfig

setEngineConfig(config: ZegoEngineConfig): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:114
Parameters
- config: ZegoEngineConfig
Returns Promise<void>

Static setRoomMode

setRoomMode(mode: ZegoRoomMode): Promise<void>

- Defined in impl/ZegoExpressEngineImpl.ts:118
Parameters
- mode: ZegoRoomMode
Returns Promise<void>

Generated using TypeDoc