ISourceAudio
Defined in: core/source/iaudiosource.ts:10
Methods
Section titled “Methods”getAudioOffset()
Section titled “getAudioOffset()”getAudioOffset():
Promise<number>
Defined in: core/source/iaudiosource.ts:60
return: Promise
Gets audio delay (1 unit = 100ns)
Returns
Section titled “Returns”Promise<number>
getSilencePeriod()
Section titled “getSilencePeriod()”getSilencePeriod():
Promise<number>
Defined in: core/source/iaudiosource.ts:46
return: Promise
Gets silenced detection period in ms time unit. Reaction time before filter removes noice/sound less than threshold
Returns
Section titled “Returns”Promise<number>
getSilenceThreshold()
Section titled “getSilenceThreshold()”getSilenceThreshold():
Promise<number>
Defined in: core/source/iaudiosource.ts:31
return: Promise
Gets silenced detection threshold. Amplitude less than threshold will be detected as silence.
Returns
Section titled “Returns”Promise<number>
getValue()
Section titled “getValue()”getValue():
Promise<string|XML>
Defined in: core/source/iaudiosource.ts:83
return: Promise
Gets the microphone device used as a source
source.getValue().then(function(value) { // Do something with the value});Returns
Section titled “Returns”Promise<string | XML>
isSilenceDetectionEnabled()
Section titled “isSilenceDetectionEnabled()”isSilenceDetectionEnabled():
Promise<boolean>
Defined in: core/source/iaudiosource.ts:16
return: Promise
Check if silence detection is on or off
Returns
Section titled “Returns”Promise<boolean>
setAudioOffset()
Section titled “setAudioOffset()”setAudioOffset(
value):Promise<ISourceAudio>
Defined in: core/source/iaudiosource.ts:67
param: (value: number)
Sets audio delay, accepts only positive delay
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ISourceAudio>
setSilenceDetectionEnabled()
Section titled “setSilenceDetectionEnabled()”setSilenceDetectionEnabled(
value):Promise<ISourceAudio>
Defined in: core/source/iaudiosource.ts:23
param: (value: boolean)
Set silence detection to ON or OFF
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceAudio>
setSilencePeriod()
Section titled “setSilencePeriod()”setSilencePeriod(
value):Promise<ISourceAudio>
Defined in: core/source/iaudiosource.ts:53
param: (value: number)
Sets silence detection period, min of 0, max of 10000
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ISourceAudio>
setSilenceThreshold()
Section titled “setSilenceThreshold()”setSilenceThreshold(
value):Promise<ISourceAudio>
Defined in: core/source/iaudiosource.ts:38
param: (value: number)
Sets silence detection threshold, min of 0, max of 128
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ISourceAudio>
setValue()
Section titled “setValue()”setValue(
value):Promise<any>
Defined in: core/source/iaudiosource.ts:102
param: (value: string)
return: Promise<AudioSource>Set the microphone device to be used as source
source.setValue('<microphone device>') .then(function(source) { // Promise resolves with same Source instance});Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<any>