Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class SdlProxyBase

Hierarchy

java.lang.Object

Package
com.smartdevicelink.proxy
All Known Subclasses
com.smartdevicelink.proxy.SdlProxyALM

Quick Jump

Fields
Constructors
Methods

Fields

TAG

public static final java.lang.String TAG
Constant Value
"SdlProxy"

MAX_SUPPORTED_RPC_VERSION

public static final com.smartdevicelink.util.Version MAX_SUPPORTED_RPC_VERSION

_appService

protected android.app.Service _appService

_advancedLifecycleManagementEnabled

protected java.lang.Boolean _advancedLifecycleManagementEnabled

_appInterfaceRegisterd

protected java.lang.Boolean _appInterfaceRegisterd

_preRegisterd

protected java.lang.Boolean _preRegisterd

_haveReceivedFirstFocusLevel

protected java.lang.Boolean _haveReceivedFirstFocusLevel

_haveReceivedFirstFocusLevelFull

protected java.lang.Boolean _haveReceivedFirstFocusLevelFull

_proxyDisposed

protected java.lang.Boolean _proxyDisposed

_sdlConnectionState

protected com.smartdevicelink.proxy.rpc.enums.SdlConnectionState _sdlConnectionState

_sdlIntefaceAvailablity

protected com.smartdevicelink.proxy.rpc.enums.SdlInterfaceAvailability _sdlIntefaceAvailablity

_hmiLevel

protected com.smartdevicelink.proxy.rpc.enums.HMILevel _hmiLevel

_audioStreamingState

protected com.smartdevicelink.proxy.rpc.enums.AudioStreamingState _audioStreamingState

_sdlMsgVersion

protected com.smartdevicelink.proxy.rpc.SdlMsgVersion _sdlMsgVersion

_autoActivateIdReturned

protected java.lang.String _autoActivateIdReturned

_sdlLanguage

protected com.smartdevicelink.proxy.rpc.enums.Language _sdlLanguage

_hmiDisplayLanguage

protected com.smartdevicelink.proxy.rpc.enums.Language _hmiDisplayLanguage

_prerecordedSpeech

protected java.util.List _prerecordedSpeech

_vehicleType

protected com.smartdevicelink.proxy.rpc.VehicleType _vehicleType

_systemSoftwareVersion

protected java.lang.String _systemSoftwareVersion

_diagModes

protected java.util.List _diagModes

firstTimeFull

protected java.lang.Boolean firstTimeFull

_proxyVersionInfo

protected java.lang.String _proxyVersionInfo

_bResumeSuccess

protected java.lang.Boolean _bResumeSuccess

_secList

protected java.util.List _secList

_systemCapabilityManager

protected com.smartdevicelink.proxy.SystemCapabilityManager _systemCapabilityManager

_iconResumed

protected java.lang.Boolean _iconResumed

protocolVersion

protected com.smartdevicelink.util.Version protocolVersion

rpcSpecVersion

protected com.smartdevicelink.util.Version rpcSpecVersion

rpcResponseListeners

protected android.util.SparseArray rpcResponseListeners

rpcNotificationListeners

protected android.util.SparseArray rpcNotificationListeners

manager

protected com.smartdevicelink.proxy.SdlProxyBase.VideoStreamingManager manager

Constructors

SdlProxyBase( proxyListenerType listener, Context context, String appName, String shortAppName, Boolean isMediaApp, Language languageDesired, Language hmiDisplayLanguageDesired, java.util.Vector<com.smartdevicelink.proxy.rpc.enums.AppHMIType> appType, String appID, BaseTransportConfig transportConfig, java.util.Vector<java.lang.String> vrSynonyms, java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName, TemplateColorScheme dayColorScheme, TemplateColorScheme nightColorScheme )

Used by the SdlManager

public SdlProxyBase(proxyListenerType listener,Context context,String appName,String shortAppName,Boolean isMediaApp,Language languageDesired,Language hmiDisplayLanguageDesired,java.util.Vector<com.smartdevicelink.proxy.rpc.enums.AppHMIType> appType,String appID,BaseTransportConfig transportConfig,java.util.Vector<java.lang.String> vrSynonyms,java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName,TemplateColorScheme dayColorScheme,TemplateColorScheme nightColorScheme)

Parameters

listener
Type of listener for this proxy base.
context
Application context.
appName
Client application name.
shortAppName
Client short application name.
isMediaApp
Flag that indicates that client application if media application or not.
languageDesired
Desired language.
hmiDisplayLanguageDesired
Desired language for HMI.
appType
Type of application.
appID
Application identifier.
transportConfig
Configuration of transport to be used by underlying connection.
vrSynonyms
List of synonyms.
ttsName
TTS name.
dayColorScheme
TemplateColorScheme for the day
nightColorScheme
TemplateColorScheme for the night

SdlProxyBase( proxyListenerType listener, SdlProxyConfigurationResources sdlProxyConfigurationResources, boolean enableAdvancedLifecycleManagement, String appName, java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName, String ngnMediaScreenAppName, java.util.Vector<java.lang.String> vrSynonyms, Boolean isMediaApp, SdlMsgVersion sdlMsgVersion, Language languageDesired, Language hmiDisplayLanguageDesired, java.util.Vector<com.smartdevicelink.proxy.rpc.enums.AppHMIType> appType, String appID, String autoActivateID, boolean callbackToUIThread, BaseTransportConfig transportConfig )

Constructor.

protected SdlProxyBase(proxyListenerType listener,SdlProxyConfigurationResources sdlProxyConfigurationResources,boolean enableAdvancedLifecycleManagement,String appName,java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName,String ngnMediaScreenAppName,java.util.Vector<java.lang.String> vrSynonyms,Boolean isMediaApp,SdlMsgVersion sdlMsgVersion,Language languageDesired,Language hmiDisplayLanguageDesired,java.util.Vector<com.smartdevicelink.proxy.rpc.enums.AppHMIType> appType,String appID,String autoActivateID,boolean callbackToUIThread,BaseTransportConfig transportConfig)

Parameters

listener
Type of listener for this proxy base.
sdlProxyConfigurationResources
Configuration resources for this proxy.
enableAdvancedLifecycleManagement
Flag that ALM should be enabled or not.
appName
Client application name.
ttsName
TTS name.
ngnMediaScreenAppName
Media Screen Application name.
vrSynonyms
List of synonyms.
isMediaApp
Flag that indicates that client application if media application or not.
sdlMsgVersion
Version of Sdl Message.
languageDesired
Desired language.
hmiDisplayLanguageDesired
Desired language for HMI.
appType
Type of application.
appID
Application identifier.
autoActivateID
Auto activation identifier.
callbackToUIThread
Flag that indicates that this proxy should send callback to UI thread or not.
transportConfig
Configuration of transport to be used by underlying connection.

SdlProxyBase( proxyListenerType listener, SdlProxyConfigurationResources sdlProxyConfigurationResources, boolean enableAdvancedLifecycleManagement, String appName, java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName, String ngnMediaScreenAppName, java.util.Vector<java.lang.String> vrSynonyms, Boolean isMediaApp, SdlMsgVersion sdlMsgVersion, Language languageDesired, Language hmiDisplayLanguageDesired, java.util.Vector<com.smartdevicelink.proxy.rpc.enums.AppHMIType> appType, String appID, String autoActivateID, TemplateColorScheme dayColorScheme, TemplateColorScheme nightColorScheme, boolean callbackToUIThread, boolean preRegister, String sHashID, Boolean bEnableResume, BaseTransportConfig transportConfig )

protected SdlProxyBase(proxyListenerType listener,SdlProxyConfigurationResources sdlProxyConfigurationResources,boolean enableAdvancedLifecycleManagement,String appName,java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName,String ngnMediaScreenAppName,java.util.Vector<java.lang.String> vrSynonyms,Boolean isMediaApp,SdlMsgVersion sdlMsgVersion,Language languageDesired,Language hmiDisplayLanguageDesired,java.util.Vector<com.smartdevicelink.proxy.rpc.enums.AppHMIType> appType,String appID,String autoActivateID,TemplateColorScheme dayColorScheme,TemplateColorScheme nightColorScheme,boolean callbackToUIThread,boolean preRegister,String sHashID,Boolean bEnableResume,BaseTransportConfig transportConfig)

Parameters

listener
sdlProxyConfigurationResources
enableAdvancedLifecycleManagement
appName
ttsName
ngnMediaScreenAppName
vrSynonyms
isMediaApp
sdlMsgVersion
languageDesired
hmiDisplayLanguageDesired
appType
appID
autoActivateID
dayColorScheme
nightColorScheme
callbackToUIThread
preRegister
sHashID
bEnableResume
transportConfig

SdlProxyBase( proxyListenerType listener, SdlProxyConfigurationResources sdlProxyConfigurationResources, boolean enableAdvancedLifecycleManagement, String appName, java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName, String ngnMediaScreenAppName, java.util.Vector<java.lang.String> vrSynonyms, Boolean isMediaApp, SdlMsgVersion sdlMsgVersion, Language languageDesired, Language hmiDisplayLanguageDesired, java.util.Vector<com.smartdevicelink.proxy.rpc.enums.AppHMIType> appType, String appID, String autoActivateID, boolean callbackToUIThread, boolean preRegister, BaseTransportConfig transportConfig )

Constructor.

protected SdlProxyBase(proxyListenerType listener,SdlProxyConfigurationResources sdlProxyConfigurationResources,boolean enableAdvancedLifecycleManagement,String appName,java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName,String ngnMediaScreenAppName,java.util.Vector<java.lang.String> vrSynonyms,Boolean isMediaApp,SdlMsgVersion sdlMsgVersion,Language languageDesired,Language hmiDisplayLanguageDesired,java.util.Vector<com.smartdevicelink.proxy.rpc.enums.AppHMIType> appType,String appID,String autoActivateID,boolean callbackToUIThread,boolean preRegister,BaseTransportConfig transportConfig)

Parameters

listener
Type of listener for this proxy base.
sdlProxyConfigurationResources
Configuration resources for this proxy.
enableAdvancedLifecycleManagement
Flag that ALM should be enabled or not.
appName
Client application name.
ttsName
TTS name.
ngnMediaScreenAppName
Media Screen Application name.
vrSynonyms
List of synonyms.
isMediaApp
Flag that indicates that client application if media application or not.
sdlMsgVersion
Version of Sdl Message.
languageDesired
Desired language.
hmiDisplayLanguageDesired
Desired language for HMI.
appType
Type of application.
appID
Application identifier.
autoActivateID
Auto activation identifier.
callbackToUIThread
Flag that indicates that this proxy should send callback to UI thread or not.
preRegister
Flag that indicates that this proxy should be pre-registerd or not.
transportConfig
Configuration of transport to be used by underlying connection.

SdlProxyBase( proxyListenerType listener, SdlProxyConfigurationResources sdlProxyConfigurationResources, boolean enableAdvancedLifecycleManagement, String appName, java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName, String ngnMediaScreenAppName, java.util.Vector<java.lang.String> vrSynonyms, Boolean isMediaApp, SdlMsgVersion sdlMsgVersion, Language languageDesired, Language hmiDisplayLanguageDesired, java.util.Vector<com.smartdevicelink.proxy.rpc.enums.AppHMIType> appType, String appID, String autoActivateID, TemplateColorScheme dayColorScheme, TemplateColorScheme nightColorScheme, boolean callbackToUIThread, boolean preRegister, BaseTransportConfig transportConfig )

Constructor.

protected SdlProxyBase(proxyListenerType listener,SdlProxyConfigurationResources sdlProxyConfigurationResources,boolean enableAdvancedLifecycleManagement,String appName,java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName,String ngnMediaScreenAppName,java.util.Vector<java.lang.String> vrSynonyms,Boolean isMediaApp,SdlMsgVersion sdlMsgVersion,Language languageDesired,Language hmiDisplayLanguageDesired,java.util.Vector<com.smartdevicelink.proxy.rpc.enums.AppHMIType> appType,String appID,String autoActivateID,TemplateColorScheme dayColorScheme,TemplateColorScheme nightColorScheme,boolean callbackToUIThread,boolean preRegister,BaseTransportConfig transportConfig)

Parameters

listener
Type of listener for this proxy base.
sdlProxyConfigurationResources
Configuration resources for this proxy.
enableAdvancedLifecycleManagement
Flag that ALM should be enabled or not.
appName
Client application name.
ttsName
TTS name.
ngnMediaScreenAppName
Media Screen Application name.
vrSynonyms
List of synonyms.
isMediaApp
Flag that indicates that client application if media application or not.
sdlMsgVersion
Version of Sdl Message.
languageDesired
Desired language.
hmiDisplayLanguageDesired
Desired language for HMI.
appType
Type of application.
appID
Application identifier.
autoActivateID
Auto activation identifier.
dayColorScheme
Day color scheme.
nightColorScheme
callbackToUIThread
Flag that indicates that this proxy should send callback to UI thread or not.
preRegister
Flag that indicates that this proxy should be pre-registerd or not.
transportConfig
Configuration of transport to be used by underlying connection.

Methods

addPutFileResponseListener( IPutFileResponseListener _putFileListener )

public void addPutFileResponseListener(IPutFileResponseListener _putFileListener)

Parameters

_putFileListener

remPutFileResponseListener( IPutFileResponseListener _putFileListener )

public void remPutFileResponseListener(IPutFileResponseListener _putFileListener)

Parameters

_putFileListener

getIsConnected()

public java.lang.Boolean getIsConnected()

getAppInterfaceRegistered()

Returns whether the application is registered in SDL. Note: for testing purposes, it's possible that the connection is established, but the application is not registered.

public java.lang.Boolean getAppInterfaceRegistered()

initializeProxy()

public void initializeProxy() throws com.smartdevicelink.exception.SdlException

Throws

forceOnConnected()

This method will fake the multiplex connection event

public void forceOnConnected()

sendTransportBroadcast()

public void sendTransportBroadcast()

enableSiphonDebug()

Public method to enable the siphon transport

public void enableSiphonDebug()

disableSiphonDebug()

Public method to disable the Siphon Trace Server

public void disableSiphonDebug()

enableDebugTool()

Public method to enable the Debug Tool

public static void enableDebugTool()

disableDebugTool()

Public method to disable the Debug Tool

public static void disableDebugTool()

isDebugEnabled()

Public method to determine Debug Tool enabled

public static boolean isDebugEnabled()

isAudioStreamTransportAvailable()

Check to see if it a transport is available to perform audio streaming.
NOTE: This is only for the audio streaming service, not regular streaming of media playback.

public boolean isAudioStreamTransportAvailable()

isVideoStreamTransportAvailable()

Check to see if it a transport is available to perform video streaming.

public boolean isVideoStreamTransportAvailable()

close()

Deprecated

public void close() throws com.smartdevicelink.exception.SdlException

Throws

dispose()

Terminates the App's Interface Registration, closes the transport connection, ends the protocol session, and frees any resources used by the proxy.

public void dispose() throws com.smartdevicelink.exception.SdlException

Throws

cycleProxy( SdlDisconnectedReason disconnectedReason )

protected void cycleProxy(SdlDisconnectedReason disconnectedReason)

Parameters

disconnectedReason

getProtocolVersion()

Get the SDL protocol spec version being used

public com.smartdevicelink.util.Version getProtocolVersion()

serializeJSON( RPCMessage msg )

public java.lang.String serializeJSON(RPCMessage msg)

Parameters

msg

onPacketProgress( int correlationId, long bytesWritten, long totalSize )

Only call this method for a PutFile response. It will cause a class cast exception if not.

public void onPacketProgress(int correlationId,long bytesWritten,long totalSize)

Parameters

correlationId
correlation id of the packet being updated
bytesWritten
how many bytes were written
totalSize
the total size in bytes

addOnRPCResponseListener( OnRPCResponseListener listener, int correlationId, int totalSize )

Add a listener that will receive the response to the specific RPCRequest sent with the corresponding correlation id

public void addOnRPCResponseListener(OnRPCResponseListener listener,int correlationId,int totalSize)

Parameters

listener
that will get called back when a response is received
correlationId
of the RPCRequest that was sent
totalSize
only include if this is an OnPutFileUpdateListener. Otherwise it will be ignored.

getResponseListeners()

public android.util.SparseArray getResponseListeners()

onRPCNotificationReceived( RPCNotification notification )

public boolean onRPCNotificationReceived(RPCNotification notification)

Parameters

notification

addOnRPCNotificationListener( FunctionID notificationId, OnRPCNotificationListener listener )

This will ad a listener for the specific type of notification. As of now it will only allow a single listener per notification function id

public void addOnRPCNotificationListener(FunctionID notificationId,OnRPCNotificationListener listener)

Parameters

notificationId
The notification type that this listener is designated for
listener
The listener that will be called when a notification of the provided type is received

removeOnRPCNotificationListener( FunctionID notificationId )

Deprecated
This method is no longer valid and will not remove the listener for the supplied notificaiton id

public void removeOnRPCNotificationListener(FunctionID notificationId)

Parameters

notificationId
n/a

removeOnRPCNotificationListener( FunctionID notificationId, OnRPCNotificationListener listener )

public boolean removeOnRPCNotificationListener(FunctionID notificationId,OnRPCNotificationListener listener)

Parameters

notificationId
listener

getSdlMsgVersion()

Get SDL Message Version

public com.smartdevicelink.proxy.rpc.SdlMsgVersion getSdlMsgVersion() throws com.smartdevicelink.exception.SdlException

Throws

sendSequentialRequests( java.util.List<? extends com.smartdevicelink.proxy.RPCRequest> rpcs, OnMultipleRequestListener listener )

Takes a list of RPCRequests and sends it to SDL in a synchronous fashion. Responses are captured through callback on OnMultipleRequestListener. For sending requests asynchronously, use sendRequests
NOTE: This will override any listeners on individual RPCs

public void sendSequentialRequests(java.util.List<? extends com.smartdevicelink.proxy.RPCRequest> rpcs,OnMultipleRequestListener listener) throws com.smartdevicelink.exception.SdlException

Parameters

rpcs
is the list of RPCRequests being sent
listener
listener for updates and completions

Throws

sendRequests( java.util.List<? extends com.smartdevicelink.proxy.RPCRequest> rpcs, OnMultipleRequestListener listener )

Takes a list of RPCRequests and sends it to SDL. Responses are captured through callback on OnMultipleRequestListener. For sending requests synchronously, use sendSequentialRequests
NOTE: This will override any listeners on individual RPCs

public void sendRequests(java.util.List<? extends com.smartdevicelink.proxy.RPCRequest> rpcs,OnMultipleRequestListener listener) throws com.smartdevicelink.exception.SdlException

Parameters

rpcs
is the list of RPCRequests being sent
listener
listener for updates and completions

Throws

sendRPCRequest( RPCRequest request )

Takes an RPCRequest and sends it to SDL. Responses are captured through callback on IProxyListener.

public void sendRPCRequest(RPCRequest request) throws com.smartdevicelink.exception.SdlException

Parameters

request
is the RPCRequest being sent

Throws

notifyProxyClosed( String info, Exception e, SdlDisconnectedReason reason )

protected void notifyProxyClosed(String info,Exception e,SdlDisconnectedReason reason)

Parameters

info
e
reason

startRPCStream( InputStream is, RPCRequest msg )

public boolean startRPCStream(InputStream is,RPCRequest msg)

Parameters

is
msg

startRPCStream( RPCRequest msg )

public java.io.OutputStream startRPCStream(RPCRequest msg)

Parameters

msg

endRPCStream()

public void endRPCStream()

createFutureTask( com.smartdevicelink.proxy.SdlProxyBase<proxyListenerType>.CallableMethod callMethod )

public java.util.concurrent.FutureTask createFutureTask(com.smartdevicelink.proxy.SdlProxyBase<proxyListenerType>.CallableMethod callMethod)

Parameters

callMethod

createScheduler()

public java.util.concurrent.ScheduledExecutorService createScheduler()

startService( SessionType serviceType, boolean isEncrypted )

public void startService(SessionType serviceType,boolean isEncrypted)

Parameters

serviceType
isEncrypted

endService( SessionType serviceType )

public void endService(SessionType serviceType)

Parameters

serviceType

startH264( InputStream is, boolean isEncrypted )

Deprecated

public boolean startH264(InputStream is,boolean isEncrypted)

Parameters

is
isEncrypted

startH264( boolean isEncrypted )

Deprecated

public java.io.OutputStream startH264(boolean isEncrypted)

Parameters

isEncrypted

endH264()

Deprecated
Closes the opened video service (serviceType 11)

public boolean endH264()

pausePCM()

Deprecated
Pauses the stream for the opened audio service (serviceType 10)

public boolean pausePCM()

pauseH264()

Deprecated
Pauses the stream for the opened video service (serviceType 11)

public boolean pauseH264()

resumePCM()

Deprecated
Resumes the stream for the opened audio service (serviceType 10)

public boolean resumePCM()

resumeH264()

Deprecated
Resumes the stream for the opened video service (serviceType 11)

public boolean resumeH264()

startPCM( InputStream is, boolean isEncrypted )

Deprecated
Opens the audio service (serviceType 10) and subsequently streams raw PCM audio from an InputStream provided by the app

public boolean startPCM(InputStream is,boolean isEncrypted)

Parameters

is
isEncrypted

startPCM( boolean isEncrypted )

Deprecated
Opens the audio service (serviceType 10) and subsequently provides an OutputStream to the app

public java.io.OutputStream startPCM(boolean isEncrypted)

Parameters

isEncrypted

endPCM()

Deprecated
Closes the opened audio service (serviceType 10)

public boolean endPCM()

startVideoStream( boolean isEncrypted, VideoStreamingParameters parameters )

Opens a video service (service type 11) and subsequently provides an IVideoStreamListener to the app to send video data. The supplied VideoStreamingParameters will be set as desired paramaters that will be used to negotiate

public com.smartdevicelink.proxy.interfaces.IVideoStreamListener startVideoStream(boolean isEncrypted,VideoStreamingParameters parameters)

Parameters

isEncrypted
Specify true if packets on this service have to be encrypted
parameters
Video streaming parameters including: codec which will be used for streaming (currently, only VideoStreamingCodec.H264 is accepted), height and width of the video in pixels.

endVideoStream()

Closes the opened video service (serviceType 11)

public boolean endVideoStream()

pauseVideoStream()

Pauses the stream for the opened video service (serviceType 11)

public boolean pauseVideoStream()

resumeVideoStream()

Resumes the stream for the opened video service (serviceType 11)

public boolean resumeVideoStream()

createOpenGLInputSurface( int frameRate, int iFrameInterval, int width, int height, int bitrate, boolean isEncrypted )

Opens the video service (serviceType 11) and creates a Surface (used for streaming video) with input parameters provided by the app

public android.view.Surface createOpenGLInputSurface(int frameRate,int iFrameInterval,int width,int height,int bitrate,boolean isEncrypted)

Parameters

frameRate
- specified rate of frames to utilize for creation of Surface
iFrameInterval
- specified interval to utilize for creation of Surface
width
- specified width to utilize for creation of Surface
height
- specified height to utilize for creation of Surface
bitrate
- specified bitrate to utilize for creation of Surface
isEncrypted

startRemoteDisplayStream( Context context, java.lang.Class<? extends com.smartdevicelink.streaming.video.SdlRemoteDisplay> remoteDisplay, VideoStreamingParameters parameters, boolean encrypted )

Starts streaming a remote display to the module if there is a connected session. This method of streaming requires the device to be on API level 19 or higher

public void startRemoteDisplayStream(Context context,java.lang.Class<? extends com.smartdevicelink.streaming.video.SdlRemoteDisplay> remoteDisplay,VideoStreamingParameters parameters,boolean encrypted)

Parameters

context
a context that can be used to create the remote display
remoteDisplay
class object of the remote display. This class will be used to create an instance of the remote display and will be projected to the module
parameters
streaming parameters to be used when streaming. If null is sent in, the default/optimized options will be used. If you are unsure about what parameters to be used it is best to just send null and let the system determine what works best for the currently connected module.
encrypted
a flag of if the stream should be encrypted. Only set if you have a supplied encryption library that the module can understand.

stopRemoteDisplayStream()

Stops the remote display stream if one has been started

public void stopRemoteDisplayStream()

startEncoder()

Starts the MediaCodec encoder utilized in conjunction with the Surface returned via the createOpenGLInputSurface method

public void startEncoder()

releaseEncoder()

Releases the MediaCodec encoder utilized in conjunction with the Surface returned via the createOpenGLInputSurface method

public void releaseEncoder()

drainEncoder( boolean endOfStream )

Releases the MediaCodec encoder utilized in conjunction with the Surface returned via the createOpenGLInputSurface method

public void drainEncoder(boolean endOfStream)

Parameters

endOfStream

startAudioStream( boolean isEncrypted, AudioStreamingCodec codec, AudioStreamingParams params )

Opens a audio service (service type 10) and subsequently provides an IAudioStreamListener to the app to send audio data. Currently information passed by "params" are ignored, since Audio Streaming feature lacks capability negotiation mechanism. App should configure audio stream data to align with head unit's capability by checking (upcoming) pcmCapabilities. The default format is in 16kHz and 16 bits.

public com.smartdevicelink.proxy.interfaces.IAudioStreamListener startAudioStream(boolean isEncrypted,AudioStreamingCodec codec,AudioStreamingParams params)

Parameters

isEncrypted
Specify true if packets on this service have to be encrypted
codec
Audio codec which will be used for streaming. Currently, only AudioStreamingCodec.LPCM is accepted.
params
(Reserved for future use) Additional configuration information for each codec. If "codec" is AudioStreamingCodec.LPCM, "params" must be an instance of LPCMParams class.

endAudioStream()

Closes the opened audio service (serviceType 10)

public boolean endAudioStream()

pauseAudioStream()

Pauses the stream for the opened audio service (serviceType 10)

public boolean pauseAudioStream()

resumeAudioStream()

Resumes the stream for the opened audio service (serviceType 10)

public boolean resumeAudioStream()

setAppService( Service mService )

public void setAppService(Service mService)

Parameters

mService

startProtectedRPCService()

public boolean startProtectedRPCService()

getLockScreenIcon( LockScreenManager.OnLockScreenIconDownloadedListener l )

public void getLockScreenIcon(LockScreenManager.OnLockScreenIconDownloadedListener l)

Parameters

l

addCommand( Integer commandID, String menuText, Integer parentID, Integer position, java.util.Vector<java.lang.String> vrCommands, String IconValue, ImageType IconType, Integer correlationID )

Sends an AddCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addCommand(Integer commandID,String menuText,Integer parentID,Integer position,java.util.Vector<java.lang.String> vrCommands,String IconValue,ImageType IconType,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-Unique command ID of the command to add.
menuText
-Menu text for optional sub value containing menu parameters.
parentID
-Menu parent ID for optional sub value containing menu parameters.
position
-Menu position for optional sub value containing menu parameters.
vrCommands
-VR synonyms for this AddCommand.
IconValue
-A static hex icon value or the binary image file name identifier (sent by the PutFile RPC).
IconType
-Describes whether the image is static or dynamic
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addCommand( Integer commandID, String menuText, Integer position, java.util.Vector<java.lang.String> vrCommands, String IconValue, ImageType IconType, Integer correlationID )

Sends an AddCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addCommand(Integer commandID,String menuText,Integer position,java.util.Vector<java.lang.String> vrCommands,String IconValue,ImageType IconType,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-Unique command ID of the command to add.
menuText
-Menu text for optional sub value containing menu parameters.
position
-Menu position for optional sub value containing menu parameters.
vrCommands
-VR synonyms for this AddCommand.
IconValue
-A static hex icon value or the binary image file name identifier (sent by the PutFile RPC).
IconType
-Describes whether the image is static or dynamic
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addCommand( Integer commandID, String menuText, Integer position, String IconValue, ImageType IconType, Integer correlationID )

Sends an AddCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addCommand(Integer commandID,String menuText,Integer position,String IconValue,ImageType IconType,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-Unique command ID of the command to add.
menuText
-Menu text for optional sub value containing menu parameters.
position
-Menu position for optional sub value containing menu parameters.
IconValue
-A static hex icon value or the binary image file name identifier (sent by the PutFile RPC).
IconType
-Describes whether the image is static or dynamic
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addCommand( Integer commandID, String menuText, String IconValue, ImageType IconType, Integer correlationID )

Sends an AddCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addCommand(Integer commandID,String menuText,String IconValue,ImageType IconType,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-Unique command ID of the command to add.
menuText
-Menu text for optional sub value containing menu parameters.
IconValue
-A static hex icon value or the binary image file name identifier (sent by the PutFile RPC).
IconType
-Describes whether the image is static or dynamic
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addCommand( Integer commandID, String menuText, java.util.Vector<java.lang.String> vrCommands, String IconValue, ImageType IconType, Integer correlationID )

Sends an AddCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addCommand(Integer commandID,String menuText,java.util.Vector<java.lang.String> vrCommands,String IconValue,ImageType IconType,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-Unique command ID of the command to add.
menuText
-Menu text for optional sub value containing menu parameters.
vrCommands
-VR synonyms for this AddCommand.
IconValue
-A static hex icon value or the binary image file name identifier (sent by the PutFile RPC).
IconType
-Describes whether the image is static or dynamic
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addCommand( Integer commandID, java.util.Vector<java.lang.String> vrCommands, String IconValue, ImageType IconType, Integer correlationID )

Sends an AddCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addCommand(Integer commandID,java.util.Vector<java.lang.String> vrCommands,String IconValue,ImageType IconType,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-Unique command ID of the command to add.
vrCommands
-VR synonyms for this AddCommand.
IconValue
-A static hex icon value or the binary image file name identifier (sent by the PutFile RPC).
IconType
-Describes whether the image is static or dynamic
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addCommand( Integer commandID, String menuText, Integer parentID, Integer position, java.util.Vector<java.lang.String> vrCommands, Integer correlationID )

Sends an AddCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addCommand(Integer commandID,String menuText,Integer parentID,Integer position,java.util.Vector<java.lang.String> vrCommands,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-Unique command ID of the command to add.
menuText
-Menu text for optional sub value containing menu parameters.
parentID
-Menu parent ID for optional sub value containing menu parameters.
position
-Menu position for optional sub value containing menu parameters.
vrCommands
-VR synonyms for this AddCommand.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addCommand( Integer commandID, String menuText, Integer position, java.util.Vector<java.lang.String> vrCommands, Integer correlationID )

Sends an AddCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addCommand(Integer commandID,String menuText,Integer position,java.util.Vector<java.lang.String> vrCommands,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-Unique command ID of the command to add.
menuText
-Menu text for optional sub value containing menu parameters.
position
-Menu position for optional sub value containing menu parameters.
vrCommands
-VR synonyms for this AddCommand.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addCommand( Integer commandID, String menuText, Integer position, Integer correlationID )

Sends an AddCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addCommand(Integer commandID,String menuText,Integer position,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-Unique command ID of the command to add.
menuText
-Menu text for optional sub value containing menu parameters.
position
-Menu position for optional sub value containing menu parameters.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addCommand( Integer commandID, String menuText, Integer correlationID )

Sends an AddCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addCommand(Integer commandID,String menuText,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-Unique command ID of the command to add.
menuText
-Menu text for optional sub value containing menu parameters.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addCommand( Integer commandID, String menuText, java.util.Vector<java.lang.String> vrCommands, Integer correlationID )

Sends an AddCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addCommand(Integer commandID,String menuText,java.util.Vector<java.lang.String> vrCommands,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-Unique command ID of the command to add.
menuText
-Menu text for optional sub value containing menu parameters.
vrCommands
-VR synonyms for this AddCommand.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addCommand( Integer commandID, java.util.Vector<java.lang.String> vrCommands, Integer correlationID )

Sends an AddCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addCommand(Integer commandID,java.util.Vector<java.lang.String> vrCommands,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-Unique command ID of the command to add.
vrCommands
-VR synonyms for this AddCommand.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addSubMenu( Integer menuID, String menuName, Integer position, Image menuIcon, Integer correlationID )

Sends an AddSubMenu RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addSubMenu(Integer menuID,String menuName,Integer position,Image menuIcon,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

menuID
-Unique ID of the sub menu to add.
menuName
-Text to show in the menu for this sub menu.
position
-Position within the items that are are at top level of the in application menu.
menuIcon
-Image to be be shown along with the submenu item
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addSubMenu( Integer menuID, String menuName, Integer position, Integer correlationID )

Deprecated
Sends an AddSubMenu RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addSubMenu(Integer menuID,String menuName,Integer position,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

menuID
-Unique ID of the sub menu to add.
menuName
-Text to show in the menu for this sub menu.
position
-Position within the items that are are at top level of the in application menu.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

addSubMenu( Integer menuID, String menuName, Integer correlationID )

Deprecated
Sends an AddSubMenu RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void addSubMenu(Integer menuID,String menuName,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

menuID
-Unique ID of the sub menu to add.
menuName
-Text to show in the menu for this sub menu.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

alert( String ttsText, String alertText1, String alertText2, String alertText3, Boolean playTone, Integer duration, java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons, Integer correlationID )

Sends an Alert RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void alert(String ttsText,String alertText1,String alertText2,String alertText3,Boolean playTone,Integer duration,java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

ttsText
-The text to speech message in the form of a string.
alertText1
-The first line of the alert text field.
alertText2
-The second line of the alert text field.
alertText3
-The optional third line of the alert text field.
playTone
-Defines if tone should be played.
duration
-Timeout in milliseconds.
softButtons
-A list of App defined SoftButtons.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

alert( java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsChunks, String alertText1, String alertText2, String alertText3, Boolean playTone, Integer duration, java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons, Integer correlationID )

Sends an Alert RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void alert(java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsChunks,String alertText1,String alertText2,String alertText3,Boolean playTone,Integer duration,java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

ttsChunks
-Text/phonemes to speak in the form of ttsChunks.
alertText1
-The first line of the alert text field.
alertText2
-The second line of the alert text field.
alertText3
-The optional third line of the alert text field.
playTone
-Defines if tone should be played.
duration
-Timeout in milliseconds.
softButtons
-A list of App defined SoftButtons.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

alert( String ttsText, Boolean playTone, java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons, Integer correlationID )

Sends an Alert RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void alert(String ttsText,Boolean playTone,java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

ttsText
-The text to speech message in the form of a string.
playTone
-Defines if tone should be played.
softButtons
-A list of App defined SoftButtons.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

alert( java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> chunks, Boolean playTone, java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons, Integer correlationID )

Sends an Alert RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void alert(java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> chunks,Boolean playTone,java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

chunks
-A list of text/phonemes to speak in the form of ttsChunks.
playTone
-Defines if tone should be played.
softButtons
-A list of App defined SoftButtons.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

alert( String alertText1, String alertText2, String alertText3, Boolean playTone, Integer duration, java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons, Integer correlationID )

Sends an Alert RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void alert(String alertText1,String alertText2,String alertText3,Boolean playTone,Integer duration,java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

alertText1
-The first line of the alert text field.
alertText2
-The second line of the alert text field.
alertText3
-The optional third line of the alert text field.
playTone
-Defines if tone should be played.
duration
-Timeout in milliseconds.
softButtons
-A list of App defined SoftButtons.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

alert( String ttsText, String alertText1, String alertText2, Boolean playTone, Integer duration, Integer correlationID )

Sends an Alert RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void alert(String ttsText,String alertText1,String alertText2,Boolean playTone,Integer duration,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

ttsText
-The text to speech message in the form of a string.
alertText1
-The first line of the alert text field.
alertText2
-The second line of the alert text field.
playTone
-Defines if tone should be played.
duration
-Timeout in milliseconds.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

alert( java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsChunks, String alertText1, String alertText2, Boolean playTone, Integer duration, Integer correlationID )

Sends an Alert RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void alert(java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsChunks,String alertText1,String alertText2,Boolean playTone,Integer duration,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

ttsChunks
-A list of text/phonemes to speak in the form of ttsChunks.
alertText1
-The first line of the alert text field.
alertText2
-The second line of the alert text field.
playTone
-Defines if tone should be played.
duration
-Timeout in milliseconds.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

alert( String ttsText, Boolean playTone, Integer correlationID )

Sends an Alert RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void alert(String ttsText,Boolean playTone,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

ttsText
-The text to speech message in the form of a string.
playTone
-Defines if tone should be played.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

alert( java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> chunks, Boolean playTone, Integer correlationID )

Sends an Alert RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void alert(java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> chunks,Boolean playTone,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

chunks
-A list of text/phonemes to speak in the form of ttsChunks.
playTone
-Defines if tone should be played.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

alert( String alertText1, String alertText2, Boolean playTone, Integer duration, Integer correlationID )

Sends an Alert RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void alert(String alertText1,String alertText2,Boolean playTone,Integer duration,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

alertText1
-The first line of the alert text field.
alertText2
-The second line of the alert text field.
playTone
-Defines if tone should be played.
duration
-Timeout in milliseconds.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

createInteractionChoiceSet( java.util.Vector<com.smartdevicelink.proxy.rpc.Choice> choiceSet, Integer interactionChoiceSetID, Integer correlationID )

Sends a CreateInteractionChoiceSet RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void createInteractionChoiceSet(java.util.Vector<com.smartdevicelink.proxy.rpc.Choice> choiceSet,Integer interactionChoiceSetID,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

choiceSet
to be sent to the module
interactionChoiceSetID
to be used in reference to the supplied choiceSet
correlationID
to be set to the RPCRequest

Throws

deleteCommand( Integer commandID, Integer correlationID )

Sends a DeleteCommand RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void deleteCommand(Integer commandID,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

commandID
-ID of the command(s) to delete.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

deleteInteractionChoiceSet( Integer interactionChoiceSetID, Integer correlationID )

Sends a DeleteInteractionChoiceSet RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void deleteInteractionChoiceSet(Integer interactionChoiceSetID,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

interactionChoiceSetID
-ID of the interaction choice set to delete.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

deleteSubMenu( Integer menuID, Integer correlationID )

Sends a DeleteSubMenu RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void deleteSubMenu(Integer menuID,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

menuID
-The menuID of the submenu to delete.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse

Throws

performInteraction( String initPrompt, String displayText, Integer interactionChoiceSetID, java.util.Vector<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp, Integer correlationID )

Sends a PerformInteraction RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void performInteraction(String initPrompt,String displayText,Integer interactionChoiceSetID,java.util.Vector<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

initPrompt
-Intial prompt spoken to the user at the start of an interaction.
displayText
-Text to be displayed first.
interactionChoiceSetID
-Interaction choice set IDs to use with an interaction.
vrHelp
-Suggested VR Help Items to display on-screen during Perform Interaction.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

performInteraction( String initPrompt, String displayText, Integer interactionChoiceSetID, String helpPrompt, String timeoutPrompt, InteractionMode interactionMode, Integer timeout, java.util.Vector<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp, Integer correlationID )

Sends a PerformInteraction RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void performInteraction(String initPrompt,String displayText,Integer interactionChoiceSetID,String helpPrompt,String timeoutPrompt,InteractionMode interactionMode,Integer timeout,java.util.Vector<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

initPrompt
-Intial prompt spoken to the user at the start of an interaction.
displayText
-Text to be displayed first.
interactionChoiceSetID
-Interaction choice set IDs to use with an interaction.
helpPrompt
-Help text that is spoken when a user speaks "help" during the interaction.
timeoutPrompt
-Timeout text that is spoken when a VR interaction times out.
interactionMode
- The method in which the user is notified and uses the interaction (Manual,VR,Both).
timeout
-Timeout in milliseconds.
vrHelp
-Suggested VR Help Items to display on-screen during Perform Interaction.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

performInteraction( String initPrompt, String displayText, java.util.Vector<java.lang.Integer> interactionChoiceSetIDList, String helpPrompt, String timeoutPrompt, InteractionMode interactionMode, Integer timeout, java.util.Vector<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp, Integer correlationID )

Sends a PerformInteraction RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void performInteraction(String initPrompt,String displayText,java.util.Vector<java.lang.Integer> interactionChoiceSetIDList,String helpPrompt,String timeoutPrompt,InteractionMode interactionMode,Integer timeout,java.util.Vector<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

initPrompt
-Intial prompt spoken to the user at the start of an interaction.
displayText
-Text to be displayed first.
interactionChoiceSetIDList
-A list of interaction choice set IDs to use with an interaction.
helpPrompt
-Help text that is spoken when a user speaks "help" during the interaction.
timeoutPrompt
-Timeout text that is spoken when a VR interaction times out.
interactionMode
- The method in which the user is notified and uses the interaction (Manual,VR,Both).
timeout
-Timeout in milliseconds.
vrHelp
-Suggested VR Help Items to display on-screen during Perform Interaction.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

performInteraction( java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> initChunks, String displayText, java.util.Vector<java.lang.Integer> interactionChoiceSetIDList, java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> helpChunks, java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> timeoutChunks, InteractionMode interactionMode, Integer timeout, java.util.Vector<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp, Integer correlationID )

Sends a PerformInteraction RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void performInteraction(java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> initChunks,String displayText,java.util.Vector<java.lang.Integer> interactionChoiceSetIDList,java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> helpChunks,java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> timeoutChunks,InteractionMode interactionMode,Integer timeout,java.util.Vector<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

initChunks
-A list of text/phonemes to speak for the initial prompt in the form of ttsChunks.
displayText
-Text to be displayed first.
interactionChoiceSetIDList
-A list of interaction choice set IDs to use with an interaction.
helpChunks
-A list of text/phonemes to speak for the help text that is spoken when a user speaks "help" during the interaction.
timeoutChunks
A list of text/phonems to speak for the timeout text that is spoken when a VR interaction times out.
interactionMode
- The method in which the user is notified and uses the interaction (Manual,VR,Both).
timeout
-Timeout in milliseconds.
vrHelp
-Suggested VR Help Items to display on-screen during Perform Interaction.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

performInteraction( String initPrompt, String displayText, Integer interactionChoiceSetID, Integer correlationID )

Sends a PerformInteraction RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void performInteraction(String initPrompt,String displayText,Integer interactionChoiceSetID,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

initPrompt
-Intial prompt spoken to the user at the start of an interaction.
displayText
-Text to be displayed first.
interactionChoiceSetID
-Interaction choice set IDs to use with an interaction.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

performInteraction( String initPrompt, String displayText, Integer interactionChoiceSetID, String helpPrompt, String timeoutPrompt, InteractionMode interactionMode, Integer timeout, Integer correlationID )

Sends a PerformInteraction RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void performInteraction(String initPrompt,String displayText,Integer interactionChoiceSetID,String helpPrompt,String timeoutPrompt,InteractionMode interactionMode,Integer timeout,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

initPrompt
-Intial prompt spoken to the user at the start of an interaction.
displayText
-Text to be displayed first.
interactionChoiceSetID
-Interaction choice set IDs to use with an interaction.
helpPrompt
-Help text that is spoken when a user speaks "help" during the interaction.
timeoutPrompt
-Timeout text that is spoken when a VR interaction times out.
interactionMode
- The method in which the user is notified and uses the interaction (Manual,VR,Both).
timeout
-Timeout in milliseconds.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

performInteraction( String initPrompt, String displayText, java.util.Vector<java.lang.Integer> interactionChoiceSetIDList, String helpPrompt, String timeoutPrompt, InteractionMode interactionMode, Integer timeout, Integer correlationID )

Sends a PerformInteraction RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void performInteraction(String initPrompt,String displayText,java.util.Vector<java.lang.Integer> interactionChoiceSetIDList,String helpPrompt,String timeoutPrompt,InteractionMode interactionMode,Integer timeout,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

initPrompt
-Intial prompt spoken to the user at the start of an interaction.
displayText
-Text to be displayed first.
interactionChoiceSetIDList
-A list of interaction choice set IDs to use with an interaction.
helpPrompt
-Help text that is spoken when a user speaks "help" during the interaction.
timeoutPrompt
-Timeout text that is spoken when a VR interaction times out.
interactionMode
- The method in which the user is notified and uses the interaction (Manual,VR,Both).
timeout
-Timeout in milliseconds.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

performInteraction( java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> initChunks, String displayText, java.util.Vector<java.lang.Integer> interactionChoiceSetIDList, java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> helpChunks, java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> timeoutChunks, InteractionMode interactionMode, Integer timeout, Integer correlationID )

Sends a PerformInteraction RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void performInteraction(java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> initChunks,String displayText,java.util.Vector<java.lang.Integer> interactionChoiceSetIDList,java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> helpChunks,java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> timeoutChunks,InteractionMode interactionMode,Integer timeout,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

initChunks
-A list of text/phonemes to speak for the initial prompt in the form of ttsChunks.
displayText
-Text to be displayed first.
interactionChoiceSetIDList
-A list of interaction choice set IDs to use with an interaction.
helpChunks
-A list of text/phonemes to speak for the help text that is spoken when a user speaks "help" during the interaction.
timeoutChunks
A list of text/phonems to speak for the timeout text that is spoken when a VR interaction times out.
interactionMode
- The method in which the user is notified and uses the interaction (Manual,VR,Both).
timeout
-Timeout in milliseconds.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

registerAppInterfacePrivate( SdlMsgVersion sdlMsgVersion, String appName, java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName, String ngnMediaScreenAppName, java.util.Vector<java.lang.String> vrSynonyms, Boolean isMediaApp, Language languageDesired, Language hmiDisplayLanguageDesired, java.util.Vector<com.smartdevicelink.proxy.rpc.enums.AppHMIType> appType, String appID, TemplateColorScheme dayColorScheme, TemplateColorScheme nightColorScheme, Integer correlationID )

protected void registerAppInterfacePrivate(SdlMsgVersion sdlMsgVersion,String appName,java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName,String ngnMediaScreenAppName,java.util.Vector<java.lang.String> vrSynonyms,Boolean isMediaApp,Language languageDesired,Language hmiDisplayLanguageDesired,java.util.Vector<com.smartdevicelink.proxy.rpc.enums.AppHMIType> appType,String appID,TemplateColorScheme dayColorScheme,TemplateColorScheme nightColorScheme,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

sdlMsgVersion
appName
ttsName
ngnMediaScreenAppName
vrSynonyms
isMediaApp
languageDesired
hmiDisplayLanguageDesired
appType
appID
dayColorScheme
nightColorScheme
correlationID

Throws

setGlobalProperties( String helpPrompt, String timeoutPrompt, String vrHelpTitle, java.util.Vector<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp, Integer correlationID )

Sends a SetGlobalProperties RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void setGlobalProperties(String helpPrompt,String timeoutPrompt,String vrHelpTitle,java.util.Vector<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

helpPrompt
that will be used for the VR screen
timeoutPrompt
string to be displayed after timeout
vrHelpTitle
string that may be displayed on VR prompt dialog
vrHelp
a list of VR synonyms that may be displayed to user
correlationID
to be attached to the request

Throws

setGlobalProperties( java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> helpChunks, java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> timeoutChunks, String vrHelpTitle, java.util.Vector<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp, Integer correlationID )

Sends a SetGlobalProperties RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void setGlobalProperties(java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> helpChunks,java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> timeoutChunks,String vrHelpTitle,java.util.Vector<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

helpChunks
tts chunks that should be used when prompting the user
timeoutChunks
tts chunks that will be used when a timeout occurs
vrHelpTitle
string that may be displayed on VR prompt dialog
vrHelp
a list of VR synonyms that may be displayed to user
correlationID
ID to be attached to the RPCRequest that correlates the RPCResponse

Throws

setGlobalProperties( String helpPrompt, String timeoutPrompt, Integer correlationID )

Sends a SetGlobalProperties RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void setGlobalProperties(String helpPrompt,String timeoutPrompt,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

helpPrompt
that will be used for the VR screen
timeoutPrompt
string to be displayed after timeout
correlationID
ID to be attached to the RPCRequest that correlates the RPCResponse

Throws

setGlobalProperties( java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> helpChunks, java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> timeoutChunks, Integer correlationID )

Sends a SetGlobalProperties RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void setGlobalProperties(java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> helpChunks,java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> timeoutChunks,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

helpChunks
tts chunks that should be used when prompting the user
timeoutChunks
tts chunks that will be used when a timeout occurs
correlationID
ID to be attached to the RPCRequest that correlates the RPCResponse

Throws

resetGlobalProperties( java.util.Vector<com.smartdevicelink.proxy.rpc.enums.GlobalProperty> properties, Integer correlationID )

public void resetGlobalProperties(java.util.Vector<com.smartdevicelink.proxy.rpc.enums.GlobalProperty> properties,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

properties
correlationID

Throws

setMediaClockTimer( Integer hours, Integer minutes, Integer seconds, UpdateMode updateMode, Integer correlationID )

Sends a SetMediaClockTimer RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void setMediaClockTimer(Integer hours,Integer minutes,Integer seconds,UpdateMode updateMode,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

hours
integer for hours
minutes
integer for minutes
seconds
integer for seconds
updateMode
mode in which the media clock timer should be updated
correlationID
ID to be attached to the RPCRequest that correlates the RPCResponse

Throws

pauseMediaClockTimer( Integer correlationID )

Pauses the media clock. Responses are captured through callback on IProxyListener.

public void pauseMediaClockTimer(Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

correlationID
ID to be attached to the RPCRequest that correlates the RPCResponse

Throws

resumeMediaClockTimer( Integer correlationID )

Resumes the media clock. Responses are captured through callback on IProxyListener.

public void resumeMediaClockTimer(Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

correlationID
ID to be attached to the RPCRequest that correlates the RPCResponse

Throws

clearMediaClockTimer( Integer correlationID )

Clears the media clock. Responses are captured through callback on IProxyListener.

public void clearMediaClockTimer(Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

correlationID
ID to be attached to the RPCRequest that correlates the RPCResponse

Throws

show( String mainText1, String mainText2, String mainText3, String mainText4, String statusBar, String mediaClock, String mediaTrack, Image graphic, java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons, java.util.Vector<java.lang.String> customPresets, TextAlignment alignment, Integer correlationID )

Sends a Show RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void show(String mainText1,String mainText2,String mainText3,String mainText4,String statusBar,String mediaClock,String mediaTrack,Image graphic,java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons,java.util.Vector<java.lang.String> customPresets,TextAlignment alignment,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

mainText1
text displayed in a single or upper display line.
mainText2
text displayed on the second display line.
mainText3
text displayed on the second "page" first display line.
mainText4
text displayed on the second "page" second display line.
statusBar
text is placed in the status bar area (Only valid for NAVIGATION apps)
mediaClock
text value for MediaClock field.
mediaTrack
text displayed in the track field.
graphic
image struct determining whether static or dynamic image to display in app.
softButtons
app defined SoftButtons.
customPresets
app labeled on-screen presets.
alignment
specifies how mainText1 and mainText2s texts should be aligned on display.
correlationID
ID to be attached to the RPCRequest that correlates the RPCResponse -A unique ID that correlates each RPCRequest and RPCResponse.

Throws

show( String mainText1, String mainText2, String mainText3, String mainText4, Image graphic, java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons, java.util.Vector<java.lang.String> customPresets, TextAlignment alignment, Integer correlationID )

Sends a Show RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void show(String mainText1,String mainText2,String mainText3,String mainText4,Image graphic,java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons,java.util.Vector<java.lang.String> customPresets,TextAlignment alignment,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

mainText1
-Text displayed in a single or upper display line.
mainText2
-Text displayed on the second display line.
mainText3
-Text displayed on the second "page" first display line.
mainText4
-Text displayed on the second "page" second display line.
graphic
-Image struct determining whether static or dynamic image to display in app.
softButtons
-App defined SoftButtons.
customPresets
-App labeled on-screen presets.
alignment
-Specifies how mainText1 and mainText2s texts should be aligned on display.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

show( String mainText1, String mainText2, String statusBar, String mediaClock, String mediaTrack, TextAlignment alignment, Integer correlationID )

Sends a Show RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void show(String mainText1,String mainText2,String statusBar,String mediaClock,String mediaTrack,TextAlignment alignment,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

mainText1
text displayed in a single or upper display line.
mainText2
text displayed on the second display line.
statusBar
text is placed in the status bar area (Only valid for NAVIGATION apps)
mediaClock
text value for MediaClock field.
mediaTrack
text displayed in the track field.
alignment
specifies how mainText1 and mainText2s texts should be aligned on display.
correlationID
unique ID that correlates each RPCRequest and RPCResponse.

Throws

show( String mainText1, String mainText2, TextAlignment alignment, Integer correlationID )

Sends a Show RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void show(String mainText1,String mainText2,TextAlignment alignment,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

mainText1
-Text displayed in a single or upper display line.
mainText2
-Text displayed on the second display line.
alignment
-Specifies how mainText1 and mainText2s texts should be aligned on display.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

speak( String ttsText, Integer correlationID )

Sends a Speak RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void speak(String ttsText,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

ttsText
-The text to speech message in the form of a string.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

speak( java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsChunks, Integer correlationID )

Sends a Speak RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void speak(java.util.Vector<com.smartdevicelink.proxy.rpc.TTSChunk> ttsChunks,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

ttsChunks
-Text/phonemes to speak in the form of ttsChunks.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

subscribeButton( ButtonName buttonName, Integer correlationID )

Sends a SubscribeButton RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void subscribeButton(ButtonName buttonName,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

buttonName
-Name of the button to subscribe.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

unregisterAppInterfacePrivate( Integer correlationID )

protected void unregisterAppInterfacePrivate(Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

correlationID

Throws

unsubscribeButton( ButtonName buttonName, Integer correlationID )

Sends an UnsubscribeButton RPCRequest to SDL. Responses are captured through callback on IProxyListener.

public void unsubscribeButton(ButtonName buttonName,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

buttonName
-Name of the button to unsubscribe.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

createChoiceSetChoice( Integer choiceID, String choiceMenuName, java.util.Vector<java.lang.String> choiceVrCommands )

Creates a choice to be added to a choiceset. Choice has both a voice and a visual menu component.

public com.smartdevicelink.proxy.rpc.Choice createChoiceSetChoice(Integer choiceID,String choiceMenuName,java.util.Vector<java.lang.String> choiceVrCommands)

Parameters

choiceID
-Unique ID used to identify this choice (returned in callback).
choiceMenuName
-Text name displayed for this choice.
choiceVrCommands
-Vector of vrCommands used to select this choice by voice. Must contain at least one non-empty element.

performaudiopassthru( String initialPrompt, String audioPassThruDisplayText1, String audioPassThruDisplayText2, SamplingRate samplingRate, Integer maxDuration, BitsPerSample bitsPerSample, AudioType audioType, Boolean muteAudio, Integer correlationID )

Starts audio pass thru session. Responses are captured through callback on IProxyListener.

public void performaudiopassthru(String initialPrompt,String audioPassThruDisplayText1,String audioPassThruDisplayText2,SamplingRate samplingRate,Integer maxDuration,BitsPerSample bitsPerSample,AudioType audioType,Boolean muteAudio,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

initialPrompt
-SDL will speak this prompt before opening the audio pass thru session.
audioPassThruDisplayText1
-First line of text displayed during audio capture.
audioPassThruDisplayText2
-Second line of text displayed during audio capture.
samplingRate
-Allowable values of 8 khz or 16 or 22 or 44 khz.
maxDuration
-The maximum duration of audio recording in milliseconds.
bitsPerSample
-Specifies the quality the audio is recorded. Currently 8 bit or 16 bit.
audioType
-Specifies the type of audio data being requested.
muteAudio
-Defines if the current audio source should be muted during the APT session.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

endaudiopassthru( Integer correlationID )

Ends audio pass thru session. Responses are captured through callback on IProxyListener.

public void endaudiopassthru(Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

correlationID
ID to be attached to the RPCRequest that correlates the RPCResponse

Throws

subscribevehicledata( boolean gps, boolean speed, boolean rpm, boolean fuelLevel, boolean fuelLevel_State, boolean instantFuelConsumption, boolean externalTemperature, boolean prndl, boolean tirePressure, boolean odometer, boolean beltStatus, boolean bodyInformation, boolean deviceStatus, boolean driverBraking, Integer correlationID )

Deprecated
Subscribes for specific published data items. The data will be only sent if it has changed. Responses are captured through callback on IProxyListener.

public void subscribevehicledata(boolean gps,boolean speed,boolean rpm,boolean fuelLevel,boolean fuelLevel_State,boolean instantFuelConsumption,boolean externalTemperature,boolean prndl,boolean tirePressure,boolean odometer,boolean beltStatus,boolean bodyInformation,boolean deviceStatus,boolean driverBraking,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

gps
-Subscribes to GPS data.
speed
-Subscribes to vehicle speed data in kilometers per hour.
rpm
-Subscribes to number of revolutions per minute of the engine.
fuelLevel
-Subscribes to fuel level in the tank (percentage).
fuelLevel_State
-Subscribes to fuel level state.
instantFuelConsumption
-Subscribes to instantaneous fuel consumption in microlitres.
externalTemperature
-Subscribes to the external temperature in degrees celsius.
prndl
-Subscribes to PRNDL data that houses the selected gear.
tirePressure
-Subscribes to the TireStatus data containing status and pressure of tires.
odometer
-Subscribes to Odometer data in km.
beltStatus
-Subscribes to status of the seat belts.
bodyInformation
-Subscribes to body information including power modes.
deviceStatus
-Subscribes to device status including signal and battery strength.
driverBraking
-Subscribes to the status of the brake pedal.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

subscribevehicledata( boolean gps, boolean speed, boolean rpm, boolean fuelLevel, boolean fuelLevel_State, boolean instantFuelConsumption, boolean externalTemperature, boolean prndl, boolean tirePressure, boolean engineOilLife, boolean odometer, boolean beltStatus, boolean bodyInformation, boolean deviceStatus, boolean driverBraking, Integer correlationID )

Subscribes for specific published data items. The data will be only sent if it has changed. Responses are captured through callback on IProxyListener.

public void subscribevehicledata(boolean gps,boolean speed,boolean rpm,boolean fuelLevel,boolean fuelLevel_State,boolean instantFuelConsumption,boolean externalTemperature,boolean prndl,boolean tirePressure,boolean engineOilLife,boolean odometer,boolean beltStatus,boolean bodyInformation,boolean deviceStatus,boolean driverBraking,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

gps
-Subscribes to GPS data.
speed
-Subscribes to vehicle speed data in kilometers per hour.
rpm
-Subscribes to number of revolutions per minute of the engine.
fuelLevel
-Subscribes to fuel level in the tank (percentage).
fuelLevel_State
-Subscribes to fuel level state.
instantFuelConsumption
-Subscribes to instantaneous fuel consumption in microlitres.
externalTemperature
-Subscribes to the external temperature in degrees celsius.
prndl
-Subscribes to PRNDL data that houses the selected gear.
tirePressure
-Subscribes to the TireStatus data containing status and pressure of tires.
engineOilLife
-Subscribes to Engine Oil Life data.
odometer
-Subscribes to Odometer data in km.
beltStatus
-Subscribes to status of the seat belts.
bodyInformation
-Subscribes to body information including power modes.
deviceStatus
-Subscribes to device status including signal and battery strength.
driverBraking
-Subscribes to the status of the brake pedal.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

unsubscribevehicledata( boolean gps, boolean speed, boolean rpm, boolean fuelLevel, boolean fuelLevel_State, boolean instantFuelConsumption, boolean externalTemperature, boolean prndl, boolean tirePressure, boolean odometer, boolean beltStatus, boolean bodyInformation, boolean deviceStatus, boolean driverBraking, Integer correlationID )

Deprecated
Unsubscribes for specific published data items. Responses are captured through callback on IProxyListener.

public void unsubscribevehicledata(boolean gps,boolean speed,boolean rpm,boolean fuelLevel,boolean fuelLevel_State,boolean instantFuelConsumption,boolean externalTemperature,boolean prndl,boolean tirePressure,boolean odometer,boolean beltStatus,boolean bodyInformation,boolean deviceStatus,boolean driverBraking,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

gps
-Unsubscribes to GPS data.
speed
-Unsubscribes to vehicle speed data in kilometers per hour.
rpm
-Unsubscribes to number of revolutions per minute of the engine.
fuelLevel
-Unsubscribes to fuel level in the tank (percentage).
fuelLevel_State
-Unsubscribes to fuel level state.
instantFuelConsumption
-Unsubscribes to instantaneous fuel consumption in microlitres.
externalTemperature
-Unsubscribes to the external temperature in degrees celsius.
prndl
-Unsubscribes to PRNDL data that houses the selected gear.
tirePressure
-Unsubscribes to the TireStatus data containing status and pressure of tires.
odometer
-Unsubscribes to Odometer data in km.
beltStatus
-Unsubscribes to status of the seat belts.
bodyInformation
-Unsubscribes to body information including power modes.
deviceStatus
-Unsubscribes to device status including signal and battery strength.
driverBraking
-Unsubscribes to the status of the brake pedal.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

unsubscribevehicledata( boolean gps, boolean speed, boolean rpm, boolean fuelLevel, boolean fuelLevel_State, boolean instantFuelConsumption, boolean externalTemperature, boolean prndl, boolean tirePressure, boolean engineOilLife, boolean odometer, boolean beltStatus, boolean bodyInformation, boolean deviceStatus, boolean driverBraking, Integer correlationID )

Unsubscribes for specific published data items. Responses are captured through callback on IProxyListener.

public void unsubscribevehicledata(boolean gps,boolean speed,boolean rpm,boolean fuelLevel,boolean fuelLevel_State,boolean instantFuelConsumption,boolean externalTemperature,boolean prndl,boolean tirePressure,boolean engineOilLife,boolean odometer,boolean beltStatus,boolean bodyInformation,boolean deviceStatus,boolean driverBraking,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

gps
-Unsubscribes to GPS data.
speed
-Unsubscribes to vehicle speed data in kilometers per hour.
rpm
-Unsubscribes to number of revolutions per minute of the engine.
fuelLevel
-Unsubscribes to fuel level in the tank (percentage).
fuelLevel_State
-Unsubscribes to fuel level state.
instantFuelConsumption
-Unsubscribes to instantaneous fuel consumption in microlitres.
externalTemperature
-Unsubscribes to the external temperature in degrees celsius.
prndl
-Unsubscribes to PRNDL data that houses the selected gear.
tirePressure
-Unsubscribes to the TireStatus data containing status and pressure of tires.
engineOilLife
-Unsubscribes to Engine Oil Life data.
odometer
-Unsubscribes to Odometer data in km.
beltStatus
-Unsubscribes to status of the seat belts.
bodyInformation
-Unsubscribes to body information including power modes.
deviceStatus
-Unsubscribes to device status including signal and battery strength.
driverBraking
-Unsubscribes to the status of the brake pedal.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

getvehicledata( boolean gps, boolean speed, boolean rpm, boolean fuelLevel, boolean fuelLevel_State, boolean instantFuelConsumption, boolean externalTemperature, boolean vin, boolean prndl, boolean tirePressure, boolean odometer, boolean beltStatus, boolean bodyInformation, boolean deviceStatus, boolean driverBraking, Integer correlationID )

Deprecated
Performs a Non periodic vehicle data read request. Responses are captured through callback on IProxyListener.

public void getvehicledata(boolean gps,boolean speed,boolean rpm,boolean fuelLevel,boolean fuelLevel_State,boolean instantFuelConsumption,boolean externalTemperature,boolean vin,boolean prndl,boolean tirePressure,boolean odometer,boolean beltStatus,boolean bodyInformation,boolean deviceStatus,boolean driverBraking,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

gps
-Performs an ad-hoc request for GPS data.
speed
-Performs an ad-hoc request for vehicle speed data in kilometers per hour.
rpm
-Performs an ad-hoc request for number of revolutions per minute of the engine.
fuelLevel
-Performs an ad-hoc request for fuel level in the tank (percentage).
fuelLevel_State
-Performs an ad-hoc request for fuel level state.
instantFuelConsumption
-Performs an ad-hoc request for instantaneous fuel consumption in microlitres.
externalTemperature
-Performs an ad-hoc request for the external temperature in degrees celsius.
vin
-Performs an ad-hoc request for the Vehicle identification number
prndl
-Performs an ad-hoc request for PRNDL data that houses the selected gear.
tirePressure
-Performs an ad-hoc request for the TireStatus data containing status and pressure of tires.
odometer
-Performs an ad-hoc request for Odometer data in km.
beltStatus
-Performs an ad-hoc request for status of the seat belts.
bodyInformation
-Performs an ad-hoc request for body information including power modes.
deviceStatus
-Performs an ad-hoc request for device status including signal and battery strength.
driverBraking
-Performs an ad-hoc request for the status of the brake pedal.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

getvehicledata( boolean gps, boolean speed, boolean rpm, boolean fuelLevel, boolean fuelLevel_State, boolean instantFuelConsumption, boolean externalTemperature, boolean vin, boolean prndl, boolean tirePressure, boolean engineOilLife, boolean odometer, boolean beltStatus, boolean bodyInformation, boolean deviceStatus, boolean driverBraking, Integer correlationID )

Performs a Non periodic vehicle data read request. Responses are captured through callback on IProxyListener.

public void getvehicledata(boolean gps,boolean speed,boolean rpm,boolean fuelLevel,boolean fuelLevel_State,boolean instantFuelConsumption,boolean externalTemperature,boolean vin,boolean prndl,boolean tirePressure,boolean engineOilLife,boolean odometer,boolean beltStatus,boolean bodyInformation,boolean deviceStatus,boolean driverBraking,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

gps
-Performs an ad-hoc request for GPS data.
speed
-Performs an ad-hoc request for vehicle speed data in kilometers per hour.
rpm
-Performs an ad-hoc request for number of revolutions per minute of the engine.
fuelLevel
-Performs an ad-hoc request for fuel level in the tank (percentage).
fuelLevel_State
-Performs an ad-hoc request for fuel level state.
instantFuelConsumption
-Performs an ad-hoc request for instantaneous fuel consumption in microlitres.
externalTemperature
-Performs an ad-hoc request for the external temperature in degrees celsius.
vin
-Performs an ad-hoc request for the Vehicle identification number
prndl
-Performs an ad-hoc request for PRNDL data that houses the selected gear.
tirePressure
-Performs an ad-hoc request for the TireStatus data containing status and pressure of tires.
engineOilLife
-Performs an ad-hoc request for Engine Oil Life data.
odometer
-Performs an ad-hoc request for Odometer data in km.
beltStatus
-Performs an ad-hoc request for status of the seat belts.
bodyInformation
-Performs an ad-hoc request for body information including power modes.
deviceStatus
-Performs an ad-hoc request for device status including signal and battery strength.
driverBraking
-Performs an ad-hoc request for the status of the brake pedal.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

scrollablemessage( String scrollableMessageBody, Integer timeout, java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons, Integer correlationID )

Creates a full screen overlay containing a large block of formatted text that can be scrolled with up to 8 SoftButtons defined. Responses are captured through callback on IProxyListener.

public void scrollablemessage(String scrollableMessageBody,Integer timeout,java.util.Vector<com.smartdevicelink.proxy.rpc.SoftButton> softButtons,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

scrollableMessageBody
-Body of text that can include newlines and tabs.
timeout
-App defined timeout. Indicates how long of a timeout from the last action.
softButtons
-App defined SoftButtons.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

slider( Integer numTicks, Integer position, String sliderHeader, java.util.Vector<java.lang.String> sliderFooter, Integer timeout, Integer correlationID )

Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider. Responses are captured through callback on IProxyListener.

public void slider(Integer numTicks,Integer position,String sliderHeader,java.util.Vector<java.lang.String> sliderFooter,Integer timeout,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

numTicks
-Number of selectable items on a horizontal axis.
position
-Initial position of slider control (cannot exceed numTicks).
sliderHeader
-Text header to display.
sliderFooter
- Text footer to display (meant to display min/max threshold descriptors).
timeout
-App defined timeout. Indicates how long of a timeout from the last action.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

changeregistration( Language language, Language hmiDisplayLanguage, Integer correlationID )

Responses are captured through callback on IProxyListener.

public void changeregistration(Language language,Language hmiDisplayLanguage,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

language
requested SDL voice engine (VR+TTS) language registration
hmiDisplayLanguage
request display language registration.
correlationID
ID to be attached to the RPCRequest that correlates the RPCResponse

Throws

putFileStream( InputStream is, String sdlFileName, Integer iOffset, Integer iLength )

Deprecated
Used to push a binary stream of file data onto the module from a mobile device. Responses are captured through callback on IProxyListener.

public void putFileStream(InputStream is,String sdlFileName,Integer iOffset,Integer iLength) throws com.smartdevicelink.exception.SdlException

Parameters

is
- The input stream of byte data that putFileStream will read from
sdlFileName
- The file reference name used by the putFile RPC.
iOffset
- The data offset in bytes, a value of zero is used to indicate data starting from the beginging of the file. A value greater than zero is used for resuming partial data chunks.
iLength
- The total length of the file being sent.

Throws

putFileStream( InputStream inputStream, String fileName, Long offset, Long length )

Used to push a binary stream of file data onto the module from a mobile device. Responses are captured through callback on IProxyListener.

public void putFileStream(InputStream inputStream,String fileName,Long offset,Long length) throws com.smartdevicelink.exception.SdlException

Parameters

inputStream
The input stream of byte data that will be read from.
fileName
The SDL file reference name used by the RPC.
offset
The data offset in bytes. A value of zero is used to indicate data starting from the beginning of the file and a value greater than zero is used for resuming partial data chunks.
length
The total length of the file being sent.

Throws

putFileStream( String sdlFileName, Integer iOffset, Integer iLength )

Deprecated
Used to push a binary stream of file data onto the module from a mobile device. Responses are captured through callback on IProxyListener.

public java.io.OutputStream putFileStream(String sdlFileName,Integer iOffset,Integer iLength) throws com.smartdevicelink.exception.SdlException

Parameters

sdlFileName
- The file reference name used by the putFile RPC.
iOffset
- The data offset in bytes, a value of zero is used to indicate data starting from the beginging of a file. A value greater than zero is used for resuming partial data chunks.
iLength
- The total length of the file being sent.

Throws

putFileStream( String fileName, Long offset, Long length )

Used to push a binary stream of file data onto the module from a mobile device. Responses are captured through callback on IProxyListener.

public java.io.OutputStream putFileStream(String fileName,Long offset,Long length) throws com.smartdevicelink.exception.SdlException

Parameters

fileName
The SDL file reference name used by the RPC.
offset
The data offset in bytes. A value of zero is used to indicate data starting from the beginning of the file and a value greater than zero is used for resuming partial data chunks.
length
The total length of the file being sent.

Throws

putFileStream( InputStream is, String sdlFileName, Integer iOffset, Integer iLength, FileType fileType, Boolean bPersistentFile, Boolean bSystemFile )

Deprecated
Used to push a binary stream of file data onto the module from a mobile device. Responses are captured through callback on IProxyListener.

public void putFileStream(InputStream is,String sdlFileName,Integer iOffset,Integer iLength,FileType fileType,Boolean bPersistentFile,Boolean bSystemFile) throws com.smartdevicelink.exception.SdlException

Parameters

is
- The input stream of byte data that PutFileStream will read from
sdlFileName
- The file reference name used by the putFile RPC.
iOffset
- The data offset in bytes, a value of zero is used to indicate data starting from the beginging of the file. A value greater than zero is used for resuming partial data chunks.
iLength
- The total length of the file being sent.
fileType
- The selected file type -- see the FileType enumeration for details
bPersistentFile
- Indicates if the file is meant to persist between sessions / ignition cycles.
bSystemFile
- Indicates if the file is meant to be passed thru core to elsewhere on the system.

Throws

putFileStream( InputStream inputStream, String fileName, Long offset, Long length, FileType fileType, Boolean isPersistentFile, Boolean isSystemFile, OnPutFileUpdateListener cb )

Used to push a binary stream of file data onto the module from a mobile device. Responses are captured through callback on IProxyListener.

public void putFileStream(InputStream inputStream,String fileName,Long offset,Long length,FileType fileType,Boolean isPersistentFile,Boolean isSystemFile,OnPutFileUpdateListener cb) throws com.smartdevicelink.exception.SdlException

Parameters

inputStream
The input stream of byte data that will be read from.
fileName
The SDL file reference name used by the RPC.
offset
The data offset in bytes. A value of zero is used to indicate data starting from the beginning of the file and a value greater than zero is used for resuming partial data chunks.
length
The total length of the file being sent.
fileType
The selected file type. See the {@link FileType} enum for details.
isPersistentFile
Indicates if the file is meant to persist between sessions / ignition cycles.
isSystemFile
Indicates if the file is meant to be passed through core to elsewhere in the system.
cb

Throws

putFileStream( String sdlFileName, Integer iOffset, Integer iLength, FileType fileType, Boolean bPersistentFile, Boolean bSystemFile )

Deprecated
Used to push a binary stream of file data onto the module from a mobile device. Responses are captured through callback on IProxyListener.

public java.io.OutputStream putFileStream(String sdlFileName,Integer iOffset,Integer iLength,FileType fileType,Boolean bPersistentFile,Boolean bSystemFile) throws com.smartdevicelink.exception.SdlException

Parameters

sdlFileName
- The file reference name used by the putFile RPC.
iOffset
- The data offset in bytes, a value of zero is used to indicate data starting from the beginging of a file. A value greater than zero is used for resuming partial data chunks.
iLength
- The total length of the file being sent.
fileType
- The selected file type -- see the FileType enumeration for details
bPersistentFile
- Indicates if the file is meant to persist between sessions / ignition cycles.
bSystemFile
- Indicates if the file is meant to be passed thru core to elsewhere on the system.

Throws

putFileStream( String fileName, Long offset, Long length, FileType fileType, Boolean isPersistentFile, Boolean isSystemFile, OnPutFileUpdateListener cb )

Used to push a binary stream of file data onto the module from a mobile device. Responses are captured through callback on IProxyListener.

public java.io.OutputStream putFileStream(String fileName,Long offset,Long length,FileType fileType,Boolean isPersistentFile,Boolean isSystemFile,OnPutFileUpdateListener cb) throws com.smartdevicelink.exception.SdlException

Parameters

fileName
The SDL file reference name used by the RPC.
offset
The data offset in bytes. A value of zero is used to indicate data starting from the beginning of the file and a value greater than zero is used for resuming partial data chunks.
length
The total length of the file being sent.
fileType
The selected file type. See the {@link FileType} enum for details.
isPersistentFile
Indicates if the file is meant to persist between sessions / ignition cycles.
isSystemFile
Indicates if the file is meant to be passed through core to elsewhere in the system.
cb

Throws

putFileStream( String sPath, String sdlFileName, Integer iOffset, FileType fileType, Boolean bPersistentFile, Boolean bSystemFile, Integer iCorrelationID )

Deprecated
Used to push a stream of putfile RPC's containing binary data from a mobile device to the module. Responses are captured through callback on IProxyListener.

public com.smartdevicelink.proxy.RPCStreamController putFileStream(String sPath,String sdlFileName,Integer iOffset,FileType fileType,Boolean bPersistentFile,Boolean bSystemFile,Integer iCorrelationID) throws com.smartdevicelink.exception.SdlException

Parameters

sPath
- The physical file path on the mobile device.
sdlFileName
- The file reference name used by the putFile RPC.
iOffset
- The data offset in bytes, a value of zero is used to indicate data starting from the beginging of a file. A value greater than zero is used for resuming partial data chunks.
fileType
- The selected file type -- see the FileType enumeration for details
bPersistentFile
- Indicates if the file is meant to persist between sessions / ignition cycles.
bSystemFile
- Indicates if the file is meant to be passed thru core to elsewhere on the system.
iCorrelationID
- A unique ID that correlates each RPCRequest and RPCResponse.

Throws

putFileStream( String path, String fileName, Long offset, FileType fileType, Boolean isPersistentFile, Boolean isSystemFile, Boolean isPayloadProtected, Integer correlationId, OnPutFileUpdateListener cb )

Used to push a binary stream of file data onto the module from a mobile device. Responses are captured through callback on IProxyListener.

public com.smartdevicelink.proxy.RPCStreamController putFileStream(String path,String fileName,Long offset,FileType fileType,Boolean isPersistentFile,Boolean isSystemFile,Boolean isPayloadProtected,Integer correlationId,OnPutFileUpdateListener cb) throws com.smartdevicelink.exception.SdlException

Parameters

path
The physical file path on the mobile device.
fileName
The SDL file reference name used by the RPC.
offset
The data offset in bytes. A value of zero is used to indicate data starting from the beginning of the file and a value greater than zero is used for resuming partial data chunks.
fileType
The selected file type. See the {@link FileType} enum for details.
isPersistentFile
Indicates if the file is meant to persist between sessions / ignition cycles.
isSystemFile
Indicates if the file is meant to be passed through core to elsewhere in the system.
isPayloadProtected
correlationId
A unique id that correlates each RPCRequest and RPCResponse.
cb

Throws

putFileStream( InputStream is, String sdlFileName, Integer iOffset, Integer iLength, FileType fileType, Boolean bPersistentFile, Boolean bSystemFile, Integer iCorrelationID )

Deprecated
Used to push a stream of putfile RPC's containing binary data from a mobile device to the module. Responses are captured through callback on IProxyListener.

public com.smartdevicelink.proxy.RPCStreamController putFileStream(InputStream is,String sdlFileName,Integer iOffset,Integer iLength,FileType fileType,Boolean bPersistentFile,Boolean bSystemFile,Integer iCorrelationID) throws com.smartdevicelink.exception.SdlException

Parameters

is
- The input stream of byte data that putFileStream will read from.
sdlFileName
- The file reference name used by the putFile RPC.
iOffset
- The data offset in bytes, a value of zero is used to indicate data starting from the beginging of a file. A value greater than zero is used for resuming partial data chunks.
iLength
fileType
- The selected file type -- see the FileType enumeration for details
bPersistentFile
- Indicates if the file is meant to persist between sessions / ignition cycles.
bSystemFile
- Indicates if the file is meant to be passed thru core to elsewhere on the system.
iCorrelationID
- A unique ID that correlates each RPCRequest and RPCResponse.

Throws

putFileStream( InputStream inputStream, String fileName, Long offset, Long length, FileType fileType, Boolean isPersistentFile, Boolean isSystemFile, Boolean isPayloadProtected, Integer correlationId )

Used to push a binary stream of file data onto the module from a mobile device. Responses are captured through callback on IProxyListener.

public com.smartdevicelink.proxy.RPCStreamController putFileStream(InputStream inputStream,String fileName,Long offset,Long length,FileType fileType,Boolean isPersistentFile,Boolean isSystemFile,Boolean isPayloadProtected,Integer correlationId) throws com.smartdevicelink.exception.SdlException

Parameters

inputStream
The input stream of byte data that will be read from.
fileName
The SDL file reference name used by the RPC.
offset
The data offset in bytes. A value of zero is used to indicate data starting from the beginning of the file and a value greater than zero is used for resuming partial data chunks.
length
The total length of the file being sent.
fileType
The selected file type. See the {@link FileType} enum for details.
isPersistentFile
Indicates if the file is meant to persist between sessions / ignition cycles.
isSystemFile
Indicates if the file is meant to be passed through core to elsewhere in the system.
isPayloadProtected
correlationId
A unique id that correlates each RPCRequest and RPCResponse.

Throws

endPutFileStream()

Used to end an existing putFileStream that was previously initiated with any putFileStream method.

public void endPutFileStream()

putfile( String sdlFileName, FileType fileType, Boolean persistentFile, byte[] fileData, Integer correlationID )

Used to push a binary data onto the SDL module from a mobile device, such as icons and album art. Not supported on first generation SDL vehicles. Responses are captured through callback on IProxyListener.

public void putfile(String sdlFileName,FileType fileType,Boolean persistentFile,byte[] fileData,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

sdlFileName
-File reference name.
fileType
-Selected file type.
persistentFile
-Indicates if the file is meant to persist between sessions / ignition cycles.
fileData
byte array of data of the file that is to be sent
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

deletefile( String sdlFileName, Integer correlationID )

Used to delete a file resident on the SDL module in the app's local cache. Not supported on first generation SDL vehicles. Responses are captured through callback on IProxyListener.

public void deletefile(String sdlFileName,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

sdlFileName
-File reference name.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

listfiles( Integer correlationID )

Requests the current list of resident filenames for the registered app. Not supported on first generation SDL vehicles. Responses are captured through callback on IProxyListener.

public void listfiles(Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

setappicon( String sdlFileName, Integer correlationID )

Used to set existing local file on SDL as the app's icon. Not supported on first generation SDL vehicles. Responses are captured through callback on IProxyListener.

public void setappicon(String sdlFileName,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

sdlFileName
-File reference name.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

setdisplaylayout( String displayLayout, Integer correlationID )

Set an alternate display layout. If not sent, default screen for given platform will be shown. Responses are captured through callback on IProxyListener.

public void setdisplaylayout(String displayLayout,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

displayLayout
-Predefined or dynamically created screen layout.
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

setdisplaylayout( String displayLayout, TemplateColorScheme dayColorScheme, TemplateColorScheme nightColorScheme, Integer correlationID )

Set an alternate display layout. If not sent, default screen for given platform will be shown. Responses are captured through callback on IProxyListener.

public void setdisplaylayout(String displayLayout,TemplateColorScheme dayColorScheme,TemplateColorScheme nightColorScheme,Integer correlationID) throws com.smartdevicelink.exception.SdlException

Parameters

displayLayout
-Predefined or dynamically created screen layout.
dayColorScheme
a TemplateColorScheme object representing the colors that will be used for day color scheme
nightColorScheme
a TemplateColorScheme object representing the colors that will be used for night color scheme
correlationID
-A unique ID that correlates each RPCRequest and RPCResponse.

Throws

getSystemCapabilityManager()

Gets the SystemCapabilityManager.

public com.smartdevicelink.proxy.SystemCapabilityManager getSystemCapabilityManager()

isCapabilitySupported( SystemCapabilityType systemCapabilityType )

public boolean isCapabilitySupported(SystemCapabilityType systemCapabilityType)

Parameters

systemCapabilityType

getCapability( SystemCapabilityType systemCapabilityType, OnSystemCapabilityListener scListener )

public void getCapability(SystemCapabilityType systemCapabilityType,OnSystemCapabilityListener scListener)

Parameters

systemCapabilityType
scListener

getCapability( SystemCapabilityType systemCapabilityType )

public java.lang.Object getCapability(SystemCapabilityType systemCapabilityType)

Parameters

systemCapabilityType

addOnSystemCapabilityListener( SystemCapabilityType systemCapabilityType, OnSystemCapabilityListener listener )

Add a listener to be called whenever a new capability is retrieved

public void addOnSystemCapabilityListener(SystemCapabilityType systemCapabilityType,OnSystemCapabilityListener listener)

Parameters

systemCapabilityType
Type of capability desired
listener
callback to execute upon retrieving capability

removeOnSystemCapabilityListener( SystemCapabilityType systemCapabilityType, OnSystemCapabilityListener listener )

Remove an OnSystemCapabilityListener that was previously added

public boolean removeOnSystemCapabilityListener(SystemCapabilityType systemCapabilityType,OnSystemCapabilityListener listener)

Parameters

systemCapabilityType
Type of capability
listener
the listener that should be removed

getCurrentTransportType()

Gets type of transport currently used by this SdlProxy.

public com.smartdevicelink.transport.enums.TransportType getCurrentTransportType() throws java.lang.IllegalStateException

Throws

  • java.lang.IllegalStateException

setSdlSecurityClassList( java.util.List<java.lang.Class<? extends com.smartdevicelink.security.SdlSecurityBase>> list )

public void setSdlSecurityClassList(java.util.List<java.lang.Class<? extends com.smartdevicelink.security.SdlSecurityBase>> list)

Parameters

list

isServiceTypeProtected( SessionType sType )

public boolean isServiceTypeProtected(SessionType sType)

Parameters

sType

addServiceListener( SessionType serviceType, ISdlServiceListener sdlServiceListener )

public void addServiceListener(SessionType serviceType,ISdlServiceListener sdlServiceListener)

Parameters

serviceType
sdlServiceListener

removeServiceListener( SessionType serviceType, ISdlServiceListener sdlServiceListener )

public void removeServiceListener(SessionType serviceType,ISdlServiceListener sdlServiceListener)

Parameters

serviceType
sdlServiceListener

getAcceptedVideoParams()

public com.smartdevicelink.streaming.video.VideoStreamingParameters getAcceptedVideoParams()

getProxyListener()

public com.smartdevicelink.proxy.interfaces.IProxyListenerBase getProxyListener()

getAppName()

public java.lang.String getAppName()

getNgnAppName()

public java.lang.String getNgnAppName()

getAppID()

public java.lang.String getAppID()

getDeviceInfo()

public com.smartdevicelink.proxy.rpc.DeviceInfo getDeviceInfo()

getInstanceDT()

public long getInstanceDT()

setConnectionDetails( String sDetails )

public void setConnectionDetails(String sDetails)

Parameters

sDetails

getConnectionDetails()

public java.lang.String getConnectionDetails()

setPoliciesURL( String sText )

public void setPoliciesURL(String sText)

Parameters

sText

getPoliciesURL()

public java.lang.String getPoliciesURL()

getIconResumed()

Tells developer whether or not their app icon has been resumed on core.

public boolean getIconResumed() throws com.smartdevicelink.exception.SdlException

Throws

Inherited Methods

From Class Methods
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section