Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ZegoExpressEngineImpl

Index

Properties

Methods

Properties

Static _listeners

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

Static _mediaPlayerMap

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

Methods

addPublishCdnUrl

callExperimentalAPI

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

    • params: string

    Returns Promise<string>

createMediaPlayer

  • Returns Promise<ZegoMediaPlayer | undefined>

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>

enableCamera

  • Parameters

    Returns Promise<void>

enableCheckPoc

  • enableCheckPoc(enable: boolean): Promise<void>
  • Parameters

    • enable: boolean

    Returns Promise<void>

enableEffectsBeauty

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

  • Parameters

    Returns Promise<void>

enableTorch

  • Parameters

    Returns Promise<void>

enableTrafficControl

enableTransientANS

  • enableTransientANS(enable: boolean): Promise<void>
  • Parameters

    • enable: boolean

    Returns Promise<void>

enableVirtualStereo

  • enableVirtualStereo(enable: boolean, angle: number): Promise<void>
  • Parameters

    • enable: boolean
    • angle: number

    Returns Promise<void>

getAudioConfig

getAudioRouteType

  • Returns Promise<ZegoAudioRoute>

getCameraMaxZoomFactor

  • Parameters

    Returns Promise<number>

getVideoConfig

isMicrophoneMuted

  • isMicrophoneMuted(): Promise<boolean>
  • Returns Promise<boolean>

isSpeakerMuted

  • isSpeakerMuted(): Promise<boolean>
  • Returns Promise<boolean>

loginMultiRoom

  • loginMultiRoom(roomID: string, config: ZegoRoomConfig): Promise<void>
  • Parameters

    Returns Promise<void>

loginRoom

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

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

setCaptureVolume

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

    • volume: number

    Returns Promise<void>

setDummyCaptureImagePath

  • Parameters

    Returns Promise<void>

setEffectsBeautyParam

setHeadphoneMonitorVolume

  • setHeadphoneMonitorVolume(volume: number): Promise<void>
  • Parameters

    • volume: number

    Returns Promise<void>

setMinVideoBitrateForTrafficControl

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

    • streamID: string

    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

    Returns Promise<void>

setRoomExtraInfo

setStreamExtraInfo

setVideoConfig

setVideoMirrorMode

setVoiceChangerParam

startAudioSpectrumMonitor

  • startAudioSpectrumMonitor(millisecond: number): Promise<void>
  • Parameters

    • millisecond: number

    Returns Promise<void>

startAutoMixerTask

startEffectsEnv

  • startEffectsEnv(): Promise<void>
  • Returns Promise<void>

startMixerTask

startPlayingStream

  • startPlayingStream(streamID: string, config?: ZegoPlayerConfig): Promise<void>
  • Parameters

    Returns Promise<void>

startPreview

  • Parameters

    Returns Promise<void>

startPublishingStream

  • Parameters

    Returns Promise<void>

startRecordingCapturedData

startScreenCapture

  • startScreenCapture(): Promise<void>
  • Returns Promise<void>

startSoundLevelMonitor

  • Parameters

    Returns Promise<void>

stopAudioSpectrumMonitor

  • stopAudioSpectrumMonitor(): Promise<void>
  • Returns Promise<void>

stopAutoMixerTask

stopEffectsEnv

  • stopEffectsEnv(): Promise<void>
  • Returns Promise<void>

stopMixerTask

stopPlayingStream

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

    • streamID: string

    Returns Promise<void>

stopPreview

  • Parameters

    Returns Promise<void>

stopPublishingStream

  • Parameters

    Returns Promise<void>

stopRecordingCapturedData

  • 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

    Returns Promise<void>

takePlayStreamSnapshot

takePublishStreamSnapshot

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

    • T

    Parameters

    • method: string
    • Optional args: undefined | {}

    Returns Promise<T>

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 setLogConfig

  • Parameters

    Returns Promise<void>

Static setRoomMode

  • Parameters

    Returns Promise<void>

Generated using TypeDoc