PerformAudioPassThru (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.RPCMessage
  - - com.smartdevicelink.proxy.RPCRequest
    - - com.smartdevicelink.proxy.rpc.PerformAudioPassThru

All Implemented Interfaces:: Cloneable

public class PerformAudioPassThru
extends RPCRequest

This will open an audio pass thru session. By doing so the app can receive audio data through the vehicles microphone

Function Group: AudioPassThru

HMILevel needs to be FULL, LIMITED or BACKGROUND

Parameter List

Name	Type	Description	Reg.	Notes	Version
initialPrompt	TTSChunk[]	SDL will speak this prompt before opening the audio pass thru session.	N	This is an array of text chunks of type TTSChunk. The array must have at least one item If omitted, then no initial prompt is spoken: Array Minsize: 1 Array Maxsize: 100	SmartDeviceLink 2.0
audioPassThruDisplayText1	String	First line of text displayed during audio capture.	N	Maxlength = 500	SmartDeviceLink 2.0
samplingRate	SamplingRate	This value shall is allowed to be 8 or 16 or 22 or 44 khz.	Y		SmartDeviceLink 2.0
maxDuration	Integer	The maximum duration of audio recording in milliseconds.	Y	Minvalue: 1; Maxvalue: 1000000	SmartDeviceLink 2.0
bitsPerSample	BitsPerSample	Specifies the quality the audio is recorded - 8 bit or 16 bit.	Y		SmartDeviceLink 2.0
audioType	AudioType	Specifies the type of audio data being requested.	Y		SmartDeviceLink 2.0
muteAudio	Boolean	N	N		SmartDeviceLink 2.0

Since:: SmartDeviceLink 2.0
See Also:: EndAudioPassThru

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_1`
`static String`	`KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_2`
`static String`	`KEY_AUDIO_TYPE`
`static String`	`KEY_BITS_PER_SAMPLE`
`static String`	`KEY_INITIAL_PROMPT`
`static String`	`KEY_MAX_DURATION`
`static String`	`KEY_MUTE_AUDIO`
`static String`	`KEY_SAMPLING_RATE`

Fields inherited from class com.smartdevicelink.proxy.RPCRequest
onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage
function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct
KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors
Constructor and Description
`PerformAudioPassThru()` Constructs a new PerformAudioPassThru object
`PerformAudioPassThru(Hashtable<String,Object> hash)` Constructs a new PerformAudioPassThru object indicated by the Hashtable parameter
`PerformAudioPassThru(SamplingRate samplingRate, Integer maxDuration, BitsPerSample bitsPerSample, AudioType audioType)` Constructs a new PerformAudioPassThru object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAudioPassThruDisplayText1()` Gets a first line of text displayed during audio capture
`String`	`getAudioPassThruDisplayText2()` Gets a second line of text displayed during audio capture
`AudioType`	`getAudioType()` Gets a type of audio data
`BitsPerSample`	`getBitsPerSample()` Gets a BitsPerSample value, 8 bit or 16 bit
`List<TTSChunk>`	`getInitialPrompt()` Gets a List value representing an initial prompt which will be spoken before opening the audio pass thru session by SDL
`Integer`	`getMaxDuration()` Gets a max duration of audio recording in milliseconds
`Boolean`	`getMuteAudio()` Gets a Boolean value representing if the current audio source should be muted during the APT session
`SamplingRate`	`getSamplingRate()` Gets a samplingRate
`PerformAudioPassThru`	`setAudioPassThruDisplayText1(String audioPassThruDisplayText1)` Sets a line of text displayed during audio capture
`PerformAudioPassThru`	`setAudioPassThruDisplayText2(String audioPassThruDisplayText2)` Sets a line of text displayed during audio capture
`PerformAudioPassThru`	`setAudioType(AudioType audioType)` Sets an audioType
`PerformAudioPassThru`	`setBitsPerSample(BitsPerSample audioQuality)` Sets the quality the audio is recorded - 8 bit or 16 bit
`PerformAudioPassThru`	`setInitialPrompt(List<TTSChunk> initialPrompt)` Sets initial prompt which will be spoken before opening the audio pass thru session by SDL
`PerformAudioPassThru`	`setMaxDuration(Integer maxDuration)` Sets the maximum duration of audio recording in milliseconds
`PerformAudioPassThru`	`setMuteAudio(Boolean muteAudio)` Sets a muteAudio value representing if the current audio source should be muted during the APT session If not, the audio source will play without interruption.
`PerformAudioPassThru`	`setSamplingRate(SamplingRate samplingRate)` Sets a samplingRate

Methods inherited from class com.smartdevicelink.proxy.RPCRequest
getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage
getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct
clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_MAX_DURATION
```
public static final String KEY_MAX_DURATION
```
    See Also:
    
    Constant Field Values
  - KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_1
```
public static final String KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_1
```
    See Also:
    
    Constant Field Values
  - KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_2
```
public static final String KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_2
```
    See Also:
    
    Constant Field Values
  - KEY_MUTE_AUDIO
```
public static final String KEY_MUTE_AUDIO
```
    See Also:
    
    Constant Field Values
  - KEY_SAMPLING_RATE
```
public static final String KEY_SAMPLING_RATE
```
    See Also:
    
    Constant Field Values
  - KEY_AUDIO_TYPE
```
public static final String KEY_AUDIO_TYPE
```
    See Also:
    
    Constant Field Values
  - KEY_INITIAL_PROMPT
```
public static final String KEY_INITIAL_PROMPT
```
    See Also:
    
    Constant Field Values
  - KEY_BITS_PER_SAMPLE
```
public static final String KEY_BITS_PER_SAMPLE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PerformAudioPassThru
```
public PerformAudioPassThru()
```
    Constructs a new PerformAudioPassThru object
  - PerformAudioPassThru
```
public PerformAudioPassThru(Hashtable<String,Object> hash)
```
    Constructs a new PerformAudioPassThru object indicated by the Hashtable parameter
    
    Parameters:
    
    hash - The Hashtable to use
  - PerformAudioPassThru
```
public PerformAudioPassThru(@NonNull
                            SamplingRate samplingRate,
                            @NonNull
                            Integer maxDuration,
                            @NonNull
                            BitsPerSample bitsPerSample,
                            @NonNull
                            AudioType audioType)
```
    Constructs a new PerformAudioPassThru object
    
    Parameters:
    
    samplingRate - a SamplingRate value representing a 8 or 16 or 22 or 24 khz
    
    maxDuration - an Integer value representing the maximum duration of audio recording in millisecond Notes: Minvalue:1; Maxvalue:1000000
    
    bitsPerSample - a BitsPerSample value representing 8 bit or 16 bit
    
    audioType - an audioType
- Method Detail
  - setInitialPrompt
```
public PerformAudioPassThru setInitialPrompt(List<TTSChunk> initialPrompt)
```
    Sets initial prompt which will be spoken before opening the audio pass thru session by SDL
    Parameters:
    initialPrompt - a List value represents the initial prompt which will be spoken before opening the audio pass thru session by SDL
    Notes:
    
    This is an array of text chunks of type TTSChunk
    
    The array must have at least one item
    
    If omitted, then no initial prompt is spoken
    
    Array Minsize: 1
    
    Array Maxsize: 100
  - getInitialPrompt
```
public List<TTSChunk> getInitialPrompt()
```
    Gets a List value representing an initial prompt which will be spoken before opening the audio pass thru session by SDL
    
    Returns:
    
    List -a List value representing an initial prompt which will be spoken before opening the audio pass thru session by SDL
  - setAudioPassThruDisplayText1
```
public PerformAudioPassThru setAudioPassThruDisplayText1(String audioPassThruDisplayText1)
```
    Sets a line of text displayed during audio capture
    
    Parameters:
    
    audioPassThruDisplayText1 -
    a String value representing the line of text displayed during audio capture
    
    Notes: Maxlength=500
  - getAudioPassThruDisplayText1
```
public String getAudioPassThruDisplayText1()
```
    Gets a first line of text displayed during audio capture
    
    Returns:
    
    String -a String value representing a first line of text displayed during audio capture
  - setAudioPassThruDisplayText2
```
public PerformAudioPassThru setAudioPassThruDisplayText2(String audioPassThruDisplayText2)
```
    Sets a line of text displayed during audio capture
    
    Parameters:
    
    audioPassThruDisplayText2 -
    a String value representing the line of text displayed during audio capture
    
    Notes: Maxlength=500
  - getAudioPassThruDisplayText2
```
public String getAudioPassThruDisplayText2()
```
    Gets a second line of text displayed during audio capture
    
    Returns:
    
    String -a String value representing a first line of text displayed during audio capture
  - setSamplingRate
```
public PerformAudioPassThru setSamplingRate(@NonNull
                                            SamplingRate samplingRate)
```
    Sets a samplingRate
    
    Parameters:
    
    samplingRate - a SamplingRate value representing a 8 or 16 or 22 or 24 khz
  - getSamplingRate
```
public SamplingRate getSamplingRate()
```
    Gets a samplingRate
    
    Returns:
    
    SamplingRate -a SamplingRate value
  - setMaxDuration
```
public PerformAudioPassThru setMaxDuration(@NonNull
                                           Integer maxDuration)
```
    Sets the maximum duration of audio recording in milliseconds
    
    Parameters:
    
    maxDuration - an Integer value representing the maximum duration of audio recording in millisecond
    Notes: Minvalue:1; Maxvalue:1000000
  - getMaxDuration
```
public Integer getMaxDuration()
```
    Gets a max duration of audio recording in milliseconds
    
    Returns:
    
    int -an int value representing the maximum duration of audio recording in milliseconds
  - setBitsPerSample
```
public PerformAudioPassThru setBitsPerSample(@NonNull
                                             BitsPerSample audioQuality)
```
    Sets the quality the audio is recorded - 8 bit or 16 bit
    
    Parameters:
    
    audioQuality - a BitsPerSample value representing 8 bit or 16 bit
  - getBitsPerSample
```
public BitsPerSample getBitsPerSample()
```
    Gets a BitsPerSample value, 8 bit or 16 bit
    
    Returns:
    
    BitsPerSample -a BitsPerSample value
  - setAudioType
```
public PerformAudioPassThru setAudioType(@NonNull
                                         AudioType audioType)
```
    Sets an audioType
    
    Parameters:
    
    audioType - an audioType
  - getAudioType
```
public AudioType getAudioType()
```
    Gets a type of audio data
    
    Returns:
    
    AudioType -an AudioType
  - getMuteAudio
```
public Boolean getMuteAudio()
```
    Gets a Boolean value representing if the current audio source should be muted during the APT session
    
    Returns:
    
    Boolean -a Boolean value representing if the current audio source should be muted during the APT session
  - setMuteAudio
```
public PerformAudioPassThru setMuteAudio(Boolean muteAudio)
```
    Sets a muteAudio value representing 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
    
    Parameters:
    
    muteAudio - a Boolean value representing if the current audio source should be muted during the APT session

Class PerformAudioPassThru

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_MAX_DURATION

KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_1

KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_2

KEY_MUTE_AUDIO

KEY_SAMPLING_RATE

KEY_AUDIO_TYPE

KEY_INITIAL_PROMPT

KEY_BITS_PER_SAMPLE

Constructor Detail

PerformAudioPassThru

PerformAudioPassThru

PerformAudioPassThru

Method Detail

setInitialPrompt

getInitialPrompt

setAudioPassThruDisplayText1

getAudioPassThruDisplayText1

setAudioPassThruDisplayText2

getAudioPassThruDisplayText2

setSamplingRate

getSamplingRate

setMaxDuration

getMaxDuration

setBitsPerSample

getBitsPerSample

setAudioType

getAudioType

getMuteAudio

setMuteAudio