Documentation iOS SDLAbstractProtocol Class Reference

Documentation iOSDocument current as of 07/31/2017 03:13 PM.

SDLAbstractProtocol Class Reference

Section Contents

• debugConsoleGroupName• transport• protocolDelegateTable• securityManager• appId• -sendStartSessionWithType:• -startServiceWithType:• -startSecureServiceWithType:completionHandler:• -sendEndSessionWithType:• -endServiceWithType:• -sendRPC:• -sendRPC:encrypted:error:• -sendRPCRequest:• -sendRawData:withServiceType:• -sendEncryptedRawData:onService:• -sendRawDataStream:withServiceType:• -sendHeartbeat• -handleBytesFromTransport:

https://d83tozu1c8tt6.cloudfront.net/






• -dispose

Overview

Undocumented

debugConsoleGroupName

Undocumented

transport

Undocumented

protocolDelegateTable

Undocumented

securityManager

Undocumented

appId

Undocumented

-sendStartSessionWithType:

Undocumented

-startServiceWithType:

Undocumented

-startSecureServiceWithType:completionHandler:

Undocumented

-sendEndSessionWithType:

Undocumented

-endServiceWithType:

Undocumented

-sendRPC:

Undocumented

-sendRPC:encrypted:error:

Undocumented

-sendRPCRequest:

Undocumented

-sendRawData:withServiceType:

Undocumented

-sendEncryptedRawData:onService:

Undocumented

-sendRawDataStream:withServiceType:

Undocumented

-sendHeartbeat

Undocumented

-handleBytesFromTransport:

Undocumented

-dispose

Undocumented

SDLAbstractTransport Class Reference

Section Contents

• delegate• debugConsoleGroupName• -connect• -disconnect• -sendData:• -dispose• -retryDelay

Overview

Undocumented

delegate

Undocumented


Undocumented

-connect

Undocumented

-disconnect

Undocumented

-sendData:

Undocumented

-dispose

Undocumented

-retryDelay

Undocumented

SDLAddCommand Class Reference

Section Contents

• -init• -initWithHandler:• -initWithDictionary:• -initWithId:vrCommands:handler:• -initWithId:vrCommands:menuName:handler:• -

initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler:• handler• cmdID• menuParams• vrCommands• cmdIcon

Overview

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

SDLMenuParams

A command will be added to the end of the list of elements in the Command

Menu under the following conditions: • When a SDLCommand is added with no SDLMenuParams value provided• When a SDLMenuParams value is provided with a SDLMenuParam.position

value greater than or equal to the number of menu items currently defined inthe menu specified by the SDLMenuParam.parentID value

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

a mixture of: • Choices having only VR synonym definitions, but no SDLMenuParams

definitions • Choices having only SDLMenuParams definitions, but no VR synonym

definitions • Choices having both SDLMenuParams and VR synonym definitions

HMILevel needs to be FULL, LIMITED or BACKGROUD

@since SDL 1.0

SeeSDLDeleteCommand SDLAddSubMenu SDLDeleteSubMenu

-init

Constructs a new SDLAddCommand object

-initWithHandler:

Construct a SDLAddCommand with a handler callback when an event occurs.

OBJECTIVE-C

- (instancetype)init;

SWIFT

init!()

OBJECTIVE-C

- (instancetype)initWithHandler:(SDLRPCNotificationHandler)handler;

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCNotificationHandler

handler

A callback that will be called when a button event occurs for the

command

An SDLAddCommand object

-initWithDictionary:

Constructs a new SDLAddCommand object indicated by the dictionary

parameter

SWIFT

init!(handler: SDLRPCNotificationHandler!)

PARAMETERS

RETURN VALUE


dict

The dictionary to use

-initWithId:vrCommands:handler:

Undocumented

OBJECTIVE-C

- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;

SWIFT

init!(dictionary dict: NSMutableDictionary!)

PARAMETERS

OBJECTIVE-C

@interface SDLAddCommand : SDLRPCRequest <SDLRequestHandler>

https://d83tozu1c8tt6.cloudfront.net/Protocols/SDLRequestHandler.html

-initWithId:vrCommands:menuName:handler:

Undocumented

-

initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handl

Undocumented

handler

A handler that will let you know when the button you created is subscribed.

Warning

OBJECTIVE-C


OBJECTIVE-C




This will only work if you use SDLManager.

cmdID

@abstract A Unique Command ID that identifies the command

@discussion Is returned in an SDLOnCommand notification to identify the

command selected by the user

Required, Integer, 0 - 2,000,000,000

OBJECTIVE-C

@property (readwrite, copy, nonatomic) SDLRPCNotificationHandler handler;

SWIFT

var handler: SDLRPCNotificationHandler! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *cmdID;



menuParams

@abstract a SDLMenuParams pointer which will defined the command and how

it is added to the Command Menu

@discussion If provided, this will define the command and how it is added to

the Command Menu

If null, commands will not be accessible through the HMI application menu

Optional

SWIFT

var cmdID: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLMenuParams *menuParams;

SWIFT

var menuParams: SDLMenuParams! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLMenuParams.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLMenuParams.html

vrCommands

@abstract An array of strings to be used as VR synonyms for this command.

@discussion If provided, defines one or more VR phrases the recognition of any

of which triggers the SDLOnCommand notification with this cmdID

If null, commands will not be accessible by voice commands (when the user

hits push-to-talk)

Optional, Array of Strings, Max String length 99 chars, Array size 1 - 100

cmdIcon

@abstract Image struct containing a static or dynamic icon

@discussion If provided, defines the image to be be shown along with a

command

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *vrCommands;

SWIFT

var vrCommands: NSMutableArray! { get set }

If omitted on supported displays, no (or the default if applicable) icon will be

displayed

Optional

SDLAddCommandResponse ClassReference

Section Contents

• -init• -initWithDictionary:

Overview

SDLAddCommandResponse is sent, when SDLAddCommand has been called

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLImage *cmdIcon;

SWIFT

var cmdIcon: SDLImage! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLImage.html


Since SmartDeviceLink 1.0

-init

Undocumented


Undocumented

SDLAddSubMenu Class Reference

Section Contents

• -init

OBJECTIVE-C

@interface SDLAddCommandResponse : SDLRPCResponse

OBJECTIVE-C

@interface SDLAddCommandResponse : SDLRPCResponse

• -initWithDictionary:• -initWithId:menuName:• -initWithId:menuName:position:• menuID• position• menuName

Overview

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



see SDLDeleteSubMenu SDLAddCommand SDLDeleteCommand

-init

Constructs a new SDLAddSubMenu object

OBJECTIVE-C


SWIFT

init!()


Constructs a new SDLAddSubMenu object indicated by the dictionary

parameter

dict


-initWithId:menuName:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

-initWithId:menuName:position:

Undocumented

menuID

@abstract a Menu ID that identifies a sub menu @discussion This value is used

in SDLAddCommand to which SDLSubMenu is the parent of the command being

added

OBJECTIVE-C

@interface SDLAddSubMenu : SDLRPCRequest

OBJECTIVE-C

@interface SDLAddSubMenu : SDLRPCRequest

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *menuID;

position

@abstract a position of menu @discussion An NSNumber pointer representing

the position within the items of the top level Command Menu. 0 will insert at

the front, 1 will insert after the first existing element, etc. Position of any

submenu will always be located before the return and exit options

Notes:

• Min Value: 0; Max Value: 1000• If position is greater or equal than the number of items on top level, the

sub menu will be appended by the end• If this parameter is omitted, the entry will be added at the end of the list

SWIFT

var menuID: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *position;

SWIFT

var position: NSNumber! { get set }

menuName

@abstract a menuName which is displayed representing this submenu item

@discussion NSString which will be displayed representing this submenu item

SDLAddSubMenuResponse ClassReference

Section Contents

• -init

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *menuName;

SWIFT

var menuName: String! { get set }

• -initWithDictionary:

Overview

SDLAddSubMenuResponse is sent, when SDLAddSubMenu has been called


-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLAddSubMenuResponse : SDLRPCResponse

OBJECTIVE-C

@interface SDLAddSubMenuResponse : SDLRPCResponse

SDLAirbagStatus Class Reference

Section Contents

• -init• -initWithDictionary:• driverAirbagDeployed• driverSideAirbagDeployed• driverCurtainAirbagDeployed• passengerAirbagDeployed• passengerCurtainAirbagDeployed• driverKneeAirbagDeployed• passengerSideAirbagDeployed• passengerKneeAirbagDeployed

Overview

Undocumented

-init

Undocumented


Undocumented

driverAirbagDeployed

Undocumented

driverSideAirbagDeployed

Undocumented

driverCurtainAirbagDeployed

Undocumented

passengerAirbagDeployed

Undocumented

passengerCurtainAirbagDeployed

Undocumented

driverKneeAirbagDeployed

Undocumented

passengerSideAirbagDeployed

Undocumented

passengerKneeAirbagDeployed

Undocumented

SDLAlert Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithAlertText1:alertText2:duration:• -initWithAlertText1:alertText2:alertText3:• -initWithAlertText1:alertText2:alertText3:duration:• -initWithAlertText1:alertText2:alertText3:duration:softButtons:• -initWithTTS:playTone:• -initWithTTS:alertText1:alertText2:playTone:duration:• -initWithTTS:alertText1:alertText2:alertText3:playTone:duration:• -initWithTTSChunks:playTone:• -initWithTTSChunks:alertText1:alertText2:alertText3:playTone:softButtons:• -

initWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButtons:• alertText1• alertText2• alertText3• ttsChunks• duration• playTone• progressIndicator• softButtons

Overview

Shows an alert which typically consists of text-to-speech message and text on

the display. At least either alertText1, alertText2 or TTSChunks need to be

provided.

• The displayed portion of the SDLAlert, if any, will persist until the specified

timeout has elapsed, or the SDLAlert is preempted

• An SDLAlert will preempt (abort) any SmartDeviceLink Operation that is

in-progress, except an already-in-progress SDLAlert• An SDLAlert cannot be preempted by any SmartDeviceLink Operation• An SDLAlert can be preempted by a user action (button push)• An SDLAlert will fail if it is issued while another SDLAlert is in progress• Although each Alert parameter is optional, in fact each SDLAlert request

must supply at least one of the following parameters:

◦ alertText1◦ alertText2◦ alertText3◦ ttsChunks

HMILevel needs to be FULL or LIMITED.If the app has been granted function group Notification theSDLHMILevel can also be BACKGROUND

@since SDL 1.0

-init

Constructs a new SDLAlert object

OBJECTIVE-C


SWIFT

init!()


Constructs a new SDLAlert object indicated by the dictionary parameter

dict


-initWithAlertText1:alertText2:duration:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

-initWithAlertText1:alertText2:alertText3:

Undocumented

-initWithAlertText1:alertText2:alertText3:duration:

Undocumented

OBJECTIVE-C

@interface SDLAlert : SDLRPCRequest

OBJECTIVE-C


OBJECTIVE-C


-

initWithAlertText1:alertText2:alertText3:duration:softButtons:

Undocumented

-initWithTTS:playTone:

Undocumented

-

initWithTTS:alertText1:alertText2:playTone:duration:

Undocumented

OBJECTIVE-C


OBJECTIVE-C


-

initWithTTS:alertText1:alertText2:alertText3:playTone:duration:

Undocumented

-initWithTTSChunks:playTone:

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


-

initWithTTSChunks:alertText1:alertText2:alertText3:playTone:softButtons:

Undocumented

-

initWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButto

Undocumented

alertText1

@abstract The String to be displayed in the first field of the display during the

Alert

@discussion Length is limited to what is indicated in SDLRegisterAppInterface

response

If omitted, top display line will be cleared

OBJECTIVE-C


OBJECTIVE-C


Text is always centered

Optional, Max length 500 chars

alertText2

@abstract The String to be displayed in the second field of the display during

the Alert

@discussion Only permitted if HMI supports a second display line

Length is limited to what is indicated in SDLRegisterAppInterface response

If omitted, second display line will be cleared



OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *alertText1;

SWIFT

var alertText1: String! { get set }

alertText3

@abstract the String to be displayed in the third field of the display during the

Alert @discussion Only permitted if HMI supports a third display line

Length is limited to what is indicated in SDLRegisterAppInterface response

If omitted, third display line will be cleared



OBJECTIVE-C


SWIFT


OBJECTIVE-C


ttsChunks

@abstract An array which, taken together, specify what is to be spoken to the

user

Optional, Array of SDLTTSChunk, Array length 1 - 100

SeeSDLTTSChunk

SWIFT


OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *ttsChunks;

SWIFT

var ttsChunks: NSMutableArray! { get set }

duration

@abstract The duration of the displayed portion of the alert, in milliseconds.

@discussion After this amount of time has passed, the display fields alertText1

and alertText2 will revert to what was displayed in those fields before the alert

began.

Typical timeouts are 3 - 5 seconds

If omitted, the timeout is set to 5 seconds

Optional, Integer, 3000 - 10000

playTone

@abstract Whether the alert tone should be played before the TTS (if any) is

spoken.

@discussion If ommitted, no tone is played

Optional, Boolean

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *duration;

SWIFT

var duration: NSNumber! { get set }

progressIndicator

@abstract If supported on the given platform, the alert GUI will include some

sort of animation indicating that loading of a feature is progressing. e.g. a

spinning wheel or hourglass, etc.

Optional, Boolean

@since SmartDeviceLink 2.0

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *playTone;

SWIFT

var playTone: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *progressIndicator;

softButtons

@abstract App defined SoftButtons.

@discussion If omitted on supported displays, the displayed alert shall not have

any SoftButtons

Optional, Array of SDLSoftButton, Array size 0 - 4

SeeSDLSoftButton

SWIFT

var progressIndicator: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *softButtons;

SWIFT

var softButtons: NSMutableArray! { get set }

SDLAlertManeuver Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithTTS:softButtons:• -initWithTTSChunks:softButtons:• ttsChunks• softButtons

Overview


-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLAlertManeuver : SDLRPCRequest

-initWithTTS:softButtons:

Undocumented

-initWithTTSChunks:softButtons:

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


ttsChunks

Undocumented

softButtons

Undocumented

SDLAlertManeuverResponse ClassReference

Section Contents

• -init

OBJECTIVE-C


OBJECTIVE-C



Overview

SDLAlertManeuverResponse is sent, when SDLAlertManeuver has been called. *


-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLAlertManeuverResponse : SDLRPCResponse

OBJECTIVE-C

@interface SDLAlertManeuverResponse : SDLRPCResponse

SDLAlertResponse Class Reference

Section Contents

• -init• -initWithDictionary:• tryAgainTime

Overview

Sent after SDLAlert has been sent @since SDL 1.0

-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLAlertResponse : SDLRPCResponse

tryAgainTime

Undocumented

SDLAmbientLightStatus ClassReference

Section Contents

• +valueOf:• +values• +NIGHT• +TWILIGHT_1• +TWILIGHT_2• +TWILIGHT_3

OBJECTIVE-C


OBJECTIVE-C


• +TWILIGHT_4• +DAY• +UNKNOWN• +INVALID

Overview

Reflects the status of the ambient light sensor @since SDL 3.0

+valueOf:

Undocumented

+values

Undocumented

OBJECTIVE-C

@interface SDLAmbientLightStatus : SDLEnum

OBJECTIVE-C


+NIGHT

Undocumented

+TWILIGHT_1

Undocumented

+TWILIGHT_2

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


+TWILIGHT_3

Undocumented

+TWILIGHT_4

Undocumented

+DAY

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


+UNKNOWN

Undocumented

+INVALID

Undocumented

SDLAppHMIType Class Reference

Section Contents

• +valueOf:• +values• +DEFAULT

OBJECTIVE-C


OBJECTIVE-C


• +COMMUNICATION• +MEDIA• +MESSAGING• +NAVIGATION• +INFORMATION• +SOCIAL• +BACKGROUND_PROCESS• +TESTING• +SYSTEM

Overview

Enumeration listing possible app hmi types.

@since SDL 2.0

+valueOf:

@abstract Convert String to AppHMIType

OBJECTIVE-C

+ (SDLAppHMIType *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLAppHMIType!

value

The value of the string to get an object for

SDLAppHMIType

+values

@abstract Store the enumeration of all possible SDLAppHMIType

PARAMETERS

RETURN VALUE

OBJECTIVE-C

+ (NSArray *)values;

SWIFT

class func values() -> [Any]!

an array that store all possible SDLAppHMIType

+DEFAULT

@abstract The App will have default rights.

SDLAppHMIType with value DEFAULT

RETURN VALUE

OBJECTIVE-C

+ (SDLAppHMIType *)DEFAULT;

SWIFT

class func `default`() -> SDLAppHMIType!

RETURN VALUE

+COMMUNICATION

@abstract Communication type of App

SDLAppHMIType with value COMMUNICATION

+MEDIA

@abstract App dealing with Media

OBJECTIVE-C

+ (SDLAppHMIType *)COMMUNICATION;

SWIFT

class func communication() -> SDLAppHMIType!

RETURN VALUE

SDLAppHMIType with value MEDIA

+MESSAGING

@abstract Messaging App

OBJECTIVE-C

+ (SDLAppHMIType *)MEDIA;

SWIFT

class func media() -> SDLAppHMIType!

RETURN VALUE

OBJECTIVE-C

+ (SDLAppHMIType *)MESSAGING;

SDLAppHMIType with value MESSAGING

+NAVIGATION

@abstract Navigation App

SWIFT

class func messaging() -> SDLAppHMIType!

RETURN VALUE

OBJECTIVE-C

+ (SDLAppHMIType *)NAVIGATION;

SWIFT

class func navigation() -> SDLAppHMIType!

SDLAppHMIType with value NAVIGATION

+INFORMATION

@abstract Information App

SDLAppHMIType with value INFORMATION

RETURN VALUE

OBJECTIVE-C

+ (SDLAppHMIType *)INFORMATION;

SWIFT

class func information() -> SDLAppHMIType!

RETURN VALUE

+SOCIAL

@abstract App dealing with social media

SDLAppHMIType with value SOCIAL

+BACKGROUND_PROCESS

Undocumented

OBJECTIVE-C

+ (SDLAppHMIType *)SOCIAL;

SWIFT

class func social() -> SDLAppHMIType!

RETURN VALUE

+TESTING

@abstract App only for Testing purposes

SDLAppHMIType with value TESTING

OBJECTIVE-C

@interface SDLAppHMIType : SDLEnum

OBJECTIVE-C

+ (SDLAppHMIType *)TESTING;

SWIFT

class func testing() -> SDLAppHMIType!

RETURN VALUE

+SYSTEM

@abstract System App

SDLAppHMIType with value SYSTEM

SDLAppInfo Class Reference

Section Contents

• +currentAppInfo

OBJECTIVE-C

+ (SDLAppHMIType *)SYSTEM;

SWIFT

class func system() -> SDLAppHMIType!

RETURN VALUE

• appDisplayName• appBundleID• appVersion

Overview

Undocumented

+currentAppInfo

Undocumented

appDisplayName

Undocumented

appBundleID

Undocumented

appVersion

Undocumented

SDLAppInterfaceUnregisteredReasonClass Reference

Section Contents

• +valueOf:• +values• +IGNITION_OFF

• +BLUETOOTH_OFF• +USB_DISCONNECTED• +REQUEST_WHILE_IN_NONE_HMI_LEVEL• +TOO_MANY_REQUESTS• +DRIVER_DISTRACTION_VIOLATION• +LANGUAGE_CHANGE• +MASTER_RESET• +FACTORY_DEFAULTS• +APP_UNAUTHORIZED

Overview

Indicates reason why app interface was unregistered. The application is being

disconnected by SDL.

@since SDL 1.0

+valueOf:

@abstract Convert String to SDLAppInterfaceUnregisteredReason

OBJECTIVE-C

+ (SDLAppInterfaceUnregisteredReason *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLAppInterfaceUnregisteredReason!

value

String value to retrieve the object for

SDLAppInterfaceUnregisteredReason

+values

@abstract Store the enumeration of all possible

SDLAppInterfaceUnregisteredReason

PARAMETERS

RETURN VALUE

OBJECTIVE-C


SWIFT


an array that stores all possible SDLAppInterfaceUnregisteredReason

+IGNITION_OFF

@abstract Vehicle ignition turned off.

SDLAppInterfaceUnregisteredReason with value IGNITION_OFF

RETURN VALUE

OBJECTIVE-C

+ (SDLAppInterfaceUnregisteredReason *)IGNITION_OFF;

SWIFT

class func ignition_OFF() -> SDLAppInterfaceUnregisteredReason!

RETURN VALUE

+BLUETOOTH_OFF

@abstract Bluetooth was turned off, causing termination of a necessary

Bluetooth connection.

SDLAppInterfaceUnregisteredReason with value BLUETOOTH_OFF

+USB_DISCONNECTED

@abstract USB was disconnected, causing termination of a necessary iAP

connection.

OBJECTIVE-C

+ (SDLAppInterfaceUnregisteredReason *)BLUETOOTH_OFF;

SWIFT

class func bluetooth_OFF() -> SDLAppInterfaceUnregisteredReason!

RETURN VALUE

SDLAppInterfaceUnregisteredReason with value USB_DISCONNECTED

+REQUEST_WHILE_IN_NONE_HMI_LEVEL

@abstract Application attempted SmartDeviceLink RPC request while HMILevel

= NONE. App must have HMILevel other than NONE to issue RPC requests or

get notifications or RPC responses.

OBJECTIVE-C

+ (SDLAppInterfaceUnregisteredReason *)USB_DISCONNECTED;

SWIFT

class func usb_DISCONNECTED() -> SDLAppInterfaceUnregisteredReason!

RETURN VALUE

SDLAppInterfaceUnregisteredReason with value

REQUEST_WHILE_IN_NONE_HMI_LEVEL

+TOO_MANY_REQUESTS

@abstract Either too many – or too many per unit of time – requests were made

by the application.

OBJECTIVE-C

+ (SDLAppInterfaceUnregisteredReason *)REQUEST_WHILE_IN_NONE_HMI_LEVEL;

SWIFT

class func request_WHILE_IN_NONE_HMI_LEVEL() -> SDLAppInterfaceUnregisteredReason!

RETURN VALUE

SDLAppInterfaceUnregisteredReason with value TOO_MANY_REQUESTS

+DRIVER_DISTRACTION_VIOLATION

@abstract The application has issued requests which cause driver distraction

rules to be violated.

OBJECTIVE-C

+ (SDLAppInterfaceUnregisteredReason *)TOO_MANY_REQUESTS;

SWIFT

class func too_MANY_REQUESTS() -> SDLAppInterfaceUnregisteredReason!

RETURN VALUE

OBJECTIVE-C

+ (SDLAppInterfaceUnregisteredReason *)DRIVER_DISTRACTION_VIOLATION;

SDLAppInterfaceUnregisteredReason with value

DRIVER_DISTRACTION_VIOLATION

+LANGUAGE_CHANGE

@abstract The user performed a language change on the SDL platform, causing

the application to need to be reregistered for the new language.

SWIFT

class func driver_DISTRACTION_VIOLATION() -> SDLAppInterfaceUnregisteredReason!

RETURN VALUE

OBJECTIVE-C

+ (SDLAppInterfaceUnregisteredReason *)LANGUAGE_CHANGE;

SDLAppInterfaceUnregisteredReason with value LANGUAGE_CHANGE

+MASTER_RESET

@abstract The user performed a MASTER RESET on the SDL platform, causing

removal of a necessary Bluetooth pairing.

SWIFT

class func language_CHANGE() -> SDLAppInterfaceUnregisteredReason!

RETURN VALUE

OBJECTIVE-C

+ (SDLAppInterfaceUnregisteredReason *)MASTER_RESET;

SWIFT

class func master_RESET() -> SDLAppInterfaceUnregisteredReason!

SDLAppInterfaceUnregisteredReason with value MASTER_RESET

+FACTORY_DEFAULTS

@abstract The user restored settings to FACTORY DEFAULTS on the SDL

platform.

SDLAppInterfaceUnregisteredReason with value FACTORY_DEFAULTS

RETURN VALUE

OBJECTIVE-C

+ (SDLAppInterfaceUnregisteredReason *)FACTORY_DEFAULTS;

SWIFT

class func factory_DEFAULTS() -> SDLAppInterfaceUnregisteredReason!

RETURN VALUE

+APP_UNAUTHORIZED

@abstract The app is not being authorized to be connected to SDL.

@since SDL 2.0

SDLAppInterfaceUnregisteredReason with value APP_UNAUTHORIZED

OBJECTIVE-C

+ (SDLAppInterfaceUnregisteredReason *)APP_UNAUTHORIZED;

SWIFT

class func app_UNAUTHORIZED() -> SDLAppInterfaceUnregisteredReason!

RETURN VALUE

SDLArtwork Class Reference

Section Contents

• +artworkWithImage:name:asImageFormat:• +persistentArtworkWithImage:name:asImageFormat:• -initWithImage:name:persistent:asImageFormat:

Overview

Undocumented

+artworkWithImage:name:asImageFormat:

Convenience Helper to create an ephemeral artwork from an image.

This is an ephemeral file, it will not be persisted through sessions / ignition

cycles. Any files that you do not know you will use in future sessions should be

created through this method. For example, album / artist artwork should be

ephemeral.

Persistent files should be created using

persistentArtworkWithImage:name:asImageFormat:

Warning

It is strongly recommended to pass the file url using an SDLFile initializer

instead of the image. If you pass the UIImage, it is loaded into memory, and will

be dumped to a temporary file. This will create a duplicate file. Only pass a

UIImage if the image is not stored on disk.

image

The UIImage to be sent to the remote head unit

name

The name of the file that will be used to reference the file in the future

(for example on the remote file system).

OBJECTIVE-C

+ (nonnull instancetype)artworkWithImage:(nonnull UIImage *)image name:(nonnull NSString *)name asImageFormat:(SDLArtworkImageFormat)imageFormat;

SWIFT

convenience init(image: Any!, name: String, as imageFormat: SDLArtworkImageFormat)

PARAMETERS

https://d83tozu1c8tt6.cloudfront.net/Enums/SDLArtworkImageFormat.html


imageFormat

Whether the image should be converted to a PNG or JPG before

transmission. Images with transparency or few colors should be PNGs.

Images with many colors should be JPGs.

An instance of this class to be passed to the file manager.

+persistentArtworkWithImage:name:asImageFormat:

Convenience Helper to create a persistent artwork from an image.

This is a persistent file, it will be persisted through sessions / ignition cycles.

You will only have a limited space for all files, so be sure to only persist files

that are required for all or most sessions. For example, menu artwork should be

persistent.

Ephemeral files should be created using

ephemeralArtworkWithImage:name:asImageFormat:

Warning

It is strongly recommended to pass the file url using an SDLFile initializer

instead of the image. If you pass the UIImage, it is loaded into memory, and will

RETURN VALUE

be dumped to a temporary file. This will create a duplicate file. Only pass a

UIImage if the image is not stored on disk.

image


name



OBJECTIVE-C

+ (nonnull instancetype)persistentArtworkWithImage:(nonnull UIImage *)image name:(nonnull NSString *)name asImageFormat: (SDLArtworkImageFormat)imageFormat;

SWIFT

class func persistentArtwork(withImage image: Any!, name: String, as imageFormat: SDLArtworkImageFormat) -> Self

PARAMETERS



imageFormat





-initWithImage:name:persistent:asImageFormat:

Create a file for transmission to the remote system from a UIImage.

RETURN VALUE

OBJECTIVE-C

- (nonnull instancetype)initWithImage:(nonnull UIImage *)image name:(nonnull NSString *)name persistent:(BOOL)persistent asImageFormat:(SDLArtworkImageFormat)imageFormat;


image


name



persistent

Whether or not the artwork should be persistent.

imageFormat




SWIFT

init(image: Any!, name: String, persistent: Bool, as imageFormat: SDLArtworkImageFormat)

PARAMETERS



SDLAudioPassThruCapabilities ClassReference

Section Contents

• -init• -initWithDictionary:• samplingRate• bitsPerSample• audioType

Overview

Describes different audio type configurations for SDLPerformAudioPassThru,

e.g. {8kHz,8-bit,PCM}

Parameter List

Name Type DescriptionSmartDeviceLink Ver.Available

RETURN VALUE

samplingRate SDLSamplingRate*

Describes thesampling rate forAudioPassThru

SmartDeviceLink 2.0

bitsPerSample SDLBitsPerSample*

Describes thesample depth inbit forAudioPassThru

SmartDeviceLink 2.0

audioType SDLAudioType * Describes theaudiotype forAudioPassThru

SmartDeviceLink 2.0


-init

Constructs a newly allocated SDLAudioPassThruCapabilities object


Constructs a newly allocated SDLAudioPassThruCapabilities object indicated by

the Hashtable parameter - parameter: dict The dictionary to use

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


samplingRate

@abstract The sampling rate for AudioPassThru

SWIFT


PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLSamplingRate *samplingRate;

SWIFT

var samplingRate: SDLSamplingRate! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLSamplingRate.html


bitsPerSample

@abstract The sample depth in bit for AudioPassThru

audioType

@abstract The audiotype for AudioPassThru

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLBitsPerSample *bitsPerSample;

SWIFT

var bitsPerSample: SDLBitsPerSample! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLAudioType *audioType;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLBitsPerSample.html


https://d83tozu1c8tt6.cloudfront.net/Classes/SDLAudioType.html

SDLAudioStreamingState ClassReference

Section Contents

• +valueOf:• +values• +AUDIBLE• +ATTENUATED• +NOT_AUDIBLE

Overview

Describes whether or not streaming audio is currently audible to the user.

Though provided in every OnHMIStatus notification, this information is only

relevant for applications that declare themselves as media apps in

RegisterAppInterface

@since SDL 1.0

+valueOf:

@abstract Convert String to SDLAudioStreamingState

SWIFT

var audioType: SDLAudioType! { get set }


value


SDLAudioStreamingState

+values

@abstract Store the enumeration of all possible SDLAudioStreamingState

OBJECTIVE-C

+ (SDLAudioStreamingState *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLAudioStreamingState!

PARAMETERS

RETURN VALUE

an array that store all possible SDLAudioStreamingState

+AUDIBLE

@abstract Currently streaming audio, if any, is audible to user.

OBJECTIVE-C


SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLAudioStreamingState *)AUDIBLE;

SDLAudioStreamingState with value of AUDIBLE

+ATTENUATED

@abstract Some kind of audio mixing is taking place. Currently streaming

audio, if any, is audible to the user at a lowered volume.

@since SDL 2.0

SWIFT

class func audible() -> SDLAudioStreamingState!

RETURN VALUE

OBJECTIVE-C

+ (SDLAudioStreamingState *)ATTENUATED;

SWIFT

class func attenuated() -> SDLAudioStreamingState!

SDLAudioStreamingState with value of ATTENUATED

+NOT_AUDIBLE

@abstract Currently streaming audio, if any, is not audible to user. made via VR

session.

SDLAudioStreamingState with value of NOT_AUDIBLE

RETURN VALUE

OBJECTIVE-C

+ (SDLAudioStreamingState *)NOT_AUDIBLE;

SWIFT

class func not_AUDIBLE() -> SDLAudioStreamingState!

RETURN VALUE

SDLAudioType Class Reference

Section Contents

• +valueOf:• +values• +PCM

Overview

Describes different audio type options for PerformAudioPassThru

+valueOf:

@abstract Convert String to SDLAudioType

OBJECTIVE-C

+ (SDLAudioType *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLAudioType!

value


SDLAudioType

+values

@abstract Store the enumeration of all possible SDLAudioType

PARAMETERS

RETURN VALUE

OBJECTIVE-C


SWIFT


an array that store all possible SDLAudioType

+PCM

@abstract PCM raw audio

@since SDL 2.0

SDLAudioType with value of PCM

RETURN VALUE

OBJECTIVE-C

+ (SDLAudioType *)PCM;

SWIFT

class func pcm() -> SDLAudioType!

RETURN VALUE

SDLBeltStatus Class Reference

Section Contents

• -init• -initWithDictionary:• driverBeltDeployed• passengerBeltDeployed• passengerBuckleBelted• driverBuckleBelted• leftRow2BuckleBelted• passengerChildDetected• rightRow2BuckleBelted• middleRow2BuckleBelted• middleRow3BuckleBelted• leftRow3BuckleBelted• rightRow3BuckleBelted• leftRearInflatableBelted• rightRearInflatableBelted• middleRow1BeltDeployed• middleRow1BuckleBelted

Overview

Undocumented

-init

Undocumented


Undocumented

driverBeltDeployed

Undocumented

passengerBeltDeployed

Undocumented

passengerBuckleBelted

Undocumented

driverBuckleBelted

Undocumented

leftRow2BuckleBelted

Undocumented

passengerChildDetected

Undocumented

rightRow2BuckleBelted

Undocumented

middleRow2BuckleBelted

Undocumented


Undocumented

leftRow3BuckleBelted

Undocumented

rightRow3BuckleBelted

Undocumented

leftRearInflatableBelted

Undocumented

rightRearInflatableBelted

Undocumented

middleRow1BeltDeployed

Undocumented


Undocumented

SDLBitsPerSample Class Reference

Section Contents

• +valueOf:• +values• +_8_BIT• +_16_BIT

Overview

Describes different bit depth options for PerformAudioPassThru

@since SDL 2.0

+valueOf:

@abstract Convert String to SDLBitsPerSample

OBJECTIVE-C

+ (SDLBitsPerSample *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLBitsPerSample!

value


SDLBitsPerSample

+values

@abstract Store the enumeration of all possible SDLBitsPerSample

PARAMETERS

RETURN VALUE

OBJECTIVE-C


SWIFT


an array that store all possible SDLBitsPerSample

+_8_BIT

@abstract 8 bits per sample

a SDLBitsPerSample with value of 8_BIT

RETURN VALUE

OBJECTIVE-C

+ (SDLBitsPerSample *)_8_BIT;

SWIFT

class func _8_BIT() -> SDLBitsPerSample!

RETURN VALUE

+_16_BIT

@abstract 16 bits per sample

a SDLBitsPerSample with value of 16_BIT

SDLBodyInformation Class Reference

Section Contents

• -init

OBJECTIVE-C

+ (SDLBitsPerSample *)_16_BIT;

SWIFT

class func _16_BIT() -> SDLBitsPerSample!

RETURN VALUE

• -initWithDictionary:• parkBrakeActive• ignitionStableStatus• ignitionStatus• driverDoorAjar• passengerDoorAjar• rearLeftDoorAjar• rearRightDoorAjar

Overview

The body information including power modes.

-init

@abstract Constructs a new SDLBodyInformation object

OBJECTIVE-C


SWIFT

init!()


@abstract Constructs a new SDLBodyInformation object indicated by the

NSMutableDictionary parameter - parameter: dict The dictionary to use

dict


parkBrakeActive

@abstract References signal “PrkBrkActv_B_Actl”.

OBJECTIVE-C


SWIFT


PARAMETERS

ignitionStableStatus

@abstract References signal “Ignition_Switch_Stable”. See IgnitionStableStatus.

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *parkBrakeActive;

SWIFT

var parkBrakeActive: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLIgnitionStableStatus *ignitionStableStatus;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLIgnitionStableStatus.html

ignitionStatus

@abstract References signal “Ignition_status”. See IgnitionStatus.

driverDoorAjar

@abstract References signal “DrStatDrv_B_Actl”.

SWIFT

var ignitionStableStatus: SDLIgnitionStableStatus! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLIgnitionStatus *ignitionStatus;

SWIFT

var ignitionStatus: SDLIgnitionStatus! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLIgnitionStableStatus.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLIgnitionStatus.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLIgnitionStatus.html

passengerDoorAjar

@abstract References signal “DrStatPsngr_B_Actl”.

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *driverDoorAjar;

SWIFT

var driverDoorAjar: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *passengerDoorAjar;

SWIFT

var passengerDoorAjar: NSNumber! { get set }

rearLeftDoorAjar

@abstract References signal “DrStatRl_B_Actl”.

rearRightDoorAjar

@abstract References signal “DrStatRr_B_Actl”.

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *rearLeftDoorAjar;

SWIFT

var rearLeftDoorAjar: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *rearRightDoorAjar;

SDLButtonCapabilities Class Reference

Section Contents

• -init• -initWithDictionary:• name• shortPressAvailable• longPressAvailable• upDownAvailable

Overview

Provides information about the capabilities of a SDL HMI button.

@since SDL 1.0

-init

Constructs a newly allocated SDLButtonCapabilities object

SWIFT

var rearRightDoorAjar: NSNumber! { get set }


Constructs a newly allocated SDLButtonCapabilities object indicated by the

Hashtable parameter - parameter: dict The dictionary to use

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


name

@abstract The name of the SDL HMI button.

shortPressAvailable

@abstract A NSNumber value indicates whether the button supports a SHORT

press

Required, Boolean

PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLButtonName *name;

SWIFT

var name: SDLButtonName! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLButtonName.html


longPressAvailable

@abstract A NSNumber value indicates whether the button supports a LONG

press

Required, Boolean

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *shortPressAvailable;

SWIFT

var shortPressAvailable: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *longPressAvailable;

upDownAvailable

@abstract A NSNumber value indicates whether the button supports “button

down” and “button up”

Required, Boolean

SWIFT

var longPressAvailable: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *upDownAvailable;

SWIFT

var upDownAvailable: NSNumber! { get set }

SDLButtonEventMode Class Reference

Section Contents

• +valueOf:• +values• +BUTTONUP• +BUTTONDOWN

Overview

Indicates whether the button was depressed or released. A BUTTONUP event

will always be preceded by a BUTTONDOWN event.

@since SDL 1.0

+valueOf:

@abstract Convert String to SDLButtonEventMode - parameter: value The value

of the string to get an object for - returns: SDLButtonEventMode (BUTTONUP /

BUTTONDOWN)

OBJECTIVE-C

+ (SDLButtonEventMode *)valueOf:(NSString *)value;

value


SDLButtonEventMode (BUTTONUP / BUTTONDOWN)

+values

@abstract Store the enumeration of all possible SDLButtonEventMode - returns:

an array that store all possible SDLButtonEventMode

SWIFT

class func value(of value: String!) -> SDLButtonEventMode!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


an array that store all possible SDLButtonEventMode

+BUTTONUP

@abstract The button was released - returns: a SDLButtonEventMode with

value of BUTTONUP

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLButtonEventMode *)BUTTONUP;

SWIFT

class func buttonup() -> SDLButtonEventMode!

a SDLButtonEventMode with value of BUTTONUP

+BUTTONDOWN

@abstract The button was depressed - returns: a SDLButtonEventMode with

value of BUTTONDOWN

a SDLButtonEventMode with value of BUTTONDOWN

RETURN VALUE

OBJECTIVE-C

+ (SDLButtonEventMode *)BUTTONDOWN;

SWIFT

class func buttondown() -> SDLButtonEventMode!

RETURN VALUE

SDLButtonName Class Reference

Section Contents

• +valueOf:• +values• +OK• +SEEKLEFT• +SEEKRIGHT• +TUNEUP• +TUNEDOWN• +PRESET_0• +PRESET_1• +PRESET_2• +PRESET_3• +PRESET_4• +PRESET_5• +PRESET_6• +PRESET_7• +PRESET_8• +PRESET_9• +CUSTOM_BUTTON• +SEARCH

Overview

Defines logical buttons which, on a given SDL unit, would correspond to either

physical or soft (touchscreen) buttons. These logical buttons present a standard

functional abstraction which the developer can rely upon, independent of the

SDL unit. For example, the developer can rely upon the OK button having the

same meaning to the user across SDL platforms.

The preset buttons (0-9) can typically be interpreted by the application as

corresponding to some user-configured choices, though the application is free

to interpret these button presses as it sees fit.

The application can discover which buttons a given SDL unit implements by

interrogating the ButtonCapabilities parameter of the RegisterAppInterface

response.

@since SDL 1.0

+valueOf:

@abstract Convert String to SDLButtonName

value


OBJECTIVE-C

+ (SDLButtonName *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLButtonName!

PARAMETERS

SDLButtonName

+values

@abstract Store the enumeration of all possible SDLButtonName

an array that store all possible SDLButtonName

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+OK

@abstract Represents the button usually labeled “OK”. A typical use of this

button is for the user to press it to make a selection.

a SDLButtonName with the value of OK

+SEEKLEFT

@abstract Represents the seek-left button. A typical use of this button is for the

user to scroll to the left through menu choices one menu item per press.

OBJECTIVE-C

+ (SDLButtonName *)OK;

SWIFT

class func ok() -> SDLButtonName!

RETURN VALUE

a SDLButtonName with the value of SEEKLEFT

+SEEKRIGHT

@abstract Represents the seek-right button. A typical use of this button is for

the user to scroll to the right through menu choices one menu item per press.

OBJECTIVE-C

+ (SDLButtonName *)SEEKLEFT;

SWIFT

class func seekleft() -> SDLButtonName!

RETURN VALUE

OBJECTIVE-C

+ (SDLButtonName *)SEEKRIGHT;

a SDLButtonName with the value of SEEKRIGHT

+TUNEUP

@abstract Represents a turn of the tuner knob in the clockwise direction one

tick.

SWIFT

class func seekright() -> SDLButtonName!

RETURN VALUE

OBJECTIVE-C

+ (SDLButtonName *)TUNEUP;

SWIFT

class func tuneup() -> SDLButtonName!

a SDLButtonName with the value of TUNEUP

+TUNEDOWN

@abstract Represents a turn of the tuner knob in the counter-clockwise

direction one tick.

a SDLButtonName with the value of TUNEDOWN

RETURN VALUE

OBJECTIVE-C

+ (SDLButtonName *)TUNEDOWN;

SWIFT

class func tunedown() -> SDLButtonName!

RETURN VALUE

+PRESET_0

@abstract Represents the preset 0 button.

a SDLButtonName with the value of PRESET_0

+PRESET_1


OBJECTIVE-C

+ (SDLButtonName *)PRESET_0;

SWIFT

class func preset_0() -> SDLButtonName!

RETURN VALUE


+PRESET_2


OBJECTIVE-C


SWIFT


RETURN VALUE

OBJECTIVE-C



+PRESET_3


SWIFT


RETURN VALUE

OBJECTIVE-C


SWIFT



+PRESET_4



RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+PRESET_5



+PRESET_6


OBJECTIVE-C


SWIFT


RETURN VALUE


+PRESET_7


OBJECTIVE-C


SWIFT


RETURN VALUE

OBJECTIVE-C



+PRESET_8


SWIFT


RETURN VALUE

OBJECTIVE-C


SWIFT



+PRESET_9



RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+CUSTOM_BUTTON

Undocumented

+SEARCH

Undocumented

SDLButtonPressMode Class Reference

Section Contents

• +valueOf:• +values• +LONG

OBJECTIVE-C

@interface SDLButtonName : SDLEnum

OBJECTIVE-C

@interface SDLButtonName : SDLEnum

• +SHORT

Overview

Indicates whether this is a LONG or SHORT button press

@since SDL 1.0

+valueOf:

@abstract Convert String to SDLButtonPressMode

value


OBJECTIVE-C

+ (SDLButtonPressMode *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLButtonPressMode!

PARAMETERS

SDLButtonPressMode

+values

@abstract Store the enumeration of all possible SDLButtonPressMode

an array that store all possible SDLButtonPressMode

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+LONG

@abstract A button was released, after it was pressed for a long time. Actual

timing is defined by the head unit and may vary.

a SDLButtonPressMode with the value of LONG

+SHORT

@abstract A button was released, after it was pressed for a short time. Actual

timing is defined by the head unit and may vary.

OBJECTIVE-C

+ (SDLButtonPressMode *)LONG;

SWIFT

class func long() -> SDLButtonPressMode!

RETURN VALUE

a SDLButtonPressMode with the value of SHORT

SDLCarModeStatus Class Reference

Section Contents

• +valueOf:• +values• +NORMAL• +FACTORY• +TRANSPORT• +CRASH

OBJECTIVE-C

+ (SDLButtonPressMode *)SHORT;

SWIFT

class func short() -> SDLButtonPressMode!

RETURN VALUE

Overview

Describes the carmode the vehicle is in. * Since SmartDeviceLink 2.0

+valueOf:

Undocumented

+values

Undocumented

+NORMAL

Provides carmode NORMAL to each module.

OBJECTIVE-C

@interface SDLCarModeStatus : SDLEnum

OBJECTIVE-C

@interface SDLCarModeStatus : SDLEnum

+FACTORY

Provides carmode FACTORY to each module.

OBJECTIVE-C

+ (SDLCarModeStatus *)NORMAL;

SWIFT

class func normal() -> SDLCarModeStatus!

OBJECTIVE-C

+ (SDLCarModeStatus *)FACTORY;

SWIFT

class func factory() -> SDLCarModeStatus!

+TRANSPORT

Provides carmode TRANSPORT to each module.

+CRASH

Provides carmode CRASH to each module.

OBJECTIVE-C

+ (SDLCarModeStatus *)TRANSPORT;

SWIFT

class func transport() -> SDLCarModeStatus!

OBJECTIVE-C

+ (SDLCarModeStatus *)CRASH;

SDLChangeRegistration Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithLanguage:hmiDisplayLanguage:• -

initWithLanguage:hmiDisplayLanguage:appName:ttsName:ngnMediaScreenAppName:vrSynonyms:• language• hmiDisplayLanguage• appName• ttsName• ngnMediaScreenAppName• vrSynonyms

Overview

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

SWIFT

class func crash() -> SDLCarModeStatus!

@since SDL 2.0

-init

Constructs a new SDLChangeRegistration object


Constructs a new SDLChangeRegistration object indicated by the dictionary

parameter

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


-initWithLanguage:hmiDisplayLanguage:

Undocumented

-

initWithLanguage:hmiDisplayLanguage:appName:ttsName:ngnMediaScreenApp

Undocumented

SWIFT


PARAMETERS

OBJECTIVE-C

@interface SDLChangeRegistration : SDLRPCRequest

language

@abstract The language the app wants to change to

hmiDisplayLanguage

@abstract HMI display language

OBJECTIVE-C

@interface SDLChangeRegistration : SDLRPCRequest

OBJECTIVE-C

@property (readwrite, strong, nonatomic) SDLLanguage *language;

SWIFT

var language: SDLLanguage! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLLanguage.html


appName

Request a new app name registration

Optional, Max string length 100 chars

OBJECTIVE-C

@property (readwrite, strong, nonatomic) SDLLanguage *hmiDisplayLanguage;

SWIFT

var hmiDisplayLanguage: SDLLanguage! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *appName;



ttsName

Request a new TTSName registration.

Optional, Array of SDLTTSChunk, 1 - 100 elements

ngnMediaScreenAppName

Request a new app short name registration

Optional, Max string length 100 chars

SWIFT

var appName: String! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSArray *ttsName;

SWIFT

var ttsName: [Any]! { get set }

vrSynonyms

Request a new VR synonyms registration

Optional, Array of NSString, 1 - 100 elements, max string length 40 chars

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *ngnMediaScreenAppName;

SWIFT

var ngnMediaScreenAppName: String! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSArray *vrSynonyms;

SDLChangeRegistrationResponse ClassReference

Section Contents


Overview

SDLChangeRegistrationResponse is sent, when SDLChangeRegistration has

been called

@since SDL 2.0

-init

Undocumented

SWIFT

var vrSynonyms: [Any]! { get set }


Undocumented

SDLCharacterSet Class Reference

Section Contents

• +valueOf:• +values• +TYPE2SET• +TYPE5SET• +CID1SET• +CID2SET

OBJECTIVE-C

@interface SDLChangeRegistrationResponse : SDLRPCResponse

OBJECTIVE-C

@interface SDLChangeRegistrationResponse : SDLRPCResponse

Overview

Character sets supported by SDL.

@since SDL 1.0

+valueOf:

@abstract Convert String to SDLCharacterSet

value


OBJECTIVE-C

+ (SDLCharacterSet *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLCharacterSet!

PARAMETERS

SDLCharacterSet

+values

@abstract Store the enumeration of all possible SDLCharacterSet

an array that store all possible SDLCharacterSet

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+TYPE2SET

Undocumented

+TYPE5SET

Undocumented

+CID1SET

Undocumented

OBJECTIVE-C

@interface SDLCharacterSet : SDLEnum

OBJECTIVE-C


OBJECTIVE-C


+CID2SET

Undocumented

SDLChoice Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithId:menuName:vrCommands:• -

initWithId:menuName:vrCommands:image:secondaryText:secondaryImage:tertiaryText:• choiceID• menuName• vrCommands• image• secondaryText• tertiaryText

OBJECTIVE-C


• secondaryImage

Overview

A choice is an option which a user can select either via the menu or via voice

recognition (VR) during an application initiated interaction.

Parameter List



-init

Constructs a newly allocated SDLChoice object

choiceID NSNumber *

Application-scoped identifierthat uniquelyidentifies thischoice. Min: 0 Max: 65535

SmartDeviceLink 1.0

menuName NSString *

Text whichappears in menu,representing thischoice. Min: 1 Max: 100

SmartDeviceLink 1.0

vrCommands NSMutableArray *

An array ofstrings to be usedas VR synonymsfor this choice. Ifthis array isprovided, it musthave at least onenon-emptyelement

SmartDeviceLink 1.0

image SDLImage *

Either a static hexicon value or abinary image filename identifier(sent by PutFile).

SmartDeviceLink 2.0


Constructs a newly allocated SDLChoice object indicated by the dictionary

parameter - parameter: dict The dictionary to use

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


-initWithId:menuName:vrCommands:

Undocumented

-

initWithId:menuName:vrCommands:image:secondaryText:secondaryImage:terti

Undocumented

PARAMETERS

OBJECTIVE-C

@interface SDLChoice : SDLRPCStruct

OBJECTIVE-C

@interface SDLChoice : SDLRPCStruct

choiceID

@abstract the application-scoped identifier that uniquely identifies this choice

Required, Integer 0 - 65535

menuName

@abstract Text which appears in menu, representing this choice

Required, Max string length 500 chars

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *choiceID;

SWIFT

var choiceID: NSNumber! { get set }

OBJECTIVE-C


vrCommands

@abstract VR synonyms for this choice

Required, Array of Strings, Array length 1 - 100, Max String length 99 chars

image

@abstract The image of the choice

Optional

SWIFT


OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *vrCommands;

SWIFT

var vrCommands: NSMutableArray! { get set }

secondaryText

@abstract Optional secondary text to display; e.g. address of POI in a search

result entry

Optional, Max String length 500 chars

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLImage *image;

SWIFT

var image: SDLImage! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *secondaryText;



tertiaryText

@abstract Optional tertiary text to display; e.g. distance to POI for a search

result entry


secondaryImage

@abstract Optional secondary image for choice

SWIFT

var secondaryText: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *tertiaryText;

SWIFT

var tertiaryText: String! { get set }

Optional

SDLClusterModeStatus Class Reference

Section Contents

• -init• -initWithDictionary:• powerModeActive• powerModeQualificationStatus• carModeStatus

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLImage *secondaryImage;

SWIFT

var secondaryImage: SDLImage! { get set }



• powerModeStatus

Overview

Undocumented

-init

Undocumented


Undocumented

powerModeActive

Undocumented

powerModeQualificationStatus

Undocumented

carModeStatus

Undocumented

powerModeStatus

Undocumented

SDLCompassDirection Class Reference

Section Contents

• +valueOf:• +values• +NORTH• +NORTHWEST• +WEST• +SOUTHWEST• +SOUTH• +SOUTHEAST• +EAST• +NORTHEAST

Overview

The list of potential compass directions.

@since SDL 2.0

+valueOf:

@abstract Convert String to SDLCompassDirection - parameter: value The

value of the string to get an object for - returns: SDLCompassDirection

OBJECTIVE-C

+ (SDLCompassDirection *)valueOf:(NSString *)value;

value


SDLCompassDirection

+values

@abstract Store the enumeration of all possible SDLCompassDirection - returns:

An array that store all possible SDLCompassDirection

SWIFT

class func value(of value: String!) -> SDLCompassDirection!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


An array that store all possible SDLCompassDirection

+NORTH

@abstract Direction North - returns: A SDLCompassDirection with the value of

NORTH

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLCompassDirection *)NORTH;

SWIFT

class func north() -> SDLCompassDirection!

A SDLCompassDirection with the value of NORTH

+NORTHWEST

@abstract Direction Northwest - returns: A SDLCompassDirection with the value

of NORTHWEST

A SDLCompassDirection with the value of NORTHWEST

RETURN VALUE

OBJECTIVE-C

+ (SDLCompassDirection *)NORTHWEST;

SWIFT

class func northwest() -> SDLCompassDirection!

RETURN VALUE

+WEST

@abstract Direction West - returns: A SDLCompassDirection with the value of

WEST

A SDLCompassDirection with the value of WEST

+SOUTHWEST

@abstract Direction Southwest - returns: A SDLCompassDirection with the

value of SOUTHWEST

OBJECTIVE-C

+ (SDLCompassDirection *)WEST;

SWIFT

class func west() -> SDLCompassDirection!

RETURN VALUE

A SDLCompassDirection with the value of SOUTHWEST

+SOUTH

@abstract Direction South - returns: A SDLCompassDirection with the value of

SOUTH

OBJECTIVE-C

+ (SDLCompassDirection *)SOUTHWEST;

SWIFT

class func southwest() -> SDLCompassDirection!

RETURN VALUE

OBJECTIVE-C

+ (SDLCompassDirection *)SOUTH;

A SDLCompassDirection with the value of SOUTH

+SOUTHEAST

@abstract Direction Southeast - returns: A SDLCompassDirection with the value

of SOUTHEAST

SWIFT

class func south() -> SDLCompassDirection!

RETURN VALUE

OBJECTIVE-C

+ (SDLCompassDirection *)SOUTHEAST;

SWIFT

class func southeast() -> SDLCompassDirection!

A SDLCompassDirection with the value of SOUTHEAST

+EAST

@abstract Direction East - returns: A SDLCompassDirection with the value of

EAST

A SDLCompassDirection with the value of EAST

RETURN VALUE

OBJECTIVE-C

+ (SDLCompassDirection *)EAST;

SWIFT

class func east() -> SDLCompassDirection!

RETURN VALUE

+NORTHEAST

@abstract Direction Northeast - returns: A SDLCompassDirection with the value

of NORTHEAST

A SDLCompassDirection with the value of NORTHEAST

OBJECTIVE-C

+ (SDLCompassDirection *)NORTHEAST;

SWIFT

class func northeast() -> SDLCompassDirection!

RETURN VALUE

SDLComponentVolumeStatus ClassReference

Section Contents

• +valueOf:• +values• +UNKNOWN• +NORMAL• +LOW• +FAULT• +ALERT• +NOT_SUPPORTED

Overview

The volume status of a vehicle component.

@since SDL 2.0

+valueOf:

@abstract Convert String to SDLComponentVolumeStatus - parameter: value

The value of the string to get an object for - returns:

SDLComponentVolumeStatus

OBJECTIVE-C

+ (SDLComponentVolumeStatus *)valueOf:(NSString *)value;

value


SDLComponentVolumeStatus

+values

@abstract Store the enumeration of all possible SDLComponentVolumeStatus -

returns: An array that store all possible SDLComponentVolumeStatus

SWIFT

class func value(of value: String!) -> SDLComponentVolumeStatus!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


An array that store all possible SDLComponentVolumeStatus

+UNKNOWN

@abstract Unknown SDLComponentVolumeStatus - returns: a

SDLComponentVolumeStatus with the value of UNKNOWN

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLComponentVolumeStatus *)UNKNOWN;

SWIFT

class func unknown() -> SDLComponentVolumeStatus!

a SDLComponentVolumeStatus with the value of UNKNOWN

+NORMAL

@abstract Normal SDLComponentVolumeStatus - returns: a

SDLComponentVolumeStatus with the value of NORMAL

a SDLComponentVolumeStatus with the value of NORMAL

RETURN VALUE

OBJECTIVE-C

+ (SDLComponentVolumeStatus *)NORMAL;

SWIFT

class func normal() -> SDLComponentVolumeStatus!

RETURN VALUE

+LOW

@abstract Low SDLComponentVolumeStatus - returns: a

SDLComponentVolumeStatus with the value of LOW

a SDLComponentVolumeStatus with the value of LOW

+FAULT

@abstract Fault SDLComponentVolumeStatus - returns: a

SDLComponentVolumeStatus with the value of FAULT

OBJECTIVE-C

+ (SDLComponentVolumeStatus *)LOW;

SWIFT

class func low() -> SDLComponentVolumeStatus!

RETURN VALUE

a SDLComponentVolumeStatus with the value of FAULT

+ALERT

@abstract Alert SDLComponentVolumeStatus - returns: a

SDLComponentVolumeStatus with the value of ALERT

OBJECTIVE-C

+ (SDLComponentVolumeStatus *)FAULT;

SWIFT

class func fault() -> SDLComponentVolumeStatus!

RETURN VALUE

OBJECTIVE-C

+ (SDLComponentVolumeStatus *)ALERT;

a SDLComponentVolumeStatus with the value of ALERT

+NOT_SUPPORTED

@abstract Not supported SDLComponentVolumeStatus - returns: a

SDLComponentVolumeStatus with the value of NOT_SUPPORTED

SWIFT

class func alert() -> SDLComponentVolumeStatus!

RETURN VALUE

OBJECTIVE-C

+ (SDLComponentVolumeStatus *)NOT_SUPPORTED;

SWIFT

class func not_SUPPORTED() -> SDLComponentVolumeStatus!

a SDLComponentVolumeStatus with the value of NOT_SUPPORTED

SDLConfiguration Class Reference

Section Contents

• lifecycleConfig• lockScreenConfig• -initWithLifecycle:lockScreen:• +configurationWithLifecycle:lockScreen:

Overview

Undocumented

lifecycleConfig

The lifecycle configuration.

RETURN VALUE

OBJECTIVE-C

@property (readonly, copy, nonatomic) SDLLifecycleConfiguration *_Nonnull lifecycleConfig;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLLifecycleConfiguration.html

lockScreenConfig

The lock screen configuration.

-initWithLifecycle:lockScreen:

Create a new configuration to be passed into SDLManager.

SWIFT

@NSCopying var lifecycleConfig: SDLLifecycleConfiguration { get }

OBJECTIVE-C

@property (readonly, copy, nonatomic) SDLLockScreenConfiguration *_Nonnull lockScreenConfig;

SWIFT

@NSCopying var lockScreenConfig: SDLLockScreenConfiguration { get }


https://d83tozu1c8tt6.cloudfront.net/Classes/SDLLockScreenConfiguration.html


lifecycleConfig

The lifecycle configuration to be used.

lockScreenConfig

The lockscreen configuration to be used. If nil, this will be

enabledConfiguration .

OBJECTIVE-C

- (nonnull instancetype)initWithLifecycle:(nonnull SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nonnull SDLLockScreenConfiguration *)lockScreenConfig;

SWIFT

init(lifecycle lifecycleConfig: SDLLifecycleConfiguration, lockScreen lockScreenConfig: SDLLockScreenConfiguration)

PARAMETERS





The configuration

+configurationWithLifecycle:lockScreen:

Create a new configuration to be passed into SDLManager.

lifecycleConfig

The lifecycle configuration to be used.

lockScreenConfig

The lockscreen configuration to be used. If nil, this will be

enabledConfiguration .

RETURN VALUE

OBJECTIVE-C

+ (nonnull instancetype)configurationWithLifecycle:(nonnull SDLLifecycleConfiguration *)lifecycleConfig lockScreen: (nonnull SDLLockScreenConfiguration *)lockScreenConfig;

PARAMETERS



The configuration

SDLConsoleController Class Reference

Section Contents

• messageList• atBottom• dateFormatter• messageList• -initWithTableView:

Overview

Undocumented

messageList

Undocumented

atBottom

Undocumented

RETURN VALUE

dateFormatter

Undocumented

messageList

Undocumented

-initWithTableView:

Undocumented

SDLCreateInteractionChoiceSet ClassReference

Section Contents

• -init• -initWithDictionary:• -initWithId:choiceSet:• interactionChoiceSetID• choiceSet

Overview

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

SeeSDLDeleteInteractionChoiceSet SDLPerformInteraction

-init

Constructs a new SDLCreateInteractionChoiceSet object


Constructs a new SDLCreateInteractionChoiceSet object indicated by the

dictionary parameter

OBJECTIVE-C


SWIFT

init!()

dict


-initWithId:choiceSet:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

OBJECTIVE-C

@interface SDLCreateInteractionChoiceSet : SDLRPCRequest

interactionChoiceSetID

@abstract A unique ID that identifies the Choice Set

Required, Integer, 0 - 2,000,000,000

choiceSet

@abstract Array of choices, which the user can select by menu or voice

recognition

Required, SDLChoice, Array size 1 - 100

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *interactionChoiceSetID;

SWIFT

var interactionChoiceSetID: NSNumber! { get set }

SDLCreateInteractionChoiceSetResponseClass Reference

Section Contents


Overview

SDLCreateInteractionChoiceSetResponse is sent, when

SDLCreateInteractionChoiceSet has been called


OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *choiceSet;

SWIFT

var choiceSet: NSMutableArray! { get set }

-init

Undocumented


Undocumented

SDLDIDResult Class Reference

Section Contents

• -init

OBJECTIVE-C

@interface SDLCreateInteractionChoiceSetResponse : SDLRPCResponse

OBJECTIVE-C

@interface SDLCreateInteractionChoiceSetResponse : SDLRPCResponse

• -initWithDictionary:• resultCode• didLocation• data

Overview

Undocumented

-init

Undocumented


Undocumented

resultCode

Undocumented

didLocation

Undocumented

data

Undocumented

SDLDateTime Class Reference

Section Contents

• -initWithHour:minute:• -initWithHour:minute:second:millisecond:• -initWithHour:minute:second:millisecond:day:month:year:• -

initWithHour:minute:second:millisecond:day:month:year:timezoneMinuteOffset:timezoneHourOffset:• millisecond• second• minute• hour• day• month• year• timezoneMinuteOffset• timezoneHourOffset

Overview

Undocumented

-initWithHour:minute:

Undocumented

-initWithHour:minute:second:millisecond:

Undocumented

-

initWithHour:minute:second:millisecond:day:month:year:

Undocumented

-

initWithHour:minute:second:millisecond:day:month:year:timezoneMinuteOffset

Undocumented

millisecond

@abstract Milliseconds part of time

Optional, Integer 0 - 999

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLInt> *millisecond;

SWIFT

@NSCopying var millisecond: NSNumber! { get set }

https://d83tozu1c8tt6.cloudfront.net/Protocols.html#/c:objc(pl)SDLInt

second

@abstract Seconds part of time


minute

@abstract Minutes part of time


OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLInt> *second;

SWIFT

@NSCopying var second: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLInt> *minute;



hour

@abstract Hour part of time


day

@abstract Day of the month


SWIFT

@NSCopying var minute: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLInt> *hour;

SWIFT

@NSCopying var hour: NSNumber! { get set }


month

@abstract Month of the year


OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLInt> *day;

SWIFT

@NSCopying var day: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLInt> *month;



year

@abstract The year in YYYY format

Optional, Max Value 4095

timezoneMinuteOffset

@abstract Time zone offset in Min with regard to UTC


SWIFT

@NSCopying var month: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLInt> *year;

SWIFT

@NSCopying var year: NSNumber! { get set }


timezoneHourOffset

@abstract Time zone offset in Hours with regard to UTC

Optional, Integer -12 - 14

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLInt> *timezoneMinuteOffset;

SWIFT

@NSCopying var timezoneMinuteOffset: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLInt> *timezoneHourOffset;



SDLDebugTool Class Reference

Section Contents

• +enable• +disable• +addConsole:• +addConsole:toGroup:• +removeConsole:• +removeConsole:fromGroup:• +logInfo:• +logFormat:• +logInfo:withType:• +logInfo:withType:toOutput:• +logInfo:andBinaryData:withType:toOutput:• +logInfo:withType:toOutput:toGroup:• +enableDebugToLogFile• +disableDebugToLogFile• +writeToLogFile:• +stringForDebugType:

Overview

Undocumented

SWIFT

@NSCopying var timezoneHourOffset: NSNumber! { get set }

+enable

Undocumented

+disable

Undocumented

+addConsole:

Undocumented

+addConsole:toGroup:

Undocumented

+removeConsole:

Undocumented

+removeConsole:fromGroup:

Undocumented

+logInfo:

Undocumented

+logFormat:

Undocumented

+logInfo:withType:

Undocumented

+logInfo:withType:toOutput:

Undocumented

+logInfo:andBinaryData:withType:toOutput:

Undocumented

+logInfo:withType:toOutput:toGroup:

Undocumented

+enableDebugToLogFile

Undocumented

+disableDebugToLogFile

Undocumented

+writeToLogFile:

Undocumented

+stringForDebugType:

Undocumented

SDLDeleteCommand Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithId:• cmdID

Overview

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


see SDLAddCommand SDLAddSubMenu SDLDeleteSubMenu

-init

Constructs a new SDLDeleteCommand object

OBJECTIVE-C



Constructs a new SDLDeleteCommand object indicated by the

NSMutableDictionary parameter

dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


-initWithId:

Undocumented

cmdID

@abstract the Command ID that identifies the Command to be deleted from

Command Menu @discussion an NSNumber value representing Command ID

Notes: Min Value: 0; Max Value: 2000000000

OBJECTIVE-C

@interface SDLDeleteCommand : SDLRPCRequest

OBJECTIVE-C


SWIFT


SDLDeleteCommandResponse ClassReference

Section Contents


Overview

SDLDeleteCommandResponse is sent, when SDLDeleteCommand has been

called


-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLDeleteCommandResponse : SDLRPCResponse

SDLDeleteFile Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithFileName:• syncFileName

Overview

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

supported on first generation SDL vehicles


see SDLPutFile SDLListFiles

-init

Constructs a new SDLDeleteFile object

OBJECTIVE-C

@interface SDLDeleteCommandResponse : SDLRPCResponse


Constructs a new SDLDeleteFile object indicated by the dictionary parameter

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


-initWithFileName:

Undocumented

syncFileName

@abstract a file reference name @discussion a String value representing a file

reference name

PARAMETERS

OBJECTIVE-C

@interface SDLDeleteFile : SDLRPCRequest

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *syncFileName;

SDLDeleteFileResponse Class Reference

Section Contents

• -init• -initWithDictionary:• spaceAvailable

Overview

Delete File Response is sent, when DeleteFile has been called


-init

Undocumented

SWIFT

var syncFileName: String! { get set }

OBJECTIVE-C

@interface SDLDeleteFileResponse : SDLRPCResponse


Undocumented

spaceAvailable

Undocumented

SDLDeleteInteractionChoiceSet ClassReference

Section Contents

• -init

OBJECTIVE-C


OBJECTIVE-C


• -initWithDictionary:• -initWithId:• interactionChoiceSetID

Overview

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



see SDLCreateInteractionChoiceSet SDLPerformInteraction

-init

Constructs a new SDLDeleteInteractionChoiceSet object

OBJECTIVE-C


SWIFT

init!()


Constructs a new SDLDeleteInteractionChoiceSet object indicated by the


dict


-initWithId:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

interactionChoiceSetID

@abstract a unique ID that identifies the Choice Set @discussion a unique ID

that identifies the Choice Set


OBJECTIVE-C

@interface SDLDeleteInteractionChoiceSet : SDLRPCRequest

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *interactionChoiceSetID;

SWIFT

var interactionChoiceSetID: NSNumber! { get set }

SDLDeleteInteractionChoiceSetResponseClass Reference

Section Contents


Overview

SDLDeleteInteractionChoiceSetResponse is sent, when

SDLDeleteInteractionChoiceSet has been called


-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLDeleteInteractionChoiceSetResponse : SDLRPCResponse

SDLDeleteSubMenu Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithId:• menuID

Overview

Deletes a submenu from the Command Menu

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

commands are also deleted



see SDLAddCommand SDLAddSubMenu SDLDeleteCommand

-init

Constructs a new SDLDeleteSubMenu object

OBJECTIVE-C

@interface SDLDeleteInteractionChoiceSetResponse : SDLRPCResponse


Constructs a new SDLDeleteSubMenu object indicated by the dictionary

parameter

- parameter: dict The dictionary to use

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


-initWithId:

Undocumented

menuID

@abstract the MenuID that identifies the SDLSubMenu to be delete @discussion


SWIFT


PARAMETERS

OBJECTIVE-C

@interface SDLDeleteSubMenu : SDLRPCRequest

SDLDeleteSubMenuResponse ClassReference

Section Contents


Overview

SDLDeleteSubMenuResponse is sent, when SDLDeleteSubMenu has been called


OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *menuID;

SWIFT

var menuID: NSNumber! { get set }

-init

Undocumented


Undocumented

SDLDeliveryMode Class Reference

Section Contents

• +valueOf:• +values• +PROMPT

OBJECTIVE-C

@interface SDLDeleteSubMenuResponse : SDLRPCResponse

OBJECTIVE-C

@interface SDLDeleteSubMenuResponse : SDLRPCResponse

• +DESTINATION• +QUEUE

Overview

Specifies the mode in which the sendLocation request is sent.

+valueOf:

@abstract Convert String to SDLDeliveryMode

value


OBJECTIVE-C

+ (SDLDeliveryMode *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLDeliveryMode!

PARAMETERS

SDLDeliveryMode

+values

@abstract Store the enumeration of all possible SDLDeliveryMode

an array that store all possible SDLDeliveryMode

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+PROMPT

@abstract User is prompted on HMI

a SDLDeliveryMode with value of PROMPT

+DESTINATION

@abstract Set the location as destination without prompting the user

OBJECTIVE-C

+ (SDLDeliveryMode *)PROMPT;

SWIFT

class func prompt() -> SDLDeliveryMode!

RETURN VALUE

a SDLDeliveryMode with value of DESTINATION

+QUEUE

@abstract Adds the current location to navigation queue

OBJECTIVE-C

+ (SDLDeliveryMode *)DESTINATION;

SWIFT

class func destination() -> SDLDeliveryMode!

RETURN VALUE

OBJECTIVE-C

+ (SDLDeliveryMode *)QUEUE;

a SDLDeliveryMode with value of QUEUE

SDLDeviceInfo Class Reference

Section Contents

• -init• -initWithDictionary:• +currentDevice• hardware• firmwareRev• os• osVersion• carrier• maxNumberRFCOMMPorts

Overview

Undocumented

SWIFT

class func queue() -> SDLDeliveryMode!

RETURN VALUE

-init

Undocumented


Undocumented

+currentDevice

Undocumented

hardware

Undocumented

firmwareRev

Undocumented

os

Undocumented

osVersion

Undocumented

carrier

Undocumented

maxNumberRFCOMMPorts

Undocumented

SDLDeviceLevelStatus Class Reference

Section Contents

• +valueOf:• +values• +ZERO_LEVEL_BARS• +ONE_LEVEL_BARS• +TWO_LEVEL_BARS• +THREE_LEVEL_BARS• +FOUR_LEVEL_BARS• +NOT_PROVIDED

Overview

Reflects the reported battery status of the connected device, if reported.

@since SDL 2.0

+valueOf:

Convert String to DeviceLevelStatus - parameter: value String - returns:

DeviceLevelStatus

value

String

DeviceLevelStatus

OBJECTIVE-C

+ (SDLDeviceLevelStatus *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLDeviceLevelStatus!

PARAMETERS

RETURN VALUE

+values

@abstract Store the enumeration of all possible SDLDeviceLevelStatus -

returns: an array that store all possible SDLDeviceLevelStatus

an array that store all possible SDLDeviceLevelStatus

+ZERO_LEVEL_BARS

@abstract Device battery level is zero bars - returns: a SDLDeviceLevelStatus

with value of ZERO_LEVEL_BARS

OBJECTIVE-C


SWIFT


RETURN VALUE

a SDLDeviceLevelStatus with value of ZERO_LEVEL_BARS

+ONE_LEVEL_BARS

@abstract Device battery level is one bar - returns: a SDLDeviceLevelStatus

with value of ONE_LEVEL_BARS

OBJECTIVE-C

+ (SDLDeviceLevelStatus *)ZERO_LEVEL_BARS;

SWIFT

class func zero_LEVEL_BARS() -> SDLDeviceLevelStatus!

RETURN VALUE

OBJECTIVE-C

+ (SDLDeviceLevelStatus *)ONE_LEVEL_BARS;

a SDLDeviceLevelStatus with value of ONE_LEVEL_BARS

+TWO_LEVEL_BARS

@abstract Device battery level is two bars - returns: a SDLDeviceLevelStatus

with value of TWO_LEVEL_BARS

SWIFT

class func one_LEVEL_BARS() -> SDLDeviceLevelStatus!

RETURN VALUE

OBJECTIVE-C

+ (SDLDeviceLevelStatus *)TWO_LEVEL_BARS;

SWIFT

class func two_LEVEL_BARS() -> SDLDeviceLevelStatus!

a SDLDeviceLevelStatus with value of TWO_LEVEL_BARS

+THREE_LEVEL_BARS

@abstract Device battery level is three bars - returns: a SDLDeviceLevelStatus

with value of THREE_LEVEL_BARS

a SDLDeviceLevelStatus with value of THREE_LEVEL_BARS

RETURN VALUE

OBJECTIVE-C

+ (SDLDeviceLevelStatus *)THREE_LEVEL_BARS;

SWIFT

class func three_LEVEL_BARS() -> SDLDeviceLevelStatus!

RETURN VALUE

+FOUR_LEVEL_BARS

@abstract Device battery level is four bars - returns: a SDLDeviceLevelStatus

with value of FOUR_LEVEL_BARS

a SDLDeviceLevelStatus with value of FOUR_LEVEL_BARS

+NOT_PROVIDED

@abstract Device battery level is unknown - returns: a SDLDeviceLevelStatus

with value of NOT_PROVIDED

OBJECTIVE-C

+ (SDLDeviceLevelStatus *)FOUR_LEVEL_BARS;

SWIFT

class func four_LEVEL_BARS() -> SDLDeviceLevelStatus!

RETURN VALUE

a SDLDeviceLevelStatus with value of NOT_PROVIDED

SDLDeviceStatus Class Reference

Section Contents

• -init• -initWithDictionary:• voiceRecOn• btIconOn• callActive• phoneRoaming

OBJECTIVE-C

+ (SDLDeviceLevelStatus *)NOT_PROVIDED;

SWIFT

class func not_PROVIDED() -> SDLDeviceLevelStatus!

RETURN VALUE

• textMsgAvailable• battLevelStatus• stereoAudioOutputMuted• monoAudioOutputMuted• signalLevelStatus• primaryAudioSource• eCallEventActive

Overview

Describes the status related to a connected mobile device or SDL and if or how

it is represented in the vehicle.

Parameter List


@since SDL 2.0

-init

Constructs a newly allocated SDLDeviceStatus object

voiceRecOn NSNumber * Voice recognitionis on

SmartDeviceLink 2.0

btIconOn NSNumber * Bluetoothconnectionestablished

SmartDeviceLink 2.0

callActive NSNumber * A call is beingactive

SmartDeviceLink 2.0

phoneRoaming NSNumber * The phone is inroaming mode

SmartDeviceLink 2.0

textMsgAvailable NSNumber * A textmessage is

available SmartDeviceLink 2.0

battLevelStatus SDLDeviceLevelStatus *

Battery levelstatus

SmartDeviceLink 2.0

stereoAudioOutputMuted NSNumber *

Status of thestereo audiooutput channel

SmartDeviceLink 2.0

monoAudioOutputMuted NSNumber *

Status of themono audiooutput channel

SmartDeviceLink 2.0

signalLevelStatus

SDLDeviceLevelStatus * Signal level status SmartDeviceLin

k 2.0

primaryAudioSource

PrimaryAudioSource *

Reflects thecurrent primaryaudio source ofSDL (if selected).

SmartDeviceLink 2.0

eCallEventActive NSNumber *

Reflects, if aneCall event isactive

SmartDeviceLink 2.0


Constructs a newly allocated SDLDeviceStatus object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict

The dictionary to use to construct the object

voiceRecOn

@abstract Indicates whether the voice recognition is on or off

Required, Boolean

btIconOn

@abstract Indicates whether the bluetooth connection established

Required, Boolean

PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *voiceRecOn;

SWIFT

var voiceRecOn: NSNumber! { get set }

callActive

@abstract Indicates whether a call is being active

Required, Boolean

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *btIconOn;

SWIFT

var btIconOn: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *callActive;

SWIFT

var callActive: NSNumber! { get set }

phoneRoaming

@abstract Indicates whether the phone is in roaming mode

Required, Boolean

textMsgAvailable

@abstract Indicates whether a textmessage is available

Required, Boolean

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *phoneRoaming;

SWIFT

var phoneRoaming: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *textMsgAvailable;

battLevelStatus

@abstract Battery level status

SeeSDLDeviceLevelStatus Required

stereoAudioOutputMuted

@abstract The status of the stereo audio output channel

SWIFT

var textMsgAvailable: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLDeviceLevelStatus *battLevelStatus;

SWIFT

var battLevelStatus: SDLDeviceLevelStatus! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDeviceLevelStatus.html


Required, Boolean

monoAudioOutputMuted

@abstract The status of the mono audio output channel

Required, Boolean

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *stereoAudioOutputMuted;

SWIFT

var stereoAudioOutputMuted: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *monoAudioOutputMuted;

signalLevelStatus

@abstract Signal level status

SeeSDLDeviceLevelStatus Required

primaryAudioSource

@abstract The current primary audio source of SDL (if selected).

See

SWIFT

var monoAudioOutputMuted: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLDeviceLevelStatus *signalLevelStatus;

SWIFT

var signalLevelStatus: SDLDeviceLevelStatus! { get set }



SDLPrimaryAudioSource Required

eCallEventActive

@abstract Indicates if an emergency call is active

Required, Boolean

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLPrimaryAudioSource *primaryAudioSource;

SWIFT

var primaryAudioSource: SDLPrimaryAudioSource! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *eCallEventActive;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLPrimaryAudioSource.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLPrimaryAudioSource.html

SDLDiagnosticMessage Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithTargetId:length:data:• targetID• messageLength• messageData

Overview

Non periodic vehicle diagnostic request

@since SDL 3.0

-init

Undocumented

SWIFT

var eCallEventActive: NSNumber! { get set }


Undocumented

-initWithTargetId:length:data:

Undocumented

OBJECTIVE-C

@interface SDLDiagnosticMessage : SDLRPCRequest

OBJECTIVE-C


OBJECTIVE-C


targetID

Name of target ECU

Required, Integer, 0 - 65535

messageLength

Length of message (in bytes)

Required, Integer, 65535

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *targetID;

SWIFT

var targetID: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *messageLength;

messageData

Array of bytes comprising CAN message.

Required, Array of NSNumber (Integers), Array size 1 - 65535, Integer Size 0 -

255

SWIFT

var messageLength: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *messageData;

SWIFT

var messageData: NSMutableArray! { get set }

SDLDiagnosticMessageResponse ClassReference

Section Contents

• -init• -initWithDictionary:• messageDataResult

Overview

SDLDiagnosticMessageResponse is sent, when SDLDiagnosticMessage has been

called. * SinceSmartDeviceLink 3.0

-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLDiagnosticMessageResponse : SDLRPCResponse

messageDataResult

Undocumented

SDLDialNumber Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithNumber:

OBJECTIVE-C


OBJECTIVE-C


• number

Overview

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

using the phone.

@since SDL 4.0

-init

Undocumented


Undocumented

-initWithNumber:

Undocumented

OBJECTIVE-C

@interface SDLDialNumber : SDLRPCRequest

OBJECTIVE-C


number

Up to 40 character string representing the phone number. All characters

stripped except for ‘0’-‘9’, ’*’, ’#’, ’,’, ’;’, and ’+’

OBJECTIVE-C


OBJECTIVE-C

@property (readwrite, strong, nonatomic) NSString *number;

SWIFT

var number: String! { get set }

SDLDialNumberResponse ClassReference

Section Contents


Overview

Indicates the result, success, or failure of the SDLDialNumber request.

@since SDL 4.0

-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLDialNumberResponse : SDLRPCResponse

SDLDimension Class Reference

Section Contents

• +valueOf:• +values• +NO_FIX• +_2D• +_3D

Overview

The supported dimensions of the GPS.

@since SDL 2.0

+valueOf:

Convert String to SDLDimension

OBJECTIVE-C

@interface SDLDialNumberResponse : SDLRPCResponse

value


SDLDimension

+values

@abstract Store the enumeration of all possible SDLDimension

OBJECTIVE-C

+ (SDLDimension *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLDimension!

PARAMETERS

RETURN VALUE

An array that store all possible SDLDimension

+NO_FIX

@abstract No GPS at all - returns: the dimension with value of NO_FIX

OBJECTIVE-C


SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLDimension *)NO_FIX;

the dimension with value of NO_FIX

+_2D

@abstract Longitude and latitude of the GPS - returns: the dimension with value

of 2D

SWIFT

class func no_FIX() -> SDLDimension!

RETURN VALUE

OBJECTIVE-C

+ (SDLDimension *)_2D;

SWIFT

class func _2D() -> SDLDimension!

the dimension with value of 2D

+_3D

@abstract Longitude and latitude and altitude of the GPS - returns: the

dimension with value of 3D

the dimension with value of 3D

RETURN VALUE

OBJECTIVE-C

+ (SDLDimension *)_3D;

SWIFT

class func _3D() -> SDLDimension!

RETURN VALUE

SDLDisplayCapabilities Class Reference

Section Contents

• -init• -initWithDictionary:• displayType• textFields• imageFields• mediaClockFormats• graphicSupported• templatesAvailable• screenParams• numCustomPresetsAvailable

Overview

Contains information about the display for the SDL system to which the

application is currently connected.

@since SDL 1.0

-init

Constructs a newly allocated SDLDisplayCapabilities object

OBJECTIVE-C



Constructs a newly allocated SDLDisplayCapabilities object indicated by the


dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


displayType

@abstract The type of display

Required

textFields

@abstract An array of SDLTextField structures, each of which describes a field in

the HMI which the application can write to using operations such as SDLShow,

SDLSetMediaClockTimer, etc.

@discussion This array of SDLTextField structures identify all the text fields to

which the application can write on the current display (identified by

SDLDisplayType).

SeeSDLTextField

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLDisplayType *displayType;

SWIFT

var displayType: SDLDisplayType! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDisplayType.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDisplayType.html

Required, Array of SDLTextField, 1 - 100 objects

imageFields

@abstract An array of SDLImageField elements

@discussion A set of all fields that support images.

SeeSDLImageField Optional, Array of SDLImageField, 1 - 100 objects

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *textFields;

SWIFT

var textFields: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *imageFields;

mediaClockFormats

@abstract An array of SDLMediaClockFormat elements, defining the valid string

formats used in specifying the contents of the media clock field

SeeSDLMediaClockFormat Required, Array of SDLMediaClockFormats, 0 - 100 objects

graphicSupported

@abstract The display’s persistent screen supports.

SWIFT

var imageFields: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *mediaClockFormats;

SWIFT

var mediaClockFormats: NSMutableArray! { get set }

@since SDL 2.0

Required, Boolean

templatesAvailable

@abstract Number of presets the screen supports

@discussion The number of on-screen custom presets available (if any)

Optional, Array of String, max string size 100, 0 - 100 objects

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *graphicSupported;

SWIFT

var graphicSupported: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *templatesAvailable;

screenParams

@abstract A set of all parameters related to a prescribed screen area (e.g. for

video / touch input)

Optional

numCustomPresetsAvailable

@abstract The number of on-screen custom presets available (if any);

otherwise omitted

SWIFT

var templatesAvailable: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLScreenParams *screenParams;

SWIFT

var screenParams: SDLScreenParams! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLScreenParams.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLScreenParams.html


SDLDisplayType Class Reference

Section Contents

• +valueOf:• +values• +CID• +TYPE2• +TYPE5• +NGN• +GEN2_8_DMA• +GEN2_6_DMA• +MFD3• +MFD4

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *numCustomPresetsAvailable;

SWIFT

var numCustomPresetsAvailable: NSNumber! { get set }

• +MFD5• +GEN3_8_INCH• +GENERIC

Overview

Identifies the various display types used by SDL.

@since SDL 1.0

+valueOf:

Convert String to SDLDisplayType

value


OBJECTIVE-C

+ (SDLDisplayType *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLDisplayType!

PARAMETERS

SDLDisplayType

+values

@abstract Store the enumeration of all possible SDLDisplayType

an array that store all possible SDLDisplayType

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+CID

@abstract This display type provides a 2-line x 20 character “dot matrix”

display.

SDLDisplayType with value of CID

+TYPE2

Undocumented

OBJECTIVE-C

+ (SDLDisplayType *)CID;

SWIFT

class func cid() -> SDLDisplayType!

RETURN VALUE

+TYPE5

Undocumented

+NGN

@abstract This display type provides an 8 inch touchscreen display.

OBJECTIVE-C

@interface SDLDisplayType : SDLEnum

OBJECTIVE-C


OBJECTIVE-C

+ (SDLDisplayType *)NGN;

SDLDisplayType with value of NGN

+GEN2_8_DMA

Undocumented

+GEN2_6_DMA

Undocumented

SWIFT

class func ngn() -> SDLDisplayType!

RETURN VALUE

OBJECTIVE-C


+MFD3

Undocumented

+MFD4

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


+MFD5

Undocumented

+GEN3_8_INCH

Undocumented

+GENERIC

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


SDLDriverDistractionState ClassReference

Section Contents

• +valueOf:• +values• +DD_ON• +DD_OFF

Overview

Enumeration that describes possible states of driver distraction.

@since SDL 1.0

+valueOf:

Convert String to SDLDisplayType

OBJECTIVE-C

+ (SDLDriverDistractionState *)valueOf:(NSString *)value;

value


SDLDisplayType

+values

@abstract Store the enumeration of all possible SDLDriverDistractionState

SWIFT

class func value(of value: String!) -> SDLDriverDistractionState!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


an array that store all possible SDLDriverDistractionState

+DD_ON

@abstract Driver distraction rules are in effect.

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLDriverDistractionState *)DD_ON;

SWIFT

class func dd_ON() -> SDLDriverDistractionState!

a SDLDriverDistractionState with value of DD_ON

+DD_OFF

@abstract Driver distraction rules are NOT in effect.

a SDLDriverDistractionState with value of DD_OFF

RETURN VALUE

OBJECTIVE-C

+ (SDLDriverDistractionState *)DD_OFF;

SWIFT

class func dd_OFF() -> SDLDriverDistractionState!

RETURN VALUE

SDLECallConfirmationStatus ClassReference

Section Contents

• +valueOf:• +values• +NORMAL• +CALL_IN_PROGRESS• +CALL_CANCELLED• +CALL_COMPLETED• +CALL_UNSUCCESSFUL• +ECALL_CONFIGURED_OFF• +CALL_COMPLETE_DTMF_TIMEOUT

Overview

Reflects the status of the eCall Notification. *Since SmartDeviceLink 2.0

+valueOf:

Undocumented

OBJECTIVE-C

@interface SDLECallConfirmationStatus : SDLEnum

+values

Undocumented

+NORMAL

No E-Call signal triggered.

OBJECTIVE-C

@interface SDLECallConfirmationStatus : SDLEnum

OBJECTIVE-C

+ (SDLECallConfirmationStatus *)NORMAL;

SWIFT

class func normal() -> SDLECallConfirmationStatus!

+CALL_IN_PROGRESS

An E-Call is being in progress.

+CALL_CANCELLED

CALL_CANCELLED An E-Call was cancelled by the user.

OBJECTIVE-C

+ (SDLECallConfirmationStatus *)CALL_IN_PROGRESS;

SWIFT

class func call_IN_PROGRESS() -> SDLECallConfirmationStatus!

OBJECTIVE-C

+ (SDLECallConfirmationStatus *)CALL_CANCELLED;

+CALL_COMPLETED

The E-Call sequence is completed.

+CALL_UNSUCCESSFUL

An E-Call could not be connected.

SWIFT

class func call_CANCELLED() -> SDLECallConfirmationStatus!

OBJECTIVE-C

+ (SDLECallConfirmationStatus *)CALL_COMPLETED;

SWIFT

class func call_COMPLETED() -> SDLECallConfirmationStatus!

+ECALL_CONFIGURED_OFF

E-Call is not configured on this vehicle.

OBJECTIVE-C

+ (SDLECallConfirmationStatus *)CALL_UNSUCCESSFUL;

SWIFT

class func call_UNSUCCESSFUL() -> SDLECallConfirmationStatus!

OBJECTIVE-C

+ (SDLECallConfirmationStatus *)ECALL_CONFIGURED_OFF;

SWIFT

class func ecall_CONFIGURED_OFF() -> SDLECallConfirmationStatus!

+CALL_COMPLETE_DTMF_TIMEOUT

E-Call is considered to be complete without Emergency Operator contact.

SDLECallInfo Class Reference

Section Contents

• -init• -initWithDictionary:• eCallNotificationStatus• auxECallNotificationStatus• eCallConfirmationStatus

OBJECTIVE-C

+ (SDLECallConfirmationStatus *)CALL_COMPLETE_DTMF_TIMEOUT;

SWIFT

class func call_COMPLETE_DTMF_TIMEOUT() -> SDLECallConfirmationStatus!

Overview

Undocumented

-init

Undocumented


Undocumented

eCallNotificationStatus

Undocumented

auxECallNotificationStatus

Undocumented

eCallConfirmationStatus

Undocumented

SDLEmergencyEvent Class Reference

Section Contents

• -init• -initWithDictionary:• emergencyEventType

• fuelCutoffStatus• rolloverEvent• maximumChangeVelocity• multipleEvents

Overview

Undocumented

-init

Undocumented


Undocumented

emergencyEventType

Undocumented

fuelCutoffStatus

Undocumented

rolloverEvent

Undocumented

maximumChangeVelocity

Undocumented

multipleEvents

Undocumented

SDLEmergencyEventType ClassReference

Section Contents

• +valueOf:• +values• +NO_EVENT• +FRONTAL• +SIDE• +REAR• +ROLLOVER• +NOT_SUPPORTED• +FAULT

Overview

Reflects the emergency event status of the vehicle. * Since: SmartDeviceLink

2.0 *

+valueOf:

Undocumented

+values

Undocumented

+NO_EVENT

No emergency event has happened.

OBJECTIVE-C

@interface SDLEmergencyEventType : SDLEnum

OBJECTIVE-C

@interface SDLEmergencyEventType : SDLEnum

OBJECTIVE-C

+ (SDLEmergencyEventType *)NO_EVENT;

+FRONTAL

Frontal collision has happened.

+SIDE

Side collision has happened.

SWIFT

class func no_() -> SDLEmergencyEventType!

OBJECTIVE-C

+ (SDLEmergencyEventType *)FRONTAL;

SWIFT

class func frontal() -> SDLEmergencyEventType!

+REAR

Rear collision has happened.

OBJECTIVE-C

+ (SDLEmergencyEventType *)SIDE;

SWIFT

class func side() -> SDLEmergencyEventType!

OBJECTIVE-C

+ (SDLEmergencyEventType *)REAR;

SWIFT

class func rear() -> SDLEmergencyEventType!

+ROLLOVER

A rollover event has happened.

+NOT_SUPPORTED

The signal is not supported

OBJECTIVE-C

+ (SDLEmergencyEventType *)ROLLOVER;

SWIFT

class func rollover() -> SDLEmergencyEventType!

OBJECTIVE-C

+ (SDLEmergencyEventType *)NOT_SUPPORTED;

+FAULT

Emergency status cannot be determined

SWIFT

class func not_SUPPORTED() -> SDLEmergencyEventType!

OBJECTIVE-C

+ (SDLEmergencyEventType *)FAULT;

SWIFT

class func fault() -> SDLEmergencyEventType!

SDLEncodedSyncPData Class Reference

Section Contents

• -init• -initWithDictionary:• data

Overview

Undocumented

-init

Undocumented


Undocumented

data

Undocumented

SDLEncodedSyncPDataResponse ClassReference

Section Contents


Overview

Undocumented

-init

Undocumented


Undocumented

SDLEndAudioPassThru Class Reference

Section Contents

• -init


Overview

When this request is invoked, the audio capture stops

Function Group: AudioPassThru



see SDLPerformAudioPassThru

-init

Constructs a new SDLEndAudioPassThru object


Constructs a new SDLEndAudioPassThru object indicated by the


OBJECTIVE-C


SWIFT

init!()

dict


SDLEndAudioPassThruResponse ClassReference

Section Contents

• -init

OBJECTIVE-C


SWIFT


PARAMETERS


Overview

SDLEndAudioPassThruResponse is sent, when SDLEndAudioPassThru has been

called


-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLEndAudioPassThruResponse : SDLRPCResponse

OBJECTIVE-C

@interface SDLEndAudioPassThruResponse : SDLRPCResponse

SDLEnum Class Reference

Section Contents

• value• -initWithValue:• -isEqualToEnum:• value

Overview

Undocumented

value

Undocumented

-initWithValue:

Undocumented

-isEqualToEnum:

Undocumented

value

Undocumented

SDLFile Class Reference

Section Contents

• persistent• overwrite• name• fileURL• data• fileType• -init• -initWithFileURL:name:persistent:• +persistentFileAtFileURL:name:• +fileAtFileURL:name:• -initWithData:name:fileExtension:persistent:• +persistentFileWithData:name:fileExtension:• +fileWithData:name:fileExtension:

Overview

Undocumented

persistent

Whether or not the file should persist on disk between car ignition cycles.

OBJECTIVE-C

@property (readonly, getter=isPersistent, assign, nonatomic) BOOL persistent;

overwrite

Whether or not the file should overwrite an existing file on the remote disk with

the same name.

name

The name the file should be stored under on the remote disk. This is how the

file will be referenced in all later calls.

SWIFT

var isPersistent: Bool { get }

OBJECTIVE-C

@property (assign, readwrite, nonatomic) BOOL overwrite;

SWIFT

var overwrite: Bool { get set }

fileURL

The url the local file is stored at while waiting to push it to the remote system. If

the data has not been passed to the file URL, this will be nil.

OBJECTIVE-C

@property (readonly, copy, nonatomic) NSString *_Nonnull name;

SWIFT

var name: String { get }

OBJECTIVE-C

@property (readonly, copy, nonatomic, nullable) NSURL *fileURL;

data

The binary data of the SDLFile. If initialized with data, this will be a relatively

quick call, but if initialized with a file URL, this is a rather expensive call the first

time. The data will be cached in RAM after the first call.

fileType

The system will attempt to determine the type of file that you have passed in. It

will default to BINARY if it does not recognize the file type or the file type is not

supported by SDL.

SWIFT

var fileURL: URL? { get }

OBJECTIVE-C

@property (readonly, copy, nonatomic) NSData *_Nonnull data;

SWIFT

var data: Data { get }

-init

Undocumented

-initWithFileURL:name:persistent:

The designated initializer for an SDL File. The only major property that is not set

using this is “overwrite”, which defaults to NO.

OBJECTIVE-C

@property (readonly, strong, nonatomic) SDLFileType *_Nonnull fileType;

SWIFT

var fileType: SDLFileType { get }

OBJECTIVE-C

- (nonnull instancetype)initWithFileURL:(nonnull NSURL *)url name:(nonnull NSString *)name persistent:(BOOL)persistent;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLFileType.html


url

The file URL pointing to the local data that will be pushed to the remote

system.

name

The name that the file will be stored under on the remote system and

how it will be referenced from the local system.

persistent

Whether or not the file will persist between ignition cycles.

An SDLFile object.

SWIFT

init(fileURL url: URL, name: String, persistent: Bool)

PARAMETERS

RETURN VALUE

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLFile.html#/c:objc(cs)SDLFile(py)fileURL

+persistentFileAtFileURL:name:

Create an SDL file using a local file URL.




persistent.

Ephemeral files should be created using ephemeralFileAtURL:name:

Warning

If this is not a readable file, this will return nil

OBJECTIVE-C

+ (nonnull instancetype)persistentFileAtFileURL:(nonnull NSURL *)url name:(nonnull NSString *)name;

SWIFT

class func persistentFile(atFileURL url: URL, name: String) -> Self

url

The url to the file that should be uploaded.

name



An instance of this class, or nil if a readable file at the path could not be found.

+fileAtFileURL:name:

Create an SDL file using a local file URL.




ephemeral.

Persistent files should be created using persistentFileAtURL:name:

Warning

If this is not a readable file, this will return nil

PARAMETERS

RETURN VALUE

url

The url to the file on disk that will be uploaded

name



OBJECTIVE-C

+ (nonnull instancetype)fileAtFileURL:(nonnull NSURL *)url name:(nonnull NSString *)name;

SWIFT

convenience init(atFileURL url: URL, name: String)

PARAMETERS

An instance of this class, or nil if a readable file at the url could not be found.

-initWithData:name:fileExtension:persistent:

Create an SDL file using raw data. It is strongly preferred to pass a file URL

instead of data, as it is currently held in memory until the file is sent.

RETURN VALUE

OBJECTIVE-C

- (nonnull instancetype)initWithData:(nonnull NSData *)data name:(nonnull NSString *)name fileExtension:(nonnull NSString *)extension persistent:(BOOL)persistent;

SWIFT

init(data: Data, name: String, fileExtension extension: String, persistent: Bool)

data

The raw data to be used for the file

name



extension

The file extension. For example “png”. Currently supported file

extensions are: “bmp”, “jpg”, “jpeg”, “png”, “wav”, “mp3”, “aac”, “

json”. All others will be sent as binary files.

persistent

Whether or not the remote file with this data should be persistent

An instance of this class

PARAMETERS

RETURN VALUE

+persistentFileWithData:name:fileExtension:






persistent.

data

OBJECTIVE-C

+ (nonnull instancetype)persistentFileWithData:(nonnull NSData *)data name:(nonnull NSString *)name fileExtension:(nonnull NSString *)extension;

SWIFT

class func persistentFile(with data: Data, name: String, fileExtension extension: String) -> Self

PARAMETERS


name



extension





+fileWithData:name:fileExtension:





RETURN VALUE


ephemeral.

data


name



OBJECTIVE-C

+ (nonnull instancetype)fileWithData:(nonnull NSData *)data name:(nonnull NSString *)name fileExtension:(nonnull NSString *)extension;

SWIFT

convenience init(data: Data, name: String, fileExtension extension: String)

PARAMETERS

extension





SDLFileManager Class Reference

Section Contents

• remoteFileNames• bytesAvailable• currentState• pendingTransactions• suspended• -init• -initWithConnectionManager:• -startWithCompletionHandler:• -stop• -deleteRemoteFileWithName:completionHandler:• -uploadFile:completionHandler:

RETURN VALUE

• +temporaryFileDirectory

Overview

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.

remoteFileNames

A set of all names of files known on the remote head unit. Known files can be

used or deleted on the remote system.

bytesAvailable

The number of bytes still available for files for this app.

OBJECTIVE-C

@property (readonly, copy, nonatomic) NSSet<SDLFileName *> *_Nonnull remoteFileNames;

SWIFT

var remoteFileNames: Set

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLFileManager.h@T@SDLFileName

currentState

The state of the file manager.

OBJECTIVE-C

@property (readonly, assign, nonatomic) NSUInteger bytesAvailable;

SWIFT

var bytesAvailable: UInt { get }

OBJECTIVE-C

@property (readonly, copy, nonatomic) NSString *_Nonnull currentState;

SWIFT

var currentState: String { get }

pendingTransactions

The currently pending transactions (Upload, Delete, and List Files) in the file

manager

suspended

Whether or not the file manager is suspended. If suspended, the file manager

can continue to queue uploads and deletes, but will not actually perform any of

those until it is no longer suspended. This can be used for throttling down the

OBJECTIVE-C

@property (readonly, copy, nonatomic) NSArray<__kindof NSOperation *> *_Nonnull pendingTransactions;

SWIFT

var pendingTransactions: [Operation] { get }

file manager if other, important operations are taking place over the accessory

connection.

-init

Initialize the class…or not, since this method is unavailable. Dependencies

must be injected using initWithConnectionManager:

OBJECTIVE-C

@property (assign, readwrite, nonatomic) BOOL suspended;

SWIFT

var suspended: Bool { get set }

OBJECTIVE-C

- (nonnull instancetype)init;

nil

-initWithConnectionManager:

Creates a new file manager with a specified connection manager

manager

A connection manager to use to forward on RPCs

An instance of SDLFileManager

RETURN VALUE

OBJECTIVE-C

- (nonnull instancetype)initWithConnectionManager: (nonnull id<SDLConnectionManagerType>)manager;

PARAMETERS

RETURN VALUE

-startWithCompletionHandler:

The manager stars up and attempts to fetch its initial list and transfer initial

files.

completionHandler

OBJECTIVE-C

- (void)startWithCompletionHandler: (nullable SDLFileManagerStartupCompletionHandler)completionHandler;

SWIFT

func start(completionHandler: SDLFileManagerStartupCompletionHandler? = nil)

PARAMETERS

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLFileManager.h@T@SDLFileManagerStartupCompletionHandler

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLFileManager.h@T@SDLFileManagerStartupCompletionHandler

The handler called when the manager is set up or failed to set up with

an error. Use weak self when accessing self from the completion

handler.

-stop

Cancels all file manager operations and deletes all associated data.

-deleteRemoteFileWithName:completionHandler:

Delete a file stored on the remote system

OBJECTIVE-C

- (void)stop;

SWIFT

func stop()

name

The name of the remote file. It should be a name currently stored in

remoteFileNames

completion

OBJECTIVE-C

- (void)deleteRemoteFileWithName:(nonnull SDLFileName *)name completionHandler: (nullable SDLFileManagerDeleteCompletionHandler)completion;

SWIFT

func deleteRemoteFile(withName name: String, completionHandler completion: SDLFileManagerDeleteCompletionHandler? = nil)

PARAMETERS

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLFileManager.h@T@SDLFileName

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerDeleteCompletionHandler

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerDeleteCompletionHandler

An optional completion handler that sends an error should one occur.

-uploadFile:completionHandler:

Upload a file to the remote file system. If a file with the [SDLFile name] already

exists, this will overwrite that file. If you do not want that to happen, check

remoteFileNames before uploading, or change allowOverwrite to NO.

file

An SDLFile that contains metadata about the file to be sent

OBJECTIVE-C

- (void)uploadFile:(nonnull SDLFile *)file completionHandler: (nullable SDLFileManagerUploadCompletionHandler)completion;

SWIFT

func uploadFile(_ file: SDLFile, completionHandler completion: SDLFileManagerUploadCompletionHandler? = nil)

PARAMETERS

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLFile.html

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerUploadCompletionHandler


https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerUploadCompletionHandler

completion

An optional completion handler that sends an error should one occur.

+temporaryFileDirectory

A URL to the directory where temporary files are stored. When an SDLFile is

created with NSData, it writes to a temporary file until the file manager finishes

uploading it.

The SDL library manages the creation and deletion of these files and you

should not have to touch this directory at all.

OBJECTIVE-C

+ (nonnull NSURL *)temporaryFileDirectory;

SWIFT

class func temporaryFileDirectory() -> URL

An NSURL pointing to the location on disk where SDL’s temporary files are

stored.

SDLFileType Class Reference

Section Contents

• +valueOf:• +values• +GRAPHIC_BMP• +GRAPHIC_JPEG• +GRAPHIC_PNG• +AUDIO_WAVE• +AUDIO_MP3• +AUDIO_AAC• +BINARY• +JSON

Overview

Enumeration listing possible file types.

@since SDL 2.0

+valueOf:

@abstract Convert String to SDLFileType

RETURN VALUE

value


SDLFileType

+values

@abstract Store the enumeration of all possible SDLFileType

OBJECTIVE-C

+ (SDLFileType *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLFileType!

PARAMETERS

RETURN VALUE

an array that store all possible SDLFileType

+GRAPHIC_BMP

@abstract file type: Bitmap (BMP)

OBJECTIVE-C


SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLFileType *)GRAPHIC_BMP;

SDLFileType with value of GRAPHIC_BMP

+GRAPHIC_JPEG

@abstract file type: JPEG

SWIFT

class func graphic_BMP() -> SDLFileType!

RETURN VALUE

OBJECTIVE-C

+ (SDLFileType *)GRAPHIC_JPEG;

SWIFT

class func graphic_JPEG() -> SDLFileType!

SDLFileType with value of GRAPHIC_JPEG

+GRAPHIC_PNG

@abstract file type: PNG

SDLFileType with value of GRAPHIC_PNG

RETURN VALUE

OBJECTIVE-C

+ (SDLFileType *)GRAPHIC_PNG;

SWIFT

class func graphic_PNG() -> SDLFileType!

RETURN VALUE

+AUDIO_WAVE

@abstract file type: WAVE (WAV)

SDLFileType with value of AUDIO_WAVE

+AUDIO_MP3

@abstract file type: MP3

OBJECTIVE-C

+ (SDLFileType *)AUDIO_WAVE;

SWIFT

class func audio_WAVE() -> SDLFileType!

RETURN VALUE

SDLFileType with value of AUDIO_MP3

+AUDIO_AAC

@abstract file type: AAC

OBJECTIVE-C

+ (SDLFileType *)AUDIO_MP3;

SWIFT

class func audio_MP3() -> SDLFileType!

RETURN VALUE

OBJECTIVE-C

+ (SDLFileType *)AUDIO_AAC;

SDLFileType with value of AUDIO_AAC

+BINARY

@abstract file type: BINARY

SWIFT

class func audio_AAC() -> SDLFileType!

RETURN VALUE

OBJECTIVE-C

+ (SDLFileType *)BINARY;

SWIFT

class func binary() -> SDLFileType!

SDLFileType with value of BINARY

+JSON

@abstract file type: JSON

SDLFileType with value of JSON

RETURN VALUE

OBJECTIVE-C

+ (SDLFileType *)JSON;

SWIFT

class func json() -> SDLFileType!

RETURN VALUE

SDLFuelCutoffStatus Class Reference

Section Contents

• +valueOf:• +values• +TERMINATE_FUEL• +NORMAL_OPERATION• +FAULT

Overview

Reflects the status of the Restraints Control Module fuel pump cutoff. The fuel

pump is cut off typically after the vehicle has had a collision.

@since SDL 2.0

+valueOf:

@abstract Convert String to SDLFuelCutoffStatus

OBJECTIVE-C

+ (SDLFuelCutoffStatus *)valueOf:(NSString *)value;

value


SDLFuelCutoffStatus

+values

@abstract Store the enumeration of all possible SDLFuelCutoffStatus

SWIFT

class func value(of value: String!) -> SDLFuelCutoffStatus!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


an array that stores all possible SDLFuelCutoffStatus

+TERMINATE_FUEL

@abstract Fuel is cut off - returns: the fuel cutoff status: TERMINATE_FUEL

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLFuelCutoffStatus *)TERMINATE_FUEL;

SWIFT

class func terminate_FUEL() -> SDLFuelCutoffStatus!

the fuel cutoff status: TERMINATE_FUEL

+NORMAL_OPERATION

@abstract Fuel is not cut off - returns: the fuel cutoff status:

NORMAL_OPERATION

the fuel cutoff status: NORMAL_OPERATION

RETURN VALUE

OBJECTIVE-C

+ (SDLFuelCutoffStatus *)NORMAL_OPERATION;

SWIFT

class func normal_OPERATION() -> SDLFuelCutoffStatus!

RETURN VALUE

+FAULT

@abstract Status of the fuel pump cannot be determined - returns: the fuel

cutoff status: FAULT

the fuel cutoff status: FAULT

OBJECTIVE-C

+ (SDLFuelCutoffStatus *)FAULT;

SWIFT

class func fault() -> SDLFuelCutoffStatus!

RETURN VALUE

SDLGPSData Class Reference

Section Contents

• -init• -initWithDictionary:• longitudeDegrees• latitudeDegrees• utcYear• utcMonth• utcDay• utcHours• utcMinutes• utcSeconds• compassDirection• pdop• hdop• vdop• actual• satellites• dimension• altitude• heading• speed

Overview

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

@since SDL 2.0

-init

Constructs a newly allocated SDLGPSData object


Constructs a newly allocated SDLGPSData object indicated by the dictionary


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


longitudeDegrees

@abstract longitude degrees

Required, Float, -180 - 180

latitudeDegrees

@abstract latitude degrees

PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *longitudeDegrees;

SWIFT

var longitudeDegrees: NSNumber! { get set }

Required, Float, -90 - 90

utcYear

@abstract utc year


OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *latitudeDegrees;

SWIFT

var latitudeDegrees: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *utcYear;

utcMonth

@abstract utc month


utcDay

@abstract utc day


SWIFT

var utcYear: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *utcMonth;

SWIFT

var utcMonth: NSNumber! { get set }

utcHours

@abstract utc hours


OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *utcDay;

SWIFT

var utcDay: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *utcHours;

SWIFT

var utcHours: NSNumber! { get set }

utcMinutes

@abstract utc minutes


utcSeconds

@abstract utc seconds


OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *utcMinutes;

SWIFT

var utcMinutes: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *utcSeconds;

compassDirection

Potential Compass Directions

pdop

@abstract The 3D positional dilution of precision.

@discussion If undefined or unavailable, then value shall be set to 0

Required, Float, 0.0 - 10.0

SWIFT

var utcSeconds: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLCompassDirection *compassDirection;

SWIFT

var compassDirection: SDLCompassDirection! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLCompassDirection.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLCompassDirection.html

hdop

@abstract The horizontal dilution of precision



OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *pdop;

SWIFT

var pdop: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *hdop;

vdop

@abstract the vertical dilution of precision



actual

@abstract What the coordinates are based on

SWIFT

var hdop: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *vdop;

SWIFT

var vdop: NSNumber! { get set }

@discussion YES, if coordinates are based on satellites. NO, if based on dead

reckoning.

Required, Boolean

satellites

@abstract The number of satellites in view


OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *actual;

SWIFT

var actual: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *satellites;

dimension

The supported dimensions of the GPS

Required

altitude

@abstract altitude in meters

Required, Float, -10000.0 - 10000.0

SWIFT

var satellites: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLDimension *dimension;

SWIFT

var dimension: SDLDimension! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDimension.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDimension.html

heading

@abstract Heading based on the GPS data.

@discussion North is 0, East is 90, etc. Resolution is 0.01


OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *altitude;

SWIFT

var altitude: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *heading;

speed

@abstract speed in KPH


SWIFT

var heading: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *speed;

SWIFT

var speed: NSNumber! { get set }

SDLGenericResponse Class Reference

Section Contents


Overview

Generic Response is sent, when the name of a received msg cannot be

retrieved. Only used in case of an error. Currently, only resultCode

INVALID_DATA is used.

-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLGenericResponse : SDLRPCResponse

SDLGetDTCs Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithECUName:• -initWithECUName:mask:• ecuName• dtcMask

Overview

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

vehicle module

Function Group: ProprietaryData


-init

Constructs a new SDLGetDTCs object

OBJECTIVE-C

@interface SDLGenericResponse : SDLRPCResponse


Constructs a new SDLGetDTCs object indicated by the dictionary parameter

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


-initWithECUName:

Undocumented

-initWithECUName:mask:

Undocumented

PARAMETERS

OBJECTIVE-C

@interface SDLGetDTCs : SDLRPCRequest

OBJECTIVE-C

@interface SDLGetDTCs : SDLRPCRequest

ecuName

@abstract a name of the module to receive the DTC form @discussion an

NSNumber value representing a name of the module to receive the DTC form

Notes: Minvalue:0; Maxvalue:65535

dtcMask

@abstract DTC Mask Byte to be sent in diagnostic request to module.

NSNumber* dtcMask Minvalue:0; Maxvalue:255

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *ecuName;

SWIFT

var ecuName: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *dtcMask;

SDLGetDTCsResponse Class Reference

Section Contents

• -init• -initWithDictionary:• ecuHeader• dtc

Overview

SDLGetDTCsResponse is sent, when SDLGetDTCs has been called


-init

Undocumented

SWIFT

var dtcMask: NSNumber! { get set }


Undocumented

ecuHeader

Undocumented

OBJECTIVE-C

@interface SDLGetDTCsResponse : SDLRPCResponse

OBJECTIVE-C


OBJECTIVE-C


dtc

Undocumented

SDLGetVehicleData Class Reference

Section Contents

• -init• -initWithDictionary:• -

initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:• gps• speed• rpm• fuelLevel• fuelLevel_State• instantFuelConsumption• externalTemperature• vin• prndl• tirePressure• odometer• beltStatus

OBJECTIVE-C


• bodyInformation• deviceStatus• driverBraking• wiperStatus• headLampStatus• engineTorque• accPedalPosition• steeringWheelAngle• eCallInfo• airbagStatus• emergencyEvent• clusterModeStatus• myKey

Overview

Requests surrent values of specific published vehicle data items.

Function Group: Location, VehicleInfo and DrivingChara



See SDLSubscribeVehicleData SDLUnsubscribeVehicleData

-init

@abstract Constructs a new SDLGetVehicleData object

OBJECTIVE-C



@abstract Constructs a new SDLGetVehicleData object indicated by the


dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


-

initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clu

Undocumented

gps

@abstract A boolean value. If true, requests Gps data

OBJECTIVE-C

@interface SDLGetVehicleData : SDLRPCRequest

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *gps;

SWIFT

var gps: NSNumber! { get set }

speed

@abstract A boolean value. If true, requests speed data

rpm

@abstract A boolean value. If true, requests rpm data

OBJECTIVE-C


SWIFT


OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *rpm;

fuelLevel

@abstract A boolean value. If true, requests FuelLevel data

fuelLevel_State

@abstract A boolean value. If true, requests fuelLevel_State data

SWIFT

var rpm: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *fuelLevel;

SWIFT

var fuelLevel: NSNumber! { get set }

instantFuelConsumption

@abstract A boolean value. If true, requests instantFuelConsumption data

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *fuelLevel_State;

SWIFT

var fuelLevel_State: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *instantFuelConsumption;

SWIFT

var instantFuelConsumption: NSNumber! { get set }

externalTemperature

@abstract A boolean value. If true, requests externalTemperature data

vin

@abstract A boolean value. If true, requests Vehicle Identification Number

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *externalTemperature;

SWIFT

var externalTemperature: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *vin;

prndl

@abstract A boolean value. If true, requests Currently selected gear data

tirePressure

@abstract A boolean value. If true, requests tire pressure status data

SWIFT

var vin: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *prndl;

SWIFT

var prndl: NSNumber! { get set }

odometer

@abstract A boolean value. If true, requests odometer data

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *tirePressure;

SWIFT

var tirePressure: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *odometer;

SWIFT

var odometer: NSNumber! { get set }

beltStatus

@abstract A boolean value. If true, requests belt Status data

bodyInformation

@abstract A boolean value. If true, requests body Information data

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *beltStatus;

SWIFT

var beltStatus: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *bodyInformation;

deviceStatus

@abstract A boolean value. If true, requests device Status data

driverBraking

@abstract A boolean value. If true, requests driver Braking data

SWIFT

var bodyInformation: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *deviceStatus;

SWIFT

var deviceStatus: NSNumber! { get set }

wiperStatus

@abstract A boolean value. If true, requests wiper Status data

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *driverBraking;

SWIFT

var driverBraking: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *wiperStatus;

SWIFT

var wiperStatus: NSNumber! { get set }

headLampStatus

@abstract A boolean value. If true, requests Head Lamp Status data

engineTorque

@abstract A boolean value. If true, requests Engine Torque data

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *headLampStatus;

SWIFT

var headLampStatus: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *engineTorque;

accPedalPosition

@abstract A boolean value. If true, means the accPedalPosition data has been

subscribed.

steeringWheelAngle

@abstract A boolean value. If true, means the steeringWheelAngle data has

been subscribed.

SWIFT

var engineTorque: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *accPedalPosition;

SWIFT

var accPedalPosition: NSNumber! { get set }

eCallInfo

Undocumented

airbagStatus

Undocumented

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *steeringWheelAngle;

SWIFT

var steeringWheelAngle: NSNumber! { get set }

OBJECTIVE-C


emergencyEvent

Undocumented

clusterModeStatus

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


myKey

Undocumented

SDLGetVehicleDataResponse ClassReference

Section Contents

• -init• -initWithDictionary:• gps• speed• rpm• fuelLevel• fuelLevel_State• instantFuelConsumption• externalTemperature• vin• prndl• tirePressure• odometer• beltStatus

OBJECTIVE-C


• bodyInformation• deviceStatus• driverBraking• wiperStatus• headLampStatus• engineTorque• accPedalPosition• steeringWheelAngle• eCallInfo• airbagStatus• emergencyEvent• clusterModeStatus• myKey

Overview

Get Vehicle Data Response is sent, when SDLGetVehicleData has been called


-init

@abstract Constructs a new SDLGetVehicleDataResponse object

OBJECTIVE-C



@abstract Constructs a new SDLGetVehicleDataResponse object indicated by

the NSMutableDictionary parameter - parameter: dict The dictionary to use

dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


gps

@abstract A SDLGPSData* value. See GPSData.

speed

@abstract The vehicle speed in kilometers per hour.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLGPSData *gps;

SWIFT

var gps: SDLGPSData! { get set }

OBJECTIVE-C


https://d83tozu1c8tt6.cloudfront.net/Classes/SDLGPSData.html


rpm

@abstract The number of revolutions per minute of the engine.

fuelLevel

@abstract The fuel level in the tank (percentage)

SWIFT


OBJECTIVE-C


SWIFT


fuelLevel_State

@abstract A SDLComponentVolumeStatus* value. The fuel level state.

OBJECTIVE-C


SWIFT


OBJECTIVE-C

@property (readwrite, strong, atomic) SDLComponentVolumeStatus *fuelLevel_State;

SWIFT

var fuelLevel_State: SDLComponentVolumeStatus! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLComponentVolumeStatus.html



@abstract The instantaneous fuel consumption in microlitres.

externalTemperature

@abstract The external temperature in degrees celsius.

OBJECTIVE-C


SWIFT


OBJECTIVE-C


vin

@abstract The Vehicle Identification Number

prndl

@abstract See PRNDL.

SWIFT


OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *vin;

SWIFT

var vin: String! { get set }

tirePressure

@abstract A SDLTireStatus* value. See TireStatus.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLPRNDL *prndl;

SWIFT

var prndl: SDLPRNDL! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLTireStatus *tirePressure;

SWIFT

var tirePressure: SDLTireStatus! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLPRNDL.html


https://d83tozu1c8tt6.cloudfront.net/Classes/SDLTireStatus.html


odometer

@abstract Odometer reading in km.

beltStatus

@abstract A SDLBeltStatus* value. The status of the seat belts.

OBJECTIVE-C


SWIFT


OBJECTIVE-C

@property (readwrite, strong, atomic) SDLBeltStatus *beltStatus;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLBeltStatus.html

bodyInformation

@abstract A SDLBodyInformation* value. The body information including power

modes.

deviceStatus

@abstract A SDLDeviceStatus* value. The device status including signal and

battery strength.

SWIFT

var beltStatus: SDLBeltStatus! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLBodyInformation *bodyInformation;

SWIFT

var bodyInformation: SDLBodyInformation! { get set }


https://d83tozu1c8tt6.cloudfront.net/Classes/SDLBodyInformation.html


driverBraking

@abstract A SDLVehicleDataResult* value. The status of the brake pedal.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLDeviceStatus *deviceStatus;

SWIFT

var deviceStatus: SDLDeviceStatus! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataEventStatus *driverBraking;

SWIFT

var driverBraking: SDLVehicleDataEventStatus! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDeviceStatus.html


https://d83tozu1c8tt6.cloudfront.net/Classes/SDLVehicleDataEventStatus.html


wiperStatus

@abstract A SDLWiperStatus* value. The status of the wipers.

headLampStatus

@abstract A SDLHeadLampStatus* value. Status of the head lamps.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLWiperStatus *wiperStatus;

SWIFT

var wiperStatus: SDLWiperStatus! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLHeadLampStatus *headLampStatus;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLWiperStatus.html


https://d83tozu1c8tt6.cloudfront.net/Classes/SDLHeadLampStatus.html

engineTorque

@abstract Torque value for engine (in Nm) on non-diesel variants.

accPedalPosition

@abstract Accelerator pedal position (percentage depressed)

SWIFT

var headLampStatus: SDLHeadLampStatus! { get set }

OBJECTIVE-C


SWIFT



steeringWheelAngle

@abstract Current angle of the steering wheel (in deg)

OBJECTIVE-C


SWIFT


OBJECTIVE-C


SWIFT


eCallInfo

Undocumented

airbagStatus

Undocumented

emergencyEvent

Undocumented

OBJECTIVE-C

@interface SDLGetVehicleDataResponse : SDLRPCResponse

OBJECTIVE-C


OBJECTIVE-C


clusterModeStatus

Undocumented

myKey

Undocumented

SDLGlobalProperty Class Reference

Section Contents

• +valueOf:• +values• +HELPPROMPT

OBJECTIVE-C


OBJECTIVE-C


• +TIMEOUTPROMPT• +VRHELPTITLE• +VRHELPITEMS• +MENUNAME• +MENUICON• +KEYBOARDPROPERTIES

Overview

Properties of a user-initiated VR interaction (i.e. interactions started by the user

pressing the PTT button).

@since SDL 1.0

+valueOf:

Convert String to SDLGlobalProperty - parameter: value The value of the string

to get an object for - returns: SDLGlobalProperty

OBJECTIVE-C

+ (SDLGlobalProperty *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLGlobalProperty!

value


SDLGlobalProperty

+values

@abstract Store the enumeration of all possible SDLGlobalProperty - returns: An

array that store all possible SDLGlobalProperty

PARAMETERS

RETURN VALUE

OBJECTIVE-C


SWIFT


An array that store all possible SDLGlobalProperty

+HELPPROMPT

@abstract The help prompt to be spoken if the user needs assistance during a

user-initiated interaction. - returns: A SDLGlobalProperty with value of

HELPPROMPT

A SDLGlobalProperty with value of HELPPROMPT

RETURN VALUE

OBJECTIVE-C

+ (SDLGlobalProperty *)HELPPROMPT;

SWIFT

class func helpprompt() -> SDLGlobalProperty!

RETURN VALUE

+TIMEOUTPROMPT

@abstract The prompt to be spoken if the user-initiated interaction times out

waiting for the user’s verbal input. - returns: A SDLGlobalProperty with value of

TIMEOUTPROMPT

A SDLGlobalProperty with value of TIMEOUTPROMPT

+VRHELPTITLE

Undocumented

OBJECTIVE-C

+ (SDLGlobalProperty *)TIMEOUTPROMPT;

SWIFT

class func timeoutprompt() -> SDLGlobalProperty!

RETURN VALUE

+VRHELPITEMS

Undocumented

+MENUNAME

Undocumented

OBJECTIVE-C

@interface SDLGlobalProperty : SDLEnum

OBJECTIVE-C


OBJECTIVE-C


+MENUICON

Undocumented

+KEYBOARDPROPERTIES

Undocumented

SDLHMICapabilities Class Reference

Section Contents

• -init• -initWithDictionary:• navigation

OBJECTIVE-C


OBJECTIVE-C


• phoneCall

Overview

Undocumented

-init

Undocumented


Undocumented

navigation

Availability of build in Nav. True: Available, False: Not Available

Boolean value. Optional.

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber *navigation;

SWIFT

@NSCopying var navigation: NSNumber! { get set }

phoneCall

Availability of build in phone. True: Available, False: Not Available

Boolean value. Optional.

SDLHMILevel Class Reference

Section Contents

• +valueOf:• +values• +FULL• +LIMITED• +BACKGROUND• +NONE

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber *phoneCall;

SWIFT

@NSCopying var phoneCall: NSNumber! { get set }

Overview

Specifies current level of the HMI. An HMI level indicates the degree of user

interaction possible through the HMI (e.g. TTS only, display only, VR, etc.). The

HMI level varies for an application based on the type of display (i.e. Nav or non-

Nav) and the user directing “focus” to other applications (e.g. phone, other

mobile applications, etc.)

@since SDL 1.0

+valueOf:

Return HMILevel status (FULL, LIMITED, BACKGROUND, NONE)

value

OBJECTIVE-C

+ (SDLHMILevel *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLHMILevel!

PARAMETERS


Current HMI level

+values

Store all possible SDLHMILevel values

an array with all possible HMILevel values inside

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+FULL

The application has full use of the SDL HMI. The app may output via TTS,

display, or streaming audio and may gather input via VR, Menu, and button

presses

the HMILevel with value of FULL

+LIMITED

This HMI Level is only defined for a media application using an HMI with an 8

inch touchscreen (Nav) system. The application’s Show text is displayed and it

receives button presses from media-oriented buttons (SEEKRIGHT, SEEKLEFT,

TUNEUP, TUNEDOWN, PRESET_0-9)

OBJECTIVE-C

+ (SDLHMILevel *)FULL;

SWIFT

class func full() -> SDLHMILevel!

RETURN VALUE

the HMILevel with value of LIMITED

+BACKGROUND

App cannot interact with user via TTS, VR, Display or Button Presses. App can

perform the following operations:

@discussion

• Operation : AddCommand• Operation : DeleteCommand• Operation : AddSubMenu• Operation : DeleteSubMenu• Operation : CreateInteractionChoiceSet• Operation : DeleteInteractionChoiceSet

OBJECTIVE-C

+ (SDLHMILevel *)LIMITED;

SWIFT

class func limited() -> SDLHMILevel!

RETURN VALUE

• Operation : SubscribeButton• Operation : UnsubscribeButton• Operation : Show• Operation : UnregisterAppInterface• Operation : ResetGlobalProperties• Operation : SetGlobalProperties

the HMILevel with value of BACKGROUND

+NONE

Application has been discovered by SDL, but it cannot send any requests or

receive any notifications

@discussion An HMILevel of NONE can also mean that the user has exited the

application by saying “exit appname” or selecting “exit” from the application’s

OBJECTIVE-C

+ (SDLHMILevel *)BACKGROUND;

SWIFT

class func background() -> SDLHMILevel!

RETURN VALUE

menu. When this happens, the application still has an active interface

registration with SDL and all SDL resources the application has created (e.g.

Choice Sets, subscriptions, etc.) still exist. But while the HMILevel is NONE, the

application cannot send any messages to SYNC, except UnregisterAppInterface

the HMILevel with value of NONE

SDLHMIPermissions Class Reference

Section Contents


OBJECTIVE-C

+ (SDLHMILevel *)NONE;

SWIFT

class func none() -> SDLHMILevel!

RETURN VALUE

• allowed• userDisallowed

Overview

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

@since SDL 2.0

-init

Constructs a newly allocated SDLHMIPermissions object


Constructs a newly allocated SDLHMIPermissions object indicated by the

dictionary parameter - parameter: dict The dictionary to use

OBJECTIVE-C


SWIFT

init!()

dict


allowed

@abstract a set of all HMI levels that are permitted for this given RPC

SeeSDLHMILevel Required, Array of SDLHMILevel, Array size 0 - 100

OBJECTIVE-C


SWIFT


PARAMETERS

userDisallowed

@abstract a set of all HMI levels that are prohibited for this given RPC

SeeSDLHMILevel Required, Array of SDLHMILevel, Array size 0 - 100

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *allowed;

SWIFT

var allowed: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *userDisallowed;

SDLHMIZoneCapabilities ClassReference

Section Contents

• +valueOf:• +values• +FRONT• +BACK

Overview

Specifies HMI Zones in the vehicle.

@since SDL 1.0

+valueOf:

@abstract SDLHMIZoneCapabilities - parameter: value The value of the string

to get an object for - returns: SDLHMIZoneCapabilities

SWIFT

var userDisallowed: NSMutableArray! { get set }

value


SDLHMIZoneCapabilities

OBJECTIVE-C

+ (SDLHMIZoneCapabilities *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLHMIZoneCapabilities!

PARAMETERS

RETURN VALUE

+values

@abstract store all possible SDLHMIZoneCapabilities values - returns: an array

with all possible SDLHMIZoneCapabilities values inside

an array with all possible SDLHMIZoneCapabilities values inside

+FRONT

@abstract Indicates HMI available for front seat passengers. - returns: a

SDLHMIZoneCapabilities with value of FRONT

OBJECTIVE-C


SWIFT


RETURN VALUE

a SDLHMIZoneCapabilities with value of FRONT

+BACK

@abstract Indicates HMI available for rear seat passengers. - returns: a

SDLHMIZoneCapabilities with value of BACK

OBJECTIVE-C

+ (SDLHMIZoneCapabilities *)FRONT;

SWIFT

class func front() -> SDLHMIZoneCapabilities!

RETURN VALUE

OBJECTIVE-C

+ (SDLHMIZoneCapabilities *)BACK;

a SDLHMIZoneCapabilities with value of BACK

SDLHeadLampStatus Class Reference

Section Contents

• -init• -initWithDictionary:• lowBeamsOn• highBeamsOn• ambientLightSensorStatus

Overview

Status of the head lamps

-init

@abstract Constructs a new SDLHeadLampStatus object

SWIFT

class func back() -> SDLHMIZoneCapabilities!

RETURN VALUE


@abstract Constructs a new SDLHeadLampStatus object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


lowBeamsOn

@abstract A boolean value. Status of the low beam lamps.

highBeamsOn

@abstract A boolean value. Status of the high beam lamps.

PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *lowBeamsOn;

SWIFT

var lowBeamsOn: NSNumber! { get set }

ambientLightSensorStatus

Undocumented

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *highBeamsOn;

SWIFT

var highBeamsOn: NSNumber! { get set }

OBJECTIVE-C

@interface SDLHeadLampStatus : SDLRPCStruct

SDLIAPTransport Class Reference

Section Contents

• controlSession• session

Overview

Undocumented

controlSession

Undocumented

session

Undocumented

SDLIgnitionStableStatus ClassReference

Section Contents

• +valueOf:• +values• +IGNITION_SWITCH_NOT_STABLE• +IGNITION_SWITCH_STABLE• +MISSING_FROM_TRANSMITTER

Overview

Reflects the ignition switch stability.

@since SDL 2.0

+valueOf:

@abstract return SDLIgnitionStableStatus - parameter: value The value of the

string to get an object for - returns: SDLIgnitionStableStatus

value


OBJECTIVE-C

+ (SDLIgnitionStableStatus *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLIgnitionStableStatus!

PARAMETERS

SDLIgnitionStableStatus

+values

@abstract store all possible SDLIgnitionStableStatus values - returns: an array

with all possible SDLIgnitionStableStatus values inside

an array with all possible SDLIgnitionStableStatus values inside

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+IGNITION_SWITCH_NOT_STABLE

@abstract The current ignition switch status is considered not to be stable. -

returns: the Ignition Stable Status with value of IGNITION_SWITCH_NOT_STABLE

the Ignition Stable Status with value of IGNITION_SWITCH_NOT_STABLE

+IGNITION_SWITCH_STABLE

@abstract The current ignition switch status is considered to be stable. -

returns: the Ignition Stable Status with value of IGNITION_SWITCH_STABLE

OBJECTIVE-C

+ (SDLIgnitionStableStatus *)IGNITION_SWITCH_NOT_STABLE;

SWIFT

class func ignition_SWITCH_NOT_STABLE() -> SDLIgnitionStableStatus!

RETURN VALUE

the Ignition Stable Status with value of IGNITION_SWITCH_STABLE

+MISSING_FROM_TRANSMITTER

Undocumented

OBJECTIVE-C

+ (SDLIgnitionStableStatus *)IGNITION_SWITCH_STABLE;

SWIFT

class func ignition_SWITCH_STABLE() -> SDLIgnitionStableStatus!

RETURN VALUE

OBJECTIVE-C

@interface SDLIgnitionStableStatus : SDLEnum

SDLIgnitionStatus Class Reference

Section Contents

• +valueOf:• +values• +UNKNOWN• +OFF• +ACCESSORY• +RUN• +START• +INVALID

Overview

Reflects the status of ignition..

@since SDL 2.0

+valueOf:

@abstract return SDLIgnitionStatus - parameter: value The value of the string

to get an object for - returns: SDLIgnitionStatus object

OBJECTIVE-C

+ (SDLIgnitionStatus *)valueOf:(NSString *)value;

value


SDLIgnitionStatus object

+values

@abstract store all possible SDLIgnitionStatus values - returns: an array with all

possible SDLIgnitionStatus values inside

SWIFT

class func value(of value: String!) -> SDLIgnitionStatus!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


an array with all possible SDLIgnitionStatus values inside

+UNKNOWN

@abstract Ignition status currently unknown - returns: Ignition Status with value

of UNKNOWN

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLIgnitionStatus *)UNKNOWN;

SWIFT

class func unknown() -> SDLIgnitionStatus!

Ignition Status with value of UNKNOWN

+OFF

@abstract Ignition is off - returns: Ignition Status with value of OFF

Ignition Status with value of OFF

RETURN VALUE

OBJECTIVE-C

+ (SDLIgnitionStatus *)OFF;

SWIFT

class func off() -> SDLIgnitionStatus!

RETURN VALUE

+ACCESSORY

@abstract Ignition is in mode accessory - returns: Ignition Status with value of

ACCESSORY

Ignition Status with value of ACCESSORY

+RUN

@abstract Ignition is in mode run - returns: Ignition Status with value of RUN

OBJECTIVE-C

+ (SDLIgnitionStatus *)ACCESSORY;

SWIFT

class func accessory() -> SDLIgnitionStatus!

RETURN VALUE

Ignition Status with value of RUN

+START

@abstract Ignition is in mode start - returns: Ignition Status with value of START

OBJECTIVE-C

+ (SDLIgnitionStatus *)RUN;

SWIFT

class func run() -> SDLIgnitionStatus!

RETURN VALUE

OBJECTIVE-C

+ (SDLIgnitionStatus *)START;

Ignition Status with value of START

+INVALID

@abstract Signal is invalid - returns: Ignition Status with value of INVALID

SWIFT

class func start() -> SDLIgnitionStatus!

RETURN VALUE

OBJECTIVE-C

+ (SDLIgnitionStatus *)INVALID;

SWIFT

class func invalid() -> SDLIgnitionStatus!

Ignition Status with value of INVALID

SDLImage Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithName:ofType:• value• imageType

Overview

Specifies, which image shall be used, e.g. in SDLAlerts or on SDLSoftbuttons

provided the display supports it.

@since SDL 2.0

-init

Constructs a newly allocated SDLImage object

RETURN VALUE


Constructs a newly allocated SDLImage object indicated by the dictionary


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


-initWithName:ofType:

Undocumented

value

@abstract The static hex icon value or the binary image file name identifier

(sent by SDLPutFile)

Required, max length = 65535

PARAMETERS

OBJECTIVE-C

@interface SDLImage : SDLRPCStruct

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *value;

imageType

@abstract Describes, whether it is a static or dynamic image

Required

SWIFT

var value: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLImageType *imageType;

SWIFT

var imageType: SDLImageType! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLImageType.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLImageType.html

SDLImageField Class Reference

Section Contents

• -init• -initWithDictionary:• name• imageTypeSupported• imageResolution

Overview

Undocumented

-init

Undocumented


Undocumented

name

Undocumented

imageTypeSupported

Undocumented

imageResolution

Undocumented

SDLImageFieldName Class Reference

Section Contents

• +valueOf:• +values• +softButtonImage• +choiceImage• +choiceSecondaryImage• +vrHelpItem• +turnIcon• +menuIcon• +cmdIcon• +appIcon• +graphic• +showConstantTBTIcon• +showConstantTBTNextTurnIcon• +locationImage

Overview

The name that identifies the filed. * * * @since SmartDeviceLink 3.0 *

+valueOf:

Undocumented

+values

Undocumented

+softButtonImage

The image field for SoftButton *

OBJECTIVE-C

@interface SDLImageFieldName : SDLEnum

OBJECTIVE-C

@interface SDLImageFieldName : SDLEnum

OBJECTIVE-C

+ (SDLImageFieldName *)softButtonImage;

+choiceImage

The first image field for Choice. *

+choiceSecondaryImage

The scondary image field for Choice. *

SWIFT

class func softButtonImage() -> SDLImageFieldName!

OBJECTIVE-C

+ (SDLImageFieldName *)choiceImage;

SWIFT

class func choiceImage() -> SDLImageFieldName!

+vrHelpItem

The image field for vrHelpItem. *

OBJECTIVE-C

+ (SDLImageFieldName *)choiceSecondaryImage;

SWIFT

class func choiceSecondaryImage() -> SDLImageFieldName!

OBJECTIVE-C

+ (SDLImageFieldName *)vrHelpItem;

SWIFT

class func vrHelpItem() -> SDLImageFieldName!

+turnIcon

The image field for Turn. *

+menuIcon

The image field for the menu icon in SetGlobalProperties. *

OBJECTIVE-C

+ (SDLImageFieldName *)turnIcon;

SWIFT

class func turnIcon() -> SDLImageFieldName!

OBJECTIVE-C

+ (SDLImageFieldName *)menuIcon;

+cmdIcon

The image filed for AddCommand. *

+appIcon

The iamage field for the app icon ( set by setAppIcon). *

SWIFT

class func menuIcon() -> SDLImageFieldName!

OBJECTIVE-C

+ (SDLImageFieldName *)cmdIcon;

SWIFT

class func cmdIcon() -> SDLImageFieldName!

+graphic

The image filed for Show. *

OBJECTIVE-C

+ (SDLImageFieldName *)appIcon;

SWIFT

class func appIcon() -> SDLImageFieldName!

OBJECTIVE-C

+ (SDLImageFieldName *)graphic;

SWIFT

class func graphic() -> SDLImageFieldName!

+showConstantTBTIcon

The primary image field for ShowConstant TBT. *

+showConstantTBTNextTurnIcon

The secondary image field for ShowConstant TBT. *

OBJECTIVE-C

+ (SDLImageFieldName *)showConstantTBTIcon;

SWIFT

class func showConstantTBTIcon() -> SDLImageFieldName!

OBJECTIVE-C

+ (SDLImageFieldName *)showConstantTBTNextTurnIcon;

+locationImage

The optional image of a destination / location @since SDL 4.0

SWIFT

class func showConstantTBTNextTurnIcon() -> SDLImageFieldName!

OBJECTIVE-C

+ (SDLImageFieldName *)locationImage;

SWIFT

class func locationImage() -> SDLImageFieldName!

SDLImageResolution Class Reference

Section Contents

• -init• -initWithDictionary:• resolutionWidth• resolutionHeight

Overview

Undocumented

-init

Undocumented


Undocumented

resolutionWidth

Undocumented

resolutionHeight

Undocumented

SDLImageType Class Reference

Section Contents

• +valueOf:• +values• +STATIC• +DYNAMIC

Overview

Contains information about the type of image.

@since SDL 2.0

+valueOf:

@abstract return SDLImageType (STATIC / DYNAMIC)

OBJECTIVE-C

+ (SDLImageType *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLImageType!

value


An SDLImageType

+values

@abstract store all possible SDLImageType values

PARAMETERS

RETURN VALUE

OBJECTIVE-C


SWIFT


An array with all possible SDLImageType values inside

+STATIC

@abstract Just the static hex icon value to be used

The Image Type with value STATIC

RETURN VALUE

OBJECTIVE-C

+ (SDLImageType *)STATIC;

SWIFT

class func `static`() -> SDLImageType!

RETURN VALUE

+DYNAMIC

@abstract Binary image file to be used (identifier to be sent by SDLPutFile)

See

SDLPutFile

The Image Type with value DYNAMIC

OBJECTIVE-C

+ (SDLImageType *)DYNAMIC;

SWIFT

class func dynamic() -> SDLImageType!

RETURN VALUE

SDLInteractionMode Class Reference

Section Contents

• +valueOf:• +values• +MANUAL_ONLY• +VR_ONLY• +BOTH

Overview

For application-initiated interactions (SDLPerformInteraction), this specifies the

mode by which the user is prompted and by which the user’s selection is

indicated

@since SDL 1.0

+valueOf:

@abstract SDLInteractionMode - parameter: value The value of the string to get

an object for - returns: SDLInteractionMode

OBJECTIVE-C

+ (SDLInteractionMode *)valueOf:(NSString *)value;

value


SDLInteractionMode

+values

@abstract store all possible SDLInteractionMode values - returns: an array with

all possible SDLInteractionMode values inside

SWIFT

class func value(of value: String!) -> SDLInteractionMode!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


an array with all possible SDLInteractionMode values inside

+MANUAL_ONLY

@abstract Interaction Mode : Manual Only @discussion This mode causes the

interaction to occur only on the display, meaning the choices are presented and

selected only via the display. Selections are viewed with the SEEKRIGHT,

SEEKLEFT, TUNEUP, TUNEDOWN buttons. User’s selection is indicated with the

OK button

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLInteractionMode *)MANUAL_ONLY;

Current Interaction Mode with value of MANUAL_ONLY

+VR_ONLY

@abstract Interaction Mode : VR Only @discussion This mode causes the

interaction to occur only through TTS and VR. The user is prompted via TTS to

select a choice by saying one of the choice’s synonyms

SWIFT

class func manual_ONLY() -> SDLInteractionMode!

RETURN VALUE

OBJECTIVE-C

+ (SDLInteractionMode *)VR_ONLY;

SWIFT

class func vr_ONLY() -> SDLInteractionMode!

Current Interaction Mode with value of VR_ONLY

+BOTH

@abstract Interaction Mode : Manual & VR @discussion This mode is a

combination of MANUAL_ONLY and VR_ONLY, meaning the user is prompted

both visually and audibly. The user can make a selection either using the mode

described in MANUAL_ONLY or using the mode described in VR_ONLY.

If the user views selections as described in MANUAL_ONLY mode, the

interaction becomes strictly, and irreversibly, a MANUAL_ONLY interaction (i.e.

the VR session is cancelled, although the interaction itself is still in progress). If

the user interacts with the VR session in any way (e.g. speaks a phrase, even if

it is not a recognized choice), the interaction becomes strictly, and irreversibly,

a VR_ONLY interaction (i.e. the MANUAL_ONLY mode forms of interaction will no

longer be honored)

The TriggerSource parameter of the PerformInteraction response will indicate

which interaction mode the user finally chose to attempt the selection (even if

the interaction did not end with a selection being made)

RETURN VALUE

OBJECTIVE-C

+ (SDLInteractionMode *)BOTH;

Current Interaction Mode with value of BOTH

SDLJingle Class Reference

Section Contents

• +NEGATIVE_JINGLE• +POSITIVE_JINGLE• +LISTEN_JINGLE• +INITIAL_JINGLE• +HELP_JINGLE

Overview

Undocumented

+NEGATIVE_JINGLE

Undocumented

SWIFT

class func both() -> SDLInteractionMode!

RETURN VALUE

+POSITIVE_JINGLE

Undocumented

+LISTEN_JINGLE

Undocumented

+INITIAL_JINGLE

Undocumented

+HELP_JINGLE

Undocumented

SDLKeyboardEvent Class Reference

Section Contents

• +valueOf:• +values• +KEYPRESS• +ENTRY_SUBMITTED• +ENTRY_CANCELLED• +ENTRY_ABORTED• +ENTRY_VOICE

Overview

Enumeration listing possible keyboard events. * * @since SmartDeviceLink 3.0 *

+valueOf:

Undocumented

+values

Undocumented

+KEYPRESS

The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and

RESEND_CURRENT_ENTRY modes). *

OBJECTIVE-C

@interface SDLKeyboardEvent : SDLEnum

OBJECTIVE-C

@interface SDLKeyboardEvent : SDLEnum

OBJECTIVE-C

+ (SDLKeyboardEvent *)KEYPRESS;

+ENTRY_SUBMITTED

The User has finished entering text from the keyboard and submitted the entry.

*

+ENTRY_CANCELLED

The User has pressed the HMI-defined “Cancel” button. *

SWIFT

class func keypress() -> SDLKeyboardEvent!

OBJECTIVE-C

+ (SDLKeyboardEvent *)ENTRY_SUBMITTED;

SWIFT

class func entry_SUBMITTED() -> SDLKeyboardEvent!

+ENTRY_ABORTED

The User has not finished entering text and the keyboard is aborted with the

event of higher priority. *

OBJECTIVE-C

+ (SDLKeyboardEvent *)ENTRY_CANCELLED;

SWIFT

class func entry_CANCELLED() -> SDLKeyboardEvent!

OBJECTIVE-C

+ (SDLKeyboardEvent *)ENTRY_ABORTED;

SWIFT

class func entry_ABORTED() -> SDLKeyboardEvent!

+ENTRY_VOICE

@since SDL 4.0

SDLKeyboardLayout Class Reference

Section Contents

• +valueOf:• +values• +QWERTY• +QWERTZ

OBJECTIVE-C

+ (SDLKeyboardEvent *)ENTRY_VOICE;

SWIFT

class func entry_VOICE() -> SDLKeyboardEvent!

• +AZERTY

Overview

Enumeration listing possible keyboard layouts * *Since SmartDeviceLink 3.0 *

+valueOf:

Undocumented

+values

Undocumented

+QWERTY

QWERTY layout (the name comes from the first six keys

appearing on the top left letter row of the keyboard and read from left to right)

*

OBJECTIVE-C

@interface SDLKeyboardLayout : SDLEnum

OBJECTIVE-C

@interface SDLKeyboardLayout : SDLEnum

+QWERTZ

QWERTZ layout (the name comes from the first six keys


*

OBJECTIVE-C

+ (SDLKeyboardLayout *)QWERTY;

SWIFT

class func qwerty() -> SDLKeyboardLayout!

OBJECTIVE-C

+ (SDLKeyboardLayout *)QWERTZ;

+AZERTY

AZERTY layout (the name comes from the first six keys


*

SWIFT

class func qwertz() -> SDLKeyboardLayout!

OBJECTIVE-C

+ (SDLKeyboardLayout *)AZERTY;

SWIFT

class func azerty() -> SDLKeyboardLayout!

SDLKeyboardProperties Class Reference

Section Contents


initWithLanguage:layout:keypressMode:limitedCharacterList:autoCompleteText:• language• keyboardLayout• keypressMode• limitedCharacterList• autoCompleteText

Overview

Undocumented

-init

Undocumented


Undocumented

-

initWithLanguage:layout:keypressMode:limitedCharacterList:autoCompleteText

Undocumented

language

Undocumented

keyboardLayout

Undocumented

keypressMode

Undocumented

limitedCharacterList

Undocumented

autoCompleteText

Undocumented

SDLKeypressMode Class Reference

Section Contents

• +valueOf:• +values• +SINGLE_KEYPRESS• +QUEUE_KEYPRESSES

• +RESEND_CURRENT_ENTRY

Overview

Enumeration listing possible keyboard events. *

* Note: Depending on keypressMode value (from keyboardProperties structure

of UI.SetGlobalProperties),

HMI must send the onKeyboardInput notification with the following data:

SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY. * @since

SmartDeviceLink 3.0 *

+valueOf:

Undocumented

+values

Undocumented

OBJECTIVE-C

@interface SDLKeypressMode : SDLEnum

OBJECTIVE-C

@interface SDLKeypressMode : SDLEnum

+SINGLE_KEYPRESS

SINGLE_KEYPRESS:

Each and every User`s keypress must be reported (new notification for every

newly entered single symbol). *

+QUEUE_KEYPRESSES

QUEUE_KEYPRESSES:

The whole entry is reported only after the User submits it (by ‘Search’ button

click displayed on touchscreen keyboard) *

OBJECTIVE-C

+ (SDLKeypressMode *)SINGLE_KEYPRESS;

SWIFT

class func single_KEYPRESS() -> SDLKeypressMode!

OBJECTIVE-C

+ (SDLKeypressMode *)QUEUE_KEYPRESSES;

+RESEND_CURRENT_ENTRY

RESEND_CURRENT_ENTRY:

The whole entry must be reported each and every time the User makes a new

keypress

(new notification with all previously entered symbols and a newly entered one

appended). *

SWIFT

class func queue_KEYPRESSES() -> SDLKeypressMode!

OBJECTIVE-C

+ (SDLKeypressMode *)RESEND_CURRENT_ENTRY;

SWIFT

class func resend_CURRENT_ENTRY() -> SDLKeypressMode!

SDLLanguage Class Reference

Section Contents

• +valueOf:• +values• +EN_US• +ES_MX• +FR_CA• +DE_DE• +ES_ES• +EN_GB• +RU_RU• +TR_TR• +PL_PL• +FR_FR• +IT_IT• +SV_SE• +PT_PT• +NL_NL• +EN_AU• +ZH_CN• +ZH_TW• +JA_JP• +AR_SA• +KO_KR• +PT_BR• +CS_CZ• +DA_DK• +NO_NO

Overview

Specifies the language to be used for TTS, VR, displayed messages/menus

@since SDL 1.0

+valueOf:

@abstract Get a Langusge according to a String

value


OBJECTIVE-C

+ (SDLLanguage *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLLanguage!

PARAMETERS

The Language

+values

@abstract store all possible Language values

an array with all possible Language values inside

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+EN_US

Undocumented

+ES_MX

@abstract Spanish - Mexico

OBJECTIVE-C

@interface SDLLanguage : SDLEnum

OBJECTIVE-C

+ (SDLLanguage *)ES_MX;

SWIFT

class func es_MX() -> SDLLanguage!

+FR_CA

@abstract French - Canada

+DE_DE

@abstract German - Germany

OBJECTIVE-C

+ (SDLLanguage *)FR_CA;

SWIFT

class func fr_CA() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)DE_DE;

+ES_ES

@abstract Spanish - Spain

+EN_GB

@abstract English - Great Britain

SWIFT

class func de_DE() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)ES_ES;

SWIFT

class func es_ES() -> SDLLanguage!

+RU_RU

@abstract Russian - Russia

OBJECTIVE-C

+ (SDLLanguage *)EN_GB;

SWIFT

class func en_GB() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)RU_RU;

SWIFT

class func ru_RU() -> SDLLanguage!

+TR_TR

@abstract Turkish - Turkey

+PL_PL

@abstract Polish - Poland

OBJECTIVE-C

+ (SDLLanguage *)TR_TR;

SWIFT

class func tr_TR() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)PL_PL;

+FR_FR

@abstract French - France

+IT_IT

@abstract Italian - Italy

SWIFT

class func pl_PL() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)FR_FR;

SWIFT

class func fr_FR() -> SDLLanguage!

+SV_SE

@abstract Swedish - Sweden

OBJECTIVE-C

+ (SDLLanguage *)IT_IT;

SWIFT

class func it_IT() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)SV_SE;

SWIFT

class func sv_SE() -> SDLLanguage!

+PT_PT

@abstract Portuguese - Portugal

+NL_NL

@abstract Dutch (Standard) - Netherlands

OBJECTIVE-C

+ (SDLLanguage *)PT_PT;

SWIFT

class func pt_PT() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)NL_NL;

+EN_AU

@abstract English - Australia

+ZH_CN

@abstract Mandarin - China

SWIFT

class func nl_NL() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)EN_AU;

SWIFT

class func en_AU() -> SDLLanguage!

+ZH_TW

@abstract Mandarin - Taiwan

OBJECTIVE-C

+ (SDLLanguage *)ZH_CN;

SWIFT

class func zh_CN() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)ZH_TW;

SWIFT

class func zh_TW() -> SDLLanguage!

+JA_JP

@abstract Japanese - Japan

+AR_SA

@abstract Arabic - Saudi Arabia

OBJECTIVE-C

+ (SDLLanguage *)JA_JP;

SWIFT

class func ja_JP() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)AR_SA;

+KO_KR

@abstract Korean - South Korea

+PT_BR

@abstract Portuguese - Brazil

SWIFT

class func ar_SA() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)KO_KR;

SWIFT

class func ko_KR() -> SDLLanguage!

+CS_CZ

@abstract Czech - Czech Republic

OBJECTIVE-C

+ (SDLLanguage *)PT_BR;

SWIFT

class func pt_BR() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)CS_CZ;

SWIFT

class func cs_CZ() -> SDLLanguage!

+DA_DK

@abstract Danish - Denmark

+NO_NO

@abstract Norwegian - Norway

OBJECTIVE-C

+ (SDLLanguage *)DA_DK;

SWIFT

class func da_DK() -> SDLLanguage!

OBJECTIVE-C

+ (SDLLanguage *)NO_NO;

SDLLayoutMode Class Reference

Section Contents

• +valueOf:• +values• +ICON_ONLY• +ICON_WITH_SEARCH• +LIST_ONLY• +LIST_WITH_SEARCH• +KEYBOARD

Overview

For touchscreen interactions, the mode of how the choices are presented.

@since SDL 3.0

+valueOf:

Undocumented

SWIFT

class func no_NO() -> SDLLanguage!

+values

Undocumented

+ICON_ONLY

This mode causes the interaction to display the previous set of choices as

icons.

OBJECTIVE-C

@interface SDLLayoutMode : SDLEnum

OBJECTIVE-C

@interface SDLLayoutMode : SDLEnum

OBJECTIVE-C

+ (SDLLayoutMode *)ICON_ONLY;

+ICON_WITH_SEARCH

This mode causes the interaction to display the previous set of choices as icons

along with a search field in the HMI.

+LIST_ONLY

This mode causes the interaction to display the previous set of choices as a list.

SWIFT

class func icon_ONLY() -> SDLLayoutMode!

OBJECTIVE-C

+ (SDLLayoutMode *)ICON_WITH_SEARCH;

SWIFT

class func icon_WITH_SEARCH() -> SDLLayoutMode!

+LIST_WITH_SEARCH

This mode causes the interaction to display the previous set of choices as a list

along with a search field in the HMI.

OBJECTIVE-C

+ (SDLLayoutMode *)LIST_ONLY;

SWIFT

class func list_ONLY() -> SDLLayoutMode!

OBJECTIVE-C

+ (SDLLayoutMode *)LIST_WITH_SEARCH;

SWIFT

class func list_WITH_SEARCH() -> SDLLayoutMode!

+KEYBOARD

This mode causes the interaction to immediately display a keyboard entry

through the HMI.

SDLLifecycleConfiguration ClassReference

Section Contents

• -init• +defaultConfigurationWithAppName:appId:• +debugConfigurationWithAppName:appId:ipAddress:port:• tcpDebugMode• tcpDebugIPAddress

OBJECTIVE-C

+ (SDLLayoutMode *)KEYBOARD;

SWIFT

class func keyboard() -> SDLLayoutMode!

• tcpDebugPort• appName• appId• resumeHash• isMedia• appType• language• languagesSupported• appIcon• shortAppName• ttsName• voiceRecognitionCommandNames• securityManagers• logFlags

Overview

Configuration options for SDLManager

-init

Undocumented

+defaultConfigurationWithAppName:appId:

A production configuration that runs using IAP. Additional functionality should

be customized on the properties.

OBJECTIVE-C

@interface SDLLifecycleConfiguration : NSObject <NSCopying>

appName

The name of the app.

appId

The appId to be used. This should be registered with the radio’s

manufacturer.

OBJECTIVE-C

+ (nonnull SDLLifecycleConfiguration *)defaultConfigurationWithAppName:(nonnull NSString *)appName appId:(nonnull NSString *)appId;

SWIFT

class func defaultConfiguration(withAppName appName: Any!, appId: Any!) -> SDLLifecycleConfiguration!

PARAMETERS

The lifecycle configuration

+debugConfigurationWithAppName:appId:ipAddress:port:

A debug configuration that runs using TCP. Additional functionality should be

customized on the properties.

RETURN VALUE

OBJECTIVE-C

+ (nonnull SDLLifecycleConfiguration *)debugConfigurationWithAppName:(nonnull NSString *)appName appId:(nonnull NSString *)appId ipAddress:(nonnull NSString *)ipAddress port:(UInt16)port;

SWIFT

class func debugConfiguration(withAppName appName: Any!, appId: Any!, ipAddress: Any!, port: Any!) -> SDLLifecycleConfiguration!

appName

The name of the app.

appId

The appId to be used. This should be registered with the radio’s

manufacturer.

ipAddress

The ip address of the server to connect to

port

The port of the server to connect to

The lifecycle configuration

tcpDebugMode

Whether or not debug mode is enabled

PARAMETERS

RETURN VALUE

tcpDebugIPAddress

The ip address at which the library will look for a server

tcpDebugPort

The port at which the library will look for a server

OBJECTIVE-C

@property (readonly, assign, nonatomic) BOOL tcpDebugMode;

SWIFT

var tcpDebugMode: Int32 { get }

OBJECTIVE-C

@property (readonly, copy, nonatomic, null_resettable) NSString *tcpDebugIPAddress;

appName

The full name of the app

appId

The app id. This must be the same as the app id received from the SDL

developer portal or OEM.

OBJECTIVE-C

@property (readonly, assign, nonatomic) UInt16 tcpDebugPort;

SWIFT

var tcpDebugPort: Int32 { get }

OBJECTIVE-C

@property (readonly, copy, nonatomic) NSString *_Nonnull appName;

resumeHash

A hash id which should be passed to the remote system in the

RegisterAppInterface

isMedia

This is an automatically set based on the app type

OBJECTIVE-C

@property (readonly, copy, nonatomic) NSString *_Nonnull appId;

OBJECTIVE-C

@property (readwrite, copy, nonatomic, nullable) NSString *resumeHash;

OBJECTIVE-C

@property (readonly, assign, nonatomic) BOOL isMedia;

appType

The application type

language

The default language to use

SWIFT

var isMedia: Int32 { get }

OBJECTIVE-C

@property (readwrite, strong, nonatomic, null_resettable) SDLAppHMIType *appType;

SWIFT

var appType: SDLAppHMIType! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLAppHMIType.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLAppHMIType.html

languagesSupported

An array of all the supported languages

appIcon

The application icon to be used on an app launching screen

OBJECTIVE-C

@property (readwrite, strong, nonatomic) SDLLanguage *_Nonnull language;

SWIFT


OBJECTIVE-C

@property (readwrite, strong, nonatomic) NSArray<SDLLanguage *> *_Nonnull languagesSupported;




shortAppName

An abbrevited application name that will be used on the app launching screen if

the full one would be truncated

ttsName

A Text to Speech String for voice recognition of the mobile application name.

OBJECTIVE-C

@property (readwrite, strong, nonatomic, nullable) SDLFile *appIcon;

SWIFT

var appIcon: SDLFile? { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic, nullable) NSString *shortAppName;



voiceRecognitionCommandNames

Additional voice recognition commands. May not interfere with any other app

name or global commands.

securityManagers

Set security managers which could be used. This is primarily used with video

streaming applications to authenticate and perhaps encrypt traffic data.

OBJECTIVE-C

@property (readwrite, copy, nonatomic, nullable) NSArray<SDLTTSChunk *> *ttsName;

OBJECTIVE-C

@property (readwrite, copy, nonatomic, nullable) NSArray<NSString *> *voiceRecognitionCommandNames;

OBJECTIVE-C

@property (readwrite, copy, nonatomic, nullable) NSArray<Class<SDLSecurityType>> *securityManagers;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLTTSChunk.html

https://d83tozu1c8tt6.cloudfront.net/Protocols/SDLSecurityType.html

logFlags

Which logging capabilities are currently enabled. The default is Console logging

only.

SDLListFiles Class Reference

Section Contents

• -init

OBJECTIVE-C

@property (assign, readwrite, nonatomic) SDLLogOutput logFlags;

SWIFT

var logFlags: Int32 { get set }

https://d83tozu1c8tt6.cloudfront.net/Enums/SDLLogOutput.html


Overview

Requests the current list of resident filenames for the registered app. Not

supported on First generation SDL vehicles


-init

Constructs a new SDLListFiles object


Constructs a new SDLListFiles object indicated by the dictionary parameter

OBJECTIVE-C


SWIFT

init!()

dict


SDLListFilesResponse Class Reference

Section Contents

• -init• -initWithDictionary:• filenames

OBJECTIVE-C


SWIFT


PARAMETERS

• spaceAvailable

Overview

SDLListFilesResponse is sent, when SDLListFiles has been called


-init

Undocumented


Undocumented

filenames

Undocumented

OBJECTIVE-C

@interface SDLListFilesResponse : SDLRPCResponse

OBJECTIVE-C


spaceAvailable

Undocumented

SDLLocationCoordinate Class Reference

Section Contents

• latitudeDegrees• longitudeDegrees

Overview

Undocumented

OBJECTIVE-C


OBJECTIVE-C


latitudeDegrees

@abstract Latitude of the location

Required, Double -90 - 90

longitudeDegrees

@abstract Longitude of the location

Required, Double -180 - 180

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLFloat> *latitudeDegrees;

SWIFT

@NSCopying var latitudeDegrees: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLFloat> *longitudeDegrees;

https://d83tozu1c8tt6.cloudfront.net/Protocols.html#/c:objc(pl)SDLFloat


SDLLocationDetails Class Reference

Section Contents

• coordinate• locationName• addressLines• locationDescription• phoneNumber• locationImage• searchAddress

Overview

Undocumented

coordinate

@abstract Latitude/Longitude of the location

SeeSDLLocationCoordinate Optional

SWIFT

@NSCopying var longitudeDegrees: NSNumber! { get set }

locationName

@abstract Name of location.


OBJECTIVE-C

@property (readwrite, strong, nonatomic) SDLLocationCoordinate *coordinate;

SWIFT

var coordinate: SDLLocationCoordinate! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *locationName;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLLocationCoordinate.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLLocationCoordinate.html

addressLines

@abstract Location address for display purposes only.

Optional, Array of Strings, Array length 0 - 4, Max String length 500

locationDescription

@abstract Description intended location / establishment.


SWIFT

var locationName: String! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSArray<NSString *> *addressLines;

SWIFT

var addressLines: [String]! { get set }

phoneNumber

@abstract Phone number of location / establishment.


OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *locationDescription;

SWIFT

var locationDescription: String! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *phoneNumber;

locationImage

@abstract Image / icon of intended location.

SeeSDLImage Optional

searchAddress

@abstract Address to be used by navigation engines for search.

See

SWIFT

var phoneNumber: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, nonatomic) SDLImage *locationImage;

SWIFT

var locationImage: SDLImage! { get set }



SDLOASISAddress Optional

SDLLockScreenConfiguration ClassReference

Section Contents

• showInOptionalState• enableAutomaticLockScreen• backgroundColor• appIcon• customViewController• -init• +disabledConfiguration• +enabledConfiguration

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLOasisAddress *searchAddress;

SWIFT

var searchAddress: SDLOasisAddress! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLOasisAddress.html


• +enabledConfigurationWithAppIcon:backgroundColor:• +enabledConfigurationWithViewController:

Overview

Undocumented

showInOptionalState

Whether or not the lock screen should be shown in the “lock screen optional”

state. Defaults to ‘NO’.

enableAutomaticLockScreen

If YES, the lock screen should be managed by SDL and automatically engage

when necessary. If NO, then the lock screen will never be engaged.

OBJECTIVE-C

@property (assign, readwrite, nonatomic) BOOL showInOptionalState;

SWIFT

var showInOptionalState: Int32 { get set }

backgroundColor

The background color of the lock screen. This could be a branding color, or

leave at the default for a dark blue-gray.

appIcon

Your app icon as it will appear on the lock screen.

OBJECTIVE-C

@property (readonly, assign, nonatomic) BOOL enableAutomaticLockScreen;

SWIFT

var enableAutomaticLockScreen: Int32 { get }

OBJECTIVE-C

@property (readonly, copy, nonatomic) UIColor *_Nonnull backgroundColor;

customViewController

A custom view controller that the lock screen will manage the presentation of.

-init

Undocumented

+disabledConfiguration

Use this configuration if you wish to manage a lock screen yourself. This may

be useful if the automatic presentation feature of SDLLockScreenManager is

failing for some reason.

OBJECTIVE-C

@property (readonly, copy, nonatomic, nullable) UIImage *appIcon;

OBJECTIVE-C

@property (readonly, strong, nonatomic, nullable) UIViewController *customViewController;

The configuration

+enabledConfiguration

Use this configuration for the basic default lock screen. A custom app icon will

not be used.

OBJECTIVE-C

+ (nonnull instancetype)disabledConfiguration;

SWIFT

class func disabled() -> Self!

RETURN VALUE

OBJECTIVE-C

+ (nonnull instancetype)enabledConfiguration;

The configuration

+enabledConfigurationWithAppIcon:backgroundColor:

Use this configuration to provide a custom lock screen icon and a custom

background color, or nil if you wish to use the default background color. This

will use the default lock screen layout.

SWIFT

class func enabled() -> Self!

RETURN VALUE

OBJECTIVE-C

+ (nonnull instancetype)enabledConfigurationWithAppIcon:(nonnull UIImage *)lockScreenAppIcon backgroundColor:(nullable UIColor *)lockScreenBackgroundColor;

lockScreenAppIcon

The app icon to be shown on the lock screen

lockScreenBackgroundColor

The color of the lock screen background

The configuration

+enabledConfigurationWithViewController:

Use this configuration if you wish to provide your own view controller for the

lock screen. This view controller’s presentation and dismissal will still be

managed by the lock screen manager. Note that you may subclass

SWIFT

class func enabledConfiguration(withAppIcon lockScreenAppIcon: Any!, backgroundColor lockScreenBackgroundColor: Any!) -> Self!

PARAMETERS

RETURN VALUE

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)backgroundColor

SDLLockScreenViewController and pass it here to continue to have the vehicle

icon set to your view controller by the manager.

viewController

The view controller to be managed

The configuration

OBJECTIVE-C

+ (nonnull instancetype)enabledConfigurationWithViewController: (nonnull UIViewController *)viewController;

SWIFT

class func enabledConfiguration(withViewController viewController: Any!) -> Self!

PARAMETERS

RETURN VALUE

SDLLockScreenStatus Class Reference

Section Contents

• +valueOf:• +values• +OFF• +OPTIONAL• +REQUIRED

Overview

Undocumented

+valueOf:

Undocumented

+values

Undocumented

+OFF

LockScreen is Not Required

OBJECTIVE-C

+ (SDLLockScreenStatus *)OFF;

+OPTIONAL

LockScreen is Optional

+REQUIRED

LockScreen is Not Required

SWIFT

class func off() -> SDLLockScreenStatus!

OBJECTIVE-C

+ (SDLLockScreenStatus *)OPTIONAL;

SWIFT

class func optional() -> SDLLockScreenStatus!

SDLLockScreenViewController ClassReference

Section Contents

• appIcon• vehicleIcon• backgroundColor

Overview

Undocumented

OBJECTIVE-C

+ (SDLLockScreenStatus *)REQUIRED;

SWIFT

class func required() -> SDLLockScreenStatus!

appIcon

The app’s icon. This will be set by the lock screen configuration.

vehicleIcon

The vehicle’s designated icon. This will be set by the lock screen manager when

it is notified that a lock screen icon has been downloaded.

backgroundColor

The designated background color set in the lock screen configuration, or the

default SDL gray-blue.

OBJECTIVE-C

@property (readwrite, copy, nonatomic, nullable) UIImage *appIcon;

OBJECTIVE-C

@property (readwrite, copy, nonatomic, nullable) UIImage *vehicleIcon;

SDLMaintenanceModeStatus ClassReference

Section Contents

• +valueOf:• +values• +NORMAL• +NEAR• +ACTIVE• +FEATURE_NOT_PRESENT

Overview

The SDLMaintenanceModeStatus class.

+valueOf:

@abstract Maintenance Mode Status - parameter: value The value of the string

to get an object for - returns: SDLMaintenanceModeStatus

OBJECTIVE-C

@property (readwrite, copy, nonatomic, nullable) UIColor *backgroundColor;

value


SDLMaintenanceModeStatus

OBJECTIVE-C

+ (SDLMaintenanceModeStatus *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLMaintenanceModeStatus!

PARAMETERS

RETURN VALUE

+values

@abstract declare an array that store all possible Maintenance Mode Status

inside - returns: the array

the array

+NORMAL

@abstract Maintenance Mode Status : Normal - returns: the object with value of

NORMAL

OBJECTIVE-C


SWIFT


RETURN VALUE

the object with value of NORMAL

+NEAR

@abstract Maintenance Mode Status : Near - returns: the object with value of

NEAR

OBJECTIVE-C

+ (SDLMaintenanceModeStatus *)NORMAL;

SWIFT

class func normal() -> SDLMaintenanceModeStatus!

RETURN VALUE

OBJECTIVE-C

+ (SDLMaintenanceModeStatus *)NEAR;

the object with value of NEAR

+ACTIVE

@abstract Maintenance Mode Status : Active - returns: the object with value of

ACTIVE

SWIFT

class func near() -> SDLMaintenanceModeStatus!

RETURN VALUE

OBJECTIVE-C

+ (SDLMaintenanceModeStatus *)ACTIVE;

SWIFT

class func active() -> SDLMaintenanceModeStatus!

the object with value of ACTIVE

+FEATURE_NOT_PRESENT

@abstract Maintenance Mode Status : Feature not present - returns: the object

with value of FEATURE_NOT_PRESENT

the object with value of FEATURE_NOT_PRESENT

RETURN VALUE

OBJECTIVE-C

+ (SDLMaintenanceModeStatus *)FEATURE_NOT_PRESENT;

SWIFT

class func feature_NOT_PRESENT() -> SDLMaintenanceModeStatus!

RETURN VALUE

SDLManager Class Reference

Section Contents

• configuration• hmiLevel• fileManager• permissionManager• streamManager• registerResponse• delegate• proxy• -initWithConfiguration:delegate:• -startWithReadyHandler:• -stop• -sendRequest:• -sendRequest:withResponseHandler:

Overview

Undocumented

configuration

The configuration the manager was set up with.

OBJECTIVE-C

@property (readonly, copy, nonatomic) SDLConfiguration *_Nonnull configuration;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLConfiguration.html

hmiLevel

The current HMI level of the running app.

fileManager

The file manager to be used by the running app.

SWIFT

@NSCopying var configuration: SDLConfiguration { get }

OBJECTIVE-C

@property (readonly, copy, nonatomic) SDLHMILevel *_Nonnull hmiLevel;

SWIFT

@NSCopying var hmiLevel: SDLHMILevel { get }


https://d83tozu1c8tt6.cloudfront.net/Classes/SDLHMILevel.html


permissionManager

The permission manager monitoring RPC permissions.

OBJECTIVE-C

@property (readonly, strong, nonatomic) SDLFileManager *_Nonnull fileManager;

SWIFT

var fileManager: SDLFileManager { get }

OBJECTIVE-C

@property (readonly, strong, nonatomic) SDLPermissionManager *_Nonnull permissionManager;

SWIFT

var permissionManager: SDLPermissionManager { get }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLFileManager.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLFileManager.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLPermissionManager.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLPermissionManager.html

streamManager

The streaming media manager to be used for starting video sessions.

registerResponse

The response of a register call after it has been received.

OBJECTIVE-C

@property (readonly, strong, nonatomic, nullable) SDLStreamingMediaManager *streamManager;

SWIFT

var streamManager: SDLStreamingMediaManager? { get }

OBJECTIVE-C

@property (readonly, strong, nonatomic, nullable) SDLRegisterAppInterfaceResponse *registerResponse;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLStreamingMediaManager.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLStreamingMediaManager.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLRegisterAppInterfaceResponse.html

delegate

The manager’s delegate.

proxy

Undocumented

-initWithConfiguration:delegate:

Initialize the manager with a configuration. Call startWithHandler to begin

waiting for a connection.

SWIFT

var registerResponse: SDLRegisterAppInterfaceResponse? { get }

OBJECTIVE-C

@property (readwrite, nonatomic, nullable) id<SDLManagerDelegate> delegate;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLRegisterAppInterfaceResponse.html

https://d83tozu1c8tt6.cloudfront.net/Protocols/SDLManagerDelegate.html

configuration

Your app’s unique configuration for setup.

delegate

An optional delegate to be notified of hmi level changes and startup

and shutdown. It is recommended that you implement this.

An instance of SDLManager

OBJECTIVE-C

- (nonnull instancetype)initWithConfiguration:(nonnull SDLConfiguration *)configuration delegate:(nullable id<SDLManagerDelegate>)delegate;

PARAMETERS

RETURN VALUE


https://d83tozu1c8tt6.cloudfront.net/Protocols/SDLManagerDelegate.html

-startWithReadyHandler:

Start the manager, which will tell it to start looking for a connection. Once one

does, it will automatically run the setup process and call the readyBlock when

done.

readyHandler

OBJECTIVE-C

- (void)startWithReadyHandler:(nonnull SDLManagerReadyBlock)readyHandler;

SWIFT

func start(readyHandler: @escaping SDLManagerReadyBlock)

PARAMETERS

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLManager.h@T@SDLManagerReadyBlock

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLManager.h@T@SDLManagerReadyBlock

The block called when the manager is ready to be used or an error

occurs while attempting to become ready.

-stop

Stop the manager, it will disconnect if needed and no longer look for a

connection. You probably don’t need to call this method ever.

If you do call this method, you must wait for SDLManagerDelegate’s

managerDidDisconnect callback to call startWithReadyHandler:.

-sendRequest:

Send an RPC request and don’t bother with the response or error. If you need

the response or error, call sendRequest:withCompletionHandler: instead.

OBJECTIVE-C

- (void)stop;

SWIFT

func stop()

request

The RPC request to send

-sendRequest:withResponseHandler:

Send an RPC request and set a completion handler that will be called with the

response when the response returns.

OBJECTIVE-C

- (void)sendRequest:(nonnull SDLRPCRequest *)request;

SWIFT

func send(_ request: SDLRPCRequest)

PARAMETERS

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLRPCRequest.html


request

The RPC request to send

handler

The handler that will be called when the response returns

OBJECTIVE-C

- (void)sendRequest:(nonnull SDLRPCRequest *)request withResponseHandler:(nullable SDLResponseHandler)handler;

SWIFT

func send(_ request: SDLRPCRequest, withResponseHandler handler: SDLResponseHandler? = nil)

PARAMETERS


https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLResponseHandler


https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLResponseHandler

SDLMediaClockFormat Class Reference

Section Contents

• +valueOf:• +values• +CLOCK1• +CLOCK2• +CLOCK3• +CLOCKTEXT1• +CLOCKTEXT2• +CLOCKTEXT3• +CLOCKTEXT4

Overview

Indicates the format of the time displayed on the connected SDL unit.

Format description follows the following nomenclature:

Sp = Space

| = or

c = character

@since SDL 1.0

+valueOf:

@abstract Media Clock Format

value


SDLMediaClockFormat

+values

@abstract declare an array that store all possible Media clock formats inside

OBJECTIVE-C

+ (SDLMediaClockFormat *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLMediaClockFormat!

PARAMETERS

RETURN VALUE

the array

+CLOCK1

@abstract Media clock format: Clock1

@discussion

• maxHours = 19• maxMinutes = 59• maxSeconds = 59

• - returns: The SDLMediaClockFormat object with value CLOCK1

OBJECTIVE-C


SWIFT


RETURN VALUE

The SDLMediaClockFormat object with value CLOCK1

+CLOCK2


@discussion


OBJECTIVE-C

+ (SDLMediaClockFormat *)CLOCK1;

SWIFT

class func clock1() -> SDLMediaClockFormat!

RETURN VALUE


+CLOCK3


@discussion


@since SDL 2.0 - returns: The SDLMediaClockFormat object with value CLOCK3

OBJECTIVE-C


SWIFT


RETURN VALUE


+CLOCKTEXT1

@abstract Media clock format: ClockText1

@discussion

• 5 characters possible• Format: 1|sp c :|sp c c• 1|sp : digit “1” or space• c : character out of following character set: sp|0-9|[letters, see TypeII

column in XLS.• :|sp : colon or space• used for Type II headunit

OBJECTIVE-C


SWIFT


RETURN VALUE

The SDLMediaClockFormat object with value CLOCKTEXT1

+CLOCKTEXT2


@discussion

• 5 characters possible• Format: 1|sp c :|sp c c• 1|sp : digit “1” or space• c : character out of following character set: sp|0-9|[letters, see CID column

in XLS.• :|sp : colon or space• used for CID headunit

OBJECTIVE-C

+ (SDLMediaClockFormat *)CLOCKTEXT1;

SWIFT

class func clocktext1() -> SDLMediaClockFormat!

RETURN VALUE

difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported characterset


+CLOCKTEXT3


@discussion

• 6 chars possible• Format: 1|sp c c :|sp c c• 1|sp : digit “1” or space• c : character out of following character set: sp|0-9|[letters, see Type 5

column in XLS].• :|sp : colon or space

OBJECTIVE-C


SWIFT


RETURN VALUE

• used for Type V headunit

difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported characterset


+CLOCKTEXT4


@discussion

• 6 chars possible• Format: c :|sp c c : c c• :|sp : colon or space• c : character out of following character set: sp|0-9|[letters]

OBJECTIVE-C


SWIFT


RETURN VALUE

• used for MFD3/4/5 headunits

@since SDL 2.0 - returns: The SDLMediaClockFormat object with value

CLOCKTEXT4


SDLMenuParams Class Reference

Section Contents


OBJECTIVE-C


SWIFT


RETURN VALUE

• -initWithMenuName:• -initWithMenuName:parentId:position:• parentID• position• menuName

Overview

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

@since SDL 1.0

-init

Constructs a newly allocated SDLMenuParams object


Constructs a newly allocated SDLMenuParams object indicated by the


OBJECTIVE-C


SWIFT

init!()

dict


-initWithMenuName:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

OBJECTIVE-C

@interface SDLMenuParams : SDLRPCStruct

-initWithMenuName:parentId:position:

Undocumented

parentID

@abstract the unique ID of an existing submenu to which a command will be

added @discussion If this element is not provided, the command will be added

to the top level of the Command Menu.

Optional, Integer, 0 - 2,000,000,000

OBJECTIVE-C

@interface SDLMenuParams : SDLRPCStruct

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *parentID;

SWIFT

var parentID: NSNumber! { get set }

position

@abstract The position within the items of the parent Command Menu

@discussion 0 will insert at the front, 1 will insert after the first existing

element, etc.

Position of any submenu will always be located before the return and exit

options.

• If position is greater or equal than the number of items in the parent

Command Menu, the sub menu will be appended to the end of that

Command Menu.• If this element is omitted, the entry will be added at the end of the parent

menu.


menuName

@abstract the menu name which appears in menu, representing this command

OBJECTIVE-C


SWIFT


Required, max length 500 characters

SDLMyKey Class Reference

Section Contents

• -init• -initWithDictionary:• e911Override

Overview

Undocumented

OBJECTIVE-C


SWIFT


-init

Undocumented


Undocumented

e911Override

Undocumented

SDLNotificationConstants ClassReference

Section Contents

• +allResponseNames• +allButtonEventNotifications

Overview

Undocumented

+allResponseNames

Undocumented

+allButtonEventNotifications

Undocumented

SDLOasisAddress Class Reference

Section Contents

• -

initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:• -

initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:countryName:su• countryName• countryCode• postalCode• administrativeArea• subAdministrativeArea• locality• subLocality• thoroughfare• subThoroughfare

Overview

Undocumented

-

initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:

Undocumented

-

initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:

Undocumented

countryName

@abstract Name of the country (localized)

Optional, max length = 200

countryCode

@abstract countryCode of the country(ISO 3166-2)


OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *countryName;

SWIFT

var countryName: String! { get set }

postalCode

@abstract postalCode of location (PLZ, ZIP, PIN, CAP etc.)


OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *countryCode;

SWIFT

var countryCode: String! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *postalCode;

administrativeArea

@abstract Portion of country (e.g. state)


subAdministrativeArea

@abstract Portion of administrativeArea (e.g. county)


SWIFT

var postalCode: String! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *administrativeArea;

SWIFT

var administrativeArea: String! { get set }

locality

@abstract Hypernym for city/village


OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *subAdministrativeArea;

SWIFT

var subAdministrativeArea: String! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *locality;

subLocality

@abstract Hypernym for district


thoroughfare

@abstract Hypernym for street, road etc.


SWIFT

var locality: String! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *subLocality;

SWIFT

var subLocality: String! { get set }

subThoroughfare

@abstract Portion of thoroughfare (e.g. house number)


OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *thoroughfare;

SWIFT

var thoroughfare: String! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *subThoroughfare;

SDLOnAppInterfaceUnregistered ClassReference

Section Contents

• -init• -initWithDictionary:• reason

Overview

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

-init

Constructs a newly allocated SDLOnAppInterfaceUnregistered object

SWIFT

var subThoroughfare: String! { get set }


Constructs a newly allocated SDLOnAppInterfaceUnregistered object indicated

by the dictionary parameter - parameter: dict The dictionary to use

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


reason

@abstract The reason application’s interface was terminated

PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLAppInterfaceUnregisteredReason *reason;

SWIFT

var reason: SDLAppInterfaceUnregisteredReason! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLAppInterfaceUnregisteredReason.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLAppInterfaceUnregisteredReason.html

SDLOnAudioPassThru Class Reference

Section Contents


Overview

Binary data is in binary part of hybrid msg.


HMILevel:

◦ BACKGROUND, FULL, LIMITED

AudioStreamingState:

◦ TBD

SystemContext:

◦ TBD

-init

Constructs a newly allocated SDLOnAudioPassThru object

OBJECTIVE-C



Constructs a newly allocated SDLOnAudioPassThru object indicated by the


dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


SDLOnButtonEvent Class Reference

Section Contents

• -init• -initWithDictionary:• buttonName• buttonEventMode• customButtonID

Overview

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.


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.


◦ Any

SystemContext:

◦ MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any

subscribable button will cancel VR.

SeeSDLSubscribeButton

@since SDL 1.0

-init

Constructs a newly allocated SDLOnButtonEvent object

OBJECTIVE-C


SWIFT

init!()


@abstract Constructs a newly allocated SDLOnButtonEvent object indicated by

the dictionary parameter

dict


buttonName

@abstract The name of the button

OBJECTIVE-C


SWIFT


PARAMETERS

buttonEventMode

@abstract Indicates whether this is an UP or DOWN event

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLButtonName *buttonName;

SWIFT

var buttonName: SDLButtonName! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLButtonEventMode *buttonEventMode;

SWIFT

var buttonEventMode: SDLButtonEventMode! { get set }



https://d83tozu1c8tt6.cloudfront.net/Classes/SDLButtonEventMode.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLButtonEventMode.html

customButtonID

@abstract If ButtonName is “CUSTOM_BUTTON”, this references the integer ID

passed by a custom button. (e.g. softButton ID)

@since SDL 2.0


SDLOnButtonPress Class Reference

Section Contents


OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *customButtonID;

SWIFT

var customButtonID: NSNumber! { get set }

• buttonName• buttonPressMode• customButtonID

Overview

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


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.


◦ Any

SystemContext:

◦ MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any

subscribable button will cancel VR.

SeeSDLSubscribeButton SeeSDLUnsubscribeButton

@since SDL 1.0

-init

Constructs a newly allocated SDLOnButtonPress object


Constructs a newly allocated SDLOnButtonPress object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


buttonName

@abstract the button’s name

SeeSDLButtonName Required

SWIFT


PARAMETERS

OBJECTIVE-C



buttonPressMode

@abstract Indicates whether this is a LONG or SHORT button press event

SeeSDLButtonPressMode Required

customButtonID

@abstract If ButtonName is “CUSTOM_BUTTON”, this references the integer ID

passed by a custom button. (e.g. softButton ID)

SWIFT


OBJECTIVE-C

@property (readwrite, strong, atomic) SDLButtonPressMode *buttonPressMode;

SWIFT

var buttonPressMode: SDLButtonPressMode! { get set }


https://d83tozu1c8tt6.cloudfront.net/Classes/SDLButtonPressMode.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLButtonPressMode.html

@since SDL 2.0


SDLOnCommand Class Reference

Section Contents

• -init• -initWithDictionary:• cmdID

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *customButtonID;

SWIFT

var customButtonID: NSNumber! { get set }

• triggerSource

Overview

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

-init

Constructs a newly allocated SDLRPCNotification object


Constructs a newly allocated SDLRPCNotification object indicated by the


OBJECTIVE-C


SWIFT

init!()

dict


cmdID

@abstract The command ID of the command the user selected. This is the

command ID value provided by the application in the SDLAddCommand

operation that created the command.

OBJECTIVE-C


SWIFT


PARAMETERS

triggerSource

@abstract Indicates whether command was selected via voice or via a menu

selection (using the OK button).

OBJECTIVE-C


SWIFT


OBJECTIVE-C

@property (readwrite, strong, atomic) SDLTriggerSource *triggerSource;

SWIFT

var triggerSource: SDLTriggerSource! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLTriggerSource.html


SDLOnDriverDistraction ClassReference

Section Contents

• -init• -initWithDictionary:• state

Overview

Notifies the application of the current driver distraction state (whether driver

distraction rules are in effect, or not).


HMILevel:

◦ Can be sent with FULL, LIMITED or BACKGROUND


◦ Any

SystemContext:

◦ Any

@since SDL 1.0

-init

Constructs a newly allocated SDLOnDriverDistraction object


Constructs a newly allocated SDLOnDriverDistraction object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


state

@abstract The driver distraction state (i.e. whether driver distraction rules are

in effect, or not)

PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLDriverDistractionState *state;

SWIFT

var state: SDLDriverDistractionState! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDriverDistractionState.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDriverDistractionState.html

SDLOnEncodedSyncPData ClassReference

Section Contents

• -init• -initWithDictionary:• data• URL• Timeout

Overview

Undocumented

-init

Undocumented


Undocumented

data

Undocumented

URL

Undocumented

Timeout

Undocumented

SDLOnHMIStatus Class Reference

Section Contents

• -init• -initWithDictionary:• hmiLevel• audioStreamingState• systemContext

Overview

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

-init

Constructs a newly allocated SDLOnHMIStatus object


Constructs a newly allocated SDLOnHMIStatus object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


hmiLevel

@abstract SDLHMILevel in effect for the application

SWIFT


PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLHMILevel *hmiLevel;

SWIFT

var hmiLevel: SDLHMILevel! { get set }



audioStreamingState

@abstract Current state of audio streaming for the application. When this

parameter has a value of NOT_AUDIBLE, the application must stop streaming

audio to SDL.

Informs app whether any currently streaming audio is audible to user (AUDIBLE)

or not (NOT_AUDIBLE). A value of NOT_AUDIBLE means that either the

application’s audio will not be audible to the user, or that the application’s

audio should not be audible to the user (i.e. some other application on the

mobile device may be streaming audio and the application’s audio would be

blended with that other audio).

systemContext

@abstract the System Context @discussion whether a user-initiated interaction

is in-progress (VRSESSION or MENU), or not (MAIN)

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLAudioStreamingState *audioStreamingState;

SWIFT

var audioStreamingState: SDLAudioStreamingState! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLAudioStreamingState.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLAudioStreamingState.html

SDLOnHashChange Class Reference

Section Contents

• -init• -initWithDictionary:• hashID

Overview

Undocumented

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLSystemContext *systemContext;

SWIFT

var systemContext: SDLSystemContext! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLSystemContext.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLSystemContext.html

-init

Undocumented


Undocumented

hashID

Undocumented

SDLOnKeyboardInput Class Reference

Section Contents

• -init• -initWithDictionary:• event• data

Overview

Undocumented

-init

Undocumented


Undocumented

event

Undocumented

data

Undocumented

SDLOnLanguageChange ClassReference

Section Contents

• -init• -initWithDictionary:• language• hmiDisplayLanguage

Overview

Provides information to what language the SDL HMI language was changed

@since SDL 2.0

-init

Constructs a newly allocated SDLOnLanguageChange object


Constructs a newly allocated SDLOnLanguageChange object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


language

@abstract Current SDL voice engine (VR+TTS) language

hmiDisplayLanguage

@abstract Current display language

PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLLanguage *language;

SWIFT




SDLOnLockScreenStatus ClassReference

Section Contents

• -init• -initWithDictionary:• driverDistractionStatus• userSelected• lockScreenStatus

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLLanguage *hmiDisplayLanguage;

SWIFT




• hmiLevel

Overview

-init

Undocumented


Undocumented

To help prevent driver distraction, any SmartDeviceLink application is required t

This lockscreen must perform the following:Limit all application control usability from the mobile device with a full-screenFor simplicity, the OnLockScreenStatus RPC will be provided via the onOnLockScreeThe call back also includes details regarding the current HMI_Status level, drive

OBJECTIVE-C

@interface SDLOnLockScreenStatus : SDLRPCNotification

OBJECTIVE-C

@interface SDLOnLockScreenStatus : SDLRPCNotification

driverDistractionStatus

Get the current driver distraction status(i.e. whether driver distraction rules are

in effect, or not)

String

userSelected

Get user selection status for the application (has the app been selected via hmi

or voice command)

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *driverDistractionStatus;

SWIFT

var driverDistractionStatus: NSNumber! { get set }

RETURN VALUE

Boolean the current user selection status

lockScreenStatus

Get the {@linkplain LockScreenStatus} enumeration, indicating if the

lockscreen should be required, optional or off

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *userSelected;

SWIFT

var userSelected: NSNumber! { get set }

RETURN VALUE

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLLockScreenStatus *lockScreenStatus;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLLockScreenStatus.html

{@linkplain LockScreenStatus}

hmiLevel

Get HMILevel in effect for the application

SWIFT

var lockScreenStatus: SDLLockScreenStatus! { get set }

RETURN VALUE

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLHMILevel *hmiLevel;

SWIFT

var hmiLevel: SDLHMILevel! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLLockScreenStatus.html



{@linkplain HMILevel} the current HMI Level in effect for the application

SDLOnPermissionsChange ClassReference

Section Contents

• -init• -initWithDictionary:• permissionItem

Overview

Provides update to app of which sets of functions are available

@since SDL 2.0

-init

Constructs a newly allocated SDLOnPermissionsChange object

RETURN VALUE

OBJECTIVE-C



Constructs a newly allocated SDLOnPermissionsChange object indicated by the


dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


permissionItem

@abstract Describes change in permissions for a given set of RPCs

Required, Array of SDLPermissionItem, Array size 0 - 500

SeeSDLPermissionItem

SDLOnSyncPData Class Reference

Section Contents

• -init

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *permissionItem;

SWIFT

var permissionItem: NSMutableArray! { get set }

• -initWithDictionary:• URL• Timeout

Overview

Undocumented

-init

Undocumented


Undocumented

URL

Undocumented

Timeout

Undocumented

SDLOnSystemRequest Class Reference

Section Contents

• -init• -initWithDictionary:• requestType• url

• timeout• fileType• offset• length

Overview

Undocumented

-init

Undocumented


Undocumented

requestType

Undocumented

url

Undocumented

timeout

Undocumented

fileType

Undocumented

offset

Undocumented

length

Undocumented

SDLOnTBTClientState Class Reference

Section Contents

• -init• -initWithDictionary:• state

Overview

Undocumented

-init

Undocumented


Undocumented

state

Undocumented

SDLOnTouchEvent Class Reference

Section Contents

• -init• -initWithDictionary:• type• event

Overview

Undocumented

-init

Undocumented


Undocumented

type

Undocumented

event

Undocumented

SDLOnVehicleData Class Reference

Section Contents

• -init• -initWithDictionary:• gps• speed• rpm• fuelLevel• fuelLevel_State• instantFuelConsumption• externalTemperature• vin• prndl• tirePressure• odometer• beltStatus• bodyInformation• deviceStatus• driverBraking• wiperStatus• headLampStatus• engineTorque• accPedalPosition• steeringWheelAngle• eCallInfo• airbagStatus• emergencyEvent• clusterModeStatus

• myKey

Overview

Request vehicle data.


-init

@abstract Constructs a new SDLOnVehicleData object


@abstract Constructs a new SDLOnVehicleData object indicated by the


OBJECTIVE-C


SWIFT

init!()

dict


gps

@abstract A SDLGPSData* value. See GPSData.

OBJECTIVE-C


SWIFT


PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLGPSData *gps;


speed

@abstract The vehicle speed in kilometers per hour.

rpm

@abstract The number of revolutions per minute of the engine.

SWIFT

var gps: SDLGPSData! { get set }

OBJECTIVE-C


SWIFT



fuelLevel

@abstract The fuel level in the tank (percentage)

OBJECTIVE-C


SWIFT


OBJECTIVE-C


SWIFT


fuelLevel_State

@abstract A SDLComponentVolumeStatus* value. The fuel level state.


@abstract The instantaneous fuel consumption in microlitres.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLComponentVolumeStatus *fuelLevel_State;

SWIFT

var fuelLevel_State: SDLComponentVolumeStatus! { get set }

OBJECTIVE-C




externalTemperature

@abstract The external temperature in degrees celsius.

vin

@abstract The Vehicle Identification Number

SWIFT


OBJECTIVE-C


SWIFT


prndl

@abstract See PRNDL.

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *vin;

SWIFT

var vin: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLPRNDL *prndl;

SWIFT

var prndl: SDLPRNDL! { get set }



tirePressure

@abstract A SDLTireStatus* value. See TireStatus.

odometer

@abstract Odometer reading in km.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLTireStatus *tirePressure;

SWIFT

var tirePressure: SDLTireStatus! { get set }

OBJECTIVE-C




beltStatus

@abstract A SDLBeltStatus* value. The status of the seat belts.

bodyInformation

@abstract A SDLBodyInformation* value. The body information including power

modes.

SWIFT


OBJECTIVE-C

@property (readwrite, strong, atomic) SDLBeltStatus *beltStatus;

SWIFT

var beltStatus: SDLBeltStatus! { get set }



deviceStatus

@abstract A SDLDeviceStatus* value. The device status including signal and

battery strength.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLBodyInformation *bodyInformation;

SWIFT

var bodyInformation: SDLBodyInformation! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLDeviceStatus *deviceStatus;




driverBraking


wiperStatus

@abstract A SDLWiperStatus* value. The status of the wipers.

SWIFT

var deviceStatus: SDLDeviceStatus! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataEventStatus *driverBraking;

SWIFT

var driverBraking: SDLVehicleDataEventStatus! { get set }




headLampStatus

@abstract A SDLHeadLampStatus* value. Status of the head lamps.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLWiperStatus *wiperStatus;

SWIFT

var wiperStatus: SDLWiperStatus! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLHeadLampStatus *headLampStatus;

SWIFT

var headLampStatus: SDLHeadLampStatus! { get set }





engineTorque

@abstract Torque value for engine (in Nm) on non-diesel variants.

accPedalPosition

@abstract Accelerator pedal position (percentage depressed)

OBJECTIVE-C


SWIFT


OBJECTIVE-C


steeringWheelAngle

@abstract Current angle of the steering wheel (in deg)

eCallInfo

Undocumented

SWIFT


OBJECTIVE-C


SWIFT


airbagStatus

Undocumented

emergencyEvent

Undocumented

OBJECTIVE-C

@interface SDLOnVehicleData : SDLRPCNotification

OBJECTIVE-C


OBJECTIVE-C


clusterModeStatus

Undocumented

myKey

Undocumented

SDLPRNDL Class Reference

Section Contents

• +valueOf:• +values• +PARK

OBJECTIVE-C


OBJECTIVE-C


• +REVERSE• +NEUTRAL• +DRIVE• +SPORT• +LOWGEAR• +FIRST• +SECOND• +THIRD• +FOURTH• +FIFTH• +SIXTH• +SEVENTH• +EIGHTH• +UNKNOWN• +FAULT

Overview

The selected gear the car is in.

@since SDL 2.0

+valueOf:

@abstract get SDLPRNDL according value string

OBJECTIVE-C

+ (SDLPRNDL *)valueOf:(NSString *)value;

value


SDLPRNDL object

+values

@abstract declare an array to store all possible SDLPRNDL values

SWIFT

class func value(of value: String!) -> SDLPRNDL!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


the array

+PARK

@abstract Park

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLPRNDL *)PARK;

SWIFT

class func park() -> SDLPRNDL!

SDLPRNDL: PARK

+REVERSE

@abstract Reverse gear

SDLPRNDL: REVERSE

RETURN VALUE

OBJECTIVE-C

+ (SDLPRNDL *)REVERSE;

SWIFT

class func reverse() -> SDLPRNDL!

RETURN VALUE

+NEUTRAL

@abstract No gear

SDLPRNDL: NEUTRAL

+DRIVE

@abstract: Drive gear

OBJECTIVE-C

+ (SDLPRNDL *)NEUTRAL;

SWIFT

class func neutral() -> SDLPRNDL!

RETURN VALUE

SDLPRNDL: DRIVE

+SPORT

@abstract Drive Sport mode

OBJECTIVE-C

+ (SDLPRNDL *)DRIVE;

SWIFT

class func drive() -> SDLPRNDL!

RETURN VALUE

OBJECTIVE-C

+ (SDLPRNDL *)SPORT;

SDLPRNDL: SPORT

+LOWGEAR

@abstract 1st gear hold

SWIFT

class func sport() -> SDLPRNDL!

RETURN VALUE

OBJECTIVE-C

+ (SDLPRNDL *)LOWGEAR;

SWIFT

class func lowgear() -> SDLPRNDL!

SDLPRNDL: LOWGEAR

+FIRST

@abstract First gear

SDLPRNDL: FIRST

RETURN VALUE

OBJECTIVE-C

+ (SDLPRNDL *)FIRST;

SWIFT

class func first() -> SDLPRNDL!

RETURN VALUE

+SECOND

@abstract Second gear

SDLPRNDL: SECOND

+THIRD

@abstract Third gear

OBJECTIVE-C

+ (SDLPRNDL *)SECOND;

SWIFT

class func second() -> SDLPRNDL!

RETURN VALUE

SDLPRNDL: THIRD

+FOURTH

@abstract Fourth gear

OBJECTIVE-C

+ (SDLPRNDL *)THIRD;

SWIFT

class func third() -> SDLPRNDL!

RETURN VALUE

OBJECTIVE-C

+ (SDLPRNDL *)FOURTH;

SDLPRNDL: FOURTH

+FIFTH

@abstract Fifth gear

SWIFT

class func fourth() -> SDLPRNDL!

RETURN VALUE

OBJECTIVE-C

+ (SDLPRNDL *)FIFTH;

SWIFT

class func fifth() -> SDLPRNDL!

SDLPRNDL: FIFTH

+SIXTH

@abstract Sixth gear

SDLPRNDL: SIXTH

RETURN VALUE

OBJECTIVE-C

+ (SDLPRNDL *)SIXTH;

SWIFT

class func sixth() -> SDLPRNDL!

RETURN VALUE

+SEVENTH

@abstract Seventh gear

SDLPRNDL: SEVENTH

+EIGHTH

@abstract Eighth gear

OBJECTIVE-C

+ (SDLPRNDL *)SEVENTH;

SWIFT

class func seventh() -> SDLPRNDL!

RETURN VALUE

SDLPRNDL: EIGHTH

+UNKNOWN

@abstract Unknown

OBJECTIVE-C

+ (SDLPRNDL *)EIGHTH;

SWIFT

class func eighth() -> SDLPRNDL!

RETURN VALUE

OBJECTIVE-C

+ (SDLPRNDL *)UNKNOWN;

SDLPRNDL: UNKNOWN

+FAULT

@abstract Fault

SWIFT

class func unknown() -> SDLPRNDL!

RETURN VALUE

OBJECTIVE-C

+ (SDLPRNDL *)FAULT;

SWIFT

class func fault() -> SDLPRNDL!

SDLPRNDL: FAULT

SDLParameterPermissions ClassReference

Section Contents

• -init• -initWithDictionary:• allowed• userDisallowed

Overview

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

@since SDL 2.0

-init

@abstract Constructs a newly allocated SDLParameterPermissions object

RETURN VALUE


@abstract Constructs a newly allocated SDLParameterPermissions object

indicated by the dictionary parameter

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


allowed

@abstract A set of all parameters that are permitted for this given RPC.

Required, Array of String, max String length = 100, Array size 0 - 100

userDisallowed

@abstract A set of all parameters that are prohibited for this given RPC.

PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *allowed;

SWIFT

var allowed: NSMutableArray! { get set }

Required, Array of String, max String length = 100, Array size 0 - 100

SDLPerformAudioPassThru ClassReference

Section Contents

• -init• -initWithDictionary:• -initWithSamplingRate:bitsPerSample:audioType:maxDuration:• -

initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:au• initialPrompt• audioPassThruDisplayText1• audioPassThruDisplayText2

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *userDisallowed;

SWIFT

var userDisallowed: NSMutableArray! { get set }

• samplingRate• maxDuration• bitsPerSample• audioType• muteAudio

Overview

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

audio data through the vehicle microphone

Function Group: AudioPassThru



See SDLEndAudioPassThru

-init

@abstract Constructs a new SDLPerformAudioPassThru object

OBJECTIVE-C


SWIFT

init!()


@abstract Constructs a new SDLPerformAudioPassThru object indicated by the

NSMutableDictionary - parameter: dict The dictionary to use

dict


-

initWithSamplingRate:bitsPerSample:audioType:maxDuration:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

-

initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:sa

Undocumented

initialPrompt

@abstract initial prompt which will be spoken before opening the audio pass

thru session by SDL @discussion initialPrompt a Vector value represents the

initial prompt which will be spoken before opening the audio pass thru session

by SDL

Notes:

• This is an array of text chunks of type TTSChunk• The array must have at least one item• If omitted, then no initial prompt is spoken• Array Minsize: 1• Array Maxsize: 100

OBJECTIVE-C

@interface SDLPerformAudioPassThru : SDLRPCRequest

OBJECTIVE-C

@interface SDLPerformAudioPassThru : SDLRPCRequest

audioPassThruDisplayText1

@abstract a line of text displayed during audio capture @discussion

audioPassThruDisplayText1 a String value representing the line of text

displayed during audio capture

Notes: Maxlength=500

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *initialPrompt;

SWIFT

var initialPrompt: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *audioPassThruDisplayText1;

audioPassThruDisplayText2

@abstract A line of text displayed during audio capture @discussion

audioPassThruDisplayText2 a String value representing the line of text

displayed during audio capture


samplingRate

@abstract A samplingRate

SWIFT

var audioPassThruDisplayText1: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *audioPassThruDisplayText2;

SWIFT

var audioPassThruDisplayText2: String! { get set }

@discussion a SamplingRate value representing a 8 or 16 or 22 or 24 khz

maxDuration

@abstract the maximum duration of audio recording in milliseconds

@discussion maxDuration an Integer value representing the maximum duration

of audio recording in millisecond


OBJECTIVE-C

@property (readwrite, strong, atomic) SDLSamplingRate *samplingRate;

SWIFT

var samplingRate: SDLSamplingRate! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *maxDuration;



bitsPerSample

@abstract the quality the audio is recorded - 8 bit or 16 bit

@discussion a BitsPerSample value representing 8 bit or 16 bit

audioType

@abstract an audioType

SWIFT

var maxDuration: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLBitsPerSample *bitsPerSample;

SWIFT

var bitsPerSample: SDLBitsPerSample! { get set }



muteAudio

@abstract a Boolean value representing if the current audio source should be

muted during the APT session

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLAudioType *audioType;

SWIFT

var audioType: SDLAudioType! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *muteAudio;

SWIFT

var muteAudio: NSNumber! { get set }



SDLPerformAudioPassThruResponseClass Reference

Section Contents


Overview

Perform Audio Pass Thru Response is sent, when PerformAudioPassThru has

been called


-init

@abstract Constructs a new SDLPerformAudioPassThruResponse object

OBJECTIVE-C



@abstract Constructs a new SDLPerformAudioPassThruResponse object

indicated by the dictionary parameter - parameter: dict The dictionary to use

dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


SDLPerformInteraction Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithInteractionChoiceSetId:• -initWithInteractionChoiceSetIdList:• -initWithInitialPrompt:initialText:interactionChoiceSetID:• -initWithInitialPrompt:initialText:interactionChoiceSetID:vrHelp:• -

initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeo• -

initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeo• -

initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:time• -

initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:time• initialText• initialPrompt• interactionMode• interactionChoiceSetIDList• helpPrompt• timeoutPrompt• timeout• vrHelp

• interactionLayout

Overview

Performs an application-initiated interaction in which the user can select a

{@linkplain Choice} from among the specified Choice Sets. For instance, an

application may use a PerformInteraction to ask a user to say the name of a

song to play. The user’s response is only valid if it appears in the specified

Choice Sets and is recognized by SDL


HMILevel needs to be FULL


See SDLCreateInteractionChoiceSet SDLDeleteInteractionChoiceSet

-init

@abstract Constructs a new SDLPerformInteraction object

OBJECTIVE-C


SWIFT

init!()


@abstract Constructs a new SDLPerformInteraction object indicated by the

NSMutableDictionary - parameter: dict The dictionary to use

dict


-initWithInteractionChoiceSetId:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

-initWithInteractionChoiceSetIdList:

Undocumented

-

initWithInitialPrompt:initialText:interactionChoiceSetID:

Undocumented

OBJECTIVE-C

@interface SDLPerformInteraction : SDLRPCRequest

OBJECTIVE-C


OBJECTIVE-C


-

initWithInitialPrompt:initialText:interactionChoiceSetID:vrHelp:

Undocumented

-

initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeout

Undocumented

-

initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeout

Undocumented

OBJECTIVE-C


OBJECTIVE-C


-

initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeout

Undocumented

-

initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeout

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


initialText

@abstract The Text that Displayed when the interaction begins. This text may

be overlaid by the “Listening” prompt during the interaction. Text is displayed

on first line of multiline display, and is centered. If text does not fit on line, it

will be truncated

initialPrompt

@abstract An array of one or more TTSChunks that, taken together, specify

what is to be spoken to the user at the start of an interaction

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *initialText;

SWIFT

var initialText: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *initialPrompt;

interactionMode

@abstract The Indicates mode that indicate how user selects interaction

choice. User can choose either by voice (VR_ONLY), by visual selection from the

menu (MANUAL_ONLY), or by either mode (BOTH)

interactionChoiceSetIDList

@abstract A Vector value representing an Array of one or more Choice Set IDs

SWIFT

var initialPrompt: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLInteractionMode *interactionMode;

SWIFT

var interactionMode: SDLInteractionMode! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLInteractionMode.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLInteractionMode.html

helpPrompt

@abstract A Vector which taken together, specify the help phrase to be spoken

when the user says “help” during the VR session

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *interactionChoiceSetIDList;

SWIFT

var interactionChoiceSetIDList: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *helpPrompt;

timeoutPrompt

@abstract An array of TTSChunks which, taken together, specify the phrase to

be spoken when the listen times out during the VR session

timeout

@abstract An Integer value representing the amount of time, in milliseconds,

SDL will wait for the user to make a choice (VR or Menu)

SWIFT

var helpPrompt: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *timeoutPrompt;

SWIFT

var timeoutPrompt: NSMutableArray! { get set }

vrHelp

@abstract A Voice recognition Help, which is a suggested VR Help Items to

display on-screen during Perform Interaction @since SmartDeviceLink 2.0

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *timeout;

SWIFT

var timeout: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *vrHelp;

SWIFT

var vrHelp: NSMutableArray! { get set }

interactionLayout

Undocumented

SDLPerformInteractionResponse ClassReference

Section Contents

• -init• -initWithDictionary:• choiceID• manualTextEntry• triggerSource

Overview

PerformInteraction Response is sent, when SDLPerformInteraction has been

called

@since SDL 1.0

OBJECTIVE-C


-init

@abstract Constructs a new SDLPerformInteractionResponse object


@abstract Constructs a new SDLPerformInteractionResponse object indicated

by the dictionary parameter - parameter: dict The dictionary to use

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


choiceID

@abstract ID of the choice that was selected in response to PerformInteraction.

@discussion Only is valid if general result is “success:true”.

Optional, Integer, 0 - 2,000,000,000

SWIFT


PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *choiceID;

manualTextEntry

@abstract Manually entered text selection, e.g. through keyboard

@discussion Can be returned in lieu of choiceID, depending on trigger source


triggerSource

@abstract A SDLTriggerSource object which will be shown in the HMI

SWIFT

var choiceID: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *manualTextEntry;

SWIFT

var manualTextEntry: String! { get set }

@discussion Only is valid if resultCode is SUCCESS.

SDLPermissionItem Class Reference

Section Contents

• -init• -initWithDictionary:• rpcName• hmiPermissions• parameterPermissions

Overview

Undocumented

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLTriggerSource *triggerSource;

SWIFT

var triggerSource: SDLTriggerSource! { get set }



-init

Undocumented


Undocumented

rpcName

Undocumented

hmiPermissions

Undocumented

parameterPermissions

Undocumented

SDLPermissionManager Class Reference

Section Contents

• -startWithCompletionHandler:• -stop• -isRPCAllowed:• -groupStatusOfRPCs:• -statusOfRPCs:• -addObserverForRPCs:groupType:withHandler:• -removeAllObservers

• -removeObserverForIdentifier:

Overview

Undocumented

-startWithCompletionHandler:

Start the manager with a completion block that will be called when startup

completes. This is used internally. To use an SDLPermissionManager, you should

use the manager found on SDLManager .

completionHandler

OBJECTIVE-C

- (void)startWithCompletionHandler: (nonnull void (^)(BOOL, NSError *_Nullable))completionHandler;

SWIFT

func start(completionHandler: @escaping (Bool, Error?) -> Void)

PARAMETERS

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLManager.html

The block to be called when the manager’s setup is complete.

-stop

Stop the manager. This method is used internally.

-isRPCAllowed:

Determine if an individual RPC is allowed for the current HMI level

OBJECTIVE-C

- (void)stop;

SWIFT

func stop()

OBJECTIVE-C

- (BOOL)isRPCAllowed:(nonnull SDLPermissionRPCName)rpcName;

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionRPCName

rpcName

The name of the RPC to be tested, for example, SDLShow

YES if the RPC is allowed at the current HMI level, NO if not

-groupStatusOfRPCs:

Determine if all RPCs are allowed for the current HMI level

SWIFT

func isRPCAllowed(_ rpcName: String) -> Bool

PARAMETERS

RETURN VALUE

OBJECTIVE-C

- (SDLPermissionGroupStatus)groupStatusOfRPCs: (nonnull NSArray<SDLPermissionRPCName> *)rpcNames;

https://d83tozu1c8tt6.cloudfront.net/Enums/SDLPermissionGroupStatus.html


rpcNames

The RPCs to check

AllAllowed if all of the permissions are allowed, AllDisallowed if all the

permissions are disallowed, Any if some are allowed, and some are disallowed

-statusOfRPCs:

Retrieve a dictionary with keys that are the passed in RPC names, and objects

of an NSNumber specifying if that RPC is currently allowed

SWIFT

func groupStatus(ofRPCs rpcNames: [String]) -> SDLPermissionGroupStatus

PARAMETERS

RETURN VALUE

https://d83tozu1c8tt6.cloudfront.net/Enums/SDLPermissionGroupStatus.html

rpcNames

An array of RPC names to check

A dictionary specifying if the passed in RPC names are currently allowed or not

OBJECTIVE-C

- (nonnull NSDictionary<SDLPermissionRPCName, NSNumber<SDLBool> *> *)statusOfRPCs:(nonnull NSArray<SDLPermissionRPCName> *)rpcNames;

SWIFT

func status(ofRPCs rpcNames: [String]) -> [String : NSNumber]

PARAMETERS

RETURN VALUE


https://d83tozu1c8tt6.cloudfront.net/Protocols.html#/c:objc(pl)SDLBool


-addObserverForRPCs:groupType:withHandler:

Add an observer for specified RPC names, with a callback that will be called

whenever the value changes, as well as immediately with the current status.

Warning

This block will be captured by the SDLPermissionsManager, be sure to use

weakself/strongself if you are referencing self within your observer block.

Warning

The observer may be called before this method returns, do not attempt to

remove the observer from within the observer. That could send nil to

removeObserverForIdentifier:. If you want functionality like that, call

groupStatusOfRPCs: instead.

OBJECTIVE-C

- (nonnull SDLPermissionObserverIdentifier)addObserverForRPCs:(nonnull NSArray<SDLPermissionRPCName> *)rpcNames groupType:(SDLPermissionGroupType)groupType withHandler:(nonnull SDLPermissionsChangedHandler)handler;

SWIFT

func addObserver(forRPCs rpcNames: [String], groupType: SDLPermissionGroupType, withHandler handler: @escaping SDLPermissionsChangedHandler) -> UUID

http://www.logicsector.com/ios/avoiding-objc-retain-cycles-with-weakself-and-strongself-the-easy-way/

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionObserverIdentifier


https://d83tozu1c8tt6.cloudfront.net/Enums/SDLPermissionGroupType.html

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionsChangedHandler

https://d83tozu1c8tt6.cloudfront.net/Enums/SDLPermissionGroupType.html

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionsChangedHandler

rpcNames

The RPCs to be observed

groupType

Affects the times that the observer block will be called. If Any, any

change to any RPC in rpcNames will cause the observer block to be

called. If AllAllowed, the block will be called when: 1. Every RPC in

rpcNames becomes allowed 2. The group of rpcNames goes from all

being allowed to some or all being disallowed.

handler

The block that will be called whenever permissions change.

An identifier that can be passed to removeObserverForIdentifer: to remove the

observer

-removeAllObservers

Remove every current observer

PARAMETERS

RETURN VALUE

-removeObserverForIdentifier:

Remove block observers for the specified RPC

OBJECTIVE-C

- (void)removeAllObservers;

SWIFT

func removeAllObservers()

OBJECTIVE-C

- (void)removeObserverForIdentifier: (nonnull SDLPermissionObserverIdentifier)identifier;

SWIFT

func removeObserver(forIdentifier identifier: UUID)

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionObserverIdentifier

identifier

The identifier specifying which observer to remove

SDLPermissionStatus Class Reference

Section Contents

• +valueOf:• +values• +ALLOWED• +DISALLOWED• +USER_DISALLOWED• +USER_CONSENT_PENDING

Overview

Enumeration that describes possible permission states of a policy table entry.

@since SDL 2.0

+valueOf:

@abstract SDLPermissionStatus

PARAMETERS

value


a SDLPermissionStatus object

OBJECTIVE-C

+ (SDLPermissionStatus *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLPermissionStatus!

PARAMETERS

RETURN VALUE

+values

@abstract declare an array to store all possible SDLPermissionStatus values -

returns: the array

the array

+ALLOWED

@abstract permission: allowed - returns: permission status: ALLOWED

OBJECTIVE-C


SWIFT


RETURN VALUE

permission status: ALLOWED

+DISALLOWED

@abstract permission: disallowed - returns: permission status: DISALLOWED

OBJECTIVE-C

+ (SDLPermissionStatus *)ALLOWED;

SWIFT

class func allowed() -> SDLPermissionStatus!

RETURN VALUE

OBJECTIVE-C

+ (SDLPermissionStatus *)DISALLOWED;

permission status: DISALLOWED

+USER_DISALLOWED

@abstract permission: user disallowed - returns: permission status:

USER_DISALLOWED

SWIFT

class func disallowed() -> SDLPermissionStatus!

RETURN VALUE

OBJECTIVE-C

+ (SDLPermissionStatus *)USER_DISALLOWED;

SWIFT

class func user_DISALLOWED() -> SDLPermissionStatus!

permission status: USER_DISALLOWED

+USER_CONSENT_PENDING

@abstract permission: user consent pending - returns: permission status:

USER_CONSENT_PENDING

permission status: USER_CONSENT_PENDING

RETURN VALUE

OBJECTIVE-C

+ (SDLPermissionStatus *)USER_CONSENT_PENDING;

SWIFT

class func user_CONSENT_PENDING() -> SDLPermissionStatus!

RETURN VALUE

SDLPowerModeQualificationStatusClass Reference

Section Contents

• +valueOf:• +values• +POWER_MODE_UNDEFINED• +POWER_MODE_EVALUATION_IN_PROGRESS• +NOT_DEFINED• +POWER_MODE_OK

Overview

Undocumented

+valueOf:

Undocumented

+values

Undocumented

+POWER_MODE_UNDEFINED

Undocumented

+POWER_MODE_EVALUATION_IN_PROGRESS

Undocumented

+NOT_DEFINED

Undocumented

+POWER_MODE_OK

Undocumented

SDLPowerModeStatus Class Reference

Section Contents

• +valueOf:• +values• +KEY_OUT• +KEY_RECENTLY_OUT• +KEY_APPROVED_0• +POST_ACCESORY_0• +ACCESORY_1• +POST_IGNITION_1• +IGNITION_ON_2• +RUNNING_2• +CRANK_3

Overview

Undocumented

+valueOf:

Undocumented

+values

Undocumented

+KEY_OUT

Undocumented

+KEY_RECENTLY_OUT

Undocumented

+KEY_APPROVED_0

Undocumented

+POST_ACCESORY_0

Undocumented

+ACCESORY_1

Undocumented

+POST_IGNITION_1

Undocumented

+IGNITION_ON_2

Undocumented

+RUNNING_2

Undocumented

+CRANK_3

Undocumented

SDLPredefinedLayout Class Reference

Section Contents

• +valueOf:• +values• +DEFAULT• +MEDIA• +NON_MEDIA• +ONSCREEN_PRESETS• +NAV_FULLSCREEN_MAP• +NAV_LIST• +NAV_KEYBOARD• +GRAPHIC_WITH_TEXT• +TEXT_WITH_GRAPHIC• +TILES_ONLY• +TEXTBUTTONS_ONLY• +GRAPHIC_WITH_TILES• +TILES_WITH_GRAPHIC• +GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS• +TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC• +GRAPHIC_WITH_TEXTBUTTONS• +TEXTBUTTONS_WITH_GRAPHIC• +LARGE_GRAPHIC_WITH_SOFTBUTTONS• +DOUBLE_GRAPHIC_WITH_SOFTBUTTONS

• +LARGE_GRAPHIC_ONLY

Overview

Undocumented

+valueOf:

Undocumented

+values

Undocumented

+DEFAULT

Undocumented

+MEDIA

Undocumented

+NON_MEDIA

Undocumented

+ONSCREEN_PRESETS

Undocumented

+NAV_FULLSCREEN_MAP

Undocumented

+NAV_LIST

Undocumented

+NAV_KEYBOARD

Undocumented

+GRAPHIC_WITH_TEXT

Undocumented

+TEXT_WITH_GRAPHIC

Undocumented

+TILES_ONLY

Undocumented

+TEXTBUTTONS_ONLY

Undocumented

+GRAPHIC_WITH_TILES

Undocumented

+TILES_WITH_GRAPHIC

Undocumented

+GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS

Undocumented

+TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC

Undocumented

+GRAPHIC_WITH_TEXTBUTTONS

Undocumented

+TEXTBUTTONS_WITH_GRAPHIC

Undocumented

+LARGE_GRAPHIC_WITH_SOFTBUTTONS

Undocumented

+DOUBLE_GRAPHIC_WITH_SOFTBUTTONS

Undocumented

+LARGE_GRAPHIC_ONLY

Undocumented

SDLPrerecordedSpeech Class Reference

Section Contents

• +valueOf:• +values• +HELP_JINGLE• +INITIAL_JINGLE• +LISTEN_JINGLE• +POSITIVE_JINGLE• +NEGATIVE_JINGLE

Overview

Undocumented

+valueOf:

Undocumented

+values

Undocumented

+HELP_JINGLE

Undocumented

+INITIAL_JINGLE

Undocumented

+LISTEN_JINGLE

Undocumented

+POSITIVE_JINGLE

Undocumented

+NEGATIVE_JINGLE

Undocumented

SDLPresetBankCapabilities ClassReference

Section Contents

• -init• -initWithDictionary:• onScreenPresetsAvailable

Overview

Contains information about on-screen preset capabilities.

@since SDL 2.0

-init

@abstract Constructs a newly allocated SDLPresetBankCapabilities object


@abstract Constructs a newly allocated SDLPresetBankCapabilities object


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


onScreenPresetsAvailable

@abstract If Onscreen custom presets are available.

Required, Boolean

PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *onScreenPresetsAvailable;

SWIFT

var onScreenPresetsAvailable: NSNumber! { get set }

SDLPrimaryAudioSource ClassReference

Section Contents

• +valueOf:• +values• +NO_SOURCE_SELECTED• +USB• +USB2• +BLUETOOTH_STEREO_BTST• +LINE_IN• +IPOD• +MOBILE_APP

Overview

Reflects the current primary audio source of SDL (if selected).

@since SDL 2.0

+valueOf:

@abstract get SDLPrimaryAudioSource according value string

OBJECTIVE-C

+ (SDLPrimaryAudioSource *)valueOf:(NSString *)value;

value

String value to retrieve the object enum for

SDLPrimaryAudioSource object

+values

@abstract declare an array to store all possible SDLPrimaryAudioSource values

- returns: the array

SWIFT

class func value(of value: String!) -> SDLPrimaryAudioSource!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


the array

+NO_SOURCE_SELECTED

@abstract Currently no source selected - returns: the current primary audio

source: NO_SOURCE_SELECTED

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLPrimaryAudioSource *)NO_SOURCE_SELECTED;

SWIFT

class func no_SOURCE_SELECTED() -> SDLPrimaryAudioSource!

the current primary audio source: NO_SOURCE_SELECTED

+USB

@abstract USB is current source - returns: the current primary audio source:

USB

the current primary audio source: USB

RETURN VALUE

OBJECTIVE-C

+ (SDLPrimaryAudioSource *)USB;

SWIFT

class func usb() -> SDLPrimaryAudioSource!

RETURN VALUE

+USB2

@abstract USB2 is current source - returns: the current primary audio source:

USB2

the current primary audio source: USB2

+BLUETOOTH_STEREO_BTST

@abstract Bluetooth Stereo is current source - returns: the current primary

audio source: BLUETOOTH_STEREO_BTST

OBJECTIVE-C

+ (SDLPrimaryAudioSource *)USB2;

SWIFT

class func usb2() -> SDLPrimaryAudioSource!

RETURN VALUE

the current primary audio source: BLUETOOTH_STEREO_BTST

+LINE_IN

@abstract Line in is current source - returns: the current primary audio source:

LINE_IN

OBJECTIVE-C

+ (SDLPrimaryAudioSource *)BLUETOOTH_STEREO_BTST;

SWIFT

class func bluetooth_STEREO_BTST() -> SDLPrimaryAudioSource!

RETURN VALUE

OBJECTIVE-C

+ (SDLPrimaryAudioSource *)LINE_IN;

the current primary audio source: LINE_IN

+IPOD

@abstract iPod is current source - returns: the current primary audio source:

IPOD

SWIFT

class func line_IN() -> SDLPrimaryAudioSource!

RETURN VALUE

OBJECTIVE-C

+ (SDLPrimaryAudioSource *)IPOD;

SWIFT

class func ipod() -> SDLPrimaryAudioSource!

the current primary audio source: IPOD

+MOBILE_APP

@abstract Mobile app is current source - returns: the current primary audio

source: MOBILE_APP

the current primary audio source: MOBILE_APP

RETURN VALUE

OBJECTIVE-C

+ (SDLPrimaryAudioSource *)MOBILE_APP;

SWIFT

class func mobile_APP() -> SDLPrimaryAudioSource!

RETURN VALUE

SDLProtocol Class Reference

Section Contents

• -sendStartSessionWithType:• -startServiceWithType:• -startSecureServiceWithType:completionHandler:• -sendEndSessionWithType:• -endServiceWithType:• -sendRPC:• -sendRPC:encrypted:error:• -sendRPCRequest:• -sendRawData:withServiceType:• -sendEncryptedRawData:onService:• -handleBytesFromTransport:

Overview

Undocumented

-sendStartSessionWithType:

Undocumented

-startServiceWithType:

Undocumented

-startSecureServiceWithType:completionHandler:

Undocumented

-sendEndSessionWithType:

Undocumented

-endServiceWithType:

Undocumented

-sendRPC:

Undocumented

-sendRPC:encrypted:error:

Undocumented

-sendRPCRequest:

Undocumented

-sendRawData:withServiceType:

Undocumented

-sendEncryptedRawData:onService:

Undocumented

-handleBytesFromTransport:

Undocumented

SDLProtocolHeader Class Reference

Section Contents

• _version• _size• version• size• compressed• encrypted• frameType• serviceType• frameData• sessionID• bytesInPayload• -init• -data• -parse:• -description• +headerForVersion:

Overview

Undocumented

_version

Undocumented

_size

Undocumented

version

Undocumented

size

Undocumented

compressed

Undocumented

encrypted

Undocumented

frameType

Undocumented

serviceType

Undocumented

frameData

Undocumented

sessionID

Undocumented

bytesInPayload

Undocumented

-init

Undocumented

-data

Undocumented

-parse:

Undocumented

-description

Undocumented

+headerForVersion:

Undocumented

SDLProtocolMessage Class Reference

Section Contents

• header• payload• data

• +messageWithHeader:andPayload:• -size• -description• -rpcDictionary• +determineVersion:

Overview

Undocumented

header

Undocumented

payload

Undocumented

data

Undocumented

+messageWithHeader:andPayload:

Undocumented

-size

Undocumented

-description

Undocumented

-rpcDictionary

Undocumented

+determineVersion:

Undocumented

SDLProxy Class Reference

Section Contents

• _version• _bulkSessionID• _isConnected• _alreadyDestructed• protocol• transport• proxyListeners• startSessionTimer• debugConsoleGroupName• proxyVersion• streamingMediaManager• -initWithTransport:protocol:delegate:• -dispose• -addDelegate:• -removeDelegate:• -sendRPC:• -sendRPCRequest:• -handleRPCDictionary:• -handleRpcMessage:• -handleProtocolMessage:• -addSecurityManagers:forAppId:

• +enableSiphonDebug• +disableSiphonDebug• -putFileStream:withRequest:

Overview

Undocumented

_version

Undocumented

_bulkSessionID

Undocumented

_isConnected

Undocumented

_alreadyDestructed

Undocumented

protocol

Undocumented

transport

Undocumented

proxyListeners

Undocumented

startSessionTimer

Undocumented


Undocumented

proxyVersion

Undocumented

streamingMediaManager

Undocumented

-initWithTransport:protocol:delegate:

Undocumented

-dispose

Undocumented

-addDelegate:

Undocumented

-removeDelegate:

Undocumented

-sendRPC:

Undocumented

-sendRPCRequest:

Undocumented

-handleRPCDictionary:

Undocumented

-handleRpcMessage:

Undocumented

-handleProtocolMessage:

Undocumented

-addSecurityManagers:forAppId:

Undocumented

+enableSiphonDebug

Undocumented

+disableSiphonDebug

Undocumented

-putFileStream:withRequest:

Puts data into a file on the module @abstract Performs a putFile for a given

input stream, performed in chunks, for handling very large files. - parameter:

inputStream A stream containing the data to put to the module. - parameter:

putFileRPCRequest A SDLPutFile object containing the parameters for the put(s)

@discussion The proxy will read from the stream based on the max MTU size

and send them in individual putFile requests. This may result in multiple

responses being received, one for each request. Note: the length parameter of

the putFileRPCRequest will be ignored. The proxy will substitute the number of

bytes read from the stream.

OBJECTIVE-C

- (void)putFileStream:(NSInputStream *)inputStream withRequest:(SDLPutFile *)putFileRPCRequest;

SWIFT

func putFileStream(_ inputStream: InputStream!, withRequest putFileRPCRequest: SDLPutFile!)

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLPutFile.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLPutFile.html

inputStream

A stream containing the data to put to the module.

putFileRPCRequest

A SDLPutFile object containing the parameters for the put(s)

SDLProxyFactory Class Reference

Section Contents

• +buildSDLProxyWithListener:• +buildSDLProxyWithListener:tcpIPAddress:tcpPort:

Overview

Undocumented

+buildSDLProxyWithListener:

Undocumented

+buildSDLProxyWithListener:tcpIPAddress:tcpPort:

Undocumented

PARAMETERS

SDLPutFile Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithFileName:fileType:• -initWithFileName:fileType:persistentFile:• -initWithFileName:fileType:persistentFile:systemFile:offset:length:• syncFileName• fileType• persistentFile• systemFile• offset• length

Overview

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 - see: SDLListFiles

-init

Constructs a new SDLPutFile object

OBJECTIVE-C



Constructs a new SDLPutFile object indicated by the dictionary parameter

dict


SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS

-initWithFileName:fileType:

Undocumented

-initWithFileName:fileType:persistentFile:

Undocumented

-

initWithFileName:fileType:persistentFile:systemFile:offset:length:

Undocumented

OBJECTIVE-C

@interface SDLPutFile : SDLRPCRequest

OBJECTIVE-C


syncFileName

A file reference name

Required, maxlength 255 characters

fileType

A FileType value representing a selected file type

Required

OBJECTIVE-C


OBJECTIVE-C


SWIFT


persistentFile

A value to indicates if the file is meant to persist between sessions / ignition

cycles. If set to TRUE, then the system will aim to persist this file through

session / cycles. While files with this designation will have priority over others,

they are subject to deletion by the system at any time. In the event of

automatic deletion by the system, the app will receive a rejection and have to

resend the file. If omitted, the value will be set to false

Boolean, Optional, default = NO

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLFileType *fileType;

SWIFT

var fileType: SDLFileType! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *persistentFile;



systemFile

Indicates if the file is meant to be passed through core to elsewhere on the

system. If set to TRUE, then the system will instead pass the data thru as it

arrives to a predetermined area outside of core.

Boolean, Optional, default = NO

offset

Offset in bytes for resuming partial data chunks.

SWIFT

var persistentFile: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *systemFile;

SWIFT

var systemFile: NSNumber! { get set }

Integer, Optional, 0 - 100,000,000,000

length

Length in bytes for resuming partial data chunks. If offset is set to 0, then

length is the total length of the file to be downloaded

Integer, Optional, 0 - 100,000,000,000

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *offset;

SWIFT

var offset: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *length;

SDLPutFileResponse Class Reference

Section Contents

• -init• -initWithDictionary:• spaceAvailable

Overview

Put File Response is sent, when SDLPutFile has been called


-init

@abstract Constructs a new SDLPutFileResponse object

SWIFT

var length: NSNumber! { get set }

OBJECTIVE-C



@abstract Constructs a new SDLPutFileResponse object indicated by the


dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


spaceAvailable

Undocumented

SDLRPCMessage Class Reference

Section Contents

• function• parameters• messageType• -initWithName:• -initWithDictionary:• -getFunctionName• -setFunctionName:• -getParameters:• -setParameters:value:• bulkData• name• messageType

OBJECTIVE-C

@interface SDLPutFileResponse : SDLRPCResponse

Overview

Undocumented

function

Undocumented

parameters

Undocumented

messageType

Undocumented

-initWithName:

Undocumented


Undocumented

-getFunctionName

Undocumented

-setFunctionName:

Undocumented

-getParameters:

Undocumented

-setParameters:value:

Undocumented

bulkData

Undocumented

name

Undocumented

messageType

Undocumented

SDLRPCNotification Class Reference

Section Contents

• -initWithName:• -initWithDictionary:

Overview

Undocumented

-initWithName:

Undocumented


Undocumented

SDLRPCNotificationNotification ClassReference

Section Contents

• notification• -initWithName:object:rpcNotification:

Overview

Undocumented

notification

Undocumented

-initWithName:object:rpcNotification:

Undocumented

SDLRPCRequest Class Reference

Section Contents

• correlationID

Overview

Undocumented

correlationID

Undocumented

SDLRPCRequestFactory Class Reference

Section Contents

• +buildAddCommandWithID:menuName:parentID:position:vrCommands:iconValue:iconType:correlationID:• +buildAddCommandWithID:menuName:vrCommands:correlationID:• +buildAddCommandWithID:vrCommands:correlationID:• +buildAddCommandWithID:menuName:parentID:position:vrCommands:iconValue:iconType:handler:• +buildAddCommandWithID:menuName:vrCommands:handler:• +buildAddCommandWithID:vrCommands:handler:• +buildAddSubMenuWithID:menuName:position:correlationID:• +buildAddSubMenuWithID:menuName:correlationID:• +buildAlertWithTTS:alertText1:alertText2:alertText3:playTone:duration:correlationID:• +buildAlertWithTTS:alertText1:alertText2:playTone:duration:correlationID:• +buildAlertWithTTS:playTone:correlationID:• +buildAlertWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButtons:correlationID:

• +buildAlertWithTTSChunks:playTone:correlationID:• +buildAlertWithAlertText1:alertText2:alertText3:duration:softButtons:correlationID:• +buildAlertWithAlertText1:alertText2:alertText3:duration:correlationID:• +buildAlertWithAlertText1:alertText2:duration:correlationID:• +buildAlertManeuverwithTTSchunks:softButtons:correlationID:• +buildChangeRegistrationWithLanguage:hmiDisplayLanguage:correlationID:• +buildCreateInteractionChoiceSetWithID:choiceSet:correlationID:• +buildDeleteCommandWithID:correlationID:• +buildDeleteFileWithName:correlationID:• +buildDialNumberWithNumber:• +buildListFilesWithCorrelationID:• +buildDeleteInteractionChoiceSetWithID:correlationID:• +buildDeleteSubMenuWithID:correlationID:• +buildEndAudioPassThruWithCorrelationID:• +buildGetDTCsWithECUName:correlationID:• +buildGetVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemper• +buildPerformAudioPassThruWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samp• +buildPerformInteractionWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks• +buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:• +buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetID:vrHelp:correlationID:• +buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:• +buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetID:correlationID:• +buildPutFileWithFileName:fileType:persistentFile:correlationId:• +buildPutFileWithFileName:fileType:persisistentFile:correlationID:• +buildReadDIDWithECUName:didLocation:correlationID:• +buildRegisterAppInterfaceWithAppName:ttsName:vrSynonyms:isMediaApp:languageDesired:hmiDisplayLa• +buildRegisterAppInterfaceWithAppName:isMediaApp:languageDesired:appID:• +buildRegisterAppInterfaceWithAppName:languageDesired:appID:• +buildResetGlobalPropertiesWithProperties:correlationID:• +buildSendLocationWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image• +buildScrollableMessage:timeout:softButtons:correlationID:• +buildSetAppIconWithFileName:correlationID:• +buildSetDisplayLayout:correlationID:• +buildSetGlobalPropertiesWithHelpText:timeoutText:vrHelpTitle:vrHelp:correlationID:• +buildSetGlobalPropertiesWithHelpText:timeoutText:correlationID:• +buildSetMediaClockTimerWithHours:minutes:seconds:updateMode:correlationID:• +buildSetMediaClockTimerWithUpdateMode:correlationID:• +buildShowWithMainField1:mainField2:mainField3:mainField4:statusBar:mediaClock:mediaTrack:alignment:

• +buildShowWithMainField1:mainField2:statusBar:mediaClock:mediaTrack:alignment:correlationID:• +buildShowWithMainField1:mainField2:alignment:correlationID:• +buildSliderDynamicFooterWithNumTicks:position:sliderHeader:sliderFooter:timeout:correlationID:• +buildSliderStaticFooterWithNumTicks:position:sliderHeader:sliderFooter:timeout:correlationID:• +buildSoftButtonWithType:text:image:highlighted:buttonID:systemAction:handler:• +buildSpeakWithTTSChunks:correlationID:• +buildSpeakWithTTS:correlationID:• +buildSubscribeButtonWithName:correlationID:• +buildSubscribeButtonWithName:handler:• +buildSubscribeVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalT• +buildShowConstantTBTWithString:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIc• +buildUnregisterAppInterfaceWithCorrelationID:• +buildUnsubscribeButtonWithName:correlationID:• +buildUnsubscribeVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externa• +buildUpdateTurnListWithTurnList:softButtons:correlationID:

Overview

Undocumented

+buildAddCommandWithID:menuName:parentID:position:vrCommands:iconValu

Undocumented

+buildAddCommandWithID:menuName:vrCommands:correlationID:

Undocumented

+buildAddCommandWithID:vrCommands:correlationID:

Undocumented

+buildAddCommandWithID:menuName:parentID:position:vrCommands:iconValu

Undocumented

+buildAddCommandWithID:menuName:vrCommands:handler:

Undocumented

+buildAddCommandWithID:vrCommands:handler:

Undocumented

+buildAddSubMenuWithID:menuName:position:correlationID:

Undocumented

+buildAddSubMenuWithID:menuName:correlationID:

Undocumented

+buildAlertWithTTS:alertText1:alertText2:alertText3:playTone:duration:correlat

Undocumented

+buildAlertWithTTS:alertText1:alertText2:playTone:duration:correlationID:

Undocumented

+buildAlertWithTTS:playTone:correlationID:

Undocumented

+buildAlertWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:s

Undocumented

+buildAlertWithTTSChunks:playTone:correlationID:

Undocumented

+buildAlertWithAlertText1:alertText2:alertText3:duration:softButtons:correlatio

Undocumented

+buildAlertWithAlertText1:alertText2:alertText3:duration:correlationID:

Undocumented

+buildAlertWithAlertText1:alertText2:duration:correlationID:

Undocumented

+buildAlertManeuverwithTTSchunks:softButtons:correlationID:

Undocumented

+buildChangeRegistrationWithLanguage:hmiDisplayLanguage:correlationID:

Undocumented

+buildCreateInteractionChoiceSetWithID:choiceSet:correlationID:

Undocumented

+buildDeleteCommandWithID:correlationID:

Undocumented

+buildDeleteFileWithName:correlationID:

Undocumented

+buildDialNumberWithNumber:

Undocumented

+buildListFilesWithCorrelationID:

Undocumented

+buildDeleteInteractionChoiceSetWithID:correlationID:

Undocumented

+buildDeleteSubMenuWithID:correlationID:

Undocumented

+buildEndAudioPassThruWithCorrelationID:

Undocumented

+buildGetDTCsWithECUName:correlationID:

Undocumented

+buildGetVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelC

Undocumented

+buildPerformAudioPassThruWithInitialPrompt:audioPassThruDisplayText1:aud

Undocumented

+buildPerformInteractionWithInitialChunks:initialText:interactionChoiceSetIDLis

Undocumented

+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetIDLis

Undocumented

+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetID:v

Undocumented

+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetIDLis

Undocumented

+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetID:co

Undocumented

+buildPutFileWithFileName:fileType:persistentFile:correlationId:

Undocumented

+buildPutFileWithFileName:fileType:persisistentFile:correlationID:

Undocumented

+buildReadDIDWithECUName:didLocation:correlationID:

Undocumented

+buildRegisterAppInterfaceWithAppName:ttsName:vrSynonyms:isMediaApp:lan

Undocumented

+buildRegisterAppInterfaceWithAppName:isMediaApp:languageDesired:appID:

Undocumented

+buildRegisterAppInterfaceWithAppName:languageDesired:appID:

Undocumented

+buildResetGlobalPropertiesWithProperties:correlationID:

Undocumented

+buildSendLocationWithLongitude:latitude:locationName:locationDescription:a

Undocumented

+buildScrollableMessage:timeout:softButtons:correlationID:

Undocumented

+buildSetAppIconWithFileName:correlationID:

Undocumented

+buildSetDisplayLayout:correlationID:

Undocumented

+buildSetGlobalPropertiesWithHelpText:timeoutText:vrHelpTitle:vrHelp:correlat

Undocumented

+buildSetGlobalPropertiesWithHelpText:timeoutText:correlationID:

Undocumented

+buildSetMediaClockTimerWithHours:minutes:seconds:updateMode:correlation

Undocumented

+buildSetMediaClockTimerWithUpdateMode:correlationID:

Undocumented

+buildShowWithMainField1:mainField2:mainField3:mainField4:statusBar:media

Undocumented

+buildShowWithMainField1:mainField2:statusBar:mediaClock:mediaTrack:align

Undocumented

+buildShowWithMainField1:mainField2:alignment:correlationID:

Undocumented

+buildSliderDynamicFooterWithNumTicks:position:sliderHeader:sliderFooter:tim

Undocumented

+buildSliderStaticFooterWithNumTicks:position:sliderHeader:sliderFooter:timeo

Undocumented

+buildSoftButtonWithType:text:image:highlighted:buttonID:systemAction:hand

Undocumented

+buildSpeakWithTTSChunks:correlationID:

Undocumented

+buildSpeakWithTTS:correlationID:

Undocumented

+buildSubscribeButtonWithName:correlationID:

Undocumented

+buildSubscribeButtonWithName:handler:

Undocumented

+buildSubscribeVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instan

Undocumented

+buildShowConstantTBTWithString:navigationText2:eta:timeToDestination:tota

Undocumented

+buildUnregisterAppInterfaceWithCorrelationID:

Undocumented

+buildUnsubscribeButtonWithName:correlationID:

Undocumented

+buildUnsubscribeVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:inst

Undocumented

+buildUpdateTurnListWithTurnList:softButtons:correlationID:

Undocumented

SDLRPCResponse Class Reference

Section Contents

• correlationID• success• resultCode

• info

Overview

Undocumented

correlationID

Undocumented

success

Undocumented

resultCode

Undocumented

info

Undocumented

SDLRPCResponseNotification ClassReference

Section Contents

• response

• -initWithName:object:rpcResponse:

Overview

Undocumented

response

Undocumented

-initWithName:object:rpcResponse:

Undocumented

SDLRPCStruct Class Reference

Section Contents

• store• -initWithDictionary:• -init• -serializeAsDictionary:

Overview

Undocumented

store

Undocumented


Undocumented

-init

Undocumented

-serializeAsDictionary:

Undocumented

SDLReadDID Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithECUName:didLocation:• ecuName• didLocation

Overview

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



-init

@abstract Constructs a new SDLReadDID object


@abstract Constructs a new SDLReadDID object indicated by the dictionary


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


-initWithECUName:didLocation:

Undocumented

ecuName

@abstract An ID of the vehicle module


SWIFT


PARAMETERS

OBJECTIVE-C

@interface SDLReadDID : SDLRPCRequest

didLocation

@abstract Raw data from vehicle data DID location(s)

a Vector value representing raw data from vehicle data DID location(s)

Notes:

• Minvalue:0; Maxvalue:65535• ArrayMin:0; ArrayMax:1000

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *ecuName;

SWIFT

var ecuName: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *didLocation;

SDLReadDIDResponse Class Reference

Section Contents

• -init• -initWithDictionary:• didResult

Overview

Read DID Response is sent, when ReadDID has been called


-init

Undocumented

SWIFT

var didLocation: NSMutableArray! { get set }

OBJECTIVE-C

@interface SDLReadDIDResponse : SDLRPCResponse


Undocumented

didResult

Undocumented

SDLRegisterAppInterface ClassReference

Section Contents

• -init

OBJECTIVE-C


OBJECTIVE-C


• -initWithDictionary:• -initWithLifecycleConfiguration:• -initWithAppName:appId:languageDesired:• -

initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:• -

initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:ttsName:vrSynonyms:hmiDis• syncMsgVersion• appName• ttsName• ngnMediaScreenAppName• vrSynonyms• isMediaApplication• languageDesired• hmiDisplayLanguageDesired• appHMIType• hashID• deviceInfo• appID• appInfo

Overview

Registers the application’s interface with SDL®, declaring properties of the

registration, 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 HMI

Status is assumed to be: SDLHMILevel=NONE, SDLAudioStreamingState

=NOT_AUDIBLE, SDLSystemContext=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:

• Choice Sets• Command Menus (built by successive calls to SDLAddCommand )• Media clock timer display value• Media clock timer display value• Media clock timer display value

The autoActivateID is used to grant an application the HMILevel and

AudioStreamingState it had when it last disconnected

Notes: The autoActivateID parameter, and associated behavior, is currently

ignored by SDL®

When first calling this method (i.e. first time within life cycle of mobile app), an

autoActivateID should not be included. After successfully registering an

interface, an autoActivateID is returned to the mobile application for it to use in

subsequent connections. If the connection between SDL® and the mobile

application is lost, such as the vehicle is turned off while the application is

running, the autoActivateID can then be passed in another call to

RegisterAppInterface to re-acquire SDLHMILevel=FULL

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®

There is no time limit for how long the autoActivateID is “valid” (i.e. would

confer focus and opt-in)

HMILevel is not defined before registering

@since SDL 1.0

SeeSDLUnregisterAppInterface SDLOnAppInterfaceUnregistered

-init

@abstract Constructs a new SDLRegisterAppInterface object


@abstract Constructs a new SDLRegisterAppInterface object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


-initWithLifecycleConfiguration:

Undocumented

-initWithAppName:appId:languageDesired:

Undocumented

SWIFT


PARAMETERS

OBJECTIVE-C

@interface SDLRegisterAppInterface : SDLRPCRequest

-

initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:

Undocumented

-

initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:t

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


syncMsgVersion

@abstract The version of the SDL interface

Required

appName

@abstract The Mobile Application’s Name, This name is displayed in the SDL

Mobile Applications menu. It also serves as the unique identifier of the

application for SmartDeviceLink

@discussion • Needs to be unique over all applications.• May not be empty.• May not start with a new line character.• May not interfere with any name or synonym of previously registered

applications and any predefined blacklist of words (global commands).• Needs to be unique over all applications. Applications with the same name will

be rejected.

Required, Max length 100 chars

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLSyncMsgVersion *syncMsgVersion;

SWIFT

var syncMsgVersion: SDLSyncMsgVersion! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLSyncMsgVersion.html


ttsName

@abstract TTS string for VR recognition of the mobile application name.

@discussion Meant to overcome any failing on speech engine in properly

pronouncing / understanding app name. • Needs to be unique over all applications.• May not be empty.• May not start with a new line character.

Optional, Array of SDLTTSChunk, Array size 1 - 100

@since SDL 2.0 - see: SDLTTSChunk

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *appName;

SWIFT

var appName: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *ttsName;

ngnMediaScreenAppName

@abstract A String representing an abbreviated version of the mobile

application’s name (if necessary) that will be displayed on the media screen

@discussion If not provided, the appName is used instead (and will be

truncated if too long)


SWIFT

var ttsName: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *ngnMediaScreenAppName;

SWIFT

var ngnMediaScreenAppName: String! { get set }

vrSynonyms

@abstract Defines a additional voice recognition commands

@discussion May not interfere with any app name of previously registered

applications and any predefined blacklist of words (global commands)

Optional, Array of Strings, Array length 1 - 100, Max String length 40

isMediaApplication

@abstract Indicates if the application is a media or a non-media application.

@discussion Only media applications will be able to stream audio to head units

that is audible outside of the BT media source.

Required, Boolean

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *vrSynonyms;

SWIFT

var vrSynonyms: NSMutableArray! { get set }

languageDesired

@abstract A Language enumeration indicating what language the application

intends to use for user interaction (TTS and VR).

@discussion If there is a mismatch with the head unit, the app will be able to

change this registration with changeRegistration prior to app being brought into

focus.

Required

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *isMediaApplication;

SWIFT

var isMediaApplication: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLLanguage *languageDesired;


hmiDisplayLanguageDesired

@abstract An enumeration indicating what language the application intends to

use for user interaction (Display).

@discussion If there is a mismatch with the head unit, the app will be able to

change this registration with changeRegistration prior to app being brought into

focus.

Required

@since SDL 2.0

SWIFT

var languageDesired: SDLLanguage! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLLanguage *hmiDisplayLanguageDesired;

SWIFT

var hmiDisplayLanguageDesired: SDLLanguage! { get set }




appHMIType

@abstract A list of all applicable app types stating which classifications to be

given to the app.

Optional, Array of SDLAppHMIType, Array size 1 - 100

@since SDL 2.0 - see: SDLAppHMIType

hashID

@abstract ID used to uniquely identify current state of all app data that can

persist through connection cycles (e.g. ignition cycles).

@discussion This registered data (commands, submenus, choice sets, etc.) can

be reestablished without needing to explicitly reregister each piece. If omitted,

then the previous state of an app’s commands, etc. will not be restored.

When sending hashID, all RegisterAppInterface parameters should still be

provided (e.g. ttsName, etc.).

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *appHMIType;

SWIFT

var appHMIType: NSMutableArray! { get set }

Optional, max length 100 chars

deviceInfo

@abstract Information about the connecting device

Optional

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *hashID;

SWIFT

var hashID: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLDeviceInfo *deviceInfo;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDeviceInfo.html

appID

@abstract ID used to validate app with policy table entries

Required, max length 100

@since SDL 2.0

appInfo

@abstract Information about the application running

SWIFT

var deviceInfo: SDLDeviceInfo! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *appID;

SWIFT

var appID: String! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDeviceInfo.html

Optional

SDLRegisterAppInterfaceResponseClass Reference

Section Contents

• -init• -initWithDictionary:• syncMsgVersion• language• hmiDisplayLanguage• displayCapabilities• buttonCapabilities• softButtonCapabilities• presetBankCapabilities

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLAppInfo *appInfo;

SWIFT

var appInfo: SDLAppInfo! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLAppInfo.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLAppInfo.html

• hmiZoneCapabilities• speechCapabilities• prerecordedSpeech• vrCapabilities• audioPassThruCapabilities• vehicleType• supportedDiagModes• hmiCapabilities• sdlVersion• systemSoftwareVersion

Overview

@abstract Register AppInterface Response is sent, when

SDLRegisterAppInterface has been called


-init

@abstract Constructs a new SDLRegisterAppInterfaceResponse object

OBJECTIVE-C


SWIFT

init!()


Constructs a new SDLRegisterAppInterfaceResponse object indicated by the


dict


syncMsgVersion

SeeSDLSyncMsgVersion Optional

OBJECTIVE-C


SWIFT


PARAMETERS

language

The currently active VR+TTS language on Sync.

SeeSDLLanguage Optional

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLSyncMsgVersion *syncMsgVersion;

SWIFT

var syncMsgVersion: SDLSyncMsgVersion! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLLanguage *language;




hmiDisplayLanguage

The currently active display language on Sync

SeeSDLLanguage @since SmartDeviceLink 2.0 Optional

displayCapabilities

SeeSDLDisplayCapabilities

SWIFT


OBJECTIVE-C

@property (readwrite, strong, atomic) SDLLanguage *hmiDisplayLanguage;

SWIFT





Optional

buttonCapabilities

SeeSDLButtonCapabilities Optional, Array of length 1 - 100, of SDLButtonCapabilities

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLDisplayCapabilities *displayCapabilities;

SWIFT

var displayCapabilities: SDLDisplayCapabilities! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *buttonCapabilities;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDisplayCapabilities.html


softButtonCapabilities

If returned, the platform supports on-screen SoftButtons

SeeSDLSoftButtonCapabilities Optional, Array of length 1 - 100, of SDLSoftButtonCapabilities

presetBankCapabilities

If returned, the platform supports custom on-screen Presets

See

SWIFT

var buttonCapabilities: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *softButtonCapabilities;

SWIFT

var softButtonCapabilities: NSMutableArray! { get set }

SDLPresetBankCapabilities Optional

hmiZoneCapabilities

SeeSDLHMIZoneCapabilities Optional, Array of length 1 - 100, of SDLHMIZoneCapabilities

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLPresetBankCapabilities *presetBankCapabilities;

SWIFT

var presetBankCapabilities: SDLPresetBankCapabilities! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *hmiZoneCapabilities;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLPresetBankCapabilities.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLPresetBankCapabilities.html

speechCapabilities

SeeSDLSpeechCapabilities Optional, Array of length 1 - 100, of SDLSpeechCapabilities

prerecordedSpeech

SeeSDLPrerecordedSpeech Optional, Array of length 1 - 100, of SDLPrerecordedSpeech

SWIFT

var hmiZoneCapabilities: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *speechCapabilities;

SWIFT

var speechCapabilities: NSMutableArray! { get set }

vrCapabilities

SeeSDLVRCapabilities Optional, Array of length 1 - 100, of SDLVRCapabilities

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *prerecordedSpeech;

SWIFT

var prerecordedSpeech: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *vrCapabilities;

audioPassThruCapabilities

SeeSDLAudioPassThruCapabilities Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities

vehicleType

Specifies the vehicle’s type

SeeSDLVehicleType

SWIFT

var vrCapabilities: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *audioPassThruCapabilities;

SWIFT

var audioPassThruCapabilities: NSMutableArray! { get set }

Optional, Array of length 1 - 100, of SDLVehicleType

supportedDiagModes

Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for

DiagnosticMessage requests. If a mode outside this list is requested, it will be

rejected.

Optional, Array of length 1 - 100, Integer 0 - 255

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleType *vehicleType;

SWIFT

var vehicleType: SDLVehicleType! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *supportedDiagModes;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLVehicleType.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLVehicleType.html

hmiCapabilities

SeeSDLHMICapabilities Optional

sdlVersion

The SmartDeviceLink version

Optional, String max length 100

SWIFT

var supportedDiagModes: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLHMICapabilities *hmiCapabilities;

SWIFT

var hmiCapabilities: SDLHMICapabilities! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLHMICapabilities.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLHMICapabilities.html

systemSoftwareVersion

The software version of the system that implements the SmartDeviceLink core

Optional, String max length 100

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *sdlVersion;

SWIFT

var sdlVersion: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *systemSoftwareVersion;

SDLRequestType Class Reference

Section Contents

• +valueOf:• +values• +HTTP• +FILE_RESUME• +AUTH_REQUEST• +AUTH_CHALLENGE• +AUTH_ACK• +PROPRIETARY• +QUERY_APPS• +LAUNCH_APP• +LOCK_SCREEN_ICON_URL• +TRAFFIC_MESSAGE_CHANNEL• +DRIVER_PROFILE• +VOICE_SEARCH• +NAVIGATION• +PHONE• +CLIMATE• +SETTINGS• +VEHICLE_DIAGNOSTICS• +EMERGENCY• +MEDIA

SWIFT

var systemSoftwareVersion: String! { get set }

• +FOTA

Overview

Undocumented

+valueOf:

Undocumented

+values

Undocumented

+HTTP

Undocumented

+FILE_RESUME

Undocumented

+AUTH_REQUEST

Undocumented

+AUTH_CHALLENGE

Undocumented

+AUTH_ACK

Undocumented

+PROPRIETARY

Undocumented

+QUERY_APPS

Undocumented

+LAUNCH_APP

Undocumented

+LOCK_SCREEN_ICON_URL

Undocumented

+TRAFFIC_MESSAGE_CHANNEL

Undocumented

+DRIVER_PROFILE

Undocumented

+VOICE_SEARCH

Undocumented

+NAVIGATION

Undocumented

+PHONE

Undocumented

+CLIMATE

Undocumented

+SETTINGS

Undocumented

+VEHICLE_DIAGNOSTICS

Undocumented

+EMERGENCY

Undocumented

+MEDIA

Undocumented

+FOTA

Undocumented

SDLResetGlobalProperties ClassReference

Section Contents

• -init• -initWithDictionary:• -initWithProperties:• properties

Overview

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


Since SmartDeviceLink 1.0 See SetGlobalProperties

-init

@abstract Constructs a new SDLResetGlobalProperties object

OBJECTIVE-C



@abstract Constructs a new SDLResetGlobalProperties object indicated by the


dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


-initWithProperties:

Undocumented

properties

@abstract An array of one or more GlobalProperty enumeration elements

indicating which global properties to reset to their default value

OBJECTIVE-C

@interface SDLResetGlobalProperties : SDLRPCRequest

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *properties;

SWIFT

var properties: NSMutableArray! { get set }

SDLResetGlobalPropertiesResponseClass Reference

Section Contents


Overview

Reset Global Properties Response is sent, when SDLResetGlobalProperties has

been called


-init

@abstract Constructs a new SDLResetGlobalPropertiesResponse object

OBJECTIVE-C



@abstract Constructs a new SDLResetGlobalPropertiesResponse object

indicated by the NSMutableDictionary parameter - parameter: dict The

dictionary to use

SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


SDLResult Class Reference

Section Contents

• +valueOf:• +values• +SUCCESS• +INVALID_DATA• +CHAR_LIMIT_EXCEEDED• +UNSUPPORTED_REQUEST• +OUT_OF_MEMORY• +TOO_MANY_PENDING_REQUESTS• +INVALID_ID• +DUPLICATE_NAME• +TOO_MANY_APPLICATIONS• +APPLICATION_REGISTERED_ALREADY• +UNSUPPORTED_VERSION• +WRONG_LANGUAGE• +APPLICATION_NOT_REGISTERED• +IN_USE• +VEHICLE_DATA_NOT_ALLOWED• +VEHICLE_DATA_NOT_AVAILABLE• +REJECTED• +ABORTED

PARAMETERS

• +IGNORED• +UNSUPPORTED_RESOURCE• +FILE_NOT_FOUND• +GENERIC_ERROR• +DISALLOWED• +USER_DISALLOWED• +TIMED_OUT• +CANCEL_ROUTE• +TRUNCATED_DATA• +RETRY• +WARNINGS• +SAVED• +INVALID_CERT• +EXPIRED_CERT• +RESUME_FAILED

Overview

Defines the possible result codes returned by SDL to the application in a

response to a requested operation

@since SDL 1.0

+valueOf:

@abstract get SDLResult according value string - parameter: value The value of

the string to get an object for - returns: SDLResult object

OBJECTIVE-C

+ (SDLResult *)valueOf:(NSString *)value;

value


SDLResult object

+values

@abstract declare an array to store all possible SDLResult values - returns: the

array

SWIFT

class func value(of value: String!) -> SDLResult!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


the array

+SUCCESS

@abstract The request succeeded

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLResult *)SUCCESS;

SWIFT

class func success() -> SDLResult!

+INVALID_DATA

@abstract Result code : Invalid Data

@discussion The data sent is invalid. For example: • Invalid Json syntax• Parameters out of bounds (number or enum range)• Mandatory parameters not provided• Parameter provided with wrong type• Invalid characters• Empty string

+CHAR_LIMIT_EXCEEDED

Undocumented

OBJECTIVE-C

+ (SDLResult *)INVALID_DATA;

SWIFT

class func invalid_DATA() -> SDLResult!

+UNSUPPORTED_REQUEST

@abstract The request is not supported by SDL

+OUT_OF_MEMORY

@abstract The system could not process the request because the necessary

memory couldn’t be allocated

OBJECTIVE-C

@interface SDLResult : SDLEnum

OBJECTIVE-C

+ (SDLResult *)UNSUPPORTED_REQUEST;

SWIFT

class func unsupported_REQUEST() -> SDLResult!

+TOO_MANY_PENDING_REQUESTS

@abstract There are too many requests pending (means that the response has

not been delivered yet).

@discussion There is a limit of 1000 pending requests at a time.

OBJECTIVE-C

+ (SDLResult *)OUT_OF_MEMORY;

SWIFT

class func out_OF_MEMORY() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)TOO_MANY_PENDING_REQUESTS;

+INVALID_ID

@abstract One of the provided IDs is not valid. @discussion For example: • CorrelationID• CommandID• MenuID

+DUPLICATE_NAME

@abstract The provided name or synonym is a duplicate of some already-

defined name or synonym.

SWIFT

class func too_MANY_PENDING_REQUESTS() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)INVALID_ID;

SWIFT

class func invalid_ID() -> SDLResult!

+TOO_MANY_APPLICATIONS

There are already too many registered applications.

OBJECTIVE-C

+ (SDLResult *)DUPLICATE_NAME;

SWIFT

class func duplicate_NAME() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)TOO_MANY_APPLICATIONS;

SWIFT

class func too_MANY_APPLICATIONS() -> SDLResult!

+APPLICATION_REGISTERED_ALREADY

RegisterApplication has been called again, after a RegisterApplication was

successful before.

+UNSUPPORTED_VERSION

The Head Unit doesn’t support the protocol that is requested by the mobile

application.

OBJECTIVE-C

+ (SDLResult *)APPLICATION_REGISTERED_ALREADY;

SWIFT

class func application_REGISTERED_ALREADY() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)UNSUPPORTED_VERSION;

+WRONG_LANGUAGE

The requested language is currently not supported. Might be because of a

mismatch of the currently active language on the head unit and the requested

language.

+APPLICATION_NOT_REGISTERED

A command can not be executed because no application has been registered

with RegisterApplication.

SWIFT

class func unsupported_VERSION() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)WRONG_LANGUAGE;

SWIFT

class func wrong_LANGUAGE() -> SDLResult!

+IN_USE

The data may not be changed, because it is currently in use. For example when

trying to delete a command set that is currently involved in an interaction.

OBJECTIVE-C

+ (SDLResult *)APPLICATION_NOT_REGISTERED;

SWIFT

class func application_NOT_REGISTERED() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)IN_USE;

SWIFT

class func in_USE() -> SDLResult!

+VEHICLE_DATA_NOT_ALLOWED

The user has turned off access to vehicle data, and it is globally unavailable to

mobile applications.

+VEHICLE_DATA_NOT_AVAILABLE

The requested vehicle data is not available on this vehicle or is not published.

OBJECTIVE-C

+ (SDLResult *)VEHICLE_DATA_NOT_ALLOWED;

SWIFT

class func vehicle_DATA_NOT_ALLOWED() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)VEHICLE_DATA_NOT_AVAILABLE;

+REJECTED

The requested command was rejected, e.g. because mobile app is in

background and cannot perform any HMI commands. Or an HMI command (e.g.

Speak) is rejected because a higher priority HMI command (e.g. Alert) is

playing.

SWIFT

class func vehicle_DATA_NOT_AVAILABLE() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)REJECTED;

SWIFT

class func rejected() -> SDLResult!

+ABORTED

A command was aborted, for example due to user interaction (e.g. user pressed

button). Or an HMI command (e.g. Speak) is aborted because a higher priority

HMI command (e.g. Alert) was requested.

+IGNORED

A command was ignored, because the intended result is already in effect. For

example, SetMediaClockTimer was used to pause the media clock although the

clock is paused already.

OBJECTIVE-C

+ (SDLResult *)ABORTED;

SWIFT

class func aborted() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)IGNORED;

+UNSUPPORTED_RESOURCE

A button that was requested for subscription is not supported under the current

system.

+FILE_NOT_FOUND

A specified file could not be found on the head unit.

SWIFT

class func ignored() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)UNSUPPORTED_RESOURCE;

SWIFT

class func unsupported_RESOURCE() -> SDLResult!

+GENERIC_ERROR

Provided data is valid but something went wrong in the lower layers.

OBJECTIVE-C

+ (SDLResult *)FILE_NOT_FOUND;

SWIFT

class func file_NOT_FOUND() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)GENERIC_ERROR;

SWIFT

class func generic_ERROR() -> SDLResult!

+DISALLOWED

RPC is not authorized in local policy table.

+USER_DISALLOWED

RPC is included in a functional group explicitly blocked by the user.

OBJECTIVE-C

+ (SDLResult *)DISALLOWED;

SWIFT

class func disallowed() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)USER_DISALLOWED;

+TIMED_OUT

Overlay reached the maximum timeout and closed.

+CANCEL_ROUTE

User selected to Cancel Route.

SWIFT

class func user_DISALLOWED() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)TIMED_OUT;

SWIFT

class func timed_OUT() -> SDLResult!

+TRUNCATED_DATA

The RPC (e.g. ReadDID) executed successfully but the data exceeded the

platform maximum threshold and thus, only part of the data is available.

OBJECTIVE-C

+ (SDLResult *)CANCEL_ROUTE;

SWIFT

class func cancel_ROUTE() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)TRUNCATED_DATA;

SWIFT

class func truncated_DATA() -> SDLResult!

+RETRY

The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to

start over. Note, the app must issue the new RPC.

+WARNINGS

The RPC (e.g. SubscribeVehicleData) executed successfully but one or more

items have a warning or failure.

OBJECTIVE-C

+ (SDLResult *)RETRY;

SWIFT

class func retry() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)WARNINGS;

+SAVED

The RPC (e.g. Slider) executed successfully and the user elected to save the

current position / value.

+INVALID_CERT

The certificate provided during authentication is invalid.

SWIFT

class func warnings() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)SAVED;

SWIFT

class func saved() -> SDLResult!

+EXPIRED_CERT

The certificate provided during authentication is expired.

OBJECTIVE-C

+ (SDLResult *)INVALID_CERT;

SWIFT

class func invalid_CERT() -> SDLResult!

OBJECTIVE-C

+ (SDLResult *)EXPIRED_CERT;

SWIFT

class func expired_CERT() -> SDLResult!

+RESUME_FAILED

The provided hash ID does not match the hash of the current set of registered

data or the core could not resume the previous data.

SDLSamplingRate Class Reference

Section Contents

• +valueOf:• +values• +_8KHZ• +_16KHZ• +_22KHZ• +_44KHZ

OBJECTIVE-C

+ (SDLResult *)RESUME_FAILED;

SWIFT

class func resume_FAILED() -> SDLResult!

Overview

Describes different sampling rates for PerformAudioPassThru

@since SDL 2.0

+valueOf:

@abstract get SDLSamplingRate according value string

value


OBJECTIVE-C

+ (SDLSamplingRate *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLSamplingRate!

PARAMETERS

SDLSamplingRate object

+values

@abstract declare an array to store all possible SDLSamplingRate values

the array

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+_8KHZ

@abstract Sampling rate of 8 kHz

SamplingRate of 8KHZ

+_16KHZ


OBJECTIVE-C

+ (SDLSamplingRate *)_8KHZ;

SWIFT

class func _8KHZ() -> SDLSamplingRate!

RETURN VALUE


+_22KHZ


OBJECTIVE-C


SWIFT


RETURN VALUE

OBJECTIVE-C



+_44KHZ


SWIFT


RETURN VALUE

OBJECTIVE-C


SWIFT



SDLScreenParams Class Reference

Section Contents

• -init• -initWithDictionary:• resolution• touchEventAvailable

Overview

Undocumented

-init

Undocumented


Undocumented

resolution

Undocumented

RETURN VALUE

touchEventAvailable

Undocumented

SDLScrollableMessage Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithMessage:• -initWithMessage:timeout:softButtons:• scrollableMessageBody• timeout• softButtons

Overview

Creates a full screen overlay containing a large block of formatted text that can

be scrolled with up to 8 SoftButtons defined

Function Group: ScrollableMessage


-init

@abstract Constructs a new SDLScrollableMessage object


@abstract Constructs a new SDLScrollableMessage object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


-initWithMessage:

Undocumented

-initWithMessage:timeout:softButtons:

Undocumented

PARAMETERS

OBJECTIVE-C

@interface SDLScrollableMessage : SDLRPCRequest

OBJECTIVE-C

@interface SDLScrollableMessage : SDLRPCRequest

scrollableMessageBody

@abstract A Body of text that can include newlines and tabs @discussion A

String value representing the Body of text that can include newlines and tabs


timeout

@abstract Gets/Sets an App defined timeout. Indicates how long of a timeout in

milliseconds from the last action @discussion An Integer value representing an

App defined timeout in milliseconds

Notes:Minval=0; Maxval=65535;Default=30000

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *scrollableMessageBody;

SWIFT

var scrollableMessageBody: String! { get set }

softButtons

@abstract Gets/Sets App defined SoftButtons.If omitted on supported displays,

only the system defined “Close” SoftButton will be displayed @discussion A

Vector value representing App defined SoftButtons

Notes: Minsize=0, Maxsize=8

OBJECTIVE-C


SWIFT


OBJECTIVE-C


SDLScrollableMessageResponse ClassReference

Section Contents


Overview

Scrollable Message Response is sent, when SDLScrollableMessage has been

called


-init

@abstract Constructs a new SDLScrollableMessageResponse object

SWIFT



@abstract Constructs a new SDLScrollableMessageResponse object indicated

by the NSMutableDictionary parameter - parameter: dict The dictionary to use

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


SDLSendLocation Class Reference

Section Contents

• -

initWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image:• -

initWithLongitude:latitude:locationName:locationDescription:displayAddressLines:phoneNumber:image:deliv• longitudeDegrees• latitudeDegrees• locationName• locationDescription• addressLines• phoneNumber• locationImage• deliveryMode• timeStamp• address

Overview

Undocumented

PARAMETERS

-

initWithLongitude:latitude:locationName:locationDescription:address:phoneNum

Undocumented

-

initWithLongitude:latitude:locationName:locationDescription:displayAddressLin

Undocumented

longitudeDegrees

The longitudinal coordinate of the location.

Float, Required, -180.0 - 180.0

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLFloat> *longitudeDegrees;

SWIFT

@NSCopying var longitudeDegrees: NSNumber! { get set }


latitudeDegrees

The latitudinal coordinate of the location.

Float, Required, -90.0 - 90.0

locationName

Name / title of intended location

Optional, Maxlength = 500 char

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSNumber<SDLFloat> *latitudeDegrees;

SWIFT

@NSCopying var latitudeDegrees: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *locationName;


locationDescription

Description of the intended location / establishment

Optional, MaxLength = 500 char

addressLines

Location address for display purposes only

Contains String, Optional, Max Array Length = 4, Max String Length = 500

SWIFT

var locationName: String! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *locationDescription;

SWIFT

var locationDescription: String! { get set }

phoneNumber

Phone number of intended location / establishment

Optional, Max Length = 500

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSArray<NSString *> *addressLines;

SWIFT

var addressLines: [String]! { get set }

OBJECTIVE-C

@property (readwrite, copy, nonatomic) NSString *phoneNumber;

locationImage

Image / icon of intended location

Optional

deliveryMode

Mode in which the sendLocation request is sent

Optional

SWIFT

var phoneNumber: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, nonatomic) SDLImage *locationImage;

SWIFT

var locationImage: SDLImage! { get set }



timeStamp

Arrival time of Location. If multiple SendLocations are sent, this will be used for

sorting as well.

Optional

OBJECTIVE-C

@property (readwrite, strong, nonatomic) SDLDeliveryMode *deliveryMode;

SWIFT

var deliveryMode: SDLDeliveryMode! { get set }

OBJECTIVE-C

@property (readwrite, strong, nonatomic) SDLDateTime *timeStamp;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDeliveryMode.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDeliveryMode.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDateTime.html

address

Address to be used for setting destination

Optional

SWIFT

var timeStamp: SDLDateTime! { get set }

OBJECTIVE-C

@property (readwrite, strong, nonatomic) SDLOasisAddress *address;

SWIFT

var address: SDLOasisAddress! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLDateTime.html



SDLSendLocationResponse ClassReference

Section Contents


Overview

Undocumented

-init

Undocumented


Undocumented

SDLSetAppIcon Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithFileName:• syncFileName

Overview

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

generation SDL modules.


-init

@abstract Constructs a new SDLSetAppIcon object


@abstract Constructs a new SDLSetAppIcon object indicated by the dictionary


OBJECTIVE-C


SWIFT

init!()

dict


-initWithFileName:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

OBJECTIVE-C

@interface SDLSetAppIcon : SDLRPCRequest

syncFileName

@abstract A file reference name @discussion A String value representing a file

reference name


SDLSetAppIconResponse ClassReference

Section Contents


OBJECTIVE-C


SWIFT


Overview

SDLSetAppIconResponse is sent, when SDLSetAppIcon has been called. * Since

SmartDeviceLink 2.0

-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLSetAppIconResponse : SDLRPCResponse

OBJECTIVE-C

@interface SDLSetAppIconResponse : SDLRPCResponse

SDLSetDisplayLayout Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithPredefinedLayout:• -initWithLayout:• displayLayout

Overview

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

platform will be shown


-init

@abstract Constructs a new SDLSetDisplayLayout object

OBJECTIVE-C



@abstract Constructs a new SDLSetDisplayLayout object indicated by the


dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


-initWithPredefinedLayout:

Undocumented

-initWithLayout:

Undocumented

displayLayout

@abstract A display layout. Predefined or dynamically created screen layout.

Currently only predefined screen layouts are defined. Predefined layouts

include: “ONSCREEN_PRESETS” Custom screen containing app-defined

onscreen presets. Currently defined for GEN2

OBJECTIVE-C

@interface SDLSetDisplayLayout : SDLRPCRequest

OBJECTIVE-C

@interface SDLSetDisplayLayout : SDLRPCRequest

SDLSetDisplayLayoutResponse ClassReference

Section Contents

• -init• -initWithDictionary:• displayCapabilities• buttonCapabilities• softButtonCapabilities

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *displayLayout;

SWIFT

var displayLayout: String! { get set }

• presetBankCapabilities

Overview

Set Display Layout Response is sent, when SetDisplayLayout has been called


-init

@abstract Constructs a new SDLSetDisplayLayoutResponse object


Undocumented

OBJECTIVE-C


SWIFT

init!()

displayCapabilities

Undocumented

buttonCapabilities

Undocumented

OBJECTIVE-C

@interface SDLSetDisplayLayoutResponse : SDLRPCResponse

OBJECTIVE-C


OBJECTIVE-C


softButtonCapabilities

Undocumented

presetBankCapabilities

Undocumented

SDLSetGlobalProperties ClassReference

Section Contents

• -init

OBJECTIVE-C


OBJECTIVE-C


• -initWithDictionary:• -initWithHelpText:timeoutText:• -initWithHelpText:timeoutText:vrHelpTitle:vrHelp:• -

initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:• helpPrompt• timeoutPrompt• vrHelpTitle• vrHelp• menuTitle• menuIcon• keyboardProperties

Overview

Sets value(s) for the specified global property(ies)



Since SmartDeviceLink 1.0 See SDLResetGlobalProperties

-init

@abstract Constructs a new SDLSetGlobalProperties object

OBJECTIVE-C



@abstract Constructs a new SDLSetGlobalProperties object indicated by the


dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


-initWithHelpText:timeoutText:

Undocumented

-initWithHelpText:timeoutText:vrHelpTitle:vrHelp:

Undocumented

-

initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboard

Undocumented

OBJECTIVE-C

@interface SDLSetGlobalProperties : SDLRPCRequest

OBJECTIVE-C


helpPrompt

@abstract Sets a Vector for Help Prompt that Array of one or more TTSChunk

elements specifying the help prompt used in an interaction started by PTT

@discussion helpPrompt a Vector of one or more TTSChunk elements

Notes:

• Array must have at least one element• Only optional it timeoutPrompt has been specified

OBJECTIVE-C


OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *helpPrompt;

SWIFT

var helpPrompt: NSMutableArray! { get set }

timeoutPrompt

@abstract A Vector for Timeout Prompt representing Array of one or more

TTSChunk elements specifying the help prompt used in an interaction started

by PTT

vrHelpTitle

@abstract Sets a voice recognition Help Title

@discussion A String value representing a voice recognition Help Title

Notes:

• If omitted on supported displays, the default SDL help title will be used• If omitted and one or more vrHelp items are provided, the request will be

rejected.• String Maxlength = 500


OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *timeoutPrompt;

SWIFT

var timeoutPrompt: NSMutableArray! { get set }

vrHelp

@abstract Sets the items listed in the VR help screen used in an interaction

started by PTT

@discussion A Vector value representing items listed in the VR help screen

used in an interaction started by PTT

Notes:

• If omitted on supported displays, the default SmartDeviceLink VR help /

What Can I Say? screen will be used• If the list of VR Help Items contains nonsequential positions (e.g. [1,2,4]),

the RPC will be rejected• If omitted and a vrHelpTitle is provided, the request will be rejected• Array Minsize: = 1• Array Maxsize = 100


OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *vrHelpTitle;

SWIFT

var vrHelpTitle: String! { get set }

menuTitle

Undocumented

menuIcon

Undocumented

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *vrHelp;

SWIFT

var vrHelp: NSMutableArray! { get set }

OBJECTIVE-C


keyboardProperties

Undocumented

SDLSetGlobalPropertiesResponse ClassReference

Section Contents

• -init

OBJECTIVE-C


OBJECTIVE-C



Overview

Set Global Properties Response is sent, when SDLSetGlobalProperties has been

called


-init

@abstract Constructs a new SDLSetGlobalPropertiesResponse object


@abstract Constructs a new SDLSetGlobalPropertiesResponse object indicated


OBJECTIVE-C


SWIFT

init!()

dict


SDLSetMediaClockTimer ClassReference

Section Contents

• -init

OBJECTIVE-C


SWIFT


PARAMETERS

• -initWithDictionary:• -initWithUpdateMode:hours:minutes:seconds:• -initWithUpdateMode:• startTime• endTime• updateMode

Overview

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

down, etc.)


HMILevel needs to be FULL, LIMITIED or BACKGROUND


-init

@abstract Constructs a new SDLSetMediaClockTimer object

OBJECTIVE-C


SWIFT

init!()


@abstract Constructs a new SDLSetMediaClockTimer object indicated by the


dict


-initWithUpdateMode:hours:minutes:seconds:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

-initWithUpdateMode:

Undocumented

startTime

@abstract A Start Time with specifying hour, minute, second values

@discussion A startTime object with specifying hour, minute, second values

Notes:

• If “updateMode” is COUNTUP or COUNTDOWN, this parameter must be

provided• Will be ignored for PAUSE/RESUME and CLEAR

OBJECTIVE-C

@interface SDLSetMediaClockTimer : SDLRPCRequest

OBJECTIVE-C

@interface SDLSetMediaClockTimer : SDLRPCRequest

endTime

@abstract An END time of type SDLStartTime, specifying hour, minute, second

values

@discussion An SDLStartTime object with specifying hour, minute, second

values

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLStartTime *startTime;

SWIFT

var startTime: SDLStartTime! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLStartTime *endTime;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLStartTime.html



updateMode

@abstract The media clock/timer update mode (COUNTUP/COUNTDOWN/

PAUSE/RESUME)

@discussion a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME)

Notes:

• When updateMode is PAUSE, RESUME or CLEAR, the start time value is

ignored• When updateMode is RESUME, the timer resumes counting from the

timer’s value when it was paused

SWIFT

var endTime: SDLStartTime! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLUpdateMode *updateMode;

SWIFT

var updateMode: SDLUpdateMode! { get set }


https://d83tozu1c8tt6.cloudfront.net/Classes/SDLUpdateMode.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLUpdateMode.html

SDLSetMediaClockTimerResponse ClassReference

Section Contents


Overview

Set Media Clock Timer Response is sent, when SDLSetMediaClockTimer has

been called


-init

@abstract Constructs a new SDLSetMediaClockTimerResponse object

OBJECTIVE-C



@abstract Constructs a new SDLSetMediaClockTimerResponse object indicated

by the NSMutableDictionary parameter

dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


SDLShow Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithMainField1:mainField2:alignment:• -initWithMainField1:mainField2:mainField3:mainField4:alignment:• -

initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:• -

initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:s• mainField1• mainField2• mainField3• mainField4• alignment• statusBar• mediaClock• mediaTrack• graphic• secondaryGraphic• softButtons• customPresets

Overview

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


Since SmartDeviceLink 1.0 See SDLAlert SDLSetMediaClockTimer

-init

@abstract Constructs a new SDLShow object


@abstract Constructs a new SDLShow object indicated by the dictionary


OBJECTIVE-C


SWIFT

init!()

dict


-initWithMainField1:mainField2:alignment:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

OBJECTIVE-C

@interface SDLShow : SDLRPCRequest

-

initWithMainField1:mainField2:mainField3:mainField4:alignment:

Undocumented

-

initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:

Undocumented

-

initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:med

Undocumented

OBJECTIVE-C


OBJECTIVE-C


mainField1

@abstract The text displayed in a single-line display, or in the upper display

line in a two-line display @discussion The String value representing the text

displayed in a single-line display, or in the upper display line in a two-line

display

Notes:

• If this parameter is omitted, the text of mainField1 does not change• If this parameter is an empty string, the field will be cleared

OBJECTIVE-C


OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *mainField1;

SWIFT

var mainField1: String! { get set }

mainField2

@abstract The text displayed on the second display line of a two-line display

@discussion The String value representing the text displayed on the second

display line of a two-line display

Notes:

• If this parameter is omitted, the text of mainField2 does not change• If this parameter is an empty string, the field will be cleared• If provided and the display is a single-line display, the parameter is

ignored• Maxlength = 500

mainField3

@abstract The text displayed on the first display line of the second page

@discussion The String value representing the text displayed on the first

display line of the second page

OBJECTIVE-C


SWIFT


Notes:


ignored• Maxlength = 500


mainField4

@abstract The text displayed on the second display line of the second page

@discussion The String value representing the text displayed on the second

display line of the second page

Notes:


ignored

OBJECTIVE-C


SWIFT


• Maxlength = 500


alignment

@abstract The alignment that Specifies how mainField1 and mainField2 text

should be aligned on display

@discussion An Enumeration value

Notes:

• Applies only to mainField1 and mainField2 provided on this call, not to

what is already showing in display• If this parameter is omitted, text in both mainField1 and mainField2 will be

centered• Has no effect with navigation display

OBJECTIVE-C


SWIFT


statusBar

@abstract Text in the Status Bar

@discussion A String representing the text you want to add in the Status Bar

Notes: The status bar only exists on navigation displays

• If this parameter is omitted, the status bar text will remain unchanged• If this parameter is an empty string, the field will be cleared• If provided and the display has no status bar, this parameter is ignored

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLTextAlignment *alignment;

SWIFT

var alignment: SDLTextAlignment! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *statusBar;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLTextAlignment.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLTextAlignment.html

mediaClock

@abstract This property is deprecated use SetMediaClockTimer instead.

The value for the MediaClock field using a format described in the

MediaClockFormat enumeration

@discussion A String value for the MediaClock

Notes:

• Must be properly formatted as described in the MediaClockFormat

enumeration• If a value of five spaces is provided, this will clear that field on the display

(i.e. the media clock timer field will not display anything)

SWIFT

var statusBar: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *mediaClock;

mediaTrack

@abstract The text in the track field

@discussion A String value disaplayed in the track field

Notes:

• If parameter is omitted, the track field remains unchanged• If an empty string is provided, the field will be cleared• This field is only valid for media applications on navigation displays

SWIFT

var mediaClock: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *mediaTrack;

SWIFT

var mediaTrack: String! { get set }

graphic

@abstract An image to be shown on supported displays

@discussion The value representing the image shown on supported displays

Notes: If omitted on supported displays, the displayed graphic shall not

change


secondaryGraphic

@abstract An image to be shown on supported displays

@discussion The value representing the image shown on supported displays

Notes: If omitted on supported displays, the displayed graphic shall not

change


OBJECTIVE-C

@property (readwrite, strong, atomic) SDLImage *graphic;

SWIFT

var graphic: SDLImage! { get set }



softButtons

@abstract The the Soft buttons defined by the App

@discussion A Vector value represemting the Soft buttons defined by the App

Notes:

• If omitted on supported displays, the currently displayed SoftButton

values will not change• Array Minsize: 0• Array Maxsize: 8


OBJECTIVE-C

@property (readwrite, strong, atomic) SDLImage *secondaryGraphic;

SWIFT

var secondaryGraphic: SDLImage! { get set }



customPresets

@abstract The Custom Presets defined by the App

@discussion A Vector value representing the Custom Presets defined by the

App

• If omitted on supported displays, the presets will be shown as not defined• Array Minsize: 0• Array Maxsize: 6


OBJECTIVE-C


SWIFT


OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *customPresets;

SDLShowConstantTBT Class Reference

Section Contents


initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distance• navigationText1• navigationText2• eta• timeToDestination• totalDistance• turnIcon• nextTurnIcon• distanceToManeuver• distanceToManeuverScale• maneuverComplete

SWIFT

var customPresets: NSMutableArray! { get set }

• softButtons

Overview

This RPC is used to update the user with navigation information

* for the constantly shown screen (base screen),but also for the

* alert type screen. *

* @since SmartDeviceLink 2.0

-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLShowConstantTBT : SDLRPCRequest

OBJECTIVE-C


-

initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:tu

Undocumented

navigationText1

Undocumented

navigationText2

Undocumented

OBJECTIVE-C


OBJECTIVE-C


eta

Undocumented

timeToDestination

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


totalDistance

Undocumented

turnIcon

Undocumented

nextTurnIcon

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


distanceToManeuver

Undocumented

distanceToManeuverScale

Undocumented

maneuverComplete

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


softButtons

Undocumented

SDLShowConstantTBTResponse ClassReference

Section Contents


Overview

SDLShowConstantTBTResponse is sent, when SDLShowConstantTBT has been

called. * SinceSmartDeviceLink 2.0

-init

Undocumented

OBJECTIVE-C



Undocumented

SDLShowResponse Class Reference

Section Contents


Overview

Show Response is sent, when Show has been called

OBJECTIVE-C

@interface SDLShowConstantTBTResponse : SDLRPCResponse

OBJECTIVE-C

@interface SDLShowConstantTBTResponse : SDLRPCResponse


-init

@abstract Constructs a new SDLShowResponse object


@abstract Constructs a new SDLShowResponse object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


SDLSingleTireStatus Class Reference

Section Contents

• -init• -initWithDictionary:• status

Overview

Tire pressure status of a single tire.


SWIFT


PARAMETERS

-init

@abstract Constructs a newly allocated SDLSingleTireStatus object


@abstract Constructs a newly allocated SDLSingleTireStatus object indicated by

the dictionary parameter - parameter: dict The dictionary to use

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


status

@abstract The volume status of a single tire

SWIFT


PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLComponentVolumeStatus *status;

SWIFT

var status: SDLComponentVolumeStatus! { get set }



SDLSiphonServer Class Reference

Section Contents

• +enableSiphonDebug• +disableSiphonDebug• +_siphonRawTransportDataFromApp:msgBytesLength:• +_siphonRawTransportDataFromSDL:msgBytesLength:• +_siphonNSLogData:• +_siphonFormattedTraceData:• +_siphonIsActive• +init• +dealloc

Overview

Undocumented

+enableSiphonDebug

Undocumented

+disableSiphonDebug

Undocumented

+_siphonRawTransportDataFromApp:msgBytesLength:

Undocumented

+_siphonRawTransportDataFromSDL:msgBytesLength:

Undocumented

+_siphonNSLogData:

Undocumented

+_siphonFormattedTraceData:

Undocumented

+_siphonIsActive

Undocumented

+init

Undocumented

+dealloc

Undocumented

SDLSlider Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithNumTicks:position:

• -initWithNumTicks:position:sliderHeader:sliderFooter:timeout:• -initWithNumTicks:position:sliderHeader:sliderFooters:timeout:• numTicks• position• sliderHeader• sliderFooter• timeout

Overview

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

user controlled slider



-init

@abstract Constructs a new SDLSlider object

OBJECTIVE-C


SWIFT

init!()


@abstract Constructs a new SDLSlider object indicated by the dictionary


dict


-initWithNumTicks:position:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

-

initWithNumTicks:position:sliderHeader:sliderFooter:timeout:

Undocumented

-

initWithNumTicks:position:sliderHeader:sliderFooters:timeout:

Undocumented

OBJECTIVE-C

@interface SDLSlider : SDLRPCRequest

OBJECTIVE-C


OBJECTIVE-C


numTicks

@abstract Represents a number of selectable items on a horizontal axis


position

@abstract An Initial position of slider control


OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *numTicks;

SWIFT

var numTicks: NSNumber! { get set }

OBJECTIVE-C


sliderHeader

@abstract A text header to display

Rquired, Max length 500 chars

sliderFooter

@abstract A text footer to display

SWIFT


OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *sliderHeader;

SWIFT

var sliderHeader: String! { get set }

@discussion For a static text footer, only one footer string shall be provided in

the array.

For a dynamic text footer, the number of footer text string in the array must

match the numTicks value.

For a dynamic text footer, text array string should correlate with potential slider

position index.

If omitted on supported displays, no footer text shall be displayed.

Optional, Array of Strings, Array length 1 - 26, Max string length 500 chars

timeout

@abstract An App defined timeout

@discussion Indicates how long of a timeout from the last action (i.e. sliding

control resets timeout).

If omitted, the value is set to 10000.

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *sliderFooter;

SWIFT

var sliderFooter: NSMutableArray! { get set }


SDLSliderResponse Class Reference

Section Contents

• -init• -initWithDictionary:• sliderPosition

Overview

Slider Response is sent, when Slider has been called


OBJECTIVE-C


SWIFT


-init

@abstract Constructs a new SDLSliderResponse object


@abstract Constructs a new SDLSliderResponse object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


sliderPosition

@abstract The selected position of the slider.

SWIFT


PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *sliderPosition;

SWIFT

var sliderPosition: NSNumber! { get set }

SDLSoftButton Class Reference

Section Contents

• -init• -initWithHandler:• -initWithDictionary:• -initWithType:text:image:highlighted:buttonId:systemAction:handler:• handler• type• text• image• isHighlighted• softButtonID• systemAction

Overview

Undocumented

-init

Undocumented

-initWithHandler:

Undocumented


Undocumented

-

initWithType:text:image:highlighted:buttonId:systemAction:handler:

Undocumented

handler

Undocumented

type

Undocumented

text

Undocumented

image

Undocumented

isHighlighted

Undocumented

softButtonID

Undocumented

systemAction

Undocumented

SDLSoftButtonCapabilities ClassReference

Section Contents

• -init• -initWithDictionary:• shortPressAvailable• longPressAvailable• upDownAvailable• imageSupported

Overview

Contains information about a SoftButton’s capabilities.

@since SDL 2.0

-init

@abstract Constructs a newly allocated SDLSoftButtonCapabilities object

OBJECTIVE-C



@abstract Constructs a newly allocated SDLSoftButtonCapabilities object


dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


shortPressAvailable

@abstract The button supports a short press.

@discussion Whenever the button is pressed short, onButtonPressed(SHORT)

will be invoked.

Required, Boolean

longPressAvailable

@abstract The button supports a LONG press.

@discussion Whenever the button is pressed long, onButtonPressed(LONG) will

be invoked.

Required, Boolean

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *shortPressAvailable;

SWIFT

var shortPressAvailable: NSNumber! { get set }

upDownAvailable

@abstract The button supports “button down” and “button up”.

@discussion Whenever the button is pressed, onButtonEvent(DOWN) will be

invoked. Whenever the button is released, onButtonEvent(UP) will be invoked.

Required, Boolean

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *longPressAvailable;

SWIFT

var longPressAvailable: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *upDownAvailable;

imageSupported

@abstract The button supports referencing a static or dynamic image.

Required, Boolean

SWIFT

var upDownAvailable: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *imageSupported;

SWIFT

var imageSupported: NSNumber! { get set }

SDLSoftButtonType Class Reference

Section Contents

• +valueOf:• +values• +TEXT• +IMAGE• +BOTH

Overview

SoftButtonType (TEXT / IMAGE / BOTH)

+valueOf:

@abstract get SDLSoftButtonType according value string - parameter: value

NSString - returns: SDLSoftButtonType object

OBJECTIVE-C

+ (SDLSoftButtonType *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLSoftButtonType!

value

NSString

SDLSoftButtonType object

+values

@abstract declare an array to store all possible SDLSoftButtonType values -

returns: the array

PARAMETERS

RETURN VALUE

OBJECTIVE-C


SWIFT


the array

+TEXT

@abstract Text kind Softbutton - returns: SDLSoftButtonType object with string

value TEXT

SDLSoftButtonType object with string value TEXT

RETURN VALUE

OBJECTIVE-C

+ (SDLSoftButtonType *)TEXT;

SWIFT

class func text() -> SDLSoftButtonType!

RETURN VALUE

+IMAGE

@abstract Image kind Softbutton - returns: SDLSoftButtonType object with

string value IMAGE

SDLSoftButtonType object with string value IMAGE

+BOTH

@abstract Both (Text & Image) kind Softbutton - returns: SDLSoftButtonType

object with string value BOTH

OBJECTIVE-C

+ (SDLSoftButtonType *)IMAGE;

SWIFT

class func image() -> SDLSoftButtonType!

RETURN VALUE

SDLSoftButtonType object with string value BOTH

SDLSpeak Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithTTS:• -initWithTTSChunks:• ttsChunks

OBJECTIVE-C

+ (SDLSoftButtonType *)BOTH;

SWIFT

class func both() -> SDLSoftButtonType!

RETURN VALUE

Overview

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


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




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-



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

-init

@abstract Constructs a new SDLSpeak object

OBJECTIVE-C


SWIFT

init!()


@abstract Constructs a new SDLSpeak object indicated by the dictionary


dict


-initWithTTS:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

-initWithTTSChunks:

Undocumented

ttsChunks

@abstract An array of TTSChunk structs which, taken together, specify the

phrase to be spoken

@discussion The total length of the phrase composed from the ttsChunks

provided must be less than 500 characters or the request will be rejected

Required, Array of SDLTTSChunk, Array size 1 - 100

See

OBJECTIVE-C

@interface SDLSpeak : SDLRPCRequest

OBJECTIVE-C

@interface SDLSpeak : SDLRPCRequest

SDLTTSChunk

SDLSpeakResponse Class Reference

Section Contents


Overview

Speak Response is sent, when Speak has been called


OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *ttsChunks;

SWIFT

var ttsChunks: NSMutableArray! { get set }

-init

@abstract Constructs a new SDLSpeakResponse object


@abstract Constructs a new SDLSpeakResponse object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


SDLSpeechCapabilities Class Reference

Section Contents

• +valueOf:• +values• +TEXT• +SAPI_PHONEMES• +LHPLUS_PHONEMES• +PRE_RECORDED• +SILENCE

Overview

Undocumented

SWIFT


PARAMETERS

+valueOf:

@abstract get SDLSpeechCapabilities according value string

value


SDLSpeechCapabilities object

OBJECTIVE-C

+ (SDLSpeechCapabilities *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLSpeechCapabilities!

PARAMETERS

RETURN VALUE

+values

@abstract declare an array to store all possible SDLSpeechCapabilities values

the array of all possible values

+TEXT

@abstract The SDL platform can speak text phrases.

OBJECTIVE-C


SWIFT


RETURN VALUE

SDLSpeechCapabilities of value: TEXT

+SAPI_PHONEMES

Undocumented

+LHPLUS_PHONEMES

Undocumented

+PRE_RECORDED

Undocumented

OBJECTIVE-C

+ (SDLSpeechCapabilities *)TEXT;

SWIFT

class func text() -> SDLSpeechCapabilities!

RETURN VALUE

+SILENCE

Undocumented

SDLStartTime Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithHours:minutes:seconds:• hours• minutes• seconds

Overview

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

@since SDL 1.0

-init

@abstract Constructs a newly allocated SDLStartTime object

OBJECTIVE-C



@abstract Constructs a newly allocated SDLStartTime object indicated by the


dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


-initWithHours:minutes:seconds:

Undocumented

hours

@abstract The hour of the media clock

@discussion Some display types only support a max value of 19. If out of

range, it will be rejected.


OBJECTIVE-C

@interface SDLStartTime : SDLRPCStruct

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *hours;

minutes

@abstract The minute of the media clock


seconds

@abstract The second of the media clock


SWIFT

var hours: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *minutes;

SWIFT

var minutes: NSNumber! { get set }

SDLStreamingMediaManager ClassReference

Section Contents

• videoSessionConnected• audioSessionConnected• videoSessionEncrypted• audioSessionEncrypted• touchManager• videoEncoderSettings• displayCapabilties• defaultVideoEncoderSettings• screenSize• pixelBufferPool• -initWithProtocol:

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *seconds;

SWIFT

var seconds: NSNumber! { get set }

• -initWithProtocol:displayCapabilities:• -startVideoSessionWithStartBlock:• -startVideoSessionWithTLS:startBlock:• -stopVideoSession• -sendVideoData:• -startAudioSessionWithStartBlock:• -startAudioSessionWithTLS:startBlock:• -stopAudioSession• -sendAudioData:

Overview

Undocumented

videoSessionConnected

Undocumented

audioSessionConnected

Undocumented

videoSessionEncrypted

Undocumented

audioSessionEncrypted

Undocumented

touchManager

Touch Manager responsible for providing touch event notifications.

videoEncoderSettings

The settings used in a VTCompressionSessionRef encoder. These will be verified

when the video stream is started. Acceptable properties for this are located in

VTCompressionProperties. If set to nil, the defaultVideoEncoderSettings will be

used.

WarningVideo streaming must not be connected to update the encoder properties. If itis running, issue a stopVideoSession before updating.

OBJECTIVE-C

@property (readonly, strong, nonatomic) SDLTouchManager *_Nonnull touchManager;

SWIFT

var touchManager: SDLTouchManager { get }

OBJECTIVE-C

@property (readwrite, strong, nonatomic, null_resettable) NSDictionary *videoEncoderSettings;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLTouchManager.html


displayCapabilties

Display capabilties that will set the screenSize property. If set to nil, the

SDLDefaultScreenSize will be used.

WarningVideo streaming must not be connected to update the encoder properties. If itis running, issue a stopVideoSession before updating.

defaultVideoEncoderSettings

Provides default video encoder settings used.

SWIFT

var videoEncoderSettings: [AnyHashable : Any]! { get set }

OBJECTIVE-C

@property (readwrite, strong, nonatomic, null_resettable) SDLDisplayCapabilities *displayCapabilties;

SWIFT

var displayCapabilties: SDLDisplayCapabilities! { get set }



screenSize

This is the current screen size of a connected display. This will be the size the

video encoder uses to encode the raw image data.

OBJECTIVE-C

@property (readonly, strong, nonatomic) NSDictionary *_Nonnull defaultVideoEncoderSettings;

SWIFT

var defaultVideoEncoderSettings: [AnyHashable : Any] { get }

OBJECTIVE-C

@property (readonly, assign, nonatomic) CGSize screenSize;

SWIFT

var screenSize: CGSize { get }

pixelBufferPool

The pixel buffer pool reference returned back from an active

VTCompressionSessionRef encoder.

WarningThis will only return a valid pixel buffer pool after the encoder has beeninitialized (when the video session has started). @discussion Clients may callthis once and retain the resulting pool, this call is cheap enough that it’s OK tocall it once per frame.

-initWithProtocol:

Undocumented

-initWithProtocol:displayCapabilities:

Undocumented

OBJECTIVE-C

@property (readonly, assign, nonatomic, nullable) CVPixelBufferPoolRef pixelBufferPool;

SWIFT

unowned(unsafe) var pixelBufferPool: CVPixelBufferPool? { get }

-startVideoSessionWithStartBlock:

This method will attempt to start a streaming video session. It will set up iOS’s

video encoder, and call out to the head unit asking if it will start a video

session. This will not use encryption.

Warning

If this method is called on an 8.0 device, it will assert (in debug), or return a

failure immediately to your block (in release).

startBlock

A block that will be called with the result of attempting to start a video

session

OBJECTIVE-C

- (void)startVideoSessionWithStartBlock: (nonnull SDLStreamingStartBlock)startBlock;

SWIFT

func startVideoSession(start startBlock: @escaping SDLStreamingStartBlock)

PARAMETERS

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLStreamingMediaManager.h@T@SDLStreamingStartBlock


-startVideoSessionWithTLS:startBlock:

Start a video session either with with no encryption (the default), with

authentication but no encryption (this will attempt a TLS authentication with

the other side, but will not physically encrypt the data after that), or

authentication and encryption, which will encrypt all video data being sent.

encryptionFlag

Whether and how much security to apply to the video session.

OBJECTIVE-C

- (void)startVideoSessionWithTLS:(SDLEncryptionFlag)encryptionFlag startBlock: (nonnull SDLStreamingEncryptionStartBlock)startBlock;

SWIFT

func startVideoSession(withTLS encryptionFlag: SDLEncryptionFlag, start startBlock: @escaping SDLStreamingEncryptionStartBlock)

PARAMETERS

https://d83tozu1c8tt6.cloudfront.net/Enums/SDLEncryptionFlag.html

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLStreamingMediaManager.h@T@SDLStreamingEncryptionStartBlock

https://d83tozu1c8tt6.cloudfront.net/Enums/SDLEncryptionFlag.html

https://d83tozu1c8tt6.cloudfront.net/Type%20Definitions.html#/c:SDLStreamingMediaManager.h@T@SDLStreamingEncryptionStartBlock

startBlock

A block that will be called with the result of attempting to start a video

session

-stopVideoSession

This method will stop a running video session if there is one running.

-sendVideoData:

This method receives raw image data and will run iOS8+’s hardware video

encoder to turn the data into a video stream, which will then be passed to the

connected head unit.

OBJECTIVE-C

- (void)stopVideoSession;

SWIFT

func stopVideoSession()

imageBuffer

A CVImageBufferRef to be encoded by Video Toolbox

Whether or not the data was successfully encoded and sent.

-startAudioSessionWithStartBlock:

This method will attempt to start an audio session

OBJECTIVE-C

- (BOOL)sendVideoData:(nonnull CVImageBufferRef)imageBuffer;

SWIFT

func sendVideoData(_ imageBuffer: CVImageBuffer) -> Bool

PARAMETERS

RETURN VALUE

startBlock

A block that will be called with the result of attempting to start an

audio session

-startAudioSessionWithTLS:startBlock:

Undocumented

-stopAudioSession

This method will stop a running audio session if there is one running.

OBJECTIVE-C

- (void)startAudioSessionWithStartBlock: (nonnull SDLStreamingStartBlock)startBlock;

SWIFT

func startAudioSession(start startBlock: @escaping SDLStreamingStartBlock)

PARAMETERS



-sendAudioData:

This method receives PCM audio data and will attempt to send that data across

to the head unit for immediate playback

OBJECTIVE-C

- (void)stopAudioSession;

SWIFT

func stopAudioSession()

OBJECTIVE-C

- (BOOL)sendAudioData:(nonnull NSData *)pcmAudioData;

SWIFT

func sendAudioData(_ pcmAudioData: Data) -> Bool

pcmAudioData

The data in PCM audio format, to be played

Whether or not the data was successfully sent.

SDLSubscribeButton Class Reference

Section Contents

• -init• -initWithHandler:• -initWithDictionary:• -initWithButtonName:handler:• handler• buttonName

Overview

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

PARAMETERS

RETURN VALUE

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)



See SDLUnsubscribeButton

-init

Construct an SDLSubscribeButton

An SDLSubscribeButton object

-initWithHandler:

Construct a SDLSubscribeButton with a handler callback when an event occurs.

OBJECTIVE-C


SWIFT

init!()

RETURN VALUE

handler

A callback that will be called when a button event occurs for the

subscribed button.

An SDLSubscribeButton object

OBJECTIVE-C

- (instancetype)initWithHandler:(SDLRPCNotificationHandler)handler;

SWIFT

init!(handler: SDLRPCNotificationHandler!)

PARAMETERS

RETURN VALUE




@abstract Constructs a new SDLSubscribeButton object indicated by the


dict


-initWithButtonName:handler:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

handler

A handler that will let you know when the button you subscribed to is selected.

WarningThis will only work if you use SDLManager.

buttonName

@abstract The name of the button to subscribe to @discussion An enum value,

see SDLButtonName

OBJECTIVE-C

@interface SDLSubscribeButton : SDLRPCRequest <SDLRequestHandler>

OBJECTIVE-C

@property (readwrite, copy, nonatomic) SDLRPCNotificationHandler handler;

SWIFT

var handler: SDLRPCNotificationHandler! { get set }




SDLSubscribeButtonResponse ClassReference

Section Contents


Overview

SubscribeButton Response is sent, when SDLSubscribeButton has been called


OBJECTIVE-C


SWIFT




-init

@abstract Constructs a new SDLSubscribeButtonResponse object


@abstract Constructs a new SDLSubscribeButtonResponse object indicated by


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


SDLSubscribeVehicleData ClassReference

Section Contents


initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:• gps• speed• rpm• fuelLevel• fuelLevel_State• instantFuelConsumption

SWIFT


PARAMETERS

• externalTemperature• prndl• tirePressure• odometer• beltStatus• bodyInformation• deviceStatus• driverBraking• wiperStatus• headLampStatus• engineTorque• accPedalPosition• steeringWheelAngle• eCallInfo• airbagStatus• emergencyEvent• clusterModeStatus• myKey

Overview

Subscribes for 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 very much

dependent on sensors, vehicle architecture and vehicle type. Be also prepared

for the situation that a signal is not available on a vehicle




See SDLUnsubscribeVehicleData SDLGetVehicleData

-init

@abstract Constructs a new SDLSubscribeVehicleData object


@abstract Constructs a new SDLSubscribeVehicleData object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


-


Undocumented

gps

@abstract A boolean value. If true, subscribes Gps data

PARAMETERS

OBJECTIVE-C

@interface SDLSubscribeVehicleData : SDLRPCRequest

OBJECTIVE-C


speed

@abstract A boolean value. If true, subscribes speed data

rpm

@abstract A boolean value. If true, subscribes rpm data

SWIFT


OBJECTIVE-C


SWIFT


fuelLevel

@abstract A boolean value. If true, subscribes FuelLevel data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


SWIFT


fuelLevel_State

@abstract A boolean value. If true, subscribes fuelLevel_State data


@abstract A boolean value. If true, subscribes instantFuelConsumption data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


externalTemperature

@abstract A boolean value. If true, subscribes externalTemperature data

prndl

@abstract A boolean value. If true, subscribes Currently selected gear data

SWIFT


OBJECTIVE-C


SWIFT


tirePressure

@abstract A boolean value. If true, subscribes tire pressure status data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


SWIFT


odometer

@abstract A boolean value. If true, subscribes odometer data

beltStatus

@abstract A boolean value. If true, subscribes belt Status data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


bodyInformation

@abstract A boolean value. If true, subscribes body Information data

deviceStatus

@abstract A boolean value. If true, subscribes device Status data

SWIFT


OBJECTIVE-C


SWIFT


driverBraking

@abstract A boolean value. If true, subscribes driver Braking data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


SWIFT


wiperStatus

@abstract A boolean value. If true, subscribes wiper Status data

headLampStatus

@abstract A boolean value. If true, subscribes Head Lamp Status data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


engineTorque

@abstract A boolean value. If true, subscribes Engine Torque data

accPedalPosition

@abstract A boolean value. If true, means the accPedalPosition data has been

subscribed.

SWIFT


OBJECTIVE-C


SWIFT


steeringWheelAngle

@abstract A boolean value. If true, means the steeringWheelAngle data has

been subscribed.

OBJECTIVE-C


SWIFT


OBJECTIVE-C


eCallInfo

Undocumented

airbagStatus

Undocumented

SWIFT


OBJECTIVE-C


OBJECTIVE-C


emergencyEvent

Undocumented

clusterModeStatus

Undocumented

myKey

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


SDLSubscribeVehicleDataResponseClass Reference

Section Contents

• -init• -initWithDictionary:• gps• speed• rpm• fuelLevel• fuelLevel_State• instantFuelConsumption• externalTemperature• prndl• tirePressure• odometer• beltStatus• bodyInformation• deviceStatus• driverBraking• wiperStatus• headLampStatus• engineTorque• accPedalPosition• steeringWheelAngle• eCallInfo• airbagStatus• emergencyEvent• clusterModes

• myKey

Overview

Subscribe Vehicle Data Response is sent, when SDLSubscribeVehicleData has

been called


-init

@abstract Constructs a new SDLSubscribeVehicleDataResponse object


@abstract Constructs a new SDLSubscribeVehicleDataResponse object


dictionary to use

OBJECTIVE-C


SWIFT

init!()

dict


gps

@abstract A SDLVehicleDataResult* value. See GPSData.

OBJECTIVE-C


SWIFT


PARAMETERS

speed

@abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per

hour.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *gps;

SWIFT

var gps: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *speed;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLVehicleDataResult.html



rpm

@abstract A SDLVehicleDataResult* value. The number of revolutions per

minute of the engine.

fuelLevel

@abstract A SDLVehicleDataResult* value. The fuel level in the tank

(percentage)

SWIFT

var speed: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *rpm;

SWIFT

var rpm: SDLVehicleDataResult! { get set }




fuelLevel_State

@abstract A SDLVehicleDataResult* value. The fuel level state.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *fuelLevel;

SWIFT

var fuelLevel: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *fuelLevel_State;

SWIFT

var fuelLevel_State: SDLVehicleDataResult! { get set }






@abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption

in microlitres.

externalTemperature

@abstract A SDLVehicleDataResult* value. The external temperature in degrees

celsius.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *instantFuelConsumption;

SWIFT

var instantFuelConsumption: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *externalTemperature;




prndl

@abstract A SDLVehicleDataResult* value. See PRNDL.

tirePressure

@abstract A SDLVehicleDataResult* value. See TireStatus.

SWIFT

var externalTemperature: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *prndl;

SWIFT

var prndl: SDLVehicleDataResult! { get set }




odometer

@abstract A SDLVehicleDataResult* value. Odometer in km.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *tirePressure;

SWIFT

var tirePressure: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *odometer;

SWIFT

var odometer: SDLVehicleDataResult! { get set }





beltStatus

@abstract A SDLVehicleDataResult* value. The status of the seat belts.

bodyInformation

@abstract A SDLVehicleDataResult* value. The body information including

power modes.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *beltStatus;

SWIFT

var beltStatus: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *bodyInformation;




deviceStatus

@abstract A SDLVehicleDataResult* value. The device status including signal

and battery strength.

driverBraking


SWIFT

var bodyInformation: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *deviceStatus;

SWIFT

var deviceStatus: SDLVehicleDataResult! { get set }




wiperStatus

@abstract A SDLVehicleDataResult* value. The status of the wipers.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *driverBraking;

SWIFT

var driverBraking: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *wiperStatus;

SWIFT

var wiperStatus: SDLVehicleDataResult! { get set }





headLampStatus

@abstract A SDLVehicleDataResult* value. Status of the head lamps.

engineTorque

@abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on

non-diesel variants.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *headLampStatus;

SWIFT

var headLampStatus: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *engineTorque;




accPedalPosition

@abstract A SDLVehicleDataResult* value. Accelerator pedal position

(percentage depressed)

steeringWheelAngle

@abstract A SDLVehicleDataResult* value. Current angle of the steering wheel

(in deg)

SWIFT

var engineTorque: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *accPedalPosition;

SWIFT

var accPedalPosition: SDLVehicleDataResult! { get set }




eCallInfo

Undocumented

airbagStatus

Undocumented

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *steeringWheelAngle;

SWIFT

var steeringWheelAngle: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@interface SDLSubscribeVehicleDataResponse : SDLRPCResponse



emergencyEvent

Undocumented

clusterModes

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


myKey

Undocumented

SDLSyncMsgVersion Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithMajorVersion:minorVersion:• majorVersion• minorVersion

Overview

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

OBJECTIVE-C


-init

@abstract Constructs a newly allocated SDLSyncMsgVersion object


@abstract Constructs a newly allocated SDLSyncMsgVersion object indicated by

the dictionary parameter - parameter: dict The dictionary to use

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


-initWithMajorVersion:minorVersion:

Undocumented

majorVersion

@abstract The major version indicates versions that is not-compatible to

previous versions


SWIFT


PARAMETERS

OBJECTIVE-C

@interface SDLSyncMsgVersion : SDLRPCStruct

minorVersion

@abstract The minor version indicates a change to a previous version that

should still allow to be run on an older version (with limited functionality)


OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *majorVersion;

SWIFT

var majorVersion: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *minorVersion;

SDLSyncPData Class Reference

Section Contents


Overview

Undocumented

-init

Undocumented


Undocumented

SWIFT

var minorVersion: NSNumber! { get set }

SDLSyncPDataResponse ClassReference

Section Contents


Overview

Undocumented

-init

Undocumented


Undocumented

SDLSystemAction Class Reference

Section Contents

• +valueOf:• +values• +DEFAULT_ACTION• +STEAL_FOCUS• +KEEP_CONTEXT

Overview

Enumeration that describes system actions that can be triggered.

+valueOf:

Convert String to SDLSystemAction - parameter: value String - returns:

SDLSystemAction

value

String

OBJECTIVE-C

+ (SDLSystemAction *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLSystemAction!

PARAMETERS

SDLSystemAction

+values

@abstract Store the enumeration of all possible SDLSystemAction - returns: an

array that store all possible SDLSystemAction

an array that store all possible SDLSystemAction

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+DEFAULT_ACTION

@abstract Default_Action

+STEAL_FOCUS

@abstract Steal_Focus

OBJECTIVE-C

+ (SDLSystemAction *)DEFAULT_ACTION;

SWIFT

class func default_() -> SDLSystemAction!

OBJECTIVE-C

+ (SDLSystemAction *)STEAL_FOCUS;

+KEEP_CONTEXT

@abstract Keep_Context

SWIFT

class func steal_FOCUS() -> SDLSystemAction!

OBJECTIVE-C

+ (SDLSystemAction *)KEEP_CONTEXT;

SWIFT

class func keep_CONTEXT() -> SDLSystemAction!

SDLSystemContext Class Reference

Section Contents

• +valueOf:• +values• +MAIN• +VRSESSION• +MENU• +HMI_OBSCURED• +ALERT

Overview

Indicates whether or not a user-initiated interaction is in progress, and if so, in

what mode (i.e. MENU or VR).

@since SDL 1.0

+valueOf:

Convert String to SDLSystemContext

OBJECTIVE-C

+ (SDLSystemContext *)valueOf:(NSString *)value;

value


SDLSystemContext

+values

@abstract Store the enumeration of all possible SDLSystemContext

SWIFT

class func value(of value: String!) -> SDLSystemContext!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


an array that store all possible SDLSystemContext

+MAIN

@abstract No user interaction (user-initiated or app-initiated) is in progress.

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLSystemContext *)MAIN;

SWIFT

class func main() -> SDLSystemContext!

SDLSystemContext object of value MAIN

+VRSESSION

@abstract VR-oriented, user-initiated or app-initiated interaction is in-progress.

SDLSystemContext object of value VRSESSION

RETURN VALUE

OBJECTIVE-C

+ (SDLSystemContext *)VRSESSION;

SWIFT

class func vrsession() -> SDLSystemContext!

RETURN VALUE

+MENU

@abstract Menu-oriented, user-initiated or app-initiated interaction is in-

progress.

SDLSystemContext object of value MENU

+HMI_OBSCURED

@abstract The app’s display HMI is currently being obscured by either a system

or other app’s overlay.

@since SDL 2.0

OBJECTIVE-C

+ (SDLSystemContext *)MENU;

SWIFT

class func menu() -> SDLSystemContext!

RETURN VALUE

SDLSystemContext object of value HMI_OBSCURED

+ALERT

@abstract Broadcast only to whichever app has an alert currently being

displayed.

@since SDL 2.0

OBJECTIVE-C

+ (SDLSystemContext *)HMI_OBSCURED;

SWIFT

class func hmi_OBSCURED() -> SDLSystemContext!

RETURN VALUE

OBJECTIVE-C

+ (SDLSystemContext *)ALERT;

SDLSystemContext object of value ALERT

SDLTBTState Class Reference

Section Contents

• +valueOf:• +values• +ROUTE_UPDATE_REQUEST• +ROUTE_ACCEPTED• +ROUTE_REFUSED• +ROUTE_CANCELLED• +ETA_REQUEST• +NEXT_TURN_REQUEST• +ROUTE_STATUS_REQUEST• +ROUTE_SUMMARY_REQUEST• +TRIP_STATUS_REQUEST

SWIFT

class func alert() -> SDLSystemContext!

RETURN VALUE

• +ROUTE_UPDATE_REQUEST_TIMEOUT

Overview

Undocumented

+valueOf:

Undocumented

+values

Undocumented

+ROUTE_UPDATE_REQUEST

Undocumented

+ROUTE_ACCEPTED

Undocumented

+ROUTE_REFUSED

Undocumented

+ROUTE_CANCELLED

Undocumented

+ETA_REQUEST

Undocumented

+NEXT_TURN_REQUEST

Undocumented

+ROUTE_STATUS_REQUEST

Undocumented

+ROUTE_SUMMARY_REQUEST

Undocumented

+TRIP_STATUS_REQUEST

Undocumented

+ROUTE_UPDATE_REQUEST_TIMEOUT

Undocumented

SDLTCPTransport Class Reference

Section Contents

• socket• hostName• portNumber

Overview

Undocumented

socket

Undocumented

hostName

Undocumented

portNumber

Undocumented

SDLTTSChunk Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithText:type:• +textChunksFromString:• +sapiChunksFromString:• +lhPlusChunksFromString:• +prerecordedChunksFromString:• +silenceChunks• text• type

Overview

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.

Parameter List



-init

@abstract Constructs a newly allocated SDLTTSChunk object

text String

Text to be spoken,or a phonemespecification, orthe name of apre-recordedsound. Thecontents of thisfield are indicatedby the “type”field.

SmartDeviceLink 1.0

type SpeechCapabilities

Indicates the typeof information inthe “text” field(e.g. phrase to bespoken, phonemespecification,name of pre-recorded sound).

SmartDeviceLink 1.0

http://en.wikipedia.org/wiki/Phoneme




@abstract Constructs a newly allocated SDLTTSChunk object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


-initWithText:type:

Undocumented

+textChunksFromString:

Undocumented

PARAMETERS

OBJECTIVE-C

@interface SDLTTSChunk : SDLRPCStruct

OBJECTIVE-C


+sapiChunksFromString:

Undocumented

+lhPlusChunksFromString:

Undocumented

+prerecordedChunksFromString:

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


+silenceChunks

Undocumented

text

@abstract Text to be spoken, or a phoneme specification, or the name of a pre-

recorded sound. The contents of this field are indicated by the “type” field.

Required, Max length 500

OBJECTIVE-C


OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *text;

SWIFT

var text: String! { get set }

type

@abstract The type of information in the “text” field (e.g. phrase to be spoken,

phoneme specification, name of pre-recorded sound).

Required

SDLTTSChunkFactory Class Reference

Section Contents

• +buildTTSChunkForString:type:

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLSpeechCapabilities *type;

SWIFT

var type: SDLSpeechCapabilities! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLSpeechCapabilities.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLSpeechCapabilities.html

• +buildTTSChunksFromSimple:

Overview

Undocumented

+buildTTSChunkForString:type:

Undocumented

+buildTTSChunksFromSimple:

Undocumented

SDLTextAlignment Class Reference

Section Contents

• +valueOf:• +values• +LEFT_ALIGNED• +RIGHT_ALIGNED• +CENTERED

Overview

The list of possible alignments of text in a field. May only work on some display

types.

@since SDL 1.0

+valueOf:

Convert String to SDLTextAlignment

value


SDLTextAlignment

OBJECTIVE-C

+ (SDLTextAlignment *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLTextAlignment!

PARAMETERS

RETURN VALUE

+values

@abstract Store the enumeration of all possible SDLTextAlignment

an array that store all possible SDLTextAlignment

+LEFT_ALIGNED

@abstract Text aligned left.

OBJECTIVE-C


SWIFT


RETURN VALUE

A SDLTextAlignment object with value of LEFT_ALIGNED

+RIGHT_ALIGNED

@abstract Text aligned right.

OBJECTIVE-C

+ (SDLTextAlignment *)LEFT_ALIGNED;

SWIFT

class func left_ALIGNED() -> SDLTextAlignment!

RETURN VALUE

OBJECTIVE-C

+ (SDLTextAlignment *)RIGHT_ALIGNED;

A SDLTextAlignment object with value of RIGHT_ALIGNED

+CENTERED

@abstract Text aligned centered.

SWIFT

class func right_ALIGNED() -> SDLTextAlignment!

RETURN VALUE

OBJECTIVE-C

+ (SDLTextAlignment *)CENTERED;

SWIFT

class func centered() -> SDLTextAlignment!

A SDLTextAlignment object with value of CENTERED

SDLTextField Class Reference

Section Contents

• -init• -initWithDictionary:• name• characterSet• width• rows

Overview

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

Parameter List

RETURN VALUE


@since SDL 1.0

-init

@abstract Constructs a newly allocated SDLTextField object

name TextFieldNameEnumerationidentifying thefield.

SDL 1.0

characterSet CharacterSetThe character setthat is supportedin this field.

SDL 1.0

width Int16

The number ofcharacters in onerow of this field.

• Minvalue

=“1”• maxvalu

e=“500”

SDL 1.0

rows Int16

The number ofrows for this textfield.

• Minvalue

=“1”• maxvalu

e=“3”

SDL 1.0

OBJECTIVE-C



@abstract Constructs a newly allocated SDLTextField object indicated by the


dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS

The dictionary to use to construct the object

name

@abstract The enumeration identifying the field.

SeeSDLTextFieldName Required

characterSet

@abstract The character set that is supported in this field.

SeeSDLCharacterSet Required

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLTextFieldName *name;

SWIFT

var name: SDLTextFieldName! { get set }

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLTextFieldName.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLTextFieldName.html

width

@abstract The number of characters in one row of this field.


OBJECTIVE-C

@property (readwrite, strong, atomic) SDLCharacterSet *characterSet;

SWIFT

var characterSet: SDLCharacterSet! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *width;

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLCharacterSet.html

https://d83tozu1c8tt6.cloudfront.net/Classes/SDLCharacterSet.html

rows

@abstract The number of rows for this text field.


SWIFT

var width: NSNumber! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *rows;

SWIFT

var rows: NSNumber! { get set }

SDLTextFieldName Class Reference

Section Contents

• +valueOf:• +values• +mainField1• +mainField2• +mainField3• +mainField4• +statusBar• +mediaClock• +mediaTrack• +alertText1• +alertText2• +alertText3• +scrollableMessageBody• +initialInteractionText• +navigationText1• +navigationText2• +ETA• +totalDistance• +audioPassThruDisplayText1• +audioPassThruDisplayText2• +sliderHeader• +sliderFooter• +menuName• +secondaryText• +tertiaryText• +menuTitle• +locationName• +locationDescription• +addressLines• +phoneNumber

Overview

Names of the text fields that can appear on a SDL display.

@since SDL 1.0

+valueOf:

Convert String to SDLTextFieldName

value


OBJECTIVE-C

+ (SDLTextFieldName *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLTextFieldName!

PARAMETERS

SDLTextFieldName

+values

@abstract Store the enumeration of all possible SDLTextFieldName

an array that store all possible SDLTextFieldName

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+mainField1

@abstract The first line of the first set of main fields of the persistent display.

Applies to SDLShow.

a SDLTextFieldName with value of mainField1

+mainField2

@abstract The second line of the first set of main fields of the persistent

display. Applies to SDLShow.

@since SDL 2.0

OBJECTIVE-C

+ (SDLTextFieldName *)mainField1;

SWIFT

class func mainField1() -> SDLTextFieldName!

RETURN VALUE


+mainField3

@abstract The first line of the second set of main fields of the persistent


@since SDL 2.0

OBJECTIVE-C


SWIFT


RETURN VALUE

OBJECTIVE-C



+mainField4

@abstract The second line of the second set of main fields of the persistent


SWIFT


RETURN VALUE

OBJECTIVE-C


SWIFT



+statusBar

@abstract The status bar on the NGN display. Applies to SDLShow.

a SDLTextFieldName with value of statusBar

RETURN VALUE

OBJECTIVE-C

+ (SDLTextFieldName *)statusBar;

SWIFT

class func statusBar() -> SDLTextFieldName!

RETURN VALUE

+mediaClock

@abstract Text value for MediaClock field. Must be properly formatted

according to MediaClockFormat. Applies to SDLShow.

@discussion This field is commonly used to show elapsed or remaining time in

an audio track or audio capture.

a SDLTextFieldName with value of mediaClock

+mediaTrack

@abstract The track field of NGN type ACMs. This field is only available for

media applications on a NGN display. Applies to SDLShow.

OBJECTIVE-C

+ (SDLTextFieldName *)mediaClock;

SWIFT

class func mediaClock() -> SDLTextFieldName!

RETURN VALUE

@discussion This field is commonly used to show the current track number

a SDLTextFieldName with value of mediaTrack

+alertText1

@abstract The first line of the alert text field. Applies to SDLAlert.

OBJECTIVE-C

+ (SDLTextFieldName *)mediaTrack;

SWIFT

class func mediaTrack() -> SDLTextFieldName!

RETURN VALUE

OBJECTIVE-C

+ (SDLTextFieldName *)alertText1;

a SDLTextFieldName with value of alertText1

+alertText2

@abstract The second line of the alert text field. Applies to SDLAlert.

@since SDL 2.0

SWIFT

class func alertText1() -> SDLTextFieldName!

RETURN VALUE

OBJECTIVE-C


SWIFT



+alertText3

@abstract The third line of the alert text field. Applies to SDLAlert.

@since SDL 2.0


RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+scrollableMessageBody

@abstract Long form body of text that can include newlines and tabs. Applies

to SDLScrollableMessage.

@since SDL 2.0

a SDLTextFieldName with value of scrollableMessageBody

+initialInteractionText

@abstract First line suggestion for a user response (in the case of VR enabled

interaction).

@since SDL 2.0

OBJECTIVE-C

+ (SDLTextFieldName *)scrollableMessageBody;

SWIFT

class func scrollableMessageBody() -> SDLTextFieldName!

RETURN VALUE

a SDLTextFieldName with value of initialInteractionText

+navigationText1

@abstract First line of navigation text.

@since SDL 2.0

OBJECTIVE-C

+ (SDLTextFieldName *)initialInteractionText;

SWIFT

class func initialInteractionText() -> SDLTextFieldName!

RETURN VALUE

OBJECTIVE-C

+ (SDLTextFieldName *)navigationText1;

a SDLTextFieldName with value of navigationText1

+navigationText2

@abstract Second line of navigation text.

@since SDL 2.0

SWIFT

class func navigationText1() -> SDLTextFieldName!

RETURN VALUE

OBJECTIVE-C

+ (SDLTextFieldName *)navigationText2;

SWIFT

class func navigationText2() -> SDLTextFieldName!

a SDLTextFieldName with value of navigationText2

+ETA

@abstract Estimated Time of Arrival time for navigation.

@since SDL 2.0

a SDLTextFieldName with value of ETA

RETURN VALUE

OBJECTIVE-C

+ (SDLTextFieldName *)ETA;

SWIFT

class func eta() -> SDLTextFieldName!

RETURN VALUE

+totalDistance

@abstract Total distance to destination for navigation.

@since SDL 2.0

a SDLTextFieldName with value of totalDistance

+audioPassThruDisplayText1

@abstract First line of text for audio pass thru.

@since SDL 2.0

OBJECTIVE-C

+ (SDLTextFieldName *)totalDistance;

SWIFT

class func totalDistance() -> SDLTextFieldName!

RETURN VALUE

a SDLTextFieldName with value of audioPassThruDisplayText1

+audioPassThruDisplayText2

@abstract Second line of text for audio pass thru.

@since SDL 2.0

OBJECTIVE-C

+ (SDLTextFieldName *)audioPassThruDisplayText1;

SWIFT

class func audioPassThruDisplayText1() -> SDLTextFieldName!

RETURN VALUE

OBJECTIVE-C

+ (SDLTextFieldName *)audioPassThruDisplayText2;

a SDLTextFieldName with value of audioPassThruDisplayText2

+sliderHeader

@abstract Header text for slider.

@since SDL 2.0

SWIFT

class func audioPassThruDisplayText2() -> SDLTextFieldName!

RETURN VALUE

OBJECTIVE-C

+ (SDLTextFieldName *)sliderHeader;

SWIFT

class func sliderHeader() -> SDLTextFieldName!

a SDLTextFieldName with value of sliderHeader

+sliderFooter

@abstract Footer text for slider

@since SDL 2.0

a SDLTextFieldName with value of sliderFooter

RETURN VALUE

OBJECTIVE-C

+ (SDLTextFieldName *)sliderFooter;

SWIFT

class func sliderFooter() -> SDLTextFieldName!

RETURN VALUE

+menuName

Primary text for SDLChoice

a SDLTextFieldName with value of menuName

+secondaryText

Secondary text for SDLChoice

OBJECTIVE-C

+ (SDLTextFieldName *)menuName;

SWIFT

class func menu() -> SDLTextFieldName!

RETURN VALUE

a SDLTextFieldName with value of secondaryText

+tertiaryText

Tertiary text for SDLChoice

OBJECTIVE-C

+ (SDLTextFieldName *)secondaryText;

SWIFT

class func secondaryText() -> SDLTextFieldName!

RETURN VALUE

OBJECTIVE-C

+ (SDLTextFieldName *)tertiaryText;

a SDLTextFieldName with value of tertiaryText

+menuTitle

Optional text to label an app menu button (for certain touchscreen platforms)

SWIFT

class func tertiaryText() -> SDLTextFieldName!

RETURN VALUE

OBJECTIVE-C

+ (SDLTextFieldName *)menuTitle;

SWIFT

class func menuTitle() -> SDLTextFieldName!

a SDLTextFieldName with value of menuTitle

+locationName

Optional name / title of intended location for SDLSendLocation

@since SDL 4.0

a SDLTextFieldName with value of locationName

RETURN VALUE

OBJECTIVE-C

+ (SDLTextFieldName *)locationName;

SWIFT

class func location() -> SDLTextFieldName!

RETURN VALUE

+locationDescription

Optional description of intended location / establishment (if applicable) for

SDLSendLocation

@since SDL 4.0

a SDLTextFieldName with value of locationDescription

+addressLines

Optional location address (if applicable) for SDLSendLocation

@since SDL 4.0

OBJECTIVE-C

+ (SDLTextFieldName *)locationDescription;

SWIFT

class func locationDescription() -> SDLTextFieldName!

RETURN VALUE

a SDLTextFieldName with value of addressLines

+phoneNumber

Optional hone number of intended location / establishment (if applicable) for

SDLSendLocation

@since SDL 4.0

OBJECTIVE-C

+ (SDLTextFieldName *)addressLines;

SWIFT

class func addressLines() -> SDLTextFieldName!

RETURN VALUE

OBJECTIVE-C

+ (SDLTextFieldName *)phoneNumber;

a SDLTextFieldName with value of phoneNumber

SDLTimerMode Class Reference

Section Contents

• +valueOf:• +values• +UP• +DOWN• +NONE

Overview

Undocumented

+valueOf:

Undocumented

SWIFT

class func phoneNumber() -> SDLTextFieldName!

RETURN VALUE

+values

Undocumented

+UP

Undocumented

+DOWN

Undocumented

+NONE

Undocumented

SDLTireStatus Class Reference

Section Contents

• -init• -initWithDictionary:• pressureTelltale• leftFront• rightFront• leftRear• rightRear• innerLeftRear

• innerRightRear

Overview

Undocumented

-init

Undocumented


Undocumented

pressureTelltale

Undocumented

leftFront

Undocumented

rightFront

Undocumented

leftRear

Undocumented

rightRear

Undocumented

innerLeftRear

Undocumented

innerRightRear

Undocumented

SDLTouchCoord Class Reference

Section Contents

• -init• -initWithDictionary:• x• y

Overview

Undocumented

-init

Undocumented


Undocumented

x

Undocumented

y

Undocumented

SDLTouchEvent Class Reference

Section Contents

• -init• -initWithDictionary:• touchEventId• timeStamp• coord

Overview

Undocumented

-init

Undocumented


Undocumented

touchEventId

A touch’s unique identifier. The application can track the current touch events

by id. If a touch event has type begin, the id should be added to the set of

touches. If a touch event has type end, the id should be removed from the set

of touches.

Mandatory, 0-9

timeStamp

The time that the touch was recorded. This number can the time since the

beginning of the session or something else as long as the units are in

milliseconds.

The timestamp is used to determined the rate of change of position of a touch.

The application also uses the time to verify whether two touches, with different

ids, are part of a single action by the user.

OBJECTIVE-C

@property (readwrite, strong, atomic) NSNumber *touchEventId;

SWIFT

var touchEventId: NSNumber! { get set }

If there is only a single timestamp in this array, it is the same for every

coordinate in the coordinates array.

Mandatory, array size 1-1000, contains size 0-5000000000

coord

Mandatory, array size 1-1000, contains SDLTouchCoord

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *timeStamp;

SWIFT

var timeStamp: NSMutableArray! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *coord;

SDLTouchEventCapabilities ClassReference

Section Contents

• -init• -initWithDictionary:• pressAvailable• multiTouchAvailable• doublePressAvailable

Overview

Undocumented

-init

Undocumented


Undocumented

SWIFT

var coord: NSMutableArray! { get set }

pressAvailable

Undocumented

multiTouchAvailable

Undocumented

doublePressAvailable

Undocumented

SDLTouchManager Class Reference

Section Contents

• touchEventDelegate• tapDistanceThreshold• tapTimeThreshold• movementTimeThreshold• touchEnabled• -cancelPendingTouches

Overview

Undocumented

touchEventDelegate

Undocumented

tapDistanceThreshold

@abstract Distance between two taps on the screen, in the head unit’s

coordinate system, used for registering double-tap callbacks. @remark Default

is 50 pixels.

tapTimeThreshold

@abstract Time (in seconds) between tap events to register a double-tap

callback. @remark Default is 0.4 seconds.

movementTimeThreshold

@abstract Time (in seconds) between movement events to register panning or

pinching callbacks. @remark Default is 0.05 seconds.

OBJECTIVE-C

@property (assign, readwrite, nonatomic) CGFloat tapDistanceThreshold;

OBJECTIVE-C

@property (assign, readwrite, nonatomic) CGFloat tapTimeThreshold;

touchEnabled

@abstract Boolean denoting whether or not the touch manager should deliver

touch event callbacks. @remark Default is true.

-cancelPendingTouches

@abstract Cancels pending touch event timers that may be in progress.

@remark Currently only impacts the timer used to register single taps.

OBJECTIVE-C

@property (assign, readwrite, nonatomic) CGFloat movementTimeThreshold;

OBJECTIVE-C

@property (getter=isTouchEnabled, assign, readwrite, nonatomic) BOOL touchEnabled;

OBJECTIVE-C

- (void)cancelPendingTouches;

SDLTouchType Class Reference

Section Contents

• +valueOf:• +values• +BEGIN• +MOVE• +END

Overview

Undocumented

+valueOf:

Undocumented

+values

Undocumented

+BEGIN

Undocumented

+MOVE

Undocumented

+END

Undocumented

SDLTriggerSource Class Reference

Section Contents

• +valueOf:• +values• +MENU• +VR• +KEYBOARD

Overview

Indicates whether choice/command was selected via VR or via a menu selection

(using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN, OK buttons)

@since SDL 1.0

+valueOf:

Convert String to SDLTriggerSource - parameter: value The value of the string to

get an object for - returns: SDLTriggerSource

OBJECTIVE-C

+ (SDLTriggerSource *)valueOf:(NSString *)value;

value


SDLTriggerSource

+values

@abstract Store the enumeration of all possible SDLTriggerSource - returns: an

array that store all possible SDLTriggerSource

SWIFT

class func value(of value: String!) -> SDLTriggerSource!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


an array that store all possible SDLTriggerSource

+MENU

@abstract Selection made via menu - returns: SDLTriggerSource with value of

MENU

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLTriggerSource *)MENU;

SWIFT

class func menu() -> SDLTriggerSource!

SDLTriggerSource with value of MENU

+VR

@abstract Selection made via Voice session - returns: SDLTriggerSource with

value of VR

SDLTriggerSource with value of VR

RETURN VALUE

OBJECTIVE-C

+ (SDLTriggerSource *)VR;

SWIFT

class func vr() -> SDLTriggerSource!

RETURN VALUE

+KEYBOARD

@abstract Selection made via Keyboard - returns: SDLTriggerSource with value

of KEYBOARD

SDLTriggerSource with value of KEYBOARD

OBJECTIVE-C

+ (SDLTriggerSource *)KEYBOARD;

SWIFT

class func keyboard() -> SDLTriggerSource!

RETURN VALUE

SDLTurn Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithNavigationText:turnIcon:• navigationText• turnIcon

Overview

Undocumented

-init

Undocumented


Undocumented

-initWithNavigationText:turnIcon:

Undocumented

navigationText

Undocumented

turnIcon

Undocumented

SDLUnregisterAppInterface ClassReference

Section Contents


Overview

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

-init

@abstract Constructs a new SDLUnregisterAppInterface object


@abstract Constructs a new SDLUnregisterAppInterface object indicated by the


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


SWIFT


dict


SDLUnregisterAppInterfaceResponseClass Reference

Section Contents


Overview

Unregister AppInterface Response is sent, when SDLUnregisterAppInterface has

been called


-init

@abstract Constructs a new SDLUnregisterAppInterfaceResponse object

PARAMETERS


@abstract Constructs a new SDLUnregisterAppInterfaceResponse object


dictionary to use

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


SDLUnsubscribeButton Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithButtonName:• buttonName

Overview

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

SWIFT


PARAMETERS



See SDLSubscribeButton

-init

@abstract Constructs a new SDLUnsubscribeButton object


@abstract Constructs a new SDLUnsubscribeButton object indicated by the


OBJECTIVE-C


SWIFT

init!()

dict


-initWithButtonName:

Undocumented

OBJECTIVE-C


SWIFT


PARAMETERS

OBJECTIVE-C

@interface SDLUnsubscribeButton : SDLRPCRequest

buttonName

@abstract A name of the button to unsubscribe from @discussion An

Enumeration value, see SDLButtonName

SDLUnsubscribeButtonResponse ClassReference

Section Contents

• -init

OBJECTIVE-C


SWIFT





Overview

Unsubscribe Button Response is sent, when SDLUnsubscribeButton has been

called


-init

@abstract Constructs a new SDLUnsubscribeButtonResponse object


@abstract Constructs a new SDLUnsubscribeButtonResponse object indicated


OBJECTIVE-C


SWIFT

init!()

dict


SDLUnsubscribeVehicleData ClassReference

Section Contents

• -init

OBJECTIVE-C


SWIFT


PARAMETERS

• -initWithDictionary:• -

initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:• gps• speed• rpm• fuelLevel• fuelLevel_State• instantFuelConsumption• externalTemperature• prndl• tirePressure• odometer• beltStatus• bodyInformation• deviceStatus• driverBraking• wiperStatus• headLampStatus• engineTorque• accPedalPosition• steeringWheelAngle• eCallInfo• airbagStatus• emergencyEvent• clusterModeStatus• myKey

Overview

This function is used to unsubscribe the notifications from the

subscribeVehicleData function




See SDLSubscribeVehicleData SDLGetVehicleData

-init

@abstract Constructs a new SDLUnsubscribeVehicleData object


@abstract Constructs a new SDLUnsubscribeVehicleData object indicated by


OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


-


Undocumented

gps

@abstract A boolean value. If true, unsubscribes Gps data

SWIFT


PARAMETERS

OBJECTIVE-C

@interface SDLUnsubscribeVehicleData : SDLRPCRequest

speed

@abstract A boolean value. If true, unsubscribes speed data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


SWIFT


rpm

@abstract A boolean value. If true, unsubscribe data

fuelLevel

@abstract A boolean value. If true, unsubscribes FuelLevel data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


fuelLevel_State

@abstract A boolean value. If true, unsubscribes fuelLevel_State data


@abstract A boolean value. If true, unsubscribes instantFuelConsumption data

SWIFT


OBJECTIVE-C


SWIFT


externalTemperature

@abstract A boolean value. If true, unsubscribes externalTemperature data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


SWIFT


prndl

@abstract A boolean value. If true, unsubscribes Currently selected gear data

tirePressure

@abstract A boolean value. If true, unsubscribes tire pressure status data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


odometer

@abstract A boolean value. If true, unsubscribes odometer data

beltStatus

@abstract A boolean value. If true, unsubscribes belt Status data

SWIFT


OBJECTIVE-C


SWIFT


bodyInformation

@abstract A boolean value. If true, unsubscribes body Information data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


SWIFT


deviceStatus

@abstract A boolean value. If true, unsubscribes device Status data

driverBraking

@abstract A boolean value. If true, unsubscribes driver Braking data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


wiperStatus

@abstract A boolean value. If true, unsubscribes wiper Status data

headLampStatus

@abstract A boolean value. If true, unsubscribes Head Lamp Status data

SWIFT


OBJECTIVE-C


SWIFT


engineTorque

@abstract A boolean value. If true, unsubscribes Engine Torque data

OBJECTIVE-C


SWIFT


OBJECTIVE-C


SWIFT


accPedalPosition

@abstract A boolean value. If true, unsubscribes accPedalPosition data

steeringWheelAngle

Undocumented

OBJECTIVE-C


SWIFT


OBJECTIVE-C


eCallInfo

Undocumented

airbagStatus

Undocumented

emergencyEvent

Undocumented

OBJECTIVE-C


OBJECTIVE-C


OBJECTIVE-C


clusterModeStatus

Undocumented

myKey

Undocumented

SDLUnsubscribeVehicleDataResponseClass Reference

Section Contents

• -init

OBJECTIVE-C


OBJECTIVE-C


• -initWithDictionary:• gps• speed• rpm• fuelLevel• fuelLevel_State• instantFuelConsumption• externalTemperature• prndl• tirePressure• odometer• beltStatus• bodyInformation• deviceStatus• driverBraking• wiperStatus• headLampStatus• engineTorque• accPedalPosition• steeringWheelAngle• eCallInfo• airbagStatus• emergencyEvent• clusterModes• myKey

Overview

Unsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has

been called


-init

@abstract Constructs a new SDLUnsubscribeVehicleDataResponse object


@abstract Constructs a new SDLUnsubscribeVehicleDataResponse object


dictionary to use

OBJECTIVE-C


SWIFT

init!()

OBJECTIVE-C


dict


gps

@abstract A SDLVehicleDataResult* value. See GPSData.

SWIFT


PARAMETERS

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *gps;

SWIFT

var gps: SDLVehicleDataResult! { get set }



speed

@abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per

hour.

rpm

@abstract A SDLVehicleDataResult* value. The number of revolutions per

minute of the engine.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *speed;

SWIFT

var speed: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *rpm;




fuelLevel

@abstract A SDLVehicleDataResult* value. The fuel level in the tank

(percentage)

fuelLevel_State

@abstract A SDLVehicleDataResult* value. The fuel level state.

SWIFT

var rpm: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *fuelLevel;

SWIFT

var fuelLevel: SDLVehicleDataResult! { get set }





@abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption

in microlitres.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *fuelLevel_State;

SWIFT

var fuelLevel_State: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *instantFuelConsumption;




externalTemperature

@abstract A SDLVehicleDataResult* value. The external temperature in degrees

celsius.

prndl

@abstract A SDLVehicleDataResult* value. See PRNDL.

SWIFT

var instantFuelConsumption: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *externalTemperature;

SWIFT

var externalTemperature: SDLVehicleDataResult! { get set }




tirePressure

@abstract A SDLVehicleDataResult* value. See TireStatus.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *prndl;

SWIFT

var prndl: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *tirePressure;

SWIFT

var tirePressure: SDLVehicleDataResult! { get set }





odometer

@abstract A SDLVehicleDataResult* value. Odometer in km.

beltStatus

@abstract A SDLVehicleDataResult* value. The status of the seat belts.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *odometer;

SWIFT

var odometer: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *beltStatus;




bodyInformation

@abstract A SDLVehicleDataResult* value. The body information including

power modes.

deviceStatus

@abstract A SDLVehicleDataResult* value. The device status including signal

and battery strength.

SWIFT

var beltStatus: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *bodyInformation;

SWIFT

var bodyInformation: SDLVehicleDataResult! { get set }




driverBraking


OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *deviceStatus;

SWIFT

var deviceStatus: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *driverBraking;

SWIFT

var driverBraking: SDLVehicleDataResult! { get set }





wiperStatus

@abstract A SDLVehicleDataResult* value. The status of the wipers.

headLampStatus

@abstract A SDLVehicleDataResult* value. Status of the head lamps.

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *wiperStatus;

SWIFT

var wiperStatus: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *headLampStatus;




engineTorque

@abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on

non-diesel variants.

accPedalPosition

@abstract A SDLVehicleDataResult* value. Accelerator pedal position

(percentage depressed)

SWIFT

var headLampStatus: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *engineTorque;

SWIFT

var engineTorque: SDLVehicleDataResult! { get set }




steeringWheelAngle

@abstract A SDLVehicleDataResult* value. Current angle of the steering wheel

(in deg)

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *accPedalPosition;

SWIFT

var accPedalPosition: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) SDLVehicleDataResult *steeringWheelAngle;




eCallInfo

Undocumented

airbagStatus

Undocumented

SWIFT

var steeringWheelAngle: SDLVehicleDataResult! { get set }

OBJECTIVE-C

@interface SDLUnsubscribeVehicleDataResponse : SDLRPCResponse

OBJECTIVE-C



emergencyEvent

Undocumented

clusterModes

Undocumented

myKey

Undocumented

OBJECTIVE-C


OBJECTIVE-C


SDLUpdateMode Class Reference

Section Contents

• +valueOf:• +values• +COUNTUP• +COUNTDOWN• +PAUSE• +RESUME• +CLEAR

Overview

Specifies what function should be performed on the media clock/counter

@since SDL 1.0

+valueOf:

Convert String to SDLUpdateMode - parameter: value The value of the string to

get an object for - returns: SDLUpdateMode

OBJECTIVE-C


value


SDLUpdateMode

OBJECTIVE-C

+ (SDLUpdateMode *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLUpdateMode!

PARAMETERS

RETURN VALUE

+values

@abstract Store the enumeration of all possible SDLUpdateMode - returns: an

array that store all possible SDLUpdateMode

an array that store all possible SDLUpdateMode

+COUNTUP

@abstract Starts the media clock timer counting upward, in increments of 1

second. - returns: SDLUpdateMode with value of COUNTUP

OBJECTIVE-C


SWIFT


RETURN VALUE

SDLUpdateMode with value of COUNTUP

+COUNTDOWN

@abstract Starts the media clock timer counting downward, in increments of 1

second. - returns: SDLUpdateMode with value of COUNTDOWN

OBJECTIVE-C

+ (SDLUpdateMode *)COUNTUP;

SWIFT

class func countup() -> SDLUpdateMode!

RETURN VALUE

OBJECTIVE-C

+ (SDLUpdateMode *)COUNTDOWN;

SDLUpdateMode with value of COUNTDOWN

+PAUSE

@abstract Pauses the media clock timer. - returns: SDLUpdateMode with value

of PAUSE

SWIFT

class func countdown() -> SDLUpdateMode!

RETURN VALUE

OBJECTIVE-C

+ (SDLUpdateMode *)PAUSE;

SWIFT

class func pause() -> SDLUpdateMode!

SDLUpdateMode with value of PAUSE

+RESUME

@abstract Resumes the media clock timer. The timer resumes counting in

whatever mode was in effect before pausing (i.e. COUNTUP or COUNTDOWN). -

returns: SDLUpdateMode with value of RESUME

SDLUpdateMode with value of RESUME

RETURN VALUE

OBJECTIVE-C

+ (SDLUpdateMode *)RESUME;

SWIFT

class func resume() -> SDLUpdateMode!

RETURN VALUE

+CLEAR

@abstract Clear the media clock timer.

SDLUpdateTurnList Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithTurnList:softButtons:• turnList

OBJECTIVE-C

+ (SDLUpdateMode *)CLEAR;

SWIFT

class func clear() -> SDLUpdateMode!

• softButtons

Overview

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

-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLUpdateTurnList : SDLRPCRequest

OBJECTIVE-C


-initWithTurnList:softButtons:

Undocumented

turnList

Optional, SDLTurn, 1 - 100 entries

OBJECTIVE-C


OBJECTIVE-C

@property (readwrite, strong, atomic) NSMutableArray *turnList;

SWIFT

var turnList: NSMutableArray! { get set }

softButtons

Required, SDLSoftButton, 0 - 1 Entries

SDLUpdateTurnListResponse ClassReference

Section Contents

• -init

OBJECTIVE-C


SWIFT



Overview

SDLUpdateTurnListResponse is sent, when SDLUpdateTurnList has been called. *

SinceSmartDeviceLink 2.0

-init

Undocumented


Undocumented

OBJECTIVE-C

@interface SDLUpdateTurnListResponse : SDLRPCResponse

OBJECTIVE-C

@interface SDLUpdateTurnListResponse : SDLRPCResponse

SDLVRCapabilities Class Reference

Section Contents

• +valueOf:• +values• +TEXT

Overview

The VR capabilities of the connected SDL platform.

@since SDL 1.0

+valueOf:

Convert String to SDLVRCapabilities - parameter: value The value of the string

to get an object for - returns: SDLVRCapabilities

OBJECTIVE-C

+ (SDLVRCapabilities *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLVRCapabilities!

value


SDLVRCapabilities

+values

@abstract Store the enumeration of all possible SDLVRCapabilities - returns: an

array that store all possible SDLVRCapabilities

PARAMETERS

RETURN VALUE

OBJECTIVE-C


SWIFT


an array that store all possible SDLVRCapabilities

+TEXT

@abstract The SDL platform is capable of recognizing spoken text in the current

language. - returns: an SDLVRCapabilities instance pointer with value of TEXT

an SDLVRCapabilities instance pointer with value of TEXT

RETURN VALUE

OBJECTIVE-C

+ (SDLVRCapabilities *)TEXT;

SWIFT

class func text() -> SDLVRCapabilities!

RETURN VALUE

SDLVRHelpItem Class Reference

Section Contents

• -init• -initWithDictionary:• -initWithText:image:• -initWithText:image:position:• text• image• position

Overview

Undocumented

-init

Undocumented


Undocumented

-initWithText:image:

Undocumented

-initWithText:image:position:

Undocumented

text

Undocumented

image

Undocumented

position

Undocumented

SDLVehicleDataActiveStatus ClassReference

Section Contents

• +valueOf:• +values• +INACTIVE_NOT_CONFIRMED• +INACTIVE_CONFIRMED• +ACTIVE_NOT_CONFIRMED• +ACTIVE_CONFIRMED• +FAULT

Overview

Vehicle Data Activity Status

+valueOf:

@abstract Convert String to SDLVehicleDataActiveStatus - parameter: value

NSString - returns: SDLVehicleDataActiveStatus

value

NSString

OBJECTIVE-C

+ (SDLVehicleDataActiveStatus *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLVehicleDataActiveStatus!

PARAMETERS

SDLVehicleDataActiveStatus

+values

@abstract return the array that store all possible SDLVehicleDataActiveStatus

values

+INACTIVE_NOT_CONFIRMED

@abstract SDLVehicleDataActiveStatus : Inactive not confirmed

RETURN VALUE

OBJECTIVE-C


SWIFT


+INACTIVE_CONFIRMED

@abstract SDLVehicleDataActiveStatus : Inactive confirmed

OBJECTIVE-C

+ (SDLVehicleDataActiveStatus *)INACTIVE_NOT_CONFIRMED;

SWIFT

class func inactive_NOT_CONFIRMED() -> SDLVehicleDataActiveStatus!

OBJECTIVE-C

+ (SDLVehicleDataActiveStatus *)INACTIVE_CONFIRMED;

SWIFT

class func inactive_CONFIRMED() -> SDLVehicleDataActiveStatus!

+ACTIVE_NOT_CONFIRMED

@abstract SDLVehicleDataActiveStatus : Active not confirmed

+ACTIVE_CONFIRMED

@abstract SDLVehicleDataActiveStatus : Active confirmed

OBJECTIVE-C

+ (SDLVehicleDataActiveStatus *)ACTIVE_NOT_CONFIRMED;

SWIFT

class func active_NOT_CONFIRMED() -> SDLVehicleDataActiveStatus!

OBJECTIVE-C

+ (SDLVehicleDataActiveStatus *)ACTIVE_CONFIRMED;

+FAULT

@abstract SDLVehicleDataActiveStatus : Fault

SWIFT

class func active_CONFIRMED() -> SDLVehicleDataActiveStatus!

OBJECTIVE-C

+ (SDLVehicleDataActiveStatus *)FAULT;

SWIFT

class func fault() -> SDLVehicleDataActiveStatus!

SDLVehicleDataEventStatus ClassReference

Section Contents

• +valueOf:• +values• +NO_EVENT• +_NO• +_YES• +NOT_SUPPORTED• +FAULT

Overview

Reflects the status of a vehicle data event; e.g. a seat belt event status.

@since SDL 2.0

+valueOf:

Convert String to SDLVehicleDataEventStatus

OBJECTIVE-C

+ (SDLVehicleDataEventStatus *)valueOf:(NSString *)value;

value


SDLVehicleDataEventStatus

+values

@abstract Store the enumeration of all possible SDLVehicleDataEventStatus

SWIFT

class func value(of value: String!) -> SDLVehicleDataEventStatus!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


an array that store all possible SDLVehicleDataEventStatus

+NO_EVENT

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLVehicleDataEventStatus *)NO_EVENT;

SWIFT

class func no_EVENT() -> SDLVehicleDataEventStatus!

The SDLVehicleDataEventStatus instance with value of NO_EVENT

+_NO

The SDLVehicleDataEventStatus instance with value of NO

RETURN VALUE

OBJECTIVE-C

+ (SDLVehicleDataEventStatus *)_NO;

SWIFT

class func _NO() -> SDLVehicleDataEventStatus!

RETURN VALUE

+_YES

The SDLVehicleDataEventStatus instance with value of YES

+NOT_SUPPORTED

@abstract Vehicle data event is not supported

OBJECTIVE-C

+ (SDLVehicleDataEventStatus *)_YES;

SWIFT

class func _YES() -> SDLVehicleDataEventStatus!

RETURN VALUE

OBJECTIVE-C

+ (SDLVehicleDataEventStatus *)NOT_SUPPORTED;

the SDLVehicleDataEventStatus instance with value of NOT_SUPPORTED

+FAULT

@abstract The SDLVehicleDataEventStatus instance with value of FAULT

SWIFT

class func not_SUPPORTED() -> SDLVehicleDataEventStatus!

RETURN VALUE

OBJECTIVE-C

+ (SDLVehicleDataEventStatus *)FAULT;

SWIFT

class func fault() -> SDLVehicleDataEventStatus!

SDLVehicleDataNotificationStatus ClassReference

Section Contents

• +valueOf:• +values• +NOT_SUPPORTED• +NORMAL• +ACTIVE• +NOT_USED

Overview

Reflects the status of a vehicle data notification.

@since SDL 2.0

+valueOf:

Convert String to SDLVehicleDataNotificationStatus - parameter: value The

value of the string to get an object for - returns:

SDLVehicleDataNotificationStatus

OBJECTIVE-C

+ (SDLVehicleDataNotificationStatus *)valueOf:(NSString *)value;

value



+values

@abstract Store the enumeration of all possible

SDLVehicleDataNotificationStatus - returns: an array that store all possible


SWIFT

class func value(of value: String!) -> SDLVehicleDataNotificationStatus!

PARAMETERS

RETURN VALUE

an array that store all possible SDLVehicleDataNotificationStatus

+NOT_SUPPORTED

@abstract SDLVehicleDataNotificationStatus: NOT_SUPPORTED

OBJECTIVE-C


SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLVehicleDataNotificationStatus *)NOT_SUPPORTED;

+NORMAL

@abstract SDLVehicleDataNotificationStatus: NORMAL

+ACTIVE

@abstract SDLVehicleDataNotificationStatus: ACTIVE

SWIFT

class func not_SUPPORTED() -> SDLVehicleDataNotificationStatus!

OBJECTIVE-C

+ (SDLVehicleDataNotificationStatus *)NORMAL;

SWIFT

class func normal() -> SDLVehicleDataNotificationStatus!

+NOT_USED

@abstract SDLVehicleDataNotificationStatus: NOT_USED

OBJECTIVE-C

+ (SDLVehicleDataNotificationStatus *)ACTIVE;

SWIFT

class func active() -> SDLVehicleDataNotificationStatus!

OBJECTIVE-C

+ (SDLVehicleDataNotificationStatus *)NOT_USED;

SWIFT

class func not_USED() -> SDLVehicleDataNotificationStatus!

SDLVehicleDataResult Class Reference

Section Contents

• -init• -initWithDictionary:• dataType• resultCode

Overview

Undocumented

-init

Undocumented


Undocumented

dataType

Undocumented

resultCode

Undocumented

SDLVehicleDataResultCode ClassReference

Section Contents

• +valueOf:• +values• +SUCCESS• +TRUNCATED_DATA• +DISALLOWED• +USER_DISALLOWED• +INVALID_ID• +VEHICLE_DATA_NOT_AVAILABLE• +DATA_ALREADY_SUBSCRIBED• +DATA_NOT_SUBSCRIBED• +IGNORED

Overview

Vehicle Data Result Code

+valueOf:

Convert String to SDLVehicleDataResultCode - parameter: value String - returns:

SDLVehicleDataResultCode

OBJECTIVE-C

+ (SDLVehicleDataResultCode *)valueOf:(NSString *)value;

value

String

SDLVehicleDataResultCode

+values

@abstract Store the enumeration of all possible SDLVehicleDataResultCode -

returns: an array that store all possible SDLVehicleDataResultCode

SWIFT

class func value(of value: String!) -> SDLVehicleDataResultCode!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


an array that store all possible SDLVehicleDataResultCode

+SUCCESS

Individual vehicle data item / DTC / DID request or subscription successful

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLVehicleDataResultCode *)SUCCESS;

SWIFT

class func success() -> SDLVehicleDataResultCode!

+TRUNCATED_DATA

DTC / DID request successful, however, not all active DTCs or full contents of

DID location available

+DISALLOWED

This vehicle data item is not allowed for this app by SDL

OBJECTIVE-C

+ (SDLVehicleDataResultCode *)TRUNCATED_DATA;

SWIFT

class func truncated_DATA() -> SDLVehicleDataResultCode!

OBJECTIVE-C

+ (SDLVehicleDataResultCode *)DISALLOWED;

+USER_DISALLOWED

The user has not granted access to this type of vehicle data item at this time

+INVALID_ID

The ECU ID referenced is not a valid ID on the bus / system

SWIFT

class func disallowed() -> SDLVehicleDataResultCode!

OBJECTIVE-C

+ (SDLVehicleDataResultCode *)USER_DISALLOWED;

SWIFT

class func user_DISALLOWED() -> SDLVehicleDataResultCode!

+VEHICLE_DATA_NOT_AVAILABLE

The requested vehicle data item / DTC / DID is not currently available or

responding on the bus / system

OBJECTIVE-C

+ (SDLVehicleDataResultCode *)INVALID_ID;

SWIFT

class func invalid_ID() -> SDLVehicleDataResultCode!

OBJECTIVE-C

+ (SDLVehicleDataResultCode *)VEHICLE_DATA_NOT_AVAILABLE;

SWIFT

class func vehicle_DATA_NOT_AVAILABLE() -> SDLVehicleDataResultCode!

+DATA_ALREADY_SUBSCRIBED

The vehicle data item is already subscribed

+DATA_NOT_SUBSCRIBED

The vehicle data item cannot be unsubscribed because it is not currently

subscribed

OBJECTIVE-C

+ (SDLVehicleDataResultCode *)DATA_ALREADY_SUBSCRIBED;

SWIFT

class func data_ALREADY_SUBSCRIBED() -> SDLVehicleDataResultCode!

OBJECTIVE-C

+ (SDLVehicleDataResultCode *)DATA_NOT_SUBSCRIBED;

+IGNORED

The request for this item is ignored because it is already in progress

SWIFT

class func data_NOT_SUBSCRIBED() -> SDLVehicleDataResultCode!

OBJECTIVE-C

+ (SDLVehicleDataResultCode *)IGNORED;

SWIFT

class func ignored() -> SDLVehicleDataResultCode!

SDLVehicleDataStatus Class Reference

Section Contents

• +valueOf:• +values• +NO_DATA_EXISTS• +OFF• +ON

Overview

Reflects the status of a binary vehicle data item.

@since SDL 2.0

+valueOf:

Convert String to SDLVehicleDataStatus - parameter: value The value of the

string to get an object for - returns: SDLVehicleDataStatus

OBJECTIVE-C

+ (SDLVehicleDataStatus *)valueOf:(NSString *)value;

value


SDLVehicleDataStatus

+values

@abstract Store the enumeration of all possible SDLVehicleDataStatus - returns:

an array that store all possible SDLVehicleDataStatus

SWIFT

class func value(of value: String!) -> SDLVehicleDataStatus!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


an array that store all possible SDLVehicleDataStatus

+NO_DATA_EXISTS

@abstract No data avaliable - returns: SDLVehicleDataStatus: NO_DATA_EXISTS

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLVehicleDataStatus *)NO_DATA_EXISTS;

SWIFT

class func no_DATA_EXISTS() -> SDLVehicleDataStatus!

SDLVehicleDataStatus: NO_DATA_EXISTS

+OFF

@abstract return SDLVehicleDataStatus: OFF

+ON

@abstract return SDLVehicleDataStatus: ON

RETURN VALUE

OBJECTIVE-C

+ (SDLVehicleDataStatus *)OFF;

SWIFT

class func off() -> SDLVehicleDataStatus!

SDLVehicleDataType Class Reference

Section Contents

• +valueOf:• +values• +VEHICLEDATA_GPS• +VEHICLEDATA_SPEED• +VEHICLEDATA_RPM• +VEHICLEDATA_FUELLEVEL• +VEHICLEDATA_FUELLEVEL_STATE• +VEHICLEDATA_FUELCONSUMPTION• +VEHICLEDATA_EXTERNTEMP• +VEHICLEDATA_VIN• +VEHICLEDATA_PRNDL• +VEHICLEDATA_TIREPRESSURE

OBJECTIVE-C

+ (SDLVehicleDataStatus *)ON;

SWIFT

class func on() -> SDLVehicleDataStatus!

• +VEHICLEDATA_ODOMETER• +VEHICLEDATA_BELTSTATUS• +VEHICLEDATA_BODYINFO• +VEHICLEDATA_DEVICESTATUS• +VEHICLEDATA_ECALLINFO• +VEHICLEDATA_AIRBAGSTATUS• +VEHICLEDATA_EMERGENCYEVENT• +VEHICLEDATA_CLUSTERMODESTATUS• +VEHICLEDATA_MYKEY• +VEHICLEDATA_BRAKING• +VEHICLEDATA_WIPERSTATUS• +VEHICLEDATA_HEADLAMPSTATUS• +VEHICLEDATA_BATTVOLTAGE• +VEHICLEDATA_ENGINETORQUE• +VEHICLEDATA_ACCPEDAL• +VEHICLEDATA_STEERINGWHEEL

Overview

Defines the vehicle data types that can be published and/or subscribed to using

SDLSubscribeVehicleData

+valueOf:

Convert String to SDLVehicleDataType

OBJECTIVE-C

+ (SDLVehicleDataType *)valueOf:(NSString *)value;

value


SDLVehicleDataType

+values

@abstract Store the enumeration of all possible SDLVehicleDataType

SWIFT

class func value(of value: String!) -> SDLVehicleDataType!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


an array that store all possible SDLVehicleDataType

+VEHICLEDATA_GPS

@abstract SDLVehicleDataType: VEHICLEDATA_GPS

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_GPS;

SWIFT

class func vehicledata_GPS() -> SDLVehicleDataType!

+VEHICLEDATA_SPEED

@abstract SDLVehicleDataType: VEHICLEDATA_SPEED

+VEHICLEDATA_RPM

@abstract SDLVehicleDataType: VEHICLEDATA_RPM

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_SPEED;

SWIFT

class func vehicledata_SPEED() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_RPM;

+VEHICLEDATA_FUELLEVEL

@abstract SDLVehicleDataType: VEHICLEDATA_FUELLEVEL

+VEHICLEDATA_FUELLEVEL_STATE

@abstract SDLVehicleDataType: VEHICLEDATA_FUELLEVEL_STATE

SWIFT

class func vehicledata_RPM() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_FUELLEVEL;

SWIFT

class func vehicledata_FUELLEVEL() -> SDLVehicleDataType!

+VEHICLEDATA_FUELCONSUMPTION

@abstract SDLVehicleDataType: VEHICLEDATA_FUELCONSUMPTION

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_FUELLEVEL_STATE;

SWIFT

class func vehicledata_FUELLEVEL_STATE() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_FUELCONSUMPTION;

SWIFT

class func vehicledata_FUELCONSUMPTION() -> SDLVehicleDataType!

+VEHICLEDATA_EXTERNTEMP

@abstract SDLVehicleDataType: VEHICLEDATA_EXTERNTEMP

+VEHICLEDATA_VIN

@abstract SDLVehicleDataType: VEHICLEDATA_VIN

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_EXTERNTEMP;

SWIFT

class func vehicledata_EXTERNTEMP() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_VIN;

+VEHICLEDATA_PRNDL

@abstract SDLVehicleDataType: VEHICLEDATA_PRNDL

+VEHICLEDATA_TIREPRESSURE

@abstract SDLVehicleDataType: VEHICLEDATA_TIREPRESSURE

SWIFT

class func vehicledata_VIN() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_PRNDL;

SWIFT

class func vehicledata_PRNDL() -> SDLVehicleDataType!

+VEHICLEDATA_ODOMETER

@abstract SDLVehicleDataType: VEHICLEDATA_ODOMETER

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_TIREPRESSURE;

SWIFT

class func vehicledata_TIREPRESSURE() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_ODOMETER;

SWIFT

class func vehicledata_ODOMETER() -> SDLVehicleDataType!

+VEHICLEDATA_BELTSTATUS

@abstract SDLVehicleDataType: VEHICLEDATA_BELTSTATUS

+VEHICLEDATA_BODYINFO

@abstract SDLVehicleDataType: VEHICLEDATA_BODYINFO

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_BELTSTATUS;

SWIFT

class func vehicledata_BELTSTATUS() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_BODYINFO;

+VEHICLEDATA_DEVICESTATUS

@abstract SDLVehicleDataType: VEHICLEDATA_DEVICESTATUS

+VEHICLEDATA_ECALLINFO

@abstract SDLVehicleDataType: VEHICLEDATA_ECALLINFO

SWIFT

class func vehicledata_BODYINFO() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_DEVICESTATUS;

SWIFT

class func vehicledata_DEVICESTATUS() -> SDLVehicleDataType!

+VEHICLEDATA_AIRBAGSTATUS

@abstract SDLVehicleDataType: VEHICLEDATA_AIRBAGSTATUS

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_ECALLINFO;

SWIFT

class func vehicledata_ECALLINFO() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_AIRBAGSTATUS;

SWIFT

class func vehicledata_AIRBAGSTATUS() -> SDLVehicleDataType!

+VEHICLEDATA_EMERGENCYEVENT

@abstract SDLVehicleDataType: VEHICLEDATA_EMERGENCYEVENT

+VEHICLEDATA_CLUSTERMODESTATUS

@abstract SDLVehicleDataType: VEHICLEDATA_CLUSTERMODESTATUS

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_EMERGENCYEVENT;

SWIFT

class func vehicledata_EMERGENCYEVENT() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_CLUSTERMODESTATUS;

+VEHICLEDATA_MYKEY

@abstract SDLVehicleDataType: VEHICLEDATA_MYKEY

+VEHICLEDATA_BRAKING

@abstract SDLVehicleDataType: VEHICLEDATA_BRAKING

SWIFT

class func vehicledata_CLUSTERMODESTATUS() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_MYKEY;

SWIFT

class func vehicledata_MYKEY() -> SDLVehicleDataType!

+VEHICLEDATA_WIPERSTATUS

@abstract SDLVehicleDataType: VEHICLEDATA_WIPERSTATUS

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_BRAKING;

SWIFT

class func vehicledata_BRAKING() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_WIPERSTATUS;

SWIFT

class func vehicledata_WIPERSTATUS() -> SDLVehicleDataType!

+VEHICLEDATA_HEADLAMPSTATUS

@abstract SDLVehicleDataType: VEHICLEDATA_HEADLAMPSTATUS

+VEHICLEDATA_BATTVOLTAGE

@abstract SDLVehicleDataType: VEHICLEDATA_BATTVOLTAGE

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_HEADLAMPSTATUS;

SWIFT

class func vehicledata_HEADLAMPSTATUS() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_BATTVOLTAGE;

+VEHICLEDATA_ENGINETORQUE

@abstract SDLVehicleDataType: VEHICLEDATA_ENGINETORQUE

+VEHICLEDATA_ACCPEDAL

@abstract SDLVehicleDataType: VEHICLEDATA_ACCPEDAL

SWIFT

class func vehicledata_BATTVOLTAGE() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_ENGINETORQUE;

SWIFT

class func vehicledata_ENGINETORQUE() -> SDLVehicleDataType!

+VEHICLEDATA_STEERINGWHEEL

@abstract SDLVehicleDataType: VEHICLEDATA_STEERINGWHEEL

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_ACCPEDAL;

SWIFT

class func vehicledata_ACCPEDAL() -> SDLVehicleDataType!

OBJECTIVE-C

+ (SDLVehicleDataType *)VEHICLEDATA_STEERINGWHEEL;

SWIFT

class func vehicledata_STEERINGWHEEL() -> SDLVehicleDataType!

SDLVehicleType Class Reference

Section Contents

• -init• -initWithDictionary:• make• model• modelYear• trim

Overview

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

@since SDL 2.0

-init

@abstract Constructs a newly allocated SDLVehicleType object

OBJECTIVE-C



@abstract Constructs a newly allocated SDLVehicleType object indicated by the


dict

SWIFT

init!()

OBJECTIVE-C


SWIFT


PARAMETERS


make

@abstract The make of the vehicle

@discussion For example, “Ford”, “Lincoln”, etc.


model

@abstract The model of the vehicle

@discussion For example, “Fiesta”, “Focus”, etc.


OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *make;

SWIFT

var make: String! { get set }

modelYear

@abstract The model year of the vehicle

@discussion For example, “2013”


OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *model;

SWIFT

var model: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *modelYear;

trim

@abstract The trim of the vehicle

@discussion For example, “SE”, “SEL”


SWIFT

var modelYear: String! { get set }

OBJECTIVE-C

@property (readwrite, strong, atomic) NSString *trim;

SWIFT

var trim: String! { get set }

SDLWarningLightStatus Class Reference

Section Contents

• +valueOf:• +values• +OFF• +ON• +FLASH• +NOT_USED

Overview

Reflects the status of a cluster instrument warning light.

@since SDL 2.0

+valueOf:

Convert String to SDLWarningLightStatus - parameter: value The value of the

string to get an object for - returns: SDLWarningLightStatus

OBJECTIVE-C

+ (SDLWarningLightStatus *)valueOf:(NSString *)value;

value


SDLWarningLightStatus

+values

@abstract Store the enumeration of all possible SDLWarningLightStatus -

returns: an array that store all possible SDLWarningLightStatus

SWIFT

class func value(of value: String!) -> SDLWarningLightStatus!

PARAMETERS

RETURN VALUE

OBJECTIVE-C


an array that store all possible SDLWarningLightStatus

+OFF

@abstract Warninglight Off - returns: SDLWarningLightStatus instance with

value of OFF

SWIFT


RETURN VALUE

OBJECTIVE-C

+ (SDLWarningLightStatus *)OFF;

SWIFT

class func off() -> SDLWarningLightStatus!

SDLWarningLightStatus instance with value of OFF

+ON

@abstract Warninglight On - returns: SDLWarningLightStatus instance with

value of ON

SDLWarningLightStatus instance with value of ON

RETURN VALUE

OBJECTIVE-C

+ (SDLWarningLightStatus *)ON;

SWIFT

class func on() -> SDLWarningLightStatus!

RETURN VALUE

+FLASH

@abstract Warninglight is flashing - returns: SDLWarningLightStatus instance

with value of FLASH

SDLWarningLightStatus instance with value of FLASH

+NOT_USED

@abstract Not used - returns: SDLWarningLightStatus instance with value of

NOT_USED

OBJECTIVE-C

+ (SDLWarningLightStatus *)FLASH;

SWIFT

class func flash() -> SDLWarningLightStatus!

RETURN VALUE

SDLWarningLightStatus instance with value of NOT_USED

SDLWaypointType Class Reference

Section Contents

• +valueOf:• +values• +ALL

OBJECTIVE-C

+ (SDLWarningLightStatus *)NOT_USED;

SWIFT

class func not_USED() -> SDLWarningLightStatus!

RETURN VALUE

• +DESTINATION

Overview

Undocumented

+valueOf:

@abstract Convert String to SDLWayPointType

value


OBJECTIVE-C

+ (SDLWaypointType *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLWaypointType!

PARAMETERS

SDLWayPointType

+values

@abstract Store the enumeration of all possible SDLWayPointType

an array that store all possible SDLWayPointType

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+ALL

a SDLWayPointType with value of PROMPT

+DESTINATION

OBJECTIVE-C

+ (SDLWaypointType *)ALL;

SWIFT

class func all() -> SDLWaypointType!

RETURN VALUE

OBJECTIVE-C

+ (SDLWaypointType *)DESTINATION;

a SDLWayPointType with value of DESTINATION

SDLWiperStatus Class Reference

Section Contents

• +valueOf:• +values• +OFF• +AUTO_OFF• +OFF_MOVING• +MAN_INT_OFF• +MAN_INT_ON• +MAN_LOW• +MAN_HIGH• +MAN_FLICK• +WASH• +AUTO_LOW• +AUTO_HIGH• +COURTESYWIPE

SWIFT

class func destination() -> SDLWaypointType!

RETURN VALUE

• +AUTO_ADJUST• +STALLED• +NO_DATA_EXISTS

Overview

Wiper Status

+valueOf:

Convert String to SDLWiperStatus - parameter: value The value of the string to

get an object for - returns: SDLWiperStatus

value


OBJECTIVE-C

+ (SDLWiperStatus *)valueOf:(NSString *)value;

SWIFT

class func value(of value: String!) -> SDLWiperStatus!

PARAMETERS

SDLWiperStatus

+values

@abstract Store the enumeration of all possible SDLWiperStatus - returns: An

array that store all possible SDLWiperStatus

An array that store all possible SDLWiperStatus

RETURN VALUE

OBJECTIVE-C


SWIFT


RETURN VALUE

+OFF

@abstract SDLWiperStatus: OFF

+AUTO_OFF

@abstract SDLWiperStatus: AUTO_OFF

OBJECTIVE-C

+ (SDLWiperStatus *)OFF;

SWIFT

class func off() -> SDLWiperStatus!

OBJECTIVE-C

+ (SDLWiperStatus *)AUTO_OFF;

+OFF_MOVING

@abstract SDLWiperStatus: OFF_MOVING

+MAN_INT_OFF

@abstract SDLWiperStatus: MAN_INT_OFF

SWIFT

class func auto_OFF() -> SDLWiperStatus!

OBJECTIVE-C

+ (SDLWiperStatus *)OFF_MOVING;

SWIFT

class func off_MOVING() -> SDLWiperStatus!

+MAN_INT_ON

@abstract SDLWiperStatus: MAN_INT_ON

OBJECTIVE-C

+ (SDLWiperStatus *)MAN_INT_OFF;

SWIFT

class func man_INT_OFF() -> SDLWiperStatus!

OBJECTIVE-C

+ (SDLWiperStatus *)MAN_INT_ON;

SWIFT

class func man_INT_ON() -> SDLWiperStatus!

+MAN_LOW

@abstract SDLWiperStatus: MAN_LOW

+MAN_HIGH

@abstract SDLWiperStatus: MAN_HIGH

OBJECTIVE-C

+ (SDLWiperStatus *)MAN_LOW;

SWIFT

class func man_LOW() -> SDLWiperStatus!

OBJECTIVE-C

+ (SDLWiperStatus *)MAN_HIGH;

+MAN_FLICK

@abstract SDLWiperStatus: MAN_FLICK

+WASH

@abstract SDLWiperStatus: WASH

SWIFT

class func man_HIGH() -> SDLWiperStatus!

OBJECTIVE-C

+ (SDLWiperStatus *)MAN_FLICK;

SWIFT

class func man_FLICK() -> SDLWiperStatus!

+AUTO_LOW

@abstract SDLWiperStatus: AUTO_LOW

OBJECTIVE-C

+ (SDLWiperStatus *)WASH;

SWIFT

class func wash() -> SDLWiperStatus!

OBJECTIVE-C

+ (SDLWiperStatus *)AUTO_LOW;

SWIFT

class func auto_LOW() -> SDLWiperStatus!

+AUTO_HIGH

@abstract SDLWiperStatus: AUTO_HIGH

+COURTESYWIPE

@abstract SDLWiperStatus: COURTESYWIPE

OBJECTIVE-C

+ (SDLWiperStatus *)AUTO_HIGH;

SWIFT

class func auto_HIGH() -> SDLWiperStatus!

OBJECTIVE-C

+ (SDLWiperStatus *)COURTESYWIPE;

+AUTO_ADJUST

@abstract SDLWiperStatus: AUTO_ADJUST

+STALLED

@abstract SDLWiperStatus: STALLED

SWIFT

class func courtesywipe() -> SDLWiperStatus!

OBJECTIVE-C

+ (SDLWiperStatus *)AUTO_ADJUST;

SWIFT

class func auto_ADJUST() -> SDLWiperStatus!

+NO_DATA_EXISTS

@abstract SDLWiperStatus: NO_DATA_EXISTS

OBJECTIVE-C

+ (SDLWiperStatus *)STALLED;

SWIFT

class func stalled() -> SDLWiperStatus!

OBJECTIVE-C

+ (SDLWiperStatus *)NO_DATA_EXISTS;

SWIFT

class func no_DATA_EXISTS() -> SDLWiperStatus!

SDLArtworkImageFormat EnumReference

Section Contents

• SDLArtworkImageFormatPNG• SDLArtworkImageFormatJPG

Overview

Undocumented

SDLArtworkImageFormatPNG

Undocumented

SDLArtworkImageFormatJPG

Undocumented

SDLDebugOutput Enum Reference

Section Contents

• SDLDebugOutput_All• SDLDebugOutput_DeviceConsole• SDLDebugOutput_DebugToolConsole• SDLDebugOutput_File

Overview

Undocumented

SDLDebugOutput_All

Undocumented

SDLDebugOutput_DeviceConsole

Undocumented

SDLDebugOutput_DebugToolConsole

Undocumented

SDLDebugOutput_File

Undocumented

SDLDebugType Enum Reference

Section Contents

• SDLDebugType_Debug• SDLDebugType_Transport_iAP• SDLDebugType_Transport_TCP• SDLDebugType_Protocol• SDLDebugType_RPC• SDLDebugType_APP

Overview

Undocumented

SDLDebugType_Debug

Undocumented

SDLDebugType_Transport_iAP

Undocumented

SDLDebugType_Transport_TCP

Undocumented

SDLDebugType_Protocol

Undocumented

SDLDebugType_RPC

Undocumented

SDLDebugType_APP

Undocumented

SDLEncryptionFlag Enum Reference

Section Contents

• SDLEncryptionFlagNone• SDLEncryptionFlagAuthenticateOnly• SDLEncryptionFlagAuthenticateAndEncrypt

Overview

Undocumented

SDLEncryptionFlagNone

Undocumented

SDLEncryptionFlagAuthenticateOnly

Undocumented

SDLEncryptionFlagAuthenticateAndEncrypt

Undocumented

SDLFileManagerError Enum Reference

Section Contents

• SDLFileManagerErrorCannotOverwrite

• SDLFileManagerErrorNoKnownFile• SDLFileManagerErrorUnableToStart• SDLFileManagerErrorUnableToUpload

Overview

Errors associated with the SDLFileManager class.

SDLFileManagerErrorCannotOverwrite

A file attempted to send, but a file with that name already exists on the remote

head unit, and the file was not configured to overwrite.

SDLFileManagerErrorNoKnownFile

A file was attempted to be accessed but it does not exist.

OBJECTIVE-C

SDLFileManagerErrorCannotOverwrite = -1

SWIFT

case cannotOverwrite = -1

SDLFileManagerErrorUnableToStart

The file manager attempted to start but encountered an error.

OBJECTIVE-C

SDLFileManagerErrorNoKnownFile = -2

SWIFT

case noKnownFile = -2

OBJECTIVE-C

SDLFileManagerErrorUnableToStart = -3

SWIFT

case unableToStart = -3

SDLFileManagerErrorUnableToUpload

The file manager was unable to send this file.

SDLFrameData Enum Reference

Section Contents

• SDLFrameData_Heartbeat• SDLFrameData_StartSession• SDLFrameData_StartSessionACK• SDLFrameData_StartSessionNACK• SDLFrameData_EndSession• SDLFrameData_EndSessionACK• SDLFrameData_EndSessionNACK• SDLFrameData_ServiceDataACK

OBJECTIVE-C

SDLFileManagerErrorUnableToUpload = -4

SWIFT

case unableToUpload = -4

• SDLFrameData_HeartbeatACK• SDLFrameData_SingleFrame• SDLFrameData_FirstFrame• SDLFrameData_ConsecutiveLastFrame

Overview

Undocumented

SDLFrameData_Heartbeat

Undocumented

SDLFrameData_StartSession

Undocumented

SDLFrameData_StartSessionACK

Undocumented

SDLFrameData_StartSessionNACK

Undocumented

SDLFrameData_EndSession

Undocumented

SDLFrameData_EndSessionACK

Undocumented

SDLFrameData_EndSessionNACK

Undocumented

SDLFrameData_ServiceDataACK

Undocumented

SDLFrameData_HeartbeatACK

Undocumented

SDLFrameData_SingleFrame

Undocumented

SDLFrameData_FirstFrame

Undocumented

SDLFrameData_ConsecutiveLastFrame

Undocumented

SDLFrameType Enum Reference

Section Contents

• SDLFrameType_Control• SDLFrameType_Single• SDLFrameType_First

• SDLFrameType_Consecutive

Overview

Undocumented

SDLFrameType_Control

Undocumented

SDLFrameType_Single

Undocumented

SDLFrameType_First

Undocumented

SDLFrameType_Consecutive

Undocumented

SDLLogOutput Enum Reference

Section Contents

• SDLLogOutputNone• SDLLogOutputConsole• SDLLogOutputFile

• SDLLogOutputSiphon

Overview

Undocumented

SDLLogOutputNone

Undocumented

SDLLogOutputConsole

Undocumented

SDLLogOutputFile

Undocumented

SDLLogOutputSiphon

Undocumented

SDLManagerError Enum Reference

Section Contents

• SDLManagerErrorRPCRequestFailed• SDLManagerErrorNotConnected• SDLManagerErrorNotReady• SDLManagerErrorUnknownRemoteError• SDLManagerErrorManagersFailedToStart• SDLManagerErrorRegistrationFailed

Overview

Errors associated with the SDLManager class.

SDLManagerErrorRPCRequestFailed

An RPC request failed to send.

SDLManagerErrorNotConnected

Some action was attempted that requires a connection to the remote head unit.

OBJECTIVE-C

SDLManagerErrorRPCRequestFailed = -1

SWIFT

case rpcRequestFailed = -1

OBJECTIVE-C

SDLManagerErrorNotConnected = -2

SDLManagerErrorNotReady

Some action was attempted before the ready state was reached.

SDLManagerErrorUnknownRemoteError

The remote system encountered an unknown error.

SWIFT

case notConnected = -2

OBJECTIVE-C

SDLManagerErrorNotReady = -3

SWIFT

case notReady = -3

SDLManagerErrorManagersFailedToStart

One or more of the sub-managers failed to start.

OBJECTIVE-C

SDLManagerErrorUnknownRemoteError = -4

SWIFT

case unknownRemoteError = -4

OBJECTIVE-C

SDLManagerErrorManagersFailedToStart = -5

SWIFT

case managersFailedToStart = -5

SDLManagerErrorRegistrationFailed

Registering with the remote system failed.

SDLPermissionGroupStatus EnumReference

Section Contents

• SDLPermissionGroupStatusAllowed• SDLPermissionGroupStatusDisallowed• SDLPermissionGroupStatusMixed

OBJECTIVE-C

SDLManagerErrorRegistrationFailed = -6

SWIFT

case registrationFailed = -6

• SDLPermissionGroupStatusUnknown

Overview

The status of the group of RPCs permissions.

SDLPermissionGroupStatusAllowed

Every RPC in the group is currently allowed.

SDLPermissionGroupStatusDisallowed

Every RPC in the group is currently disallowed.

OBJECTIVE-C

SDLPermissionGroupStatusAllowed

SWIFT

case allowed = 0

OBJECTIVE-C

SDLPermissionGroupStatusDisallowed

SDLPermissionGroupStatusMixed

Some RPCs in the group are allowed and some disallowed.

SDLPermissionGroupStatusUnknown

The current status of the group is unknown.

SWIFT

case disallowed = 1

OBJECTIVE-C

SDLPermissionGroupStatusMixed

SWIFT

case mixed = 2

SDLPermissionGroupType EnumReference

Section Contents

• SDLPermissionGroupTypeAllAllowed• SDLPermissionGroupTypeAny

Overview

A permission group type which will be used to tell the system what type of

changes you want to be notified about for the group.

OBJECTIVE-C

SDLPermissionGroupStatusUnknown

SWIFT

case unknown = 3

SDLPermissionGroupTypeAllAllowed

Be notified when all of the RPC in the group are allowed, or, when they all stop

being allowed in some sense, that is, when they were all allowed, and now they

are not.

SDLPermissionGroupTypeAny

Be notified when any change in availability occurs among the group.

OBJECTIVE-C

SDLPermissionGroupTypeAllAllowed

SWIFT

case allAllowed = 0

OBJECTIVE-C

SDLPermissionGroupTypeAny

SDLProtocolError Enum Reference

Section Contents

• SDLProtocolErrorNoSecurityManager

Overview

Undocumented

SDLProtocolErrorNoSecurityManager

Undocumented

SDLRPCMessageType Enum Reference

Section Contents

• SDLRPCMessageTypeRequest• SDLRPCMessageTypeResponse

SWIFT

case any = 1

• SDLRPCMessageTypeNotification

Overview

Undocumented

SDLRPCMessageTypeRequest

Undocumented

SDLRPCMessageTypeResponse

Undocumented

SDLRPCMessageTypeNotification

Undocumented

SDLServiceType Enum Reference

Section Contents

• SDLServiceType_Control• SDLServiceType_RPC• SDLServiceType_Audio• SDLServiceType_Video• SDLServiceType_BulkData

Overview

Undocumented

SDLServiceType_Control

Undocumented

SDLServiceType_RPC

Undocumented

SDLServiceType_Audio

Undocumented

SDLServiceType_Video

Undocumented

SDLServiceType_BulkData

Undocumented

SDLStreamingAudioError EnumReference

Section Contents

• SDLStreamingAudioErrorHeadUnitNACK

Overview

Undocumented

SDLStreamingAudioErrorHeadUnitNACK

Undocumented

SDLStreamingVideoError EnumReference

Section Contents

• SDLStreamingVideoErrorHeadUnitNACK• SDLSTreamingVideoErrorInvalidOperatingSystemVersion• SDLStreamingVideoErrorInvalidOperatingSystemVersion• SDLStreamingVideoErrorConfigurationCompressionSessionCreationFailure• SDLStreamingVideoErrorConfigurationAllocationFailure• SDLStreamingVideoErrorConfigurationCompressionSessionSetPropertyFailure

Overview

Undocumented

SDLStreamingVideoErrorHeadUnitNACK

Undocumented

SDLSTreamingVideoErrorInvalidOperatingSystemVersion

Undocumented

SDLStreamingVideoErrorInvalidOperatingSystemVersion

Undocumented

SDLStreamingVideoErrorConfigurationCompressionSessionCreationFailure

Undocumented

SDLStreamingVideoErrorConfigurationAllocationFailure

Undocumented

SDLStreamingVideoErrorConfigurationCompressionSessionSetPropertyFailure

Undocumented

SDLDebugToolConsole ProtocolReference

Section Contents

• -logInfo:

Overview

Undocumented

-logInfo:

Undocumented

SDLIAPSessionDelegate ProtocolReference

Section Contents

• -onSessionInitializationCompleteForSession:• -onSessionStreamsEnded:

Overview

Undocumented

-onSessionInitializationCompleteForSession:

Undocumented

-onSessionStreamsEnded:

Undocumented

SDLManagerDelegate ProtocolReference

Section Contents

• -managerDidDisconnect• -hmiLevel:didChangeToLevel:

Overview

Undocumented

-managerDidDisconnect

Called upon a disconnection from the remote system.

-hmiLevel:didChangeToLevel:

Called when the HMI level state of this application changes on the remote

system. This is equivalent to the application’s state changes in iOS such as

foreground, background, or closed.

OBJECTIVE-C

- (void)managerDidDisconnect;

SWIFT

func managerDidDisconnect()

oldLevel

The previous level which has now been left.

newLevel

The current level.

OBJECTIVE-C

- (void)hmiLevel:(nonnull SDLHMILevel *)oldLevel didChangeToLevel:(nonnull SDLHMILevel *)newLevel;

SWIFT

func hmiLevel(_ oldLevel: SDLHMILevel, didChangeTo newLevel: SDLHMILevel)

PARAMETERS





SDLProtocolListener Protocol Reference

Section Contents

• -handleProtocolStartSessionACK:sessionID:version:• -handleProtocolStartSessionACK:• -handleProtocolStartSessionNACK:• -handleProtocolEndSessionACK:• -handleProtocolEndSessionNACK:• -handleHeartbeatForSession:• -handleHeartbeatACK• -onProtocolMessageReceived:• -onProtocolOpened• -onProtocolClosed• -onError:exception:

Overview

Undocumented

-handleProtocolStartSessionACK:sessionID:version:

Undocumented

-handleProtocolStartSessionACK:

Undocumented

-handleProtocolStartSessionNACK:

Undocumented

-handleProtocolEndSessionACK:

Undocumented

-handleProtocolEndSessionNACK:

Undocumented

-handleHeartbeatForSession:

Undocumented

-handleHeartbeatACK

Undocumented

-onProtocolMessageReceived:

Undocumented

-onProtocolOpened

Undocumented

-onProtocolClosed

Undocumented

-onError:exception:

Undocumented

SDLProxyListener Protocol Reference

Section Contents

• -onOnDriverDistraction:• -onOnHMIStatus:• -onProxyClosed• -onProxyOpened• -onAddCommandResponse:• -onAddSubMenuResponse:• -onAlertManeuverResponse:• -onAlertResponse:• -onChangeRegistrationResponse:• -onCreateInteractionChoiceSetResponse:• -onDeleteCommandResponse:• -onDeleteFileResponse:• -onDeleteInteractionChoiceSetResponse:• -onDeleteSubMenuResponse:• -onDiagnosticMessageResponse:• -onDialNumberResponse:• -onEncodedSyncPDataResponse:• -onEndAudioPassThruResponse:• -onError:• -onGenericResponse:• -onGetDTCsResponse:• -onGetVehicleDataResponse:• -onGetWayPointsResponse:• -onListFilesResponse:• -onReceivedLockScreenIcon:• -onOnAppInterfaceUnregistered:• -onOnAudioPassThru:• -onOnButtonEvent:• -onOnButtonPress:• -onOnCommand:• -onOnEncodedSyncPData:

• -onOnHashChange:• -onOnKeyboardInput:• -onOnLanguageChange:• -onOnLockScreenNotification:• -onOnPermissionsChange:• -onOnSyncPData:• -onOnSystemRequest:• -onOnTBTClientState:• -onOnTouchEvent:• -onOnVehicleData:• -onOnWayPointChange:• -onPerformAudioPassThruResponse:• -onPerformInteractionResponse:• -onPutFileResponse:• -onReadDIDResponse:• -onRegisterAppInterfaceResponse:• -onResetGlobalPropertiesResponse:• -onScrollableMessageResponse:• -onSendLocationResponse:• -onSetAppIconResponse:• -onSetDisplayLayoutResponse:• -onSetGlobalPropertiesResponse:• -onSetMediaClockTimerResponse:• -onShowConstantTBTResponse:• -onShowResponse:• -onSliderResponse:• -onSpeakResponse:• -onSubscribeButtonResponse:• -onSubscribeVehicleDataResponse:• -onSubscribeWayPointsResponse:• -onSyncPDataResponse:• -onUpdateTurnListResponse:• -onUnregisterAppInterfaceResponse:• -onUnsubscribeButtonResponse:• -onUnsubscribeVehicleDataResponse:

• -onUnsubscribeWayPointsResponse:

Overview

Undocumented

-onOnDriverDistraction:

Undocumented

-onOnHMIStatus:

Undocumented

-onProxyClosed

Undocumented

-onProxyOpened

Undocumented

-onAddCommandResponse:

Undocumented

-onAddSubMenuResponse:

Undocumented

-onAlertManeuverResponse:

Undocumented

-onAlertResponse:

Undocumented

-onChangeRegistrationResponse:

Undocumented

-onCreateInteractionChoiceSetResponse:

Undocumented

-onDeleteCommandResponse:

Undocumented

-onDeleteFileResponse:

Undocumented

-onDeleteInteractionChoiceSetResponse:

Undocumented

-onDeleteSubMenuResponse:

Undocumented

-onDiagnosticMessageResponse:

Undocumented

-onDialNumberResponse:

Undocumented

-onEncodedSyncPDataResponse:

Undocumented

-onEndAudioPassThruResponse:

Undocumented

-onError:

Undocumented

-onGenericResponse:

Undocumented

-onGetDTCsResponse:

Undocumented

-onGetVehicleDataResponse:

Undocumented

-onGetWayPointsResponse:

Undocumented

-onListFilesResponse:

Undocumented

-onReceivedLockScreenIcon:

Undocumented

-onOnAppInterfaceUnregistered:

Undocumented

-onOnAudioPassThru:

Undocumented

-onOnButtonEvent:

Undocumented

-onOnButtonPress:

Undocumented

-onOnCommand:

Undocumented

-onOnEncodedSyncPData:

Undocumented

-onOnHashChange:

Undocumented

-onOnKeyboardInput:

Undocumented

-onOnLanguageChange:

Undocumented

-onOnLockScreenNotification:

Undocumented

-onOnPermissionsChange:

Undocumented

-onOnSyncPData:

Undocumented

-onOnSystemRequest:

Undocumented

-onOnTBTClientState:

Undocumented

-onOnTouchEvent:

Undocumented

-onOnVehicleData:

Undocumented

-onOnWayPointChange:

Undocumented

-onPerformAudioPassThruResponse:

Undocumented

-onPerformInteractionResponse:

Undocumented

-onPutFileResponse:

Undocumented

-onReadDIDResponse:

Undocumented

-onRegisterAppInterfaceResponse:

Undocumented

-onResetGlobalPropertiesResponse:

Undocumented

-onScrollableMessageResponse:

Undocumented

-onSendLocationResponse:

Undocumented

-onSetAppIconResponse:

Undocumented

-onSetDisplayLayoutResponse:

Undocumented

-onSetGlobalPropertiesResponse:

Undocumented

-onSetMediaClockTimerResponse:

Undocumented

-onShowConstantTBTResponse:

Undocumented

-onShowResponse:

Undocumented

-onSliderResponse:

Undocumented

-onSpeakResponse:

Undocumented

-onSubscribeButtonResponse:

Undocumented

-onSubscribeVehicleDataResponse:

Undocumented

-onSubscribeWayPointsResponse:

Undocumented

-onSyncPDataResponse:

Undocumented

-onUpdateTurnListResponse:

Undocumented

-onUnregisterAppInterfaceResponse:

Undocumented

-onUnsubscribeButtonResponse:

Undocumented

-onUnsubscribeVehicleDataResponse:

Undocumented

-onUnsubscribeWayPointsResponse:

Undocumented

SDLRequestHandler Protocol Reference

Section Contents

• handler• -initWithHandler:

Overview

Undocumented

handler

The handler that is added to any RPC implementing this protocol.

-initWithHandler:

A special init function on any RPC implementing this protocol.

OBJECTIVE-C

@property (readwrite, copy, nonatomic) SDLRPCNotificationHandler _Nonnull handler;

SWIFT

var handler: SDLRPCNotificationHandler { get set }

OBJECTIVE-C

- (nonnull instancetype)initWithHandler: (nonnull SDLRPCNotificationHandler)handler;

SWIFT

init(handler: @escaping SDLRPCNotificationHandler)





handler

The handler to be called at specified times, such as events for buttons.

An instance of the class implementing this protocol.

SDLSecurityType Protocol Reference

Section Contents

• appId• -initializeWithAppId:completionHandler:• -stop• -runHandshakeWithClientData:error:• -encryptData:withError:• -decryptData:withError:• +availableMakes

Overview

Undocumented

PARAMETERS

RETURN VALUE

appId

Undocumented

-initializeWithAppId:completionHandler:

Undocumented

-stop

Undocumented

-runHandshakeWithClientData:error:

Undocumented

-encryptData:withError:

Undocumented

-decryptData:withError:

Undocumented

+availableMakes

Undocumented

SDLTouchManagerDelegate ProtocolReference

Section Contents

• -touchManager:didReceiveSingleTapAtPoint:• -touchManager:didReceiveDoubleTapAtPoint:• -touchManager:panningDidStartAtPoint:• -touchManager:didReceivePanningFromPoint:toPoint:• -touchManager:panningDidEndAtPoint:• -touchManager:pinchDidStartAtCenterPoint:• -touchManager:didReceivePinchAtCenterPoint:withScale:• -touchManager:pinchDidEndAtCenterPoint:

Overview

Undocumented

-touchManager:didReceiveSingleTapAtPoint:

@abstract Single tap was received. - parameter: manager Current initalized

SDLTouchManager issuing the callback. - parameter: point Location of the single

tap in the head unit’s coordinate system.

OBJECTIVE-C

- (void)touchManager:(nonnull SDLTouchManager *)manager didReceiveSingleTapAtPoint:(CGPoint)point;


manager

Current initalized SDLTouchManager issuing the callback.

point

Location of the single tap in the head unit’s coordinate system.

-touchManager:didReceiveDoubleTapAtPoint:

@abstract Double tap was received. - parameter: manager Current initalized

SDLTouchManager issuing the callback. - parameter: point Location of the

double tap in the head unit’s coordinate system. This is the average of the first

and second tap.

SWIFT

optional func touchManager(_ manager: SDLTouchManager!, didReceiveSingleTapAtPoint point: Any!)

PARAMETERS

OBJECTIVE-C

- (void)touchManager:(nonnull SDLTouchManager *)manager didReceiveDoubleTapAtPoint:(CGPoint)point;



manager


point

Location of the double tap in the head unit’s coordinate system. This is

the average of the first and second tap.

-touchManager:panningDidStartAtPoint:

@abstract Panning did start. - parameter: manager Current initalized


panning start point in the head unit’s coordinate system.

SWIFT

optional func touchManager(_ manager: SDLTouchManager!, didReceiveDoubleTapAtPoint point: Any!)

PARAMETERS

OBJECTIVE-C

- (void)touchManager:(nonnull SDLTouchManager *)manager panningDidStartAtPoint:(CGPoint)point;



manager


point

Location of the panning start point in the head unit’s coordinate

system.

-

touchManager:didReceivePanningFromPoint:toPoint:

@abstract Panning did move. - parameter: manager Current initalized

SDLTouchManager issuing the callback. - parameter: fromPoint Location of the

panning’s previous point in the head unit’s coordinate system. - parameter:

SWIFT

optional func touchManager(_ manager: SDLTouchManager!, panningDidStartAtPoint point: Any!)

PARAMETERS


toPoint Location of the panning’s new point in the head unit’s coordinate

system.

manager


fromPoint

Location of the panning’s previous point in the head unit’s coordinate

system.

toPoint

OBJECTIVE-C

- (void)touchManager:(nonnull SDLTouchManager *)manager didReceivePanningFromPoint:(CGPoint)fromPoint toPoint:(CGPoint)toPoint;

SWIFT

optional func touchManager(_ manager: SDLTouchManager!, didReceivePanningFromPoint fromPoint: Any!, toPoint: Any!)

PARAMETERS



Location of the panning’s new point in the head unit’s coordinate

system.

-touchManager:panningDidEndAtPoint:

@abstract Panning did end. - parameter: manager Current initalized


panning’s end point in the head unit’s coordinate system.

manager


OBJECTIVE-C

- (void)touchManager:(nonnull SDLTouchManager *)manager panningDidEndAtPoint:(CGPoint)point;

SWIFT

optional func touchManager(_ manager: SDLTouchManager!, panningDidEndAtPoint point: Any!)

PARAMETERS



point

Location of the panning’s end point in the head unit’s coordinate

system.

-touchManager:pinchDidStartAtCenterPoint:

@abstract Pinch did start. - parameter: manager Current initalized

SDLTouchManager issuing the callback. - parameter: point Center point of the

pinch in the head unit’s coordinate system.

manager


OBJECTIVE-C

- (void)touchManager:(nonnull SDLTouchManager *)manager pinchDidStartAtCenterPoint:(CGPoint)point;

SWIFT

optional func touchManager(_ manager: SDLTouchManager!, pinchDidStartAtCenterPoint point: Any!)

PARAMETERS



point

Center point of the pinch in the head unit’s coordinate system.

-

touchManager:didReceivePinchAtCenterPoint:withScale:

@abstract Pinch did move. - parameter: manager Current initalized


pinch in the head unit’s coordinate system. - parameter: scale Scale relative to

the distance between touch points.

OBJECTIVE-C

- (void)touchManager:(nonnull SDLTouchManager *)manager didReceivePinchAtCenterPoint:(CGPoint)point withScale:(CGFloat)scale;

SWIFT

optional func touchManager(_ manager: SDLTouchManager!, didReceivePinchAtCenterPoint point: Any!, withScale scale: Any!)



manager


point


scale

Scale relative to the distance between touch points.

-touchManager:pinchDidEndAtCenterPoint:

@abstract Pinch did end. - parameter: manager Current initalized


pinch in the head unit’s coordinate system.

PARAMETERS

OBJECTIVE-C

- (void)touchManager:(nonnull SDLTouchManager *)manager pinchDidEndAtCenterPoint:(CGPoint)point;


manager


point


SDLTransportDelegate ProtocolReference

Section Contents

• -onTransportConnected• -onTransportDisconnected• -onDataReceived:

SWIFT

optional func touchManager(_ manager: SDLTouchManager!, pinchDidEndAtCenterPoint point: Any!)

PARAMETERS


Overview

Undocumented

-onTransportConnected

Undocumented

-onTransportDisconnected

Undocumented

-onDataReceived:

Undocumented

Documents

Documentation iOS SDLAbstractProtocol Class Reference