Interface 接口文档
接口定义总览
本页面包含所有的接口类型定义。
UserAllowType
用户权限类型
说明
| 值 | 说明 |
|---|---|
ALLOW_ANY |
允许任何人 |
NEED_CONFIRM |
需要确认 |
DENY_ANY |
拒绝任何人 |
GenderType
性别类型
说明
| 值 | 说明 |
|---|---|
UNKNOWN |
未知 |
MALE |
男 |
FEMALE |
女 |
TakeSeatModeType
上麦模式类型
说明
| 值 | 说明 |
|---|---|
FREE |
自由上麦模式 |
APPLY |
申请上麦模式 |
MoveSeatPolicyType
移动座位策略类型
说明
| 值 | 说明 |
|---|---|
ABORT_WHEN_OCCUPIED |
当目标座位被占用时中止操作 |
FORCE_REPLACE |
强制替换目标座位上的用户 |
SWAP_POSITION |
交换位置 |
DeviceControlPolicyType
设备控制策略类型
说明
| 值 | 说明 |
|---|---|
FORCE_OPEN |
强制开启设备 |
UNLOCK_ONLY |
仅解锁设备权限 |
AudioOutputType
音频输出类型
说明
| 值 | 说明 |
|---|---|
SPEAKERPHONE |
扬声器 |
EARPIECE |
听筒 |
VideoQualityType
视频质量类型
说明
| 值 | 说明 |
|---|---|
VIDEOQUALITY_360P |
360P分辨率 |
VIDEOQUALITY_540P |
540P分辨率 |
VIDEOQUALITY_720P |
720P分辨率 |
VIDEOQUALITY_1080P |
1080P分辨率 |
CoHostLayoutTemplateType
连麦布局模板类型
说明
| 值 | 说明 |
|---|---|
HOST_DYNAMIC_GRID |
动态网格布局 |
HOST_DYNAMIC_1V6 |
1对6布局 |
MessageType
弹幕消息类型
说明
| 值 | 说明 |
|---|---|
TEXT |
文本类型弹幕，包含纯文字内容 |
CUSTOM |
自定义类型弹幕，支持业务自定义数据格式（如带特效的弹幕、互动消息等） |
DeviceMirrorType
设备镜像类型
说明
| 值 | 说明 |
|---|---|
AUTO |
自动模式 |
ENABLE |
启用镜像 |
DISABLE |
禁用镜像 |
ModifyFlagType
直播间信息修改标志类型
说明
| 值 | 说明 |
|---|---|
NONE |
无修改 |
LIVE_NAME |
修改直播间名称 |
NOTICE |
修改直播间公告 |
IS_MESSAGE_DISABLE |
修改消息禁用状态 |
IS_PUBLIC_VISIBLE |
修改公开可见状态 |
SEAT_MODE |
修改上麦模式 |
COVER_URL |
修改封面URL |
BACKGROUND_URL |
修改背景URL |
CATEGORY_LIST |
修改分类列表 |
ACTIVITY_STATUS |
修改活动状态 |
SEAT_LAYOUT_TEMPLATE_ID |
修改座位布局模板ID |
AudioChangerTypeParam
音频变声效果
说明
| 值 | 说明 |
|---|---|
NONE |
无效果 |
CHILD |
小孩 |
LITTLE_GIRL |
小女孩 |
MAN |
男人 |
HEAVY_METAL |
重金属 |
COLD |
冷酷 |
FOREIGNER |
外国人 |
TRAPPED_BEAST |
野兽 |
FATSO |
胖子 |
STRONG_CURRENT |
电流 |
HEAVY_MACHINERY |
机械 |
ETHEREAL |
空灵 |
AudioReverbTypeParam
音频混响效果
说明
| 值 | 说明 |
|---|---|
NONE |
无效果 |
KTV |
KTV |
SMALL_ROOM |
小房间 |
AUDITORIUM |
礼堂 |
DEEP |
深沉 |
LOUD |
洪亮 |
METALLIC |
金属 |
MAGNETIC |
磁性 |
SeatUserInfoParam
座位用户信息参数
属性列表
| Name | Type | Description |
|---|---|---|
| userID | string | 用户ID（必填） |
| userName | string | 用户名（可选） |
| avatarURL | string | 头像URL（可选） |
| role | string | 用户角色（可选） |
| liveID | string | 直播间ID（必填） |
| microphoneStatus | string | 麦克风状态（可选） |
| allowOpenMicrophone | boolean | 是否允许开启麦克风（可选） |
| cameraStatus | string | 摄像头状态（可选） |
| allowOpenCamera | boolean | 是否允许开启摄像头（可选） |
UserProfileParam
用户资料参数
属性列表
| Name | Type | Description |
|---|---|---|
| userID | string | 用户ID（必填） |
| nickname | string | 昵称（可选） |
| avatarURL | string | 头像URL（可选） |
| selfSignature | string | 个性签名（可选） |
| gender | GenderType | 性别（可选） |
| role | number | 角色（可选） |
| level | number | 等级（可选） |
| birthday | number | 生日时间戳（可选） |
| allowType | UserAllowType | 权限类型（可选） |
| customInfo | Record |
自定义信息（可选） |
LiveUserInfoParam
直播间用户信息参数
属性列表
| Name | Type | Description |
|---|---|---|
| userID | string | 用户ID（必填） |
| userName | string | 用户名（可选） |
| avatarURL | string | 头像URL（可选） |
LiveInfoParam
直播间信息参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填, 最大支持48个字节） |
| liveName | string | 直播间名称（可选, 默认房间ID，最大支持100个字节） |
| notice | string | 直播间公告（可选, 最大支持100个字节） |
| isMessageDisable | boolean | 是否禁用消息（可选，默认值为 false） |
| isPublicVisible | boolean | 是否公开可见（可选，默认值为 true） |
| isSeatEnabled | boolean | 是否启用麦位功能（可选，默认值为 true） |
| keepOwnerOnSeat | boolean | 是否保持房主在座位上（必填） |
| maxSeatCount | number | 最大麦位数量（默认为 套餐包允许的最大麦位数）,不可与seatLayoutTemplateID同时传递; 若需手动指定 maxSeatCount, 必须将 seatLayoutTemplateID 设为 0。 |
| seatMode | TakeSeatModeType | 上麦模式类型（可选，默认为 ‘APPLY’ 申请上麦模式, 只有开启麦位功能后生效） |
| seatLayoutTemplateID | number | 指定座位布局模板 ID（可选，默认值：600,对应默认最大麦位数为 9）, 不可与maxCount同时传递; 若需使用maxCount, 需将本参数设为 0。 |
| coverURL | string | 封面 URL（可选, 最大支持 200 个字节） |
| backgroundURL | string | 背景 URL（可选, 最大支持 200 个字节） |
| categoryList | number[] | 直播间分类标签，单个房间最大支持3个标记（可选） |
| activityStatus | number | 直播间活跃状态: 用户自定义标记（可选，默认值：0） |
| totalViewerCount | number | 总观众数（只读） |
| isGiftEnabled | boolean | 是否启用礼物功能（可选） |
| metaData | Record |
元数据（可选） |
BarrageParam
弹幕参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 弹幕所属直播间/语音聊天房的唯一标识 ID（必填）。 |
| sender | LiveUserInfoParam | 弹幕发送者的用户信息（如用户ID、昵称、头像等）。 |
| sequence | number | 弹幕消息的唯一序列ID，用于消息排序和去重。 |
| timestampInSecond | number | 弹幕发送时间戳（单位：秒），用于展示发送时间顺序。 |
| messageType | MessageType | 弹幕消息类型（文本或自定义）。 |
| textContent | string | 文本类型弹幕的消息内容。 |
| extensionInfo | Record |
弹幕扩展信息，可自定义字段（如显示样式、优先级等）。当 messageType 为 TEXT 时有效。(可选) |
| businessID | string | 自定义类型弹幕的业务标识ID，用于区分不同业务场景的自定义弹幕。 |
| data | string | 自定义类型弹幕的具体数据内容（通常为JSON格式字符串），当 messageType 为 CUSTOM 时有效。（可选） |
LoginOptions
登录参数
属性列表
| Name | Type | Description |
|---|---|---|
| sdkAppID | number | 应用ID（必填） |
| userID | string | 用户ID（必填） |
| 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 | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
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 | 直播间ID（必填） |
| 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 | number[] | 修改标志列表，标识需要更新的字段（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
TakeSeatOptions
上麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| seatIndex | number | 座位索引（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
LeaveSeatOptions
下麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
MuteMicrophoneOptions
静音麦克风参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
UnmuteMicrophoneOptions
取消静音麦克风参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
KickUserOutOfSeatOptions
踢用户下麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| userID | string | 用户ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
MoveUserToSeatOptions
移动用户到座位参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| userID | string | 用户ID（必填） |
| targetIndex | number | 目标座位索引（必填） |
| policy | MoveSeatPolicyType | 移动策略（可选） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
LockSeatOptions
锁定座位参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| seatIndex | number | 座位索引（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
UnlockSeatOptions
解锁座位参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| seatIndex | number | 座位索引（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
OpenRemoteCameraOptions
开启远程摄像头参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| userID | string | 用户ID（必填） |
| policy | DeviceControlPolicyType | 控制策略（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
CloseRemoteCameraOptions
关闭远程摄像头参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| userID | string | 用户ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
OpenRemoteMicrophoneOptions
开启远程麦克风参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| userID | string | 用户ID（必填） |
| policy | DeviceControlPolicyType | 控制策略（必填，参考DeviceControlPolicyType） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
CloseRemoteMicrophoneOptions
关闭远程麦克风参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| userID | string | 用户ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
FetchAudienceListOptions
获取观众列表参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
SetAdministratorOptions
设置管理员参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| userID | string | 用户ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
RevokeAdministratorOptions
撤销管理员参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| userID | string | 用户ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
KickUserOutOfRoomOptions
踢出房间参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| userID | string | 用户ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
DisableSendMessageOptions
禁用发送消息参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| userID | string | 用户ID（必填） |
| isDisable | boolean | 是否禁用（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
OpenLocalMicrophoneOptions
开启本地麦克风参数
属性列表
| Name | Type | Description |
|---|---|---|
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
VolumeOptions
音量参数
属性列表
| Name | Type | Description |
|---|---|---|
| volume | number | 音量大小（必填） |
SetAudioRouteOptions
设置音频路由参数
属性列表
| Name | Type | Description |
|---|---|---|
| route | AudioOutputType | 音频路由类型（必填） |
OpenLocalCameraOptions
开启本地摄像头参数
属性列表
| Name | Type | Description |
|---|---|---|
| isFront | boolean | 是否前置摄像头（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
SwitchCameraOptions
切换摄像头参数
属性列表
| Name | Type | Description |
|---|---|---|
| isFront | boolean | 是否前置摄像头（必填） |
SwitchMirrorOptions
切换镜像参数
属性列表
| Name | Type | Description |
|---|---|---|
| mirrorType | DeviceMirrorType | 镜像类型（必填） |
UpdateVideoQualityOptions
更新视频质量参数
属性列表
| Name | Type | Description |
|---|---|---|
| quality | VideoQualityType | 视频质量类型（必填） |
RequestHostConnectionOptions
请求主播连麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 当前直播间ID（必填） |
| targetHostLiveID | string | 目标主播直播间ID（必填） |
| layoutTemplate | CoHostLayoutTemplateType | 连麦布局模板（必填） |
| timeout | number | 超时时间（毫秒，必填） |
| extensionInfo | Record |
扩展信息（可选） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
CancelHostConnectionOptions
取消主播连麦请求参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 当前直播间ID（必填） |
| toHostLiveID | string | 目标主播直播间ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
AcceptHostConnectionOptions
接受主播连麦请求参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 当前直播间ID（必填） |
| fromHostLiveID | string | 来源主播直播间ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
RejectHostConnectionOptions
拒绝主播连麦请求参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 当前直播间ID（必填） |
| fromHostLiveID | string | 来源主播直播间ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
ExitHostConnectionOptions
退出主播连麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 当前直播间ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
ApplyForSeatOptions
申请上麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| seatIndex | number | 申请的座位索引（必填） |
| timeout | number | 超时时间（毫秒，必填） |
| extraInfo | string | 额外信息（可选） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
CancelApplicationOptions
取消申请参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
AcceptApplicationOptions
接受申请参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| userID | string | 申请用户ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
RejectApplicationOptions
拒绝申请参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| userID | string | 申请用户ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
InviteToSeatOptions
邀请上麦参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| inviteeID | string | 被邀请用户ID（必填） |
| seatIndex | number | 座位索引（必填） |
| timeout | number | 超时时间（毫秒，必填） |
| extraInfo | string | 额外信息（可选） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
CancelInvitationOptions
取消邀请参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| inviteeID | string | 被邀请用户ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
AcceptInvitationOptions
接受邀请参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| inviterID | string | 邀请者用户ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
RejectInvitationOptions
拒绝邀请参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| inviterID | string | 邀请者用户ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
DisconnectOptions
断开连接参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
SendTextMessageOptions
发送文本弹幕参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 当前直播间 ID（必填） |
| text | string | 文本弹幕内容（必填） |
| extensionInfo | Map |
扩展信息（可选） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
SendCustomMessageOptions
发送自定义类型弹幕参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 当前直播间 ID（必填） |
| businessID | string | 业务标识 ID（必填） |
| data | string | 自定义数据内容，通常为JSON格式字符串（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
AppendLocalTipOptions
添加本地提示消息
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 当前直播间 ID（必填） |
| message | BarrageParam | 本地弹幕消息（如系统提示、操作反馈等，仅当前用户可见）（必填） |
RefreshUsableGiftsOptions
刷新可用礼物列表参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
SendGiftOptions
发送礼物参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| giftID | string | 礼物ID（必填） |
| count | number | 礼物数量（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
SetSmoothLevelOptions
设置美颜平滑等级参数
属性列表
| Name | Type | Description |
|---|---|---|
| smoothLevel | number | 磨皮参数，取值范围[0,9]: 0 表示关闭，9 表示效果最明显）（必填） |
SetWhitenessLevelOptions
设置美白等级参数
属性列表
| Name | Type | Description |
|---|---|---|
| whitenessLevel | number | 美白参数，取值范围[0,9]: 0 表示关闭，9 表示效果最明显（必填） |
SetRuddyLevelOptions
设置红润等级参数
属性列表
| Name | Type | Description |
|---|---|---|
| ruddyLevel | number | 红润参数，取值范围[0,9]: 0 表示关闭，9 表示效果最明显（必填） |
SetAudioChangerTypeOptions
设置音频变声器类型参数
属性列表
| Name | Type | Description |
|---|---|---|
| changerType | AudioChangerTypeParam | 变声器类型（必填） |
SetAudioReverbTypeOptions
设置音频混响类型参数
属性列表
| Name | Type | Description |
|---|---|---|
| reverbType | AudioReverbTypeParam | 混响类型（必填） |
SetVoiceEarMonitorEnableOptions
设置语音耳返开关参数
属性列表
| Name | Type | Description |
|---|---|---|
| enable | boolean | 是否开启耳返（必填） |
SendLikeOptions
发送点赞参数
属性列表
| Name | Type | Description |
|---|---|---|
| liveID | string | 直播间ID（必填） |
| count | number | 点赞数量（必填） |
| success | () => void | 成功回调（可选） |
| fail | (errCode: number, errMsg: string) => void | 失败回调（可选） |
ILiveListener
直播监听器接口
属性列表
| Name | Type | Description |
|---|---|---|
| callback | (res: string) => void | 回调函数（必填） |