PerformAudioPassThru Class Reference
Constructors
Instance Methods
- getAudioPassThruDisplayText1() ⇒
String - getAudioPassThruDisplayText2() ⇒
String - getAudioType() ⇒
AudioType - getBitsPerSample() ⇒
BitsPerSample - getInitialPrompt() ⇒
Array.<TTSChunk> - getMaxDuration() ⇒
Number - getMuteAudio() ⇒
Boolean - getSamplingRate() ⇒
SamplingRate - setAudioPassThruDisplayText1(text1) ⇒
PerformAudioPassThru - setAudioPassThruDisplayText2(text2) ⇒
PerformAudioPassThru - setAudioType(type) ⇒
PerformAudioPassThru - setBitsPerSample(sample) ⇒
PerformAudioPassThru - setInitialPrompt(prompt) ⇒
PerformAudioPassThru - setMaxDuration(duration) ⇒
PerformAudioPassThru - setMuteAudio(audio) ⇒
PerformAudioPassThru - setSamplingRate(rate) ⇒
PerformAudioPassThru
Instance Methods
performAudioPassThru.getAudioPassThruDisplayText1() ⇒ String
Get the AudioPassThruDisplayText1
Kind: Instance method of PerformAudioPassThru
Returns: String - the KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_1 value
performAudioPassThru.getAudioPassThruDisplayText2() ⇒ String
Get the AudioPassThruDisplayText2
Kind: Instance method of PerformAudioPassThru
Returns: String - the KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_2 value
performAudioPassThru.getAudioType() ⇒ AudioType
Get the AudioType
Kind: Instance method of PerformAudioPassThru
Returns: AudioType - the KEY_AUDIO_TYPE value
performAudioPassThru.getBitsPerSample() ⇒ BitsPerSample
Get the BitsPerSample
Kind: Instance method of PerformAudioPassThru
Returns: BitsPerSample - the KEY_BITS_PER_SAMPLE value
performAudioPassThru.getInitialPrompt() ⇒ Array.<TTSChunk>
Get the InitialPrompt
Kind: Instance method of PerformAudioPassThru
Returns: Array.<TTSChunk> - the KEY_INITIAL_PROMPT value
performAudioPassThru.getMaxDuration() ⇒ Number
Get the MaxDuration
Kind: Instance method of PerformAudioPassThru
Returns: Number - the KEY_MAX_DURATION value
performAudioPassThru.getMuteAudio() ⇒ Boolean
Get the MuteAudio
Kind: Instance method of PerformAudioPassThru
Returns: Boolean - the KEY_MUTE_AUDIO value
performAudioPassThru.getSamplingRate() ⇒ SamplingRate
Get the SamplingRate
Kind: Instance method of PerformAudioPassThru
Returns: SamplingRate - the KEY_SAMPLING_RATE value
performAudioPassThru.setAudioPassThruDisplayText1(text1) ⇒ PerformAudioPassThru
Set the AudioPassThruDisplayText1
Kind: Instance method of PerformAudioPassThru
Returns: PerformAudioPassThru - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| text1 | String |
First line of text displayed during audio capture. - The desired AudioPassThruDisplayText1. {'string_min_length': 1, 'string_max_length': 500} |
performAudioPassThru.setAudioPassThruDisplayText2(text2) ⇒ PerformAudioPassThru
Set the AudioPassThruDisplayText2
Kind: Instance method of PerformAudioPassThru
Returns: PerformAudioPassThru - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| text2 | String |
Second line of text displayed during audio capture. - The desired AudioPassThruDisplayText2. {'string_min_length': 1, 'string_max_length': 500} |
performAudioPassThru.setAudioType(type) ⇒ PerformAudioPassThru
Set the AudioType
Kind: Instance method of PerformAudioPassThru
Returns: PerformAudioPassThru - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| type | AudioType |
Specifies the type of audio data being requested. - The desired AudioType. |
performAudioPassThru.setBitsPerSample(sample) ⇒ PerformAudioPassThru
Set the BitsPerSample
Kind: Instance method of PerformAudioPassThru
Returns: PerformAudioPassThru - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| sample | BitsPerSample |
Specifies the quality the audio is recorded. Currently 8 bit or 16 bit. - The desired BitsPerSample. |
performAudioPassThru.setInitialPrompt(prompt) ⇒ PerformAudioPassThru
Set the InitialPrompt
Kind: Instance method of PerformAudioPassThru
Returns: PerformAudioPassThru - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| prompt | Array.<TTSChunk> |
The module will speak this prompt before opening the audio pass thru session. An array of text chunks of type TTSChunk. See TTSChunk. The array must have at least one item. If omitted, then no initial prompt is spoken. - The desired InitialPrompt. {'array_min_size': 1, 'array_max_size': 100} |
performAudioPassThru.setMaxDuration(duration) ⇒ PerformAudioPassThru
Set the MaxDuration
Kind: Instance method of PerformAudioPassThru
Returns: PerformAudioPassThru - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| duration | Number |
The maximum duration of audio recording in milliseconds. - The desired MaxDuration. {'num_min_value': 1, 'num_max_value': 1000000} |
performAudioPassThru.setMuteAudio(audio) ⇒ PerformAudioPassThru
Set the MuteAudio
Kind: Instance method of PerformAudioPassThru
Returns: PerformAudioPassThru - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| audio | Boolean |
Defines if the current audio source should be muted during the APT session. If not, the audio source will play without interruption. If omitted, the value is set to true. - The desired MuteAudio. |
performAudioPassThru.setSamplingRate(rate) ⇒ PerformAudioPassThru
Set the SamplingRate
Kind: Instance method of PerformAudioPassThru
Returns: PerformAudioPassThru - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| rate | SamplingRate |
This value shall be allowed at 8 kHz or 16 or 22 or 44 kHz. - The desired SamplingRate. |