Class RCMediaStreamCapture

Hierarchy

RCMediaStreamCapture
- RCRTCClient

Index

Constructors

constructor

Methods

Constructors

constructor

new RCMediaStreamCapture(_context: RTCContext): RCMediaStreamCapture

- Defined in src/core/RCMediaStreamCapture.ts:20
Parameters
- _context: RTCContext
Returns RCMediaStreamCapture

Methods

createCameraVideoTrack

createCameraVideoTrack(tag?: string, options?: ICameraVideoProfile): Promise<{ code: RCRTCCode; track?: RCCameraVideoTrack }>

- Defined in src/core/RCMediaStreamCapture.ts:147
由摄像头捕获视轨数据

Parameters
- tag: string = 'RongCloudRTC'
- Optional options: ICameraVideoProfile
Returns Promise<{ code: RCRTCCode; track?: RCCameraVideoTrack }>

createLocalAudioTrack

createLocalAudioTrack(tag: string, track: MediaStreamTrack): Promise<{ code: RCRTCCode; track?: RCLocalAudioTrack }>

- Defined in src/core/RCMediaStreamCapture.ts:441
创建 RCLocalAudioTrack 实例

Parameters
- tag: string
- track: MediaStreamTrack
Returns Promise<{ code: RCRTCCode; track?: RCLocalAudioTrack }>

createLocalFileTracks

createLocalFileTracks(tag: string, file: string | File, options?: ICreateLocalTrackOptions): Promise<{ code: RCRTCCode; tracks: RCLocalFileTrack[] }>

- Defined in src/core/RCMediaStreamCapture.ts:536
根据本地或网络媒体文件资源创建 RCLocalFileTrack 实例

Parameters
- tag: string
  
  资源标识
- file: string | File
  
  网络文件地址，或通过获取到的 File 实例
- Optional options: ICreateLocalTrackOptions
  
  可用于指定 withoutVideo 与 withoutAudio 以剔除视轨与音轨
Returns Promise<{ code: RCRTCCode; tracks: RCLocalFileTrack[] }>

createLocalTracks

createLocalTracks(tag: string, stream: MediaStream, options?: ICreateLocalTrackOptions): Promise<{ code: RCRTCCode; tracks: RCLocalTrack[] }>

- Defined in src/core/RCMediaStreamCapture.ts:639
根据 MediaStream 实例对象创建 RCLocalTrack 实例

Parameters
- tag: string
  
  轨道标识
- stream: MediaStream
  
  MediaStream 实例
- Optional options: ICreateLocalTrackOptions
  
  可用于指定 withoutVideo 与 withoutAudio 以剔除视轨与音轨
Returns Promise<{ code: RCRTCCode; tracks: RCLocalTrack[] }>

createLocalVideoTrack

createLocalVideoTrack(tag: string, track: MediaStreamTrack): Promise<{ code: RCRTCCode; track?: RCLocalVideoTrack }>

- Defined in src/core/RCMediaStreamCapture.ts:488
创建 RCLocalVideoTrack 实例

Parameters
- tag: string
  
  视轨数据标识
- track: MediaStreamTrack
  
  MediaStreamTrack 实例
Returns Promise<{ code: RCRTCCode; track?: RCLocalVideoTrack }>

createMicrophoneAndCameraTracks

createMicrophoneAndCameraTracks(tag?: string, options?: { audio?: IMicphoneAudioProfile; video?: ICameraVideoProfile }): Promise<{ code: RCRTCCode; tracks: RCLocalTrack[] }>

- Defined in src/core/RCMediaStreamCapture.ts:206
通过摄像头与麦克风采集音视频轨道数据

Parameters
- tag: string = 'RongCloudRTC'
- Optional options: { audio?: IMicphoneAudioProfile; video?: ICameraVideoProfile }
  - Optional audio?: IMicphoneAudioProfile
  - Optional video?: ICameraVideoProfile
Returns Promise<{ code: RCRTCCode; tracks: RCLocalTrack[] }>

createMicrophoneAudioTrack

createMicrophoneAudioTrack(tag?: string, options?: IMicphoneAudioProfile): Promise<{ code: RCRTCCode; track?: RCMicphoneAudioTrack }>

- Defined in src/core/RCMediaStreamCapture.ts:90
从麦克风中捕获音轨数据

Parameters
- tag: string = 'RongCloudRTC'
- Optional options: IMicphoneAudioProfile
Returns Promise<{ code: RCRTCCode; track?: RCMicphoneAudioTrack }>

createScreenVideoTrack

createScreenVideoTrack(tag?: string, options?: IScreenVideoProfile): Promise<{ code: RCRTCCode; track?: RCScreenVideoTrack }>

- Defined in src/core/RCMediaStreamCapture.ts:286
创建屏幕共享视频流，默认分辨率 1280 * 720，帧率 15

description
支持 Electron 平台下通过制定 chromeMediaSourceId 的方式获取屏幕共享视频。参考：https://www.electronjs.org/docs/api/desktop-capturer

Parameters
- tag: string = 'screenshare'
  
  屏幕共享视轨数据标识
- Optional options: IScreenVideoProfile
Returns Promise<{ code: RCRTCCode; track?: RCScreenVideoTrack }>

createScreenWithAudioTracks

createScreenWithAudioTracks(tag?: string, options?: IScreenVideoProfile): Promise<{ code: RCRTCCode; tracks?: (RCScreenVideoTrack | RCScreenAudioTrack)[] }>

- Defined in src/core/RCMediaStreamCapture.ts:301
创建带音频的屏幕共享资源

description
electron 中 mac 系统暂不支持屏幕共享采集声音

Parameters
- tag: string = 'screenshare'
  
  屏幕共享视轨数据标识
- Optional options: IScreenVideoProfile
Returns Promise<{ code: RCRTCCode; tracks?: (RCScreenVideoTrack | RCScreenAudioTrack)[] }>
在可以取到音频的情况下，tracks 中包含音轨和视轨；取不到音视频时 tracks 仅返回视轨

Static getTracksWithOptions

getTracksWithOptions(stream: MediaStream, options?: ICreateLocalTrackOptions): (undefined | MediaStreamTrack)[]

- Defined in src/core/RCMediaStreamCapture.ts:691
它接受一个 MediaStream 和一个可选的选项对象并返回一个 MediaStreamTracks 数组

Parameters
- stream: MediaStream
  
  MediaStream - 从中获取曲目的流。
- Optional options: ICreateLocalTrackOptions
Returns (undefined | MediaStreamTrack)[]
一组 MediaStreamTrack 对象。

Generated using TypeDoc