Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ZegoExpressEngineImpl

Hierarchy

  • ZegoExpressEngineImpl

Index

Properties

Methods

Properties

Static _audioEffectPlayerMap

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

Static _listeners

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

Static _mediaPlayerMap

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

Methods

addPublishCdnUrl

callExperimentalAPI

  • callExperimentalAPI(params: string): Promise<string>

  • Parameters

    • params: string

    Returns Promise<string>

createAudioEffectPlayer

createMediaPlayer

  • Returns Promise<ZegoMediaPlayer | null>

destroyAudioEffectPlayer

  • Parameters

    Returns Promise<void>

destroyMediaPlayer

  • Parameters

    Returns Promise<void>

enableAEC

  • enableAEC(enable: boolean): Promise<void>

  • Parameters

    • enable: boolean

    Returns Promise<void>

enableAGC

  • enableAGC(enable: boolean): Promise<void>

  • Parameters

    • enable: boolean

    Returns Promise<void>

enableANS

  • enableANS(enable: boolean): Promise<void>

  • Parameters

    • enable: boolean

    Returns Promise<void>

enableAudioCaptureDevice

  • enableAudioCaptureDevice(enable: boolean): Promise<void>

  • Parameters

    • enable: boolean

    Returns Promise<void>

enableBeautify

  • Parameters

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

    Returns Promise<void>

enableCamera

  • Parameters

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

    Returns Promise<void>

enableCustomAudioIO

  • Parameters

    Returns Promise<void>

enableCustomVideoProcessing

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

  • Parameters

    • enable: boolean
    • Optional config: zego.ZegoCustomVideoProcessConfig
    • Optional channel: zego.ZegoPublishChannel

    Returns Promise<void>

enableEffectsBeauty

  • enableEffectsBeauty(enable: boolean): Promise<void>

  • Parameters

    • enable: boolean

    Returns Promise<void>

enableH265EncodeFallback

  • enableH265EncodeFallback(enable: boolean): Promise<void>

  • Parameters

    • enable: boolean

    Returns Promise<void>

enableHardwareDecoder

  • enableHardwareDecoder(enable: boolean): Promise<void>

  • Parameters

    • enable: boolean

    Returns Promise<void>

enableHardwareEncoder

  • enableHardwareEncoder(enable: boolean): Promise<void>

  • Parameters

    • enable: boolean

    Returns Promise<void>

enableHeadphoneAEC

  • enableHeadphoneAEC(enable: boolean): Promise<void>

  • Parameters

    • enable: boolean

    Returns Promise<void>

enableHeadphoneMonitor

  • enableHeadphoneMonitor(enable: boolean): Promise<void>

  • Parameters

    • enable: boolean

    Returns Promise<void>

enablePublishDirectToCDN

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

  • Parameters

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

    Returns Promise<void>

getAudioConfig

  • Parameters

    Returns Promise<ZegoAudioConfig>

getAudioRouteType

  • Returns Promise<ZegoAudioRoute>

getNetworkTimeInfo

getVersion

  • getVersion(): Promise<string>

  • Returns Promise<string>

getVideoConfig

  • Parameters

    Returns Promise<ZegoVideoConfig>

isMicrophoneMuted

  • isMicrophoneMuted(): Promise<boolean>

  • Returns Promise<boolean>

isSpeakerMuted

  • isSpeakerMuted(): Promise<boolean>

  • Returns Promise<boolean>

isVideoDecoderSupported

  • Parameters

    Returns Promise<boolean>

isVideoEncoderSupported

  • Parameters

    Returns Promise<boolean>

loginRoom

  • Parameters

    • roomID: string
    • user: ZegoUser
    • Optional config: zego.ZegoRoomConfig

    Returns Promise<ZegoRoomLoginResult>

logoutRoom

  • Parameters

    • Optional roomID: undefined | string

    Returns Promise<ZegoRoomLogoutResult>

muteAllPlayStreamAudio

  • muteAllPlayStreamAudio(mute: boolean): Promise<void>

  • Parameters

    • mute: boolean

    Returns Promise<void>

muteAllPlayStreamVideo

  • muteAllPlayStreamVideo(mute: boolean): Promise<void>

  • Parameters

    • mute: boolean

    Returns Promise<void>

muteMicrophone

  • muteMicrophone(mute: boolean): Promise<void>

  • Parameters

    • mute: boolean

    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

    • mute: boolean

    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

renewToken

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

  • Parameters

    • roomID: string
    • token: string

    Returns Promise<void>

sendBarrageMessage

sendBroadcastMessage

sendCustomCommand

sendSEI

  • Parameters

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

    Returns Promise<void>

setAECMode

  • Parameters

    Returns Promise<void>

setANSMode

  • Parameters

    Returns Promise<void>

setAllPlayStreamVolume

  • setAllPlayStreamVolume(volume: number): Promise<void>

  • Parameters

    • volume: number

    Returns Promise<void>

setAppOrientation

  • Parameters

    Returns Promise<void>

setAudioConfig

  • Parameters

    Returns Promise<void>

setAudioEqualizerGain

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

  • Parameters

    • bandIndex: number
    • bandGain: number

    Returns Promise<void>

setAudioRouteToSpeaker

  • setAudioRouteToSpeaker(defaultToSpeaker: boolean): Promise<void>

  • Parameters

    • defaultToSpeaker: boolean

    Returns Promise<void>

setAudioSource

  • Parameters

    Returns Promise<number>

setBeautifyOption

  • Parameters

    Returns Promise<void>

setCaptureVolume

  • setCaptureVolume(volume: number): Promise<void>

  • Parameters

    • volume: number

    Returns Promise<void>

setEffectsBeautyParam

  • Parameters

    Returns Promise<void>

setElectronicEffects

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

setReverbAdvancedParam

setReverbEchoParam

  • Parameters

    Returns Promise<void>

setReverbPreset

  • Parameters

    Returns Promise<void>

setRoomExtraInfo

  • Parameters

    • roomID: string
    • key: string
    • value: string

    Returns Promise<ZegoRoomSetRoomExtraInfoResult>

setStreamExtraInfo

setVideoConfig

  • Parameters

    Returns Promise<void>

setVideoMirrorMode

setVideoSource

  • Parameters

    Returns Promise<number>

setVoiceChangerParam

  • Parameters

    Returns Promise<void>

setVoiceChangerPreset

  • Parameters

    Returns Promise<void>

startEffectsEnv

  • startEffectsEnv(): Promise<void>

  • Returns Promise<void>

startMixerTask

startNetworkSpeedTest

  • Parameters

    Returns Promise<void>

startPlayingStream

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

  • Parameters

    • streamID: string
    • Optional view: zego.ZegoView
    • Optional config: zego.ZegoPlayerConfig

    Returns Promise<void>

startPreview

  • Parameters

    • Optional view: zego.ZegoView
    • Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main

    Returns Promise<void>

startPublishingStream

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

  • Parameters

    • streamID: string
    • Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
    • Optional config: zego.ZegoPublisherConfig

    Returns Promise<void>

startScreenCapture

  • startScreenCapture(config?: zego.ZegoScreenCaptureConfig): Promise<void>

  • Parameters

    • Optional config: zego.ZegoScreenCaptureConfig

    Returns Promise<void>

startScreenCaptureInApp

  • startScreenCaptureInApp(config?: zego.ZegoScreenCaptureConfig): Promise<void>

  • Parameters

    • Optional config: zego.ZegoScreenCaptureConfig

    Returns Promise<void>

startSoundLevelMonitor

  • startSoundLevelMonitor(config?: zego.ZegoSoundLevelConfig): Promise<void>

  • Parameters

    • Optional config: zego.ZegoSoundLevelConfig

    Returns Promise<void>

stopEffectsEnv

  • stopEffectsEnv(): Promise<void>

  • Returns Promise<void>

stopMixerTask

stopNetworkSpeedTest

  • stopNetworkSpeedTest(): Promise<void>

  • Returns Promise<void>

stopPlayingStream

  • stopPlayingStream(streamID: string): Promise<void>

  • Parameters

    • streamID: string

    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?: zego.ZegoRoomConfig): Promise<void>

  • Parameters

    • fromRoomID: string
    • toRoomID: string
    • Optional config: zego.ZegoRoomConfig

    Returns Promise<void>

takePlayStreamSnapshot

takePublishStreamSnapshot

updateScreenCaptureConfig

  • Parameters

    Returns Promise<void>

uploadLog

  • uploadLog(): Promise<void>

  • Returns Promise<void>

useFrontCamera

  • Parameters

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

    Returns Promise<void>

Static createEngine

  • Parameters

    • appID: number
    • appSign: string
    • isTestEnv: boolean
    • scenario: ZegoScenario

    Returns Promise<ZegoExpressEngineImpl>

Static createEngineWithProfile

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 setRoomMode

  • Parameters

    Returns Promise<void>

Generated using TypeDoc