Configs topic

Invitation

ZegoCallRingtoneConfig

online call ringtone config Note that it only works for online calls. If it is offline, please configure it in the zego console

  • String? incomingCallPath

callee ringtone on local side, please note that the resource needs to be configured in your flutter project example: "assets/ringtone/incomingCallRingtone.mp3"

  • String? outgoingCallPath

caller ringtone on local side, please note that the resource needs to be configured in your flutter project example: "assets/ringtone/outgoingCallRingtone.mp3"

ZegoCallInvitationUIConfig

  • bool prebuiltWithSafeArea: does ZegoUIKitPrebuiltCall display with SafeArea or not

  • ZegoCallInvitationNotifyPopUpUIConfig popUp: config of call invitation pop-up dialog

    • EdgeInsetsGeometry? padding: popup's padding

    • double? width: popup's width

    • double? height: popup's height

    • Decoration? decoration: popup's decoration

    • bool visible:

    when receiving an online call, whether to pop up the top pop-up dialog

    If you want to customize the invitation pop-up dialog, set visible to false and listen ZegoUIKitPrebuiltCallInvitationEvents.onIncomingCallReceived, when you receive the invitation event, show invitation widget

    invitationEvents: ZegoUIKitPrebuiltCallInvitationEvents(
  onIncomingCallReceived: (
    String callID,
    ZegoCallUser caller,
    ZegoCallType callType,
    List<ZegoCallUser> callees,
    String customData,
  ) {
  /// show your custom call notification
  },
),
uiConfig: ZegoCallInvitationUIConfig(
  popUp: ZegoCallInvitationNotifyPopUpUIConfig(
    visible: false,
  ),
),
    • ZegoCallInvitationNotifyDialogBuilder? builder:

    custom the top pop-up dialog which receiving an online call

    popUp: ZegoCallInvitationNotifyPopUpUIConfig(
        builder: (
          ZegoCallInvitationData invitationData,
        ) {
        /// show your custom popup dialog,
        /// and call ZegoUIKitPrebuiltCallInvitationService().accept() if you accept
        /// and call ZegoUIKitPrebuiltCallInvitationService().reject() if you reject
        },
      ),

  • ZegoCallingBackgroundBuilder? callingBackgroundBuilder: background builder, default is a image

  • ZegoCallButtonUIConfig declineButton

  • ZegoCallButtonUIConfig acceptButton

  • ZegoCallButtonUIConfig cancelButton

ZegoCallInvitationNotificationConfig

  • ZegoCallIOSNotificationConfig? iOSNotificationConfig:

    • bool? isSandboxEnvironment: is iOS sandbox or not

    • ZegoSignalingPluginMultiCertificate certificateIndex: Corresponding certificate index configured by Zego console

    • String systemCallingIconName:

    Customizing the icon for the iOS CallKit lock screen interface

    Below, we will using the example of setting a CallKitIcon icon, to explain how to set the icon for the CallKit lock screen interface on iOS system .

    Place your icon file in the ios/Runner/Assets.xcassets/ folder, with the file name CallKitIcon.imageset. When calling ZegoUIKitPrebuiltCallInvitationService.init, configure the iOSNotificationConfig.systemCallingIconName parameter with the file name (without the file extension).

    such as : iOSNotificationConfig: ZegoCallIOSNotificationConfig( systemCallingIconName: 'CallKitIcon', ),

  • ZegoCallAndroidNotificationConfig? androidNotificationConfig: android notification config

    • Call

      • String channelID: specify the channel id of notification, which is same in 'Zego Console'

      • String channelName: specify the channel name of notification, which is same in 'Zego Console'

      • String? icon: specify the icon file name id of notification, additionally, you must place your icon file in the following path: ${project_root}/android/app/src/main/res/drawable/${icon}.png

      • String? sound:

      specify the sound file name id of notification, which is same in 'Zego Console'. Additionally, you must place your audio file in the following path: ${project_root}/android/app/src/main/res/raw/${sound}.mp3

      • bool vibrate: vibrate or not

      • bool callIDVisibility: specify the call id show or hide

      • bool showFullScreen:

      only for offline call, displayed in full screen or not when the screen is locked, default value is false. and THE IMPORTANT IS, if set showFullScreen to true, then you need set android:launchMode="singleInstance" in manifest/application/activity node of ${project_root} /android/app/src/main/AndroidManifest.xml

    • message(ZIMKit)

      • String messageChannelID: specify the channel id of message notification, which is same in 'Zego Console'

      • String messageChannelName: specify the channel name of message notification, which is same in 'Zego Console'

      • String? messageIcon: specify the icon file name id of message notification, additionally, you must place your icon file in the following path: ${project_root}/android/app/src/main/res/drawable/${icon}.png

      • String? messageSound: specify the sound file name id of message notification, which is same in 'Zego Console'. additionally, you must place your audio file in the following path: ${project_root}/android/app/src/main/res/raw/${sound}.mp3

      • bool messageVibrate: vibrate or not if message arrived

ZegoUIKitPrebuiltCallConfig

construtors

  • groupVideoCall: Default initialization parameters for the group video call.
  • groupVoiceCall: Default initialization parameters for the group voice call.
  • oneOnOneVideoCall: Default initialization parameters for the one-on-one video call
  • oneOnOneVoiceCall: Default initialization parameters for the one-on-one voice call

parameters

ZegoUIKitVideoConfig video

configuration parameters for audio and video streaming, such as Resolution, Frame rate, Bit rate. you can set by video = ZegoUIKitVideoConfig.presetXX()

  • parameters:

    • int fps: Frame rate, control the frame rate of the camera and the frame rate of the encoder.
    • int bitrate: Bit rate in kbps.
    • int width: resolution width, control the image width of camera image acquisition or encoder when publishing stream.
    • int height: resolution height, control the image height of camera image acquisition or encoder when publishing stream.

  • construtors:

    • preset180P
    • preset270P
    • preset360P
    • preset540P
    • preset720P
    • preset1080P
    • preset2K
    • preset4K

ZegoCallAudioVideoViewConfig audioVideoView

Configuration options for audio/video views.

You can use the ZegoUIKitPrebuiltCallConfig.audioVideoView property to set the properties inside this class.

These options allow you to customize the display effects of the audio/video views, such as showing microphone status and usernames.

If you need to customize the foreground or background of the audio/video view, you can use foregroundBuilder and backgroundBuilder.

If you want to hide user avatars or sound waveforms in audio mode, you can set showAvatarInAudioMode and showSoundWavesInAudioMode to false.

Custom audio/video view. If you don't want to use the default view components, you can pass a custom component through this parameter.

typedef ZegoCallAudioVideoContainerBuilder = Widget Function(
 BuildContext,
 List<ZegoUIKitUser> allUsers,
 List<ZegoUIKitUser> audioVideoUsers,
 /// The default audio-video view creator, you can also use [ZegoAudioVideoView] as a child control to continue encapsulating
 ZegoAudioVideoView Function(ZegoUIKitUser) audioVideoViewCreator,
);
  • Rect Function()? containerRect:

Specify the rect of the audio & video container. If not specified, it defaults to display full.

  • bool isVideoMirror:

Whether to mirror the displayed video captured by the camera.

This mirroring effect only applies to the front-facing camera.

Set it to true to enable mirroring, which flips the image horizontally.

  • bool showMicrophoneStateOnView:

Whether to display the microphone status on the audio/video view.

Set it to false if you don't want to show the microphone status on the audio/video view.

  • bool showCameraStateOnView:

Whether to display the camera status on the audio/video view.

Set it to false if you don't want to show the camera status on the audio/video view.

  • bool showUserNameOnView:

Whether to display the username on the audio/video view.

Set it to false if you don't want to show the username on the audio/video view.

  • ZegoAudioVideoViewForegroundBuilder? foregroundBuilder:

You can customize the foreground of the audio/video view, which refers to the widget positioned on top of the view.

You can return any widget, and we will place it at the top of the audio/video view.

/// type of audio video view foreground builder
typedef ZegoAudioVideoViewForegroundBuilder = Widget Function(
 BuildContext context,
 Size size,
 ZegoUIKitUser? user,
 Map<String, dynamic> extraInfo,
);
  • ZegoAudioVideoViewBackgroundBuilder? backgroundBuilder:

Background for the audio/video windows in a call.

You can use any widget as the background for the audio/video windows. This can be a video, a GIF animation, an image, a web page, or any other widget.

If you need to dynamically change the background content, you should implement the logic for dynamic modification within the widget you return.

/// type of audio video view background builder
typedef ZegoAudioVideoViewBackgroundBuilder = Widget Function(
 BuildContext context,
 Size size,
 ZegoUIKitUser? user,
 Map<String, dynamic> extraInfo,
);
  • bool useVideoViewAspectFill:

Video view mode.

Set it to true if you want the video view to scale proportionally to fill the entire view, potentially resulting in partial cropping.

Set it to false if you want the video view to scale proportionally, potentially resulting in black borders.

  • bool showAvatarInAudioMode:

Whether to display user avatars in audio mode.

Set it to false if you don't want to show user avatars in audio mode.

  • bool showSoundWavesInAudioMode:

Whether to display sound waveforms in audio mode.

Set it to false if you don't want to show sound waveforms in audio mode.

ZegoCallTopMenuBarConfig topMenuBar

Configuration options for the top menu bar (toolbar). You can use these options to customize the appearance and behavior of the top menu bar.

  • bool isVisible: Whether to display the top menu bar.
  • String title: Title of the top menu bar.
  • bool hideAutomatically: Whether to automatically collapse the top menu bar after 5 seconds of inactivity.
  • bool hideByClick: Whether to collapse the top menu bar when clicking on the blank area.
  • List<ZegoCallMenuBarButtonName> buttons: Buttons displayed on the menu bar. The buttons will be arranged in the order specified in the list.
  • List<Widget> extendButtons: Extension buttons that allow you to add your own buttons to the top toolbar.: These buttons will be added to the menu bar in the specified order.: If the limit of 3 is exceeded, additional buttons will be automatically added to the overflow menu.
  • ZegoCallMenuBarStyle style: Style of the top menu bar.
  • EdgeInsetsGeometry? padding: Padding for the top menu bar.
  • EdgeInsetsGeometry? margin: Margin for the top menu bar.
  • Color? backgroundColor: Background color for the top menu bar.
  • double? height: Height for the top menu bar.

ZegoCallBottomMenuBarConfig bottomMenuBar

Configuration options for the bottom menu bar (toolbar). You can use these options to customize the appearance and behavior of the bottom menu bar.

  • bool isVisible: Whether to display the bottom menu bar.

  • bool hideAutomatically: Whether to automatically collapse the top menu bar after 5 seconds of inactivity.

  • bool hideByClick: Whether to collapse the top menu bar when clicking on the blank area.

  • List<ZegoCallMenuBarButtonName> buttons: Buttons displayed on the menu bar. The buttons will be arranged in the order specified in the list.

  • int maxCount:

Controls the maximum number of buttons to be displayed in the menu bar (toolbar).

When the number of buttons exceeds the maxCount limit, a "More" button will appear.

Clicking on it will display a panel showing other buttons that cannot be displayed in the menu bar (toolbar).

  • ZegoCallMenuBarStyle style: Button style for the bottom menu bar.

  • EdgeInsetsGeometry? padding: Padding for the bottom menu bar.

  • EdgeInsetsGeometry? margin: Margin for the bottom menu bar.

  • Color? backgroundColor: Background color for the bottom menu bar.

  • double? height: Height for the bottom menu bar.

  • List<Widget> extendButtons:

Extension buttons that allow you to add your own buttons to the top toolbar.

These buttons will be added to the menu bar in the specified order.

If the limit of maxCount is exceeded, additional buttons will be automatically added to the overflow menu.

ZegoCallMemberListConfig memberList

Configuration related to the bottom member list, including displaying the member list, member list styles, and more.

  • bool showMicrophoneState: Whether to show the microphone state of the member. Defaults to true, which means it will be shown.

  • bool showCameraState:

Whether to show the camera state of the member.

Defaults to true, which means it will be shown.

  • ZegoMemberListItemBuilder? itemBuilder: Custom member list item view.

ZegoBeautyPluginConfig? beauty

advance beauty config

  • List<ZegoBeautyPluginEffectsType> effectsTypes

  • ZegoBeautyPluginInnerText innerText

  • ZegoBeautyPluginUIConfig uiConfig:

    • Color? backgroundColor
    • Color? selectedIconBorderColor
    • Color? selectedIconDotColor
    • TextStyle? selectedTextStyle
    • TextStyle? normalTextStyle
    • TextStyle? sliderTextStyle
    • Color? sliderTextBackgroundColor
    • Color? sliderActiveTrackColor
    • Color? sliderInactiveTrackColor
    • Color? sliderThumbColor
    • double? sliderThumbRadius
    • Widget? backIcon
    • TextStyle? normalHeaderTitleTextStyle
    • TextStyle? selectHeaderTitleTextStyle

  • String? segmentationBackgroundImageName: backgroundPortraitSegmentation feature need use this path.

  • bool enableFaceDetection: if true, can use getFaceDetection to notify face detection.

  • ZegoBeautyPluginSegmentationScaleMode segmentationScaleMode

ZegoCallDurationConfig duration

Call timing configuration.

  • bool isVisible: Whether to display call timing.
  • void Function(Duration)? onDurationUpdate: Call timing callback function, called every second.

Example: Set to automatically hang up after 5 minutes.

..duration.isVisible = true
..duration.onDurationUpdate = (Duration duration) {
 if (duration.inSeconds >= 5 * 60) {
   callController?.hangUp(context);
 }
}

ZegoCallInRoomChatViewConfig chatView

Configuration related to the bottom-left message list.

  • ZegoInRoomMessageItemBuilder? itemBuilder:

Use this to customize the style and content of each chat message list item.

For example, you can modify the background color, opacity, border radius, or add additional information like the sender's level or role.

/// Chat message list builder for customizing the display of chat messages.
typedef ZegoInRoomMessageItemBuilder = Widget Function(
 BuildContext context,
 ZegoInRoomMessage message,
 Map<String, dynamic> extraInfo,
);

ZegoCallHangUpConfirmDialogConfig? hangUpConfirmDialog

Confirmation dialog when hang up the call.

  • ZegoCallHangUpConfirmDialogInfo? info: dialog information, If not set, clicking the exit button will directly exit the call. If set, a confirmation dialog will be displayed when clicking the exit button, and you will need to confirm the exit before actually exiting.
  • TextStyle? titleStyle: title text style
  • TextStyle? contentStyle: content text style
  • TextStyle? actionTextStyle: action button text style
  • Brightness? backgroundBrightness: background brightness

Map<String, String> advanceConfigs

Set advanced engine configuration, Used to enable advanced functions.

For details, please consult ZEGO technical support.

bool turnOnCameraWhenJoining

Whether to open the camera when joining the call.

If you want to join the call with your camera closed, set this value to false;

if you want to join the call with your camera open, set this value to true.

The default value is true.

bool turnOnMicrophoneWhenJoining

Whether to open the microphone when joining the call.

If you want to join the call with your microphone closed, set this value to false;

if you want to join the call with your microphone open, set this value to true.

The default value is true.

bool useSpeakerWhenJoining

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.

ZegoLayout layout

Layout-related configuration. You can choose your layout here.

Widget? foreground

The foreground of the call.

If you need to nest some widgets in ZegoUIKitPrebuiltCall, please use foreground nesting, otherwise these widgets will be lost when you minimize and restore the ZegoUIKitPrebuiltCall

Widget? background

The background of the call.

You can use any Widget as the background of the call, such as a video, a GIF animation, an image, a web page, etc.

If you need to dynamically change the background content, you will need to implement the logic for dynamic modification within the Widget you return.

..background = Container(
   width: size.width,
   height: size.height,
   decoration: const BoxDecoration(
     image: DecorationImage(
       fit: BoxFit.fitHeight,
       image: ,
     )));

ZegoAvatarBuilder? avatarBuilder

Use this to customize the avatar, and replace the default avatar with it.

Example：

// eg:
avatarBuilder: (BuildContext context, Size size, ZegoUIKitUser? user, Map extraInfo) {
 return user != null
     ? Container(
         decoration: BoxDecoration(
           shape: BoxShape.circle,
           image: DecorationImage(
             image: NetworkImage(
               'https://your_server/app/avatar/${user.id}.png',
             ),
           ),
         ),
       )
     : const SizedBox();
},

bool rootNavigator

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.

Classes

ZegoUIKitPrebuiltCall APIs Events Configs Migration_v4.x
Call Widget. You can embed this widget into any page of your project to integrate the functionality of a call. You can refer to our documentation, or our sample code.