房间查询信息结果类

此类封装了房间查询的结果信息,包括房间ID、房间号码、成员数量及成员ID列表等。 通过此类可以获取和设置与房间查询相关的各种信息,便于应用层了解房间状态。

Constructors

  • 创建房间查询信息对象

    Parameters

    • roomId: undefined | string

      房间ID

    • roomNumber: number

      房间号码(服务器生成)

    • memberCount: number

      房间成员数量

    • memberUserIdList: any

      房间成员用户ID列表

    Returns JRTCRoomQueryInfo

Accessors

  • get roomId(): undefined | string

    获取房间ID

    Returns undefined | string

    房间ID字符串,如果未设置则返回 undefined

    房间ID是房间的唯一标识符,由用户创建房间时指定。

  • set roomId(value: undefined | string): void

    设置房间ID

    Parameters

    • value: undefined | string

      要设置的房间ID

    Returns void

    设置房间的唯一标识符。

  • get roomNumber(): number

    获取房间号码

    Returns number

    房间号码值

    房间号码是服务器为房间生成的唯一数字标识,与房间ID不同, 房间号码由服务器自动分配。

  • set roomNumber(value: number): void

    设置房间号码

    Parameters

    • value: number

      要设置的房间号码

    Returns void

    设置服务器分配的房间号码。

  • get memberCount(): number

    获取房间成员数量

    Returns number

    房间内的成员数量

    此值表示房间中当前的用户数量。

  • set memberCount(value: number): void

    设置房间成员数量

    Parameters

    • value: number

      要设置的成员数量

    Returns void

    设置房间中当前的用户数量。

  • get memberUserIdList(): any

    获取房间成员用户ID列表

    Returns any

    成员用户ID列表,如果未设置则返回 undefined

    返回一个包含房间所有成员用户ID的列表。

  • set memberUserIdList(value: any): void

    设置房间成员用户ID列表

    Parameters

    • value: any

      要设置的成员用户ID列表

    Returns void

    设置房间所有成员的用户ID列表。

Methods

  • 将查询信息对象转换为JSON格式

    Returns Record<string, undefined | Object>

    包含所有房间查询信息的JSON对象

    此方法将房间查询信息的所有属性转换为标准的JSON对象,便于序列化和传输。

  • 将查询信息对象转换为字符串

    Returns string

    包含所有房间查询信息的JSON字符串

    此方法将房间查询信息转换为JSON字符串格式,便于日志记录和调试。