ZegoUIKit class
APIs
Features
Methods
-
activeAppToForeground()
→ Future<void>
-
inherited
-
adapterService()
→ ZegoPluginAdapterService
-
adapter service
inherited
-
backToDesktop({bool nonRoot = false})
→ Future<void>
-
Android go to the desktop
inherited
-
checkAppRunning()
→ Future<bool>
-
inherited
-
clearLogs()
→ Future<void>
-
inherited
-
clearMessage({ZegoInRoomMessageType type = ZegoInRoomMessageType.broadcastMessage, bool clearRemote = true})
→ Future<bool>
-
inherited
-
destroyMedia()
→ Future<void>
-
Destroy current media
inherited
-
enableBeauty(bool isOn)
→ Future<void>
-
enable beauty
inherited
-
enableCustomVideoProcessing(bool enable)
→ void
-
inherited
-
enableEventUninitOnRoomLeaved(bool enabled)
→ void
-
-
enableTrafficControl(bool enabled, List<ZegoUIKitTrafficControlProperty> properties, {ZegoUIKitVideoConfig? minimizeVideoConfig, bool isFocusOnRemote = true, ZegoStreamType streamType = ZegoStreamType.main})
→ Future<void>
-
inherited
-
enableVideoMirroring(bool isVideoMirror)
→ void
-
set video mirror mode
inherited
-
getAllUsers()
→ List<ZegoUIKitUser>
-
get all users, include local user and remote users
inherited
-
getAudioOutputDeviceNotifier(String userID)
→ ValueNotifier<ZegoUIKitAudioRoute>
-
get audio output device notifier
inherited
-
getAudioVideoList()
→ List<ZegoUIKitUser>
-
get audio video list
inherited
-
getAudioVideoListStream()
→ Stream<List<ZegoUIKitUser>>
-
inherited
-
getAudioVideoViewNotifier(String? userID, {ZegoStreamType streamType = ZegoStreamType.main})
→ ValueNotifier<Widget?>
-
get audio video view notifier
inherited
-
getBeautyPlugin()
→ ZegoUIKitBeautyPluginImpl
-
inherited
-
getBeautyValue()
→ ZegoEffectsBeautyParam
-
get beauty value
inherited
-
getCameraStateNotifier(String userID)
→ ValueNotifier<bool>
-
get camera state notifier
inherited
-
getErrorStream()
→ Stream<ZegoUIKitError>
-
-
getInRoomCommandReceivedStream()
→ Stream<ZegoInRoomCommandReceivedData>
-
get in-room command received notifier
inherited
-
getInRoomLocalMessageStream({ZegoInRoomMessageType type = ZegoInRoomMessageType.broadcastMessage})
→ Stream<ZegoInRoomMessage>
-
local message sent notifier
inherited
-
getInRoomMessageListStream({ZegoInRoomMessageType type = ZegoInRoomMessageType.broadcastMessage})
→ Stream<List<ZegoInRoomMessage>>
-
messages notifier
inherited
-
getInRoomMessages({ZegoInRoomMessageType type = ZegoInRoomMessageType.broadcastMessage})
→ List<ZegoInRoomMessage>
-
get history messages
inherited
-
getInRoomMessageStream({ZegoInRoomMessageType type = ZegoInRoomMessageType.broadcastMessage})
→ Stream<ZegoInRoomMessage>
-
latest message received notifier
inherited
-
getInRoomUserAttributesNotifier(String userID)
→ ValueNotifier<ZegoUIKitUserAttributes>
-
get notifier of in-room user attributes
inherited
-
getLocalUser()
→ ZegoUIKitUser
-
get local user
inherited
-
getMediaCurrentProgress()
→ int
-
Get current playing progress.
inherited
-
getMediaCurrentProgressNotifier()
→ ValueNotifier<int>
-
inherited
-
getMediaInfo()
→ ZegoUIKitMediaInfo
-
inherited
-
getMediaList()
→ List<ZegoUIKitUser>
-
get media list
inherited
-
getMediaListStream()
→ Stream<List<ZegoUIKitUser>>
-
inherited
-
getMediaMuteNotifier()
→ ValueNotifier<bool>
-
inherited
-
getMediaPlayStateNotifier()
→ ValueNotifier<ZegoUIKitMediaPlayState>
-
inherited
-
getMediaTotalDuration()
→ int
-
Get the total progress of your media resources, Returns Unit is millisecond.
inherited
-
getMediaType()
→ ZegoUIKitMediaType
-
inherited
-
getMediaTypeNotifier()
→ ValueNotifier<ZegoUIKitMediaType>
-
inherited
-
getMediaVolume()
→ int
-
inherited
-
getMediaVolumeNotifier()
→ ValueNotifier<int>
-
inherited
-
getMeRemovedFromRoomStream()
→ Stream<String>
-
get kicked out notifier
inherited
-
getMicrophoneStateNotifier(String userID)
→ ValueNotifier<bool>
-
get microphone state notifier
inherited
-
getMixAudioVideoCameraStateNotifier(String mixerID, String userID)
→ ValueNotifier<bool>
-
inherited
-
getMixAudioVideoLoadedNotifier(String mixerID)
→ ValueNotifier<bool>
-
inherited
-
getMixAudioVideoMicrophoneStateNotifier(String mixerID, String userID)
→ ValueNotifier<bool>
-
inherited
-
getMixAudioVideoViewNotifier(String mixerID)
→ ValueNotifier<Widget?>
-
inherited
-
getMixedSoundLevelsStream()
→ Stream<Map<int, double>>
-
get mixed sound level notifier
inherited
-
getMixedSoundLevelStream(String userID)
→ Stream<double>
-
get sound level notifier
inherited
-
getMixerStreamUsers(String mixerStreamID)
→ List<ZegoUIKitUser>
-
inherited
-
getMixerUserListStream(String mixerStreamID)
→ Stream<List<ZegoUIKitUser>>
-
get user list notifier
inherited
-
getNetworkModeStream()
→ Stream<ZegoNetworkMode>
-
get network state notifier
inherited
-
getNetworkTime()
→ ValueNotifier<DateTime?>
-
-
getPlugin(ZegoUIKitPluginType type)
→ IZegoUIKitPlugin?
-
get plugin object
inherited
-
getReceiveCustomSEIStream()
→ Stream<ZegoUIKitReceiveSEIEvent>
-
inherited
-
getReceiveSEIStream()
→ Stream<ZegoUIKitReceiveSEIEvent>
-
inherited
-
getRemoteUsers()
→ List<ZegoUIKitUser>
-
get remote users, not include local user
inherited
-
getRoom()
→ ZegoUIKitRoom
-
get room object
inherited
-
getRoomProperties()
→ Map<String, RoomProperty>
-
get room properties
inherited
-
getRoomPropertiesStream()
→ Stream<Map<String, RoomProperty>>
-
only notify the properties which changed
you can get full properties by getRoomProperties() function
inherited
-
getRoomPropertyStream()
→ Stream<RoomProperty>
-
only notify the property which changed
you can get full properties by getRoomProperties() function
inherited
-
getRoomStateStream()
→ ValueNotifier<ZegoUIKitRoomState>
-
get room state notifier
inherited
-
getRoomTokenExpiredStream()
→ Stream<int>
-
the room Token authentication is about to expire will be sent 30 seconds before the Token expires
inherited
-
getScreenSharingList()
→ List<ZegoUIKitUser>
-
get screen sharing list
inherited
-
getScreenSharingListStream()
→ Stream<List<ZegoUIKitUser>>
-
inherited
-
getScreenSharingStateNotifier()
→ ValueNotifier<bool>
-
get screen share notifier
inherited
-
getSignalingPlugin()
→ ZegoUIKitSignalingPluginImpl
-
signal plugin
inherited
-
getSoundLevelStream(String userID)
→ Stream<double>
-
get sound level notifier
inherited
-
getTurnOnYourCameraRequestStream()
→ Stream<String>
-
protocol: String is 'operator'
inherited
-
getTurnOnYourMicrophoneRequestStream()
→ Stream<ZegoUIKitReceiveTurnOnLocalMicrophoneEvent>
-
inherited
-
getUseFrontFacingCameraStateNotifier(String userID)
→ ValueNotifier<bool>
-
get front facing camera switch notifier
inherited
-
getUser(String userID)
→ ZegoUIKitUser
-
get user by user id
inherited
-
getUserInMixerStream(String userID)
→ ZegoUIKitUser
-
inherited
-
getUserJoinStream()
→ Stream<List<ZegoUIKitUser>>
-
get user join notifier
inherited
-
getUserLeaveStream()
→ Stream<List<ZegoUIKitUser>>
-
get user leave notifier
inherited
-
getUserListStream()
→ Stream<List<ZegoUIKitUser>>
-
get user list notifier
inherited
-
getVideoSizeNotifier(String userID)
→ ValueNotifier<Size>
-
get video size notifier
inherited
-
getZegoUIKitVersion()
→ Future<String>
-
version
-
init({required int appID, String appSign = '', bool? enablePlatformView, ZegoScenario scenario = ZegoScenario.Default})
→ Future<void>
-
init
-
initLog({String folderName = 'uikit'})
→ Future<void>
-
inherited
-
installPlugins(List<IZegoUIKitPlugin> plugins)
→ void
-
install plugins
inherited
-
isLockScreen()
→ Future<bool>
-
Android/IOS is lock screen
inherited
-
joinRoom(String roomID, {String token = '', bool markAsLargeRoom = false})
→ Future<ZegoRoomLoginResult>
-
join room
inherited
-
leaveRoom({String? targetRoomID})
→ Future<ZegoRoomLogoutResult>
-
leave room
inherited
-
login(String id, String name)
→ void
-
login
inherited
-
logout()
→ void
-
logout
inherited
-
muteMediaLocal(bool mute)
→ Future<void>
-
inherited
-
muteUserAudio(String userID, bool mute)
→ Future<bool>
-
When the
mute
is set to true, it means that the device is not actually turned off, but muted.
The default value is false, which means the device is turned off.
When either the camera or the microphone is muted, the audio and video views will still be visible.
inherited
-
muteUserAudioVideo(String userID, bool mute)
→ Future<bool>
-
When the
mute
is set to true, it means that the device is not actually turned off, but muted.
The default value is false, which means the device is turned off.
When either the camera or the microphone is muted, the audio and video views will still be visible.
inherited
-
muteUserVideo(String userID, bool mute)
→ Future<bool>
-
When the
mute
is set to true, it means that the device is not actually turned off, but muted.
The default value is false, which means the device is turned off.
When either the camera or the microphone is muted, the audio and video views will still be visible.
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
onWillPop(BuildContext context)
→ Future<bool>
-
'onWillPop' in Android returns true will cause the Flutter engine to be destroyed,
resulting in the inability to interact between native code and Flutter code.
inherited
-
pauseMedia()
→ Future<void>
-
Pause playing.
inherited
-
pickMediaFile({List<String>? allowedExtensions})
→ Future<List<PlatformFile>>
-
If you want to specify the allowed formats, you can set them using
allowedExtensions
.
Currently, for video, we support "avi", "flv", "mkv", "mov", "mp4", "mpeg", "webm", "wmv".
For audio, we support "aac", "midi", "mp3", "ogg", "wav".
inherited
-
pickPureAudioMediaFile()
→ Future<List<PlatformFile>>
-
inherited
-
pickVideoMediaFile()
→ Future<List<PlatformFile>>
-
inherited
-
playMedia({required String filePathOrURL, bool enableRepeat = false, bool autoStart = true})
→ Future<ZegoUIKitMediaPlayResult>
-
Start playing.
inherited
-
pluginsInstallNotifier()
→ ValueNotifier<List<ZegoUIKitPluginType>>
-
inherited
-
registerExpressEvent(ZegoUIKitExpressEventInterface event)
→ void
-
-
registerMediaEvent(ZegoUIKitMediaEventInterface event)
→ void
-
inherited
-
removeUserFromRoom(List<String> userIDs)
→ Future<bool>
-
remove user from room, kick out
inherited
-
renewRoomToken(String token)
→ Future<void>
-
inherited
-
requestDismissKeyguard()
→ Future<void>
-
inherited
-
resendInRoomMessage(ZegoInRoomMessage message, {ZegoInRoomMessageType type = ZegoInRoomMessageType.broadcastMessage})
→ Future<bool>
-
re-send in-room message
inherited
-
resetBeautyEffect()
→ Future<void>
-
reset beauty effect
inherited
-
resetSoundEffect()
→ Future<void>
-
reset sound effect
inherited
-
resumeMedia()
→ Future<void>
-
Resume playing.
inherited
-
seekTo(int millisecond)
→ Future<ZegoUIKitMediaSeekToResult>
-
Set the specified playback progress, Unit is millisecond.
inherited
-
sendCustomSEI(Map<String, dynamic> seiData, {ZegoStreamType streamType = ZegoStreamType.main})
→ Future<bool>
-
MUST call after pushing the stream(turn on camera of microphone)
SEI data will transmit by the audio and video stream
inherited
-
sendInRoomCommand(String command, List<String> toUserIDs)
→ Future<bool>
-
toUserIDs
send to everyone if empty
inherited
-
sendInRoomMessage(String message, {ZegoInRoomMessageType type = ZegoInRoomMessageType.broadcastMessage})
→ Future<bool>
-
send in-room message
inherited
-
setAdvanceConfigs(Map<String, String> configs)
→ Future<void>
-
Set advanced engine configuration, Used to enable advanced functions.
For details, please consult ZEGO technical support.
-
setAudioOutputToSpeaker(bool isSpeaker)
→ void
-
set audio output to speaker
inherited
-
setAudioVideoResourceMode(ZegoAudioVideoResourceMode mode)
→ void
-
inherited
-
setBeautifyValue(int value, BeautyEffectType type)
→ void
-
Set the intensity of the specific face beautify feature
Description: After the face beautify feature is enabled, you can specify the parameters to set the intensity of the specific feature as needed.
inherited
-
setMediaVolume(int volume, {bool isSyncToRemote = false})
→ Future<void>
-
Set media player volume.
inherited
-
setReverbType(ZegoReverbPreset reverbPreset)
→ void
-
Set reverb
Description: This method can be used to use the reverb effect in the room.
inherited
-
setRoomProperty(String key, String value)
→ Future<bool>
-
update one room property
inherited
-
setVideoConfig(ZegoUIKitVideoConfig config, {ZegoStreamType streamType = ZegoStreamType.main})
→ Future<void>
-
update video config
inherited
-
setVoiceChangerType(ZegoVoiceChangerPreset voicePreset)
→ void
-
Set voice changing
Description: This method can be used to change the voice with voice effects.
inherited
-
startEffectsEnv()
→ Future<void>
-
start effects env
inherited
-
startMedia()
→ Future<void>
-
Start playing.
inherited
-
startMixerTask(ZegoMixerTask task)
→ Future<ZegoMixerStartResult>
-
inherited
-
startPlayAllAudioVideo()
→ Future<void>
-
start play all audio video
inherited
-
startPlayAnotherRoomAudioVideo(String roomID, String userID, {String userName = ''})
→ Future<void>
-
inherited
-
startPlayMixAudioVideo(String mixerID, List<ZegoUIKitUser> users, Map<String, int> userSoundIDs)
→ Future<void>
-
userSoundIDs
is a map<user id, sound id>
inherited
-
startSharingScreen()
→ Future<void>
-
start share screen
inherited
-
stopEffectsEnv()
→ Future<void>
-
stop effects env
inherited
-
stopMedia()
→ Future<void>
-
Stop playing.
inherited
-
stopMixerTask(ZegoMixerTask task)
→ Future<ZegoMixerStopResult>
-
inherited
-
stopPlayAllAudioVideo()
→ Future<void>
-
stop play all audio video
inherited
-
stopPlayAnotherRoomAudioVideo(String userID)
→ Future<void>
-
inherited
-
stopPlayMixAudioVideo(String mixerID)
→ Future<void>
-
inherited
-
stopSharingScreen()
→ Future<void>
-
stop share screen
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
turnCameraOn(bool isOn, {String? userID})
→ void
-
turn on/off camera
inherited
-
turnMicrophoneOn(bool isOn, {String? userID, bool muteMode = false})
→ void
-
turn on/off microphone
inherited
-
uninit()
→ Future<void>
-
uninit
-
uninstallPlugins(List<IZegoUIKitPlugin> plugins)
→ void
-
uninstall plugins
inherited
-
unregisterExpressEvent(ZegoUIKitExpressEventInterface event)
→ void
-
-
unregisterMediaEvent(ZegoUIKitMediaEventInterface event)
→ void
-
inherited
-
updateAppOrientation(DeviceOrientation orientation)
→ void
-
update app orientation
inherited
-
updateRoomProperties(Map<String, String> properties)
→ Future<bool>
-
update room properties
inherited
-
updateTextureRendererOrientation(Orientation orientation)
→ void
-
update texture render orientation
inherited
-
updateVideoViewMode(bool useVideoViewAspectFill)
→ void
-
update video view mode
inherited
-
useFrontFacingCamera(bool isFrontFacing)
→ void
-
local use front facing camera
inherited