logo
当前页

Config


ZegoUIKitPrebuiltCallInvitationConfig

通话配置类

属性类型描述
incomingCallRingtoneString配置在线来电呼叫的铃声。资源文件需要放到 res/raw/ 目录下,设置该参数时不用填写文件名后缀。例如:在res/raw/ 目录下添加了 zego_incoming.mp3 资源文件,那么就把 incomingCallRingtone 设置成字符串 "zego_incoming".
outgoingCallRingtoneString配置在线呼出的铃声。资源文件需要放到 res/raw/ 目录下,设置该参数时不用填写文件名后缀。例如:在res/raw/ 目录下添加了 zego_outgoing.mp3 资源文件,那么就把 outgoingCallRingtone 设置成字符串 "zego_outgoing".
ZegoUIKitPrebuiltCallConfigProviderZegoUIKitPrebuiltCallConfigProvider返回 ZegoUIKitPrebuiltCallConfig 配置类以自定义通话。您可以使用 ZegoUIKitPrebuiltCallInvitationConfig.generateDefaultConfig(ZegoCallInvitationData invitationData) 方法来生成默认配置。请参考功能概述
incomingCallBackgroundDrawable配置在线来电呼叫的等待页面的背景图片。
outgoingCallBackgroundDrawable配置在线呼出的等待页面的背景图片。
showDeclineButtonboolean收到在线来电呼叫的时候,是否显示拒绝按钮。
notificationConfigZegoNotificationConfig离线呼相关配置,具体请参考离线向离线应用发送呼叫邀请文档。
translationTextZegoTranslationText呼叫邀请相关的文案。请参考切换语言
callingConfigZegoCallInvitationInCallingConfig通话中邀请的相关配置。
endCallWhenInitiatorLeaveboolean是否因发起者离开而自动结束通话,默认为 false。

ZegoUIKitPrebuiltCallConfig

通话配置类

属性类型描述
turnOnCameraWhenJoiningboolean默认是否启用摄像头。默认值为 true。
turnOnMicrophoneWhenJoiningboolean默认是否启用麦克风。默认值为 true。
useSpeakerWhenJoiningboolean默认是否启用扬声器。默认值为 true。
audioVideoViewConfigZegoPrebuiltAudioVideoViewConfig音频和视频视图的配置。如麦克风和摄像头状态图标、是否显示用户名、声浪效果和视频显示模式。
layoutZegoLayout通话页面音视频窗口显示样式,包括画中画布局、宫格布局。
bottomMenuBarConfigZegoBottomMenuBarConfig通话页面底部栏的配置参数,如底部的栏按钮、按钮数量限制、是否自动隐藏、点击其他区域是否隐藏以及颜色风格。
topMenuBarConfigZegoTopMenuBarConfig通话页面顶部栏的配置参数,如顶部的栏按钮、按钮数量限制、是否自动隐藏、点击其他区域是否隐藏以及颜色风格。
hangUpConfirmDialogInfoZegoHangUpConfirmDialogInfo点击挂断按钮时,是否显示离开房间的对话框信息。如果没有设置,则不显示。
memberListConfigZegoMemberListConfig通话成员列表显示配置,如成员的摄像头和麦克风状态。
screenSharingVideoConfigZegoPrebuiltVideoConfig屏幕共享视频的分辨率,默认值为 540p。
videoConfigZegoPrebuiltVideoConfig通话视频的分辨率,默认值为 360p。
durationConfigZegoCallDurationConfig通话时长配置。
beautyConfigZegoBeautyPluginConfig仅在使用美颜插件时有效。用于自定义美颜插件的 effectsTypes。
inRoomChatConfigZegoInRoomChatConfig配置房间内聊天的标题和输入提示,或自定义房间内聊天视图。
miniVideoConfigZegoMiniVideoConfig小窗口视频的文案和可绘制资源配置。
avatarViewProviderZegoAvatarViewProvider可自定义用户头像。
leaveCallListenerLeaveCallListener自己离开通话的回调。
zegoCallTextZegoCallText通话相关文案。

ZegoPrebuiltAudioVideoViewConfig

视图配置类

属性类型描述
showMicrophoneStateOnViewboolean是否在 VideoView 上显示麦克风状态Icon。默认值为 false。
showCameraStateOnViewboolean是否在 VideoView 上显示摄像头状态Icon。默认值为 false。
showUserNameOnViewboolean是否在 VideoView 上显示用户名。默认值为 false。
showSoundWavesInAudioModeboolean在语音模式下是否显示头像周围的声浪。默认值为 true。
useVideoViewAspectFillboolean正常的黑边模式(否则横屏会难看)。默认值为 true。
videoViewForegroundViewProviderZegoForegroundViewProvider自定义视频视图前景 View。

ZegoBottomMenuBarConfig

底部菜单栏配置类

属性类型描述
buttonsList<ZegoMenuBarButtonName>需要显示的按钮,按照实际 List 的顺序显示。
maxCountint可以显示的按钮的最大数量,最多为 5个。如果超过这个值,则会显示“更多”按钮。注意,这个值包含了“更多”按钮。
hideAutomaticallyboolean5 秒内没有操作屏幕,或者用户点击屏幕非响应区域的位置,顶部和底部会自动收起。
hideByClickboolean用户是否可以点击屏幕非响应区域的位置,并收起顶部和底部。
styleZegoMenuBarStyle菜单栏显示颜色,有高亮和暗色两种。
buttonConfigZegoMenuBarButtonConfig菜单栏按钮配置,使用此配置来改变按钮的图标。

ZegoTopMenuBarConfig

顶部菜单栏配置类

属性类型描述
titleString顶部菜单栏标题。
buttonsList<ZegoMenuBarButtonName>需要显示的按钮,按照实际 List 的顺序显示。
maxCountint可以显示的按钮的最大数量,最多为 5个。如果超过这个值,则会显示“更多”按钮。注意,这个值包含了“更多”按钮。
hideAutomaticallyboolean5 秒内没有操作屏幕,或者用户点击屏幕非响应区域的位置,顶部和底部会自动收起。
hideByClickboolean用户是否可以点击屏幕非响应区域的位置,并收起顶部和底部。
styleZegoMenuBarStyle菜单栏显示颜色,有高亮和暗色两种。
buttonConfigZegoMenuBarButtonConfig菜单栏按钮配置,使用此配置来改变按钮的图标。

ZegoMemberListConfig

房间用户列表配置类

属性类型描述
showMicrophoneStateboolean是否显示麦克风的状态图标,默认值为 true。
showCameraStateboolean是否显示摄像头的状态图标,默认值为 true。
memberListItemProviderZegoMemberListItemViewProvider自定义成员列表视图。

ZegoCallDurationConfig

通话时长配置类

属性类型描述
isVisibleboolean是否显示通话时间时长,默认值为 true。
durationUpdateListenerDurationUpdateListener通话时长更新的回调。每隔1s触发一次。

ZegoMiniVideoConfig

小窗口配置类

属性类型描述
miniVideoTextColorint小窗口视频的文字颜色。
miniVideoDrawableColorint小窗口视频的可绘制颜色。
miniVideoAudioDrawableDrawable小窗口视频的音频可绘制资源。
miniVideoVideoDrawableDrawable小窗口视频的视频可绘制资源。
permissionTextString请求小窗口视频权限时显示的文本。

ZegoMenuBarButtonConfig

菜单栏按钮配置类

属性类型描述
toggleCameraOnImageDrawable摄像头开启状态的按钮图标。
toggleCameraOffImageDrawable摄像头关闭状态的按钮图标。
toggleMicrophoneOnImageDrawable麦克风开启状态的按钮图标。
toggleMicrophoneOffImageDrawable麦克风关闭状态的按钮图标。
hangUpButtonImageDrawable挂断按钮的图标。
switchCameraFrontImageDrawable切换至前置摄像头的按钮图标。
switchCameraBackImageDrawable切换至后置摄像头的按钮图标。
showMemberListButtonImageDrawable显示成员列表的按钮图标。
chatButtonImageDrawable聊天按钮的图标。
minimizingButtonImageDrawable最小化按钮的图标。
audioOutputSpeakerImageDrawable扬声器音频输出状态的按钮图标。
audioOutputEarSpeakerImageDrawable耳机音频输出状态的按钮图标。
audioOutputBluetoothImageDrawable蓝牙音频输出状态的按钮图标。
screenSharingToggleButtonOnImageDrawable屏幕共享切换按钮开启状态的图标。
screenSharingToggleButtonOffImageDrawable屏幕共享切换按钮关闭状态的图标。
beautyButtonImageDrawable美颜按钮的图标。

ZegoCallInvitationInCallingConfig

通话中邀请的相关配置

属性类型描述
canInvitingInCallingboolean是否开启通话中邀请模式。默认为 false。
onlyInitiatorCanInviteboolean只有创建通话的人才能邀请别人加入。默认为 false。

Previous

Event