SDL Logo
Expand
Minimize
Picture-in-picture
Power
Device Status
Voice Recognition
Skip Back
Skip Forward
Minus
Plus
Play
Search
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.
tool.
US
JP
About SDL
Overview
SmartDeviceLink Consortium
SDLC Members
Frequently Asked Questions
App Catalog
Case Studies
Documentation
SDL Overview Guides
Android Guides
iOS Guides
JavaSE Guides
JavaEE Guides
JavaScript Suite Guides
SDL Core Guides
SDL Server Guides
SHAID Documentation
Licensing
Resources
Manticore
Events
News
US
JP
Documentation
About SDL
Documentation
Resources
Manticore
Events
News
Sign In
SDL Overview Guides
Android Guides
iOS Guides
JavaSE Guides
JavaEE Guides
JavaScript Suite Guides
SDL Core Guides
SDL Server Guides
SHAID Documentation
Licensing
About SDL
About SDL
Overview
SmartDeviceLink Consortium
SDLC Members
Frequently Asked Questions
App Catalog
Case Studies
Resources
Manticore
Events
News
Docs
SDL Overview Guides
Android Guides
iOS Guides
JavaSE Guides
JavaEE Guides
JavaScript Suite Guides
SDL Core Guides
SDL Server Guides
SHAID Documentation
Licensing
Sign In
Table of Contents
icon-arrow-down-dark-svg
To Top
Created with Sketch.
To Top
To Bottom
Created with Sketch.
To Bottom
Android Documentation
Getting Started
Installation
SDK Configuration
Integration Basics - Java
Connecting to an Infotainment System
Adding the Lock Screen
Using AOA Protocol
Multiple Transports
Adapting to the Head Unit Language
Understanding Permissions
Checking Supported Features
Setting Security Level for Multiplexing
Proguard Guidelines
Example Apps
Displaying a User Interface
Adaptive Interface Capabilities
Main Screen Templates
Template Text
Template Images
Template Custom Buttons
Template Subscription Buttons
Main Menu
Popup Menus
Popup Keyboards
Alerts and Subtle Alerts
Media Clock
Slider
Scrollable Message
Customizing Look and Functionality
Customizing the Template
Customizing the Keyboard
Customizing Help Prompts
Speech and Audio
Playing Spoken Feedback
Playing Audio Indications
Setting Up Voice Commands
Getting Microphone Audio
Other SDL Features
Batch Sending RPCs
Retrieving Vehicle Data
Remote Control Vehicle Features
Creating an App Service
Using App Services
Calling a Phone Number
Setting the Navigation Destination
Getting the Navigation Destination
Uploading Files
Uploading Images
Creating an OEM Cloud App Store
Encryption
OEM Exclusive Apps
Video Streaming for Navigation Apps
Introduction
Video Streaming - Java
Audio Streaming
Supporting Haptic Input
Displaying Turn Directions
Menus
Developer Tools
Configuring SDL Logging
Migrating to Newer SDL Java Suite Versions
Updating to v4.4
Updating to v4.5
Updating to v4.6
Updating to v4.7
Updating to v4.9
Updating to v5.0
Updating to v5.1
Updating to v5.4
Updating to v5.6
Updating to v5.7
Frequently Asked Questions
Kotlin Support
SDL Notifications
Trusted Router Service
Multiple Processes
API Reference Documentation
A - C
AbstractPacketizer
AddCommand
AddCommandResponse
AddSubMenu
AddSubMenuResponse
AirbagStatus
Alert
AlertAudioData
AlertCanceledListener
AlertCompletionListener
AlertManeuver
AlertManeuverResponse
AlertResponse
AlertView
AlertView.Builder
AmbientLightStatus
AndroidTools
AppCapability
AppCapabilityType
AppHMIType
AppInfo
AppInterfaceUnregisteredReason
AppServiceCapability
AppServiceData
AppServiceManifest
AppServiceRecord
AppServiceType
AppServicesCapabilities
AudioControlCapabilities
AudioControlData
AudioData
AudioDecoder
AudioDecoderCompat
AudioDecoderListener
AudioPassThruCapabilities
AudioStreamManager
AudioStreamManager.SampleType
AudioStreamingCodec
AudioStreamingIndicator
AudioStreamingLPCMParams
AudioStreamingLPCMParams.SampleFormat
AudioStreamingParams
AudioStreamingState
AudioType
BaseAudioDecoder
BaseSdlManagerListener
BaseSdlSession
BaseSubManager
BaseTransportConfig
BeltStatus
BinaryFrameHeader
BitConverter
BitsPerSample
BodyInformation
ButtonCapabilities
ButtonEventMode
ButtonName
ButtonPress
ButtonPressMode
ButtonPressResponse
ByteAraryMessageAssembler
ByteArrayMessageSpliter
ByteEnumer
CancelInteraction
CancelInteractionResponse
CapacityUnit
CarModeStatus
ChangeRegistration
ChangeRegistrationResponse
CharacterSet
Choice
ChoiceCell
ChoiceSet
ChoiceSetLayout
ChoiceSetManager
ChoiceSetSelectionListener
ClimateControlCapabilities
ClimateControlData
ClimateData
CloseApplication
CloseApplicationResponse
CloudAppProperties
ClusterModeStatus
CompareUtils
CompassDirection
CompletionListener
ComponentVolumeStatus
ControlFrameTags
ControlFrameTags.Audio
ControlFrameTags.Audio.EndService
ControlFrameTags.Audio.EndServiceACK
ControlFrameTags.Audio.EndServiceNAK
ControlFrameTags.Audio.StartService
ControlFrameTags.Audio.StartServiceACK
ControlFrameTags.Audio.StartServiceNAK
ControlFrameTags.RPC
ControlFrameTags.RPC.EndService
ControlFrameTags.RPC.EndServiceACK
ControlFrameTags.RPC.EndServiceNAK
ControlFrameTags.RPC.RegisterSecondaryTransport
ControlFrameTags.RPC.RegisterSecondaryTransportACK
ControlFrameTags.RPC.RegisterSecondaryTransportNAK
ControlFrameTags.RPC.StartService
ControlFrameTags.RPC.StartServiceACK
ControlFrameTags.RPC.StartServiceNAK
ControlFrameTags.RPC.TransportEventUpdate
ControlFrameTags.Video
ControlFrameTags.Video.EndService
ControlFrameTags.Video.EndServiceACK
ControlFrameTags.Video.EndServiceNAK
ControlFrameTags.Video.StartService
ControlFrameTags.Video.StartServiceACK
ControlFrameTags.Video.StartServiceNAK
Coordinate
CorrelationIdGenerator
CreateInteractionChoiceSet
CreateInteractionChoiceSetResponse
CreateWindow
CreateWindowResponse
D - F
DIDResult
DTC
DateTime
DebugTool
DefrostZone
DeleteCommand
DeleteCommandResponse
DeleteFile
DeleteFileResponse
DeleteInteractionChoiceSet
DeleteInteractionChoiceSetResponse
DeleteSubMenu
DeleteSubMenuResponse
DeleteWindow
DeleteWindowResponse
DeliveryMode
DetailLevel
DeviceInfo
DeviceLevelStatus
DeviceStatus
DiagLevel
DiagnosticMessage
DiagnosticMessageResponse
DialNumber
DialNumberResponse
Dimension
Direction
DisplayCapabilities
DisplayCapability
DisplayMode
DisplayType
DistanceUnit
DoorStatus
DoorStatusType
Drawable2d
Drawable2d.Prefab
DriverDistractionCapability
DriverDistractionState
DynamicMenuUpdatesMode
DynamicUpdateCapabilities
ECallConfirmationStatus
ECallInfo
EglCore
EglSurfaceBase
ElectronicParkBrakeStatus
EmergencyEvent
EmergencyEventType
EncoderUtils
EndAudioPassThru
EndAudioPassThruResponse
EqualizerSettings
FileManager
FileManagerConfig
FileType
FileUtls
FrameDataControlFrameType
FrameType
FuelCutoffStatus
FuelRange
FuelType
FullFrameRect
FunctionID
G - I
GPSData
GateStatus
GearStatus
GenericResponse
GetAppServiceData
GetAppServiceDataResponse
GetCloudAppProperties
GetCloudAppPropertiesResponse
GetDTCs
GetDTCsResponse
GetFile
GetFileResponse
GetInteriorVehicleData
GetInteriorVehicleDataConsent
GetInteriorVehicleDataConsentResponse
GetInteriorVehicleDataResponse
GetSystemCapability
GetSystemCapabilityResponse
GetVehicleData
GetVehicleDataResponse
GetWayPoints
GetWayPointsResponse
GlUtil
GlobalProperty
Grid
HMICapabilities
HMILevel
HMIPermissions
HMISettingsControlCapabilities
HMISettingsControlData
HapticRect
HeadLampStatus
Headers
HeartbeatMonitor
HmiZoneCapabilities
HttpRequestTask
HttpRequestTask.HttpRequestTaskCallback
HybridAppPreference
IAudioStreamListener
IConsole
IHeartbeatMonitor
IHeartbeatMonitorListener
ISTListener
ISdl
ISdlProtocol
ISdlServiceListener
ISdlSessionListener
ISecondaryTransportListener
ISecurityInitializedListener
IStreamListener
IVideoStreamListener
IgnitionStableStatus
IgnitionStatus
Image
ImageField
ImageFieldName
ImageResolution
ImageResolutionKind
ImageType
IntegrationValidator
IntegrationValidator.ValidationResult
InteractionMode
InterfaceActivityDirection
J - L
Jingle
JsonRPCMarshaller
KeyboardAutocompleteCompletionListener
KeyboardCapabilities
KeyboardCharacterSetCompletionListener
KeyboardEvent
KeyboardInputMask
KeyboardLayout
KeyboardLayoutCapability
KeyboardListener
KeyboardProperties
KeypressMode
Language
LayoutMode
LifecycleConfigurationUpdate
LifecycleManager
LightCapabilities
LightControlCapabilities
LightControlData
LightName
LightState
LightStatus
ListFiles
ListFilesResponse
LocationDetails
LockScreenConfig
LockScreenConfig.DisplayMode
LockScreenManager
LockScreenStatus
Log
M - O
MaintenanceModeStatus
ManagerUtility
ManagerUtility.WindowCapabilityUtility
MassageCushion
MassageCushionFirmness
MassageMode
MassageModeData
MassageZone
MediaClockFormat
MediaServiceData
MediaServiceManifest
MediaStreamingStatus
MediaStreamingStatus.Callback
MediaType
MenuCell
MenuConfiguration
MenuLayout
MenuManager
MenuParams
MenuSelectionListener
MessageType
MessageType
MetadataTags
MetadataType
Mime
Mod
ModuleData
ModuleInfo
ModuleType
MultipleFileCompletionListener
MultiplexBaseTransport
MultiplexBluetoothTransport
MultiplexTcpTransport
MultiplexTransportConfig
MultiplexTransportConfig.TransportListener
MultiplexUsbTransport
MyKey
NativeLogTool
NativeLogTool.LogTarget
NavigationAction
NavigationCapability
NavigationInstruction
NavigationJunction
NavigationServiceData
NavigationServiceManifest
OasisAddress
OffscreenSurface
OnAppCapabilityUpdated
OnAppInterfaceUnregistered
OnAppServiceData
OnAudioPassThru
OnButtonEvent
OnButtonListener
OnButtonPress
OnCommand
OnDriverDistraction
OnHMIStatus
OnHashChange
OnInteriorVehicleData
OnKeyboardInput
OnLanguageChange
OnMultipleRequestListener
OnPermissionChangeListener
OnPermissionsChange
OnRCStatus
OnRPCListener
OnRPCNotificationListener
OnRPCRequestListener
OnRPCResponseListener
OnSubtleAlertPressed
OnSystemCapabilityListener
OnSystemCapabilityUpdated
OnSystemRequest
OnTBTClientState
OnTouchEvent
OnUpdateFile
OnUpdateSubMenu
OnVehicleData
OnWayPointChange
P - R
PRNDL
ParameterPermissions
PerformAppServiceInteraction
PerformAppServiceInteractionResponse
PerformAudioPassThru
PerformAudioPassThruResponse
PerformInteraction
PerformInteractionResponse
PermissionElement
PermissionItem
PermissionManager
PermissionStatus
PermissionStatus
PhoneCapability
PowerModeQualificationStatus
PowerModeStatus
PredefinedLayout
PredefinedWindows
PrerecordedSpeech
PresentAlertOperation
PresetBankCapabilities
PrimaryAudioSource
ProtocolMessage
PublishAppService
PublishAppServiceResponse
PutFile
PutFileResponse
RGBColor
RPCMessage
RPCNotification
RPCRequest
RPCResponse
RPCStruct
RTPH264Packetizer
RadioBand
RadioControlCapabilities
RadioControlData
RadioState
RdsData
ReadDID
ReadDIDResponse
Rectangle
RegisterAppInterface
RegisterAppInterfaceResponse
ReleaseInteriorVehicleDataModule
ReleaseInteriorVehicleDataModuleResponse
RemoteControlCapabilities
RequestType
ResetGlobalProperties
ResetGlobalPropertiesResponse
Resolution
Result
RoofStatus
RouterServiceMessageEmitter
RouterServiceMessageEmitter.Callback
RouterServiceValidator
RouterServiceValidator.SdlApp
RouterServiceValidator.TrustedAppStore
RouterServiceValidator.TrustedListCallback
RpcConverter
S - U
SDLLockScreenActivity
SampleBuffer
SamplingRate
ScreenManager
ScreenParams
ScrollableMessage
ScrollableMessageResponse
SdlAppInfo
SdlAppInfo.BestRouterComparator
SdlArtwork
SdlBroadcastReceiver
SdlDataTypeConverter
SdlDeviceListener
SdlDeviceListener.Callback
SdlDisconnectedReason
SdlEncoder
SdlException
SdlExceptionCause
SdlFile
SdlInterfaceAvailability
SdlManager
SdlManager.Builder
SdlManagerListener
SdlMsgVersion
SdlPacket
SdlPacketFactory
SdlProtocol
SdlProtocolBase
SdlProtocolBase.MessageFrameAssembler
SdlPsm
SdlRemoteDisplay
SdlRemoteDisplay.Callback
SdlRemoteDisplay.Creator
SdlRouterService
SdlRouterService.PacketWriteTask
SdlRouterStatusProvider
SdlRouterStatusProvider.ConnectedStatusCallback
SdlSecurityBase
SdlSession
SdlTrace
SeatControlCapabilities
SeatControlData
SeatLocation
SeatLocationCapability
SeatMemoryAction
SeatMemoryActionType
SeatOccupancy
SeatStatus
SecurityQueryErrorCode
SecurityQueryID
SecurityQueryPayload
SecurityQueryType
SeekIndicatorType
SeekStreamingIndicator
SendHapticData
SendHapticDataResponse
SendLocation
SendLocationResponse
ServiceEncryptionListener
ServiceFinder
ServiceFinder.ServiceFinderCallback
ServiceUpdateReason
SessionType
SetAppIcon
SetAppIconResponse
SetCloudAppProperties
SetCloudAppPropertiesResponse
SetDisplayLayout
SetDisplayLayoutResponse
SetGlobalProperties
SetGlobalPropertiesResponse
SetInteriorVehicleData
SetInteriorVehicleDataResponse
SetMediaClockTimer
SetMediaClockTimerResponse
Show
ShowAppMenu
ShowAppMenuResponse
ShowConstantTbt
ShowConstantTbtResponse
ShowResponse
SingleTireStatus
SiphonServer
SisData
Slider
SliderResponse
SoftButton
SoftButtonCapabilities
SoftButtonObject
SoftButtonObject.OnEventListener
SoftButtonState
SoftButtonType
Speak
SpeakResponse
SpeechCapabilities
StabilityControlsStatus
StartTime
StaticIconName
StationIDNumber
StreamPacketizer
StreamingStateMachine
StreamingStateMachine.StreamingState
SubscribeButton
SubscribeButtonResponse
SubscribeVehicleData
SubscribeVehicleDataResponse
SubscribeWayPoints
SubscribeWayPointsResponse
SubtleAlert
SubtleAlertResponse
SupportedSeat
SystemAction
SystemCapability
SystemCapabilityManager
SystemCapabilityType
SystemContext
SystemInfo
SystemRequest
SystemRequestResponse
TBTState
TCPTransportConfig
TCPTransportManager
TCPTransportManager.TCPHandler
TPMS
TTSChunk
Temperature
TemperatureUnit
TemplateColorScheme
TemplateConfiguration
TextAlignment
TextField
TextFieldName
Texture2dProgram
Texture2dProgram.ProgramType
TimerMode
TireStatus
TouchCoord
TouchEvent
TouchEventCapabilities
TouchType
TraceDeviceInfo
TransmissionType
TransportBroker
TransportConstants
TransportConstants.RouterServiceVersions
TransportManager
TransportManager.LegacyBluetoothHandler
TransportManager.TransportBrokerImpl
TransportManagerBase
TransportManagerBase.TransportEventListener
TransportRecord
TransportType
TriggerSource
Turn
TurnSignal
USBAccessoryAttachmentActivity
UnpublishAppService
UnpublishAppServiceResponse
UnregisterAppInterface
UnregisterAppInterfaceResponse
UnsubscribeButton
UnsubscribeButtonResponse
UnsubscribeVehicleData
UnsubscribeVehicleDataResponse
UnsubscribeWayPoints
UnsubscribeWayPointsResponse
UpdateMode
UpdateTurnList
UpdateTurnListResponse
UsbTransferProvider
UsbTransferProvider.UsbTransferCallback
V - Z
VehicleDataActiveStatus
VehicleDataEventStatus
VehicleDataNotificationStatus
VehicleDataResult
VehicleDataResultCode
VehicleDataStatus
VehicleDataType
VehicleType
VentilationMode
Version
VideoStreamManager
VideoStreamingCapability
VideoStreamingCodec
VideoStreamingFormat
VideoStreamingParameters
VideoStreamingProtocol
VideoStreamingRange
VideoStreamingState
VirtualDisplayEncoder
VoiceCommand
VoiceCommandManager
VoiceCommandSelectionListener
VrCapabilities
VrHelpItem
WarningLightStatus
WayPointType
WeatherAlert
WeatherData
WeatherServiceData
WeatherServiceManifest
WiFiSocketFactory
WindowCapability
WindowState
WindowStatus
WindowSurface
WindowType
WindowTypeCapabilities
WiperStatus
AudioStreamManager.SampleType
AudioStreamManager.SampleType
Quick Jump
View on GitHub.com
Previous Section
Next Section