Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
SDLAddCommandResponse SDLAddSubMenuResponse SDLAlertManeuverResponse SDLButtonPressResponse SDLCancelInteractionResponse SDLChangeRegistrationResponse SDLCloseApplication SDLCloseApplicationResponse SDLCreateInteractionChoiceSetResponse SDLCreateWindowResponse SDLDeleteCommandResponse SDLDeleteInteractionChoiceSetResponse SDLDeleteSubMenuResponse SDLDeleteWindowResponse SDLDialNumberResponse SDLEncodedSyncPDataResponse SDLEndAudioPassThru SDLEndAudioPassThruResponse SDLGenericResponse SDLListFiles SDLLogTargetAppleSystemLog SDLLogTargetFile SDLLogTargetOSLog SDLMediaServiceManifest SDLOnAudioPassThru SDLPerformAudioPassThruResponse SDLRPCNotification SDLReleaseInteriorVehicleDataModuleResponse SDLResetGlobalPropertiesResponse SDLScrollableMessageResponse SDLSendHapticDataResponse SDLSendLocationResponse SDLSetAppIconResponse SDLSetCloudAppPropertiesResponse SDLSetGlobalPropertiesResponse SDLSetMediaClockTimerResponse SDLShowAppMenuResponse SDLShowConstantTBTResponse SDLShowResponse SDLSpeakResponse SDLSubscribeButtonResponse SDLSubscribeWayPoints SDLSubscribeWayPointsResponse SDLSyncPData SDLSyncPDataResponse SDLUnpublishAppServiceResponse SDLUnregisterAppInterface SDLUnregisterAppInterfaceResponse SDLUnsubscribeButtonResponse SDLUnsubscribeWayPoints SDLUnsubscribeWayPointsResponse SDLUpdateTurnListResponse

Classes Reference

Section Contents

Overview

The following classes are available globally.

SDLAddCommand

This class will add a command to the application’s Command Menu

A command will be added to the end of the list of elements in the Command Menu under the following conditions:

  1. When a SDLAddCommand is added with no SDLMenuParams value provided.
  2. When a SDLMenuParams value is provided with a SDLMenuParam.position value greater than or equal to the number of menu items currently defined in the menu specified by the SDLMenuParam.parentID value.

The set of choices which the application builds using SDLAddCommand can be a mixture of:

  1. Choices having only VR synonym definitions, but no SDLMenuParams definitions
  2. Choices having only SDLMenuParams definitions, but no VR synonym definitions
  3. Choices having both SDLMenuParams and VR synonym definitions

HMILevel needs to be FULL, LIMITED or BACKGROUD @since SDL 1.0

See

SDLDeleteCommand, SDLAddSubMenu, SDLDeleteSubMenu
See more

Objective-C

@interface SDLAddCommand : SDLRPCRequest

Swift

class SDLAddCommand : SDLRPCRequest

SDLAddCommandResponse

Response to SDLAddCommand

Since SmartDeviceLink 1.0

Objective-C

@interface SDLAddCommandResponse : SDLRPCResponse

Swift

class SDLAddCommandResponse : SDLRPCResponse

SDLAddSubMenu

Add a SDLSubMenu to the Command Menu

A SDLSubMenu can only be added to the Top Level Menu (i.e.a SDLSubMenu cannot be added to a SDLSubMenu), and may only contain commands as children

HMILevel needs to be FULL, LIMITED or BACKGROUD

Since SmartDeviceLink 1.0
see SDLDeleteSubMenu SDLAddCommand SDLDeleteCommand

See more

Objective-C

@interface SDLAddSubMenu : SDLRPCRequest

Swift

class SDLAddSubMenu : SDLRPCRequest

SDLAddSubMenuResponse

Response to SDLAddSubMenu

Since SmartDeviceLink 1.0

Objective-C

@interface SDLAddSubMenuResponse : SDLRPCResponse

Swift

class SDLAddSubMenuResponse : SDLRPCResponse

SDLAirbagStatus

A vehicle data status struct for airbags

See more

Objective-C

@interface SDLAirbagStatus : SDLRPCStruct

Swift

class SDLAirbagStatus : SDLRPCStruct

SDLAlert

Shows an alert which typically consists of text-to-speech message and text on the display. Either alertText1, alertText2 or TTSChunks needs to be set or the request will be rejected.

If connecting to SDL Core v.6.0+, the alert can be canceled programmatically using the cancelID. Canceling will not dismiss the alert’s speech - only the modal view will be dismissed. On older versions of SDL Core, the alert will persist until the user has interacted with the alert or the specified timeout has elapsed.

@since SDL 1.0

See more

Objective-C

@interface SDLAlert : SDLRPCRequest

Swift

class SDLAlert : SDLRPCRequest

SDLAlertManeuver

Shows a SDLShowConstantTBT message with an optional voice command. This message is shown as an overlay over the display’s base screen.

@since SmartDeviceLink 1.0

See more

Objective-C

@interface SDLAlertManeuver : SDLRPCRequest

Swift

class SDLAlertManeuver : SDLRPCRequest

SDLAlertManeuverResponse

Response to SDLAlertManeuver

@since SmartDeviceLink 1.0

Objective-C

@interface SDLAlertManeuverResponse : SDLRPCResponse

Swift

class SDLAlertManeuverResponse : SDLRPCResponse

SDLAlertResponse

Response to SDLAlert

@since SDL 1.0

See more

Objective-C

@interface SDLAlertResponse : SDLRPCResponse

Swift

class SDLAlertResponse : SDLRPCResponse

SDLAppInfo

A struct used in register app interface. Contains detailed information about the registered application.

See more

Objective-C

@interface SDLAppInfo : SDLRPCStruct

Swift

class SDLAppInfo : SDLRPCStruct

SDLAppServiceCapability

A currently available service.

@since RPC 5.1

See more

Objective-C

@interface SDLAppServiceCapability : SDLRPCStruct

Swift

class SDLAppServiceCapability : SDLRPCStruct

SDLAppServiceData

Contains all the current data of the app service. The serviceType will link to which of the service data objects are included in this object (e.g. if the service type is MEDIA, the mediaServiceData param should be included).

@since RPC 5.1

See more

Objective-C

@interface SDLAppServiceData : SDLRPCStruct

Swift

class SDLAppServiceData : SDLRPCStruct

SDLAppServiceManifest

This manifest contains all the information necessary for the service to be published, activated, and allow consumers to interact with it

See more

Objective-C

@interface SDLAppServiceManifest : SDLRPCStruct

Swift

class SDLAppServiceManifest : SDLRPCStruct

SDLAppServiceRecord

This is the record of an app service publisher that the module has. It should contain the most up to date information including the service’s active state.

@since RPC 5.1

See more

Objective-C

@interface SDLAppServiceRecord : SDLRPCStruct

Swift

class SDLAppServiceRecord : SDLRPCStruct

SDLAppServicesCapabilities

Capabilities of app services including what service types are supported and the current state of services.

@since RPC 5.1

See more

Objective-C

@interface SDLAppServicesCapabilities : SDLRPCStruct

Swift

class SDLAppServicesCapabilities : SDLRPCStruct

SDLArtwork

An SDLFile subclass specifically designed for images

See more

Objective-C

@interface SDLArtwork : SDLFile

Swift

class SDLArtwork : SDLFile

SDLAudioControlCapabilities

Describes a head unit’s audio control capabilities.

@since RPC 5.0

See more

Objective-C

@interface SDLAudioControlCapabilities : SDLRPCStruct

Swift

class SDLAudioControlCapabilities : SDLRPCStruct

SDLAudioControlData

The audio control data information.

@since RPC 5.0

See more

Objective-C

@interface SDLAudioControlData : SDLRPCStruct

Swift

class SDLAudioControlData : SDLRPCStruct

SDLAudioFile

Includes inforamtion about a given audio file

See more

Objective-C

@interface SDLAudioFile : NSObject

Swift

class SDLAudioFile : NSObject

SDLAudioPassThruCapabilities

Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM}

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLAudioPassThruCapabilities : SDLRPCStruct

Swift

class SDLAudioPassThruCapabilities : SDLRPCStruct

SDLAudioStreamManager

The manager to control the audio stream

See more

Objective-C

@interface SDLAudioStreamManager : NSObject

Swift

class SDLAudioStreamManager : NSObject

SDLBeltStatus

Vehicle data struct for the seat belt status

See more

Objective-C

@interface SDLBeltStatus : SDLRPCStruct

Swift

class SDLBeltStatus : SDLRPCStruct

SDLBodyInformation

The body information including power modes.

See more

Objective-C

@interface SDLBodyInformation : SDLRPCStruct

Swift

class SDLBodyInformation : SDLRPCStruct

SDLButtonCapabilities

Provides information about the capabilities of a SDL HMI button.

@since SDL 1.0

See more

Objective-C

@interface SDLButtonCapabilities : SDLRPCStruct

Swift

class SDLButtonCapabilities : SDLRPCStruct

SDLButtonPress

This RPC allows a remote control type mobile application to simulate a hardware button press event.

@since RPC 4.5

See more

Objective-C

@interface SDLButtonPress : SDLRPCRequest

Swift

class SDLButtonPress : SDLRPCRequest

SDLButtonPressResponse

Response to SDLButtonPress

Objective-C

@interface SDLButtonPressResponse : SDLRPCResponse

Swift

class SDLButtonPressResponse : SDLRPCResponse

SDLCancelInteraction

Used to dismiss a modal view programmatically without needing to wait for the timeout to complete. Can be used to dismiss alerts, scrollable messages, sliders, and perform interactions (i.e. pop-up menus).

See

SDLAlert, SDLScrollableMessage, SDLSlider, SDLPerformInteraction
See more

Objective-C

@interface SDLCancelInteraction : SDLRPCRequest

Swift

class SDLCancelInteraction : SDLRPCRequest

SDLCancelInteractionResponse

Response to the request to dismiss a modal view. If no applicable request can be dismissed, the resultCode will be IGNORED.

Objective-C

@interface SDLCancelInteractionResponse : SDLRPCResponse

Swift

class SDLCancelInteractionResponse : SDLRPCResponse

SDLCarWindowViewController

Note that if this is embedded in a UINavigationController and UITabBarController, it will not lock orientation. You must lock your container controller to a specific orientation.

See more

Objective-C

@interface SDLCarWindowViewController : UIViewController

Swift

class SDLCarWindowViewController : UIViewController

SDLChangeRegistration

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.

Any HMILevel allowed

@since SDL 2.0

See more

Objective-C

@interface SDLChangeRegistration : SDLRPCRequest

Swift

class SDLChangeRegistration : SDLRPCRequest

SDLChangeRegistrationResponse

Response to SDLChangeRegistrations

@since SDL 2.0

Objective-C

@interface SDLChangeRegistrationResponse : SDLRPCResponse

Swift

class SDLChangeRegistrationResponse : SDLRPCResponse

SDLChoice

A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.

Since RPC 1.0

See more

Objective-C

@interface SDLChoice : SDLRPCStruct

Swift

class SDLChoice : SDLRPCStruct

SDLChoiceCell

A selectable item within an SDLChoiceSet

See more

Objective-C

@interface SDLChoiceCell : NSObject

Swift

class SDLChoiceCell : NSObject

SDLChoiceSet

The choice set to be displayed to the user. Contains a list of selectable options.

See more

Objective-C

@interface SDLChoiceSet : NSObject

Swift

class SDLChoiceSet : NSObject

SDLClimateControlCapabilities

Contains information about a climate control module’s capabilities.

See more

Objective-C

@interface SDLClimateControlCapabilities : SDLRPCStruct

Swift

class SDLClimateControlCapabilities : SDLRPCStruct

SDLClimateControlData

The current information for the Climate Remote Control Module

See more

Objective-C

@interface SDLClimateControlData : SDLRPCStruct

Swift

class SDLClimateControlData : SDLRPCStruct

SDLCloseApplication

Used by an app to set itself to a HMILevel of NONE. The app will close but will still be registered. If the app is a navigation app it will no longer be used as the preferred mobile-navigation application by the module.

Objective-C

@interface SDLCloseApplication : SDLRPCRequest

Swift

class SDLCloseApplication : SDLRPCRequest

SDLCloseApplicationResponse

Response to the request to close this app on the module.

Objective-C

@interface SDLCloseApplicationResponse : SDLRPCResponse

Swift

class SDLCloseApplicationResponse : SDLRPCResponse

SDLCloudAppProperties

The cloud application properties.

See more

Objective-C

@interface SDLCloudAppProperties : SDLRPCStruct

Swift

class SDLCloudAppProperties : SDLRPCStruct

SDLClusterModeStatus

A vehicle data struct for the cluster mode and power status

See more

Objective-C

@interface SDLClusterModeStatus : SDLRPCStruct

Swift

class SDLClusterModeStatus : SDLRPCStruct

SDLConfiguration

Contains information about the app’s configurtion, such as lifecycle, lockscreen, encryption, etc.

See more

Objective-C

@interface SDLConfiguration : NSObject <NSCopying>

Swift

class SDLConfiguration : NSObject, NSCopying

SDLCreateInteractionChoiceSet

Creates a Choice Set which can be used in subsequent SDLPerformInteraction Operations.

HMILevel needs to be FULL, LIMITED or BACKGROUND

Before a perform interaction is sent you MUST wait for the success from the CreateInteractionChoiceSet RPC.

If you do not wait the system may not recognize the first utterance from the user.

@since SDL 1.0

See

SDLDeleteInteractionChoiceSet SDLPerformInteraction
See more

Objective-C

@interface SDLCreateInteractionChoiceSet : SDLRPCRequest

Swift

class SDLCreateInteractionChoiceSet : SDLRPCRequest

SDLCreateInteractionChoiceSetResponse

Response to SDLCreateInteractionChoiceSet has been called

Since SmartDeviceLink 1.0

Objective-C

@interface SDLCreateInteractionChoiceSetResponse : SDLRPCResponse

Swift

class SDLCreateInteractionChoiceSetResponse : SDLRPCResponse

SDLCreateWindow

Create a new window on the display with the specified window type. @discussion Windows of different types like MAIN or WIDGET windows can be created. Every application will have a pre-created MAIN window available. A widget is a small window that the app can create to provide information and soft buttons for quick app control. Widgets can be created depending on the capabilities of the system. Widgets can be associated with a specific App Service type such as MEDIA or NAVIGATION. As an example if a MEDIA app becomes active, this app becomes audible and is allowed to play audio. If the media app has created a widget with MEDIA type associated, this widget will automatically be activated together with the app.

@since SDL 6.0

See more

Objective-C

@interface SDLCreateWindow : SDLRPCRequest

Swift

class SDLCreateWindow : SDLRPCRequest

SDLCreateWindowResponse

Response to SDLCreateWindow

@since RPC 6.0

Objective-C

@interface SDLCreateWindowResponse : SDLRPCResponse

Swift

class SDLCreateWindowResponse : SDLRPCResponse

SDLDIDResult

A vehicle data struct

See more

Objective-C

@interface SDLDIDResult : SDLRPCStruct

Swift

class SDLDIDResult : SDLRPCStruct

SDLDateTime

A struct referenced in SendLocation for an absolute date

See more

Objective-C

@interface SDLDateTime : SDLRPCStruct

Swift

class SDLDateTime : SDLRPCStruct

SDLDeleteCommand

Removes a command from the Command Menu

HMI Status Requirements:
HMILevel: FULL, LIMITED or BACKGROUND
AudioStreamingState: N/A
SystemContext: Should not be attempted when VRSESSION or MENU

Since SmartDeviceLink 1.0
see SDLAddCommand SDLAddSubMenu SDLDeleteSubMenu

See more

Objective-C

@interface SDLDeleteCommand : SDLRPCRequest

Swift

class SDLDeleteCommand : SDLRPCRequest

SDLDeleteCommandResponse

Response to SDLDeleteCommand

Since SmartDeviceLink 1.0

Objective-C

@interface SDLDeleteCommandResponse : SDLRPCResponse

Swift

class SDLDeleteCommandResponse : SDLRPCResponse

SDLDeleteFile

Used to delete a file resident on the SDL module in the app’s local cache. Not supported on first generation SDL vehicles

Since SmartDeviceLink 2.0
see SDLPutFile SDLListFiles

See more

Objective-C

@interface SDLDeleteFile : SDLRPCRequest

Swift

class SDLDeleteFile : SDLRPCRequest

SDLDeleteFileResponse

Response to SDLDeleteFile

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLDeleteFileResponse : SDLRPCResponse

Swift

class SDLDeleteFileResponse : SDLRPCResponse

SDLDeleteInteractionChoiceSet

Deletes an existing Choice Set identified by the parameter interactionChoiceSetID. If the specified interactionChoiceSetID is currently in use by an active SDLPerformInteraction this call to delete the Choice Set will fail returning an IN_USE resultCode

Function Group: Base

HMILevel needs to be FULL, LIMITED or BACKGROUD

Since SmartDeviceLink 1.0
see SDLCreateInteractionChoiceSet SDLPerformInteraction

See more

Objective-C

@interface SDLDeleteInteractionChoiceSet : SDLRPCRequest

Swift

class SDLDeleteInteractionChoiceSet : SDLRPCRequest

SDLDeleteInteractionChoiceSetResponse

SDLDeleteInteractionChoiceSetResponse is sent, when SDLDeleteInteractionChoiceSet has been called

Since SmartDeviceLink 1.0

Objective-C

@interface SDLDeleteInteractionChoiceSetResponse : SDLRPCResponse

Swift

class SDLDeleteInteractionChoiceSetResponse : SDLRPCResponse

SDLDeleteSubMenu

Deletes a submenu from the Command Menu

Notes: When an app deletes a submenu that has child commands, those child commands are also deleted

HMILevel needs to be FULL, LIMITED or BACKGROUND

Since SmartDeviceLink 1.0
see SDLAddCommand SDLAddSubMenu SDLDeleteCommand

See more

Objective-C

@interface SDLDeleteSubMenu : SDLRPCRequest

Swift

class SDLDeleteSubMenu : SDLRPCRequest

SDLDeleteSubMenuResponse

Response to SDLDeleteSubMenu

Since SmartDeviceLink 1.0

Objective-C

@interface SDLDeleteSubMenuResponse : SDLRPCResponse

Swift

class SDLDeleteSubMenuResponse : SDLRPCResponse

SDLDeleteWindow

Deletes previously created window of the SDL application.

@since SDL 6.0

See more

Objective-C

@interface SDLDeleteWindow : SDLRPCRequest

Swift

class SDLDeleteWindow : SDLRPCRequest

SDLDeleteWindowResponse

Response to DeleteWindow

@since RPC 6.0

Objective-C

@interface SDLDeleteWindowResponse : SDLRPCResponse

Swift

class SDLDeleteWindowResponse : SDLRPCResponse

SDLDeviceInfo

Various information about connecting device. Referenced in RegisterAppInterface

See more

Objective-C

@interface SDLDeviceInfo : SDLRPCStruct

Swift

class SDLDeviceInfo : SDLRPCStruct

SDLDeviceStatus

Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.

@since SDL 2.0

See more

Objective-C

@interface SDLDeviceStatus : SDLRPCStruct

Swift

class SDLDeviceStatus : SDLRPCStruct

SDLDiagnosticMessage

Non periodic vehicle diagnostic request

@since SDL 3.0

See more

Objective-C

@interface SDLDiagnosticMessage : SDLRPCRequest

Swift

class SDLDiagnosticMessage : SDLRPCRequest

SDLDiagnosticMessageResponse

Response to SDLDiagnosticMessage

Since SmartDeviceLink 3.0

See more

Objective-C

@interface SDLDiagnosticMessageResponse : SDLRPCResponse

Swift

class SDLDiagnosticMessageResponse : SDLRPCResponse

SDLDialNumber

This RPC is used to tell the head unit to use bluetooth to dial a phone number using the phone.

@since SDL 4.0

See more

Objective-C

@interface SDLDialNumber : SDLRPCRequest

Swift

class SDLDialNumber : SDLRPCRequest

SDLDialNumberResponse

The response to SDLDialNumber

@since SDL 4.0

Objective-C

@interface SDLDialNumberResponse : SDLRPCResponse

Swift

class SDLDialNumberResponse : SDLRPCResponse

SDLDisplayCapabilities

Contains information about the display for the SDL system to which the application is currently connected.

@since SDL 1.0

See more

Objective-C

@interface SDLDisplayCapabilities : SDLRPCStruct

Swift

class SDLDisplayCapabilities : SDLRPCStruct

SDLDisplayCapability

Contain the display related information and all windows related to that display.

@since SDL 6.0

See more

Objective-C

@interface SDLDisplayCapability : SDLRPCStruct

Swift

class SDLDisplayCapability : SDLRPCStruct

SDLECallInfo

A vehicle data struct for emergency call information

See more

Objective-C

@interface SDLECallInfo : SDLRPCStruct

Swift

class SDLECallInfo : SDLRPCStruct

SDLEmergencyEvent

A vehicle data struct for an emergency event

See more

Objective-C

@interface SDLEmergencyEvent : SDLRPCStruct

Swift

class SDLEmergencyEvent : SDLRPCStruct

SDLEncodedSyncPData

Allows encoded data in the form of SyncP packets to be sent to the SYNC module. Legacy / v1 Protocol implementation; use SyncPData instead.

*** DEPRECATED ***

See more

Objective-C


@interface SDLEncodedSyncPData : SDLRPCRequest

Swift

class SDLEncodedSyncPData : SDLRPCRequest

SDLEncodedSyncPDataResponse

The response to SDLEncodedSyncPData

DEPRECATED

Objective-C


@interface SDLEncodedSyncPDataResponse : SDLRPCResponse

Swift

class SDLEncodedSyncPDataResponse : SDLRPCResponse

SDLEncryptionConfiguration

The encryption configuration data

See more

Objective-C

@interface SDLEncryptionConfiguration : NSObject <NSCopying>

Swift

class SDLEncryptionConfiguration : NSObject, NSCopying

SDLEndAudioPassThru

When this request is invoked, the audio capture stops

Function Group: AudioPassThru

HMILevel needs to be FULL, LIMITED or BACKGROUND

Since SmartDeviceLink 2.0
see SDLPerformAudioPassThru

Objective-C

@interface SDLEndAudioPassThru : SDLRPCRequest

Swift

class SDLEndAudioPassThru : SDLRPCRequest

SDLEndAudioPassThruResponse

Response to SDLEndAudioPassThru

Since SmartDeviceLink 2.0

Objective-C

@interface SDLEndAudioPassThruResponse : SDLRPCResponse

Swift

class SDLEndAudioPassThruResponse : SDLRPCResponse

SDLEqualizerSettings

Defines the each Equalizer channel settings.

See more

Objective-C

@interface SDLEqualizerSettings : SDLRPCStruct

Swift

class SDLEqualizerSettings : SDLRPCStruct

SDLFile

Crates an SDLFile from a file

See more

Objective-C

@interface SDLFile : NSObject <NSCopying>

Swift

class SDLFile : NSObject, NSCopying

SDLFileManager

The SDLFileManager is an RPC manager for the remote file system. After it starts, it will attempt to communicate with the remote file system to get the names of all files. Deleting and Uploading will them queue these changes as transactions. If a delete succeeds, the local list of remote files will remove that file name, and likewise, if an upload succeeds, the local list of remote files will now include that file name.

See more

Objective-C

@interface SDLFileManager : NSObject

Swift

class SDLFileManager : NSObject

SDLFileManagerConfiguration

File manager configuration information

See more

Objective-C

@interface SDLFileManagerConfiguration : NSObject <NSCopying>

Swift

class SDLFileManagerConfiguration : NSObject, NSCopying

SDLFuelRange

Describes the distance a vehicle can travel with the current level of fuel.

See more

Objective-C

@interface SDLFuelRange : SDLRPCStruct

Swift

class SDLFuelRange : SDLRPCStruct

SDLFunctionID

A function ID for an SDL RPC

See more

Objective-C

@interface SDLFunctionID : NSObject

Swift

class SDLFunctionID : NSObject

SDLGPSData

Describes the GPS data. Not all data will be available on all carlines.

@since SDL 2.0

See more

Objective-C

@interface SDLGPSData : SDLRPCStruct

Swift

class SDLGPSData : SDLRPCStruct

SDLGenericResponse

Generic Response is sent when the name of a received request is unknown. It is only used in case of an error. It will have an INVALID_DATA result code.

Objective-C

@interface SDLGenericResponse : SDLRPCResponse

Swift

class SDLGenericResponse : SDLRPCResponse

SDLGetAppServiceData

This request asks the module for current data related to the specific service. It also includes an option to subscribe to that service for future updates.

See more

Objective-C

@interface SDLGetAppServiceData : SDLRPCRequest

Swift

class SDLGetAppServiceData : SDLRPCRequest

SDLGetAppServiceDataResponse

This response includes the data that was requested from the specific service.

See more

Objective-C

@interface SDLGetAppServiceDataResponse : SDLRPCResponse

Swift

class SDLGetAppServiceDataResponse : SDLRPCResponse

SDLGetCloudAppProperties

RPC used to get the current properties of a cloud application.

See more

Objective-C

@interface SDLGetCloudAppProperties : SDLRPCRequest

Swift

class SDLGetCloudAppProperties : SDLRPCRequest

SDLGetCloudAppPropertiesResponse

The response to GetCloudAppProperties

See more

Objective-C

@interface SDLGetCloudAppPropertiesResponse : SDLRPCResponse

Swift

class SDLGetCloudAppPropertiesResponse : SDLRPCResponse

SDLGetDTCs

This RPC allows to request diagnostic module trouble codes from a certain vehicle module

Function Group: ProprietaryData

HMILevel needs to be FULL, LIMITED or BACKGROUND

See more

Objective-C

@interface SDLGetDTCs : SDLRPCRequest

Swift

class SDLGetDTCs : SDLRPCRequest

SDLGetDTCsResponse

Response to SDLGetDTCs

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLGetDTCsResponse : SDLRPCResponse

Swift

class SDLGetDTCsResponse : SDLRPCResponse

SDLGetFile

This request is sent to the module to retrieve a file.

See more

Objective-C

@interface SDLGetFile : SDLRPCRequest

Swift

class SDLGetFile : SDLRPCRequest

SDLGetFileResponse

Response to GetFiles

@since RPC 5.1

See more

Objective-C

@interface SDLGetFileResponse : SDLRPCResponse

Swift

class SDLGetFileResponse : SDLRPCResponse

SDLGetInteriorVehicleData

Reads the current status value of specified remote control module (type). When subscribe is true, subscribes for specific remote control module data items. When subscribe is false, unsubscribes for specific remote control module data items. Once subscribed, the application will be notified by the onInteriorVehicleData RPC notification whenever new data is available for the module.

See more

Objective-C

@interface SDLGetInteriorVehicleData : SDLRPCRequest

Swift

class SDLGetInteriorVehicleData : SDLRPCRequest

SDLGetInteriorVehicleDataConsent

This RPC allows you to get consent to control a certian module

@since RPC 6.0

See more

Objective-C

@interface SDLGetInteriorVehicleDataConsent : SDLRPCRequest

Swift

class SDLGetInteriorVehicleDataConsent : SDLRPCRequest

SDLGetInteriorVehicleDataConsentResponse

Response to GetInteriorVehicleDataConsent

@since RPC 6.0

See more

Objective-C

@interface SDLGetInteriorVehicleDataConsentResponse : SDLRPCResponse

Swift

class SDLGetInteriorVehicleDataConsentResponse : SDLRPCResponse

SDLGetInteriorVehicleDataResponse

A response to SDLGetInteriorVehicleData

See more

Objective-C

@interface SDLGetInteriorVehicleDataResponse : SDLRPCResponse

Swift

class SDLGetInteriorVehicleDataResponse : SDLRPCResponse

SDLGetSystemCapability

SDL RPC Request for expanded information about a supported system/HMI capability

@since SDL 4.5

See more

Objective-C

@interface SDLGetSystemCapability : SDLRPCRequest

Swift

class SDLGetSystemCapability : SDLRPCRequest

SDLGetSystemCapabilityResponse

Response to SDLGetSystemCapability

See more

Objective-C

@interface SDLGetSystemCapabilityResponse : SDLRPCResponse

Swift

class SDLGetSystemCapabilityResponse : SDLRPCResponse

SDLGetVehicleData

Requests current values of specific published vehicle data items.

Function Group: Location, VehicleInfo and DrivingChara HMILevel needs to be FULL, LIMITED or BACKGROUND Since SmartDeviceLink 2.0 See SDLSubscribeVehicleData, SDLUnsubscribeVehicleData

See more

Objective-C

@interface SDLGetVehicleData : SDLRPCRequest

Swift

class SDLGetVehicleData : SDLRPCRequest

SDLGetVehicleDataResponse

Response to SDLGetVehicleData

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLGetVehicleDataResponse : SDLRPCResponse

Swift

class SDLGetVehicleDataResponse : SDLRPCResponse

SDLGetWayPoints

This RPC allows you to get navigation waypoint data

@since RPC 4.1

See more

Objective-C

@interface SDLGetWayPoints : SDLRPCRequest

Swift

class SDLGetWayPoints : SDLRPCRequest

SDLGetWayPointsResponse

Response to SDLGetWayPoints

See more

Objective-C

@interface SDLGetWayPointsResponse : SDLRPCResponse

Swift

class SDLGetWayPointsResponse : SDLRPCResponse

SDLGrid

Describes a location (origin coordinates and span) of a vehicle component.

See more

Objective-C

@interface SDLGrid : SDLRPCStruct

Swift

class SDLGrid : SDLRPCStruct

SDLHMICapabilities

Contains information about the HMI capabilities.

Since SDL 3.0

See more

Objective-C

@interface SDLHMICapabilities : SDLRPCStruct

Swift

class SDLHMICapabilities : SDLRPCStruct

SDLHMIPermissions

Defining sets of HMI levels, which are permitted or prohibited for a given RPC.

@since SDL 2.0

See more

Objective-C

@interface SDLHMIPermissions : SDLRPCStruct

Swift

class SDLHMIPermissions : SDLRPCStruct

SDLHMISettingsControlCapabilities

HMI data struct for HMI control settings

@since 5.0

See more

Objective-C

@interface SDLHMISettingsControlCapabilities : SDLRPCStruct

Swift

class SDLHMISettingsControlCapabilities : SDLRPCStruct

SDLHMISettingsControlData

Corresponds to “HMI_SETTINGS” ModuleType

See more

Objective-C

@interface SDLHMISettingsControlData : SDLRPCStruct

Swift

class SDLHMISettingsControlData : SDLRPCStruct

SDLHapticRect

Defines spatial for each user control object for video streaming application

See more

Objective-C

@interface SDLHapticRect : SDLRPCStruct

Swift

class SDLHapticRect : SDLRPCStruct

SDLHeadLampStatus

Vehicle data struct for status of head lamps

See more

Objective-C

@interface SDLHeadLampStatus : SDLRPCStruct

Swift

class SDLHeadLampStatus : SDLRPCStruct

SDLImage

Specifies which image shall be used e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it.

@since SDL 2.0

See more

Objective-C

@interface SDLImage : SDLRPCStruct

Swift

class SDLImage : SDLRPCStruct

SDLImageField

A struct used in DisplayCapabilities describing the capability of an image field

See more

Objective-C

@interface SDLImageField : SDLRPCStruct

Swift

class SDLImageField : SDLRPCStruct

SDLImageResolution

The resolution of an image

See more

Objective-C

@interface SDLImageResolution : SDLRPCStruct

Swift

class SDLImageResolution : SDLRPCStruct

SDLKeyboardProperties

Configuration of on-screen keyboard (if available)

See more

Objective-C

@interface SDLKeyboardProperties : SDLRPCStruct

Swift

class SDLKeyboardProperties : SDLRPCStruct

SDLLifecycleConfiguration

Configuration options for SDLManager

See more

Objective-C

@interface SDLLifecycleConfiguration : NSObject <NSCopying>

Swift

class SDLLifecycleConfiguration : NSObject, NSCopying

SDLLifecycleConfigurationUpdate

Configuration update options for SDLManager. This class can be used to update the lifecycle configuration in cases the language of the head unit changes or does not match the app language.

See more

Objective-C

@interface SDLLifecycleConfigurationUpdate : NSObject

Swift

class SDLLifecycleConfigurationUpdate : NSObject

SDLLightCapabilities

Current Light capabilities.

@since RPC 5.0

See more

Objective-C

@interface SDLLightCapabilities : SDLRPCStruct

Swift

class SDLLightCapabilities : SDLRPCStruct

SDLLightControlCapabilities

Current light control capabilities.

@since RPC 5.0

See more

Objective-C

@interface SDLLightControlCapabilities : SDLRPCStruct

Swift

class SDLLightControlCapabilities : SDLRPCStruct

SDLLightControlData

Data about the current light controls

@since SDL 5.0

See more

Objective-C

@interface SDLLightControlData : SDLRPCStruct

Swift

class SDLLightControlData : SDLRPCStruct

SDLLightState

Current light control state

@since RPC 5.0

See more

Objective-C

@interface SDLLightState : SDLRPCStruct

Swift

class SDLLightState : SDLRPCStruct

SDLListFiles

Requests the current list of resident filenames for the registered app. Not supported on First generation SDL vehicles

Since SmartDeviceLink 2.0

Objective-C

@interface SDLListFiles : SDLRPCRequest

Swift

class SDLListFiles : SDLRPCRequest

SDLListFilesResponse

Response to SDLListFiles

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLListFilesResponse : SDLRPCResponse

Swift

class SDLListFilesResponse : SDLRPCResponse

SDLLocationCoordinate

Describes a coordinate on earth

See more

Objective-C

@interface SDLLocationCoordinate : SDLRPCStruct

Swift

class SDLLocationCoordinate : SDLRPCStruct

SDLLocationDetails

Describes a location, including its coordinate, name, etc. Used in WayPoints.

See more

Objective-C

@interface SDLLocationDetails : SDLRPCStruct

Swift

class SDLLocationDetails : SDLRPCStruct

SDLLockScreenConfiguration

A configuration describing how the lock screen should be used by the internal SDL system for your application. This configuration is provided before SDL starts and will govern the entire SDL lifecycle of your application.

See more

Objective-C

@interface SDLLockScreenConfiguration : NSObject <NSCopying>

Swift

class SDLLockScreenConfiguration : NSObject, NSCopying

SDLLockScreenViewController

The view controller for the lockscreen.

See more

Objective-C

@interface SDLLockScreenViewController : UIViewController

Swift

class SDLLockScreenViewController : UIViewController

SDLLogConfiguration

Information about the current logging configuration

See more

Objective-C

@interface SDLLogConfiguration : NSObject <NSCopying>

Swift

class SDLLogConfiguration : NSObject, NSCopying

SDLLogFileModule

A log file module is a collection of source code files that form a cohesive unit and that logs can all use to describe themselves. E.g. a “transport” module, or a “Screen Manager” module.

See more

Objective-C

@interface SDLLogFileModule : NSObject

Swift

class SDLLogFileModule : NSObject

SDLLogFilter

Represents a filter over which SDL logs should be logged

See more

Objective-C

@interface SDLLogFilter : NSObject

Swift

class SDLLogFilter : NSObject

SDLLogManager

This is the central manager of logging. A developer should not have to interact with this class, it is exclusively used internally.

See more

Objective-C

@interface SDLLogManager : NSObject

Swift

class SDLLogManager : NSObject

SDLLogTargetAppleSystemLog

The Apple System Log target is an iOS 2.0+ compatible log target that logs to both the Console and to the System Log.

Objective-C

@interface SDLLogTargetAppleSystemLog : NSObject <SDLLogTarget>

Swift

class SDLLogTargetAppleSystemLog : NSObject, SDLLogTarget

SDLLogTargetFile

The File log will log to a text file on the iPhone in Documents/smartdevicelink/log/#appName##datetime##.log. It will log up to 3 logs which will rollover.

Objective-C

@interface SDLLogTargetFile : NSObject <SDLLogTarget>

Swift

class SDLLogTargetFile : NSObject, SDLLogTarget

SDLLogTargetOSLog

OS_LOG is an iOS 10+ only logging system that logs to the Console and the Apple system console. This is an improved replacement for Apple SysLog (SDLLogTargetAppleSystemLog).

https://developer.apple.com/reference/os/logging

Objective-C

@interface SDLLogTargetOSLog : NSObject <SDLLogTarget>

Swift

class SDLLogTargetOSLog : NSObject, SDLLogTarget

SDLManager

The top level manager object for all of SDL’s interactions with the app and the head unit

See more

Objective-C

@interface SDLManager : NSObject

Swift

class SDLManager : NSObject

SDLMassageCushionFirmness

The intensity or firmness of a cushion.

See more

Objective-C

@interface SDLMassageCushionFirmness : SDLRPCStruct

Swift

class SDLMassageCushionFirmness : SDLRPCStruct

SDLMassageModeData

Specify the mode of a massage zone.

See more

Objective-C

@interface SDLMassageModeData : SDLRPCStruct

Swift

class SDLMassageModeData : SDLRPCStruct

SDLMediaServiceData

This data is related to what a media service should provide.

See more

Objective-C

@interface SDLMediaServiceData : SDLRPCStruct

Swift

class SDLMediaServiceData : SDLRPCStruct

SDLMediaServiceManifest

A media service manifest.

Objective-C

@interface SDLMediaServiceManifest : SDLRPCStruct

Swift

class SDLMediaServiceManifest : SDLRPCStruct

SDLMenuCell

A menu cell item for the main menu or sub-menu.

See more

Objective-C

@interface SDLMenuCell : NSObject

Swift

class SDLMenuCell : NSObject

SDLMenuConfiguration

Defines how the menu is configured

See more

Objective-C

@interface SDLMenuConfiguration : NSObject

Swift

class SDLMenuConfiguration : NSObject

SDLMenuParams

Used when adding a sub menu to an application menu or existing sub menu.

@since SDL 1.0

See more

Objective-C

@interface SDLMenuParams : SDLRPCStruct

Swift

class SDLMenuParams : SDLRPCStruct

SDLMetadataTags

Metadata for Show fields

See more

Objective-C

@interface SDLMetadataTags : SDLRPCStruct

Swift

class SDLMetadataTags : SDLRPCStruct

SDLModuleData

Describes a remote control module’s data

See more

Objective-C

@interface SDLModuleData : SDLRPCStruct

Swift

class SDLModuleData : SDLRPCStruct

SDLModuleInfo

Contains information about a RC module.

See more

Objective-C

@interface SDLModuleInfo : SDLRPCStruct

Swift

class SDLModuleInfo : SDLRPCStruct

SDLMsgVersion

Specifies the version number of the SDL V4 interface. This is used by both the application and SDL to declare what interface version each is using.

@since SDL 1.0

See more

Objective-C

@interface SDLMsgVersion : SDLRPCStruct

Swift

class SDLMsgVersion : SDLRPCStruct

SDLMyKey

Vehicle Data struct

See more

Objective-C

@interface SDLMyKey : SDLRPCStruct

Swift

class SDLMyKey : SDLRPCStruct

SDLNavigationCapability

Extended capabilities for an onboard navigation system

See more

Objective-C

@interface SDLNavigationCapability : SDLRPCStruct

Swift

class SDLNavigationCapability : SDLRPCStruct

SDLNavigationInstruction

A navigation instruction.

See more

Objective-C

@interface SDLNavigationInstruction : SDLRPCStruct

Swift

class SDLNavigationInstruction : SDLRPCStruct

SDLNavigationServiceData

This data is related to what a navigation service would provide.

See more

Objective-C

@interface SDLNavigationServiceData : SDLRPCStruct

Swift

class SDLNavigationServiceData : SDLRPCStruct

SDLNavigationServiceManifest

A navigation service manifest.

See more

Objective-C

@interface SDLNavigationServiceManifest : SDLRPCStruct

Swift

class SDLNavigationServiceManifest : SDLRPCStruct

SDLNotificationConstants

This class defines methods for getting groups of notifications

See more

Objective-C

@interface SDLNotificationConstants : NSObject

Swift

class SDLNotificationConstants : NSObject

SDLOasisAddress

Struct used in SendLocation describing an address

See more

Objective-C

@interface SDLOasisAddress : SDLRPCStruct

Swift

class SDLOasisAddress : SDLRPCStruct

SDLOnAppInterfaceUnregistered

Notifies an application that its interface registration has been terminated. This means that all SDL resources associated with the application are discarded, including the Command Menu, Choice Sets, button subscriptions, etc.

For more information about SDL resources related to an interface registration, see SDLRegisterAppInterface.

@since SDL 1.0

See

SDLRegisterAppInterface
See more

Objective-C

@interface SDLOnAppInterfaceUnregistered : SDLRPCNotification

Swift

class SDLOnAppInterfaceUnregistered : SDLRPCNotification

SDLOnAppServiceData

This notification includes the data that is updated from the specific service.

See more

Objective-C

@interface SDLOnAppServiceData : SDLRPCNotification

Swift

class SDLOnAppServiceData : SDLRPCNotification

SDLOnAudioPassThru

Binary data is in binary part of hybrid msg.

HMILevel must be:

  • BACKGROUND, FULL, LIMITED

Objective-C

@interface SDLOnAudioPassThru : SDLRPCNotification

Swift

class SDLOnAudioPassThru : SDLRPCNotification

SDLOnButtonEvent

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 SDLSubscribeButton.

HMI Status Requirements:

HMILevel:

  • The application will receive SDLOnButtonEvent notifications for all subscribed buttons when HMILevel is FULL.

  • The application will receive SDLOnButtonEvent notifications for subscribed media buttons when HMILevel is LIMITED.

  • Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and PRESET_0-PRESET_9.

  • The application will not receive SDLOnButtonEvent notification when HMILevel is BACKGROUND.

AudioStreamingState:

  • Any

SystemContext:

  • MAIN, VR. In MENU, only PRESET buttons.

  • In VR, pressing any subscribable button will cancel VR.

See

SDLSubscribeButton

@since SDL 1.0

See more

Objective-C

@interface SDLOnButtonEvent : SDLRPCNotification

Swift

class SDLOnButtonEvent : SDLRPCNotification

SDLOnButtonPress

Notifies application of button press events for buttons to which the application is subscribed. SDL supports two button press events defined as follows:

SHORT - Occurs when a button is depressed, then released within two seconds. The event is considered to occur immediately after the button is released.

LONG - Occurs when a button is depressed and held for two seconds or more. The event is considered to occur immediately after the two second threshold has been crossed, before the button is released.

HMI Status Requirements:

HMILevel:

The application will receive OnButtonPress notifications for all subscribed buttons when HMILevel is FULL.

The application will receive OnButtonPress notifications for subscribed media buttons when HMILevel is LIMITED. Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and PRESET_0-PRESET_9.

The application will not receive OnButtonPress notification when HMILevel is BACKGROUND or NONE.

AudioStreamingState: Any

SystemContext: MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable button will cancel VR.

@since SDL 1.0

See more

Objective-C

@interface SDLOnButtonPress : SDLRPCNotification

Swift

class SDLOnButtonPress : SDLRPCNotification

SDLOnCommand

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.

Note: The sequence of SDLOnHMIStatus and SDLOnCommand notifications for user-initiated interactions is indeterminate.

@since SDL 1.0

See

SDLAddCommand SDLDeleteCommand SDLDeleteSubMenu
See more

Objective-C

@interface SDLOnCommand : SDLRPCNotification

Swift

class SDLOnCommand : SDLRPCNotification

SDLOnDriverDistraction

Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or not).

HMI Status Requirements:

HMILevel: Can be sent with FULL, LIMITED or BACKGROUND

AudioStreamingState: Any

SystemContext: Any

@since SDL 1.0

See more

Objective-C

@interface SDLOnDriverDistraction : SDLRPCNotification

Swift

class SDLOnDriverDistraction : SDLRPCNotification

SDLOnEncodedSyncPData

Callback including encoded data of any SyncP packets that SYNC needs to send back to the mobile device. Legacy / v1 Protocol implementation; responds to EncodedSyncPData. *** DEPRECATED ***

See more

Objective-C


@interface SDLOnEncodedSyncPData : SDLRPCNotification

Swift

class SDLOnEncodedSyncPData : SDLRPCNotification

SDLOnHMIStatus

  • Notifies an application that HMI conditions have changed for the application. This indicates whether the application can speak phrases, display text, perform interactions, receive button presses and events, stream audio, etc. This notification will be sent to the application when there has been a change in any one or several of the indicated states (SDLHMILevel, SDLAudioStreamingState or SDLSystemContext) for the application.

All three values are, in principle, independent of each other (though there may be some relationships). A value for one parameter should not be interpreted from the value of another parameter.

There are no guarantees about the timeliness or latency of the SDLOnHMIStatus notification. Therefore, for example, information such as SDLAudioStreamingState may not indicate that the audio stream became inaudible to the user exactly when the SDLOnHMIStatus notification was received.

@since SDL 1.0

See more

Objective-C

@interface SDLOnHMIStatus : SDLRPCNotification

Swift

class SDLOnHMIStatus : SDLRPCNotification

SDLOnHashChange

Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.). Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data.

See more

Objective-C

@interface SDLOnHashChange : SDLRPCNotification

Swift

class SDLOnHashChange : SDLRPCNotification

SDLOnInteriorVehicleData

Notifications when subscribed vehicle data changes.

See: SDLSubscribeVehicleData

See more

Objective-C

@interface SDLOnInteriorVehicleData : SDLRPCNotification

Swift

class SDLOnInteriorVehicleData : SDLRPCNotification

SDLOnKeyboardInput

Sent when a keyboard presented by a PerformInteraction has a keyboard input.

See more

Objective-C

@interface SDLOnKeyboardInput : SDLRPCNotification

Swift

class SDLOnKeyboardInput : SDLRPCNotification

SDLOnLanguageChange

Provides information to what language the SDL HMI language was changed

@since SDL 2.0

See more

Objective-C

@interface SDLOnLanguageChange : SDLRPCNotification

Swift

class SDLOnLanguageChange : SDLRPCNotification

SDLOnLockScreenStatus

To help prevent driver distraction, any SmartDeviceLink application is required to implement a lockscreen that must be enforced while the application is active on the system while the vehicle is in motion.

This lockscreen must perform the following:

Limit all application control usability from the mobile device with a full-screen static image overlay or separate view.

For simplicity, the OnLockScreenStatus RPC will be provided via the onOnLockScreenNotification call back. The call back will include the LockScreenStatus enum which indicates if the lockscreen is required, optional or not required.

The call back also includes details regarding the current HMI_Status level, driver distraction status and user selection status of the application.

See more

Objective-C


@interface SDLOnLockScreenStatus : SDLRPCNotification

Swift

class SDLOnLockScreenStatus : SDLRPCNotification

SDLOnPermissionsChange

Provides update to app of which sets of functions are available

@since SDL 2.0

See more

Objective-C

@interface SDLOnPermissionsChange : SDLRPCNotification

Swift

class SDLOnPermissionsChange : SDLRPCNotification

SDLOnRCStatus

OnRCStatus notifications to all registered mobile applications and the HMI whenever (1) SDL allocates a module to an application or (2) it de-allocates a module from an application, or (3) an application registers with SDL

See more

Objective-C

@interface SDLOnRCStatus : SDLRPCNotification

Swift

class SDLOnRCStatus : SDLRPCNotification

SDLOnSyncPData

DEPRECATED

See more

Objective-C


@interface SDLOnSyncPData : SDLRPCNotification

Swift

class SDLOnSyncPData : SDLRPCNotification

SDLOnSystemCapabilityUpdated

A notification to inform the connected device that a specific system capability has changed.

See more

Objective-C

@interface SDLOnSystemCapabilityUpdated : SDLRPCNotification

Swift

class SDLOnSystemCapabilityUpdated : SDLRPCNotification

SDLOnSystemRequest

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 Binary data can be included in hybrid part of message for some requests (such as Authentication request responses)

See more

Objective-C

@interface SDLOnSystemRequest : SDLRPCNotification

Swift

class SDLOnSystemRequest : SDLRPCNotification

SDLOnTBTClientState

Provides applications with notifications specific to the current TBT client status on the module

See more

Objective-C

@interface SDLOnTBTClientState : SDLRPCNotification

Swift

class SDLOnTBTClientState : SDLRPCNotification

SDLOnTouchEvent

Notifies about touch events on the screen’s prescribed area during video streaming

See more

Objective-C

@interface SDLOnTouchEvent : SDLRPCNotification

Swift

class SDLOnTouchEvent : SDLRPCNotification

SDLOnVehicleData

Callback for the periodic and non periodic vehicle data read function.

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLOnVehicleData : SDLRPCNotification

Swift

class SDLOnVehicleData : SDLRPCNotification

SDLOnWayPointChange

Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.

See more

Objective-C

@interface SDLOnWayPointChange : SDLRPCNotification

Swift

class SDLOnWayPointChange : SDLRPCNotification

SDLParameterPermissions

Defining sets of parameters, which are permitted or prohibited for a given RPC.

@since SDL 2.0

See more

Objective-C

@interface SDLParameterPermissions : SDLRPCStruct

Swift

class SDLParameterPermissions : SDLRPCStruct

SDLPerformAppServiceInteraction

App service providers will likely have different actions exposed to the module and app service consumers. It will be difficult to standardize these actions by RPC versions and can easily become stale. Therefore, we introduce a best-effort attempt to take actions on a service.

The PerformAppServiceInteraction request will be sent to the service that has the matching appServiceId. The serviceUri should be the fully qualified URI with all parameters that are necessary for the given action. The URI prefix and actions list will be contained in the app service provider’s manifest. SDL takes no steps to validate an app service provider’s action sheet JSON object. In the future, plug in libraries could be added to handle these sheets on a provider by provider basis.

An app service consumer can also request for this service to become the active service of its respective type. If the app service consumer currently has an HMI state of HMI_FULL this request can be performed without user interaction. If the app is currently not in that state, the HMI should present the user with a choice to allow this app service provider to become the active service of its specified type. If the app service provider is not allowed to become active, the request will not be sent to it and an unsuccessful response will be sent to the requester.

SDL should make no guarantees that: 1. App service providers offer URI prefix and URI Schema 2. App service providers will correctly respond to the requests 3. The requested app service provider will become the active service of that type 4. The serviceUri will be a correctly formatted URI from the app service consumer

See more

Objective-C

@interface SDLPerformAppServiceInteraction : SDLRPCRequest

Swift

class SDLPerformAppServiceInteraction : SDLRPCRequest

SDLPerformAppServiceInteractionResponse

Response to the request to request an app service.

See more

Objective-C

@interface SDLPerformAppServiceInteractionResponse : SDLRPCResponse

Swift

class SDLPerformAppServiceInteractionResponse : SDLRPCResponse

SDLPerformAudioPassThru

This will open an audio pass thru session. By doing so the app can receive audio data through the vehicle microphone

Function Group: AudioPassThru

HMILevel needs to be FULL, LIMITED or BACKGROUND

Since SmartDeviceLink 2.0

See SDLEndAudioPassThru

See more

Objective-C

@interface SDLPerformAudioPassThru : SDLRPCRequest

Swift

class SDLPerformAudioPassThru : SDLRPCRequest

SDLPerformAudioPassThruResponse

Response to SDLPerformAudioPassThru

Since SmartDeviceLink 2.0

Objective-C

@interface SDLPerformAudioPassThruResponse : SDLRPCResponse

Swift

class SDLPerformAudioPassThruResponse : SDLRPCResponse

SDLPerformInteraction

Performs an application-initiated interaction in which the user can select a choice from the passed choice set.

There are several ways to present a choice set: as visual pop-up menu (with an optional keyboard that allows for searches), as voice-recognition (VR) only menu, or as both a VR and visual menu. It is also possible to present only the keyboard for doing searches.

A choice set can have up to 100 items, however if you are presenting a visual only menu please be aware that the OEM may choose to limit the number of presented choices when the driver is distracted (i.e. the car is moving).

A VR-only menu could be used to ask a user to say the name of a song to play. The user’s response would only be valid if it appears in the specified choice set. A visual popup-menu could be used to present a list of albums to the user. The user would select the album they want to play from the list of presented choices. A keyboard can be used for searches. For example, the user could be asked to enter the name of a restaurant. The name can be used to search for local restaurants with the same name. When the search is completed another menu can be presented with a list of potential addresses for the destination.

If connecting to SDL Core v.6.0+, the perform interaction can be canceled programmatically using the cancelID. On older versions of SDL Core, the perform interaction will persist until the user has interacted with the perform interaction or the specified timeout has elapsed.

See

SDLCreateInteractionChoiceSet, SDLDeleteInteractionChoiceSet

@since SDL 1.0

See more

Objective-C

@interface SDLPerformInteraction : SDLRPCRequest

Swift

class SDLPerformInteraction : SDLRPCRequest

SDLPerformInteractionResponse

PerformInteraction Response is sent, when SDLPerformInteraction has been called

@since SDL 1.0

See more

Objective-C

@interface SDLPerformInteractionResponse : SDLRPCResponse

Swift

class SDLPerformInteractionResponse : SDLRPCResponse

SDLPermissionElement

An object containing the RPC name and its parameter names that should be checked when checking permissions

See more

Objective-C

@interface SDLPermissionElement : NSObject <NSCopying>

Swift

class SDLPermissionElement : NSObject, NSCopying

SDLPermissionItem

Permissions for a given set of RPCs

@since RPC 2.0

See more

Objective-C

@interface SDLPermissionItem : SDLRPCStruct

Swift

class SDLPermissionItem : SDLRPCStruct

SDLPermissionManager

The permission manager monitoring RPC permissions.

See more

Objective-C

@interface SDLPermissionManager : NSObject

Swift

class SDLPermissionManager : NSObject

SDLPhoneCapability

Extended capabilities of the module’s phone feature

See more

Objective-C

@interface SDLPhoneCapability : SDLRPCStruct

Swift

class SDLPhoneCapability : SDLRPCStruct

SDLPinchGesture

Pinch Gesture information

See more

Objective-C

@interface SDLPinchGesture : NSObject

Swift

class SDLPinchGesture : NSObject

SDLPresetBankCapabilities

Contains information about on-screen preset capabilities.

@since SDL 2.0

See more

Objective-C

@interface SDLPresetBankCapabilities : SDLRPCStruct

Swift

class SDLPresetBankCapabilities : SDLRPCStruct

SDLPublishAppService

Registers a service offered by this app on the module. Subsequent calls with the same service type will update the manifest for that service.

See more

Objective-C

@interface SDLPublishAppService : SDLRPCRequest

Swift

class SDLPublishAppService : SDLRPCRequest

SDLPublishAppServiceResponse

Response to the request to register a service offered by this app on the module.

See more

Objective-C

@interface SDLPublishAppServiceResponse : SDLRPCResponse

Swift

class SDLPublishAppServiceResponse : SDLRPCResponse

SDLPutFile

Used to push a binary data onto the SDL module from a mobile device, such as icons and album art.

Since SmartDeviceLink 2.0

See

SDLDeleteFile, SDLListFiles
See more

Objective-C

@interface SDLPutFile : SDLRPCRequest

Swift

class SDLPutFile : SDLRPCRequest

SDLPutFileResponse

Response to SDLPutFile

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLPutFileResponse : SDLRPCResponse

Swift

class SDLPutFileResponse : SDLRPCResponse

SDLRDSData

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.

See more

Objective-C

@interface SDLRDSData : SDLRPCStruct

Swift

class SDLRDSData : SDLRPCStruct

SDLRGBColor

Represents an RGB color

@since 5.0

See more

Objective-C

@interface SDLRGBColor : SDLRPCStruct

Swift

class SDLRGBColor : SDLRPCStruct

SDLRPCMessage

Parent class of all RPC messages.

Contains basic information about an RPC message.

See more

Objective-C

@interface SDLRPCMessage : SDLRPCStruct <NSCopying>

Swift

class SDLRPCMessage : SDLRPCStruct, NSCopying

SDLRPCNotification

An RPC sent from the head unit to the app about some data change, such as a button was pressed

Objective-C

@interface SDLRPCNotification : SDLRPCMessage

Swift

class SDLRPCNotification : SDLRPCMessage

SDLRPCNotificationNotification

An NSNotification object that makes retrieving internal SDLRPCNotification data easier

See more

Objective-C

@interface SDLRPCNotificationNotification : NSNotification

Swift

class SDLRPCNotificationNotification : NSNotification

SDLRPCPermissionStatus

An object containing the result status of a permission element request

See more

Objective-C

@interface SDLRPCPermissionStatus : NSObject

Swift

class SDLRPCPermissionStatus : NSObject

SDLRPCRequest

Superclass of RPC requests

See more

Objective-C

@interface SDLRPCRequest : SDLRPCMessage

Swift

class SDLRPCRequest : SDLRPCMessage

SDLRPCRequestNotification

A NSNotification object that makes retrieving internal SDLRPCRequest data easier

See more

Objective-C

@interface SDLRPCRequestNotification : NSNotification

Swift

class SDLRPCRequestNotification : NSNotification

SDLRPCResponse

Superclass of RPC responses

See more

Objective-C

@interface SDLRPCResponse : SDLRPCMessage

Swift

class SDLRPCResponse : SDLRPCMessage

SDLRPCResponseNotification

A NSNotification object that makes retrieving internal SDLRPCResponse data easier

See more

Objective-C

@interface SDLRPCResponseNotification : NSNotification

Swift

class SDLRPCResponseNotification : NSNotification

SDLRPCStruct

Superclass of all RPC-related structs and messages

See more

Objective-C

@interface SDLRPCStruct : NSObject <NSCopying>

Swift

class SDLRPCStruct : NSObject, NSCopying

SDLRadioControlCapabilities

Contains information about a radio control module’s capabilities.

See more

Objective-C

@interface SDLRadioControlCapabilities : SDLRPCStruct

Swift

class SDLRadioControlCapabilities : SDLRPCStruct

SDLRadioControlData

Include information (both read-only and changeable data) about a remote control radio module.

See more

Objective-C

@interface SDLRadioControlData : SDLRPCStruct

Swift

class SDLRadioControlData : SDLRPCStruct

SDLReadDID

Non periodic vehicle data read request. This is an RPC to get diagnostics data from certain vehicle modules. DIDs of a certain module might differ from vehicle type to vehicle type

Function Group: ProprietaryData

HMILevel needs to be FULL, LIMITED or BACKGROUND

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLReadDID : SDLRPCRequest

Swift

class SDLReadDID : SDLRPCRequest

SDLReadDIDResponse

A response to ReadDID

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLReadDIDResponse : SDLRPCResponse

Swift

class SDLReadDIDResponse : SDLRPCResponse

SDLRectangle

A struct describing a rectangle

See more

Objective-C

@interface SDLRectangle : SDLRPCStruct

Swift

class SDLRectangle : SDLRPCStruct

SDLRegisterAppInterface

Registers the application’s interface with SDL. The RegisterAppInterface RPC declares the properties of the app, including the messaging interface version, the app name, etc. The mobile application must establish its interface registration with SDL before any other interaction with SDL can take place. The registration lasts until it is terminated either by the application calling the SDLUnregisterAppInterface method, or by SDL sending an SDLOnAppInterfaceUnregistered notification, or by loss of the underlying transport connection, or closing of the underlying message transmission protocol RPC session.

Until the application receives its first SDLOnHMIStatus notification, its SDLHMILevel is assumed to be NONE, the SDLAudioStreamingState is assumed to be NOT_AUDIBLE, and the SDLSystemContext is assumed to be MAIN.

All SDL resources which the application creates or uses (e.g. choice sets, command menu, etc.) are associated with the application’s interface registration. Therefore, when the interface registration ends, the SDL resources associated with the application are disposed of. As a result, even though the application itself may continue to run on its host platform (e.g. mobile device) after the interface registration terminates, the application will not be able to use the SDL HMI without first establishing a new interface registration and re-creating its required SDL resources. That is, SDL resources created by (or on behalf of) an application do not persist beyond the life-span of the interface registration. Resources and settings whose lifespan is tied to the duration of an application’s interface registration include: choice sets, command menus, and the media clock timer display value

If the application intends to stream audio it is important to indicate so via the isMediaApp parameter. When set to true, audio will reliably stream without any configuration required by the user. When not set, audio may stream, depending on what the user might have manually configured as a media source on SDL.

@since SDL 1.0

See

SDLUnregisterAppInterface, SDLOnAppInterfaceUnregistered
See more

Objective-C

@interface SDLRegisterAppInterface : SDLRPCRequest

Swift

class SDLRegisterAppInterface : SDLRPCRequest

SDLRegisterAppInterfaceResponse

Response to SDLRegisterAppInterface

@since SDL 1.0

See more

Objective-C

@interface SDLRegisterAppInterfaceResponse : SDLRPCResponse

Swift

class SDLRegisterAppInterfaceResponse : SDLRPCResponse

SDLReleaseInteriorVehicleDataModule

Releases a controlled remote control module so others can take control

@since 6.0

See more

Objective-C

@interface SDLReleaseInteriorVehicleDataModule : SDLRPCRequest

Swift

class SDLReleaseInteriorVehicleDataModule : SDLRPCRequest

SDLReleaseInteriorVehicleDataModuleResponse

Response to ReleaseInteriorVehicleDataModule

@since RPC 6.0

Objective-C

@interface SDLReleaseInteriorVehicleDataModuleResponse : SDLRPCResponse

Swift

class SDLReleaseInteriorVehicleDataModuleResponse : SDLRPCResponse

SDLRemoteControlCapabilities

Capabilities of the remote control feature

See more

Objective-C

@interface SDLRemoteControlCapabilities : SDLRPCStruct

Swift

class SDLRemoteControlCapabilities : SDLRPCStruct

SDLResetGlobalProperties

Resets the passed global properties to their default values as defined by SDL

The HELPPROMPT global property default value is generated by SDL consists of the first vrCommand of each Command Menu item defined at the moment PTT is pressed
The TIMEOUTPROMPT global property default value is the same as the HELPPROMPT global property default value

HMILevel needs to be FULL, LIMITED or BACKGROUND

Since SmartDeviceLink 1.0 See SetGlobalProperties

See more

Objective-C

@interface SDLResetGlobalProperties : SDLRPCRequest

Swift

class SDLResetGlobalProperties : SDLRPCRequest

SDLResetGlobalPropertiesResponse

Response to ResetGlobalProperties

Since SmartDeviceLink 1.0

Objective-C

@interface SDLResetGlobalPropertiesResponse : SDLRPCResponse

Swift

class SDLResetGlobalPropertiesResponse : SDLRPCResponse

SDLSISData

HD radio Station Information Service (SIS) data.

See more

Objective-C

@interface SDLSISData : SDLRPCStruct

Swift

class SDLSISData : SDLRPCStruct

SDLScreenManager

The SDLScreenManager is a manager to control SDL UI features. Use the screen manager for setting up the UI of the template, creating a menu for your users, creating softbuttons, setting textfields, etc..

See more

Objective-C

@interface SDLScreenManager : NSObject

Swift

class SDLScreenManager : NSObject

SDLScreenParams

A struct in DisplayCapabilities describing parameters related to a video / touch input area

See more

Objective-C

@interface SDLScreenParams : SDLRPCStruct

Swift

class SDLScreenParams : SDLRPCStruct

SDLScrollableMessage

Creates a full screen overlay containing a large block of formatted text that can be scrolled with buttons available.

If connecting to SDL Core v.6.0+, the scrollable message can be canceled programmatically using the cancelID. On older versions of SDL Core, the scrollable message will persist until the user has interacted with the scrollable message or the specified timeout has elapsed.

@since SDL 2.0

See more

Objective-C

@interface SDLScrollableMessage : SDLRPCRequest

Swift

class SDLScrollableMessage : SDLRPCRequest

SDLScrollableMessageResponse

Response to SDLScrollableMessage

Since SmartDeviceLink 2.0

Objective-C

@interface SDLScrollableMessageResponse : SDLRPCResponse

Swift

class SDLScrollableMessageResponse : SDLRPCResponse

SDLSeatControlCapabilities

Include information about a seat control capabilities.

See more

Objective-C

@interface SDLSeatControlCapabilities : SDLRPCStruct

Swift

class SDLSeatControlCapabilities : SDLRPCStruct

SDLSeatControlData

Seat control data corresponds to “SEAT” ModuleType.

See more

Objective-C

@interface SDLSeatControlData : SDLRPCStruct

Swift

class SDLSeatControlData : SDLRPCStruct

SDLSeatLocation

Describes the location of a seat

See more

Objective-C

@interface SDLSeatLocation : SDLRPCStruct

Swift

class SDLSeatLocation : SDLRPCStruct

SDLSeatLocationCapability

Contains information about the locations of each seat.

See more

Objective-C

@interface SDLSeatLocationCapability : SDLRPCStruct

Swift

class SDLSeatLocationCapability : SDLRPCStruct

SDLSeatMemoryAction

Specify the action to be performed.

See more

Objective-C

@interface SDLSeatMemoryAction : SDLRPCStruct

Swift

class SDLSeatMemoryAction : SDLRPCStruct

SDLSendHapticData

Sends the spatial data gathered from SDLCarWindow or VirtualDisplayEncoder to the HMI. This data will be utilized by the HMI to determine how and when haptic events should occur.

See more

Objective-C

@interface SDLSendHapticData : SDLRPCRequest

Swift

class SDLSendHapticData : SDLRPCRequest

SDLSendHapticDataResponse

Response to SDLSendHapticData

Objective-C

@interface SDLSendHapticDataResponse : SDLRPCResponse

Swift

class SDLSendHapticDataResponse : SDLRPCResponse

SDLSendLocation

SendLocation is used to send a location to the navigation system for navigation

@since RPC 3.0

See more

Objective-C

@interface SDLSendLocation : SDLRPCRequest

Swift

class SDLSendLocation : SDLRPCRequest

SDLSendLocationResponse

Response to SDLSendLocation

Objective-C

@interface SDLSendLocationResponse : SDLRPCResponse

Swift

class SDLSendLocationResponse : SDLRPCResponse

SDLSetAppIcon

Used to set existing local file on SDL as the app’s icon. Not supported on first generation SDL modules.

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLSetAppIcon : SDLRPCRequest

Swift

class SDLSetAppIcon : SDLRPCRequest

SDLSetAppIconResponse

Response to SDLSetAppIcon

Since SmartDeviceLink 2.0

Objective-C

@interface SDLSetAppIconResponse : SDLRPCResponse

Swift

class SDLSetAppIconResponse : SDLRPCResponse

SDLSetCloudAppProperties

RPC used to enable/disable a cloud application and set authentication data

See more

Objective-C

@interface SDLSetCloudAppProperties : SDLRPCRequest

Swift

class SDLSetCloudAppProperties : SDLRPCRequest

SDLSetCloudAppPropertiesResponse

The response to SetCloudAppProperties

Objective-C

@interface SDLSetCloudAppPropertiesResponse : SDLRPCResponse

Swift

class SDLSetCloudAppPropertiesResponse : SDLRPCResponse

SDLSetDisplayLayout

Used to set an alternate display layout. If not sent, default screen for given platform will be shown

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLSetDisplayLayout : SDLRPCRequest

Swift

class SDLSetDisplayLayout : SDLRPCRequest

SDLSetDisplayLayoutResponse

Response to SDLSetDisplayLayout

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLSetDisplayLayoutResponse : SDLRPCResponse

Swift

class SDLSetDisplayLayoutResponse : SDLRPCResponse

SDLSetGlobalProperties

Sets global property values

Since SmartDeviceLink 1.0

See SDLResetGlobalProperties

See more

Objective-C

@interface SDLSetGlobalProperties : SDLRPCRequest

Swift

class SDLSetGlobalProperties : SDLRPCRequest

SDLSetGlobalPropertiesResponse

Response to SDLSetGlobalProperties

Since SmartDeviceLink 1.0

Objective-C

@interface SDLSetGlobalPropertiesResponse : SDLRPCResponse

Swift

class SDLSetGlobalPropertiesResponse : SDLRPCResponse

SDLSetInteriorVehicleData

This RPC allows a remote control type mobile application to change the settings of a specific remote control module.

See more

Objective-C

@interface SDLSetInteriorVehicleData : SDLRPCRequest

Swift

class SDLSetInteriorVehicleData : SDLRPCRequest

SDLSetInteriorVehicleDataResponse

Response to SDLSetInteriorVehicleData

See more

Objective-C

@interface SDLSetInteriorVehicleDataResponse : SDLRPCResponse

Swift

class SDLSetInteriorVehicleDataResponse : SDLRPCResponse

SDLSetMediaClockTimer

Sets the media clock/timer value and the update method (e.g.count-up, count-down, etc.)

Function Group: Base

HMILevel needs to be FULL, LIMITIED or BACKGROUND

Since SmartDeviceLink 1.0

See more

Objective-C

@interface SDLSetMediaClockTimer : SDLRPCRequest

Swift

class SDLSetMediaClockTimer : SDLRPCRequest

SDLSetMediaClockTimerResponse

Response to SDLSetMediaClockTimer

Since SmartDeviceLink 1.0

Objective-C

@interface SDLSetMediaClockTimerResponse : SDLRPCResponse

Swift

class SDLSetMediaClockTimerResponse : SDLRPCResponse

SDLShow

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. The application’s display text area remains unchanged until updated by subsequent calls to Show

The content of the application’s display text area is visible to the user when the application is FULL or LIMITED, and the SDLSystemContext=MAIN and no SDLAlert is in progress

The Show operation cannot be used to create an animated scrolling screen. To avoid distracting the driver, Show commands cannot be issued more than once every 4 seconds. Requests made more frequently than this will be rejected

HMILevel needs to be FULL, LIMITED or BACKGROUND

Since SmartDeviceLink 1.0 See SDLAlert SDLSetMediaClockTimer

See more

Objective-C

@interface SDLShow : SDLRPCRequest

Swift

class SDLShow : SDLRPCRequest

SDLShowAppMenu

Used by an app to show the app’s menu, typically this is used by a navigation app if the menu button is hidden.

Added in SmartDeviceLink 6.0

See more

Objective-C

@interface SDLShowAppMenu : SDLRPCRequest

Swift

class SDLShowAppMenu : SDLRPCRequest

SDLShowAppMenuResponse

Response to the request to show the app menu.

Objective-C

@interface SDLShowAppMenuResponse : SDLRPCResponse

Swift

class SDLShowAppMenuResponse : SDLRPCResponse

SDLShowConstantTBT

This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but also for the alert maneuver screen.

@since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLShowConstantTBT : SDLRPCRequest

Swift

class SDLShowConstantTBT : SDLRPCRequest

SDLShowConstantTBTResponse

Response to SDLShowConstantTBT

Since SmartDeviceLink 2.0

Objective-C

@interface SDLShowConstantTBTResponse : SDLRPCResponse

Swift

class SDLShowConstantTBTResponse : SDLRPCResponse

SDLShowResponse

Response to SDLShow

Since SmartDeviceLink 1.0

Objective-C

@interface SDLShowResponse : SDLRPCResponse

Swift

class SDLShowResponse : SDLRPCResponse

SDLSingleTireStatus

Tire pressure status of a single tire.

@since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLSingleTireStatus : SDLRPCStruct

Swift

class SDLSingleTireStatus : SDLRPCStruct

SDLSlider

Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider.

If connecting to SDL Core v.6.0+, the slider can be canceled programmatically using the cancelID. On older versions of SDL Core, the slider will persist until the user has interacted with the slider or the specified timeout has elapsed.

Since SDL 2.0

See more

Objective-C

@interface SDLSlider : SDLRPCRequest

Swift

class SDLSlider : SDLRPCRequest

SDLSliderResponse

Response to SDLSlider

Since SmartDeviceLink 2.0

See more

Objective-C

@interface SDLSliderResponse : SDLRPCResponse

Swift

class SDLSliderResponse : SDLRPCResponse

SDLSoftButton

Describes an on-screen button which may be presented in various contexts, e.g. templates or alerts

See more

Objective-C

@interface SDLSoftButton : SDLRPCStruct

Swift

class SDLSoftButton : SDLRPCStruct

SDLSoftButtonCapabilities

Contains information about a SoftButton’s capabilities.

@since SDL 2.0

See more

Objective-C

@interface SDLSoftButtonCapabilities : SDLRPCStruct

Swift

class SDLSoftButtonCapabilities : SDLRPCStruct

SDLSoftButtonObject

A soft button wrapper object that is capable of storing and switching between states

See more

Objective-C

@interface SDLSoftButtonObject : NSObject

Swift

class SDLSoftButtonObject : NSObject

SDLSoftButtonState

A soft button state including data such as text, name and artwork

See more

Objective-C

@interface SDLSoftButtonState : NSObject

Swift

class SDLSoftButtonState : NSObject

SDLSpeak

Speaks a phrase over the vehicle audio system using SDL’s TTS (text-to-speech) engine. The provided text to be spoken can be simply a text phrase, or it can consist of phoneme specifications to direct SDL’s TTS engine to speak a “speech-sculpted” phrase.

Receipt of the Response indicates the completion of the Speak operation, regardless of how the Speak operation may have completed (i.e. successfully, interrupted, terminated, etc.).

Requesting a new Speak operation while the application has another Speak operation already in progress (i.e. no corresponding Response for that in-progress Speak operation has been received yet) will terminate the in-progress Speak operation (causing its corresponding Response to be sent by SDL) and begin the requested Speak operation

Requesting a new Speak operation while the application has an SDLAlert operation already in progress (i.e. no corresponding Response for that in-progress SDLAlert operation has been received yet) will result in the Speak operation request being rejected (indicated in the Response to the Request)

Requesting a new SDLAlert operation while the application has a Speak operation already in progress (i.e. no corresponding Response for that in-progress Speak operation has been received yet) will terminate the in-progress Speak operation (causing its corresponding Response to be sent by SDL) and begin the requested SDLAlert operation

Requesting a new Speak operation while the application has a SDLPerformInteraction operation already in progress (i.e. no corresponding Response for that in-progress SDLPerformInteraction operation has been received yet) will result in the Speak operation request being rejected (indicated in the Response to the Request)

Requesting a SDLPerformInteraction operation while the application has a Speak operation already in progress (i.e. no corresponding Response for that in-progress Speak operation has been received yet) will terminate the in-progress Speak operation (causing its corresponding Response to be sent by SDL) and begin the requested SDLPerformInteraction operation

HMI Status Requirements:

  • HMILevel: FULL, Limited
  • AudioStreamingState: Any
  • SystemContext: MAIN, MENU, VR
  • Notes:

  • When SDLAlert is issued with MENU in effect, SDLAlert is queued and “played” when MENU interaction is completed (i.e. SystemContext reverts to MAIN). When SDLAlert is issued with VR in effect, SDLAlert is queued and “played” when VR interaction is completed (i.e. SystemContext reverts to MAIN)
  • When both SDLAlert and Speak are queued during MENU or VR, they are “played” back in the order in which they were queued, with all existing rules for “collisions” still in effect
  • Additional Notes:

  • Total character limit depends on platform.
  • Chunks are limited to 500 characters; however you can have multiple TTS chunks.
  • On old systems there is a total character limit of 500 characters across all chunks. This could vary according to the VCA.
  • @since SmartDeviceLink 1.0

    See

    SDLAlert
    See more

    Objective-C

    @interface SDLSpeak : SDLRPCRequest

    Swift

    class SDLSpeak : SDLRPCRequest

    SDLSpeakResponse

    Response to SDLSpeak

    Since SmartDeviceLink 1.0

    Objective-C

    @interface SDLSpeakResponse : SDLRPCResponse

    Swift

    class SDLSpeakResponse : SDLRPCResponse

    SDLStartTime

    Describes the hour, minute and second values used to set the media clock.

    @since SDL 1.0

    See more

    Objective-C

    @interface SDLStartTime : SDLRPCStruct

    Swift

    class SDLStartTime : SDLRPCStruct

    SDLStationIDNumber

    Describes the hour, minute and second values used to set the media clock.

    @since SDL 1.0

    See more

    Objective-C

    @interface SDLStationIDNumber : SDLRPCStruct

    Swift

    class SDLStationIDNumber : SDLRPCStruct

    SDLStreamingMediaConfiguration

    The streaming media configuration. Use this class to configure streaming media information.

    See more

    Objective-C

    @interface SDLStreamingMediaConfiguration : NSObject <NSCopying>

    Swift

    class SDLStreamingMediaConfiguration : NSObject, NSCopying

    SDLStreamingMediaManager

    Manager to help control streaming (video and audio) media services.

    See more

    Objective-C

    @interface SDLStreamingMediaManager : NSObject <SDLStreamingAudioManagerType>

    Swift

    class SDLStreamingMediaManager : NSObject, SDLStreamingAudioManagerType

    SDLStreamingVideoScaleManager

    This class consolidates the logic of scaling between the view controller’s coordinate system and the display’s coordinate system.

    The main goal of using scaling is to align different screens and use a common range of “points per inch”. This allows showing assets with a similar size on different screen resolutions.

    See more

    Objective-C

    @interface SDLStreamingVideoScaleManager : NSObject

    Swift

    class SDLStreamingVideoScaleManager : NSObject

    SDLSubscribeButton

    Establishes a subscription to button notifications for HMI buttons. Buttons are not necessarily physical buttons, but can also be “soft” buttons on a touch screen, depending on the display in the vehicle. Once subscribed to a particular button, an application will receive both SDLOnButtonEvent and SDLOnButtonPress notifications whenever that button is pressed. The application may also unsubscribe from notifications for a button by invoking the SDLUnsubscribeButton operation

    When a button is depressed, an SDLOnButtonEvent notification is sent to the application with a ButtonEventMode of BUTTONDOWN. When that same button is released, an SDLOnButtonEvent notification is sent to the application with a ButtonEventMode of BUTTONUP

    When the duration of a button depression (that is, time between depression and release) is less than two seconds, an SDLOnButtonPress notification is sent to the application (at the moment the button is released) with a ButtonPressMode of SHORT. When the duration is two or more seconds, an SDLOnButtonPress notification is sent to the application (at the moment the two seconds have elapsed) with a ButtonPressMode of LONG

    The purpose of SDLOnButtonPress notifications is to allow for programmatic detection of long button presses similar to those used to store presets while listening to the radio, for example

    When a button is depressed and released, the sequence in which notifications will be sent to the application is as follows:

    For short presses:

    • OnButtonEvent (ButtonEventMode = BUTTONDOWN)
    • OnButtonEvent (ButtonEventMode = BUTTONUP)
    • OnButtonPress (ButtonPressMode = SHORT)

    For long presses:

    • OnButtonEvent (ButtonEventMode = BUTTONDOWN)
    • OnButtonEvent (ButtonEventMode = BUTTONUP)
    • OnButtonPress (ButtonPressMode = LONG)

    HMILevel needs to be FULL, LIMITED or BACKGROUND

    Since SmartDeviceLink 1.0
    See SDLUnsubscribeButton

    See more

    Objective-C

    @interface SDLSubscribeButton : SDLRPCRequest

    Swift

    class SDLSubscribeButton : SDLRPCRequest

    SDLSubscribeButtonResponse

    Response to SDLSubscribeButton

    Since SmartDeviceLink 1.0

    Objective-C

    @interface SDLSubscribeButtonResponse : SDLRPCResponse

    Swift

    class SDLSubscribeButtonResponse : SDLRPCResponse

    SDLSubscribeVehicleData

    Subscribes to specific published vehicle data items. The data will be only sent if it has changed. The application will be notified by the onVehicleData notification whenever new data is available. The update rate is dependent on sensors, vehicle architecture and vehicle type.

    Warning

    A vehicle may only support a subset of the vehicle data items. Be prepared for the situation where a signal is not available on a vehicle.

    Function Group: Location, VehicleInfo and DrivingChara HMILevel needs to be FULL, LIMITED or BACKGROUND Since SmartDeviceLink 2.0 See SDLUnsubscribeVehicleData, SDLGetVehicleData

    See more

    Objective-C

    @interface SDLSubscribeVehicleData : SDLRPCRequest

    Swift

    class SDLSubscribeVehicleData : SDLRPCRequest

    SDLSubscribeVehicleDataResponse

    Response to SDLSubscribeVehicleData

    Since SmartDeviceLink 2.0

    See more

    Objective-C

    @interface SDLSubscribeVehicleDataResponse : SDLRPCResponse

    Swift

    class SDLSubscribeVehicleDataResponse : SDLRPCResponse

    SDLSubscribeWayPoints

    A SDLSubscribeWaypoints can be sent to subscribe for any changes in waypoints/destinations

    See

    SDLUnsubscribeWaypoints

    Objective-C

    @interface SDLSubscribeWayPoints : SDLRPCRequest

    Swift

    class SDLSubscribeWayPoints : SDLRPCRequest

    SDLSubscribeWayPointsResponse

    Response to SubscribeWayPoints

    Objective-C

    @interface SDLSubscribeWayPointsResponse : SDLRPCResponse

    Swift

    class SDLSubscribeWayPointsResponse : SDLRPCResponse

    SDLSyncMsgVersion

    Specifies the version number of the SDL V4 interface. This is used by both the application and SDL to declare what interface version each is using.

    @since SDL 1.0

    See more

    Objective-C

    
    @interface SDLSyncMsgVersion : SDLRPCStruct

    Swift

    class SDLSyncMsgVersion : SDLRPCStruct

    SDLSyncPData

    Allows binary data in the form of SyncP packets to be sent to the SYNC module. Binary data is in binary part of hybrid msg.

    *** DEPRECATED ***

    Objective-C

    
    @interface SDLSyncPData : SDLRPCRequest

    Swift

    class SDLSyncPData : SDLRPCRequest

    SDLSyncPDataResponse

    Response to SyncPData

    DEPRECATED

    Objective-C

    
    @interface SDLSyncPDataResponse : SDLRPCResponse

    Swift

    class SDLSyncPDataResponse : SDLRPCResponse

    SDLSystemCapability

    The systemCapabilityType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the SystemCapability Type is NAVIGATION then a “navigationCapability” should exist.

    First implemented in SDL Core v4.4

    See more

    Objective-C

    @interface SDLSystemCapability : SDLRPCStruct

    Swift

    class SDLSystemCapability : SDLRPCStruct

    SDLSystemCapabilityManager

    A manager that handles updating and subscribing to SDL capabilities.

    See more

    Objective-C

    @interface SDLSystemCapabilityManager : NSObject

    Swift

    class SDLSystemCapabilityManager : NSObject

    SDLSystemRequest

    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)

    @since SmartDeviceLink 3.0

    See more

    Objective-C

    @interface SDLSystemRequest : SDLRPCRequest

    Swift

    class SDLSystemRequest : SDLRPCRequest

    SDLTTSChunk

    Specifies what is to be spoken. This can be simply a text phrase, which SDL will speak according to its own rules. It can also be phonemes from either the Microsoft SAPI phoneme set, or from the LHPLUS phoneme set. It can also be a pre-recorded sound in WAV format (either developer-defined, or provided by the SDL platform).

    In SDL, words, and therefore sentences, can be built up from phonemes and are used to explicitly provide the proper pronounciation to the TTS engine. For example, to have SDL pronounce the word “read” as “red”, rather than as when it is pronounced like “reed”, the developer would use phonemes to express this desired pronounciation.

    For more information about phonemes, see http://en.wikipedia.org/wiki/Phoneme.

    @since SmartDeviceLink 1.0

    See more

    Objective-C

    @interface SDLTTSChunk : SDLRPCStruct

    Swift

    class SDLTTSChunk : SDLRPCStruct

    SDLTemperature

    Struct representing a temperature.

    See more

    Objective-C

    @interface SDLTemperature : SDLRPCStruct

    Swift

    class SDLTemperature : SDLRPCStruct

    SDLTemplateColorScheme

    A color scheme for all display layout templates.

    See more

    Objective-C

    @interface SDLTemplateColorScheme : SDLRPCStruct

    Swift

    class SDLTemplateColorScheme : SDLRPCStruct

    SDLTemplateConfiguration

    Used to set an alternate template layout to a window.

    @since SDL 6.0

    See more

    Objective-C

    @interface SDLTemplateConfiguration : SDLRPCStruct

    Swift

    class SDLTemplateConfiguration : SDLRPCStruct

    SDLTextField

    Struct defining the characteristics of a displayed field on the HMI.

    @since SDL 1.0

    See more

    Objective-C

    @interface SDLTextField : SDLRPCStruct

    Swift

    class SDLTextField : SDLRPCStruct

    SDLTireStatus

    Struct used in Vehicle Data; the status and pressure of the tires.

    See more

    Objective-C

    @interface SDLTireStatus : SDLRPCStruct

    Swift

    class SDLTireStatus : SDLRPCStruct

    SDLTouch

    Describes a touch location

    See more

    Objective-C

    @interface SDLTouch : NSObject

    Swift

    class SDLTouch : NSObject

    SDLTouchCoord

    The coordinate of a touch, used in a touch event

    See more

    Objective-C

    @interface SDLTouchCoord : SDLRPCStruct

    Swift

    class SDLTouchCoord : SDLRPCStruct

    SDLTouchEvent

    A touch which occurred on the IVI system during projection

    See more

    Objective-C

    @interface SDLTouchEvent : SDLRPCStruct

    Swift

    class SDLTouchEvent : SDLRPCStruct

    SDLTouchEventCapabilities

    The capabilities of touches during projection applications

    See more

    Objective-C

    @interface SDLTouchEventCapabilities : SDLRPCStruct

    Swift

    class SDLTouchEventCapabilities : SDLRPCStruct

    SDLTouchManager

    Touch Manager responsible for processing touch event notifications.

    See more

    Objective-C

    @interface SDLTouchManager : NSObject

    Swift

    class SDLTouchManager : NSObject

    SDLTurn

    A struct used in UpdateTurnList for Turn-by-Turn navigation applications

    See more

    Objective-C

    @interface SDLTurn : SDLRPCStruct

    Swift

    class SDLTurn : SDLRPCStruct

    SDLUnpublishAppService

    Unpublish an existing service published by this application.

    See more

    Objective-C

    @interface SDLUnpublishAppService : SDLRPCRequest

    Swift

    class SDLUnpublishAppService : SDLRPCRequest

    SDLUnpublishAppServiceResponse

    The response to UnpublishAppService

    Objective-C

    @interface SDLUnpublishAppServiceResponse : SDLRPCResponse

    Swift

    class SDLUnpublishAppServiceResponse : SDLRPCResponse

    SDLUnregisterAppInterface

    Terminates an application’s interface registration. This causes SDL® to dispose of all resources associated with the application’s interface registration (e.g. Command Menu items, Choice Sets, button subscriptions, etc.)

    After the UnregisterAppInterface operation is performed, no other operations can be performed until a new app interface registration is established by calling {@linkplain RegisterAppInterface}

    HMILevel can be FULL, LIMITED, BACKGROUND or NONE

    See SDLRegisterAppInterface SDLOnAppInterfaceUnregistered

    Objective-C

    @interface SDLUnregisterAppInterface : SDLRPCRequest

    Swift

    class SDLUnregisterAppInterface : SDLRPCRequest

    SDLUnregisterAppInterfaceResponse

    Response to UnregisterAppInterface

    SmartDeviceLink 1.0

    Objective-C

    @interface SDLUnregisterAppInterfaceResponse : SDLRPCResponse

    Swift

    class SDLUnregisterAppInterfaceResponse : SDLRPCResponse

    SDLUnsubscribeButton

    Deletes a subscription to button notifications for the specified button. For more information about button subscriptions, see SDLSubscribeButton

    Application can unsubscribe from a button that is currently being pressed (i.e. has not yet been released), but app will not get button event

    HMILevel needs to be FULL, LIMITED or BACKGROUND

    @since SmartDeviceLink 1.0
    See SDLSubscribeButton

    See more

    Objective-C

    @interface SDLUnsubscribeButton : SDLRPCRequest

    Swift

    class SDLUnsubscribeButton : SDLRPCRequest

    SDLUnsubscribeButtonResponse

    Response to UnsubscribeButton

    Since SmartDeviceLink 1.0

    Objective-C

    @interface SDLUnsubscribeButtonResponse : SDLRPCResponse

    Swift

    class SDLUnsubscribeButtonResponse : SDLRPCResponse

    SDLUnsubscribeVehicleData

    This function is used to unsubscribe the notifications from the subscribeVehicleData function

    Function Group: Location, VehicleInfo and DrivingChara

    HMILevel needs to be FULL, LIMITED or BACKGROUND

    @since SmartDeviceLink 2.0
    See SDLSubscribeVehicleData SDLGetVehicleData

    See more

    Objective-C

    @interface SDLUnsubscribeVehicleData : SDLRPCRequest

    Swift

    class SDLUnsubscribeVehicleData : SDLRPCRequest

    SDLUnsubscribeVehicleDataResponse

    Response to UnsubscribeVehicleData

    since SmartDeviceLink 2.0

    See more

    Objective-C

    @interface SDLUnsubscribeVehicleDataResponse : SDLRPCResponse

    Swift

    class SDLUnsubscribeVehicleDataResponse : SDLRPCResponse

    SDLUnsubscribeWayPoints

    Request to unsubscribe from navigation WayPoints and Destination

    Objective-C

    @interface SDLUnsubscribeWayPoints : SDLRPCRequest

    Swift

    class SDLUnsubscribeWayPoints : SDLRPCRequest

    SDLUnsubscribeWayPointsResponse

    Response to UnsubscribeWayPoints

    Objective-C

    @interface SDLUnsubscribeWayPointsResponse : SDLRPCResponse

    Swift

    class SDLUnsubscribeWayPointsResponse : SDLRPCResponse

    SDLUpdateTurnList

    Updates the list of next maneuvers, which can be requested by the user pressing the softbutton

    • “Turns” on the Navigation base screen. Three softbuttons are predefined by the system: Up, Down, Close. *

    • @since SmartDeviceLink 2.0
    See more

    Objective-C

    @interface SDLUpdateTurnList : SDLRPCRequest

    Swift

    class SDLUpdateTurnList : SDLRPCRequest

    SDLUpdateTurnListResponse

    Response to UpdateTurnList

    Since SmartDeviceLink 2.0

    Objective-C

    @interface SDLUpdateTurnListResponse : SDLRPCResponse

    Swift

    class SDLUpdateTurnListResponse : SDLRPCResponse

    SDLVehicleDataResult

    Individual published data request result

    See more

    Objective-C

    @interface SDLVehicleDataResult : SDLRPCStruct

    Swift

    class SDLVehicleDataResult : SDLRPCStruct

    SDLVehicleType

    Describes the type of vehicle the mobile phone is connected with.

    @since SDL 2.0

    See more

    Objective-C

    @interface SDLVehicleType : SDLRPCStruct

    Swift

    class SDLVehicleType : SDLRPCStruct

    SDLVersion

    Specifies a major / minor / patch version number for semantic versioning purposes and comparisons

    See more

    Objective-C

    @interface SDLVersion : NSObject <NSCopying>

    Swift

    class SDLVersion : NSObject, NSCopying

    SDLVideoStreamingCapability

    Contains information about this system’s video streaming capabilities

    See more

    Objective-C

    @interface SDLVideoStreamingCapability : SDLRPCStruct

    Swift

    class SDLVideoStreamingCapability : SDLRPCStruct

    SDLVideoStreamingFormat

    An available format for video streaming in projection applications

    See more

    Objective-C

    @interface SDLVideoStreamingFormat : SDLRPCStruct

    Swift

    class SDLVideoStreamingFormat : SDLRPCStruct

    SDLVoiceCommand

    Voice commands available for the user to speak and be recognized by the IVI’s voice recognition engine.

    See more

    Objective-C

    @interface SDLVoiceCommand : NSObject

    Swift

    class SDLVoiceCommand : NSObject

    SDLVRHelpItem

    A help item for voice commands, used locally in interaction lists and globally

    See more

    Objective-C

    @interface SDLVRHelpItem : SDLRPCStruct

    Swift

    class SDLVRHelpItem : SDLRPCStruct

    SDLWeatherAlert

    Contains information about a weather alert

    @since RPC 5.1

    See more

    Objective-C

    @interface SDLWeatherAlert : SDLRPCStruct

    Swift

    class SDLWeatherAlert : SDLRPCStruct

    SDLWeatherData

    Contains information about the current weather

    @since RPC 5.1

    See more

    Objective-C

    @interface SDLWeatherData : SDLRPCStruct

    Swift

    class SDLWeatherData : SDLRPCStruct

    SDLWeatherServiceData

    This data is related to what a weather service would provide.

    See more

    Objective-C

    @interface SDLWeatherServiceData : SDLRPCStruct

    Swift

    class SDLWeatherServiceData : SDLRPCStruct

    SDLWeatherServiceManifest

    A weather service manifest.

    See more

    Objective-C

    @interface SDLWeatherServiceManifest : SDLRPCStruct

    Swift

    class SDLWeatherServiceManifest : SDLRPCStruct

    SDLWindowCapability

    Reflects content of DisplayCapabilities, ButtonCapabilities and SoftButtonCapabilities

    @since SDL 6.0

    See more

    Objective-C

    @interface SDLWindowCapability : SDLRPCStruct

    Swift

    class SDLWindowCapability : SDLRPCStruct

    SDLWindowTypeCapabilities

    Used to inform an app how many window instances per type that can be created.

    @since SDL 6.0

    See more

    Objective-C

    @interface SDLWindowTypeCapabilities : SDLRPCStruct

    Swift

    class SDLWindowTypeCapabilities : SDLRPCStruct
    View on GitHub.com