Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
ISdl

Interface ISdl

Package
com.smartdevicelink.managers

Methods

start()

Starts the connection with the module

public void start()

stop()

Ends connection with the module

public void stop()

isConnected()

Method to check if the session is connected

public boolean isConnected()

addServiceListener( SessionType serviceType, ISdlServiceListener sdlServiceListener )

Add a service listener for a specific service type

public void addServiceListener(SessionType serviceType,ISdlServiceListener sdlServiceListener)

Parameters

serviceType
service type that the listener will be attached to
sdlServiceListener
listener for events that happen to the service

removeServiceListener( SessionType serviceType, ISdlServiceListener sdlServiceListener )

Remote a service listener for a specific service type

public void removeServiceListener(SessionType serviceType,ISdlServiceListener sdlServiceListener)

Parameters

serviceType
service type that the listener was attached to
sdlServiceListener
service listener that was previously added for the service type

startVideoService( VideoStreamingParameters parameters, boolean encrypted )

Starts the video streaming service

public void startVideoService(VideoStreamingParameters parameters,boolean encrypted)

Parameters

parameters
desired video streaming params for this service to be started with
encrypted
flag to start this service with encryption or not

startAudioService( boolean encrypted )

Starts the Audio streaming service

public void startAudioService(boolean encrypted)

Parameters

encrypted
flag to start this service with encryption or not

sendRPC( RPCMessage message )

Pass an RPC message through the proxy to be sent to the connected module

public void sendRPC(RPCMessage message)

Parameters

message
RPCMessage that should be sent to the module

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

Pass a list of RPC messages through the proxy to be sent to core

public void sendRPCs(java.util.List<? extends com.smartdevicelink.proxy.RPCMessage> rpcs,OnMultipleRequestListener listener)

Parameters

rpcs
List of RPC messages
listener
OnMultipleRequestListener that is called between requests and after all are processed

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

Takes a list of RPCMessages 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
ADDITIONAL NOTE: This only takes the type of RPCRequest for now, notifications and responses will be thrown out

public void sendSequentialRPCs(java.util.List<? extends com.smartdevicelink.proxy.RPCMessage> rpcs,OnMultipleRequestListener listener)

Parameters

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

addOnRPCNotificationListener( FunctionID notificationId, OnRPCNotificationListener listener )

Add an OnRPCNotificationListener for specified notification

public void addOnRPCNotificationListener(FunctionID notificationId,OnRPCNotificationListener listener)

Parameters

notificationId
FunctionID of the notification that is to be listened for
listener
listener that should be added for the notification ID

removeOnRPCNotificationListener( FunctionID notificationId, OnRPCNotificationListener listener )

Removes an OnRPCNotificationListener for specified notification

public boolean removeOnRPCNotificationListener(FunctionID notificationId,OnRPCNotificationListener listener)

Parameters

notificationId
FunctionID of the notification that was to be listened for
listener
listener that was previously added for the notification ID

addOnRPCRequestListener( FunctionID functionID, OnRPCRequestListener listener )

Add an OnRPCRequestListener for specified request

public void addOnRPCRequestListener(FunctionID functionID,OnRPCRequestListener listener)

Parameters

functionID
FunctionID of the request that is to be listened for
listener
listener that should be added for the request ID

removeOnRPCRequestListener( FunctionID functionID, OnRPCRequestListener listener )

Removes an OnRPCRequestListener for specified request

public boolean removeOnRPCRequestListener(FunctionID functionID,OnRPCRequestListener listener)

Parameters

functionID
FunctionID of the request that was to be listened for
listener
listener that was previously added for the request ID

addOnRPCListener( FunctionID responseId, OnRPCListener listener )

Add an OnRPCResponseListener for specified response

public void addOnRPCListener(FunctionID responseId,OnRPCListener listener)

Parameters

responseId
FunctionID of the response that is to be listened for
listener
listener that should be added for the response ID

removeOnRPCListener( FunctionID responseId, OnRPCListener listener )

Removes an OnRPCResponseListener for specified response

public boolean removeOnRPCListener(FunctionID responseId,OnRPCListener listener)

Parameters

responseId
FunctionID of the response that was to be listened for
listener
listener that was previously added for the response ID

getRegisterAppInterfaceResponse()

Get RegisterAppInterfaceResponse

public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse getRegisterAppInterfaceResponse()

isTransportForServiceAvailable( SessionType serviceType )

Check to see if a transport is available to start/use the supplied service.

public boolean isTransportForServiceAvailable(SessionType serviceType)

Parameters

serviceType
the session that should be checked for transport availability

getSdlMsgVersion()

Get the RPC specification version currently being used for the SDL messages

public com.smartdevicelink.proxy.rpc.SdlMsgVersion getSdlMsgVersion()

getProtocolVersion()

Get the protocol version of this session

public com.smartdevicelink.util.Version getProtocolVersion()

startRPCEncryption()

Start encrypted RPC service

public void startRPCEncryption()

getTaskmaster()

public Taskmaster getTaskmaster()

getSystemCapabilityManager()

public SystemCapabilityManager getSystemCapabilityManager()
View on GitHub.com
Previous Section Next Section