logo
当前页

Config

ZegoUIKitPrebuiltCallConfig

通话配置类

属性类型描述
turnOnCameraWhenJoiningBool默认是否启用摄像头,默认值为 true。
turnOnMicrophoneWhenJoiningBool默认是否启用麦克风,默认值为 true。
useSpeakerWhenJoiningBool默认是否启用扬声器,默认值为 true。
audioVideoViewConfigZegoAudioVideoViewConfig音频和视频视图的配置。如麦克风和摄像头状态图标、是否显示用户名、声浪效果和视频显示模式。
layoutZegoLayout配置通话页面音视频窗口的显示布局,包括画中画布局局。
bottomMenuBarConfigZegoBottomMenuBarConfig通话页面底部栏的配置参数,如底部的栏按钮、按钮数量限制、是否自动隐藏、点击其他区域是否隐藏以及颜色风格。
hangUpConfirmInfoZegoHangUpConfirmInfo点击挂断按钮时,是否显示离开房间的对话框信息。如果没有设置,则不显示,反之亦然。
videoConfigZegoPrebuiltVideoConfig视频分辨率配置,默认值为 ZegoPrebuiltVideoConfig(resolution: ZegoPresetResolution.Preset360p)。
durationConfigZegoCallDurationConfig通话时长配置,可显示或隐藏时时长统计,以及设置时长回调。

ZegoAudioVideoViewConfig

视图配置类

属性类型描述
showMicrophoneStateOnViewBool是否在视频通话页面展示麦克风状态的图标。默认值为 true。
showCameraStateOnViewBool是否在视频通话页面展示摄像头状态的图标。默认值为 true。
showUserNameOnViewBool是否在视频通话页面展示用户名称。默认值为 true。
showSoundWavesInAudioModeBool在语音通话模式下,是否在用户头像周围显示声浪。默认值为 true。
useVideoViewAspectFillBool是否以等比例填充模式(黑边模式)显示视频。默认值为 true。

ZegoBottomMenuBarConfig

底部菜单栏配置类

属性类型描述
buttons[ZegoMenuBarButtonName]需要在菜单栏上显示的按钮,按照数组的顺序显示。默认值为 [ToggleCameraButton, SwitchCameraButton, HangUpButton, ToggleMicrophoneButton, SwitchAudioOutputButton]。
maxCountInt可以显示的按钮的最大数量,最多为 5 个。如果超过这个值,则会显示“更多”按钮。注意,这个值包含了“更多”按钮。
hideAutomaticallyBool5 秒内没有操作屏幕,或者用户点击屏幕非响应区域的位置,底部菜单栏是否会自动收起。默认值为 true。
hideByClickBool用户是否可以点击屏幕非响应区域的位置,收起菜单栏。默认值为 true。

ZegoPrebuiltVideoConfig

视频分辨率配置类

属性类型描述
resolutionZegoPresetResolution自定义视频分辨率。默认为 Preset360p。
configZegoVideoConfig详细的视频参数配置,可选,如果配置了该参数,则忽略 resolution

ZegoLayout

通话页面布局类

属性类型描述
modeZegoUIKitLayoutMode通话页面音视频窗口显示样式,包括画中画布局、宫格布局。
configZegoLayoutConfigUI 布局配置。

ZegoLayoutConfig

通话页面布局配置类。目前只支持ZegoLayoutPictureInPictureConfig一种布局模式。

ZegoLayoutPictureInPictureConfig

画中画布局配置类

属性类型描述
smallViewBackgroundColorString小视图的背景颜色。默认为 #333437
largeViewBackgroundColorString大视图的背景颜色。默认为 #4A4B4D
smallViewBackgroundImageString小视图的背景图片。默认为 null
largeViewBackgroundImageString大视图的背景图片。默认为 null
smallViewPostionZegoViewPosition小视图在 UI 上的位置。默认为 TopRight
switchLargeOrSmallViewByClickBool大小视图是否可以点击切换。默认为 true
smallViewSizeObject小视图的大小。默认为 { width: 85, height: 151 }
spacingBetweenSmallViewsInt小视图之间的间距。默认为 8
removeViewWhenAudioVideoUnavailableBool当音频和视频不可用的时候是否移除 view。默认为 true

ZegoCallDurationConfig

通话时长配置类

属性类型描述
showDurationboolean是否显示通话时间时长,默认值为 true。
onDurationUpdate(seconds: number) => void通话时长更新的回调。每隔 1s 触发一次,不建议运行耗时任务。

ZegoHangUpConfirmInfo

离开通话确认对话框信息配置类

属性类型描述
titleString标题文本。
messageString确认消息文本。
cancelButtonNameString取消按钮文本。
confirmButtonNameString确认按钮文本。

ZegoLayoutMode

通话页面布局模式枚举类

枚举描述
PictureInPicture画中画布局。

ZegoMenuBarButtonName

菜单栏按钮名称枚举类

枚举描述
HangUpButton挂断按钮。
ToggleCameraButton摄像头开关按钮。
ToggleMicrophoneButton麦克风开关按钮。
SwitchCameraButton前后摄像头切换按钮。
SwitchAudioOutputButton音频外放切换按钮。

ZegoPresetResolution

视频分辨率枚举类

枚举描述
Preset180p180P。
Preset270p270P。
Preset360p360P。
Preset540p540P。
Preset720p720P。
Preset1080p1080P。

ZegoViewPosition

视图位置类

枚举描述
TopLeft左上。
TopRight右上。
BottomLeft左下。
BottomRight右下。

Previous

计算通话时长