Class ZegoExpressEngineImpl

Hierarchy

ZegoExpressEngineImpl

Index

Constructors

constructor

Methods

Constructors

constructor

new ZegoExpressEngineImpl(): ZegoExpressEngineImpl

- Defined in ZegoExpressEngineImpl.ts:28
Returns ZegoExpressEngineImpl

Methods

addPublishCdnUrl

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

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

callEmit

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

- Defined in ZegoExpressEngineImpl.ts:1684
Parameters
- Rest ...args: any[]
Returns void

callExperimentalAPI

callExperimentalAPI(param: string): string

- Defined in ZegoExpressEngineImpl.ts:1019
Parameters
- param: string
Returns string

createAudioEffectPlayer

createAudioEffectPlayer(): ZegoAudioEffectPlayer | null

- Defined in ZegoExpressEngineImpl.ts:269
Returns ZegoAudioEffectPlayer | null

createCopyrightedMusic

createCopyrightedMusic(): ZegoCopyrightedMusic | null

- Defined in ZegoExpressEngineImpl.ts:359
Returns ZegoCopyrightedMusic | null

createMediaPlayer

createMediaPlayer(): ZegoMediaPlayer | null

- Defined in ZegoExpressEngineImpl.ts:211
Returns ZegoMediaPlayer | null

createRangeAudio

createRangeAudio(): ZegoRangeAudio | null

- Defined in ZegoExpressEngineImpl.ts:314
Returns ZegoRangeAudio | null

destroyAudioEffectPlayer

destroyAudioEffectPlayer(player: ZegoAudioEffectPlayer): void

- Defined in ZegoExpressEngineImpl.ts:295
Parameters
- player: ZegoAudioEffectPlayer
Returns void

destroyCopyrightedMusic

destroyCopyrightedMusic(copyrightedMusic: ZegoCopyrightedMusic): void

- Defined in ZegoExpressEngineImpl.ts:385
Parameters
- copyrightedMusic: ZegoCopyrightedMusic
Returns void

destroyMediaPlayer

destroyMediaPlayer(player: ZegoMediaPlayer): void

- Defined in ZegoExpressEngineImpl.ts:238
Parameters
- player: ZegoMediaPlayer
Returns void

destroyRangeAudio

destroyRangeAudio(rangeAudio: ZegoRangeAudio): void

- Defined in ZegoExpressEngineImpl.ts:340
Parameters
- rangeAudio: ZegoRangeAudio
Returns void

emit

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

- Defined in ZegoExpressEngineImpl.ts:1648
Parameters
- eventName: string
- Rest ...args: any[]
Returns void

enableAEC

enableAEC(enable: boolean): void

- Defined in ZegoExpressEngineImpl.ts:611
Parameters
- enable: boolean
Returns void

enableAGC

enableAGC(enable: boolean): void

- Defined in ZegoExpressEngineImpl.ts:643
Parameters
- enable: boolean
Returns void

enableANS

enableANS(enable: boolean): void

- Defined in ZegoExpressEngineImpl.ts:619
Parameters
- enable: boolean
Returns void

enableAudioCaptureDevice

enableAudioCaptureDevice(enable: boolean): void

- Defined in ZegoExpressEngineImpl.ts:778
Parameters
- enable: boolean
Returns void

enableAudioMixing

enableAudioMixing(enable: boolean): void

- Defined in ZegoExpressEngineImpl.ts:1371
Parameters
- enable: boolean
Returns void

enableBeforeAudioPrepAudioData

enableBeforeAudioPrepAudioData(enable: boolean, param: ZegoAudioFrameParam): void

- Defined in ZegoExpressEngineImpl.ts:1588
Parameters
- enable: boolean
- param: ZegoAudioFrameParam
Returns void

enableCamera

enableCamera(enable: boolean, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1044
Parameters
- enable: boolean
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

enableCapturedVideoCustomVideoRender

enableCapturedVideoCustomVideoRender(enable: boolean, channel: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1541
Parameters
- enable: boolean
- channel: ZegoPublishChannel
Returns void

enableCustomAudioCaptureProcessing

enableCustomAudioCaptureProcessing(enable: boolean, config: ZegoCustomAudioProcessConfig): void

- Defined in ZegoExpressEngineImpl.ts:1572
Parameters
- enable: boolean
- config: ZegoCustomAudioProcessConfig
Returns void

enableCustomAudioCaptureProcessingAfterHeadphoneMonitor

enableCustomAudioCaptureProcessingAfterHeadphoneMonitor(enable: boolean, config: ZegoCustomAudioProcessConfig): void

- Defined in ZegoExpressEngineImpl.ts:1580
Parameters
- enable: boolean
- config: ZegoCustomAudioProcessConfig
Returns void

enableCustomAudioIO

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

- Defined in ZegoExpressEngineImpl.ts:1628
Parameters
- enable: boolean
- config: ZegoCustomAudioConfig
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

enableCustomAudioPlaybackProcessing

enableCustomAudioPlaybackProcessing(enable: boolean, config: ZegoCustomAudioProcessConfig): void

- Defined in ZegoExpressEngineImpl.ts:1604
Parameters
- enable: boolean
- config: ZegoCustomAudioProcessConfig
Returns void

enableCustomAudioRemoteProcessing

enableCustomAudioRemoteProcessing(enable: boolean, config: ZegoCustomAudioProcessConfig): void

- Defined in ZegoExpressEngineImpl.ts:1596
Parameters
- enable: boolean
- config: ZegoCustomAudioProcessConfig
Returns void

enableCustomVideoCapture

enableCustomVideoCapture(enable: boolean, config?: ZegoCustomVideoCaptureConfig, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1557
Parameters
- enable: boolean
- Optional config: ZegoCustomVideoCaptureConfig
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

enableCustomVideoProcessing

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

- Defined in ZegoExpressEngineImpl.ts:1565
Parameters
- enable: boolean
- Optional config: ZegoCustomVideoProcessConfig
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

enableCustomVideoRender

enableCustomVideoRender(enable: boolean, config?: ZegoCustomVideoRenderConfig): void

- Defined in ZegoExpressEngineImpl.ts:1533
Parameters
- enable: boolean
- Optional config: ZegoCustomVideoRenderConfig
Returns void

enableDebugAssistant

enableDebugAssistant(enable: boolean): void

- Defined in ZegoExpressEngineImpl.ts:496
Parameters
- enable: boolean
Returns void

enableEffectsBeauty

enableEffectsBeauty(enable: boolean): void

- Defined in ZegoExpressEngineImpl.ts:1076
Parameters
- enable: boolean
Returns void

enableHardwareDecoder

enableHardwareDecoder(enable: boolean): void

- Defined in ZegoExpressEngineImpl.ts:667
Parameters
- enable: boolean
Returns void

enableHardwareEncoder

enableHardwareEncoder(enable: boolean): void

- Defined in ZegoExpressEngineImpl.ts:675
Parameters
- enable: boolean
Returns void

enableHeadphoneAEC

enableHeadphoneAEC(enable: boolean): void

- Defined in ZegoExpressEngineImpl.ts:603
Parameters
- enable: boolean
Returns void

enableHeadphoneMonitor

enableHeadphoneMonitor(enable: boolean): void

- Defined in ZegoExpressEngineImpl.ts:795
Parameters
- enable: boolean
Returns void

enablePublishDirectToCDN

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

- Defined in ZegoExpressEngineImpl.ts:922
Parameters
- enable: boolean
- config: ZegoCDNConfig
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

enableRemoteVideoCustomVideoRender

enableRemoteVideoCustomVideoRender(enable: boolean, streamID: string): void

- Defined in ZegoExpressEngineImpl.ts:1549
Parameters
- enable: boolean
- streamID: string
Returns void

enableTrafficControl

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

- Defined in ZegoExpressEngineImpl.ts:659
Parameters
- enable: boolean
- property: number
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

enableTransientANS

enableTransientANS(enable: boolean): void

- Defined in ZegoExpressEngineImpl.ts:627
Parameters
- enable: boolean
Returns void

enableVirtualStereo

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

- Defined in ZegoExpressEngineImpl.ts:1459
Parameters
- enable: boolean
- angle: number
Returns void

getAudioConfig

getAudioConfig(channel?: ZegoPublishChannel): ZegoAudioConfig

- Defined in ZegoExpressEngineImpl.ts:538
Parameters
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns ZegoAudioConfig

getAudioDeviceList

getAudioDeviceList(deviceType: ZegoAudioDeviceType): ZegoDeviceInfo[]

- Defined in ZegoExpressEngineImpl.ts:1207
Parameters
- deviceType: ZegoAudioDeviceType
Returns ZegoDeviceInfo[]

getAudioDeviceVolume

getAudioDeviceVolume(deviceType: ZegoAudioDeviceType, deviceID: string): number

- Defined in ZegoExpressEngineImpl.ts:1234
Parameters
- deviceType: ZegoAudioDeviceType
- deviceID: string
Returns number

getAudioRouteType

getAudioRouteType(): ZegoAudioRoute

- Defined in ZegoExpressEngineImpl.ts:786
Returns ZegoAudioRoute

getCameraMaxZoomFactor

getCameraMaxZoomFactor(channel?: ZegoPublishChannel): number

- Defined in ZegoExpressEngineImpl.ts:1181
Parameters
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns number

getCaptureVolume

getCaptureVolume(): number

- Defined in ZegoExpressEngineImpl.ts:835
Returns number

getDefaultAudioDeviceID

getDefaultAudioDeviceID(deviceType: ZegoAudioDeviceType): string

- Defined in ZegoExpressEngineImpl.ts:1216
Parameters
- deviceType: ZegoAudioDeviceType
Returns string

getNetworkTimeInfo

getNetworkTimeInfo(): ZegoNetworkTimeInfo | null

- Defined in ZegoExpressEngineImpl.ts:1491
Returns ZegoNetworkTimeInfo | null

getVideoConfig

getVideoConfig(channel?: ZegoPublishChannel): ZegoVideoConfig

- Defined in ZegoExpressEngineImpl.ts:513
Parameters
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns ZegoVideoConfig

isAudioDeviceMuted

isAudioDeviceMuted(deviceType: ZegoAudioDeviceType, deviceID: string): boolean

- Defined in ZegoExpressEngineImpl.ts:769
Parameters
- deviceType: ZegoAudioDeviceType
- deviceID: string
Returns boolean

isCameraFocusSupported

isCameraFocusSupported(channel?: ZegoPublishChannel): boolean

- Defined in ZegoExpressEngineImpl.ts:1124
Parameters
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns boolean

isMicrophoneMuted

isMicrophoneMuted(): boolean

- Defined in ZegoExpressEngineImpl.ts:751
Returns boolean

isSpeakerMuted

isSpeakerMuted(): boolean

- Defined in ZegoExpressEngineImpl.ts:1198
Returns boolean

isVideoDecoderSupported

isVideoDecoderSupported(codecID: ZegoVideoCodecID, codecBackend: ZegoVideoCodecBackend): number

- Defined in ZegoExpressEngineImpl.ts:700
Parameters
- codecID: ZegoVideoCodecID
- codecBackend: ZegoVideoCodecBackend
Returns number

isVideoEncoderSupported

isVideoEncoderSupported(codecID: ZegoVideoCodecID, codecBackend: ZegoVideoCodecBackend): number

- Defined in ZegoExpressEngineImpl.ts:691
Parameters
- codecID: ZegoVideoCodecID
- codecBackend: ZegoVideoCodecBackend
Returns number

loginRoom

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

- Defined in ZegoExpressEngineImpl.ts:420
Parameters
- roomID: string
- user: ZegoUser
- Optional config: ZegoRoomConfig
Returns Promise<ZegoRoomLoginResult>

logoutRoom

logoutRoom(roomID?: string): Promise<ZegoRoomLogoutResult>

- Defined in ZegoExpressEngineImpl.ts:436
Parameters
- Optional roomID: string
Returns Promise<ZegoRoomLogoutResult>

muteAllPlayStreamAudio

muteAllPlayStreamAudio(mute: boolean): void

- Defined in ZegoExpressEngineImpl.ts:1068
Parameters
- mute: boolean
Returns void

muteAudioDevice

muteAudioDevice(deviceType: ZegoAudioDeviceType, deviceID: string, mute: boolean): void

- Defined in ZegoExpressEngineImpl.ts:1252
Parameters
- deviceType: ZegoAudioDeviceType
- deviceID: string
- mute: boolean
Returns void

muteLocalAudioMixing

muteLocalAudioMixing(mute: boolean): void

- Defined in ZegoExpressEngineImpl.ts:1379
Parameters
- mute: boolean
Returns void

muteMicrophone

muteMicrophone(mute: boolean): void

- Defined in ZegoExpressEngineImpl.ts:743
Parameters
- mute: boolean
Returns void

mutePlayStreamAudio

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

- Defined in ZegoExpressEngineImpl.ts:1060
Parameters
- streamID: string
- mute: boolean
Returns void

mutePlayStreamVideo

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

- Defined in ZegoExpressEngineImpl.ts:1052
Parameters
- streamID: string
- mute: boolean
Returns void

mutePublishStreamAudio

mutePublishStreamAudio(mute: boolean, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:946
Parameters
- mute: boolean
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

mutePublishStreamVideo

mutePublishStreamVideo(mute: boolean, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:938
Parameters
- mute: boolean
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

muteSpeaker

muteSpeaker(mute: boolean): void

- Defined in ZegoExpressEngineImpl.ts:1190
Parameters
- mute: boolean
Returns void

off

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

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

on

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

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

removeAllLister

removeAllLister(): void

- Defined in ZegoExpressEngineImpl.ts:1675
Returns void

removePublishCdnUrl

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

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

renewToken

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

- Defined in ZegoExpressEngineImpl.ts:460
Parameters
- roomID: string
- token: string
Returns void

sendAudioSideInfo

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

- Defined in ZegoExpressEngineImpl.ts:1411
Parameters
- data: ArrayBuffer
- timeStampMs: number
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

sendBarrageMessage

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

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

sendBroadcastMessage

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

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

sendCustomCommand

sendCustomCommand(roomID: string, command: string, toUserList: Array<ZegoUser>): Promise<ZegoIMSendCustomCommandResult>

- Defined in ZegoExpressEngineImpl.ts:1293
Parameters
- roomID: string
- command: string
- toUserList: Array<ZegoUser>
Returns Promise<ZegoIMSendCustomCommandResult>

sendSEI

sendSEI(data: ArrayBuffer, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1403
Parameters
- data: ArrayBuffer
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setAECMode

setAECMode(mode: ZegoAECMode): void

- Defined in ZegoExpressEngineImpl.ts:595
Parameters
- mode: ZegoAECMode
Returns void

setANSMode

setANSMode(mode: ZegoANSMode): void

- Defined in ZegoExpressEngineImpl.ts:635
Parameters
- mode: ZegoANSMode
Returns void

setAllPlayStreamVolume

setAllPlayStreamVolume(volume: number): void

- Defined in ZegoExpressEngineImpl.ts:811
Parameters
- volume: number
Returns void

setAppOrientation

setAppOrientation(orientation: ZegoOrientation, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1108
Parameters
- orientation: ZegoOrientation
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setAppOrientationMode

setAppOrientationMode(mode: ZegoOrientationMode): void

- Defined in ZegoExpressEngineImpl.ts:717
Parameters
- mode: ZegoOrientationMode
Returns void

setAudioCaptureStereoMode

setAudioCaptureStereoMode(mode: ZegoAudioCaptureStereoMode): void

- Defined in ZegoExpressEngineImpl.ts:844
Parameters
- mode: ZegoAudioCaptureStereoMode
Returns void

setAudioConfig

setAudioConfig(config: ZegoAudioConfig | ZegoAudioConfigPreset, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:530
Parameters
- config: ZegoAudioConfig | ZegoAudioConfigPreset
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setAudioDeviceMode

setAudioDeviceMode(mode: ZegoAudioDeviceMode): void

- Defined in ZegoExpressEngineImpl.ts:761
Parameters
- mode: ZegoAudioDeviceMode
Returns void

setAudioDeviceVolume

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

- Defined in ZegoExpressEngineImpl.ts:1243
Parameters
- deviceType: ZegoAudioDeviceType
- deviceID: string
- volume: number
Returns void

setAudioEqualizerGain

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

- Defined in ZegoExpressEngineImpl.ts:1092
Parameters
- bandIndex: number
- bandGain: number
Returns void

setAudioMixMode

setAudioMixMode(mode: ZegoAudioMixMode, streamList: string[]): void

- Defined in ZegoExpressEngineImpl.ts:1011
Parameters
- mode: ZegoAudioMixMode
- streamList: string[]
Returns void

setAudioMixingVolume

setAudioMixingVolume(volume: number, type: ZegoVolumeType): void

- Defined in ZegoExpressEngineImpl.ts:1387
Parameters
- volume: number
- type: ZegoVolumeType
Returns void

setAudioRouteToSpeaker

setAudioRouteToSpeaker(defaultToSpeaker: boolean): void

- Defined in ZegoExpressEngineImpl.ts:852
Parameters
- defaultToSpeaker: boolean
Returns void

setAudioSource

setAudioSource(source: ZegoAudioSourceType, channel?: ZegoPublishChannel): number

- Defined in ZegoExpressEngineImpl.ts:734
Parameters
- source: ZegoAudioSourceType
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns number

setCameraExposureCompensation

setCameraExposureCompensation(value: number, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1165
Parameters
- value: number
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setCameraExposureMode

setCameraExposureMode(mode: ZegoCameraExposureMode, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1149
Parameters
- mode: ZegoCameraExposureMode
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setCameraExposurePointInPreview

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

- Defined in ZegoExpressEngineImpl.ts:1157
Parameters
- x: number
- y: number
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setCameraFocusMode

setCameraFocusMode(mode: ZegoCameraFocusMode, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1133
Parameters
- mode: ZegoCameraFocusMode
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setCameraFocusPointInPreview

setCameraFocusPointInPreview(x: number, y: number, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1141
Parameters
- x: number
- y: number
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setCameraZoomFactor

setCameraZoomFactor(factor: number, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1173
Parameters
- factor: number
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setCapturePipelineScaleMode

setCapturePipelineScaleMode(mode: ZegoCapturePipelineScaleMode): void

- Defined in ZegoExpressEngineImpl.ts:683
Parameters
- mode: ZegoCapturePipelineScaleMode
Returns void

setCaptureVolume

setCaptureVolume(volume: number): void

- Defined in ZegoExpressEngineImpl.ts:827
Parameters
- volume: number
Returns void

setEffectsBeautyParam

setEffectsBeautyParam(param: ZegoEffectsBeautyParam): void

- Defined in ZegoExpressEngineImpl.ts:1084
Parameters
- param: ZegoEffectsBeautyParam
Returns void

setElectronicEffects

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

- Defined in ZegoExpressEngineImpl.ts:1467
Parameters
- enable: boolean
- mode: ZegoElectronicEffectsMode
- tonal: number
Returns void

setHeadphoneMonitorVolume

setHeadphoneMonitorVolume(volume: number): void

- Defined in ZegoExpressEngineImpl.ts:819
Parameters
- volume: number
Returns void

setMinVideoBitrateForTrafficControl

setMinVideoBitrateForTrafficControl(bitrate: number, mode: ZegoTrafficControlMinVideoBitrateMode, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1501
Parameters
- bitrate: number
- mode: ZegoTrafficControlMinVideoBitrateMode
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setMinVideoFpsForTrafficControl

setMinVideoFpsForTrafficControl(fps: number, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1509
Parameters
- fps: number
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setMinVideoResolutionForTrafficControl

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

- Defined in ZegoExpressEngineImpl.ts:1517
Parameters
- width: number
- height: number
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setPlayStreamBufferIntervalRange

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

- Defined in ZegoExpressEngineImpl.ts:1003
Parameters
- streamID: string
- minBufferInterval: number
- maxBufferInterval: number
Returns void

setPlayStreamDecryptionKey

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

- Defined in ZegoExpressEngineImpl.ts:556
Parameters
- streamID: string
- key: string
Returns void

setPlayStreamVideoType

setPlayStreamVideoType(streamID: string, type: ZegoVideoStreamType): void

- Defined in ZegoExpressEngineImpl.ts:986
Parameters
- streamID: string
- type: ZegoVideoStreamType
Returns void

setPlayStreamsAlignmentProperty

setPlayStreamsAlignmentProperty(mode: ZegoStreamAlignmentMode): void

- Defined in ZegoExpressEngineImpl.ts:709
Parameters
- mode: ZegoStreamAlignmentMode
Returns void

setPlayVolume

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

- Defined in ZegoExpressEngineImpl.ts:803
Parameters
- streamID: string
- volume: number
Returns void

setPublishDualStreamConfig

setPublishDualStreamConfig(configList: ZegoPublishDualStreamConfig[], channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:522
Parameters
- configList: ZegoPublishDualStreamConfig[]
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setPublishStreamEncryptionKey

setPublishStreamEncryptionKey(key: string, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:548
Parameters
- key: string
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setPublishWatermark

setPublishWatermark(watermark: ZegoWatermark, isPreviewVisible: boolean, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:876
Parameters
- watermark: ZegoWatermark
- isPreviewVisible: boolean
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setReverbAdvancedParam

setReverbAdvancedParam(param: ZegoReverbAdvancedParam): void

- Defined in ZegoExpressEngineImpl.ts:1443
Parameters
- param: ZegoReverbAdvancedParam
Returns void

setReverbEchoParam

setReverbEchoParam(param: ZegoReverbEchoParam): void

- Defined in ZegoExpressEngineImpl.ts:1451
Parameters
- param: ZegoReverbEchoParam
Returns void

setReverbPreset

setReverbPreset(preset: ZegoReverbPreset): void

- Defined in ZegoExpressEngineImpl.ts:1435
Parameters
- preset: ZegoReverbPreset
Returns void

setRoomExtraInfo

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

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

setRoomScenario

setRoomScenario(scenario: ZegoScenario): void

- Defined in ZegoExpressEngineImpl.ts:195
Parameters
- scenario: ZegoScenario
Returns void

setSEIConfig

setSEIConfig(config: ZegoSEIConfig): void

- Defined in ZegoExpressEngineImpl.ts:1395
Parameters
- config: ZegoSEIConfig
Returns void

setStreamAlignmentProperty

setStreamAlignmentProperty(alignment: number, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:651
Parameters
- alignment: number
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setStreamExtraInfo

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

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

setTrafficControlFocusOn

setTrafficControlFocusOn(mode: ZegoTrafficControlFocusOnMode, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1525
Parameters
- mode: ZegoTrafficControlFocusOnMode
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setVideoConfig

setVideoConfig(config: ZegoVideoConfigPreset | ZegoVideoConfig, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:505
Parameters
- config: ZegoVideoConfigPreset | ZegoVideoConfig
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setVideoMirrorMode

setVideoMirrorMode(mirrorMode: ZegoVideoMirrorMode, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1100
Parameters
- mirrorMode: ZegoVideoMirrorMode
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

setVideoSource

setVideoSource(source: ZegoVideoSourceType, channel?: ZegoPublishChannel, instanceID?: number): number

- Defined in ZegoExpressEngineImpl.ts:725
Parameters
- source: ZegoVideoSourceType
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
- Optional instanceID: number
Returns number

setVoiceChangerParam

setVoiceChangerParam(param: ZegoVoiceChangerParam): void

- Defined in ZegoExpressEngineImpl.ts:1427
Parameters
- param: ZegoVoiceChangerParam
Returns void

setVoiceChangerPreset

setVoiceChangerPreset(preset: ZegoVoiceChangerPreset): void

- Defined in ZegoExpressEngineImpl.ts:1419
Parameters
- preset: ZegoVoiceChangerPreset
Returns void

startAudioDataObserver

startAudioDataObserver(observerBitMask: number, param: ZegoAudioFrameParam): void

- Defined in ZegoExpressEngineImpl.ts:1612
Parameters
- observerBitMask: number
- param: ZegoAudioFrameParam
Returns void

startAudioSpectrumMonitor

startAudioSpectrumMonitor(millisecond: number): void

- Defined in ZegoExpressEngineImpl.ts:1355
Parameters
- millisecond: number
Returns void

startAudioVADStableStateMonitor

startAudioVADStableStateMonitor(type: ZegoAudioVADStableStateMonitorType, millisecond: number): void

- Defined in ZegoExpressEngineImpl.ts:1028
Parameters
- type: ZegoAudioVADStableStateMonitorType
- millisecond: number
Returns void

startMixerTask

startMixerTask(task: ZegoMixerTask): Promise<ZegoMixerStartResult>

- Defined in ZegoExpressEngineImpl.ts:1308
Parameters
- task: ZegoMixerTask
Returns Promise<ZegoMixerStartResult>

startNetworkSpeedTest

startNetworkSpeedTest(config: ZegoNetworkSpeedTestConfig, interval: number): void

- Defined in ZegoExpressEngineImpl.ts:1475
Parameters
- config: ZegoNetworkSpeedTestConfig
- interval: number
Returns void

startPlayingStream

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

- Defined in ZegoExpressEngineImpl.ts:954
Parameters
- streamID: string
- Optional view: ZegoView
- Optional config: ZegoPlayerConfig
Returns void

startPreview

startPreview(view?: ZegoView, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:860
Parameters
- Optional view: ZegoView
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

startPublishingStream

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

- Defined in ZegoExpressEngineImpl.ts:884
Parameters
- streamID: string
- Optional config: ZegoPublisherConfig
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

startRecordingCapturedData

startRecordingCapturedData(config: ZegoDataRecordConfig, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:404
Parameters
- config: ZegoDataRecordConfig
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

startSoundLevelMonitor

startSoundLevelMonitor(config: ZegoSoundLevelConfig): void

- Defined in ZegoExpressEngineImpl.ts:1339
Parameters
- config: ZegoSoundLevelConfig
Returns void

stopAudioDataObserver

stopAudioDataObserver(): void

- Defined in ZegoExpressEngineImpl.ts:1620
Returns void

stopAudioSpectrumMonitor

stopAudioSpectrumMonitor(): void

- Defined in ZegoExpressEngineImpl.ts:1363
Returns void

stopAudioVADStableStateMonitor

stopAudioVADStableStateMonitor(type: ZegoAudioVADStableStateMonitorType): void

- Defined in ZegoExpressEngineImpl.ts:1036
Parameters
- type: ZegoAudioVADStableStateMonitorType
Returns void

stopMixerTask

stopMixerTask(task: ZegoMixerTask): Promise<ZegoMixerStopResult>

- Defined in ZegoExpressEngineImpl.ts:1324
Parameters
- task: ZegoMixerTask
Returns Promise<ZegoMixerStopResult>

stopNetworkSpeedTest

stopNetworkSpeedTest(): void

- Defined in ZegoExpressEngineImpl.ts:1483
Returns void

stopPlayingStream

stopPlayingStream(streamID: string): void

- Defined in ZegoExpressEngineImpl.ts:962
Parameters
- streamID: string
Returns void

stopPreview

stopPreview(channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:868
Parameters
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

stopPublishingStream

stopPublishingStream(channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:930
Parameters
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

stopRecordingCapturedData

stopRecordingCapturedData(channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:412
Parameters
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

stopSoundLevelMonitor

stopSoundLevelMonitor(): void

- Defined in ZegoExpressEngineImpl.ts:1347
Returns void

switchRoom

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

- Defined in ZegoExpressEngineImpl.ts:452
Parameters
- fromRoomID: string
- toRoomID: string
- Optional config: ZegoRoomConfig
Returns void

takePlayStreamSnapshot

takePlayStreamSnapshot(streamID: string): Promise<ZegoPlayerTakeSnapshotResult>

- Defined in ZegoExpressEngineImpl.ts:970
Parameters
- streamID: string
Returns Promise<ZegoPlayerTakeSnapshotResult>

takePublishStreamSnapshot

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

- Defined in ZegoExpressEngineImpl.ts:563
Parameters
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns Promise<ZegoPublisherTakeSnapshotResult>

takePublishStreamSnapshotByConfig

takePublishStreamSnapshotByConfig(config: ZegoPublisherTakeSnapshotConfig, channel?: ZegoPublishChannel): Promise<ZegoPublisherTakeSnapshotResult>

- Defined in ZegoExpressEngineImpl.ts:579
Parameters
- config: ZegoPublisherTakeSnapshotConfig
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns Promise<ZegoPublisherTakeSnapshotResult>

updatePlayingCanvas

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

- Defined in ZegoExpressEngineImpl.ts:994
Parameters
- streamID: string
- view: ZegoView
Returns number

uploadLog

uploadLog(): void

- Defined in ZegoExpressEngineImpl.ts:203
Returns void

useAudioDevice

useAudioDevice(deviceType: ZegoAudioDeviceType, deviceID: string): void

- Defined in ZegoExpressEngineImpl.ts:1225
Parameters
- deviceType: ZegoAudioDeviceType
- deviceID: string
Returns void

useFrontCamera

useFrontCamera(enable: boolean, channel?: ZegoPublishChannel): void

- Defined in ZegoExpressEngineImpl.ts:1116
Parameters
- enable: boolean
- Default value channel: ZegoPublishChannel = zego.ZegoPublishChannel.Main
Returns void

Static createEngine

createEngine(profile: ZegoEngineProfile): Promise<ZegoExpressEngineImpl | null>

- Defined in ZegoExpressEngineImpl.ts:52
Parameters
- profile: ZegoEngineProfile
Returns Promise<ZegoExpressEngineImpl | null>

Static createTextureRenderer

createTextureRenderer(surfaceId: number, width: number, height: number): boolean

- Defined in ZegoExpressEngineImpl.ts:183
Parameters
- surfaceId: number
- width: number
- height: number
Returns boolean

Static destroyEngine

destroyEngine(): Promise<void>

- Defined in ZegoExpressEngineImpl.ts:103
Returns Promise<void>

Static destroyTextureRenderer

destroyTextureRenderer(surfaceId: number): boolean

- Defined in ZegoExpressEngineImpl.ts:191
Parameters
- surfaceId: number
Returns boolean

Static getInstance

getInstance(): ZegoExpressEngineImpl

- Defined in ZegoExpressEngineImpl.ts:40
Returns ZegoExpressEngineImpl

Static getSDKVersion

getSDKVersion(): string

- Defined in ZegoExpressEngineImpl.ts:135
Returns string

Static isFeatureSupported

isFeatureSupported(featureType: ZegoFeatureType): boolean

- Defined in ZegoExpressEngineImpl.ts:146
Parameters
- featureType: ZegoFeatureType
Returns boolean

Static setCustomLog

setCustomLog(msg: string): void

- Defined in ZegoExpressEngineImpl.ts:178
Parameters
- msg: string
Returns void

Static setEngineConfig

setEngineConfig(config: ZegoEngineConfig): void

- Defined in ZegoExpressEngineImpl.ts:162
Parameters
- config: ZegoEngineConfig
Returns void

Static setGeoFence

setGeoFence(type: ZegoGeoFenceType, areaList: number[]): void

- Defined in ZegoExpressEngineImpl.ts:174
Parameters
- type: ZegoGeoFenceType
- areaList: number[]
Returns void

Static setLicense

setLicense(license: string): void

- Defined in ZegoExpressEngineImpl.ts:158
Parameters
- license: string
Returns void

Static setLogConfig

setLogConfig(config: ZegoLogConfig): void

- Defined in ZegoExpressEngineImpl.ts:152
Parameters
- config: ZegoLogConfig
Returns void

Static setRoomMode

setRoomMode(mode: ZegoRoomMode): void

- Defined in ZegoExpressEngineImpl.ts:168
Parameters
- mode: ZegoRoomMode
Returns void

Static submitLog

submitLog(): void

- Defined in ZegoExpressEngineImpl.ts:141
Returns void

Static updateTextureRendererSize

updateTextureRendererSize(surfaceId: number, width: number, height: number): boolean

- Defined in ZegoExpressEngineImpl.ts:187
Parameters
- surfaceId: number
- width: number
- height: number
Returns boolean

Generated using TypeDoc