Class JRTCRoom

房间管理

Hierarchy

Methods

create destroy enableUploadAudioStream enableUploadVideoStream requestVideo requestScreenVideo getRoomId getPassword getCallId getTitle getState getParticipants getParticipant statistics getUploadLocalAudio getUploadLocalVideo getShareStreamId getShareUserId getRemoteRecordState query join leave setRemoteMergeVideoProperty unRequestVideo unRequestScreenVideo enableRemoteRecord setCustomProperty getCustomProperty sendMessage setRatio isAutoRecord

Methods

Static create

  • create(client, mediaDevice, initParam, callback): undefined | JRTCRoom

  • 创建 JRTCRoom 对象

    Parameters

    Returns undefined | JRTCRoom

    JRTCRoom 对象

    Note

    Throws

    Error "初次创建时 JRTCClient、JRTCMediaDevice、JRTCRoomCallback、JRTCRoomInitParam 任意一个参数传空就会创建失败"

Static destroy

  • destroy(): void

  • 销毁 JRTCRoom 对象

    Returns void

    Note

    • 该方法为同步调用，需要等待 JRTCRoom 实例资源释放后才能执行其他操作，调用此方法后，你将无法再使用 JRTCRoom 的其它方法和回调。
    • 我们 不建议 在 JRTCSDK 的回调中调用此方法销毁 JRTCRoom 对象，否则可能出现崩溃。
    • 如需在销毁后再次创建 JRTCRoom 实例，需要等待 destroy 方法执行结束后再创建实例。

enableUploadAudioStream

  • enableUploadAudioStream(enable): boolean

  • 开启/关闭发送本地音频流

    • 调用该方法可开启或关闭发送本地音频流。开启后，房间成员将听见本端声音；关闭后，房间成员将听不见本端声音
    • 房间中调用此方法不影响接收远端音频
    • 初始化 JRTCRoom 时，默认不发送本地音频流。若要加入房间时，让房间内其他成员听见本端声音，需要在调用 join 加入房间前设置
    • 该方法在房间内和房间外均可调用，且在离开房间后该设置仍然有效。也就是说这一次设置了开启发送本地音频流，那么在下一次加入房间时默认会开启发送本地音频流
    • 房间中也可调用此方法开启或关闭发送本地音频流，服务器会更新状态并同步给其他房间成员，即房间中所有成员都会收到 onParticipantUpdate 回调

    Parameters

    • enable: boolean

      开启/关闭发送本地音频流

      • true: 开启，即发送本地音频流
      • false: 关闭，即不发送本地音频流

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • 在调用此方法时，用户未加入房间，不会收到回调
    • 在调用此方法时，用户已在房间中，会收到 onRoomPropertyChanged 回调
    • false: 接口调用异常

enableUploadVideoStream

  • enableUploadVideoStream(enable): boolean

  • 开启/关闭发送本地视频流

    • 调用该方法可开启或关闭发送本地视频流。开启后，房间成员将可以看见本端视频画面；关闭后，房间成员将看不见本端视频画面
    • 房间中调用此方法不影响接收远端视频
    • 初始化 JCRoom 时，默认发送本地视频流。若要加入房间时，让房间内其他成员看见本端视频画面，建议在调用 join 加入房间前设置
    • 该方法在房间内和房间外均可调用，且在离开房间后该设置仍然有效。也就是说这一次设置了关闭发送本地视频流，那么在下一次加入房间时默认会关闭发送本地视频流
    • 会议中也可调用此方法开启或关闭发送本地视频流，服务器会更新状态并同步给其他房间成员，即房间中所有成员都会收到 onParticipantUpdate 回调

    Parameters

    • enable: boolean

      是否发送本地视频流

      • true: 开启，即发送本地视频流
      • false: 关闭，即不发送本地视频流

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • 在调用此方法时，用户不在房间中，不会收到回调
    • 在调用此方法时，用户在房间中，会收到 onRoomPropertyChanged 回调
    • false: 接口调用异常

requestVideo

  • requestVideo(participant, videoSize): Promise<{
        streamUrl: string;
        mediaStream: MediaStream;
    }>

  • 订阅房间中其他用户的视频流

    Parameters

    Returns Promise<{
        streamUrl: string;
        mediaStream: MediaStream;
    }>

    包含视频流拉流地址(SRS地址)和媒体流对象

requestScreenVideo

  • requestScreenVideo(videoSize): Promise<{
        streamUrl: string;
        mediaStream: MediaStream;
    }>

  • 订阅屏幕共享的视频流

    Parameters

    Returns Promise<{
        streamUrl: string;
        mediaStream: MediaStream;
    }>

    包含视频流拉流地址(SRS地址)和媒体流对象

getRoomId

  • getRoomId(): undefined | string

  • 获取房间号

    Returns undefined | string

    房间号

getPassword

  • getPassword(): undefined | string

  • 获取房间密码

    Returns undefined | string

    房间密码

getCallId

  • getCallId(): undefined | string

  • 获取房间唯一标识（服务器生成）

    Returns undefined | string

    房间唯一标识

getTitle

  • getTitle(): undefined | string

  • 获取房间标题

    Returns undefined | string

    房间标题

getState

  • getState(): RoomState

  • 获取自己当前在房间中的状态

    Returns RoomState

    当前在房间中的状态

getParticipants

getParticipant

  • getParticipant(userId): undefined | JRTCRoomParticipant

  • 根据用户ID获取房间成员

    Parameters

    • userId: string

      用户ID

    Returns undefined | JRTCRoomParticipant

    房间成员对象

    • 房间内无此用户标识的用户: undefined
    • 房间内有此用户标识的用户: JCRoomParticipant 对象

statistics

  • statistics(): string

  • Returns string

    统计信息

getUploadLocalAudio

  • getUploadLocalAudio(): boolean

  • 获取本地音频数据是否在上传

    Returns boolean

    是否上传音频数据

    • true: 上传中
    • false: 未上传

getUploadLocalVideo

  • getUploadLocalVideo(): boolean

  • 获取本地视频数据是否在上传

    Returns boolean

    是否在上传本地视频数据

    • true: 上传中
    • false: 未上传

getShareStreamId

  • getShareStreamId(): undefined | string

  • 获取屏幕共享时的视频流ID，无屏幕共享时为 undefined

    调用 JRTCMediaDevice startVideo 接口渲染通话中其他成员的屏幕共享画面时使用。

    Returns undefined | string

    屏幕共享时的视频流ID

getShareUserId

  • getShareUserId(): undefined | string

  • 获取发起屏幕共享者的用户ID，无屏幕共享时为 undefined

    可用来判断当前通话中是否有成员发起屏幕共享。

    Returns undefined | string

    发起屏幕共享者的用户ID

getRemoteRecordState

  • getRemoteRecordState(): RemoteRecordState

  • 获取远程视频录制状态

    Returns RemoteRecordState

    远程视频录制状态

    • NONE : 无法进行视频录制。用户不在房间中或者加入房间时没有设置视频录制参数
    • READY : 可以开启视频录制。用户在加入房间时设置了录制参数，并且没有在录制视频
    • RUNNING : 视频录制中。用户在加入房间时设置了录制参数，并且正在视频录制中

query

  • query(roomId): number

  • 查询房间相关信息

    调用此接口可以查询房间相关信息，例如房间人数等，结果通过 onQuery 回调通知

    Parameters

    • roomId: string

      房间标识

    Returns number

    操作id，与 onQuery 回调中的 operationId 对应

join

  • join(roomId, joinParam): boolean

  • 加入房间

    该方法让用户加入通话房间，在同一个房间内的用户可以互相通话。
    如果用户已在房间中，必须退出当前房间，即处于空闲状态，才能进入其他房间，否则将直接返回 false，且不会收到回调通知。

    Parameters

    • roomId: string

      房间标识

    • joinParam: JRTCRoomJoinParam

      JCRoomJoinParam 对象，传 null 则使用默认配置

    Returns boolean

    接口调用结果

    • true: 接口调用成功，会收到 onJoin 回调
    • false: 接口调用异常

leave

  • leave(): boolean

  • 离开房间

    Returns boolean

    接口调用结果

    • true: 接口调用成功，非空闲状态下，会收到 onLeave 回调
    • false: 接口调用异常

setRemoteMergeVideoProperty

  • setRemoteMergeVideoProperty(mergeParam): boolean

  • 设置远端视频合流参数

    Parameters

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

    Notes

    需要加入房间

unRequestVideo

  • unRequestVideo(participant): boolean

  • 取消订阅房间中其他用户的视频流

    Parameters

    Returns boolean

    调用是否正常

    • true: 正常执行调用流程，会收到 onParticipantUpdate 回调
    • false: 调用失败，不会收到回调通知

unRequestScreenVideo

  • unRequestScreenVideo(): boolean

  • 取消订阅屏幕共享的视频流

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

enableRemoteRecord

  • enableRemoteRecord(enable, recordParam?): boolean

  • 开启/关闭远程录制

    可通过 getRemoteRecordState 属性获取当前服务器录制状态。

    Parameters

    • enable: boolean

      开启或关闭远程录制

      • true: 开启视频录制
      • false: 关闭视频录制
    • Optional recordParam: JRTCRecordRemoteParam

      录制参数，详见 JRTCRecordRemoteParam。当 enable == false 时，可传 null；当 enable == true 且按照默认配置进行录制可传 null

    Returns boolean

    接口调用结果

setCustomProperty

  • setCustomProperty(key, value): boolean

  • 设置媒体房间中的自定义属性

    Parameters

    • key: string

      自定义属性的key值

    • value: string

      自定义属性的value值

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

getCustomProperty

  • getCustomProperty(key): undefined | string

  • 获取自定义房间属性

    调用此接口来获取自定义房间属性

    Parameters

    • key: string

      自定义属性 key

    Returns undefined | string

    属性值

sendMessage

  • sendMessage(type, content, toUserId?): boolean

  • 发送房间消息，消息内容不能大于4K

    消息接收方都会收到 onMessageReceived 回调

    Parameters

    • type: string

      消息类型

    • content: string

      消息内容

    • Optional toUserId: string

      指定成员的用户ID，传 null 即给通话中全部成员发送消息

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

setRatio

  • setRatio(ratio): boolean

  • 设置本端视频宽高比

    将自己的视频采集根据宽高比裁剪后进行发送，通话中其他成员收到的画面将是裁剪后的比例。
    该方法不影响其他成员的画面在本端的显示比例，也不影响其他成员相互之间的画面显示比例。
    必须 加入房间后 设置才能生效，即收到 onJoin 回调后设置才生效。

    Parameters

    • ratio: number

      视频宽高比

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

isAutoRecord

  • isAutoRecord(): boolean

  • Returns boolean

设置

主题

Generated using TypeDoc