ZegoUIKitPrebuiltCallConfig class

Configuration for initializing the Call This class is used as the config parameter for the constructor of ZegoUIKitPrebuiltCall.

Available extensions

Constructors

ZegoUIKitPrebuiltCallConfig({bool turnOnCameraWhenJoining = true, bool turnOnMicrophoneWhenJoining = true, bool useSpeakerWhenJoining = false, bool rootNavigator = false, Map<String, String> advanceConfigs = const {}, ZegoUIKitVideoConfig? videoConfig, ZegoCallAudioVideoViewConfig? audioVideoViewConfig, ZegoCallTopMenuBarConfig? topMenuBarConfig, ZegoCallBottomMenuBarConfig? bottomMenuBarConfig, ZegoCallMemberListConfig? memberListConfig, ZegoCallPIPConfig? pipConfig, ZegoCallDurationConfig? durationConfig, ZegoCallInRoomChatViewConfig? chatViewConfig, ZegoCallHangUpConfirmDialogConfig? hangUpConfirmDialog, ZegoCallUserConfig? userConfig, ZegoLayout? layout, Widget? foreground, Widget? background, ZegoAvatarBuilder? avatarBuilder, ZegoUIKitPrebuiltCallInnerText? translationText, ZegoCallAudioEffectConfig? audioEffect})
ZegoUIKitPrebuiltCallConfig.groupVideoCall()
Default initialization parameters for the group video call. If a configuration item does not meet your expectations, you can directly override its value.
factory
ZegoUIKitPrebuiltCallConfig.groupVoiceCall()
Default initialization parameters for the group voice call. If a configuration item does not meet your expectations, you can directly override its value.
factory
ZegoUIKitPrebuiltCallConfig.oneOnOneVideoCall()
Default initialization parameters for the one-on-one video call. If a configuration item does not meet your expectations, you can directly override its value.
factory
ZegoUIKitPrebuiltCallConfig.oneOnOneVoiceCall()
Default initialization parameters for the one-on-one voice call. If a configuration item does not meet your expectations, you can directly override its value.
factory

Properties

advanceConfigs ↔ Map<String, String>
Set advanced engine configuration, Used to enable advanced functions. For details, please consult ZEGO technical support.
getter/setter pair
audioEffect ↔ ZegoCallAudioEffectConfig
Configuration options for voice changer and reverberation effects.
getter/setter pair
audioVideoView ↔ ZegoCallAudioVideoViewConfig
Configuration options for audio/video views.
getter/setter pair
avatarBuilder ↔ ZegoAvatarBuilder?
Use this to customize the avatar, and replace the default avatar with it.
getter/setter pair
background ↔ Widget?
The background of the call.
getter/setter pair
beauty ↔ ZegoBeautyPluginConfig?
advance beauty config
getter/setter pair
bottomMenuBar ↔ ZegoCallBottomMenuBarConfig
Configuration options for the bottom menu bar (toolbar). You can use these options to customize the appearance and behavior of the bottom menu bar.
getter/setter pair
chatView ↔ ZegoCallInRoomChatViewConfig
Configuration related to the bottom-left message list.
getter/setter pair
duration ↔ ZegoCallDurationConfig
Call timing configuration.
getter/setter pair
foreground ↔ Widget?
The foreground of the call.
getter/setter pair
hangUpConfirmDialog ↔ ZegoCallHangUpConfirmDialogConfig
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
layout ↔ ZegoLayout
Layout-related configuration. You can choose your layout here.
getter/setter pair
memberList ↔ ZegoCallMemberListConfig
Configuration related to the bottom member list, including displaying the member list, member list styles, and more.
getter/setter pair
pip ↔ ZegoCallPIPConfig
getter/setter pair
rootNavigator ↔ bool
same as Flutter's Navigator's param If rootNavigator is set to true, the state from the furthest instance of this class is given instead. Useful for pushing contents above all subsequent instances of Navigator.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
topMenuBar ↔ ZegoCallTopMenuBarConfig
Configuration options for the top menu bar (toolbar). You can use these options to customize the appearance and behavior of the top menu bar.
getter/setter pair
translationText ↔ ZegoUIKitPrebuiltCallInnerText
Configuration options for modifying all calling page's text content on the UI. All visible text content on the UI can be modified using this single property.
getter/setter pair
turnOnCameraWhenJoining ↔ bool
Whether to open the camera when joining the call.
getter/setter pair
turnOnMicrophoneWhenJoining ↔ bool
Whether to open the microphone when joining the call.
getter/setter pair
user ↔ ZegoCallUserConfig
config about users.
getter/setter pair
useSpeakerWhenJoining ↔ bool
Whether to use the speaker to play audio when joining the call. The default value is false, but it will be set to true if the user is in a group call or video call. If this value is set to false, the system's default playback device, such as the earpiece or Bluetooth headset, will be used for audio playback.
getter/setter pair
video ↔ ZegoUIKitVideoConfig
configuration parameters for audio and video streaming, such as Resolution, Frame rate, Bit rate.. you can set by video = ZegoUIKitVideoConfig.presetXX()
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited