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

Class SdlManager

Hierarchy

java.lang.Object

Package
com.smartdevicelink.managers

Overview

SDLManager
This is the main point of contact between an application and SDL
It is broken down to these areas:
1. SDLManagerBuilder
2. ISdl Interface along with its overridden methods - This can be passed into attached managers
3. Sending Requests
4. Helper methods

Constructors

SdlManager()

public SdlManager()

Methods

initialize()

protected void initialize()

getState()

Get the current state for the SdlManager

public int getState()

transitionToState( int state )

protected void transitionToState(int state)

Parameters

state

dispose()

public void dispose()

getPermissionManager()

Gets the PermissionManager.
Note: PermissionManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.

public com.smartdevicelink.managers.permission.PermissionManager getPermissionManager()

getFileManager()

Gets the FileManager.
Note: FileManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.

public com.smartdevicelink.managers.file.FileManager getFileManager()

getVideoStreamManager()

Gets the VideoStreamManager.
The VideoStreamManager returned will only be not null if the registered app type is either NAVIGATION or PROJECTION. Once the VideoStreamManager is retrieved, its start() method will need to be called before use.

Note: VideoStreamManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.

public com.smartdevicelink.managers.video.VideoStreamManager getVideoStreamManager()

getAudioStreamManager()

Gets the AudioStreamManager.
The AudioStreamManager returned will only be not null if the registered app type is either NAVIGATION or PROJECTION. Once the AudioStreamManager is retrieved, its start() method will need to be called before use.
Note: AudioStreamManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.

public com.smartdevicelink.managers.audio.AudioStreamManager getAudioStreamManager()

getScreenManager()

Gets the ScreenManager.
Note: ScreenManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.

public com.smartdevicelink.managers.screen.ScreenManager getScreenManager()

getLockScreenManager()

Gets the LockScreenManager.
Note: LockScreenManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.

public com.smartdevicelink.managers.lockscreen.LockScreenManager getLockScreenManager()

getSystemCapabilityManager()

Gets the SystemCapabilityManager.
Note: SystemCapabilityManager should be used only after SdlManager.start() CompletionListener callback is completed successfully.

public com.smartdevicelink.proxy.SystemCapabilityManager getSystemCapabilityManager()

getAppName()

protected java.lang.String getAppName()

getAppId()

protected java.lang.String getAppId()

getShortAppName()

protected java.lang.String getShortAppName()

getHmiLanguage()

protected com.smartdevicelink.proxy.rpc.enums.Language getHmiLanguage()

getDayColorScheme()

protected com.smartdevicelink.proxy.rpc.TemplateColorScheme getDayColorScheme()

getNightColorScheme()

protected com.smartdevicelink.proxy.rpc.TemplateColorScheme getNightColorScheme()

getAppTypes()

protected java.util.Vector getAppTypes()

getVrSynonyms()

protected java.util.Vector getVrSynonyms()

getTtsChunks()

protected java.util.Vector getTtsChunks()

getTransport()

protected com.smartdevicelink.transport.BaseTransportConfig getTransport()

getLockScreenConfig()

protected com.smartdevicelink.managers.lockscreen.LockScreenConfig getLockScreenConfig()

sendRPC( RPCMessage message )

Send RPC Message
Note: Only takes type of RPCRequest for now, notifications and responses will be thrown out

public void sendRPC(RPCMessage message)

Parameters

message
RPCMessage

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

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

Takes a list of RPCMessages and sends it to SDL. Responses are captured through callback on OnMultipleRequestListener. For sending requests synchronously, use sendSequentialRPCs
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 sendRPCs(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

public void addOnRPCNotificationListener(FunctionID notificationId,OnRPCNotificationListener listener)

Parameters

notificationId
listener
listener that will be called when a notification is received

removeOnRPCNotificationListener( FunctionID notificationId, OnRPCNotificationListener listener )

Remove an OnRPCNotificationListener

public void removeOnRPCNotificationListener(FunctionID notificationId,OnRPCNotificationListener listener)

Parameters

notificationId
listener
listener that was previously added

start()

Starts up a SdlManager, and calls provided callback called once all BaseSubManagers are done setting up

public void start()

setProxy( com.smartdevicelink.proxy.SdlProxyBase proxy )

protected void setProxy(com.smartdevicelink.proxy.SdlProxyBase proxy)

Parameters

proxy

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