ZegoExpressEngineImpl.d.ts 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. import { ZegoAccurateSeekConfig, ZegoAECMode, ZegoANSMode, ZegoAudioCaptureStereoMode, ZegoAudioConfig, ZegoAudioRoute, ZegoEffectsBeautyParam, ZegoCapturePipelineScaleMode, ZegoCDNConfig, ZegoEngineConfig, ZegoEngineProfile, ZegoIMSendBarrageMessageResult, ZegoIMSendBroadcastMessageResult, ZegoIMSendCustomCommandResult, ZegoLogConfig, ZegoMediaPlayer, ZegoMediaPlayerAudioChannel, ZegoMediaPlayerLoadResourceResult, ZegoMediaPlayerSeekToResult, ZegoMediaPlayerState, ZegoMediaPlayerTakeSnapshotResult, ZegoNetWorkResourceCache, ZegoOrientation, ZegoPlayerConfig, ZegoPlayerTakeSnapshotResult, ZegoPublishChannel, ZegoPublisherSetStreamExtraInfoResult, ZegoPublisherTakeSnapshotResult, ZegoPublisherUpdateCdnUrlResult, ZegoReverbAdvancedParam, ZegoReverbEchoParam, ZegoReverbPreset, ZegoRoomConfig, ZegoRoomSetRoomExtraInfoResult, ZegoScenario, ZegoSEIConfig, ZegoTrafficControlFocusOnMode, ZegoTrafficControlMinVideoBitrateMode, ZegoTrafficControlProperty, ZegoUser, ZegoVideoConfig, ZegoVideoConfigPreset, ZegoVideoMirrorMode, ZegoVideoStreamType, ZegoVoiceChangerParam, ZegoVoiceChangerPreset, ZegoWatermark, ZegoAutoMixerTask, ZegoMixerStartResult, ZegoMixerStopResult, ZegoMixerTask, ZegoRoomMode, ZegoPublisherConfig, ZegoSoundLevelConfig } from "../ZegoExpressDefines";
  2. import { ZegoEventListener, ZegoAnyCallback, ZegoMediaPlayerListener } from "../ZegoExpressEventHandler";
  3. export declare class ZegoExpressEngineImpl {
  4. static _listeners: Map<string, Map<ZegoAnyCallback, ZegoAnyCallback>>;
  5. static _mediaPlayerMap: Map<number, ZegoMediaPlayer>;
  6. private static _callMethod;
  7. static getInstance(): ZegoExpressEngineImpl;
  8. static createEngineWithProfile(profile: ZegoEngineProfile): Promise<ZegoExpressEngineImpl>;
  9. static createEngine(appID: number, appSign: string, isTestEnv: boolean, scenario: ZegoScenario): Promise<ZegoExpressEngineImpl>;
  10. static destroyEngine(): Promise<void>;
  11. static setEngineConfig(config: ZegoEngineConfig): Promise<void>;
  12. static setRoomMode(mode: ZegoRoomMode): Promise<void>;
  13. on<EventType extends keyof ZegoEventListener>(event: EventType, callback: ZegoEventListener[EventType]): void;
  14. off<EventType extends keyof ZegoEventListener>(event: EventType, callback?: ZegoEventListener[EventType]): void;
  15. setLogConfig(config: ZegoLogConfig): Promise<void>;
  16. getVersion(): Promise<string>;
  17. uploadLog(): Promise<void>;
  18. callExperimentalAPI(params: string): Promise<string>;
  19. setDummyCaptureImagePath(filePath: string, channel?: ZegoPublishChannel): Promise<void>;
  20. loginRoom(roomID: string, user: ZegoUser, config?: ZegoRoomConfig): Promise<void>;
  21. logoutRoom(roomID?: string): Promise<void>;
  22. loginMultiRoom(roomID: string, config: ZegoRoomConfig): Promise<void>;
  23. switchRoom(fromRoomID: string, toRoomID: string, config?: ZegoRoomConfig): Promise<void>;
  24. renewToken(roomID: string, token: string): Promise<void>;
  25. setRoomExtraInfo(value: string, key: string, roomID: string): Promise<ZegoRoomSetRoomExtraInfoResult>;
  26. startPublishingStream(streamID: string, channel?: ZegoPublishChannel, config?: ZegoPublisherConfig): Promise<void>;
  27. stopPublishingStream(channel?: ZegoPublishChannel): Promise<void>;
  28. setStreamExtraInfo(extraInfo: string, channel?: ZegoPublishChannel): Promise<ZegoPublisherSetStreamExtraInfoResult>;
  29. startPreview(channel?: ZegoPublishChannel): Promise<void>;
  30. stopPreview(channel?: ZegoPublishChannel): Promise<void>;
  31. setVideoConfig(config: ZegoVideoConfigPreset | ZegoVideoConfig, channel?: ZegoPublishChannel): Promise<void>;
  32. getVideoConfig(channel?: ZegoPublishChannel): Promise<ZegoVideoConfig>;
  33. setVideoMirrorMode(mode: ZegoVideoMirrorMode, channel?: ZegoPublishChannel): Promise<void>;
  34. setAppOrientation(orientation: ZegoOrientation, channel?: ZegoPublishChannel): Promise<void>;
  35. setAudioConfig(config: ZegoAudioConfig): Promise<void>;
  36. getAudioConfig(): Promise<ZegoAudioConfig>;
  37. setPublishStreamEncryptionKey(key: string, channel?: ZegoPublishChannel): Promise<void>;
  38. takePublishStreamSnapshot(channel?: ZegoPublishChannel): Promise<ZegoPublisherTakeSnapshotResult>;
  39. mutePublishStreamAudio(mute: boolean, channel?: ZegoPublishChannel): Promise<void>;
  40. mutePublishStreamVideo(mute: boolean, channel?: ZegoPublishChannel): Promise<void>;
  41. enableTrafficControl(enable: boolean, property: ZegoTrafficControlProperty, channel?: ZegoPublishChannel): Promise<void>;
  42. setMinVideoBitrateForTrafficControl(bitrate: number, mode: ZegoTrafficControlMinVideoBitrateMode, channel?: ZegoPublishChannel): Promise<void>;
  43. setTrafficControlFocusOn(mode: ZegoTrafficControlFocusOnMode, channel?: ZegoPublishChannel): Promise<void>;
  44. setCaptureVolume(volume: number): Promise<void>;
  45. setAudioCaptureStereoMode(mode: ZegoAudioCaptureStereoMode): Promise<void>;
  46. addPublishCdnUrl(targetURL: string, streamID: string): Promise<ZegoPublisherUpdateCdnUrlResult>;
  47. removePublishCdnUrl(targetURL: string, streamID: string): Promise<ZegoPublisherUpdateCdnUrlResult>;
  48. enablePublishDirectToCDN(enable: boolean, config: ZegoCDNConfig, channel?: ZegoPublishChannel): Promise<void>;
  49. setPublishWatermark(watermark: ZegoWatermark, isPreviewVisible: boolean, channel?: ZegoPublishChannel): Promise<void>;
  50. setSEIConfig(config: ZegoSEIConfig): Promise<void>;
  51. sendSEI(data: ArrayBuffer, channel?: ZegoPublishChannel): Promise<void>;
  52. enableHardwareEncoder(enable: boolean): Promise<void>;
  53. setCapturePipelineScaleMode(mode: ZegoCapturePipelineScaleMode): Promise<void>;
  54. startPlayingStream(streamID: string, config?: ZegoPlayerConfig): Promise<void>;
  55. stopPlayingStream(streamID: string): Promise<void>;
  56. setPlayStreamDecryptionKey(key: string, streamID: string): Promise<void>;
  57. takePlayStreamSnapshot(streamID: string): Promise<ZegoPlayerTakeSnapshotResult>;
  58. setPlayVolume(streamID: string, volume: number): Promise<void>;
  59. setAllPlayStreamVolume(volume: number): Promise<void>;
  60. setPlayStreamVideoType(streamID: string, streamType: ZegoVideoStreamType): Promise<void>;
  61. setPlayStreamBufferIntervalRange(streamID: string, minBufferInterval: number, maxBufferInterval: number): Promise<void>;
  62. setPlayStreamFocusOn(streamID: string): Promise<void>;
  63. mutePlayStreamAudio(streamID: string, mute: boolean): Promise<void>;
  64. mutePlayStreamVideo(streamID: string, mute: boolean): Promise<void>;
  65. muteAllPlayStreamAudio(mute: boolean): Promise<void>;
  66. muteAllPlayStreamVideo(mute: boolean): Promise<void>;
  67. enableHardwareDecoder(enable: boolean): Promise<void>;
  68. enableCheckPoc(enable: boolean): Promise<void>;
  69. startMixerTask(task: ZegoMixerTask): Promise<ZegoMixerStartResult>;
  70. stopMixerTask(task: ZegoMixerTask): Promise<ZegoMixerStopResult>;
  71. startAutoMixerTask(task: ZegoAutoMixerTask): Promise<ZegoMixerStartResult>;
  72. stopAutoMixerTask(task: ZegoAutoMixerTask): Promise<ZegoMixerStopResult>;
  73. muteMicrophone(mute: boolean): Promise<void>;
  74. isMicrophoneMuted(): Promise<boolean>;
  75. muteSpeaker(mute: boolean): Promise<void>;
  76. isSpeakerMuted(): Promise<boolean>;
  77. enableAudioCaptureDevice(enable: boolean): Promise<void>;
  78. getAudioRouteType(): Promise<ZegoAudioRoute>;
  79. setAudioRouteToSpeaker(defaultToSpeaker: boolean): Promise<void>;
  80. enableCamera(enable: boolean, channel?: ZegoPublishChannel): Promise<void>;
  81. useFrontCamera(enable: boolean, channel?: ZegoPublishChannel): Promise<void>;
  82. setCameraZoomFactor(factor: number, channel?: ZegoPublishChannel): Promise<void>;
  83. getCameraMaxZoomFactor(channel?: ZegoPublishChannel): Promise<number>;
  84. startSoundLevelMonitor(config?: ZegoSoundLevelConfig): Promise<void>;
  85. stopSoundLevelMonitor(): Promise<void>;
  86. startAudioSpectrumMonitor(millisecond: number): Promise<void>;
  87. stopAudioSpectrumMonitor(): Promise<void>;
  88. enableHeadphoneMonitor(enable: boolean): Promise<void>;
  89. setHeadphoneMonitorVolume(volume: number): Promise<void>;
  90. enableAEC(enable: boolean): Promise<void>;
  91. enableHeadphoneAEC(enable: boolean): Promise<void>;
  92. setAECMode(mode: ZegoAECMode): Promise<void>;
  93. enableAGC(enable: boolean): Promise<void>;
  94. enableANS(enable: boolean): Promise<void>;
  95. enableTransientANS(enable: boolean): Promise<void>;
  96. setANSMode(mode: ZegoANSMode): Promise<void>;
  97. startEffectsEnv(): Promise<void>;
  98. stopEffectsEnv(): Promise<void>;
  99. enableEffectsBeauty(enable: boolean): Promise<void>;
  100. setEffectsBeautyParam(param: ZegoEffectsBeautyParam): Promise<void>;
  101. setAudioEqualizerGain(bandGain: number, bandIndex: number): Promise<void>;
  102. setVoiceChangerPreset(preset: ZegoVoiceChangerPreset): Promise<void>;
  103. setVoiceChangerParam(param: ZegoVoiceChangerParam, audioChannel: ZegoMediaPlayerAudioChannel): Promise<void>;
  104. setReverbPreset(preset: ZegoReverbPreset): Promise<void>;
  105. setReverbAdvancedParam(param: ZegoReverbAdvancedParam): Promise<void>;
  106. setReverbEchoParam(param: ZegoReverbEchoParam): Promise<void>;
  107. enableVirtualStereo(enable: boolean, angle: number): Promise<void>;
  108. sendBroadcastMessage(roomID: string, message: string): Promise<ZegoIMSendBroadcastMessageResult>;
  109. sendBarrageMessage(roomID: string, message: string): Promise<ZegoIMSendBarrageMessageResult>;
  110. sendCustomCommand(roomID: string, command: string, toUserList?: ZegoUser[]): Promise<ZegoIMSendCustomCommandResult>;
  111. createMediaPlayer(): Promise<ZegoMediaPlayer | undefined>;
  112. destroyMediaPlayer(mediaPlayer: ZegoMediaPlayer): Promise<void>;
  113. }
  114. export declare class ZegoMediaPlayerImpl implements ZegoMediaPlayer {
  115. private _index;
  116. constructor(index: number);
  117. private _callMethod;
  118. on<MediaPlayerEventType extends keyof ZegoMediaPlayerListener>(event: MediaPlayerEventType, callback: ZegoMediaPlayerListener[MediaPlayerEventType]): void;
  119. off<MediaPlayerEventType extends keyof ZegoMediaPlayerListener>(event: MediaPlayerEventType, callback?: ZegoMediaPlayerListener[MediaPlayerEventType]): void;
  120. loadResource(path: string): Promise<ZegoMediaPlayerLoadResourceResult>;
  121. start(): Promise<void>;
  122. stop(): Promise<void>;
  123. pause(): Promise<void>;
  124. resume(): Promise<void>;
  125. setPlayerView(playerID: number): Promise<void>;
  126. seekTo(millisecond: number): Promise<ZegoMediaPlayerSeekToResult>;
  127. enableRepeat(enable: boolean): Promise<void>;
  128. enableAux(enable: boolean): Promise<void>;
  129. muteLocal(mute: boolean): Promise<void>;
  130. setVolume(volume: number): Promise<void>;
  131. setPlayVolume(volume: number): Promise<void>;
  132. setPublishVolume(volume: number): Promise<void>;
  133. setProgressInterval(millisecond: number): Promise<void>;
  134. setAudioTrackIndex(index: number): Promise<void>;
  135. setVoiceChangerParam(param: ZegoVoiceChangerParam, audioChannel: ZegoMediaPlayerAudioChannel): Promise<void>;
  136. takeSnapshot(): Promise<ZegoMediaPlayerTakeSnapshotResult>;
  137. setNetworkResourceMaxCache(time: number, size: number): Promise<void>;
  138. setNetworkBufferThreshold(threshold: number): Promise<void>;
  139. enableAccurateSeek(enable: boolean, config: ZegoAccurateSeekConfig): Promise<void>;
  140. getNetworkResourceCache(): Promise<ZegoNetWorkResourceCache>;
  141. getPlayVolume(): Promise<number>;
  142. getPublishVolume(): Promise<number>;
  143. getTotalDuration(): Promise<number>;
  144. getCurrentProgress(): Promise<number>;
  145. getAudioTrackCount(): Promise<number>;
  146. getCurrentState(): Promise<ZegoMediaPlayerState>;
  147. getIndex(): number;
  148. }