Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StreamOptions

Hierarchy

  • StreamOptions

Index

Properties

audio

audio: boolean

是否从麦克风采集音频

Optional audioProcessing

audioProcessing: { AEC?: boolean; AGC?: boolean; ANS?: boolean }

是否开启/关闭音频处理接口(3A接口)。

note

音频处理接口取决于浏览器支持情况。目前Safari不支持AGC及ANS设置。

AEC: 是否开启声学回声消除。默认为 true。

  • true:开启声学回声消除。
  • false:关闭声学回声消除。 AGC: 是否开启自动增益控制。默认为 true。
  • true:开启自动增益控制。
  • false:关闭自动增益控制。 ANS: 是否开启自动噪声抑制。默认为 true。
  • true:开启自动噪声抑制。
  • false:关闭自动噪声抑制。

Type declaration

  • Optional AEC?: boolean
  • Optional AGC?: boolean
  • Optional ANS?: boolean

Optional audioSource

audioSource: MediaStreamTrack

自定义的音频的track

Optional cameraId

cameraId: string

摄像头设备 deviceId,通过 getCameras() 获取。

Optional client

client: Client

和要Stream绑定的client实例对象,默认是最初使用用createClient创建的client实例(多实例场景使用)

Optional facingMode

facingMode: String

指定使用前置/后置摄像头来采集视频

Optional microphoneId

microphoneId: string

麦克风设备 deviceId,通过 NERTC.getMicrophones 获取。

Optional screen

screen: boolean

是否采集屏幕共享流。

Optional screenAudio

screenAudio: boolean

是否采集屏幕分享流的共享音频。

since

V4.3.0

screenAudio 字段用于指定该屏幕共享流中是否包含本地播放的声音。

可设置为:

  • true:屏幕共享同时共享本地播放的背景音。
  • false:(默认)屏幕共享时不共享本地播放的背景音。
note
  • 该功能仅支持 Windows 和 macOS 平台 Chrome 浏览器 74 及以上版本。其中 macOS 平台的 Chrome 浏览器仅支持 Chrome 标签页(Chrome Tab)模式。
  • 如需使用屏幕共享背景音功能,必须将 screen 设为 true、audio 设为 false。Stream.setAudioProfile 推荐设置为 high_quality_stereo。如果 screenAudio 和 audio 都设置为 true,音视频流中只会包含本地播放的背景音。
  • 如需使用屏幕共享背景音功能,还需要在屏幕共享的弹出框中,勾选 分享音频(Share audio)。

Optional sourceId

sourceId: string

Electron 屏幕共享的数据源 ID,您可以自行获取。

uid

uid: number

用户 ID。

video

video: boolean

是否从摄像头采集视频。

Optional videoSource

videoSource: MediaStreamTrack

自定义的视频的track