# Interface: JoinVoIPChatParams ‹Err

JoinVoIPChatParamsErr›()

# Type parameters:

Err: MogsRes

# Type parameters

Err: MogsRes

# Properties

# groupId

groupId: string

小游戏内此房间/群聊的 ID。 同一时刻传入相同 groupId 的用户会进入到同个实时语音房间。

Returns: string


# Optional handsFree

handsFree? : boolean

语音通话是否免提

default true

Returns: boolean


# muteConfig

muteConfig: MuteConfig

静音设置

Returns: MuteConfig


# nonceStr

nonceStr: string

验证所需的随机字符串

Returns: string


# signature

signature: string

签名,用于验证小游戏的身份

Returns: string


# timeStamp

timeStamp: number

验证所需的时间戳

Returns: number

# Methods

# Optional complete

complete(res: JoinVoIPChatRes | Err): void

Inherited from MogsParams.complete

接口调用结束的回调函数(调用成功、失败都会执行)

# 参数:

属性 类型
res JoinVoIPChatRes | Err

# 返回值:

void


# Optional fail

fail(err: Err): void

Inherited from MogsParams.fail

接口调用失败的回调函数

# 参数:

属性 类型
err Err

# 返回值:

void


# Optional success

success(res: JoinVoIPChatRes): void

Inherited from MogsParams.success

接口调用成功的回调函数

# 参数:

属性 类型
res JoinVoIPChatRes

JoinVoIPChatRes

属性 类型 描述
errCode number 错误码
errMsg string 调用结果
openIdList string[] 在此通话中的成员 openId 名单
speakerDetailList? SpeakerMuteDetail[] 获取用户麦位状态信息列表,仅有乐会返回

# 返回值:

void