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

Type Definitions Reference

Section Contents

Overview

The following type definitions are available globally.

SDLAmbientLightStatus

Reflects the status of the ambient light sensor for headlamps

@since SDL 3.0

Objective-C

typedef SDLEnum SDLAmbientLightStatus

Swift

struct SDLAmbientLightStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLAppHMIType

Enumeration listing possible app hmi types.

@since SDL 2.0

Objective-C

typedef SDLEnum SDLAppHMIType

Swift

struct SDLAppHMIType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLAppInterfaceUnregisteredReason

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

@since SDL 1.0

Objective-C

typedef SDLEnum SDLAppInterfaceUnregisteredReason

Swift

struct SDLAppInterfaceUnregisteredReason : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLAudioStreamingIndicator

Enumeration listing possible indicators of audio streaming changes

@since SDL 4.6

Objective-C

typedef SDLEnum SDLAudioStreamingIndicator

Swift

struct SDLAudioStreamingIndicator : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLAudioStreamingState

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

Objective-C

typedef SDLEnum SDLAudioStreamingState

Swift

struct SDLAudioStreamingState : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLAudioType

Describes different audio type options for PerformAudioPassThru

Objective-C

typedef SDLEnum SDLAudioType

Swift

struct SDLAudioType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLBitsPerSample

Describes different bit depth options for PerformAudioPassThru

@since SDL 2.0

Objective-C

typedef SDLEnum SDLBitsPerSample

Swift

struct SDLBitsPerSample : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLButtonEventMode

Indicates whether the button was depressed or released. A BUTTONUP event will always be preceded by a BUTTONDOWN event.

@since SDL 1.0

Objective-C

typedef SDLEnum SDLButtonEventMode

Swift

struct SDLButtonEventMode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLButtonName

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

Objective-C

typedef SDLEnum SDLButtonName

Swift

struct SDLButtonName : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLButtonPressMode

Indicates whether this is a LONG or SHORT button press

@since SDL 1.0

Objective-C

typedef SDLEnum SDLButtonPressMode

Swift

struct SDLButtonPressMode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLCarModeStatus

Describes the carmode the vehicle is in. Used in ClusterModeStatus

Since

Since SmartDeviceLink 2.0

Objective-C

typedef SDLEnum SDLCarModeStatus

Swift

struct SDLCarModeStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLCharacterSet

Character sets supported by SDL. Used to describe text field capabilities.

@since SDL 1.0

Objective-C

typedef SDLEnum SDLCharacterSet

Swift

struct SDLCharacterSet : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLCompassDirection

The list of potential compass directions. Used in GPS data

@since SDL 2.0

Objective-C

typedef SDLEnum SDLCompassDirection

Swift

struct SDLCompassDirection : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLComponentVolumeStatus

The volume status of a vehicle component. Used in SingleTireStatus and VehicleData Fuel Level

@since SDL 2.0

Objective-C

typedef SDLEnum SDLComponentVolumeStatus

Swift

struct SDLComponentVolumeStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLDefrostZone

Enumeration listing possible defrost zones. Used in ClimateControlCapabilities and Data.

@since SDL 2.0

Objective-C

typedef SDLEnum SDLDefrostZone

Swift

struct SDLDefrostZone : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLDeliveryMode

Specifies the mode in which the sendLocation request is sent. Used in SendLocation.

Objective-C

typedef SDLEnum SDLDeliveryMode

Swift

struct SDLDeliveryMode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLDeviceLevelStatus

Reflects the reported battery status of the connected device, if reported. Used in DeviceStatus.

@since SDL 2.0

Objective-C

typedef SDLEnum SDLDeviceLevelStatus

Swift

struct SDLDeviceLevelStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLDimension

The supported dimensions of the GPS. Used in GPSData

@since SDL 2.0

Objective-C

typedef SDLEnum SDLDimension

Swift

struct SDLDimension : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLDisplayMode

Identifies the various display types used by SDL.

@since SDL 1.0

Objective-C

typedef SDLEnum SDLDisplayMode

Swift

struct SDLDisplayMode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLDisplayType

Identifies the various display types used by SDL. Used in DisplayCapabilities.

Warning

This should not be used to identify features of a display, this is a deprecated parameter.

@since SDL 1.0

Objective-C

typedef SDLEnum SDLDisplayType

Swift

struct SDLDisplayType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLDistanceUnit

Wiper Status

Objective-C

typedef SDLEnum SDLDistanceUnit

Swift

struct SDLDistanceUnit : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLDriverDistractionState

Enumeration that describes possible states of driver distraction. Used in OnDriverDistraction.

@since SDL 1.0

Objective-C

typedef SDLEnum SDLDriverDistractionState

Swift

struct SDLDriverDistractionState : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLECallConfirmationStatus

Reflects the status of the eCall Notification. Used in ECallInfo

Since SmartDeviceLink 2.0

Objective-C

typedef SDLEnum SDLECallConfirmationStatus

Swift

struct SDLECallConfirmationStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLElectronicParkBrakeStatus

Reflects the status of the Electronic Parking Brake. A Vehicle Data Type.

Objective-C

typedef SDLEnum SDLElectronicParkBrakeStatus

Swift

struct SDLElectronicParkBrakeStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLEmergencyEventType

Reflects the emergency event status of the vehicle. Used in EmergencyEvent

Since SmartDeviceLink 2.0

Objective-C

typedef SDLEnum SDLEmergencyEventType

Swift

struct SDLEmergencyEventType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLEnum

Undocumented

Objective-C

typedef NSString* SDLEnum

Swift

struct SDLEnum : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLFileManagerStartupCompletionHandler

Undocumented

Objective-C

typedef void (^SDLFileManagerStartupCompletionHandler)(BOOL success, NSError *__nullable error)

Swift

typealias SDLFileManagerStartupCompletionHandler = (Bool, Error?) -> Void

SDLFileName

Undocumented

Objective-C

typedef NSString SDLFileName

SDLFileManagerUploadCompletionHandler

A completion handler called after a response from Core to a upload request.

Objective-C

typedef void (^SDLFileManagerUploadCompletionHandler)(BOOL, NSUInteger,
                                                      NSError *_Nullable)

Swift

typealias SDLFileManagerUploadCompletionHandler = (Bool, UInt, Error?) -> Void

Parameters

success

Whether or not the upload was successful

bytesAvailable

The amount of space left for files on Core

error

The error that occurred during the request if one occurred, nil if no error occured

SDLFileManagerMultiUploadCompletionHandler

A completion handler called after a set of upload requests has completed.

Objective-C

typedef void (^SDLFileManagerMultiUploadCompletionHandler)(NSError *_Nullable)

Swift

typealias SDLFileManagerMultiUploadCompletionHandler = (Error?) -> Void

Parameters

error

The userInfo dictionary property, of type , contains information on all failed uploads. The key is the name of the file that did not upload properly, the value is an error describing what went wrong on that particular upload attempt. If all files are uploaded successfully, nil is returned

SDLFileManagerMultiUploadProgressHandler

In a multiple request send, a handler called after each response from Core to a upload request.

Objective-C

typedef BOOL (^SDLFileManagerMultiUploadProgressHandler)(SDLFileName *_Nonnull,
                                                         float,
                                                         NSError *_Nullable)

Swift

typealias SDLFileManagerMultiUploadProgressHandler = (String, Float, Error?) -> Bool

Parameters

fileName

The name of the file that received a response from SDL Core

uploadPercentage

The percentage of uploaded data. The upload percentage is calculated as the total file size of all attempted file uploads (regardless of the successfulness of the upload) divided by the sum of the data in all the files

error

The error that occurred during the request if one occurred, nil if no error occured

Return Value

Return NO to cancel any requests that have not yet been sent. Return YES to continue sending requests

SDLFileManagerDeleteCompletionHandler

A completion handler called after a response from Core to a delete request.

Objective-C

typedef void (^SDLFileManagerDeleteCompletionHandler)(BOOL, NSUInteger,
                                                      NSError *_Nullable)

Swift

typealias SDLFileManagerDeleteCompletionHandler = (Bool, UInt, Error?) -> Void

Parameters

success

Whether or not the delete was successful

bytesAvailable

The amount of space left for files on Core

error

The error that occurred during the request if one occurred, nil if no error occured

SDLFileManagerMultiDeleteCompletionHandler

A completion handler called after a set of delete requests has completed.

Objective-C

typedef void (^SDLFileManagerMultiDeleteCompletionHandler)(NSError *_Nullable)

Swift

typealias SDLFileManagerMultiDeleteCompletionHandler = (Error?) -> Void

Parameters

error

The userInfo dictionary property, of type , will return information on all failed deletes. The key is the name of the file that did not delete properly, the value is an error describing what went wrong on that particular delete attempt. If all files are deleted successfully, nil is returned

SDLFileManagerListFilesCompletionHandler

A completion handler called after response from Core to a list files request.

Objective-C

typedef void (^SDLFileManagerListFilesCompletionHandler)(
    BOOL, NSUInteger, NSArray<NSString *> *_Nonnull, NSError *_Nullable)

Swift

typealias SDLFileManagerListFilesCompletionHandler = (Bool, UInt, [String], Error?) -> Void

Parameters

success

Whether or not the list files request was successful

bytesAvailable

The amount of space available for files on Core

fileNames

The names of the files stored on SDL Core

error

The error that occurred during the request if one occurred, nil if no error occured

SDLFileManagerUploadArtworkCompletionHandler

A completion handler called after a response from Core to a artwork upload request.

Objective-C

typedef void (^SDLFileManagerUploadArtworkCompletionHandler)(BOOL,
                                                             NSString *_Nonnull,
                                                             NSUInteger,
                                                             NSError *_Nullable)

Swift

typealias SDLFileManagerUploadArtworkCompletionHandler = (Bool, String, UInt, Error?) -> Void

Parameters

success

Whether or not the upload was successful

artworkName

The unique identifier for the uploaded file.

bytesAvailable

The amount of space left for files on Core

error

The error that occurred during the request if one occurred, nil if not

SDLFileManagerMultiUploadArtworkCompletionHandler

A completion handler called after a set of upload artwork requests has completed.

Objective-C

typedef void (^SDLFileManagerMultiUploadArtworkCompletionHandler)(
    NSArray<NSString *> *_Nonnull, NSError *_Nullable)

Swift

typealias SDLFileManagerMultiUploadArtworkCompletionHandler = ([String], Error?) -> Void

Parameters

artworkNames

The names of the artwork files successfully uploaded to the remote

error

The userInfo dictionary property, of type , contains information on all failed uploads. The key is the name of the artwork that did not upload properly, the value is an error describing what went wrong on that particular upload attempt. If all artworks are uploaded successfully, nil is returned

SDLFileManagerMultiUploadArtworkProgressHandler

In a multiple request send, a handler called after each response from Core to an artwork upload request.

Objective-C

typedef BOOL (^SDLFileManagerMultiUploadArtworkProgressHandler)(
    NSString *_Nonnull, float, NSError *_Nullable)

Swift

typealias SDLFileManagerMultiUploadArtworkProgressHandler = (String, Float, Error?) -> Bool

Parameters

artworkName

The unique identifier for the uploaded file

uploadPercentage

The percentage of uploaded data. The upload percentage is calculated as the total file size of all attempted artwork uploads (regardless of the successfulness of the upload) divided by the sum of the data in all the files

error

The error that occurred during the upload request if one occurred, nil if no error occured

Return Value

Return NO to cancel any artworks that have not yet been sent. Return YES to continue sending artworks

SDLFileType

Enumeration listing possible file types. Used in SDLFile, PutFile, ImageField, OnSystemRequest

@since SDL 2.0

Objective-C

typedef SDLEnum SDLFileType

Swift

struct SDLFileType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLFuelCutoffStatus

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. Used in EmergencyEvent.

@since SDL 2.0

Objective-C

typedef SDLEnum SDLFuelCutoffStatus

Swift

struct SDLFuelCutoffStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLFuelType

Enumeration listing possible fuel types.

Objective-C

typedef SDLEnum SDLFuelType

Swift

struct SDLFuelType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLGlobalProperty

Properties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button). Used in RPCs related to ResetGlobalProperties

@since SDL 1.0

Objective-C

typedef SDLEnum SDLGlobalProperty

Swift

struct SDLGlobalProperty : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLHMILevel

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.). Used in OnHMIStatus

@since SDL 1.0

Objective-C

typedef SDLEnum SDLHMILevel

Swift

struct SDLHMILevel : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLHMIZoneCapabilities

Specifies HMI Zones in the vehicle. Used in RegisterAppInterfaceResponse

@since SDL 1.0

Objective-C

typedef SDLEnum SDLHMIZoneCapabilities

Swift

struct SDLHMIZoneCapabilities : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLIgnitionStableStatus

Reflects the ignition switch stability. Used in BodyInformation

@since SDL 2.0

Objective-C

typedef SDLEnum SDLIgnitionStableStatus

Swift

struct SDLIgnitionStableStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLIgnitionStatus

Reflects the status of ignition. Used in BodyInformation.

@since SDL 2.0

Objective-C

typedef SDLEnum SDLIgnitionStatus

Swift

struct SDLIgnitionStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLImageFieldName

The name that identifies the filed. Used in DisplayCapabilities.

@since SmartDeviceLink 3.0

Objective-C

typedef SDLEnum SDLImageFieldName

Swift

struct SDLImageFieldName : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLImageType

Contains information about the type of image. Used in Image.

@since SDL 2.0

Objective-C

typedef SDLEnum SDLImageType

Swift

struct SDLImageType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLInteractionMode

For application-initiated interactions (SDLPerformInteraction), this specifies the mode by which the user is prompted and by which the user’s selection is indicated. Used in PerformInteraction.

@since SDL 1.0

Objective-C

typedef SDLEnum SDLInteractionMode

Swift

struct SDLInteractionMode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLKeyboardAutocompleteCompletionHandler

This handler is called when you wish to update your autocomplete text in response to the user’s input

Objective-C

typedef void (^SDLKeyboardAutocompleteCompletionHandler)(NSString *_Nullable)

Swift

typealias SDLKeyboardAutocompleteCompletionHandler = (String?) -> Void

Parameters

updatedAutocompleteText

The new autocomplete text to use

SDLKeyboardCharacterSetCompletionHandler

This handler is called when you wish to update your keyboard’s limitedCharacterSet in response to the user’s input

Objective-C

typedef void (^SDLKeyboardCharacterSetCompletionHandler)(
    NSArray<NSString *> *_Nullable)

Swift

typealias SDLKeyboardCharacterSetCompletionHandler = ([String]?) -> Void

Parameters

updatedCharacterSet

The new set of characters to use

SDLKeyboardEvent

Enumeration listing possible keyboard events. Used in OnKeyboardInput.

@since SmartDeviceLink 3.0

Objective-C

typedef SDLEnum SDLKeyboardEvent

Swift

struct SDLKeyboardEvent : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLKeyboardLayout

Enumeration listing possible keyboard layouts. Used in KeyboardProperties.

Since SmartDeviceLink 3.0

Objective-C

typedef SDLEnum SDLKeyboardLayout

Swift

struct SDLKeyboardLayout : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLKeypressMode

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

Objective-C

typedef SDLEnum SDLKeypressMode

Swift

struct SDLKeypressMode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLLanguage

Specifies the language to be used for TTS, VR, displayed messages/menus. Used in ChangeRegistration and RegisterAppInterface.

@since SDL 1.0

Objective-C

typedef SDLEnum SDLLanguage

Swift

struct SDLLanguage : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLLayoutMode

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

@since SDL 3.0

Objective-C

typedef SDLEnum SDLLayoutMode

Swift

struct SDLLayoutMode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLLightName

The name that identifies the Light

Objective-C

typedef SDLEnum SDLLightName

Swift

struct SDLLightName : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLLightStatus

Reflects the status of Light.

Objective-C

typedef SDLEnum SDLLightStatus

Swift

struct SDLLightStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLLockScreenStatus

Describes what the status of the lock screen should be

Used in OnLockScreenStatus

Objective-C

typedef SDLEnum SDLLockScreenStatus

Swift

struct SDLLockScreenStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLLogFilterBlock

A block that takes in a log model and returns whether or not the log passes the filter and should therefore be logged.

Objective-C

typedef BOOL (^SDLLogFilterBlock)(SDLLogModel *_Nonnull)

Swift

typealias SDLLogFilterBlock = (SDLLogModel) -> Bool

Parameters

log

The log model describing the log.

Return Value

Whether or not the log should be logged.

SDLMaintenanceModeStatus

Describes the maintenence mode. Used in nothing.

Objective-C

typedef SDLEnum SDLMaintenanceModeStatus

Swift

struct SDLMaintenanceModeStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLManagerReadyBlock

Undocumented

Objective-C

typedef void (^SDLManagerReadyBlock)(BOOL success, NSError *_Nullable error)

Swift

typealias SDLManagerReadyBlock = (Bool, Error?) -> Void

SDLMassageCushion

The List possible cushions of a multi-contour massage seat.

Objective-C

typedef SDLEnum SDLMassageCushion

Swift

struct SDLMassageCushion : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLMassageMode

The List possible modes of a massage zone.

Objective-C

typedef SDLEnum SDLMassageMode

Swift

struct SDLMassageMode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLMassageZone

List possible zones of a multi-contour massage seat.

Objective-C

typedef SDLEnum SDLMassageZone

Swift

struct SDLMassageZone : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLMediaClockFormat

Indicates the format of the time displayed on the connected SDL unit.

Format description follows the following nomenclature:
Sp = Space
| = or
c = character

Used in DisplayCapabilities

@since SDL 1.0

Objective-C

typedef SDLEnum SDLMediaClockFormat

Swift

struct SDLMediaClockFormat : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLMenuCellSelectionHandler

Undocumented

Objective-C

typedef void(^SDLMenuCellSelectionHandler)(SDLTriggerSource triggerSource)

Swift

typealias SDLMenuCellSelectionHandler = (SDLTriggerSource) -> Void

SDLMetadataType

Text Field metadata types. Used in Show.

Objective-C

typedef SDLEnum SDLMetadataType

Swift

struct SDLMetadataType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLModuleType

The type of remote control data. Used in ButtonPress, GetInteriorVehicleData, and ModuleData

Objective-C

typedef SDLEnum SDLModuleType

Swift

struct SDLModuleType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLNotificationName

Undocumented

Objective-C

typedef NOTIFICATION_TYPEDEF SDLNotificationName

Swift

typealias SDLNotificationName = NSString

SDLNotificationUserInfoKey

Undocumented

Objective-C

typedef NSString *SDLNotificationUserInfoKey

Swift

typealias SDLNotificationUserInfoKey = NSString

SDLAudioPassThruHandler

A handler used on SDLPerformAudioPassThru.

Objective-C

typedef void (^SDLAudioPassThruHandler)(NSData *_Nullable)

Swift

typealias SDLAudioPassThruHandler = (Data?) -> Void

Parameters

audioData

The audio data contained in the notification.

SDLResponseHandler

A handler used on all RPC requests which fires when the response is received.

Objective-C

typedef void (^SDLResponseHandler)(__kindof SDLRPCRequest *_Nullable,
                                   __kindof SDLRPCResponse *_Nullable,
                                   NSError *_Nullable)

Swift

typealias SDLResponseHandler = (SDLRPCRequest?, SDLRPCResponse?, Error?) -> Void

Parameters

request

The request which was sent.

response

The response which was received.

error

If sending the request encountered an error, this parameter will not be nil.

SDLMultipleRequestCompletionHandler

A completion handler called after a sequential or simultaneous set of requests have completed sending.

Objective-C

typedef void (^SDLMultipleRequestCompletionHandler)(BOOL)

Swift

typealias SDLMultipleRequestCompletionHandler = (Bool) -> Void

Parameters

success

True if every request succeeded, false if any failed. See the progress handler for more details on failures.

SDLMultipleSequentialRequestProgressHandler

A handler called after each response to a request comes in in a multiple request send.

Objective-C

typedef BOOL (^SDLMultipleSequentialRequestProgressHandler)(
    __kindof SDLRPCRequest *_Nonnull, __kindof SDLRPCResponse *_Nullable,
    NSError *_Nullable, float)

Swift

typealias SDLMultipleSequentialRequestProgressHandler = (SDLRPCRequest, SDLRPCResponse?, Error?, Float) -> Bool

Parameters

request

The request that received a response

response

The response received

error

The error that occurred during the request if any occurred.

percentComplete

The percentage of requests that have received a response

Return Value

continueSendingRequests NO to cancel any requests that have not yet been sent. This is really only useful for a sequential send (sendSequentialRequests:progressHandler:completionHandler:). Return YES to continue sending requests.

SDLMultipleAsyncRequestProgressHandler

A handler called after each response to a request comes in in a multiple request send.

Objective-C

typedef void (^SDLMultipleAsyncRequestProgressHandler)(
    __kindof SDLRPCRequest *_Nonnull, __kindof SDLRPCResponse *_Nullable,
    NSError *_Nullable, float)

Swift

typealias SDLMultipleAsyncRequestProgressHandler = (SDLRPCRequest, SDLRPCResponse?, Error?, Float) -> Void

Parameters

request

The request that received a response

response

The response received

error

The error that occurred during the request if any occurred.

percentComplete

The percentage of requests that have received a response

SDLRPCButtonNotificationHandler

A handler that may optionally be run when an SDLSubscribeButton or SDLSoftButton has a corresponding notification occur.

Warning

This only works if you send the RPC using SDLManager.

Warning

Only one of the two parameters will be set for each block call.

Objective-C

typedef void (^SDLRPCButtonNotificationHandler)(SDLOnButtonPress *_Nullable,
                                                SDLOnButtonEvent *_Nullable)

Swift

typealias SDLRPCButtonNotificationHandler = (SDLOnButtonPress?, SDLOnButtonEvent?) -> Void

Parameters

buttonPress

An SDLOnButtonPress object that corresponds to this particular button.

buttonEvent

An SDLOnButtonEvent object that corresponds to this particular button.

SDLRPCCommandNotificationHandler

A handler that may optionally be run when an SDLAddCommand has a corresponding notification occur.

Warning

This only works if you send the RPC using SDLManager.

Objective-C

typedef void (^SDLRPCCommandNotificationHandler)(SDLOnCommand *_Nonnull)

Swift

typealias SDLRPCCommandNotificationHandler = (SDLOnCommand) -> Void

Parameters

command

An SDLOnCommand object that corresponds to this particular SDLAddCommand.

SDLPRNDL

The selected gear the car is in. Used in retrieving vehicle data.

@since SDL 2.0

Objective-C

typedef SDLEnum SDLPRNDL

Swift

struct SDLPRNDL : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLPermissionRPCName

Undocumented

Objective-C

typedef NSString *SDLPermissionRPCName

Swift

typealias SDLPermissionRPCName = NSString

SDLPermissionObserverIdentifier

Undocumented

Objective-C

typedef NSUUID *SDLPermissionObserverIdentifier

Swift

typealias SDLPermissionObserverIdentifier = NSUUID

SDLPermissionsChangedHandler

The PermissionObserver is a block that is passed in to some methods that will be stored and called when specified permissions change.

Objective-C

typedef void (^SDLPermissionsChangedHandler)(
    NSDictionary<SDLPermissionRPCName, NSNumber<SDLBool> *> *_Nonnull,
    SDLPermissionGroupStatus)

Swift

typealias SDLPermissionsChangedHandler = ([String : NSNumber & SDLBool], SDLPermissionGroupStatus) -> Void

Parameters

change

A dictionary of permission changes containing

status

The change made to all of the RPCs in the changedDict. Allowed, if all RPCs are now allowed, Disallowed if all RPCs are now disallowed, or Mixed if some are allowed, and some are disallowed

SDLPermissionStatus

Enumeration that describes possible permission states of a policy table entry. Used in nothing.

@since SDL 2.0

Objective-C

typedef SDLEnum SDLPermissionStatus

Swift

struct SDLPermissionStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLPowerModeQualificationStatus

Describes the power mode qualification status. Used in ClusterModeStatus.

Objective-C

typedef SDLEnum SDLPowerModeQualificationStatus

Swift

struct SDLPowerModeQualificationStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLPowerModeStatus

The status of the car’s power. Used in ClusterModeStatus.

Objective-C

typedef SDLEnum SDLPowerModeStatus

Swift

struct SDLPowerModeStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLPredefinedLayout

A template layout an app uses to display information. The broad details of the layout are defined, but the details depend on the IVI system. Used in SetDisplayLayout.

Objective-C

typedef SDLEnum SDLPredefinedLayout

Swift

struct SDLPredefinedLayout : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLPrerecordedSpeech

Contains information about the speech capabilities on the SDL platform. Used in RegisterAppInterfaceResponse to indicate capability.

Objective-C

typedef SDLEnum SDLPrerecordedSpeech

Swift

struct SDLPrerecordedSpeech : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLPrimaryAudioSource

Reflects the current primary audio source of SDL (if selected). Used in DeviceStatus.

@since SDL 2.0

Objective-C

typedef SDLEnum SDLPrimaryAudioSource

Swift

struct SDLPrimaryAudioSource : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLRadioBand

Radio bands, such as AM and FM, used in RadioControlData

Objective-C

typedef SDLEnum SDLRadioBand

Swift

struct SDLRadioBand : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLRadioState

List possible states of a remote control radio module. Used in RadioControlData.

Objective-C

typedef SDLEnum SDLRadioState

Swift

struct SDLRadioState : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLRequestType

A type of system request. Used in SystemRequest.

Objective-C

typedef SDLEnum SDLRequestType

Swift

struct SDLRequestType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLResult

Defines the possible result codes returned by SDL to the application in a response to a requested operation. Used in RPC responses

@since SDL 1.0

Objective-C

typedef SDLEnum SDLResult

Swift

struct SDLResult : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLSamplingRate

Describes different sampling rates for PerformAudioPassThru and AudioPassThruCapabilities

@since SDL 2.0

Objective-C

typedef SDLEnum SDLSamplingRate

Swift

struct SDLSamplingRate : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLScreenManagerUpdateCompletionHandler

The handler run when the update has completed

Objective-C

typedef void (^SDLScreenManagerUpdateCompletionHandler)(NSError *_Nullable)

Swift

typealias SDLScreenManagerUpdateCompletionHandler = (Error?) -> Void

Parameters

error

An error if the update failed and an error occurred

SDLPreloadChoiceCompletionHandler

Return an error with userinfo [key: SDLChoiceCell, value: NSError] if choices failed to upload

Objective-C

typedef void (^SDLPreloadChoiceCompletionHandler)(NSError *_Nullable)

Swift

typealias SDLPreloadChoiceCompletionHandler = (Error?) -> Void

Parameters

error

The error if one occurred

SDLSeatMemoryActionType

List of possible actions on Seat Meomry

@since SDL 2.0

Objective-C

typedef SDLEnum SDLSeatMemoryActionType

Swift

struct SDLSeatMemoryActionType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLSoftButtonType

SoftButtonType (TEXT / IMAGE / BOTH). Used by SoftButton.

Objective-C

typedef SDLEnum SDLSoftButtonType

Swift

struct SDLSoftButtonType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLSpeechCapabilities

Undocumented

Objective-C

typedef SDLEnum SDLSpeechCapabilities

Swift

struct SDLSpeechCapabilities : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLStaticIconName

Undocumented

Objective-C

typedef SDLEnum SDLStaticIconName

Swift

struct SDLStaticIconName : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLVideoStreamManagerState

Undocumented

Objective-C

typedef NSString SDLVideoStreamManagerState

SDLAudioStreamManagerState

Undocumented

Objective-C

typedef NSString SDLAudioStreamManagerState

SDLAppState

Undocumented

Objective-C

typedef NSString SDLAppState

SDLSupportedSeat

List possible seats that is a remote controllable seat.

Objective-C

typedef SDLEnum SDLSupportedSeat

Swift

struct SDLSupportedSeat : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLSystemAction

Enumeration that describes system actions that can be triggered. Used in SoftButton.

Objective-C

typedef SDLEnum SDLSystemAction

Swift

struct SDLSystemAction : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLUpdateCapabilityHandler

A completion handler called after a request for the capability type is returned from the remote system.

Objective-C

typedef void (^SDLUpdateCapabilityHandler)(NSError *_Nullable,
                                           SDLSystemCapabilityManager *_Nonnull)

Swift

typealias SDLUpdateCapabilityHandler = (Error?, SDLSystemCapabilityManager) -> Void

Parameters

error

The error returned if the request for a capability type failed. The error is nil if the request was successful.

systemCapabilityManager

The system capability manager

SDLSystemCapabilityType

The type of system capability to get more information on. Used in GetSystemCapability.

Objective-C

typedef SDLEnum SDLSystemCapabilityType

Swift

struct SDLSystemCapabilityType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLSystemContext

Indicates whether or not a user-initiated interaction is in progress, and if so, in what mode (i.e. MENU or VR). Used in OnHMIStatus

@since SDL 1.0

Objective-C

typedef SDLEnum SDLSystemContext

Swift

struct SDLSystemContext : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLTBTState

The turn-by-turn state, used in OnTBTClientState.

Objective-C

typedef SDLEnum SDLTBTState

Swift

struct SDLTBTState : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLTPMS

An enum representing values of the tire pressure monitoring system

Objective-C

typedef SDLEnum SDLTPMS

Swift

struct SDLTPMS : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLTemperatureUnit

The unit of temperature to display. Used in Temperature.

Objective-C

typedef SDLEnum SDLTemperatureUnit

Swift

struct SDLTemperatureUnit : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLTextAlignment

The list of possible alignments of text in a field. May only work on some display types. used in Show.

@since SDL 1.0

Objective-C

typedef SDLEnum SDLTextAlignment

Swift

struct SDLTextAlignment : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLTextFieldName

Names of the text fields that can appear on a SDL display. Used in TextFieldName.

@since SDL 1.0

Objective-C

typedef SDLEnum SDLTextFieldName

Swift

struct SDLTextFieldName : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLTimerMode

The direction of a timer. Used in nothing.

Objective-C

typedef SDLEnum SDLTimerMode

Swift

struct SDLTimerMode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLTouchIdentifier

Undocumented

See more

Objective-C

typedef enum {
    SDLTouchIdentifierFirstFinger = 0,
    SDLTouchIdentifierSecondFinger = 1
} SDLTouchIdentifier

SDLTouchEventHandler

Undocumented

Objective-C

typedef void(^SDLTouchEventHandler)(SDLTouch *touch, SDLTouchType type)

Swift

typealias SDLTouchEventHandler = (SDLTouch, SDLTouchType) -> Void

SDLTouchType

The type of a touch in a projection application. Used in OnTouchEvent.

Objective-C

typedef SDLEnum SDLTouchType

Swift

struct SDLTouchType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLTriggerSource

Indicates whether choice/command was selected via VR or via a menu selection (using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN, OK buttons). Used in PerformInteractionResponse and OnCommand.

@since SDL 1.0

Objective-C

typedef SDLEnum SDLTriggerSource

Swift

struct SDLTriggerSource : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLTurnSignal

Undocumented

Objective-C

typedef SDLEnum SDLTurnSignal

Swift

struct SDLTurnSignal : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLUpdateMode

Specifies what function should be performed on the media clock/counter. Used in SetMediaClockTimer.

@since SDL 1.0

Objective-C

typedef SDLEnum SDLUpdateMode

Swift

struct SDLUpdateMode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLVehicleDataActiveStatus

Vehicle Data Activity Status. Used in nothing.

Objective-C

typedef SDLEnum SDLVehicleDataActiveStatus

Swift

struct SDLVehicleDataActiveStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLVehicleDataEventStatus

Reflects the status of a vehicle data event; e.g. a seat belt event status. Used in retrieving vehicle data.

@since SDL 2.0

Objective-C

typedef SDLEnum SDLVehicleDataEventStatus

Swift

struct SDLVehicleDataEventStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLVehicleDataNotificationStatus

Reflects the status of a vehicle data notification. Used in ECallInfo

@since SDL 2.0

Objective-C

typedef SDLEnum SDLVehicleDataNotificationStatus

Swift

struct SDLVehicleDataNotificationStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLVehicleDataResultCode

Vehicle Data Result Code. Used in DIDResult.

Objective-C

typedef SDLEnum SDLVehicleDataResultCode

Swift

struct SDLVehicleDataResultCode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLVehicleDataStatus

Reflects the status of a binary vehicle data item. Used in MyKey.

@since SDL 2.0

Objective-C

typedef SDLEnum SDLVehicleDataStatus

Swift

struct SDLVehicleDataStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLVehicleDataType

Defines the vehicle data types that can be published and/or subscribed to using SDLSubscribeVehicleData. Used in VehicleDataResult

Objective-C

typedef SDLEnum SDLVehicleDataType

Swift

struct SDLVehicleDataType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLVentilationMode

The ventilation mode. Used in ClimateControlCapabilities

Objective-C

typedef SDLEnum SDLVentilationMode

Swift

struct SDLVentilationMode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLVideoStreamingCodec

Enum for each type of video streaming codec. Used in VideoStreamingFormat.

Objective-C

typedef SDLEnum SDLVideoStreamingCodec

Swift

struct SDLVideoStreamingCodec : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLVideoStreamingProtocol

Enum for each type of video streaming protocol, used in VideoStreamingFormat

Objective-C

typedef SDLEnum SDLVideoStreamingProtocol

Swift

struct SDLVideoStreamingProtocol : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLVideoStreamingState

Enum for each type of video streaming protocol, used in VideoStreamingFormat

Objective-C

typedef SDLEnum SDLVideoStreamingState

Swift

struct SDLVideoStreamingState : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLVoiceCommandSelectionHandler

Undocumented

Objective-C

typedef void(^SDLVoiceCommandSelectionHandler)(void)

Swift

typealias SDLVoiceCommandSelectionHandler = () -> Void

SDLVRCapabilities

The VR capabilities of the connected SDL platform. Used in RegisterAppInterfaceResponse.

@since SDL 1.0

Objective-C

typedef SDLEnum SDLVRCapabilities

Swift

struct SDLVRCapabilities : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLWarningLightStatus

Reflects the status of a cluster instrument warning light. Used in TireStatus

@since SDL 2.0

Objective-C

typedef SDLEnum SDLWarningLightStatus

Swift

struct SDLWarningLightStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLWayPointType

The type of a navigation waypoint. Used in GetWayPoints.

Objective-C

typedef SDLEnum SDLWayPointType

Swift

struct SDLWayPointType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

SDLWiperStatus

The status of the windshield wipers. Used in retrieving vehicle data.

Objective-C

typedef SDLEnum SDLWiperStatus

Swift

struct SDLWiperStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable
View on GitHub.com