Options
All
  • Public
  • Public/Protected
  • All
Menu

RTCLib - v5.7.2

Index

Variables

device: { getCameras: (() => Promise<MediaDeviceInfo[]>); getMicrophones: (() => Promise<MediaDeviceInfo[]>); getSpeakers: (() => Promise<MediaDeviceInfo[]>) } = ...

Type declaration

  • getCameras: (() => Promise<MediaDeviceInfo[]>)
      • (): Promise<MediaDeviceInfo[]>
      • 获取摄像头设备列表

        Returns Promise<MediaDeviceInfo[]>

  • getMicrophones: (() => Promise<MediaDeviceInfo[]>)
      • (): Promise<MediaDeviceInfo[]>
      • 获取 Microphone 列表

        Returns Promise<MediaDeviceInfo[]>

  • getSpeakers: (() => Promise<MediaDeviceInfo[]>)
      • (): Promise<MediaDeviceInfo[]>
      • 获取扬声器设备列表

        Returns Promise<MediaDeviceInfo[]>

installer: IPluginGenerator<RCRTCClient, IRCRTCInitOptions> = ...

RTC 插件生成器

RCTag: { DEFAULT: string } = ...

预定义的资源 tag

Type declaration

  • DEFAULT: string

    默认流 Tag 定义

helper: { transResolution: ((resolution: RCResolution) => { width: number; height: number }); transFrameRate: ((fps: RCFrameRate) => number); parseTrackId: ((trackId: string) => { mediaType: RCMediaType; tag: string; userId: string }); ifSupportLocalFileTrack: (() => boolean); ifSupportScreenShare: (() => boolean) } = ...

Type declaration

  • transResolution: ((resolution: RCResolution) => { width: number; height: number })
      • (resolution: RCResolution): { width: number; height: number }
      • 转化 RCResolution 枚举值为分辨率宽高

        Parameters

        Returns { width: number; height: number }

        • width: number
        • height: number
  • transFrameRate: ((fps: RCFrameRate) => number)
  • parseTrackId: ((trackId: string) => { mediaType: RCMediaType; tag: string; userId: string })
      • (trackId: string): { mediaType: RCMediaType; tag: string; userId: string }
      • 它接受一个类似“userId_tag_mediaType”的字符串,并返回一个包含字符串三个部分的对象 解析 trackId 以获取资源信息 trackId 构成说明 trackId = [ userid, tag, mediaType ].join('_') userid : 用户可随意定义可包含 _ 下划线 tag : 不可以有 _ 下划线 mediaType : RCMediaType 0:音频流 1:视频流 2:音视频混合流

        Parameters

        • trackId: string

          远程轨道的轨道 ID。

        Returns { mediaType: RCMediaType; tag: string; userId: string }

        具有三个属性的对象:mediaType、tag 和 userId。

  • ifSupportLocalFileTrack: (() => boolean)
      • (): boolean
      • 验证浏览器是否支持创建自定义文件流

        Returns boolean

  • ifSupportScreenShare: (() => boolean)
      • (): boolean
      • 验证浏览器是否支持屏幕共享

        Returns boolean

Type Aliases

RTCEncodedFrame: RTCEncodedAudioFrame | RTCEncodedVideoFrame
RCEncryptFunction<T>: ((data: T) => T)

Type Parameters

Type declaration

    • (data: T): T
    • Parameters

      • data: T

      Returns T