Config
ZegoUIKitPrebuiltCallConfig
通话配置类
| 属性 | 类型 | 描述 |
|---|---|---|
| turnOnCameraWhenJoining | Bool | 默认是否启用摄像头，默认值为 true。 |
| turnOnMicrophoneWhenJoining | Bool | 默认是否启用麦克风，默认值为 true。 |
| useSpeakerWhenJoining | Bool | 默认是否启用扬声器，默认值为 true。 |
| audioVideoViewConfig | ZegoAudioVideoViewConfig | 音频和视频视图的配置。如麦克风和摄像头状态图标、是否显示用户名、声浪效果和视频显示模式。 |
| layout | ZegoLayout | 配置通话页面音视频窗口的显示布局，包括画中画布局局。 |
| bottomMenuBarConfig | ZegoBottomMenuBarConfig | 通话页面底部栏的配置参数，如底部的栏按钮、按钮数量限制、是否自动隐藏、点击其他区域是否隐藏以及颜色风格。 |
| hangUpConfirmInfo | ZegoHangUpConfirmInfo | 点击挂断按钮时，是否显示离开房间的对话框信息。如果没有设置，则不显示，反之亦然。 |
| videoConfig | ZegoPrebuiltVideoConfig | 视频分辨率配置，默认值为 ZegoPrebuiltVideoConfig(resolution: ZegoPresetResolution.Preset360p)。 |
| durationConfig | ZegoCallDurationConfig | 通话时长配置，可显示或隐藏时时长统计，以及设置时长回调。 |
ZegoAudioVideoViewConfig
视图配置类
| 属性 | 类型 | 描述 |
|---|---|---|
| showMicrophoneStateOnView | Bool | 是否在视频通话页面展示麦克风状态的图标。默认值为 true。 |
| showCameraStateOnView | Bool | 是否在视频通话页面展示摄像头状态的图标。默认值为 true。 |
| showUserNameOnView | Bool | 是否在视频通话页面展示用户名称。默认值为 true。 |
| showSoundWavesInAudioMode | Bool | 在语音通话模式下，是否在用户头像周围显示声浪。默认值为 true。 |
| useVideoViewAspectFill | Bool | 是否以等比例填充模式（黑边模式）显示视频。默认值为 true。 |
ZegoBottomMenuBarConfig
底部菜单栏配置类
| 属性 | 类型 | 描述 |
|---|---|---|
| buttons | [ZegoMenuBarButtonName] | 需要在菜单栏上显示的按钮，按照数组的顺序显示。默认值为 [ToggleCameraButton, SwitchCameraButton, HangUpButton, ToggleMicrophoneButton, SwitchAudioOutputButton]。 |
| maxCount | Int | 可以显示的按钮的最大数量，最多为 5 个。如果超过这个值，则会显示“更多”按钮。注意，这个值包含了“更多”按钮。 |
| hideAutomatically | Bool | 5 秒内没有操作屏幕，或者用户点击屏幕非响应区域的位置，底部菜单栏是否会自动收起。默认值为 true。 |
| hideByClick | Bool | 用户是否可以点击屏幕非响应区域的位置，收起菜单栏。默认值为 true。 |
ZegoPrebuiltVideoConfig
视频分辨率配置类
| 属性 | 类型 | 描述 |
|---|---|---|
| resolution | ZegoPresetResolution | 自定义视频分辨率。默认为 Preset360p。 |
| config | ZegoVideoConfig | 详细的视频参数配置，可选，如果配置了该参数，则忽略 resolution。 |
ZegoLayout
通话页面布局类
| 属性 | 类型 | 描述 |
|---|---|---|
| mode | ZegoUIKitLayoutMode | 通话页面音视频窗口显示样式，包括画中画布局、宫格布局。 |
| config | ZegoLayoutConfig | UI 布局配置。 |
ZegoLayoutConfig
通话页面布局配置类。目前只支持ZegoLayoutPictureInPictureConfig一种布局模式。
ZegoLayoutPictureInPictureConfig
画中画布局配置类
| 属性 | 类型 | 描述 |
|---|---|---|
| smallViewBackgroundColor | String | 小视图的背景颜色。默认为 #333437。 |
| largeViewBackgroundColor | String | 大视图的背景颜色。默认为 #4A4B4D。 |
| smallViewBackgroundImage | String | 小视图的背景图片。默认为 null。 |
| largeViewBackgroundImage | String | 大视图的背景图片。默认为 null。 |
| smallViewPostion | ZegoViewPosition | 小视图在 UI 上的位置。默认为 TopRight。 |
| switchLargeOrSmallViewByClick | Bool | 大小视图是否可以点击切换。默认为 true。 |
| smallViewSize | Object | 小视图的大小。默认为 { width: 85, height: 151 }。 |
| spacingBetweenSmallViews | Int | 小视图之间的间距。默认为 8。 |
| removeViewWhenAudioVideoUnavailable | Bool | 当音频和视频不可用的时候是否移除 view。默认为 true。 |
ZegoCallDurationConfig
通话时长配置类
| 属性 | 类型 | 描述 |
|---|---|---|
| showDuration | boolean | 是否显示通话时间时长，默认值为 true。 |
| onDurationUpdate | (seconds: number) => void | 通话时长更新的回调。每隔 1s 触发一次，不建议运行耗时任务。 |
ZegoHangUpConfirmInfo
离开通话确认对话框信息配置类
| 属性 | 类型 | 描述 |
|---|---|---|
| title | String | 标题文本。 |
| message | String | 确认消息文本。 |
| cancelButtonName | String | 取消按钮文本。 |
| confirmButtonName | String | 确认按钮文本。 |
ZegoLayoutMode
通话页面布局模式枚举类
| 枚举 | 描述 |
|---|---|
| PictureInPicture | 画中画布局。 |
ZegoMenuBarButtonName
菜单栏按钮名称枚举类
| 枚举 | 描述 |
|---|---|
| HangUpButton | 挂断按钮。 |
| ToggleCameraButton | 摄像头开关按钮。 |
| ToggleMicrophoneButton | 麦克风开关按钮。 |
| SwitchCameraButton | 前后摄像头切换按钮。 |
| SwitchAudioOutputButton | 音频外放切换按钮。 |
ZegoPresetResolution
视频分辨率枚举类
| 枚举 | 描述 |
|---|---|
| Preset180p | 180P。 |
| Preset270p | 270P。 |
| Preset360p | 360P。 |
| Preset540p | 540P。 |
| Preset720p | 720P。 |
| Preset1080p | 1080P。 |
ZegoViewPosition
视图位置类
| 枚举 | 描述 |
|---|---|
| TopLeft | 左上。 |
| TopRight | 右上。 |
| BottomLeft | 左下。 |
| BottomRight | 右下。 |
ZegoUser
用户信息
| 属性 | 类型 | 描述 |
|---|---|---|
| userID | String | 用户ID。 |
| userName | String | 用户名。 |
ZegoSendCallInvitationButton
呼叫邀请按钮参数
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
| invitees | ZegoUser[] | 是 | 被叫用户列表，最多可传入 9 名用户。 |
| type | Number | 是 | 呼叫类型：0：语音呼叫；1:视频呼叫。 |
| callName | String | 否 | 当 showWaitingPageWhenGroupCall 为 true 时，此字段可用于配置呼叫等待页显示的内容。 |
| callID | String | 否 | 呼叫邀请 ID。 |
| timeout | Number | 否 | 超时时长。默认为 60 秒。超时后会自动取消本次呼叫。 |
| customData | String | 否 | 您需要传递给被叫者的自定义参数。 |
| showWaitingPageWhenGroupCall | Boolean | 否 | 是否显示呼叫等待页。当只有一个被叫用户时，默认为true；当呼叫多名用户时，默认为 false。 |
| text | String | 否 | 发起呼叫邀请按钮的文本。 |
| icon | String | 否 | 自定义发起呼叫按钮图标。 |
| iconWidth | String | 否 | 自定义发起呼叫按钮图标宽度。 |
| iconHeight | String | 否 | 自定义发起呼叫按钮图标高度。 |
| notificationConfig | NotificationConfig | 否 | 离线通知配置。 |
| onPressed | Function | 否 | 点击发起呼叫邀请按钮的回调。 |
OfflinePushConfig
各家厂商离线推送配置
| 属性 | 类型 | 描述 |
|---|---|---|
| enableHWPush | Boolean | 是否开启华为推送。 |
| enableMiPush | Boolean | 是否开启小米推送。 |
| enableVivoPush | Boolean | 是否开启 vivo 推送 |
| enableOppoPush | Boolean | 是否开启 OPPO 推送。 |
| miAppID | Sting | 小米推送所需 AppID，您需要在 小米开放平台 上创建项目后获取该 AppID。 |
| miAppKey | Sting | 小米推送所需 AppKey，您需要在 小米开放平台 上创建项目后获取该 AppKey。 |
| oppoAppID | Sting | OPPO 推送所需 AppID，您需要在 OPPO 开放平台 上创建应用并开通推送权限后获取该 AppID。 |
| oppoAppSecret | Sting | OPPO 推送所需的 AppSecret，您需要在 OPPO 开放平台 上创建应用并开通推送权限后获取该 AppSecret。 |
| oppoAppKey | Sting | OPPO 推送所需的 AppKey，您需要在 OPPO 开放平台 上创建应用并开通推送权限后获取该 AppKey。 |
| vivoAppID | Sting | vivo 推送所需的 AppID，您需要在 vivo 开放平台 上申请推送应用并获取该应用的 AppID。 |
| vivoAppKey | Sting | vivo 推送所需的 AppKey，您需要在 vivo 开放平台 上申请推送应用并获取该应用的 AppKey |
| hwAppID | Sting | 华为推送所需的 AppID，您需要在 华为开发者后台 创建一个新的项目并开通推送服务，然后创建自己的应用，获取对应的 AppID。 |
| appType | Number | 用于指定当前项目对应 ZEGO 控制台的第几套离线推送配置。默认值为 1。 |
NotificationConfig
发起离线呼叫配置
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
| title | String | 否 | 推送标题。 |
| message | String | 否 | 推送内容。 |
| resourcesID | String | 否 | 用于映射多个厂商进阶配置的离线推送字段，将多个厂商的推送配置抽象为一种您自定的推送策略。 |
CallInviteConfig
呼叫邀请接口参数
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
| invitees | ZegoUser[] | 是 | 被叫用户列表，最多可传入 9 名用户。 |
| type | Number | 是 | 呼叫类型：0：语音呼叫；1:视频呼叫。 |
| timeout | Number | 否 | 超时时长。默认为 60 秒。超时后会自动取消本次呼叫。 |
| callID | String | 否 | 呼叫邀请 ID。 |
| customData | String | 否 | 您需要传递给被叫者的自定义参数。 |
| notificationConfig | NotificationConfig | 否 | 离线通知配置。 |
返回值:
| 属性 | 类型 | 描述 |
|---|---|---|
| invitationID | String | 呼叫邀请 ID。 |
| successUsers | ZegoUser[] | 收到邀请的用户。 |
| errorUsers | ZegoUser[] | 未收到呼叫邀请的用户。 |