com.smartdevicelink.proxy.rpc

Class AudioPassThruCapabilities

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.AudioPassThruCapabilities

All Implemented Interfaces:

Cloneable

public class AudioPassThruCapabilities
extends RPCStruct

Describes different audio type configurations for PerformAudioPassThru, e.g. {8kHz,8-bit,PCM} Specifies the capabilities of audio capturing: sampling rate, bits per sample, audio type.

Parameter List

Name	Type	Description	SmartDeviceLink Ver. Available
samplingRate	SamplingRate	Describes the sampling rate for AudioPassThru	SmartDeviceLink 2.0
bitsPerSample	BitsPerSample	Describes the sample depth in bit for AudioPassThru	SmartDeviceLink 2.0
audioType	AudioType	Describes the audioType for AudioPassThru	SmartDeviceLink 2.0

Since:

SmartDeviceLink 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_AUDIO_TYPE
static String	KEY_BITS_PER_SAMPLE
static String	KEY_SAMPLING_RATE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
AudioPassThruCapabilities() Constructs a newly allocated AudioPassThruCapabilities object
AudioPassThruCapabilities(Hashtable<String,Object> hash) Constructs a newly allocated AudioPassThruCapabilities object indicated by the Hashtable parameter
AudioPassThruCapabilities(SamplingRate samplingRate, BitsPerSample bitsPerSample, AudioType audioType) Constructs a newly allocated AudioPassThruCapabilities object

Method Summary

Modifier and Type	Method and Description
AudioType	getAudioType() get the audioType for AudioPassThru
BitsPerSample	getBitsPerSample() get the sample depth in bit for AudioPassThru
SamplingRate	getSamplingRate() get the sampling rate for AudioPassThru
AudioPassThruCapabilities	setAudioType(AudioType audioType) set the audioType for AudioPassThru
AudioPassThruCapabilities	setBitsPerSample(BitsPerSample bitsPerSample) set the sample depth in bit for AudioPassThru
AudioPassThruCapabilities	setSamplingRate(SamplingRate samplingRate) set the sampling rate for AudioPassThru

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, 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_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_BITS_PER_SAMPLE

public static final String KEY_BITS_PER_SAMPLE

See Also:

Constant Field Values

Constructor Detail

AudioPassThruCapabilities

public AudioPassThruCapabilities()

Constructs a newly allocated AudioPassThruCapabilities object

AudioPassThruCapabilities

public AudioPassThruCapabilities(Hashtable<String,Object> hash)

Constructs a newly allocated AudioPassThruCapabilities object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

AudioPassThruCapabilities

public AudioPassThruCapabilities(@NonNull
                                 SamplingRate samplingRate,
                                 @NonNull
                                 BitsPerSample bitsPerSample,
                                 @NonNull
                                 AudioType audioType)

Constructs a newly allocated AudioPassThruCapabilities object

Parameters:

samplingRate - the sampling rate for AudioPassThru

bitsPerSample - the sample depth in bit for AudioPassThru

audioType - the audioType for AudioPassThru

Method Detail

setSamplingRate

public AudioPassThruCapabilities setSamplingRate(@NonNull
                                                 SamplingRate samplingRate)

set the sampling rate for AudioPassThru

Parameters:

samplingRate - the sampling rate for AudioPassThru

getSamplingRate

public SamplingRate getSamplingRate()

get the sampling rate for AudioPassThru

Returns:

the sampling rate for AudioPassThru

setBitsPerSample

public AudioPassThruCapabilities setBitsPerSample(@NonNull
                                                  BitsPerSample bitsPerSample)

set the sample depth in bit for AudioPassThru

Parameters:

bitsPerSample - the sample depth in bit for AudioPassThru

getBitsPerSample

public BitsPerSample getBitsPerSample()

get the sample depth in bit for AudioPassThru

Returns:

the sample depth in bit for AudioPassThru

setAudioType

public AudioPassThruCapabilities setAudioType(@NonNull
                                              AudioType audioType)

set the audioType for AudioPassThru

Parameters:

audioType - the audioType for AudioPassThru

getAudioType

public AudioType getAudioType()

get the audioType for AudioPassThru

Returns:

the audioType for AudioPassThru