Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RCRTCRoom

Hierarchy

  • default
    • RCRTCRoom

Index

Constructors

Methods

Constructors

constructor

  • new RCRTCRoom(context: RTCPluginContext, runtime: IRuntime, initOptions: IRCRTCInitOptions, invoker: default, _releaseRoomInstance: Function): RCRTCRoom

  • Parameters

    • context: RTCPluginContext
    • runtime: IRuntime
    • initOptions: IRCRTCInitOptions
    • invoker: default
    • _releaseRoomInstance: Function

    Returns RCRTCRoom

Methods

__leaveHandle

  • __leaveHandle(): Promise<void>

  • 离开房间

    Returns Promise<void>

__onReconnected

  • __onReconnected(): void

  • im 重新连接之后的处理

    Returns void

__parseInnerMessage

  • __parseInnerMessage(message: IReceivedMessage): boolean

  • Parameters

    • message: IReceivedMessage

    Returns boolean

clear

  • clear(): void

  • 无差别清空所有事件监听器

    Returns void

closeCamera

  • 关闭摄像头 未发布视频时，该方法仅关闭摄像头硬件设备 发布过视频时，关闭摄像头硬件设备后，修改视频资源状态为不可用，订阅端看到发布的视频为黑屏

    Returns Promise<{ code: RCRTCCode; data: unknown } | { code: RCRTCCode }>

closeMicphone

  • 关闭麦克风 未发布音频时，该方法仅关闭麦克风硬件设备 发布过视频时，关闭麦克风硬件设备后，修改音频资源状态为不可用，订阅端听不到发布的声音

    Returns Promise<{ code: RCRTCCode; data: unknown } | { code: RCRTCCode }>

deleteRoomAttributes

  • deleteRoomAttributes(keys: string[], message: { content: any; name: string }, isInner?: boolean): Promise<{ code: RCRTCCode }>

  • 删除房间属性

    Parameters

    • keys: string[]

      待删除的属性名数组

    • message: { content: any; name: string }

      是否在删除属性的时候携带消息内容，传空则不往房间中发送消息

      • content: any
      • name: string
    • isInner: boolean = false

      RTC 业务内部使用参数，用户忽略

    Returns Promise<{ code: RCRTCCode }>

emit

  • emit(eventType: string, ...attrs: any[]): void

  • 事件派发

    Parameters

    • eventType: string
    • Rest ...attrs: any[]

    Returns void

getCrtUserId

  • getCrtUserId(): string

  • 获取当前用户

    Returns string

    返回当前用户 Id

getRemoteStreams

  • 获取远端发布的所有资源列表 streams

    Returns RCRemoteStream[]

getRemoteStreamsByUserId

  • 根据 userId 获取此用户在房间内发布的资源列表

    Parameters

    • userId: string

      远端用户 Id

    Returns RCRemoteStream[]

getRemoteUserIds

  • getRemoteUserIds(): string[]

  • 获取房间内其他人员

    Returns string[]

getRoomAttributes

  • getRoomAttributes(keys?: string[], isInner?: boolean): Promise<{ code: RCRTCCode; data: undefined } | { code: RCRTCCode; data: undefined | KVString }>

  • 获取房间属性

    Parameters

    • keys: string[] = []

      要查询的属性名数组，当数组长度为空时，取所有已设置的 kv 值

    • isInner: boolean = false

      RTC 业务内部使用参数，用户忽略

    Returns Promise<{ code: RCRTCCode; data: undefined } | { code: RCRTCCode; data: undefined | KVString }>

getRoomId

  • getRoomId(): string

  • 获取房间 Id

    Returns string

    返回房间 Id

getSessionId

  • getSessionId(): string

  • Returns string

isCameraOpen

  • isCameraOpen(): boolean

  • 摄像头是否开启

    Returns boolean

isDestroyed

  • isDestroyed(): boolean

  • 房间是否被销毁

    Returns boolean

isMicphoneOpen

  • isMicphoneOpen(): boolean

  • 麦克风是否开启

    Returns boolean

off

  • off(eventType: string, listener: IEventListener, target?: any): void

  • 移除事件监听器

    Parameters

    • eventType: string
    • listener: IEventListener
    • Optional target: any

    Returns void

on

  • on(eventType: string, listener: IEventListener, target?: any): void

  • 添加事件监听器

    Parameters

    • eventType: string
    • listener: IEventListener
    • Optional target: any

    Returns void

onLocalAudioLevelChange

  • onLocalAudioLevelChange(listenerEvent: null | ((volume: number) => void)): void

  • 注册本端麦克风采集的音量通知

    Parameters

    • listenerEvent: null | ((volume: number) => void)

    Returns void

onRemoteAudioLevelChange

  • onRemoteAudioLevelChange(listenerEvent: null | ((msid: string, volume: number) => void)): void

  • 注册远端订阅资源的音量通知

    Parameters

    • listenerEvent: null | ((msid: string, volume: number) => void)

    Returns void

once

  • once(eventType: string, listener: IEventListener, target?: any): void

  • Parameters

    • eventType: string
    • listener: IEventListener
    • Optional target: any

    Returns void

openCamera

  • 开启摄像头 未发布视频时，该方法仅打开摄像头硬件设备 发布过视频时，打开摄像头硬件设备后，修改视频资源状态为可用，订阅端可以看到发布的视频

    Returns Promise<{ code: RCRTCCode; data: unknown } | { code: RCRTCCode }>

openMicphone

  • 开启麦克风 未发布音频时，该方法仅打开麦克风硬件设备 发布过视频时，打开麦克风硬件设备后，修改音频资源状态为可用，订阅端可以听到发布的声音

    Returns Promise<{ code: RCRTCCode; data: unknown } | { code: RCRTCCode }>

publishStream

  • 发布资源

    Parameters

    • tag: string = 'RongCloudRTC'

      资源标识，可不传，默认为 RongCloudRTC

    • mediaType: RCMediaType = RCMediaType.AUDIO_VIDEO

      资源类型，代表发布音频、视频或音视频，可不传，默认为 RCMediaType.AUDIO_VIDEO

    Returns Promise<{ code: RCRTCCode }>

    发布资源状态码

registerReportListener

  • 注册小程序网络状态和资源数据事件

    Parameters

    Returns void

registerRoomEventListener

  • 注册房间事件

    Parameters

    Returns void

removeAll

  • removeAll(eventType: string): void

  • 清空所有指定类型的事件监听器

    Parameters

    • eventType: string

    Returns void

sendMessage

  • sendMessage(name: string, content: any): Promise<{ code: RCRTCCode }>

  • 向房间内发消息

    Parameters

    • name: string

      消息名称

    • content: any

      消息内容

    Returns Promise<{ code: RCRTCCode }>

setRoomAttribute

  • setRoomAttribute(key: string, value: string, message?: { content: any; name: string }, isInner?: boolean): Promise<{ code: RCRTCCode }>

  • 设置房间属性

    Parameters

    • key: string

      属性名

    • value: string

      属性值

    • Optional message: { content: any; name: string }

      是否在设置属性的时候携带消息内容，传空则不往房间中发送消息

      • content: any
      • name: string
    • isInner: boolean = false

      RTC 业务内部使用参数，用户忽略

    Returns Promise<{ code: RCRTCCode }>

startPreview

  • startPreview(): void

  • 开启视频预览

    Returns void

stopPreview

  • stopPreview(): void

  • 关闭视频预览

    Returns void

subscribe

  • 订阅资源

    Parameters

    • subParams: RCRemoteStream[] | ISubParams[]

      订阅参数列表

      • ISubParams.stream 从房间数据或房间发布资源事件监听中拿到的 RCRemoteStream 对象
      • ISubParams.subTiny 是否订阅小流，可不传，默认为小流，boolean 类型，true 代表订阅小流

    Returns Promise<{ code: RCRTCCode }>

    订阅的状态码

unpublishStream

  • unpublishStream(): Promise<{ code: RCRTCCode }>

  • 取消发布

    Returns Promise<{ code: RCRTCCode }>

    取消发布的状态码

unsubscribe

  • 取消订阅

    Parameters

    Returns Promise<{ code: RCRTCCode }>

    取消订阅的状态码

Generated using TypeDoc