Audio
Defined in: core/source/iaudio.ts:80
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Audio():
Audio
Returns
Section titled “Returns”Audio
Methods
Section titled “Methods”getVolume()
Section titled “getVolume()”getVolume():
Promise<number>
Defined in: core/source/iaudio.ts:92
return: Promise
Get source’s volume level expressed as an integer from 0 to 100
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”isAudioAvailable()
Section titled “isAudioAvailable()”isAudioAvailable():
Promise<boolean>
Defined in: core/source/iaudio.ts:249
return: Promise
Checks if audio is available
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isAutoMute()
Section titled “isAutoMute()”isAutoMute():
Promise<boolean>
Defined in: core/source/iaudio.ts:171
return: Promise
Check if source is automatically being muted when hiding
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isMute()
Section titled “isMute()”isMute():
Promise<boolean>
Defined in: core/source/iaudio.ts:132
return: Promise
Check if source’s mute option is active
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isStreamOnlyAudio()
Section titled “isStreamOnlyAudio()”isStreamOnlyAudio():
Promise<boolean>
Defined in: core/source/iaudio.ts:210
return: Promise
Checks if audio is also output to system sound
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”setAutoMute()
Section titled “setAutoMute()”setAutoMute(
value):Promise<Audio>
Defined in: core/source/iaudio.ts:190
param: (value: boolean)
Set source to automatically mute when hiding
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<Audio>
Implementation of
Section titled “Implementation of”setMute()
Section titled “setMute()”setMute(
value):Promise<Audio>
Defined in: core/source/iaudio.ts:151
param: (value: boolean)
Set source’s Mute property to ON or OFF
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<Audio>
Implementation of
Section titled “Implementation of”setStreamOnlyAudio()
Section titled “setStreamOnlyAudio()”setStreamOnlyAudio(
value):Promise<Audio>
Defined in: core/source/iaudio.ts:229
param: (value: boolean)
Sets whether audio should also be output to system sound
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<Audio>
Implementation of
Section titled “Implementation of”setVolume()
Section titled “setVolume()”setVolume(
value):Promise<Audio>
Defined in: core/source/iaudio.ts:111
param: (value: number)
Set volume level of source as an integer from 0 (muted) to 100 (maximum)
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<Audio>