HMSScreenAudioTrack

Hierarchy

• HMSAudioTrack

  ↳ HMSScreenAudioTrack

Properties

deviceID

• Optional deviceID: string

Inherited from

HMSAudioTrack.deviceID

displayEnabled

• Optional displayEnabled: boolean

Inherited from

HMSAudioTrack.displayEnabled

enabled

• enabled: boolean

Inherited from

HMSAudioTrack.enabled

id

• id: string

Inherited from

HMSAudioTrack.id

interrupted

• Optional interrupted: boolean

only applicable for local tracks - true while the OS or another app has taken the device, eg. an incoming call. Cleared once capture is back, however it came back.

Backgrounding the tab on mobile is not reported here: the device is handed back on return. It is set on return if the device did not come back.

Inherited from

HMSAudioTrack.interrupted

isPublished

• Optional isPublished: boolean

only applicable for local tracks - to denote if a track has been published or not false for preview tracks

Inherited from

HMSAudioTrack.isPublished

peerId

• Optional peerId: string

Inherited from

HMSAudioTrack.peerId

plugins

• Optional plugins: string[]

Inherited from

HMSAudioTrack.plugins

source

• source: "screen"

Overrides

HMSAudioTrack.source

type

• type: "audio"

Overrides

HMSAudioTrack.type

volume

• Optional volume: number

Inherited from

HMSAudioTrack.volume