Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScreenAudioParameters

The audio configuration for the shared screen stream.

Only available for scenarios where captureAudio is true.

since

v3.7.0

Hierarchy

  • ScreenAudioParameters

Index

Properties

Optional allowCaptureCurrentApp

allowCaptureCurrentApp: undefined | false | true

Determines whether to capture the audio played by the current application:

  • true: Capture.
  • false: (Default) Do not capture.

Optional captureSignalVolume

captureSignalVolume: undefined | number

The volume of the captured system audio. The value range is [0,100]. The default value is 100.

Optional channels

channels: undefined | number

The number of audio channels. The default value is 2, indicating dual channels.

Optional sampleRate

sampleRate: undefined | number

The audio sample rate (Hz). The default value is 16000.

Generated using TypeDoc