Class JRTCRoomParticipant

房间成员类

Remarks

此类表示RTC房间中的一个参与者，包含该参与者的各种状态信息，如用户ID、音频/视频状态、 网络状态、角色信息等。通过此类可以获取和设置与房间成员相关的各种属性。

在房间通话过程中，系统会自动更新成员状态，应用层可以监听这些状态变化来更新UI或执行 特定逻辑。

Accessors

roomHandle netStatus userId streamId displayName role clientInfo clientProtocolVersion volumeStatus volume audio video sipTalking requestVideoSize lastUpdateTime extraStreams

Methods

isViewer isIRC isAgent isGuest isSip isDigital isAI toJSON toString

Accessors

roomHandle

  • get roomHandle(): number

    获取房间句柄

    Returns number

    房间句柄值

  • set roomHandle(value: number): void

    设置房间句柄

    Parameters

    • value: number

    Returns void

    Remarks

    房间句柄是与特定房间会话关联的唯一标识符。

netStatus

  • get netStatus(): JRTCNetStatus

    获取网络状态

    Returns JRTCNetStatus

    当前网络状态值

  • set netStatus(netStatus: JRTCNetStatus): void

    设置网络状态

    Parameters

    Returns void

    Remarks

    设置成员的网络连接状态。当网络状态发生变化时，会更新变化参数。

    可能的状态值包括：

userId

  • get userId(): undefined | string

    获取用户ID

    Returns undefined | string

    用户ID字符串

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

    设置用户ID

    Parameters

    • value: undefined | string

    Returns void

    Remarks

    用户ID是成员的唯一标识符，用于在系统中区分不同的用户。

streamId

  • get streamId(): undefined | string

    获取视频流ID

    Returns undefined | string

    视频流ID字符串

    Remarks

    视频流ID用于渲染视频画面。

    对于本地用户，如果摄像头已打开，则返回当前摄像头ID； 对于远端用户，返回服务器分配的流ID。

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

    设置视频流ID

    Parameters

    • value: undefined | string

    Returns void

    Remarks

    设置用于标识视频流的唯一ID。

displayName

  • get displayName(): undefined | string

    获取显示名称

    Returns undefined | string

    成员的显示名称

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

    设置显示名称

    Parameters

    • value: undefined | string

    Returns void

    Remarks

    设置成员的昵称或显示名称，用于在用户界面上显示。

role

  • get role(): number

    获取成员角色

    Returns number

    表示成员角色的数值

  • set role(value: number): void

    设置成员角色

    Parameters

    • value: number

    Returns void

    Remarks

    设置成员在房间中的角色。当角色发生变化时，会更新变化参数。 角色值是一个位掩码，可以通过位运算判断具体角色类型。

clientInfo

  • get clientInfo(): undefined | string

    获取该成员的客户端信息

    Returns undefined | string

    表示该成员的客户端信息

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

    设置该成员的客户端信息

    Parameters

    • value: undefined | string

    Returns void

    Remarks

    设置该成员的客户端信息。

clientProtocolVersion

  • get clientProtocolVersion(): number

    获取该成员的客户端 SDK 协议版本

    Returns number

    客户端 SDK 协议版本

  • set clientProtocolVersion(value: number): void

    设置该成员的客户端 SDK 协议版本

    Parameters

    • value: number

    Returns void

    Remarks

    设置该成员的客户端 SDK 协议版本

volumeStatus

  • get volumeStatus(): JRTCVolumeStatus

    获取音量状态

    Returns JRTCVolumeStatus

    当前音量状态值

  • set volumeStatus(volumeStatus: JRTCVolumeStatus): void

    设置音量状态

    Parameters

    Returns void

    Remarks

    设置成员的音量等级状态。当音量状态发生变化时，会更新变化参数。

    可能的状态值包括：

volume

  • get volume(): number

    获取音量值

    Returns number

    当前音量值，范围为0-100

  • set volume(volume: number): void

    设置音量值

    Parameters

    • volume: number

    Returns void

    Remarks

    设置成员的音量数值，范围为0-100。当音量值发生变化时，会更新变化参数。

    • 0: 表示静音
    • 100: 表示最大音量

audio

  • get audio(): boolean

    获取音频状态

    Returns boolean

    如果音频已开启则返回 true，否则返回 false

  • set audio(audio: boolean): void

    设置音频状态

    Parameters

    • audio: boolean

    Returns void

    Remarks

    设置成员是否开启了音频。当音频状态发生变化时，会同时更新音量状态和变化参数。

    • true: 音频已开启，其他成员可以听到此成员的声音
    • false: 音频已关闭，其他成员听不到此成员的声音

video

  • get video(): boolean

    获取视频状态

    Returns boolean

    如果视频已开启则返回 true，否则返回 false

  • set video(video: boolean): void

    设置视频状态

    Parameters

    • video: boolean

    Returns void

    Remarks

    设置成员是否开启了视频。当视频状态发生变化时，会更新变化参数。

    • true: 视频已开启，其他成员可以看到此成员的画面
    • false: 视频已关闭，其他成员看不到此成员的画面

sipTalking

  • get sipTalking(): boolean

    获取SIP通话状态

    Returns boolean

    如果SIP电话已接通则返回 true，否则返回 false

  • set sipTalking(value: boolean): void

    设置SIP通话状态

    Parameters

    • value: boolean

    Returns void

    Remarks

    设置成员是否通过SIP电话线路接通。

    • true: SIP电话已接通，成员可以通过电话参与通话
    • false: SIP电话未接通

requestVideoSize

  • get requestVideoSize(): undefined | JRTCVideoSize

    获取请求的视频尺寸

    Returns undefined | JRTCVideoSize

    当前请求的视频尺寸对象

  • set requestVideoSize(videoSize: undefined | JRTCVideoSize): void

    设置请求的视频尺寸

    Parameters

    Returns void

    Remarks

    设置向该成员请求的视频尺寸。当请求的视频尺寸发生变化时，会更新变化参数。

    视频尺寸决定了接收的视频流的分辨率和质量。

lastUpdateTime

  • get lastUpdateTime(): number

    获取最后更新时间

    Returns number

    成员状态的最后更新时间戳

  • set lastUpdateTime(value: number): void

    设置最后更新时间

    Parameters

    • value: number

    Returns void

    Remarks

    设置成员状态的最后更新时间戳。

extraStreams

  • get extraStreams(): ArrayList<string>

    获取额外视频流列表

    Returns ArrayList<string>

    成员额外视频流列表

  • set extraStreams(value: ArrayList<string>): void

    设置额外视频流列表

    Parameters

    • value: ArrayList<string>

    Returns void

    Remarks

    设置成员的额外视频流列表

Methods

isViewer

  • isViewer(): boolean

    判断成员是否为观察者

    Returns boolean

    如果成员是观察者则返回 true，否则返回 false

    Remarks

    观察者只能观看不能参与互动。

isIRC

  • isIRC(): boolean

    判断成员是否为录制成员

    Returns boolean

    如果成员是录制成员则返回 true，否则返回 false

    Remarks

    录制成员是用于远程录制的特殊成员类型。

isAgent

  • isAgent(): boolean

    判断成员是否为座席

    Returns boolean

    如果成员是座席则返回 true，否则返回 false

    Remarks

    座席通常用于呼叫中心场景中的客服角色。

isGuest

  • isGuest(): boolean

    判断成员是否为访客

    Returns boolean

    如果成员是访客则返回 true，否则返回 false

    Remarks

    访客通常是呼叫中心场景中的普通用户角色。

isSip

  • isSip(): boolean

    判断成员是否为SIP电话成员

    Returns boolean

    如果成员是SIP成员则返回 true，否则返回 false

    Remarks

    SIP成员是通过电话网络接入房间的特殊成员类型。

isDigital

  • isDigital(): boolean

    判断成员是否为数字人成员

    Returns boolean

    如果成员是数字人则返回 true，否则返回 false

    Remarks

    数字人成员是一种虚拟成员类型，通常用于表示AI生成的虚拟角色。

isAI

  • isAI(): boolean

    判断成员是否为AI成员

    Returns boolean

    如果成员是AI成员则返回 true，否则返回 false

    Remarks

    AI成员是一种智能机器人成员类型，可以提供自动化的功能。

toJSON

  • toJSON(): Record<string, undefined | Object>

    将成员对象转换为JSON格式

    Returns Record<string, undefined | Object>

    包含成员所有属性的JSON对象

    Remarks

    此方法将成员的所有属性转换为标准的JSON对象，便于序列化和传输。

toString

  • toString(): string

    将房间成员对象转换为字符串

    Returns string

    包含所有变化参数的JSON字符串

    Remarks

    此方法将变化参数的所有属性转换为JSON字符串格式。

设置

主题