Call Kit
  • iOS : Swift
  • Android
  • Web
  • Flutter
  • React Native
  • Overview
  • Quick start
    • Quick start
    • Quick start (with call invitation)
  • Customize the call
    • Overview
    • Add custom components to the call
    • Configure layouts
    • Hide the label on the user view
    • Implement an audio-only call
    • Customize the menu bar
    • Set a hangup confirmation dialog
    • Call invitation config
    • Calculate call duration
  • Enhance the call
    • Minimize video call window
  • API Reference
    • API
    • Event
    • Config
  • Documentation
  • Call Kit
  • API Reference
  • Config

Config

Last updated:2024-04-28 14:20


ZegoUIKitPrebuiltCallConfig

audioVideoViewConfig

Configure the UI of the audio and video view, such as microphone and camera status ICONS, whether to display the user name, sound wave effect, and video display mode

bottomMenuBarConfig

The bar configuration parameters at the bottom of the call page, such as the bar button at the bottom, the limit on the number of buttons, whether to hide automatically, whether to click other areas to hide, and the color style.

layout

Call page audio and video window display style, including picture in picture layout, flow layout.

turnOnCameraWhenJoining

Whether the camera is enabled by default. The default value is enabled.

turnOnMicrophoneWhenJoining

Is the microphone enabled by default? It is enabled by default.

useSpeakerWhenJoining

Whether to enable the speaker by default

hangUpConfirmDialogInfo

Whether to display information about the Leave Room dialog box when the hang up button is clicked. If it is not set, it will not be displayed. If it is set, it will be displayed.

memberListConfig

The call member list displays configurations, such as the member's camera and microphone status

topMenuBarConfig

The bar configuration parameters at the top of the call page, such as the bar button at the top, the limit on the number of buttons, whether to hide automatically, whether to click other areas to hide, and the color style.

showCallDuration

Whether to display call duration. The default value is true

ZegoPrebuiltAudioVideoViewConfig

showMicrophoneStateOnView

Used to control whether the default MicrophoneStateIcon for the prebuilt layer is displayed on VideoView.

showCameraStateOnView

Used to control whether the default CameraStateIcon for the prebuilt layer is displayed on VideoView.

showUserNameOnView

Controls whether to display the default UserNameLabel for the prebuilt layer on VideoView.

showSoundWavesInAudioMode

Whether to display the sound waves around the profile picture in voice mode.

useVideoViewAspectFill

Default true, normal black edge mode (otherwise landscape is ugly).

videoViewForegroundViewProvider

custom video view foregroundView

ZegoBottomMenuBarConfig

buttons

Buttons that need to be displayed on the MenuBar are displayed in the order of the actual List.

maxCount

The maximum number of buttons that can be displayed in the MenuBar, which is a maximum of 5. If this value is exceeded, the More button is displayed. Note that this value contains the "more" button.

hideAutomatically

Yes no operation on the screen for 5 seconds, or if the user clicks the position of the non-response area on the screen, the top and bottom will be folded up.

hideByClick

Whether the user can click the position of the non-responsive area of the screen, and fold up the top and bottom.

style

MenuBar display color, there are two kinds of high light and dark.

buttonConfig

MenuBar button config, use this config to change the icon of buttons.

ZegoMemberListConfig

showMicrophoneState

Whether to display the status icon of the microphone,the default value is true.

showCameraState

Whether to display the status icon of the camera. The default value is true.

ZegoTopMenuBarConfig

buttons

Buttons that need to be displayed on the MenuBar are displayed in the order of the actual List.

hideAutomatically

Yes no operation on the screen for 5 seconds, or if the user clicks the position of the non-response area on the screen, the top and bottom will be folded up.

hideByClick

Whether the user can click the position of the non-responsive area of the screen, and fold up the top and bottom.

style

MenuBar display color, there are two kinds of high light and dark.

isVisible

Whether it is visible. The default value is false.

buttonConfig

MenuBar button config, use this config to change the icon of buttons.

ZegoMenuBarButtonConfig

toggleCameraOnImage

Customize the camera button icon for the on state.

toggleCameraOffImage

Customize the camera button icon for the off state.

toggleMicrophoneOnImage

Customize the microphone button icon for the on state.

toggleMicrophoneOffImage

Customize the microphone button icon for the off state.

hangUpButtonImage

Customize the icon of hangup button.

switchCameraFrontImage

Customize the switch Camera button icon for the front state.

switchCameraBackImage

Customize the switch Camera button icon for the back state.

showMemberListButtonImage

Customize the icon of member list button.

chatButtonImage

Customize the icon of chat button.

minimizingButtonImage

Customize the icon of minimizing button.

audioOutputSpeakerImage

Customize the audio output button icon for the speaker state.

audioOutputEarSpeakerImage

Customize the audio output button icon for the ear speaker state.

audioOutputBluetoothImage

Customize the audio output button icon for the bluetooth state.

Page Directory