Table of Contents

Interface Documentation

Interface Definition Overview

This page contains all interface type definitions, including interface, type, enum, and const types.

LoginOptions

interface

登录选项

Properties

Name Type Required Description
sdkAppID number Yes 腾讯云应用ID（必填）
userID string Yes 用户ID（必填）
userSig string Yes 用户签名（必填）
onSuccess Function No 登录成功回调（可选）
onError Function No 登录失败回调（可选）

LogoutOptions

interface

登出选项

Properties

Name Type Required Description
onSuccess Function No 登出成功回调（可选）
onError Function No 登出失败回调（可选）

SetSelfInfoOptions

interface

设置用户信息选项

Properties

Name Type Required Description
userProfile Object Yes 用户信息对象（必填）
onSuccess Function No 设置成功回调（可选）
onError Function No 设置失败回调（可选）

TakeSeatModeType

type

上麦模式类型

Notes

Value Description
FREE 自由上麦模式
APPLY 申请上麦模式

LiveUserInfoParam

type

直播间用户信息参数

Properties

Name Type Required Description
userID string No 用户ID（必填）
userName string No 用户名（可选）
avatarURL string No 头像URL（可选）

LiveInfoParam

interface

直播信息参数

Properties

Name Type Required
liveID string Yes
liveName string No
notice string No
isMessageDisable boolean No
isPublicVisible boolean No
isSeatEnabled boolean No
keepOwnerOnSeat boolean No
maxSeatCount number No
seatMode TakeSeatModeType No
seatLayoutTemplateID number No
coverURL string No
backgroundURL string No
categoryList number[] No
activityStatus number No
totalViewerCount number No
liveOwner LiveUserInfoParam No
createTime number No
isGiftEnabled boolean No
metaData Map No

FetchLiveListOptions

interface

获取直播列表选项

Properties

Name Type Required
cursor string No
count number No
onSuccess () => void No
onError (error: Error | string) => void No

CreateLiveOptions

interface

创建直播选项

Properties

Name Type Required
liveInfo LiveInfoParam Yes
onSuccess () => void No
onError (error: Error | string) => void No

JoinLiveOptions

interface

加入直播选项

Properties

Name Type Required
liveID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

LeaveLiveOptions

interface

离开直播选项

Properties

Name Type Required
onSuccess () => void No
onError (error: Error | string) => void No

EndLiveOptions

interface

结束直播选项

Properties

Name Type Required
onSuccess () => void No
onError (error: Error | string) => void No

UpdateLiveInfoOptions

interface

更新直播信息选项

Properties

Name Type Required
liveID string Yes
title string No
coverUrl string No
onSuccess () => void No
onError (error: Error | string) => void No

TakeSeatOptions

interface

上麦选项

Properties

Name Type Required
seatIndex number Yes
onSuccess () => void No
onError (error: Error | string) => void No

LeaveSeatOptions

interface

下麦选项

Properties

Name Type Required
onSuccess () => void No
onError (error: Error | string) => void No

MuteMicrophoneOptions

interface

静音麦克风选项

Properties

Name Type Required
onSuccess () => void No
onError (error: Error | string) => void No

UnmuteMicrophoneOptions

interface

取消静音麦克风选项

Properties

Name Type Required
onSuccess () => void No
onError (error: Error | string) => void No

KickUserOutOfSeatOptions

interface

踢出座位选项

Properties

Name Type Required
userID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

MoveUserToSeatOptions

interface

移动用户到座位选项

Properties

Name Type Required
fromSeatIndex number Yes
toSeatIndex number Yes
onSuccess () => void No
onError (error: Error | string) => void No

LockSeatOptions

interface

锁定座位选项

Properties

Name Type Required
seatIndex number Yes
onSuccess () => void No
onError (error: Error | string) => void No

UnlockSeatOptions

interface

解锁座位选项

Properties

Name Type Required
seatIndex number Yes
onSuccess () => void No
onError (error: Error | string) => void No

OpenRemoteCameraOptions

interface

开启远程摄像头选项

Properties

Name Type Required
userID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

CloseRemoteCameraOptions

interface

关闭远程摄像头选项

Properties

Name Type Required
userID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

OpenRemoteMicrophoneOptions

interface

开启远程麦克风选项

Properties

Name Type Required
userID string Yes
policy string Yes
onSuccess () => void No
onError (error: Error | string) => void No

CloseRemoteMicrophoneOptions

interface

关闭远程麦克风选项

Properties

Name Type Required
userID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

LiveUserInfoParam

interface

直播用户信息参数

Properties

Name Type Required
userID string Yes
nickname string No
avatarURL string No
role string No

FetchAudienceListOptions

interface

获取观众列表选项

Properties

Name Type Required
onSuccess () => void No
onError (error: Error | string) => void No

SetAdministratorOptions

interface

设置管理员选项

Properties

Name Type Required
userID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

RevokeAdministratorOptions

interface

撤销管理员选项

Properties

Name Type Required
userID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

KickUserOutOfRoomOptions

interface

踢出用户选项

Properties

Name Type Required
userID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

DisableSendMessageOptions

interface

禁用发送消息选项

Properties

Name Type Required
userID string Yes
isDisable boolean Yes
onSuccess () => void No
onError (error: Error | string) => void No

LiveUserInfoParam

interface

直播用户信息参数

Properties

Name Type Required
userID string Yes
nickname string No
avatarURL string No
role string No

ApplyForSeatOptions

interface

申请连麦座位选项

Properties

Name Type Required
seatIndex number No
timeout number No
extension string No
onSuccess () => void No
onError (error: Error | string) => void No

CancelApplicationOptions

interface

取消申请选项

Properties

Name Type Required
onSuccess () => void No
onError (error: Error | string) => void No

AcceptApplicationOptions

interface

接受申请选项

Properties

Name Type Required
userID string Yes
seatIndex number No
onSuccess () => void No
onError (error: Error | string) => void No

RejectApplicationOptions

interface

拒绝申请选项

Properties

Name Type Required
userID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

InviteToSeatOptions

interface

邀请上麦选项

Properties

Name Type Required
userID string Yes
seatIndex number No
timeout number No
extension string No
onSuccess () => void No
onError (error: Error | string) => void No

CancelInvitationOptions

interface

取消邀请选项

Properties

Name Type Required
inviteeID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

AcceptInvitationOptions

interface

接受邀请选项

Properties

Name Type Required
inviterID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

RejectInvitationOptions

interface

拒绝邀请选项

Properties

Name Type Required
inviterID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

DisconnectOptions

interface

断开连接选项

Properties

Name Type Required
onSuccess () => void No
onError (error: Error | string) => void No

BattleInfoParam

interface

PK 信息参数

Properties

Name Type Required
battleID string No
liveID string No
duration number No
startTime number No
endTime number No

BattleConfigParam

interface

PK 配置参数

Properties

Name Type Required
duration number No
needResponse boolean No
extensionInfo string No

RequestBattleOptions

interface

请求 PK 选项

Properties

Name Type Required
liveID string Yes
userIDList string[] Yes
timeout number No
config BattleConfigParam No
onSuccess (battleInfo?: BattleInfoParam, result?: unknown) => void No
onError (error: Error | string) => void No

CancelBattleRequestOptions

interface

取消 PK 请求选项

Properties

Name Type Required
liveID string Yes
battleID string Yes
userIDList string[] Yes
onSuccess () => void No
onError (error: Error | string) => void No

AcceptBattleOptions

interface

接受 PK 选项

Properties

Name Type Required
liveID string Yes
battleID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

RejectBattleOptions

interface

拒绝 PK 选项

Properties

Name Type Required
liveID string Yes
battleID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

ExitBattleOptions

interface

退出 PK 选项

Properties

Name Type Required
liveID string Yes
battleID string Yes
onSuccess () => void No
onError (error: Error | string) => void No

AudioChangerTypeParam

type

变声器类型参数

AudioReverbTypeParam

type

混响类型参数

SetAudioChangerTypeOptions

interface

设置变声效果选项

Properties

Name Type Required
changerType AudioChangerTypeParam Yes
onSuccess () => void No
onError (error: Error | string) => void No

SetAudioReverbTypeOptions

interface

设置混响效果选项

Properties

Name Type Required
reverbType AudioReverbTypeParam Yes
onSuccess () => void No
onError (error: Error | string) => void No

SetVoiceEarMonitorEnableOptions

interface

设置耳返开关选项

Properties

Name Type Required
enable boolean Yes
onSuccess () => void No
onError (error: Error | string) => void No

VolumeOptions

interface

音量选项

Properties

Name Type Required
volume number Yes
onSuccess () => void No
onError (error: Error | string) => void No

BarrageParam

interface

弹幕参数

Properties

Name Type Required
content string No
text string No
sender string No
userID string No
nickname string No
avatarURL string No
timestamp number No
messageID string No

SendTextMessageOptions

interface

发送文本消息选项

Properties

Name Type Required
liveID string Yes
text string Yes
onSuccess () => void No
onError (error: Error | string) => void No

SendCustomMessageOptions

interface

发送自定义消息选项

Properties

Name Type Required
liveID string Yes
businessID string Yes
data string Yes
onSuccess () => void No
onError (error: Error | string) => void No

AppendLocalTipOptions

interface

添加本地提示消息选项

Properties

Name Type Required
liveID string Yes
message BarrageParam Yes
onSuccess () => void No
onError (error: Error | string) => void No

SetSmoothLevelOptions

interface

设置磨皮级别选项

Properties

Name Type Required
smoothLevel number Yes
onSuccess () => void No
onError (error: Error | string) => void No

SetWhitenessLevelOptions

interface

设置美白级别选项

Properties

Name Type Required
whitenessLevel number Yes
onSuccess () => void No
onError (error: Error | string) => void No

SetRuddyLevelOptions

interface

设置红润级别选项

Properties

Name Type Required
ruddyLevel number Yes
onSuccess () => void No
onError (error: Error | string) => void No

BeautyType

type

美颜类型

RefreshUsableGiftsOptions

interface

刷新可用礼物列表选项

Properties

Name Type Required
onSuccess () => void No
onError (error: Error | string) => void No

SendGiftOptions

interface

发送礼物选项

Properties

Name Type Required
liveID string Yes
giftID string Yes
count number Yes
onSuccess () => void No
onError (error: Error | string) => void No

SetLanguageOptions

interface

设置礼物语言选项

Properties

Name Type Required
liveID string Yes
language string Yes
onSuccess () => void No
onError (error: Error | string) => void No

SendLikeOptions

interface

发送点赞选项

Properties

Name Type Required
count number No
onSuccess () => void No
onError (error: Error | string) => void No