| Class | Description |
|---|---|
| AddCommand |
This class will add a command to the application's Command Menu
|
| AddCommandResponse |
Add Command Response is sent, when AddCommand has been called
|
| AddSubMenu |
Add a SubMenu to the Command Menu
|
| AddSubMenuResponse |
Add SubMenu Response is sent, when AddSubMenu has been called
|
| AirbagStatus |
The status of the air bags.
|
| Alert |
Provides information to the user using either TTS, the Display or both and
can include a system-generated alert tone.
|
| AlertManeuver |
This will bring up an alert with information related to the next navigation maneuver including potential voice
navigation instructions.
|
| AlertManeuverResponse |
Alert Maneuver Response is sent, when AlertManeuver has been called
|
| AlertResponse |
Alert Response is sent, when Alert has been called
|
| AppCapability |
Parameter List
|
| AppInfo |
Contains detailed information about the registered application.
|
| AppServiceCapability | |
| AppServiceData |
Contains all the current data of the app service.
|
| AppServiceManifest |
This manifest contains all the information necessary for the service to be
published, activated, and allow consumers to interact with it
|
| AppServiceRecord |
This manifest contains all the information necessary for the
service to be published, activated, and consumers able to interact with it
|
| AppServicesCapabilities |
Capabilities of app services including what service types are supported
and the current state of services.
|
| AudioControlCapabilities | |
| AudioControlData | |
| AudioPassThruCapabilities |
Describes different audio type configurations for PerformAudioPassThru, e.g.
|
| BeltStatus |
The status of the seat belts.
|
| BodyInformation |
The body information including power modes.
|
| ButtonCapabilities |
Provides information about the capabilities of a SDL HMI button.
|
| ButtonPress |
This function allows a remote control type mobile application
simulate a hardware button press event.
|
| ButtonPressResponse | |
| CancelInteraction | |
| CancelInteractionResponse |
Response to the request to dismiss a modal view.
|
| ChangeRegistration |
If the app recognizes during the app registration that the SDL HMI language
(voice/TTS and/or display) does not match the app language, the app will be
able (but does not need) to change this registration with changeRegistration
prior to app being brought into focus.
|
| ChangeRegistrationResponse |
Change Registration Response is sent, when ChangeRegistration has been called
|
| Choice |
A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.
|
| ClimateControlCapabilities |
Contains information about a climate control module's capabilities.
|
| ClimateControlData | |
| ClimateData |
Parameter List
|
| CloseApplication |
Used by an app to set itself to a `HMILevel` of `NONE`.
|
| CloseApplicationResponse |
Response to the request to close this app on the module.
|
| CloudAppProperties |
Properties that relate to a a cloud app entry.
|
| ClusterModeStatus |
The status modes of the instrument panel cluster.
|
| Coordinate | |
| CreateInteractionChoiceSet |
Creates a Choice Set which can be used in subsequent
PerformInteraction Operations.
|
| CreateInteractionChoiceSetResponse |
Create Interaction ChoiceSet Response is sent, when CreateInteractionChoiceSet
has been called
|
| CreateWindow |
The RPC CreateWindow allows an app to create a new window on the display.
|
| CreateWindowResponse |
This RCP creates a window, by default the main is 0.
|
| DateTime | |
| DeleteCommand |
Removes a command from the Command Menu.
|
| DeleteCommandResponse |
Delete Command Response is sent, when DeleteCommand has been called.
|
| DeleteFile |
Used to delete a file resident on the SDL module in the app's local cache.
|
| DeleteFileResponse |
Delete File Response is sent, when DeleteFile has been called
|
| DeleteInteractionChoiceSet |
Deletes an existing Choice Set identified by the parameter
interactionChoiceSetID.
|
| DeleteInteractionChoiceSetResponse |
Delete Interaction ChoiceSet Response is sent, when DeleteInteractionChoiceSet has been called
|
| DeleteSubMenu |
Deletes a submenu from the Command Menu.
|
| DeleteSubMenuResponse |
Delete SubMenu Response is sent, when DeleteSubMenu has been called
|
| DeleteWindow |
This RPC deletes the window created by the CreateWindow RPC
|
| DeleteWindowResponse |
This RPC is the response of the DeleteWindow RPC
|
| DeviceInfo |
Various information about connecting device.
|
| DeviceStatus |
Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.
|
| DiagnosticMessage |
Non periodic vehicle diagnostic request.
|
| DiagnosticMessageResponse |
Diagnostic Message Response is sent, when DiagnosticMessage has been called.
|
| DialNumber |
Dials a phone number and switches to phone application.
|
| DialNumberResponse |
Dial Number Response is sent, when DialNumber has been called
|
| DIDResult |
Individual requested DID result and data.
|
| DisplayCapabilities |
Contains information about the display for the SDL system to which the application is currently connected.
|
| DisplayCapability |
Contain the display related information and all windows related to that display.
|
| DoorStatus |
Describes the status of a parameter of door.
|
| DriverDistractionCapability |
Parameter List
|
| DTC |
String containing hexadecimal identifier as well as other common names.
|
| DynamicUpdateCapabilities |
Parameter List
|
| ECallInfo |
Emergency Call notification and confirmation data.
|
| EmergencyEvent |
Information related to an emergency event (and if it occurred).
|
| EndAudioPassThru |
When this request is invoked, the audio capture stops
|
| EndAudioPassThruResponse |
End Audio Pass Thru Response is sent, when EndAudioPassThru has been called
|
| EqualizerSettings |
Defines the each Equalizer channel settings.
|
| FuelRange |
Parameter List
|
| GateStatus |
Describes the status of a parameter of trunk/hood/etc.
|
| GearStatus |
Parameter List
|
| GenericResponse |
Generic Response is sent, when the name of a received msg cannot be
retrieved.
|
| GetAppServiceData |
This request asks the module for current data related to the specific service.
|
| GetAppServiceDataResponse |
This response includes the data that was requested from the specific service
|
| GetCloudAppProperties | |
| GetCloudAppPropertiesResponse | |
| GetDTCs |
This RPC allows to request diagnostic module trouble codes from a certain
vehicle module.
|
| GetDTCsResponse |
Get DTCs Response is sent, when GetDTCs has been called
|
| GetFile |
This request is sent to the module to retrieve a file
|
| GetFileResponse | |
| GetInteriorVehicleData |
Read the current status value of specified remote control module (type).
|
| GetInteriorVehicleDataConsent | |
| GetInteriorVehicleDataConsentResponse | |
| GetInteriorVehicleDataResponse | |
| GetSystemCapability |
Used to request the corresponding capability object for a given capability.
|
| GetSystemCapabilityResponse |
GetSystemCapabilityResponse is sent, when GetSystemCapability has been called
|
| GetVehicleData |
Non periodic vehicle data read request.
|
| GetVehicleDataResponse |
Get Vehicle Data Response is sent, when GetVehicleData has been called.
|
| GetWayPoints | |
| GetWayPointsResponse | |
| GPSData |
Describes the GPS data.
|
| Grid |
Struct that describes a location (origin coordinates and span) of a vehicle component (Module)
|
| HapticRect |
Defines a haptic rectangle that contains a reference ID and the spatial data of a rectangle UI component.
|
| Headers | |
| HeadLampStatus |
Status of the head lamps.
|
| HMICapabilities | |
| HMIPermissions |
Defining sets of HMI levels, which are permitted or prohibited for a given RPC.
|
| HMISettingsControlCapabilities | |
| HMISettingsControlData |
Corresponds to "HMI_SETTINGS" ModuleType
|
| Image |
Specifies, which image shall be used, e.g.
|
| ImageField |
The name that identifies the field.For example AppIcon,SoftButton, LocationImage, etc.
|
| ImageResolution |
The image resolution of this field.
|
| KeyboardCapabilities |
Parameter List
|
| KeyboardLayoutCapability |
Describes the capabilities of a single keyboard layout.
|
| KeyboardProperties |
This mode causes the interaction to immediately display a keyboard entry through the HMI.
|
| LightCapabilities | |
| LightControlCapabilities | |
| LightControlData | |
| LightState | |
| ListFiles |
Requests the current list of resident filenames for the registered app.
|
| ListFilesResponse |
List Files Response is sent, when ListFiles has been called
|
| LocationDetails | |
| MassageCushionFirmness |
The intensity or firmness of a cushion.
|
| MassageModeData |
Specify the mode of a massage zone.
|
| MediaServiceData |
This data is related to what a media service should provide
|
| MediaServiceManifest | |
| MenuParams |
Used when adding a sub menu to an application menu or existing sub menu.
|
| MetadataTags | |
| ModuleData | |
| ModuleInfo |
Struct that describes a module within different SystemCapabilities
|
| MyKey |
Information related to the MyKey feature.
|
| NavigationCapability | |
| NavigationInstruction | |
| NavigationServiceData |
This data is related to what a navigation service would provide.
|
| NavigationServiceManifest | |
| OasisAddress | |
| OnAppCapabilityUpdated |
A notification to inform SDL Core that a specific app capability has changed.
|
| OnAppInterfaceUnregistered |
Notifies an application that its interface registration has been terminated.
|
| OnAppServiceData |
This notification includes the data that is updated from the specific service
|
| OnAudioPassThru |
Binary data is in binary part of hybrid msg.
|
| OnButtonEvent |
Notifies application that user has depressed or released a button to which
the application has subscribed.Further information about button events
and button-presses can be found at SubscribeButton.
|
| OnButtonPress |
Notifies application of button press events for buttons to which the
application is subscribed.
|
| OnCommand |
This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after
pressing the MENU button.
|
| OnDriverDistraction |
Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or
not).
|
| OnHashChange |
Notification containing an updated hashID which can be used over connection cycles (i.e.
|
| OnHMIStatus |
Notifies an application that HMI conditions have changed for the application.
|
| OnInteriorVehicleData | |
| OnKeyboardInput |
On-screen keyboard event.
|
| OnLanguageChange |
Provides information to what language the Sdl HMI language was changed
|
| OnPermissionsChange |
Provides update to app of which sets of functions are available
|
| OnRCStatus | |
| OnSubtleAlertPressed |
Sent when the alert itself is touched (outside of a soft button).
|
| OnSystemCapabilityUpdated |
A notification to inform the connected device that a specific system capability has changed.
|
| OnSystemRequest |
An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud.
|
| OnTBTClientState |
Notifies the application of the current TBT client status on the module.
|
| OnTouchEvent |
Notifies about touch events on the screen's prescribed area.
|
| OnUpdateFile |
This notification tells an app to upload and update a file with a given name.
|
| OnUpdateSubMenu |
This notification tells an app to update the AddSubMenu or its 'sub' AddCommand and
AddSubMenus with the requested data
|
| OnVehicleData |
Individual requested DID result and data.
|
| OnWayPointChange | |
| ParameterPermissions |
Defining sets of parameters, which are permitted or prohibited for a given RPC.
|
| PerformAppServiceInteraction | |
| PerformAppServiceInteractionResponse | |
| PerformAudioPassThru |
This will open an audio pass thru session.
|
| PerformAudioPassThruResponse |
Perform Audio Pass Thru Response is sent, when PerformAudioPassThru has been called
|
| PerformInteraction |
Performs an application-initiated interaction in which the user can select a
Choice from among the specified Choice Sets.
|
| PerformInteractionResponse |
PerformInteraction Response is sent, when PerformInteraction has been called
|
| PermissionItem |
Change in permissions for a given set of RPCs
|
| PhoneCapability |
Extended capabilities of the module's phone feature
|
| PresetBankCapabilities |
Contains information about on-screen preset capabilities.
|
| PublishAppService |
Registers a service offered by this app on the module.
|
| PublishAppServiceResponse | |
| PutFile |
Used to push a binary data onto the SDL module from a mobile device, such as
icons and album art.
|
| PutFileResponse |
Put File Response is sent, when PutFile has been called
|
| RadioControlCapabilities |
Contains information about a radio control module's capabilities.
|
| RadioControlData |
Include information (both read-only and changeable data) about a
remote control radio module.
|
| RdsData |
Include the data defined in Radio Data System, which is a communications protocol standard
for embedding small amounts of digital information in conventional FM radio broadcasts.
|
| ReadDID |
Non periodic vehicle data read request.
|
| ReadDIDResponse |
Read DID Response is sent, when ReadDID has been called
|
| Rectangle |
Defines Rectangle for each user control object for video streaming application
|
| RegisterAppInterface |
Registers the application's interface with SDL®, declaring properties of
the registration, including the messaging interface version, the app name,
etc.
|
| RegisterAppInterfaceResponse |
Register AppInterface Response is sent, when RegisterAppInterface has been called
|
| ReleaseInteriorVehicleDataModule | |
| ReleaseInteriorVehicleDataModuleResponse | |
| RemoteControlCapabilities | |
| ResetGlobalProperties |
Resets the passed global properties to their default values as defined by
SDL
|
| ResetGlobalPropertiesResponse |
Reset Global Properties Response is sent, when ResetGlobalProperties has been called
|
| RGBColor |
A color class that stores RGB values
|
| RoofStatus |
Describes the status of a parameter of roof/convertible roof/sunroof/moonroof etc.
|
| ScreenParams |
The resolution of the prescribed screen area.
|
| ScrollableMessage |
Creates a full screen overlay containing a large block of formatted text that
can be scrolled with up to 8 SoftButtons defined
|
| ScrollableMessageResponse |
Scrollable Message Response is sent, when ScrollableMessage has been called
|
| SdlMsgVersion |
Specifies the version number of the SDL V4 interface.
|
| SeatControlCapabilities | |
| SeatControlData |
Seat control data corresponds to "SEAT" ModuleType.
|
| SeatLocation | |
| SeatLocationCapability | |
| SeatMemoryAction | |
| SeatOccupancy |
Parameter List
|
| SeatStatus |
Describes the status of a parameter of seat.
|
| SeekStreamingIndicator |
The seek next / skip previous subscription buttons' content
|
| SendHapticData |
Request to describe UI elements boundaries to a connected modules.
|
| SendHapticDataResponse |
Response to request that described UI elements boundaries to a connected modules.
|
| SendLocation |
Sends a location to the head-unit to display on a map or list.
|
| SendLocationResponse |
Add SendLocation Response is sent, when SendLocation has been called
|
| SetAppIcon |
Used to set existing local file on SDL as the app's icon.
|
| SetAppIconResponse |
Set App Icon Response is sent, when SetAppIcon has been called.
|
| SetCloudAppProperties | |
| SetCloudAppPropertiesResponse | |
| SetDisplayLayout | Deprecated
in SmartDeviceLink 6.0
|
| SetDisplayLayoutResponse | Deprecated
in SmartDeviceLink 6.0
|
| SetGlobalProperties |
Sets value(s) for the specified global property(ies)
|
| SetGlobalPropertiesResponse |
Set Global Properties Response is sent, when SetGlobalProperties has been called
|
| SetInteriorVehicleData |
This function allows a remote control type mobile application change the settings
of a specific remote control module.
|
| SetInteriorVehicleDataResponse | |
| SetMediaClockTimer |
Sets the media clock/timer value and the update method (e.g.count-up,
count-down, etc.)
|
| SetMediaClockTimerResponse |
Set Media Clock Timer Response is sent, when SetMediaClockTimer has been called
|
| Show |
Updates the application's display text area, regardless of whether or not
this text area is visible to the user at the time of the request.
|
| ShowAppMenu | |
| ShowAppMenuResponse |
The response to ShowAppMenuResponse
|
| ShowConstantTbt |
This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but
also for the alert type screen
|
| ShowConstantTbtResponse |
Show Constant TBT Response is sent, when ShowConstantTBT has been called
|
| ShowResponse |
Show Response is sent, when Show has been called
|
| SingleTireStatus |
Tire pressure status of a single tire.
|
| SisData | |
| Slider |
Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider.
|
| SliderResponse |
Slider Response is sent, when Slider has been called
|
| SoftButton |
A simulated button or keyboard key that is displayed on a touch screen.
|
| SoftButtonCapabilities |
Contains information about a SoftButton's capabilities.
|
| Speak |
Speaks a phrase over the vehicle audio system using SDL's TTS
(text-to-speech) engine.
|
| SpeakResponse |
Speak Response is sent, when Speak has been called
|
| StabilityControlsStatus |
Parameter List
|
| StartTime |
Describes the hour, minute and second values used to set the media clock.
|
| StationIDNumber | |
| SubscribeButton |
Establishes a subscription to button notifications for HMI buttons.
|
| SubscribeButtonResponse |
Sub scribeButton Response is sent, when SubscribeButton has been called
|
| SubscribeVehicleData |
Subscribes for specific published vehicle data items.
|
| SubscribeVehicleDataResponse |
Subscribe Vehicle Data Response is sent, when SubscribeVehicleData has been called
|
| SubscribeWayPoints | |
| SubscribeWayPointsResponse | |
| SubtleAlert |
Shows an alert which typically consists of text-to-speech message and text on the display.
|
| SubtleAlertResponse | |
| SystemCapability |
Struct that indicates the SystemCapabilityType and houses different structs to describe particular capabilities
|
| SystemRequest |
An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as HTTP, Proprietary, or Authentication requests)
|
| SystemRequestResponse |
System Request Response is sent, when SystemRequest has been called
|
| Temperature | |
| TemplateColorScheme |
A color scheme for all display layout templates.
|
| TemplateConfiguration |
Used to set an alternate template layout to a window.
|
| TextField |
Struct defining the characteristics of a displayed field on the HMI.
|
| TireStatus |
The status and pressure of the tires.
|
| TouchCoord |
The x or y coordinate of the touch.
|
| TouchEvent |
For touchscreen interactions, the mode of how the choices are presented.
|
| TouchEventCapabilities |
Types of screen touch events available in screen area.
|
| TTSChunk |
Specifies what is to be spoken.
|
| Turn |
Describes a navigation turn including an optional icon
|
| UnpublishAppService |
Unpublish an existing service published by this application.
|
| UnpublishAppServiceResponse |
The response to UnpublishAppService
|
| UnregisterAppInterface |
Terminates an application's interface registration.
|
| UnregisterAppInterfaceResponse |
Unregister AppInterface Response is sent, when UnregisterAppInterface has been called
|
| UnsubscribeButton |
Deletes a subscription to button notifications for the specified button.
|
| UnsubscribeButtonResponse |
Unsubscribe Button Response is sent, when UnsubscribeButton has been called
|
| UnsubscribeVehicleData |
This function is used to unsubscribe the notifications from the
subscribeVehicleData function
|
| UnsubscribeVehicleDataResponse |
Unsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called.
|
| UnsubscribeWayPoints | |
| UnsubscribeWayPointsResponse | |
| UpdateTurnList |
Updates the list of next maneuvers, which can be requested by the user pressing the soft button "Turns" on the
Navigation base screen.
|
| UpdateTurnListResponse |
Update Turn List Response is sent, when UpdateTurnList has been called
|
| VehicleDataResult |
Individual published data request result.
|
| VehicleType |
Describes the type of vehicle the mobile phone is connected with.
|
| VideoStreamingCapability |
Contains information about this system's video streaming capabilities.
|
| VideoStreamingFormat |
Video streaming formats and their specifications.
|
| VrHelpItem |
VR help items i.e.
|
| WeatherAlert | |
| WeatherData | |
| WeatherServiceData |
This data is related to what a weather service would provide
|
| WeatherServiceManifest | |
| WindowCapability | |
| WindowState |
Parameter List
|
| WindowStatus |
Describes the status of a window of a door/liftgate etc.
|
| WindowTypeCapabilities |
Used to inform an app how many window instances per type they can be created.
|