Interface 接口文档
接口定义总览
本页面包含所有的接口类型定义。
CallExperimentalAPIOptions
interface接口
属性列表
| Name | Type | Description |
|---|---|---|
| jsonData | string | |
| onResponse | (jsonData: string) => void | (可选) |
HybridListenerOptions
hybridBridge addListener 参数
属性列表
| Name | Type | Description |
|---|---|---|
| type | string | |
| store | string | store 名称（必填） |
| name | string | 监听的变量名称（必填） |
| roomID | string | (可选) |
| listenerID | string | (可选) |
| params | any | 参数 (可选) |
PickSingleImageFromAlbum
从系统相册选择单张图片
AllowType
用户权限类型
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
ALLOW_ANY |
0 | 允许任何人 |
NEED_CONFIRM |
1 | 需要确认 |
DENY_ANY |
2 | 拒绝任何人 |
Gender
性别类型
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
UNKNOWN |
0 | 未知 |
MALE |
1 | 男 |
FEMALE |
2 | 女 |
UserProfileParam
用户资料参数
LoginOptions
登录参数
属性列表
| Name | Type | Description |
|---|---|---|
| sdkAppID | number | |
| userID | string | |
| userSig | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
LogoutOptions
登出参数
属性列表
| Name | Type | Description |
|---|---|---|
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
SetSelfInfoOptions
设置用户信息参数
属性列表
| Name | Type | Description |
|---|---|---|
| userProfile | UserProfileParam | |
| success | (data?: any) => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
TakeSeatMode
上麦模式类型
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
FREE |
0 | 自由上麦模式 |
APPLY |
1 | 申请上麦模式 |
MoveSeatPolicy
移动座位策略类型
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
ABORT_WHEN_OCCUPIED |
0 | 当目标座位被占用时中止操作 |
FORCE_REPLACE |
1 | 强制替换目标座位上的用户 |
SWAP_POSITION |
2 | 交换位置 |
LiveModifyFlag
直播间信息修改标志类型
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
NONE |
0 | |
LIVE_NAME |
1 << 0 | |
NOTICE |
1 << 1 | |
IS_MESSAGE_DISABLE |
1 << 2 | |
IS_PUBLIC_VISIBLE |
1 << 5 | |
SEAT_MODE |
1 << 6 | |
COVER_URL |
1 << 7 | |
BACKGROUND_URL |
1 << 8 | |
CATEGORY_LIST |
1 << 9 | |
ACTIVITY_STATUS |
1 << 10 | |
SEAT_LAYOUT_TEMPLATE_ID |
1 << 11 |
LiveUserInfoParam
直播间用户信息参数
属性列表
| Name | Type | Description |
|---|---|---|
| userID | string | 用户ID（必填） (可选) |
| userName | string | 用户名（可选） (可选) |
| avatarURL | string | 头像URL（可选） (可选) |
LiveInfoParam
直播间信息参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| liveName | string | (可选) |
| notice | string | (可选) |
| isMessageDisable | boolean | (可选) |
| isPublicVisible | boolean | (可选) |
| isSeatEnabled | boolean | (可选) |
| keepOwnerOnSeat | boolean | (可选) |
| maxSeatCount | number | (可选) |
| seatMode | TakeSeatMode | (可选) |
| seatLayoutTemplateID | number | (可选) |
| coverURL | string | (可选) |
| backgroundURL | string | (可选) |
| categoryList | number[] | (可选) |
| activityStatus | number | (可选) |
| readonly totalViewerCount | number | (可选) |
| readonly liveOwner | LiveUserInfoParam | (可选) |
| readonly createTime | number | (可选) |
| isGiftEnabled | boolean | (可选) |
| metaData | Map<string, string> | (可选) |
FetchLiveListOptions
获取直播间列表参数
属性列表
| Name | Type | Description |
|---|---|---|
| cursor | string | |
| count | number | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
CreateLiveOptions
创建直播间参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveInfo | LiveInfoParam | |
| success | (liveInfo: string) => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
JoinLiveOptions
加入直播间参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| success | (liveInfo: string) => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
LeaveLiveOptions
离开直播间参数
属性列表
| Name | Type | Description |
|---|---|---|
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
EndLiveOptions
结束直播间参数
属性列表
| Name | Type | Description |
|---|---|---|
| success | (data: string) => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
UpdateLiveInfoOptions
更新直播间信息参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveInfo | LiveInfoParam | |
| modifyFlagList | LiveModifyFlag[] | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
UpdateLiveMetaDataOptions
更新直播间元数据参数
属性列表
| Name | Type | Description |
|---|---|---|
| metaData | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
DeviceControlPolicy
设备控制策略类型
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
UNLOCK_ONLY |
1 | 仅解锁设备权限 |
SeatUserInfoParam
座位用户信息参数
属性列表
| Name | Type | Description |
|---|---|---|
| userID | string | 用户ID (可选) |
| userName | string | 用户名 (可选) |
| avatarURL | string | 头像URL (可选) |
| role | string | 用户角色 (可选) |
| liveID | string | 直播间ID (可选) |
| microphoneStatus | DeviceStatus | 麦克风状态 (可选) |
| allowOpenMicrophone | boolean | 是否允许开启麦克风 (可选) |
| cameraStatus | DeviceStatus | 摄像头状态 (可选) |
| allowOpenCamera | boolean | 是否允许开启摄像头 (可选) |
LiveCanvasParams
直播画布参数类型定义
属性列表
| Name | Type | Description |
|---|---|---|
| w | number | 画布宽度 |
| h | number | 画布高度 |
| background | string | 背景色（可选） (可选) |
SeatInfo
座位信息类型定义
属性列表
| Name | Type | Description |
|---|---|---|
| index | number | 座位索引 |
| isLocked | boolean | 是否锁定 |
| userInfo | SeatUserInfoParam | 座位上用户信息 |
| region | RegionInfoParams | 座位区域信息 |
TakeSeatOptions
上麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| seatIndex | number | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
LeaveSeatOptions
下麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
MuteMicrophoneOptions
静音麦克风参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string |
UnmuteMicrophoneOptions
取消静音麦克风参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
KickUserOutOfSeatOptions
踢用户下麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| userID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
MoveUserToSeatOptions
移动用户到座位参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| userID | string | |
| targetIndex | number | |
| policy | MoveSeatPolicy | (可选) |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
LockSeatOptions
锁定座位参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| seatIndex | number | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
UnlockSeatOptions
解锁座位参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| seatIndex | number | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
OpenRemoteCameraOptions
开启远程摄像头参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| userID | string | |
| policy | DeviceControlPolicy | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
CloseRemoteCameraOptions
关闭远程摄像头参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| userID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
OpenRemoteMicrophoneOptions
开启远程麦克风参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| userID | string | |
| policy | DeviceControlPolicy | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
CloseRemoteMicrophoneOptions
关闭远程麦克风参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| userID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
FetchAudienceListOptions
获取观众列表参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
SetAdministratorOptions
设置管理员参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| userID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
RevokeAdministratorOptions
撤销管理员参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| userID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
KickUserOutOfRoomOptions
踢出房间参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| userID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
DisableSendMessageOptions
禁用发送消息参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| userID | string | |
| isDisable | boolean | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
ApplyForSeatOptions
申请上麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| seatIndex | number | |
| timeout | number | |
| extraInfo | string | (可选) |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
CancelApplicationOptions
取消申请参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
AcceptApplicationOptions
接受申请参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| userID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
RejectApplicationOptions
拒绝申请参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| userID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
InviteToSeatOptions
邀请上麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| inviteeID | string | |
| seatIndex | number | |
| timeout | number | |
| extraInfo | string | (可选) |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
CancelInvitationOptions
取消邀请参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| inviteeID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
AcceptInvitationOptions
接受邀请参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| inviterID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
RejectInvitationOptions
拒绝邀请参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| inviterID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
DisconnectOptions
断开连接参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
NoResponseReason
无响应原因枚举 用于 onGuestApplicationNoResponse / onHostInvitationNoResponse 回调中标识无响应的具体原因 @enum {number}
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
TIMEOUT |
0 |
CoHostLayoutTemplateType
连麦布局模板类型
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
HOST_VOICE_CONNECTION |
2 | 语音连线布局 |
HOST_DYNAMIC_GRID |
600 | 动态网格布局 |
HOST_DYNAMIC_1V6 |
601 | 1制6布局 |
CoHostStatusType
连线状态类型
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
CONNECTED |
0 | 0，已连接 |
DISCONNECTED |
1 | 1，已断开 |
RequestHostConnectionOptions
请求主播连麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| targetHostLiveID | string | |
| layoutTemplate | CoHostLayoutTemplateType | |
| timeout | number | |
| extraInfo | string | (可选) |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
CancelHostConnectionOptions
取消主播连麦请求参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| toHostLiveID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
AcceptHostConnectionOptions
接受主播连麦请求参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| fromHostLiveID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
RejectHostConnectionOptions
拒绝主播连麦请求参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| fromHostLiveID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
ExitHostConnectionOptions
退出主播连麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
BattleConfigParam
PK 配置参数
属性列表
| Name | Type | Description |
|---|---|---|
| duration | number | |
| needResponse | boolean | |
| extensionInfo | string |
BattleInfoParam
PK 信息参数
属性列表
| Name | Type | Description |
|---|---|---|
| battleID | string | |
| config | BattleConfigParam | |
| startTime | number | |
| endTime | number |
RequestBattleOptions
发起 PK 请求参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| config | BattleConfigParam | |
| userIDList | string[] | |
| timeout | number | |
| success | (battleInfo: string, resultMap: string) => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
CancelBattleRequestOptions
取消 PK 请求参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| battleID | string | |
| userIDList | string[] | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
AcceptBattleOptions
接受 PK 请求参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| battleID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
RejectBattleOptions
拒绝 PK 请求参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| battleID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
ExitBattleOptions
退出 PK 请求参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| battleID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
VideoQuality
视频质量类型
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
QUALITY_360P |
1 | 360P分辨率 |
QUALITY_540P |
2 | 540P分辨率 |
QUALITY_720P |
3 | 720P分辨率 |
QUALITY_1080P |
4 | 1080P分辨率 |
OpenLocalMicrophoneOptions
开启本地麦克风参数
属性列表
| Name | Type | Description |
|---|---|---|
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
VolumeOptions
音量参数
属性列表
| Name | Type | Description |
|---|---|---|
| volume | number |
OpenLocalCameraOptions
开启本地摄像头参数
属性列表
| Name | Type | Description |
|---|---|---|
| isFront | boolean | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
SwitchCameraOptions
切换摄像头参数
属性列表
| Name | Type | Description |
|---|---|---|
| isFront | boolean |
UpdateVideoQualityOptions
更新视频质量参数
属性列表
| Name | Type | Description |
|---|---|---|
| quality | VideoQuality |
SetAudioRouteOptions
设置音频路由参数
属性列表
| Name | Type | Description |
|---|---|---|
| audioRoute | AudioOutput |
SwitchMirrorOptions
切换镜像参数
属性列表
| Name | Type | Description |
|---|---|---|
| mirrorType | MirrorType | 镜像类型（必填） |
AudioChangerType
音频变声效果
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
NONE |
0 | 0，无效果 |
CHILD |
1 | 1，小孩 |
LITTLE_GIRL |
2 | 2，小女孩 |
MAN |
3 | 3，男人 |
HEAVY_METAL |
4 | 4，重金属 |
COLD |
5 | 5，冷酷 |
FOREIGNER |
6 | 6，外国人 |
TRAPPED_BEAST |
7 | 7，野兽 |
FATSO |
8 | 8，胖子 |
STRONG_CURRENT |
9 | 9，电流 |
HEAVY_MACHINERY |
10 | 10，机械 |
ETHEREAL |
11 | 11，空灵 |
AudioReverbType
音频混响效果
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
NONE |
0 | 0，无效果 |
KTV |
1 | 1，KTV |
SMALL_ROOM |
2 | 2，小房间 |
AUDITORIUM |
3 | 3，礼堂 |
DEEP |
4 | 4，深沉 |
LOUD |
5 | 5，洪亮 |
METALLIC |
6 | 6，金属 |
MAGNETIC |
7 | 7，磁性 |
SetAudioChangerTypeOptions
设置音频变声器类型参数
属性列表
| Name | Type | Description |
|---|---|---|
| changerType | AudioChangerType |
SetAudioReverbTypeOptions
设置音频混响类型参数
属性列表
| Name | Type | Description |
|---|---|---|
| reverbType | AudioReverbType |
SetVoiceEarMonitorEnableOptions
设置语音耳返开关参数
属性列表
| Name | Type | Description |
|---|---|---|
| enable | boolean |
BarrageType
弹幕消息类型
枚举值
| 名称 | 值 | 说明 |
|---|---|---|
TEXT |
0 | 文本类型弹幕 |
CUSTOM |
1 | 自定义类型弹幕 |
BarrageParam
弹幕参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| sender | LiveUserInfoParam | |
| sequence | number | |
| timestampInSecond | number | |
| messageType | BarrageType | |
| textContent | string | (可选) |
| extensionInfo | Map<string, string> | (可选) |
| businessID | string | (可选) |
| data | string | (可选) |
SendTextMessageOptions
发送文本弹幕参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| text | string | |
| extensionInfo | string | (可选) |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
SendCustomMessageOptions
发送自定义类型弹幕参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| businessID | string | |
| data | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
AppendLocalTipOptions
添加本地提示消息参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| message | BarrageParam |
SetSmoothLevelOptions
设置美颜平滑等级参数
属性列表
| Name | Type | Description |
|---|---|---|
| smoothLevel | number |
SetWhitenessLevelOptions
设置美白等级参数
属性列表
| Name | Type | Description |
|---|---|---|
| whitenessLevel | number |
SetRuddyLevelOptions
设置红润等级参数
属性列表
| Name | Type | Description |
|---|---|---|
| ruddyLevel | number |
GiftParam
礼物参数类型定义
GiftCategoryParam
礼物分类参数类型定义
属性列表
| Name | Type | Description |
|---|---|---|
| categoryID | string | 分类ID (可选) |
| name | string | 分类名称 (可选) |
| desc | string | 分类描述 (可选) |
| extensionInfo | Map<string, string> | 扩展信息 (可选) |
| giftList | GiftParam[] | 分类下的礼物列表 (可选) |
RefreshUsableGiftsOptions
刷新可用礼物列表参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
SendGiftOptions
发送礼物参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| giftID | string | |
| count | number | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
SetLanguageOptions
设置礼物语言参数
SendLikeOptions
发送点赞参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | |
| count | number | |
| success | () => void | (可选) |
| fail | (errCode: number, errMsg: string) => void | (可选) |
CallInfo
通话信息接口
属性列表
| Name | Type | Description |
|---|---|---|
| callId | string | |
| mediaType | CallMediaType | |
| startTime | number | |
| duration | number | |
| participantIds | string[] | |
| callParams | any | (可选) |
CallParticipant
通话参与者信息接口
属性列表
| Name | Type | Description |
|---|---|---|
| userId | string | |
| userName | string | (可选) |
| avatarUrl | string | (可选) |
| hasAudio | boolean | |
| hasVideo | boolean | |
| isMicMuted | boolean | |
| isCameraMuted | boolean |
RecentCall
通话记录接口
属性列表
| Name | Type | Description |
|---|---|---|
| callId | string | |
| mediaType | CallMediaType | |
| startTime | number | |
| duration | number | |
| participantIds | string[] | |
| endReason | CallEndReason |
SpeakerVolume
音量信息接口
属性列表
| Name | Type | Description |
|---|---|---|
| userId | string | |
| volume | number |
NetworkQualityInfo
网络质量信息接口
属性列表
| Name | Type | Description |
|---|---|---|
| userId | string | |
| quality | NetworkQuality |
CallsOptions
发起通话参数
属性列表
| Name | Type | Description |
|---|---|---|
| participantIds | string[] | |
| mediaType | CallMediaType | |
| params | any | (可选) |
| success | () => void | (可选) |
| fail | (code: number, message: string) => void | (可选) |
AcceptOptions
接听通话参数
属性列表
| Name | Type | Description |
|---|---|---|
| success | () => void | (可选) |
| fail | (code: number, message: string) => void | (可选) |
RejectOptions
拒绝通话参数
属性列表
| Name | Type | Description |
|---|---|---|
| success | () => void | (可选) |
| fail | (code: number, message: string) => void | (可选) |
HangupOptions
挂断通话参数
属性列表
| Name | Type | Description |
|---|---|---|
| success | () => void | (可选) |
| fail | (code: number, message: string) => void | (可选) |
JoinOptions
加入通话参数
属性列表
| Name | Type | Description |
|---|---|---|
| callId | string | |
| success | () => void | (可选) |
| fail | (code: number, message: string) => void | (可选) |
InviteOptions
邀请加入通话参数
属性列表
| Name | Type | Description |
|---|---|---|
| participantIds | string[] | |
| params | any | (可选) |
| success | () => void | (可选) |
| fail | (code: number, message: string) => void | (可选) |
QueryRecentCallsOptions
查询通话记录参数
属性列表
| Name | Type | Description |
|---|---|---|
| cursor | string | (可选) |
| count | number | (可选) |
| success | () => void | (可选) |
| fail | (code: number, message: string) => void | (可选) |
DeleteRecentCallsOptions
删除通话记录参数
属性列表
| Name | Type | Description |
|---|---|---|
| callIdList | string[] | |
| success | () => void | (可选) |
| fail | (code: number, message: string) => void | (可选) |
StartFloatWindowOptions
悬浮窗配置项
属性列表
| Name | Type | Description |
|---|---|---|
| avatars | Record<string, string> | (可选) |
| waitingAnimation | string | (可选) |
| volumeLevelIcons | Record<string, string> | (可选) |
| networkQualityIcons | Record<string, string> | (可选) |
ICallListener
通话事件监听器函数类型