Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RCRTCClient

RTC 业务客户端

Hierarchy

Index

Methods

  • 根据本地或网络媒体文件资源创建 RCLocalFileTrack 实例

    Parameters

    • tag: string

      资源标识

    • file: string | File

      网络文件地址,或通过 获取到的 File 实例

    • Optional options: ICreateLocalTrackOptions

      可用于指定 withoutVideowithoutAudio 以剔除视轨与音轨

    Returns Promise<{ code: RCRTCCode; tracks: RCLocalFileTrack[] }>

  • getCurrentId(): string
  • 获取当前用户 Id,若 IM 未连接,这返回 ''

    Returns string

  • 加入跨 AppKey 音视频房间

    deprecated

    @since 5.7.0; 请使用 joinRTCRoomWithOptions 方法替代

    Parameters

    • roomId: string
    • Optional joinType: RTCJoinType

      多端处理方式

    • Optional userData: IRTCUserData

      设置用户属性

    • _: boolean = false

      参数已废弃

    • __: RTCMode = RTCMode.CROSS_MUTI

      参数已废弃

    Returns Promise<{ room?: RCRTCRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[] }>

  • 加入普通音视频房间,加入成功后返回 room 实例、code、userIds、tracks

    deprecated

    @since 5.7.0; 请使用 joinRTCRoomWithOptions 方法替代

    Parameters

    • roomId: string

      房间号

    • Optional joinType: RTCJoinType
    • Optional userData: IRTCUserData
    • _: boolean = false
    • roomType: RTC | SIP | CALL = RTCMode.RTC

      房间类型,请谨慎修改,默认为 RTCMode.RTC

    Returns Promise<{ room?: RCRTCRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[] }>

  • 加入普通音视频房间

    since

    5.7.0

    Parameters

    Returns Promise<{ room?: RCRTCRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[] }>

  • 主播加入直播房间或观众上麦场景调用,观众上麦之前需先取消已订阅的直播间资源

    Parameters

    • roomId: string

      房间 Id

    • livingType: RCLivingType

      直播间类型,RCLivingType.AUDIO 为音频直播,RCLivingType.VIDEO 为音视频直播

    • Optional joinType: RTCJoinType

      多端处理方式,公有云暂不支持该字段

    • Optional outerUserDatas: IRTCUserData

      业务层设置人员属性

    • _: boolean = false

      参数已废弃

    Returns Promise<{ room?: RCLivingRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[]; CDNEnable?: boolean }>

  • 获取直播观众客户端

    Parameters

    • Optional _: boolean

      参数已废弃

    Returns RCAudienceClient

  • 退出并销毁当前房间实例,退出后该房间的所有方法将不可用

    Parameters

    Returns Promise<{ code: RCRTCCode }>

  • 观众退出并销毁当前房间实例,退出后该房间的所有方法将不可用

    Parameters

    Returns Promise<{ code: RCRTCCode }>

  • getJoinedRoomInfo(): Promise<{ code: RCRTCCode | ErrorCode; data?: IRTCJoinedInfo[] }>
  • 验证本用户是否存在于某个 RTC 房间内

    since

    version 5.2.1

    Returns Promise<{ code: RCRTCCode | ErrorCode; data?: IRTCJoinedInfo[] }>

Constructors