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

Interface ISdl

Package
com.smartdevicelink.proxy.interfaces

Quick Jump

Methods

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 sevice to be started with
encrypted
flag to start this service with encryption or not

stopVideoService()

Stops the video service if open

public void stopVideoService()

startVideoStream( boolean isEncrypted, VideoStreamingParameters parameters )

Starts the video streaming service

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

Parameters

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

startAudioService( boolean encrypted, AudioStreamingCodec codec, AudioStreamingParams params )

Starts the Audio streaming service

public void startAudioService(boolean encrypted,AudioStreamingCodec codec,AudioStreamingParams params)

Parameters

encrypted
flag to start this service with encryption or not
codec
params

startAudioService( boolean encrypted )

Starts the Audio streaming service

public void startAudioService(boolean encrypted)

Parameters

encrypted
flag to start this service with encryption or not

stopAudioService()

Stops the audio service if open

public void stopAudioService()

startAudioStream( boolean isEncrypted, AudioStreamingCodec codec, AudioStreamingParams params )

Start Audio Stream and return IAudioStreamListener

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

Parameters

isEncrypted
codec
params

sendRPCRequest( RPCRequest message )

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

public void sendRPCRequest(RPCRequest message)

Parameters

message
RPCRequest that should be sent to the module

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

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

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

Parameters

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

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

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

getCapability( SystemCapabilityType systemCapabilityType )

Get SystemCapability Object

public java.lang.Object getCapability(SystemCapabilityType systemCapabilityType)

Parameters

systemCapabilityType

getCapability( SystemCapabilityType systemCapabilityType, OnSystemCapabilityListener scListener )

Get Capability

public void getCapability(SystemCapabilityType systemCapabilityType,OnSystemCapabilityListener scListener)

Parameters

systemCapabilityType
scListener

isCapabilitySupported( SystemCapabilityType systemCapabilityType )

Check if capability is supported

public boolean isCapabilitySupported(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

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()
View on GitHub.com
Previous Section Next Section