The following classes are available globally.
+ + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +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: +
The set of choices which the application builds using SDLAddCommand can be a + mixture of: +
HMILevel needs to be FULL, LIMITED or BACKGROUD
+ +@since SDL 1.0
+ +See
+ SDLDeleteCommand SDLAddSubMenu SDLDeleteSubMenu + +@interface SDLAddCommand : SDLRPCRequestclass SDLAddCommand : SDLRPCRequestSDLAddCommandResponse is sent, when SDLAddCommand has been called
+ +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLAddCommandResponse : SDLRPCResponseclass SDLAddCommandResponse : SDLRPCResponseAdd a SDLSubMenu to the Command Menu +
+ A SDLSubMenu can only be added to the Top Level Menu (i.e.a SDLSubMenu cannot be + added to a SDLSubMenu), and may only contain commands as children +
+
+ HMILevel needs to be FULL, LIMITED or BACKGROUD +
+ +Since SmartDeviceLink 1.0
+ see SDLDeleteSubMenu SDLAddCommand SDLDeleteCommand
@interface SDLAddSubMenu : SDLRPCRequestclass SDLAddSubMenu : SDLRPCRequestSDLAddSubMenuResponse is sent, when SDLAddSubMenu has been called +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLAddSubMenuResponse : SDLRPCResponseclass SDLAddSubMenuResponse : SDLRPCResponseUndocumented
+ + See more + + + + + +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.
+ +@since SDL 1.0
+ + See more + + +@interface SDLAlert : SDLRPCRequestclass SDLAlert : SDLRPCRequest@since SmartDeviceLink 1.0
+ + See more + + +@interface SDLAlertManeuver : SDLRPCRequestclass SDLAlertManeuver : SDLRPCRequestSDLAlertManeuverResponse is sent, when SDLAlertManeuver has been called. + * @since SmartDeviceLink 1.0
+ + See more + + +@interface SDLAlertManeuverResponse : SDLRPCResponseclass SDLAlertManeuverResponse : SDLRPCResponseSent after SDLAlert has been sent +@since SDL 1.0
+ + See more + + +@interface SDLAlertResponse : SDLRPCResponseclass SDLAlertResponse : SDLRPCResponseReflects the status of the ambient light sensor +@since SDL 3.0
+ + See more + + +@interface SDLAmbientLightStatus : SDLEnumclass SDLAmbientLightStatus : SDLEnumEnumeration listing possible app hmi types.
+ +@since SDL 2.0
+ + See more + + +@interface SDLAppHMIType : SDLEnumclass SDLAppHMIType : SDLEnumIndicates reason why app interface was unregistered. The application is being disconnected by SDL.
+ +@since SDL 1.0
+ + See more + + +@interface SDLAppInterfaceUnregisteredReason : SDLEnumclass SDLAppInterfaceUnregisteredReason : SDLEnumDescribes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM} +
Parameter List +
| Name | +Type | +Description | +SmartDeviceLink Ver. Available | +
|---|---|---|---|
| samplingRate | +SDLSamplingRate * | +Describes the sampling rate for AudioPassThru + | +SmartDeviceLink 2.0 | +
| bitsPerSample | +SDLBitsPerSample * | +Describes the sample depth in bit for AudioPassThru + | +SmartDeviceLink 2.0 | +
| audioType | +SDLAudioType * | +Describes the audiotype for AudioPassThru + | +SmartDeviceLink 2.0 | +
@interface SDLAudioPassThruCapabilities : SDLRPCStructclass SDLAudioPassThruCapabilities : SDLRPCStructDescribes 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
+ + See more + + +@interface SDLAudioStreamingState : SDLEnumclass SDLAudioStreamingState : SDLEnumDescribes different audio type options for PerformAudioPassThru
+ + See more + + +@interface SDLAudioType : SDLEnumclass SDLAudioType : SDLEnumUndocumented
+ + See more + + + + + +Describes different bit depth options for PerformAudioPassThru
+ +@since SDL 2.0
+ + See more + + +@interface SDLBitsPerSample : SDLEnumclass SDLBitsPerSample : SDLEnumThe body information including power modes.
+ + See more + + +@interface SDLBodyInformation : SDLRPCStructclass SDLBodyInformation : SDLRPCStructProvides information about the capabilities of a SDL HMI button.
+ +@since SDL 1.0
+ + See more + + +@interface SDLButtonCapabilities : SDLRPCStructclass SDLButtonCapabilities : SDLRPCStructIndicates whether the button was depressed or released. A BUTTONUP event will always be preceded by a BUTTONDOWN event.
+ +@since SDL 1.0
+ + See more + + +@interface SDLButtonEventMode : SDLEnumclass SDLButtonEventMode : SDLEnumDefines 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
+ + See more + + +@interface SDLButtonName : SDLEnumclass SDLButtonName : SDLEnumIndicates whether this is a LONG or SHORT button press
+ +@since SDL 1.0
+ + See more + + +@interface SDLButtonPressMode : SDLEnumclass SDLButtonPressMode : SDLEnumDescribes the carmode the vehicle is in. + * Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLCarModeStatus : SDLEnumclass SDLCarModeStatus : SDLEnumIf the app recognizes during the app registration that the SDL HMI language (voice/TTS and/or display) does not match the app language, the app will be able (but does not need) to change this registration with changeRegistration prior to app being brought into focus.
+ +Any HMILevel allowed
+ +@since SDL 2.0
+ + See more + + +@interface SDLChangeRegistration : SDLRPCRequestclass SDLChangeRegistration : SDLRPCRequestSDLChangeRegistrationResponse is sent, when SDLChangeRegistration has been called
+ +@since SDL 2.0
+ + See more + + +@interface SDLChangeRegistrationResponse : SDLRPCResponseclass SDLChangeRegistrationResponse : SDLRPCResponseCharacter sets supported by SDL.
+ +@since SDL 1.0
+ + See more + + +@interface SDLCharacterSet : SDLEnumclass SDLCharacterSet : SDLEnumA 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 +
| Name | +Type | +Description | +SmartDeviceLink Ver. Available | +
|---|---|---|---|
| choiceID | +NSNumber * | +Application-scoped identifier that uniquely identifies this choice.
+ Min: 0 + Max: 65535 + |
+ SmartDeviceLink 1.0 | +
| menuName | +NSString * | +Text which appears in menu, representing this choice.
+ Min: 1 + Max: 100 + |
+ SmartDeviceLink 1.0 | +
| vrCommands | +NSMutableArray * | +An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element | +SmartDeviceLink 1.0 | +
| image | +SDLImage * | +Either a static hex icon value or a binary image file name identifier (sent by PutFile). | +SmartDeviceLink 2.0 | +
Since SmartDeviceLink 1.0
@interface SDLChoice : SDLRPCStructclass SDLChoice : SDLRPCStructUndocumented
+ + See more + + + + + +The list of potential compass directions.
+ +@since SDL 2.0
+ + See more + + +@interface SDLCompassDirection : SDLEnumclass SDLCompassDirection : SDLEnumThe volume status of a vehicle component.
+ +@since SDL 2.0
+ + See more + + +@interface SDLComponentVolumeStatus : SDLEnumclass SDLComponentVolumeStatus : SDLEnumUndocumented
+ + See more + + + + + +Creates a Choice Set which can be used in subsequent SDLPerformInteraction Operations.
+ +HMILevel needs to be FULL, LIMITED or BACKGROUND
+ +Before a perform interaction is sent you MUST wait for the success from the CreateInteractionChoiceSet RPC.
+ +If you do not wait the system may not recognize the first utterance from the user.
+ +@since SDL 1.0
+ +See
+ SDLDeleteInteractionChoiceSet SDLPerformInteraction + +@interface SDLCreateInteractionChoiceSet : SDLRPCRequestclass SDLCreateInteractionChoiceSet : SDLRPCRequestSDLCreateInteractionChoiceSetResponse is sent, when SDLCreateInteractionChoiceSet + has been called
+ +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLCreateInteractionChoiceSetResponse : SDLRPCResponseclass SDLCreateInteractionChoiceSetResponse : SDLRPCResponseUndocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Removes a command from the Command Menu +
+ HMI Status Requirements:
+ HMILevel: FULL, LIMITED or BACKGROUND
+ AudioStreamingState: N/A
+ SystemContext: Should not be attempted when VRSESSION or MENU
+
Since SmartDeviceLink 1.0
+ see SDLAddCommand SDLAddSubMenu SDLDeleteSubMenu
@interface SDLDeleteCommand : SDLRPCRequestclass SDLDeleteCommand : SDLRPCRequestSDLDeleteCommandResponse is sent, when SDLDeleteCommand has been called
+ +Since SmartDeviceLink 1.0
@interface SDLDeleteCommandResponse : SDLRPCResponseclass SDLDeleteCommandResponse : SDLRPCResponseUsed to delete a file resident on the SDL module in the app’s local cache. + Not supported on first generation SDL vehicles +
+ +Since SmartDeviceLink 2.0
+ see SDLPutFile SDLListFiles
@interface SDLDeleteFile : SDLRPCRequestclass SDLDeleteFile : SDLRPCRequestDelete File Response is sent, when DeleteFile has been called
+ +Since SmartDeviceLink 2.0
@interface SDLDeleteFileResponse : SDLRPCResponseclass SDLDeleteFileResponse : SDLRPCResponseDeletes an existing Choice Set identified by the parameter + interactionChoiceSetID. If the specified interactionChoiceSetID is currently + in use by an active SDLPerformInteraction this call to + delete the Choice Set will fail returning an IN_USE resultCode +
+ Function Group: Base +
+ HMILevel needs to be FULL, LIMITED or BACKGROUD
+
Since SmartDeviceLink 1.0
+ see SDLCreateInteractionChoiceSet SDLPerformInteraction
@interface SDLDeleteInteractionChoiceSet : SDLRPCRequestclass SDLDeleteInteractionChoiceSet : SDLRPCRequestSDLDeleteInteractionChoiceSetResponse is sent, when SDLDeleteInteractionChoiceSet has been called
+ +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLDeleteInteractionChoiceSetResponse : SDLRPCResponseclass SDLDeleteInteractionChoiceSetResponse : SDLRPCResponseDeletes a submenu from the Command Menu +
+ Notes: When an app deletes a submenu that has child commands, those + child commands are also deleted +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 1.0
+ see SDLAddCommand SDLAddSubMenu SDLDeleteCommand
@interface SDLDeleteSubMenu : SDLRPCRequestclass SDLDeleteSubMenu : SDLRPCRequestSDLDeleteSubMenuResponse is sent, when SDLDeleteSubMenu has been called
+ +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLDeleteSubMenuResponse : SDLRPCResponseclass SDLDeleteSubMenuResponse : SDLRPCResponseUndocumented
+ + See more + + + + + +Reflects the reported battery status of the connected device, if reported.
+ +@since SDL 2.0
+ + See more + + +@interface SDLDeviceLevelStatus : SDLEnumclass SDLDeviceLevelStatus : SDLEnumDescribes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.
+ +Parameter List +
| Name | +Type | +Description | +SmartDeviceLink Ver. Available | +
|---|---|---|---|
| voiceRecOn | +NSNumber * | +Voice recognition is on + | +SmartDeviceLink 2.0 | +
| btIconOn | +NSNumber * | +Bluetooth connection established + | +SmartDeviceLink 2.0 | +
| callActive | +NSNumber * | +A call is being active + | +SmartDeviceLink 2.0 | +
| phoneRoaming | +NSNumber * | +The phone is in roaming mode + | +SmartDeviceLink 2.0 | +
| textMsgAvailable | +NSNumber * | +A textmessage is available + | +SmartDeviceLink 2.0 | +
| battLevelStatus | +SDLDeviceLevelStatus * | +Battery level status + | +SmartDeviceLink 2.0 | +
| stereoAudioOutputMuted | +NSNumber * | +Status of the stereo audio output channel + | +SmartDeviceLink 2.0 | +
| monoAudioOutputMuted | +NSNumber * | +Status of the mono audio output channel + | +SmartDeviceLink 2.0 | +
| signalLevelStatus | +SDLDeviceLevelStatus * | +Signal level status + | +SmartDeviceLink 2.0 | +
| primaryAudioSource | +PrimaryAudioSource * | +Reflects the current primary audio source of SDL (if selected). + | +SmartDeviceLink 2.0 | +
| eCallEventActive | +NSNumber * | +Reflects, if an eCall event is active + | +SmartDeviceLink 2.0 | +
@interface SDLDeviceStatus : SDLRPCStructclass SDLDeviceStatus : SDLRPCStructNon periodic vehicle diagnostic request
+ +@since SDL 3.0
+ + See more + + +@interface SDLDiagnosticMessage : SDLRPCRequestclass SDLDiagnosticMessage : SDLRPCRequestSDLDiagnosticMessageResponse is sent, when SDLDiagnosticMessage has been called. + * SinceSmartDeviceLink 3.0
+ + See more + + +@interface SDLDiagnosticMessageResponse : SDLRPCResponseclass SDLDiagnosticMessageResponse : SDLRPCResponseThis RPC is used to tell the head unit to use bluetooth to dial a phone number using the phone.
+ +@since SDL 4.0
+ + See more + + +@interface SDLDialNumber : SDLRPCRequestclass SDLDialNumber : SDLRPCRequestIndicates the result, success, or failure of the SDLDialNumber request.
+ +@since SDL 4.0
+ + See more + + +@interface SDLDialNumberResponse : SDLRPCResponseclass SDLDialNumberResponse : SDLRPCResponseThe supported dimensions of the GPS.
+ +@since SDL 2.0
+ + See more + + +@interface SDLDimension : SDLEnumclass SDLDimension : SDLEnumContains information about the display for the SDL system to which the application is currently connected.
+ +@since SDL 1.0
+ + See more + + +@interface SDLDisplayCapabilities : SDLRPCStructclass SDLDisplayCapabilities : SDLRPCStructIdentifies the various display types used by SDL.
+ +@since SDL 1.0
+ + See more + + +@interface SDLDisplayType : SDLEnumclass SDLDisplayType : SDLEnumEnumeration that describes possible states of driver distraction.
+ +@since SDL 1.0
+ + See more + + +@interface SDLDriverDistractionState : SDLEnumclass SDLDriverDistractionState : SDLEnumReflects the status of the eCall Notification. + *Since SmartDeviceLink 2.0 +
+ + See more + + +@interface SDLECallConfirmationStatus : SDLEnumclass SDLECallConfirmationStatus : SDLEnumUndocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Reflects the emergency event status of the vehicle. + * Since: SmartDeviceLink 2.0 + *
+ + See more + + +@interface SDLEmergencyEventType : SDLEnumclass SDLEmergencyEventType : SDLEnumUndocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +When this request is invoked, the audio capture stops +
+Function Group: AudioPassThru +
+HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 2.0
+see SDLPerformAudioPassThru
@interface SDLEndAudioPassThru : SDLRPCRequestclass SDLEndAudioPassThru : SDLRPCRequestSDLEndAudioPassThruResponse is sent, when SDLEndAudioPassThru has been called
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLEndAudioPassThruResponse : SDLRPCResponseclass SDLEndAudioPassThruResponse : SDLRPCResponseUndocumented
+ + See more + + + + + +Enumeration listing possible file types.
+ +@since SDL 2.0
+ + See more + + +@interface SDLFileType : SDLEnumclass SDLFileType : SDLEnumReflects 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
+ + See more + + +@interface SDLFuelCutoffStatus : SDLEnumclass SDLFuelCutoffStatus : SDLEnumDescribes the GPS data. Not all data will be available on all carlines.
+ +@since SDL 2.0
+ + See more + + +@interface SDLGPSData : SDLRPCStructclass SDLGPSData : SDLRPCStructGeneric 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.
+ + See more + + +@interface SDLGenericResponse : SDLRPCResponseclass SDLGenericResponse : SDLRPCResponseThis RPC allows to request diagnostic module trouble codes from a certain +vehicle module +
+Function Group: ProprietaryData +
+HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ + See more + + +@interface SDLGetDTCs : SDLRPCRequestclass SDLGetDTCs : SDLRPCRequestSDLGetDTCsResponse is sent, when SDLGetDTCs has been called
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLGetDTCsResponse : SDLRPCResponseclass SDLGetDTCsResponse : SDLRPCResponseRequests surrent values of specific published vehicle data items. +
+ Function Group: Location, VehicleInfo and DrivingChara +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 2.0
+ See SDLSubscribeVehicleData SDLUnsubscribeVehicleData
@interface SDLGetVehicleData : SDLRPCRequestclass SDLGetVehicleData : SDLRPCRequestGet Vehicle Data Response is sent, when SDLGetVehicleData has been called
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLGetVehicleDataResponse : SDLRPCResponseclass SDLGetVehicleDataResponse : SDLRPCResponseProperties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button).
+ +@since SDL 1.0
+ + See more + + +@interface SDLGlobalProperty : SDLEnumclass SDLGlobalProperty : SDLEnumUndocumented
+ + See more + + + + + +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
+ + See more + + +@interface SDLHMILevel : SDLEnumclass SDLHMILevel : SDLEnumDefining sets of HMI levels, which are permitted or prohibited for a given RPC.
+ +@since SDL 2.0
+ + See more + + +@interface SDLHMIPermissions : SDLRPCStructclass SDLHMIPermissions : SDLRPCStructSpecifies HMI Zones in the vehicle.
+ +@since SDL 1.0
+ + See more + + +@interface SDLHMIZoneCapabilities : SDLEnumclass SDLHMIZoneCapabilities : SDLEnumStatus of the head lamps
+ + See more + + +@interface SDLHeadLampStatus : SDLRPCStructclass SDLHeadLampStatus : SDLRPCStructUndocumented
+ + See more + + + + + +Reflects the ignition switch stability.
+ +@since SDL 2.0
+ + See more + + +@interface SDLIgnitionStableStatus : SDLEnumclass SDLIgnitionStableStatus : SDLEnumReflects the status of ignition..
+ +@since SDL 2.0
+ + See more + + +@interface SDLIgnitionStatus : SDLEnumclass SDLIgnitionStatus : SDLEnumSpecifies, which image shall be used, e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it.
+ +@since SDL 2.0
+ + See more + + +@interface SDLImage : SDLRPCStructclass SDLImage : SDLRPCStructUndocumented
+ + See more + + + + + +The name that identifies the filed. + * + * + * @since SmartDeviceLink 3.0 + *
+ + See more + + +@interface SDLImageFieldName : SDLEnumclass SDLImageFieldName : SDLEnumUndocumented
+ + See more + + + + + +Contains information about the type of image.
+ +@since SDL 2.0
+ + See more + + +@interface SDLImageType : SDLEnumclass SDLImageType : SDLEnumFor 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
+ + See more + + +@interface SDLInteractionMode : SDLEnumclass SDLInteractionMode : SDLEnumUndocumented
+ + See more + + + + + +Enumeration listing possible keyboard events. + * + * @since SmartDeviceLink 3.0 + *
+ + See more + + +@interface SDLKeyboardEvent : SDLEnumclass SDLKeyboardEvent : SDLEnumEnumeration listing possible keyboard layouts + * + *Since SmartDeviceLink 3.0 + *
+ + See more + + +@interface SDLKeyboardLayout : SDLEnumclass SDLKeyboardLayout : SDLEnumUndocumented
+ + See more + + + + + +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
+ *
@interface SDLKeypressMode : SDLEnumclass SDLKeypressMode : SDLEnumSpecifies the language to be used for TTS, VR, displayed messages/menus
+ +@since SDL 1.0
+ + See more + + +@interface SDLLanguage : SDLEnumclass SDLLanguage : SDLEnumFor touchscreen interactions, the mode of how the choices are presented.
+ +@since SDL 3.0
+ + See more + + +@interface SDLLayoutMode : SDLEnumclass SDLLayoutMode : SDLEnumRequests the current list of resident filenames for the registered app. Not + supported on First generation SDL vehicles +
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLListFiles : SDLRPCRequestclass SDLListFiles : SDLRPCRequestSDLListFilesResponse is sent, when SDLListFiles has been called
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLListFilesResponse : SDLRPCResponseclass SDLListFilesResponse : SDLRPCResponseUndocumented
+ + See more + + + + + +The SDLMaintenanceModeStatus class.
+ + See more + + +@interface SDLMaintenanceModeStatus : SDLEnumclass SDLMaintenanceModeStatus : SDLEnumIndicates 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
+ + See more + + +@interface SDLMediaClockFormat : SDLEnumclass SDLMediaClockFormat : SDLEnumUsed when adding a sub menu to an application menu or existing sub menu.
+ +@since SDL 1.0
+ + See more + + +@interface SDLMenuParams : SDLRPCStructclass SDLMenuParams : SDLRPCStructUndocumented
+ + See more + + + + + +Notifies an application that its interface registration has been terminated. This means that all SDL resources associated with the application are discarded, including the Command Menu, Choice Sets, button subscriptions, etc.
+ +For more information about SDL resources related to an interface registration, see SDLRegisterAppInterface.
+ +@since SDL 1.0 + - see: SDLRegisterAppInterface
+ + See more + + +@interface SDLOnAppInterfaceUnregistered : SDLRPCNotificationclass SDLOnAppInterfaceUnregistered : SDLRPCNotificationBinary data is in binary part of hybrid msg.
+ +HMI Status Requirements: +
@interface SDLOnAudioPassThru : SDLRPCNotificationclass SDLOnAudioPassThru : SDLRPCNotificationNotifies application that user has depressed or released a button to which + the application has subscribed.
+ +Further information about button events + and button-presses can be found at SDLSubscribeButton. +
+
+ +HMI Status Requirements: +
See
+ SDLSubscribeButton + +@since SDL 1.0
+ + See more + + +@interface SDLOnButtonEvent : SDLRPCNotificationclass SDLOnButtonEvent : SDLRPCNotificationNotifies application of button press events for buttons to which the + application is subscribed. SDL supports two button press events defined as + follows:
+ +See
+ SDLSubscribeButton + +See
+ SDLUnsubscribeButton + +@since SDL 1.0
+ + See more + + +@interface SDLOnButtonPress : SDLRPCNotificationclass SDLOnButtonPress : SDLRPCNotificationThis is called when a command was selected via VR after pressing the PTT button, or selected from the menu after + pressing the MENU button.
+ +Note: The sequence of SDLOnHMIStatus and SDLOnCommand notifications for user-initiated interactions is indeterminate.
+ +@since SDL 1.0 + - see: SDLAddCommand SDLDeleteCommand SDLDeleteSubMenu
+ + See more + + +@interface SDLOnCommand : SDLRPCNotificationclass SDLOnCommand : SDLRPCNotificationNotifies the application of the current driver distraction state (whether driver distraction rules are in effect, or + not).
+ +HMI Status Requirements:
+ +@since SDL 1.0
+ + See more + + +@interface SDLOnDriverDistraction : SDLRPCNotificationclass SDLOnDriverDistraction : SDLRPCNotificationUndocumented
+ + See more + + + + + +Notifies an application that HMI conditions have changed for the application. This indicates whether the application + can speak phrases, display text, perform interactions, receive button presses and events, stream audio, etc. This + notification will be sent to the application when there has been a change in any one or several of the indicated + states (SDLHMILevel, SDLAudioStreamingState or SDLSystemContext) for the application.
+ +All three values are, in principle, independent of each other (though there may be some relationships). A value for + one parameter should not be interpreted from the value of another parameter.
+ +There are no guarantees about the timeliness or latency of the SDLOnHMIStatus notification. Therefore, for example, + information such as SDLAudioStreamingState may not indicate that the audio stream became inaudible to the user + exactly when the SDLOnHMIStatus notification was received.
+ +@since SDL 1.0
+ + See more + + +@interface SDLOnHMIStatus : SDLRPCNotificationclass SDLOnHMIStatus : SDLRPCNotificationUndocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Provides information to what language the SDL HMI language was changed
+ +@since SDL 2.0
+ + See more + + +@interface SDLOnLanguageChange : SDLRPCNotificationclass SDLOnLanguageChange : SDLRPCNotificationTo help prevent driver distraction, any SmartDeviceLink application is required to implement a lockscreen that must be enforced while the application is active on the system while the vehicle is in motion.
+
+This lockscreen must perform the following:
+Limit all application control usability from the mobile device with a full-screen static image overlay or separate view.
+For simplicity, the OnLockScreenStatus RPC will be provided via the onOnLockScreenNotification call back. The call back will include the LockScreenStatus enum which indicates if the lockscreen is required, optional or not required.
+The call back also includes details regarding the current HMI_Status level, driver distraction status and user selection status of the application.
+@interface SDLOnLockScreenStatus : SDLRPCNotificationclass SDLOnLockScreenStatus : SDLRPCNotificationProvides update to app of which sets of functions are available
+ +@since SDL 2.0
+ + See more + + +@interface SDLOnPermissionsChange : SDLRPCNotificationclass SDLOnPermissionsChange : SDLRPCNotificationUndocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Request vehicle data.
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLOnVehicleData : SDLRPCNotificationclass SDLOnVehicleData : SDLRPCNotificationThe selected gear the car is in.
+ +@since SDL 2.0
+ + See more + + +@interface SDLPRNDL : SDLEnumclass SDLPRNDL : SDLEnumDefining sets of parameters, which are permitted or prohibited for a given RPC.
+ +@since SDL 2.0
+ + See more + + +@interface SDLParameterPermissions : SDLRPCStructclass SDLParameterPermissions : SDLRPCStructThis will open an audio pass thru session. By doing so the app can receive + audio data through the vehicle microphone +
+ Function Group: AudioPassThru +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 2.0
+ +See SDLEndAudioPassThru
+ + See more + + +@interface SDLPerformAudioPassThru : SDLRPCRequestclass SDLPerformAudioPassThru : SDLRPCRequestPerform Audio Pass Thru Response is sent, when PerformAudioPassThru has been called
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLPerformAudioPassThruResponse : SDLRPCResponseclass SDLPerformAudioPassThruResponse : SDLRPCResponsePerforms 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 +
+ Function Group: Base +
+ HMILevel needs to be FULL +
+ +Since SmartDeviceLink 1.0
+ See SDLCreateInteractionChoiceSet SDLDeleteInteractionChoiceSet
@interface SDLPerformInteraction : SDLRPCRequestclass SDLPerformInteraction : SDLRPCRequestPerformInteraction Response is sent, when SDLPerformInteraction has been called
+ +@since SDL 1.0
+ + See more + + +@interface SDLPerformInteractionResponse : SDLRPCResponseclass SDLPerformInteractionResponse : SDLRPCResponseUndocumented
+ + See more + + + + + +Enumeration that describes possible permission states of a policy table entry.
+ +@since SDL 2.0
+ + See more + + +@interface SDLPermissionStatus : SDLEnumclass SDLPermissionStatus : SDLEnumUndocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Contains information about on-screen preset capabilities.
+ +@since SDL 2.0
+ + See more + + +@interface SDLPresetBankCapabilities : SDLRPCStructclass SDLPresetBankCapabilities : SDLRPCStructReflects the current primary audio source of SDL (if selected).
+ +@since SDL 2.0
+ + See more + + +@interface SDLPrimaryAudioSource : SDLEnumclass SDLPrimaryAudioSource : SDLEnumUndocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +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
+ + See more + + +@interface SDLPutFile : SDLRPCRequestclass SDLPutFile : SDLRPCRequestPut File Response is sent, when SDLPutFile has been called
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLPutFileResponse : SDLRPCResponseclass SDLPutFileResponse : SDLRPCResponseUndocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Non periodic vehicle data read request. This is an RPC to get diagnostics + data from certain vehicle modules. DIDs of a certain module might differ from + vehicle type to vehicle type +
+ Function Group: ProprietaryData +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLReadDID : SDLRPCRequestclass SDLReadDID : SDLRPCRequestRead DID Response is sent, when ReadDID has been called
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLReadDIDResponse : SDLRPCResponseclass SDLReadDIDResponse : SDLRPCResponseRegisters 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:
+
+ 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
+ +See
+ SDLUnregisterAppInterface SDLOnAppInterfaceUnregistered + +@interface SDLRegisterAppInterface : SDLRPCRequestclass SDLRegisterAppInterface : SDLRPCRequest@abstract Register AppInterface Response is sent, when SDLRegisterAppInterface has been called
+ +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLRegisterAppInterfaceResponse : SDLRPCResponseclass SDLRegisterAppInterfaceResponse : SDLRPCResponseUndocumented
+ + See more + + + + + +Resets the passed global properties to their default values as defined by + SDL +
+ The HELPPROMPT global property default value is generated by SDL consists of
+ the first vrCommand of each Command Menu item defined at the moment PTT is
+ pressed
+ The TIMEOUTPROMPT global property default value is the same as the HELPPROMPT
+ global property default value
+
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 1.0 + See SetGlobalProperties
+ + See more + + +@interface SDLResetGlobalProperties : SDLRPCRequestclass SDLResetGlobalProperties : SDLRPCRequestReset Global Properties Response is sent, when SDLResetGlobalProperties has been called
+ +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLResetGlobalPropertiesResponse : SDLRPCResponseclass SDLResetGlobalPropertiesResponse : SDLRPCResponseDefines the possible result codes returned by SDL to the application in a response to a requested operation
+ +@since SDL 1.0
+ + See more + + +@interface SDLResult : SDLEnumclass SDLResult : SDLEnumDescribes different sampling rates for PerformAudioPassThru
+ +@since SDL 2.0
+ + See more + + +@interface SDLSamplingRate : SDLEnumclass SDLSamplingRate : SDLEnumUndocumented
+ + See more + + + + + +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 +
+HMILevel needs to be FULL +
+ + See more + + +@interface SDLScrollableMessage : SDLRPCRequestclass SDLScrollableMessage : SDLRPCRequestScrollable Message Response is sent, when SDLScrollableMessage has been called
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLScrollableMessageResponse : SDLRPCResponseclass SDLScrollableMessageResponse : SDLRPCResponseUndocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Used to set existing local file on SDL as the app’s icon. Not supported on + first generation SDL modules. +
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLSetAppIcon : SDLRPCRequestclass SDLSetAppIcon : SDLRPCRequestSDLSetAppIconResponse is sent, when SDLSetAppIcon has been called. + * SinceSmartDeviceLink 2.0
+ + See more + + +@interface SDLSetAppIconResponse : SDLRPCResponseclass SDLSetAppIconResponse : SDLRPCResponseUsed to set an alternate display layout. If not sent, default screen for + given platform will be shown
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLSetDisplayLayout : SDLRPCRequestclass SDLSetDisplayLayout : SDLRPCRequestSet Display Layout Response is sent, when SetDisplayLayout has been called
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLSetDisplayLayoutResponse : SDLRPCResponseclass SDLSetDisplayLayoutResponse : SDLRPCResponseSets value(s) for the specified global property(ies) +
+ Function Group: Base
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 1.0 + See SDLResetGlobalProperties
+ + See more + + +@interface SDLSetGlobalProperties : SDLRPCRequestclass SDLSetGlobalProperties : SDLRPCRequestSet Global Properties Response is sent, when SDLSetGlobalProperties has been called
+ +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLSetGlobalPropertiesResponse : SDLRPCResponseclass SDLSetGlobalPropertiesResponse : SDLRPCResponseSets the media clock/timer value and the update method (e.g.count-up, + count-down, etc.) +
+ Function Group: Base
+ HMILevel needs to be FULL, LIMITIED or BACKGROUND +
+ +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLSetMediaClockTimer : SDLRPCRequestclass SDLSetMediaClockTimer : SDLRPCRequestSet Media Clock Timer Response is sent, when SDLSetMediaClockTimer has been called
+ +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLSetMediaClockTimerResponse : SDLRPCResponseclass SDLSetMediaClockTimerResponse : SDLRPCResponseUpdates the application’s display text area, regardless of whether or not + this text area is visible to the user at the time of the request. The + application’s display text area remains unchanged until updated by subsequent + calls to Show +
+ The content of the application’s display text area is visible to the user + when the application + is FULL or LIMITED, and the + SDLSystemContext=MAIN and no + SDLAlert is in progress +
+ The Show operation cannot be used to create an animated scrolling screen. To + avoid distracting the driver, Show commands cannot be issued more than once + every 4 seconds. Requests made more frequently than this will be rejected +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 1.0 + See SDLAlert SDLSetMediaClockTimer
+ + See more + + +@interface SDLShow : SDLRPCRequestclass SDLShow : SDLRPCRequestThis 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
+ + See more + + +@interface SDLShowConstantTBT : SDLRPCRequestclass SDLShowConstantTBT : SDLRPCRequestSDLShowConstantTBTResponse is sent, when SDLShowConstantTBT has been called. + * SinceSmartDeviceLink 2.0
+ + See more + + +@interface SDLShowConstantTBTResponse : SDLRPCResponseclass SDLShowConstantTBTResponse : SDLRPCResponseShow Response is sent, when Show has been called
+ +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLShowResponse : SDLRPCResponseclass SDLShowResponse : SDLRPCResponseTire pressure status of a single tire.
+ +@since SmartDeviceLink 2.0
+ + See more + + +@interface SDLSingleTireStatus : SDLRPCStructclass SDLSingleTireStatus : SDLRPCStructUndocumented
+ + See more + + + + + +Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider
+ +HMILevel needs to be FULL
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLSlider : SDLRPCRequestclass SDLSlider : SDLRPCRequestSlider Response is sent, when Slider has been called
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLSliderResponse : SDLRPCResponseclass SDLSliderResponse : SDLRPCResponseUndocumented
+ + See more + + + + + +Contains information about a SoftButton’s capabilities.
+ +@since SDL 2.0
+ + See more + + +@interface SDLSoftButtonCapabilities : SDLRPCStructclass SDLSoftButtonCapabilities : SDLRPCStructSoftButtonType (TEXT / IMAGE / BOTH)
+ + See more + + +@interface SDLSoftButtonType : SDLEnumclass SDLSoftButtonType : SDLEnumSpeaks a phrase over the vehicle audio system using SDL’s TTS (text-to-speech) engine. The provided text to be spoken can be simply a text phrase, or it can consist of phoneme specifications to direct SDL’s TTS engine to speak a speech-sculpted
phrase.
Receipt of the Response indicates the completion of the Speak operation, regardless of how the Speak operation may have completed (i.e. successfully, interrupted, terminated, etc.).
+ +Requesting a new Speak operation while the application has another Speak operation already in progress (i.e. no corresponding Response for that in-progress Speak operation has been received yet) will terminate the in-progress Speak operation (causing its corresponding Response to be sent by SDL) and begin the requested Speak operation
+ +Requesting a new Speak operation while the application has an SDLAlert operation already in progress (i.e. no corresponding Response for that in-progress SDLAlert operation has been received yet) will result in the Speak operation request being rejected (indicated in the Response to the Request)
+ +Requesting a new SDLAlert operation while the application has a Speak operation already in progress (i.e. no corresponding Response for that in-progress Speak operation has been received yet) will terminate the in-progress Speak operation (causing its corresponding Response to be sent by SDL) and begin the requested SDLAlert operation
+ +Requesting a new Speak operation while the application has a SDLPerformInteraction operation already in progress (i.e. no corresponding Response for that in-progress SDLPerformInteraction operation has been received yet) will result in the Speak operation request being rejected (indicated in the Response to the Request)
+ +Requesting a SDLPerformInteraction operation while the application has a Speak operation already in progress (i.e. no corresponding Response for that in-progress Speak operation has been received yet) will terminate the in-progress Speak operation (causing its corresponding Response to be sent by SDL) and begin the requested SDLPerformInteraction operation
+ +HMI Status Requirements: +
Notes: +
playedwhen MENU interaction is completed (i.e. SystemContext reverts to MAIN). When SDLAlert + is issued with VR in effect, SDLAlert is queued and
playedwhen VR interaction is completed (i.e. SystemContext reverts to MAIN)
playedback in the order in which they were queued, with all existing rules for
collisionsstill in effect
Additional Notes: +
@since SmartDeviceLink 1.0 + - see: SDLAlert
+ + See more + + +@interface SDLSpeak : SDLRPCRequestclass SDLSpeak : SDLRPCRequestSpeak Response is sent, when Speak has been called
+ +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLSpeakResponse : SDLRPCResponseclass SDLSpeakResponse : SDLRPCResponseUndocumented
+ + See more + + + + + +Describes the hour, minute and second values used to set the media clock.
+ +@since SDL 1.0
+ + See more + + +@interface SDLStartTime : SDLRPCStructclass SDLStartTime : SDLRPCStructUndocumented
+ + See more + + + + + +Establishes a subscription to button notifications for HMI buttons. Buttons
+ are not necessarily physical buttons, but can also be soft
buttons on a
+ touch screen, depending on the display in the vehicle. Once subscribed to a
+ particular button, an application will receive both
+ SDLOnButtonEvent and SDLOnButtonPress notifications
+ whenever that button is pressed. The application may also unsubscribe from
+ notifications for a button by invoking the SDLUnsubscribeButton
+ operation
+
+ When a button is depressed, an SDLOnButtonEvent notification is + sent to the application with a ButtonEventMode of BUTTONDOWN. When that same + button is released, an SDLOnButtonEvent notification is sent to the + application with a ButtonEventMode of BUTTONUP +
+ When the duration of a button depression (that is, time between depression + and release) is less than two seconds, an SDLOnButtonPress + notification is sent to the application (at the moment the button is + released) with a ButtonPressMode of SHORT. When the duration is two or more + seconds, an SDLOnButtonPress notification is sent to the + application (at the moment the two seconds have elapsed) with a + ButtonPressMode of LONG +
+ The purpose of SDLOnButtonPress notifications is to allow for + programmatic detection of long button presses similar to those used to store + presets while listening to the radio, for example +
+ When a button is depressed and released, the sequence in which notifications + will be sent to the application is as follows: +
+ For short presses:
+
+ For long presses:
+
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 1.0
+ See SDLUnsubscribeButton
@interface SDLSubscribeButton : SDLRPCRequestclass SDLSubscribeButton : SDLRPCRequestSubscribeButton Response is sent, when SDLSubscribeButton has been called
+ +Since SmartDeviceLink 1.0
+ + See more + + +@interface SDLSubscribeButtonResponse : SDLRPCResponseclass SDLSubscribeButtonResponse : SDLRPCResponseSubscribes 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 +
+ Function Group: Location, VehicleInfo and DrivingChara +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 2.0
+ See SDLUnsubscribeVehicleData SDLGetVehicleData
@interface SDLSubscribeVehicleData : SDLRPCRequestclass SDLSubscribeVehicleData : SDLRPCRequestSubscribe Vehicle Data Response is sent, when SDLSubscribeVehicleData has been called
+ +Since SmartDeviceLink 2.0
+ + See more + + +@interface SDLSubscribeVehicleDataResponse : SDLRPCResponseclass SDLSubscribeVehicleDataResponse : SDLRPCResponseSpecifies the version number of the SDL V4 interface. This is used by both the application and SDL to declare what interface version each is using.
+ +@since SDL 1.0
+ + See more + + +@interface SDLSyncMsgVersion : SDLRPCStructclass SDLSyncMsgVersion : SDLRPCStructUndocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Enumeration that describes system actions that can be triggered.
+ + See more + + +@interface SDLSystemAction : SDLEnumclass SDLSystemAction : SDLEnumIndicates 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
+ + See more + + +@interface SDLSystemContext : SDLEnumclass SDLSystemContext : SDLEnumUndocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +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 +
| Name | +Type | +Description | +SmartDeviceLink Ver. Available | +
|---|---|---|---|
| text | +String | +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 typefield. |
+ SmartDeviceLink 1.0 | +
| type | +SpeechCapabilities | +Indicates the type of information in the textfield (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). |
+ SmartDeviceLink 1.0 | +
@since SmartDeviceLink 1.0
+ + See more + + +@interface SDLTTSChunk : SDLRPCStructclass SDLTTSChunk : SDLRPCStructUndocumented
+ + See more + + + + + +The list of possible alignments of text in a field. May only work on some display types.
+ +@since SDL 1.0
+ + See more + + +@interface SDLTextAlignment : SDLEnumclass SDLTextAlignment : SDLEnumStruct defining the characteristics of a displayed field on the HMI.
+ +Parameter List +
| Name | +Type | +Description | +SmartDeviceLink Ver. Available | +
|---|---|---|---|
| name | +TextFieldName | +Enumeration identifying the field. | +SDL 1.0 | +
| characterSet | +CharacterSet | +The character set that is supported in this field. | +SDL 1.0 | +
| width | +Int16 | +The number of characters in one row of this field.
+
|
+ SDL 1.0 | +
| rows | +Int16 | +The number of rows for this text field.
+
|
+ SDL 1.0 | +
@since SDL 1.0
+ + See more + + +@interface SDLTextField : SDLRPCStructclass SDLTextField : SDLRPCStructNames of the text fields that can appear on a SDL display.
+ +@since SDL 1.0
+ + See more + + +@interface SDLTextFieldName : SDLEnumclass SDLTextFieldName : SDLEnumUndocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Indicates whether choice/command was selected via VR or via a menu selection (using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN, OK buttons)
+ +@since SDL 1.0
+ + See more + + +@interface SDLTriggerSource : SDLEnumclass SDLTriggerSource : SDLEnumUndocumented
+ + See more + + + + + +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
+ + See more + + +@interface SDLUnregisterAppInterface : SDLRPCRequestclass SDLUnregisterAppInterface : SDLRPCRequestUnregister AppInterface Response is sent, when SDLUnregisterAppInterface has been called
+ +@since SmartDeviceLink 1.0
+ + See more + + +@interface SDLUnregisterAppInterfaceResponse : SDLRPCResponseclass SDLUnregisterAppInterfaceResponse : SDLRPCResponseDeletes a subscription to button notifications for the specified button. For +more information about button subscriptions, see SDLSubscribeButton +
+Application can unsubscribe from a button that is currently being pressed +(i.e. has not yet been released), but app will not get button event +
+HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +@since SmartDeviceLink 1.0
+See SDLSubscribeButton
@interface SDLUnsubscribeButton : SDLRPCRequestclass SDLUnsubscribeButton : SDLRPCRequestUnsubscribe Button Response is sent, when SDLUnsubscribeButton has been called
+ +@since SmartDeviceLink 1.0
+ + See more + + +@interface SDLUnsubscribeButtonResponse : SDLRPCResponseclass SDLUnsubscribeButtonResponse : SDLRPCResponseThis function is used to unsubscribe the notifications from the + subscribeVehicleData function +
+ Function Group: Location, VehicleInfo and DrivingChara +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +@since SmartDeviceLink 2.0
+ See SDLSubscribeVehicleData SDLGetVehicleData
@interface SDLUnsubscribeVehicleData : SDLRPCRequestclass SDLUnsubscribeVehicleData : SDLRPCRequestUnsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called
+ +@since SmartDeviceLink 2.0
+ + See more + + +@interface SDLUnsubscribeVehicleDataResponse : SDLRPCResponseclass SDLUnsubscribeVehicleDataResponse : SDLRPCResponseSpecifies what function should be performed on the media clock/counter
+ +@since SDL 1.0
+ + See more + + +@interface SDLUpdateMode : SDLEnumclass SDLUpdateMode : SDLEnumUpdates the list of next maneuvers, which can be requested by the user pressing the softbutton
+ * “Turns” on the Navigation base screen. Three softbuttons are predefined by the system: Up, Down, Close.
+ *
+ * @since SmartDeviceLink 2.0
+ + See more + + +@interface SDLUpdateTurnList : SDLRPCRequestclass SDLUpdateTurnList : SDLRPCRequestSDLUpdateTurnListResponse is sent, when SDLUpdateTurnList has been called. + * SinceSmartDeviceLink 2.0
+ + See more + + +@interface SDLUpdateTurnListResponse : SDLRPCResponseclass SDLUpdateTurnListResponse : SDLRPCResponseThe VR capabilities of the connected SDL platform.
+ +@since SDL 1.0
+ + See more + + +@interface SDLVRCapabilities : SDLEnumclass SDLVRCapabilities : SDLEnumUndocumented
+ + See more + + + + + +Vehicle Data Activity Status
+ + See more + + +@interface SDLVehicleDataActiveStatus : SDLEnumclass SDLVehicleDataActiveStatus : SDLEnumReflects the status of a vehicle data event; e.g. a seat belt event status.
+ +@since SDL 2.0
+ + See more + + +@interface SDLVehicleDataEventStatus : SDLEnumclass SDLVehicleDataEventStatus : SDLEnumReflects the status of a vehicle data notification.
+ +@since SDL 2.0
+ + See more + + +@interface SDLVehicleDataNotificationStatus : SDLEnumclass SDLVehicleDataNotificationStatus : SDLEnumUndocumented
+ + See more + + + + + +Vehicle Data Result Code
+ + See more + + +@interface SDLVehicleDataResultCode : SDLEnumclass SDLVehicleDataResultCode : SDLEnumReflects the status of a binary vehicle data item.
+ +@since SDL 2.0
+ + See more + + +@interface SDLVehicleDataStatus : SDLEnumclass SDLVehicleDataStatus : SDLEnumDefines the vehicle data types that can be published and/or subscribed to using SDLSubscribeVehicleData
+ + See more + + +@interface SDLVehicleDataType : SDLEnumclass SDLVehicleDataType : SDLEnumDescribes the type of vehicle the mobile phone is connected with.
+ +@since SDL 2.0
+ + See more + + +@interface SDLVehicleType : SDLRPCStructclass SDLVehicleType : SDLRPCStructReflects the status of a cluster instrument warning light.
+ +@since SDL 2.0
+ + See more + + +@interface SDLWarningLightStatus : SDLEnumclass SDLWarningLightStatus : SDLEnumWiper Status
+ + See more + + +@interface SDLWiperStatus : SDLEnumclass SDLWiperStatus : SDLEnumUndocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +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: +
The set of choices which the application builds using SDLAddCommand can be a + mixture of: +
HMILevel needs to be FULL, LIMITED or BACKGROUD
+ +@since SDL 1.0
+ +See
+ SDLDeleteCommand SDLAddSubMenu SDLDeleteSubMenu + +Constructs a new SDLAddCommand object
+ + + +- (instancetype)init;init!()Constructs a new SDLAddCommand object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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
+ + + +@property (readwrite, strong, atomic) NSNumber *cmdID;var cmdID: NSNumber! { get set }@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
+ + + +@property (readwrite, strong, atomic) SDLMenuParams *menuParams;var menuParams: SDLMenuParams! { get set }@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
+ + + +@property (readwrite, strong, atomic) NSMutableArray *vrCommands;var vrCommands: NSMutableArray! { get set }@abstract Image struct containing a static or dynamic icon
+ +@discussion If provided, defines the image to be be shown along with a command
+ +If omitted on supported displays, no (or the default if applicable) icon will be displayed
+ +Optional
+ + + +@property (readwrite, strong, atomic) SDLImage *cmdIcon;var cmdIcon: SDLImage! { get set }SDLAddCommandResponse is sent, when SDLAddCommand has been called
+ +Since SmartDeviceLink 1.0
+ + +Undocumented
+ + + +@interface SDLAddCommandResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLAddCommandResponse : SDLRPCResponseAdd a SDLSubMenu to the Command Menu +
+ A SDLSubMenu can only be added to the Top Level Menu (i.e.a SDLSubMenu cannot be + added to a SDLSubMenu), and may only contain commands as children +
+
+ HMILevel needs to be FULL, LIMITED or BACKGROUD +
+ +Since SmartDeviceLink 1.0
+ see SDLDeleteSubMenu SDLAddCommand SDLDeleteCommand
Constructs a new SDLAddSubMenu object
+ + + +- (instancetype)init;init!()Constructs a new SDLAddSubMenu object indicated by the dictionary parameter +
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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 +
+ + + +@property (readwrite, strong, atomic) NSNumber *menuID;var menuID: NSNumber! { get set }@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:
+
@property (readwrite, strong, atomic) NSNumber *position;var position: NSNumber! { get set }@abstract a menuName which is displayed representing this submenu item +@discussion NSString which will be displayed representing this submenu item
+ + + +@property (readwrite, strong, atomic) NSString *menuName;var menuName: String! { get set }SDLAddSubMenuResponse is sent, when SDLAddSubMenu has been called +Since SmartDeviceLink 1.0
+ + +Undocumented
+ + + +@interface SDLAddSubMenuResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLAddSubMenuResponse : SDLRPCResponseUndocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +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.
+ +@since SDL 1.0
+ + +Constructs a new SDLAlert object
+ + + +- (instancetype)init;init!()Constructs a new SDLAlert object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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
+ +Text is always centered
+ +Optional, Max length 500 chars
+ + + +@property (readwrite, strong, atomic) NSString *alertText1;var alertText1: String! { get set }@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
+ +Text is always centered
+ +Optional, Max length 500 chars
+ + + +@property (readwrite, strong, atomic) NSString *alertText2;var alertText2: String! { get set }@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
+ +Text is always centered
+ +Optional, Max length 500 chars
+ + + +@property (readwrite, strong, atomic) NSString *alertText3;var alertText3: String! { get set }@abstract An array which, taken together, specify what is to be spoken to the user
+ +Optional, Array of SDLTTSChunk, Array length 1 - 100
+ +See
+ SDLTTSChunk + +@property (readwrite, strong, atomic) NSMutableArray *ttsChunks;var ttsChunks: NSMutableArray! { get set }@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
+ + + +@property (readwrite, strong, atomic) NSNumber *duration;var duration: NSNumber! { get set }@abstract Whether the alert tone should be played before the TTS (if any) is spoken.
+ +@discussion If ommitted, no tone is played
+ +Optional, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *playTone;var playTone: NSNumber! { get set }@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
+ + + +@property (readwrite, strong, atomic) NSNumber *progressIndicator;var progressIndicator: NSNumber! { get set }@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
+ +See
+ SDLSoftButton + +@property (readwrite, strong, atomic) NSMutableArray *softButtons;var softButtons: NSMutableArray! { get set }@since SmartDeviceLink 1.0
+ + +Undocumented
+ + + +@interface SDLAlertManeuver : SDLRPCRequestUndocumented
+ + + +@interface SDLAlertManeuver : SDLRPCRequestUndocumented
+ + + +@interface SDLAlertManeuver : SDLRPCRequestUndocumented
+ + + +@interface SDLAlertManeuver : SDLRPCRequestSDLAlertManeuverResponse is sent, when SDLAlertManeuver has been called. + * @since SmartDeviceLink 1.0
+ + +Undocumented
+ + + +@interface SDLAlertManeuverResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLAlertManeuverResponse : SDLRPCResponseSent after SDLAlert has been sent +@since SDL 1.0
+ + +Undocumented
+ + + +@interface SDLAlertResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLAlertResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLAlertResponse : SDLRPCResponseReflects the status of the ambient light sensor +@since SDL 3.0
+ + +Undocumented
+ + + +@interface SDLAmbientLightStatus : SDLEnumUndocumented
+ + + +@interface SDLAmbientLightStatus : SDLEnumUndocumented
+ + + +@interface SDLAmbientLightStatus : SDLEnumUndocumented
+ + + +@interface SDLAmbientLightStatus : SDLEnumUndocumented
+ + + +@interface SDLAmbientLightStatus : SDLEnumUndocumented
+ + + +@interface SDLAmbientLightStatus : SDLEnumUndocumented
+ + + +@interface SDLAmbientLightStatus : SDLEnumUndocumented
+ + + +@interface SDLAmbientLightStatus : SDLEnumUndocumented
+ + + +@interface SDLAmbientLightStatus : SDLEnumUndocumented
+ + + +@interface SDLAmbientLightStatus : SDLEnumEnumeration listing possible app hmi types.
+ +@since SDL 2.0
+ + +@abstract Convert String to AppHMIType
+ + + ++ (SDLAppHMIType *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLAppHMIType!The value of the string to get an object for
+SDLAppHMIType
+ +@abstract Store the enumeration of all possible SDLAppHMIType
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLAppHMIType
+ +@abstract The App will have default rights.
+ + + ++ (SDLAppHMIType *)DEFAULT;class func DEFAULT() -> SDLAppHMIType!SDLAppHMIType with value DEFAULT
+ +@abstract Communication type of App
+ + + ++ (SDLAppHMIType *)COMMUNICATION;class func COMMUNICATION() -> SDLAppHMIType!SDLAppHMIType with value COMMUNICATION
+ +@abstract App dealing with Media
+ + + ++ (SDLAppHMIType *)MEDIA;class func MEDIA() -> SDLAppHMIType!SDLAppHMIType with value MEDIA
+ +@abstract Messaging App
+ + + ++ (SDLAppHMIType *)MESSAGING;class func MESSAGING() -> SDLAppHMIType!SDLAppHMIType with value MESSAGING
+ +@abstract Navigation App
+ + + ++ (SDLAppHMIType *)NAVIGATION;class func NAVIGATION() -> SDLAppHMIType!SDLAppHMIType with value NAVIGATION
+ +@abstract Information App
+ + + ++ (SDLAppHMIType *)INFORMATION;class func INFORMATION() -> SDLAppHMIType!SDLAppHMIType with value INFORMATION
+ +@abstract App dealing with social media
+ + + ++ (SDLAppHMIType *)SOCIAL;class func SOCIAL() -> SDLAppHMIType!SDLAppHMIType with value SOCIAL
+ +Undocumented
+ + + +@interface SDLAppHMIType : SDLEnum@abstract App only for Testing purposes
+ + + ++ (SDLAppHMIType *)TESTING;class func TESTING() -> SDLAppHMIType!SDLAppHMIType with value TESTING
+ +@abstract System App
+ + + ++ (SDLAppHMIType *)SYSTEM;class func SYSTEM() -> SDLAppHMIType!SDLAppHMIType with value SYSTEM
+ +Indicates reason why app interface was unregistered. The application is being disconnected by SDL.
+ +@since SDL 1.0
+ + +@abstract Convert String to SDLAppInterfaceUnregisteredReason
+ + + ++ (SDLAppInterfaceUnregisteredReason *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLAppInterfaceUnregisteredReason!String value to retrieve the object for
+SDLAppInterfaceUnregisteredReason
+ +@abstract Store the enumeration of all possible SDLAppInterfaceUnregisteredReason
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that stores all possible SDLAppInterfaceUnregisteredReason
+ +@abstract Vehicle ignition turned off.
+ + + ++ (SDLAppInterfaceUnregisteredReason *)IGNITION_OFF;class func IGNITION_OFF() -> SDLAppInterfaceUnregisteredReason!SDLAppInterfaceUnregisteredReason with value IGNITION_OFF
+ +@abstract Bluetooth was turned off, causing termination of a necessary Bluetooth connection.
+ + + ++ (SDLAppInterfaceUnregisteredReason *)BLUETOOTH_OFF;class func BLUETOOTH_OFF() -> SDLAppInterfaceUnregisteredReason!SDLAppInterfaceUnregisteredReason with value BLUETOOTH_OFF
+ +@abstract USB was disconnected, causing termination of a necessary iAP connection.
+ + + ++ (SDLAppInterfaceUnregisteredReason *)USB_DISCONNECTED;class func USB_DISCONNECTED() -> SDLAppInterfaceUnregisteredReason!SDLAppInterfaceUnregisteredReason with value USB_DISCONNECTED
+ +@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.
+ + + ++ (SDLAppInterfaceUnregisteredReason *)REQUEST_WHILE_IN_NONE_HMI_LEVEL;class func REQUEST_WHILE_IN_NONE_HMI_LEVEL() -> SDLAppInterfaceUnregisteredReason!SDLAppInterfaceUnregisteredReason with value REQUEST_WHILE_IN_NONE_HMI_LEVEL
+ +@abstract Either too many – or too many per unit of time – requests were made by the application.
+ + + ++ (SDLAppInterfaceUnregisteredReason *)TOO_MANY_REQUESTS;class func TOO_MANY_REQUESTS() -> SDLAppInterfaceUnregisteredReason!SDLAppInterfaceUnregisteredReason with value TOO_MANY_REQUESTS
+ +@abstract The application has issued requests which cause driver distraction rules to be violated.
+ + + ++ (SDLAppInterfaceUnregisteredReason *)DRIVER_DISTRACTION_VIOLATION;class func DRIVER_DISTRACTION_VIOLATION() -> SDLAppInterfaceUnregisteredReason!SDLAppInterfaceUnregisteredReason with value DRIVER_DISTRACTION_VIOLATION
+ +@abstract The user performed a language change on the SDL platform, causing the application to need to be reregistered for the new language.
+ + + ++ (SDLAppInterfaceUnregisteredReason *)LANGUAGE_CHANGE;class func LANGUAGE_CHANGE() -> SDLAppInterfaceUnregisteredReason!SDLAppInterfaceUnregisteredReason with value LANGUAGE_CHANGE
+ +@abstract The user performed a MASTER RESET on the SDL platform, causing removal of a necessary Bluetooth pairing.
+ + + ++ (SDLAppInterfaceUnregisteredReason *)MASTER_RESET;class func MASTER_RESET() -> SDLAppInterfaceUnregisteredReason!SDLAppInterfaceUnregisteredReason with value MASTER_RESET
+ +@abstract The user restored settings to FACTORY DEFAULTS on the SDL platform.
+ + + ++ (SDLAppInterfaceUnregisteredReason *)FACTORY_DEFAULTS;class func FACTORY_DEFAULTS() -> SDLAppInterfaceUnregisteredReason!SDLAppInterfaceUnregisteredReason with value FACTORY_DEFAULTS
+ +@abstract The app is not being authorized to be connected to SDL.
+ +@since SDL 2.0
+ + + ++ (SDLAppInterfaceUnregisteredReason *)APP_UNAUTHORIZED;class func APP_UNAUTHORIZED() -> SDLAppInterfaceUnregisteredReason!SDLAppInterfaceUnregisteredReason with value APP_UNAUTHORIZED
+ +Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM} +
Parameter List +
| Name | +Type | +Description | +SmartDeviceLink Ver. Available | +
|---|---|---|---|
| samplingRate | +SDLSamplingRate * | +Describes the sampling rate for AudioPassThru + | +SmartDeviceLink 2.0 | +
| bitsPerSample | +SDLBitsPerSample * | +Describes the sample depth in bit for AudioPassThru + | +SmartDeviceLink 2.0 | +
| audioType | +SDLAudioType * | +Describes the audiotype for AudioPassThru + | +SmartDeviceLink 2.0 | +
Constructs a newly allocated SDLAudioPassThruCapabilities object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLAudioPassThruCapabilities object indicated by the Hashtable parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The sampling rate for AudioPassThru
@property (readwrite, strong, atomic) SDLSamplingRate *samplingRate;var samplingRate: SDLSamplingRate! { get set }@abstract The sample depth in bit for AudioPassThru
@property (readwrite, strong, atomic) SDLBitsPerSample *bitsPerSample;var bitsPerSample: SDLBitsPerSample! { get set }@abstract The audiotype for AudioPassThru
@property (readwrite, strong, atomic) SDLAudioType *audioType;var audioType: SDLAudioType! { get set }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
+ + +@abstract Convert String to SDLAudioStreamingState
+ + + ++ (SDLAudioStreamingState *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLAudioStreamingState!The value of the string to get an object for
+SDLAudioStreamingState
+ +@abstract Store the enumeration of all possible SDLAudioStreamingState
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLAudioStreamingState
+ +@abstract Currently streaming audio, if any, is audible to user.
+ + + ++ (SDLAudioStreamingState *)AUDIBLE;class func AUDIBLE() -> SDLAudioStreamingState!SDLAudioStreamingState with value of AUDIBLE
+ +@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
+ + + ++ (SDLAudioStreamingState *)ATTENUATED;class func ATTENUATED() -> SDLAudioStreamingState!SDLAudioStreamingState with value of ATTENUATED
+ +@abstract Currently streaming audio, if any, is not audible to user. made via VR session.
+ + + ++ (SDLAudioStreamingState *)NOT_AUDIBLE;class func NOT_AUDIBLE() -> SDLAudioStreamingState!SDLAudioStreamingState with value of NOT_AUDIBLE
+ +Describes different audio type options for PerformAudioPassThru
+ + +@abstract Convert String to SDLAudioType
+ + + ++ (SDLAudioType *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLAudioType!The value of the string to get an object for
+SDLAudioType
+ +@abstract Store the enumeration of all possible SDLAudioType
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLAudioType
+ +@abstract PCM raw audio
+ +@since SDL 2.0
+ + + ++ (SDLAudioType *)PCM;class func PCM() -> SDLAudioType!SDLAudioType with value of PCM
+ +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Describes different bit depth options for PerformAudioPassThru
+ +@since SDL 2.0
+ + +@abstract Convert String to SDLBitsPerSample
+ + + ++ (SDLBitsPerSample *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLBitsPerSample!The value of the string to get an object for
+SDLBitsPerSample
+ +@abstract Store the enumeration of all possible SDLBitsPerSample
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLBitsPerSample
+ +@abstract 8 bits per sample
+ + + ++ (SDLBitsPerSample *)_8_BIT;class func _8_BIT() -> SDLBitsPerSample!a SDLBitsPerSample with value of 8_BIT
+ +@abstract 16 bits per sample
+ + + ++ (SDLBitsPerSample *)_16_BIT;class func _16_BIT() -> SDLBitsPerSample!a SDLBitsPerSample with value of 16_BIT
+ +The body information including power modes.
+ + +@abstract Constructs a new SDLBodyInformation object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLBodyInformation object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract References signal PrkBrkActv_B_Actl
.
@property (readwrite, strong, atomic) NSNumber *parkBrakeActive;var parkBrakeActive: NSNumber! { get set }@abstract References signal Ignition_Switch_Stable
. See IgnitionStableStatus.
@property (readwrite, strong, atomic)
+ SDLIgnitionStableStatus *ignitionStableStatus;var ignitionStableStatus: SDLIgnitionStableStatus! { get set }@abstract References signal Ignition_status
. See IgnitionStatus.
@property (readwrite, strong, atomic) SDLIgnitionStatus *ignitionStatus;var ignitionStatus: SDLIgnitionStatus! { get set }@abstract References signal DrStatDrv_B_Actl
.
@property (readwrite, strong, atomic) NSNumber *driverDoorAjar;var driverDoorAjar: NSNumber! { get set }@abstract References signal DrStatPsngr_B_Actl
.
@property (readwrite, strong, atomic) NSNumber *passengerDoorAjar;var passengerDoorAjar: NSNumber! { get set }@abstract References signal DrStatRl_B_Actl
.
@property (readwrite, strong, atomic) NSNumber *rearLeftDoorAjar;var rearLeftDoorAjar: NSNumber! { get set }@abstract References signal DrStatRr_B_Actl
.
@property (readwrite, strong, atomic) NSNumber *rearRightDoorAjar;var rearRightDoorAjar: NSNumber! { get set }Provides information about the capabilities of a SDL HMI button.
+ +@since SDL 1.0
+ + +Constructs a newly allocated SDLButtonCapabilities object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLButtonCapabilities object indicated by the Hashtable parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The name of the SDL HMI button.
+ + + +@property (readwrite, strong, atomic) SDLButtonName *name;var name: SDLButtonName! { get set }@abstract A NSNumber value indicates whether the button supports a SHORT press
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *shortPressAvailable;var shortPressAvailable: NSNumber! { get set }@abstract A NSNumber value indicates whether the button supports a LONG press
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *longPressAvailable;var longPressAvailable: NSNumber! { get set }@abstract A NSNumber value indicates whether the button supports button down
and button up
Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *upDownAvailable;var upDownAvailable: NSNumber! { get set }Indicates whether the button was depressed or released. A BUTTONUP event will always be preceded by a BUTTONDOWN event.
+ +@since SDL 1.0
+ + +@abstract Convert String to SDLButtonEventMode +- parameter: value The value of the string to get an object for +- returns: SDLButtonEventMode (BUTTONUP / BUTTONDOWN)
+ + + ++ (SDLButtonEventMode *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLButtonEventMode!The value of the string to get an object for
+SDLButtonEventMode (BUTTONUP / BUTTONDOWN)
+ +@abstract Store the enumeration of all possible SDLButtonEventMode +- returns: an array that store all possible SDLButtonEventMode
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLButtonEventMode
+ +@abstract The button was released +- returns: a SDLButtonEventMode with value of BUTTONUP
+ + + ++ (SDLButtonEventMode *)BUTTONUP;class func BUTTONUP() -> SDLButtonEventMode!a SDLButtonEventMode with value of BUTTONUP
+ +@abstract The button was depressed +- returns: a SDLButtonEventMode with value of BUTTONDOWN
+ + + ++ (SDLButtonEventMode *)BUTTONDOWN;class func BUTTONDOWN() -> SDLButtonEventMode!a SDLButtonEventMode with value of BUTTONDOWN
+ +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
+ + +@abstract Convert String to SDLButtonName
+ + + ++ (SDLButtonName *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLButtonName!String value to retrieve the object for
+SDLButtonName
+ +@abstract Store the enumeration of all possible SDLButtonName
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLButtonName
+ +@abstract Represents the button usually labeled OK
. A typical use of this button is for the user to press it to make a selection.
+ (SDLButtonName *)OK;class func OK() -> SDLButtonName!a SDLButtonName with the value of OK
+ +@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.
+ + + ++ (SDLButtonName *)SEEKLEFT;class func SEEKLEFT() -> SDLButtonName!a SDLButtonName with the value of SEEKLEFT
+ +@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.
+ + + ++ (SDLButtonName *)SEEKRIGHT;class func SEEKRIGHT() -> SDLButtonName!a SDLButtonName with the value of SEEKRIGHT
+ +@abstract Represents a turn of the tuner knob in the clockwise direction one tick.
+ + + ++ (SDLButtonName *)TUNEUP;class func TUNEUP() -> SDLButtonName!a SDLButtonName with the value of TUNEUP
+ +@abstract Represents a turn of the tuner knob in the counter-clockwise direction one tick.
+ + + ++ (SDLButtonName *)TUNEDOWN;class func TUNEDOWN() -> SDLButtonName!a SDLButtonName with the value of TUNEDOWN
+ +@abstract Represents the preset 0 button.
+ + + ++ (SDLButtonName *)PRESET_0;class func PRESET_0() -> SDLButtonName!a SDLButtonName with the value of PRESET_0
+ +@abstract Represents the preset 1 button.
+ + + ++ (SDLButtonName *)PRESET_1;class func PRESET_1() -> SDLButtonName!a SDLButtonName with the value of PRESET_1
+ +@abstract Represents the preset 2 button.
+ + + ++ (SDLButtonName *)PRESET_2;class func PRESET_2() -> SDLButtonName!a SDLButtonName with the value of PRESET_2
+ +@abstract Represents the preset 3 button.
+ + + ++ (SDLButtonName *)PRESET_3;class func PRESET_3() -> SDLButtonName!a SDLButtonName with the value of PRESET_3
+ +@abstract Represents the preset 4 button.
+ + + ++ (SDLButtonName *)PRESET_4;class func PRESET_4() -> SDLButtonName!a SDLButtonName with the value of PRESET_4
+ +@abstract Represents the preset 5 button.
+ + + ++ (SDLButtonName *)PRESET_5;class func PRESET_5() -> SDLButtonName!a SDLButtonName with the value of PRESET_5
+ +@abstract Represents the preset 6 button.
+ + + ++ (SDLButtonName *)PRESET_6;class func PRESET_6() -> SDLButtonName!a SDLButtonName with the value of PRESET_6
+ +@abstract Represents the preset 7 button.
+ + + ++ (SDLButtonName *)PRESET_7;class func PRESET_7() -> SDLButtonName!a SDLButtonName with the value of PRESET_7
+ +@abstract Represents the preset 8 button.
+ + + ++ (SDLButtonName *)PRESET_8;class func PRESET_8() -> SDLButtonName!a SDLButtonName with the value of PRESET_8
+ +@abstract Represents the preset 9 button.
+ + + ++ (SDLButtonName *)PRESET_9;class func PRESET_9() -> SDLButtonName!a SDLButtonName with the value of PRESET_9
+ +Undocumented
+ + + +@interface SDLButtonName : SDLEnumUndocumented
+ + + +@interface SDLButtonName : SDLEnumIndicates whether this is a LONG or SHORT button press
+ +@since SDL 1.0
+ + +@abstract Convert String to SDLButtonPressMode
+ + + ++ (SDLButtonPressMode *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLButtonPressMode!The value of the string to get an object for
+SDLButtonPressMode
+ +@abstract Store the enumeration of all possible SDLButtonPressMode
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLButtonPressMode
+ +@abstract A button was released, after it was pressed for a long time. Actual timing is defined by the head unit and may vary.
+ + + ++ (SDLButtonPressMode *)LONG;class func LONG() -> SDLButtonPressMode!a SDLButtonPressMode with the value of LONG
+ +@abstract A button was released, after it was pressed for a short time. Actual timing is defined by the head unit and may vary.
+ + + ++ (SDLButtonPressMode *)SHORT;class func SHORT() -> SDLButtonPressMode!a SDLButtonPressMode with the value of SHORT
+ +Describes the carmode the vehicle is in. + * Since SmartDeviceLink 2.0
+ + +Undocumented
+ + + +@interface SDLCarModeStatus : SDLEnumUndocumented
+ + + +@interface SDLCarModeStatus : SDLEnumProvides carmode NORMAL to each module.
+ + + ++ (SDLCarModeStatus *)NORMAL;class func NORMAL() -> SDLCarModeStatus!Provides carmode FACTORY to each module.
+ + + ++ (SDLCarModeStatus *)FACTORY;class func FACTORY() -> SDLCarModeStatus!Provides carmode TRANSPORT to each module.
+ + + ++ (SDLCarModeStatus *)TRANSPORT;class func TRANSPORT() -> SDLCarModeStatus!Provides carmode CRASH to each module.
+ + + ++ (SDLCarModeStatus *)CRASH;class func CRASH() -> SDLCarModeStatus!If the app recognizes during the app registration that the SDL HMI language (voice/TTS and/or display) does not match the app language, the app will be able (but does not need) to change this registration with changeRegistration prior to app being brought into focus.
+ +Any HMILevel allowed
+ +@since SDL 2.0
+ + +Constructs a new SDLChangeRegistration object
+ + + +- (instancetype)init;init!()Constructs a new SDLChangeRegistration object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The language the app wants to change to
+ + + +@property (readwrite, strong, nonatomic) SDLLanguage *language;var language: SDLLanguage! { get set }@abstract HMI display language
+ + + +@property (readwrite, strong, nonatomic) SDLLanguage *hmiDisplayLanguage;var hmiDisplayLanguage: SDLLanguage! { get set }Request a new app name registration
+ +Optional, Max string length 100 chars
+ + + +@property (readwrite, copy, nonatomic) NSString *appName;var appName: String! { get set }Request a new TTSName registration.
+ +Optional, Array of SDLTTSChunk, 1 - 100 elements
+ + + +@property (readwrite, copy, nonatomic) NSArray *ttsName;var ttsName: [AnyObject]! { get set }Request a new app short name registration
+ +Optional, Max string length 100 chars
+ + + +@property (readwrite, copy, nonatomic) NSString *ngnMediaScreenAppName;var ngnMediaScreenAppName: String! { get set }Request a new VR synonyms registration
+ +Optional, Array of NSString, 1 - 100 elements, max string length 40 chars
+ + + +@property (readwrite, copy, nonatomic) NSArray *vrSynonyms;var vrSynonyms: [AnyObject]! { get set }SDLChangeRegistrationResponse is sent, when SDLChangeRegistration has been called
+ +@since SDL 2.0
+ + +Undocumented
+ + + +@interface SDLChangeRegistrationResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLChangeRegistrationResponse : SDLRPCResponseCharacter sets supported by SDL.
+ +@since SDL 1.0
+ + +@abstract Convert String to SDLCharacterSet
+ + + ++ (SDLCharacterSet *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLCharacterSet!The value of the string to get an object for
+SDLCharacterSet
+ +@abstract Store the enumeration of all possible SDLCharacterSet
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLCharacterSet
+ +Undocumented
+ + + +@interface SDLCharacterSet : SDLEnumUndocumented
+ + + +@interface SDLCharacterSet : SDLEnumUndocumented
+ + + +@interface SDLCharacterSet : SDLEnumUndocumented
+ + + +@interface SDLCharacterSet : SDLEnumA 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 +
| Name | +Type | +Description | +SmartDeviceLink Ver. Available | +
|---|---|---|---|
| choiceID | +NSNumber * | +Application-scoped identifier that uniquely identifies this choice.
+ Min: 0 + Max: 65535 + |
+ SmartDeviceLink 1.0 | +
| menuName | +NSString * | +Text which appears in menu, representing this choice.
+ Min: 1 + Max: 100 + |
+ SmartDeviceLink 1.0 | +
| vrCommands | +NSMutableArray * | +An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element | +SmartDeviceLink 1.0 | +
| image | +SDLImage * | +Either a static hex icon value or a binary image file name identifier (sent by PutFile). | +SmartDeviceLink 2.0 | +
Since SmartDeviceLink 1.0
Constructs a newly allocated SDLChoice object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLChoice object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract the application-scoped identifier that uniquely identifies this choice
+ +Required, Integer 0 - 65535
+ + + +@property (readwrite, strong, atomic) NSNumber *choiceID;var choiceID: NSNumber! { get set }@abstract Text which appears in menu, representing this choice
+ +Required, Max string length 500 chars
+ + + +@property (readwrite, strong, atomic) NSString *menuName;var menuName: String! { get set }@abstract VR synonyms for this choice
+ +Required, Array of Strings, Array length 1 - 100, Max String length 99 chars
+ + + +@property (readwrite, strong, atomic) NSMutableArray *vrCommands;var vrCommands: NSMutableArray! { get set }@abstract The image of the choice
+ +Optional
+ + + +@property (readwrite, strong, atomic) SDLImage *image;var image: SDLImage! { get set }@abstract Optional secondary text to display; e.g. address of POI in a search result entry
+ +Optional, Max String length 500 chars
+ + + +@property (readwrite, strong, atomic) NSString *secondaryText;var secondaryText: String! { get set }@abstract Optional tertiary text to display; e.g. distance to POI for a search result entry
+ +Optional, Max String length 500 chars
+ + + +@property (readwrite, strong, atomic) NSString *tertiaryText;var tertiaryText: String! { get set }@abstract Optional secondary image for choice
+ +Optional
+ + + +@property (readwrite, strong, atomic) SDLImage *secondaryImage;var secondaryImage: SDLImage! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +The list of potential compass directions.
+ +@since SDL 2.0
+ + +@abstract Convert String to SDLCompassDirection +- parameter: value The value of the string to get an object for +- returns: SDLCompassDirection
+ + + ++ (SDLCompassDirection *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLCompassDirection!The value of the string to get an object for
+SDLCompassDirection
+ +@abstract Store the enumeration of all possible SDLCompassDirection +- returns: An array that store all possible SDLCompassDirection
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!An array that store all possible SDLCompassDirection
+ +@abstract Direction North +- returns: A SDLCompassDirection with the value of NORTH
+ + + ++ (SDLCompassDirection *)NORTH;class func NORTH() -> SDLCompassDirection!A SDLCompassDirection with the value of NORTH
+ +@abstract Direction Northwest +- returns: A SDLCompassDirection with the value of NORTHWEST
+ + + ++ (SDLCompassDirection *)NORTHWEST;class func NORTHWEST() -> SDLCompassDirection!A SDLCompassDirection with the value of NORTHWEST
+ +@abstract Direction West +- returns: A SDLCompassDirection with the value of WEST
+ + + ++ (SDLCompassDirection *)WEST;class func WEST() -> SDLCompassDirection!A SDLCompassDirection with the value of WEST
+ +@abstract Direction Southwest +- returns: A SDLCompassDirection with the value of SOUTHWEST
+ + + ++ (SDLCompassDirection *)SOUTHWEST;class func SOUTHWEST() -> SDLCompassDirection!A SDLCompassDirection with the value of SOUTHWEST
+ +@abstract Direction South +- returns: A SDLCompassDirection with the value of SOUTH
+ + + ++ (SDLCompassDirection *)SOUTH;class func SOUTH() -> SDLCompassDirection!A SDLCompassDirection with the value of SOUTH
+ +@abstract Direction Southeast +- returns: A SDLCompassDirection with the value of SOUTHEAST
+ + + ++ (SDLCompassDirection *)SOUTHEAST;class func SOUTHEAST() -> SDLCompassDirection!A SDLCompassDirection with the value of SOUTHEAST
+ +@abstract Direction East +- returns: A SDLCompassDirection with the value of EAST
+ + + ++ (SDLCompassDirection *)EAST;class func EAST() -> SDLCompassDirection!A SDLCompassDirection with the value of EAST
+ +@abstract Direction Northeast +- returns: A SDLCompassDirection with the value of NORTHEAST
+ + + ++ (SDLCompassDirection *)NORTHEAST;class func NORTHEAST() -> SDLCompassDirection!A SDLCompassDirection with the value of NORTHEAST
+ +The volume status of a vehicle component.
+ +@since SDL 2.0
+ + +@abstract Convert String to SDLComponentVolumeStatus +- parameter: value The value of the string to get an object for +- returns: SDLComponentVolumeStatus
+ + + ++ (SDLComponentVolumeStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLComponentVolumeStatus!The value of the string to get an object for
+SDLComponentVolumeStatus
+ +@abstract Store the enumeration of all possible SDLComponentVolumeStatus +- returns: An array that store all possible SDLComponentVolumeStatus
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!An array that store all possible SDLComponentVolumeStatus
+ +@abstract Unknown SDLComponentVolumeStatus +- returns: a SDLComponentVolumeStatus with the value of UNKNOWN
+ + + ++ (SDLComponentVolumeStatus *)UNKNOWN;class func UNKNOWN() -> SDLComponentVolumeStatus!a SDLComponentVolumeStatus with the value of UNKNOWN
+ +@abstract Normal SDLComponentVolumeStatus +- returns: a SDLComponentVolumeStatus with the value of NORMAL
+ + + ++ (SDLComponentVolumeStatus *)NORMAL;class func NORMAL() -> SDLComponentVolumeStatus!a SDLComponentVolumeStatus with the value of NORMAL
+ +@abstract Low SDLComponentVolumeStatus +- returns: a SDLComponentVolumeStatus with the value of LOW
+ + + ++ (SDLComponentVolumeStatus *)LOW;class func LOW() -> SDLComponentVolumeStatus!a SDLComponentVolumeStatus with the value of LOW
+ +@abstract Fault SDLComponentVolumeStatus +- returns: a SDLComponentVolumeStatus with the value of FAULT
+ + + ++ (SDLComponentVolumeStatus *)FAULT;class func FAULT() -> SDLComponentVolumeStatus!a SDLComponentVolumeStatus with the value of FAULT
+ +@abstract Alert SDLComponentVolumeStatus +- returns: a SDLComponentVolumeStatus with the value of ALERT
+ + + ++ (SDLComponentVolumeStatus *)ALERT;class func ALERT() -> SDLComponentVolumeStatus!a SDLComponentVolumeStatus with the value of ALERT
+ +@abstract Not supported SDLComponentVolumeStatus +- returns: a SDLComponentVolumeStatus with the value of NOT_SUPPORTED
+ + + ++ (SDLComponentVolumeStatus *)NOT_SUPPORTED;class func NOT_SUPPORTED() -> SDLComponentVolumeStatus!a SDLComponentVolumeStatus with the value of NOT_SUPPORTED
+ +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Creates a Choice Set which can be used in subsequent SDLPerformInteraction Operations.
+ +HMILevel needs to be FULL, LIMITED or BACKGROUND
+ +Before a perform interaction is sent you MUST wait for the success from the CreateInteractionChoiceSet RPC.
+ +If you do not wait the system may not recognize the first utterance from the user.
+ +@since SDL 1.0
+ +See
+ SDLDeleteInteractionChoiceSet SDLPerformInteraction + +Constructs a new SDLCreateInteractionChoiceSet object
+ + + +- (instancetype)init;init!()Constructs a new SDLCreateInteractionChoiceSet object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract A unique ID that identifies the Choice Set
+ +Required, Integer, 0 - 2,000,000,000
+ + + +@property (readwrite, strong, atomic) NSNumber *interactionChoiceSetID;var interactionChoiceSetID: NSNumber! { get set }@abstract Array of choices, which the user can select by menu or voice recognition
+ +Required, SDLChoice, Array size 1 - 100
+ + + +@property (readwrite, strong, atomic) NSMutableArray *choiceSet;var choiceSet: NSMutableArray! { get set }SDLCreateInteractionChoiceSetResponse is sent, when SDLCreateInteractionChoiceSet + has been called
+ +Since SmartDeviceLink 1.0
+ + +Undocumented
+ + + +@interface SDLCreateInteractionChoiceSetResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLCreateInteractionChoiceSetResponse : SDLRPCResponseUndocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Removes a command from the Command Menu +
+ HMI Status Requirements:
+ HMILevel: FULL, LIMITED or BACKGROUND
+ AudioStreamingState: N/A
+ SystemContext: Should not be attempted when VRSESSION or MENU
+
Since SmartDeviceLink 1.0
+ see SDLAddCommand SDLAddSubMenu SDLDeleteSubMenu
Constructs a new SDLDeleteCommand object
+ + + +- (instancetype)init;init!()Constructs a new SDLDeleteCommand object indicated by the NSMutableDictionary + parameter +
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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
+ + + +@property (readwrite, strong, atomic) NSNumber *cmdID;var cmdID: NSNumber! { get set }SDLDeleteCommandResponse is sent, when SDLDeleteCommand has been called
+ +Since SmartDeviceLink 1.0
Undocumented
+ + + +@interface SDLDeleteCommandResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLDeleteCommandResponse : SDLRPCResponseUsed to delete a file resident on the SDL module in the app’s local cache. + Not supported on first generation SDL vehicles +
+ +Since SmartDeviceLink 2.0
+ see SDLPutFile SDLListFiles
Constructs a new SDLDeleteFile object
+ + + +- (instancetype)init;init!()Constructs a new SDLDeleteFile object indicated by the dictionary parameter +
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract a file reference name +@discussion a String value representing a file reference name
+ + + +@property (readwrite, strong, atomic) NSString *syncFileName;var syncFileName: String! { get set }Delete File Response is sent, when DeleteFile has been called
+ +Since SmartDeviceLink 2.0
Undocumented
+ + + +@interface SDLDeleteFileResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLDeleteFileResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLDeleteFileResponse : SDLRPCResponseDeletes an existing Choice Set identified by the parameter + interactionChoiceSetID. If the specified interactionChoiceSetID is currently + in use by an active SDLPerformInteraction this call to + delete the Choice Set will fail returning an IN_USE resultCode +
+ Function Group: Base +
+ HMILevel needs to be FULL, LIMITED or BACKGROUD
+
Since SmartDeviceLink 1.0
+ see SDLCreateInteractionChoiceSet SDLPerformInteraction
Constructs a new SDLDeleteInteractionChoiceSet object
+ + + +- (instancetype)init;init!()Constructs a new SDLDeleteInteractionChoiceSet object indicated by the + NSMutableDictionary parameter +
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract a unique ID that identifies the Choice Set +@discussion a unique ID that identifies the Choice Set +
+Notes: Min Value: 0; Max Value: 2000000000
+ + + +@property (readwrite, strong, atomic) NSNumber *interactionChoiceSetID;var interactionChoiceSetID: NSNumber! { get set }SDLDeleteInteractionChoiceSetResponse is sent, when SDLDeleteInteractionChoiceSet has been called
+ +Since SmartDeviceLink 1.0
+ + +Undocumented
+ + + +@interface SDLDeleteInteractionChoiceSetResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLDeleteInteractionChoiceSetResponse : SDLRPCResponseDeletes a submenu from the Command Menu +
+ Notes: When an app deletes a submenu that has child commands, those + child commands are also deleted +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 1.0
+ see SDLAddCommand SDLAddSubMenu SDLDeleteCommand
Constructs a new SDLDeleteSubMenu object
+ + + +- (instancetype)init;init!()Constructs a new SDLDeleteSubMenu object indicated by the dictionary parameter
+- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract the MenuID that identifies the SDLSubMenu to be delete +@discussion Notes: Min Value: 0; Max Value: 2000000000
+ + + +@property (readwrite, strong, atomic) NSNumber *menuID;var menuID: NSNumber! { get set }SDLDeleteSubMenuResponse is sent, when SDLDeleteSubMenu has been called
+ +Since SmartDeviceLink 1.0
+ + +Undocumented
+ + + +@interface SDLDeleteSubMenuResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLDeleteSubMenuResponse : SDLRPCResponseUndocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Reflects the reported battery status of the connected device, if reported.
+ +@since SDL 2.0
+ + +Convert String to DeviceLevelStatus +- parameter: value String +- returns: DeviceLevelStatus
+ + + ++ (SDLDeviceLevelStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLDeviceLevelStatus!String
+DeviceLevelStatus
+ +@abstract Store the enumeration of all possible SDLDeviceLevelStatus +- returns: an array that store all possible SDLDeviceLevelStatus
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLDeviceLevelStatus
+ +@abstract Device battery level is zero bars +- returns: a SDLDeviceLevelStatus with value of ZERO_LEVEL_BARS
+ + + ++ (SDLDeviceLevelStatus *)ZERO_LEVEL_BARS;class func ZERO_LEVEL_BARS() -> SDLDeviceLevelStatus!a SDLDeviceLevelStatus with value of ZERO_LEVEL_BARS
+ +@abstract Device battery level is one bar +- returns: a SDLDeviceLevelStatus with value of ONE_LEVEL_BARS
+ + + ++ (SDLDeviceLevelStatus *)ONE_LEVEL_BARS;class func ONE_LEVEL_BARS() -> SDLDeviceLevelStatus!a SDLDeviceLevelStatus with value of ONE_LEVEL_BARS
+ +@abstract Device battery level is two bars +- returns: a SDLDeviceLevelStatus with value of TWO_LEVEL_BARS
+ + + ++ (SDLDeviceLevelStatus *)TWO_LEVEL_BARS;class func TWO_LEVEL_BARS() -> SDLDeviceLevelStatus!a SDLDeviceLevelStatus with value of TWO_LEVEL_BARS
+ +@abstract Device battery level is three bars +- returns: a SDLDeviceLevelStatus with value of THREE_LEVEL_BARS
+ + + ++ (SDLDeviceLevelStatus *)THREE_LEVEL_BARS;class func THREE_LEVEL_BARS() -> SDLDeviceLevelStatus!a SDLDeviceLevelStatus with value of THREE_LEVEL_BARS
+ +@abstract Device battery level is four bars +- returns: a SDLDeviceLevelStatus with value of FOUR_LEVEL_BARS
+ + + ++ (SDLDeviceLevelStatus *)FOUR_LEVEL_BARS;class func FOUR_LEVEL_BARS() -> SDLDeviceLevelStatus!a SDLDeviceLevelStatus with value of FOUR_LEVEL_BARS
+ +@abstract Device battery level is unknown +- returns: a SDLDeviceLevelStatus with value of NOT_PROVIDED
+ + + ++ (SDLDeviceLevelStatus *)NOT_PROVIDED;class func NOT_PROVIDED() -> SDLDeviceLevelStatus!a SDLDeviceLevelStatus with value of NOT_PROVIDED
+ +Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.
+ +Parameter List +
| Name | +Type | +Description | +SmartDeviceLink Ver. Available | +
|---|---|---|---|
| voiceRecOn | +NSNumber * | +Voice recognition is on + | +SmartDeviceLink 2.0 | +
| btIconOn | +NSNumber * | +Bluetooth connection established + | +SmartDeviceLink 2.0 | +
| callActive | +NSNumber * | +A call is being active + | +SmartDeviceLink 2.0 | +
| phoneRoaming | +NSNumber * | +The phone is in roaming mode + | +SmartDeviceLink 2.0 | +
| textMsgAvailable | +NSNumber * | +A textmessage is available + | +SmartDeviceLink 2.0 | +
| battLevelStatus | +SDLDeviceLevelStatus * | +Battery level status + | +SmartDeviceLink 2.0 | +
| stereoAudioOutputMuted | +NSNumber * | +Status of the stereo audio output channel + | +SmartDeviceLink 2.0 | +
| monoAudioOutputMuted | +NSNumber * | +Status of the mono audio output channel + | +SmartDeviceLink 2.0 | +
| signalLevelStatus | +SDLDeviceLevelStatus * | +Signal level status + | +SmartDeviceLink 2.0 | +
| primaryAudioSource | +PrimaryAudioSource * | +Reflects the current primary audio source of SDL (if selected). + | +SmartDeviceLink 2.0 | +
| eCallEventActive | +NSNumber * | +Reflects, if an eCall event is active + | +SmartDeviceLink 2.0 | +
Constructs a newly allocated SDLDeviceStatus object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLDeviceStatus object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use to construct the object
+@abstract Indicates whether the voice recognition is on or off
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *voiceRecOn;var voiceRecOn: NSNumber! { get set }@abstract Indicates whether the bluetooth connection established
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *btIconOn;var btIconOn: NSNumber! { get set }@abstract Indicates whether a call is being active
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *callActive;var callActive: NSNumber! { get set }@abstract Indicates whether the phone is in roaming mode
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *phoneRoaming;var phoneRoaming: NSNumber! { get set }@abstract Indicates whether a textmessage is available
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *textMsgAvailable;var textMsgAvailable: NSNumber! { get set }@abstract Battery level status
+ +See
+ SDLDeviceLevelStatus + +Required
+ + + +@property (readwrite, strong, atomic) SDLDeviceLevelStatus *battLevelStatus;var battLevelStatus: SDLDeviceLevelStatus! { get set }@abstract The status of the stereo audio output channel
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *stereoAudioOutputMuted;var stereoAudioOutputMuted: NSNumber! { get set }@abstract The status of the mono audio output channel
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *monoAudioOutputMuted;var monoAudioOutputMuted: NSNumber! { get set }@abstract Signal level status
+ +See
+ SDLDeviceLevelStatus + +Required
+ + + +@property (readwrite, strong, atomic) SDLDeviceLevelStatus *signalLevelStatus;var signalLevelStatus: SDLDeviceLevelStatus! { get set }@abstract The current primary audio source of SDL (if selected).
+ +See
+ SDLPrimaryAudioSource + +Required
+ + + +@property (readwrite, strong, atomic) SDLPrimaryAudioSource *primaryAudioSource;var primaryAudioSource: SDLPrimaryAudioSource! { get set }@abstract Indicates if an emergency call is active
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *eCallEventActive;var eCallEventActive: NSNumber! { get set }Non periodic vehicle diagnostic request
+ +@since SDL 3.0
+ + +Undocumented
+ + + +@interface SDLDiagnosticMessage : SDLRPCRequestUndocumented
+ + + +@interface SDLDiagnosticMessage : SDLRPCRequestName of target ECU
+ +Required, Integer, 0 - 65535
+ + + +@property (readwrite, strong, atomic) NSNumber *targetID;var targetID: NSNumber! { get set }Length of message (in bytes)
+ +Required, Integer, 65535
+ + + +@property (readwrite, strong, atomic) NSNumber *messageLength;var messageLength: NSNumber! { get set }Array of bytes comprising CAN message.
+ +Required, Array of NSNumber (Integers), Array size 1 - 65535, Integer Size 0 - 255
+ + + +@property (readwrite, strong, atomic) NSMutableArray *messageData;var messageData: NSMutableArray! { get set }SDLDiagnosticMessageResponse is sent, when SDLDiagnosticMessage has been called. + * SinceSmartDeviceLink 3.0
+ + +Undocumented
+ + + +@interface SDLDiagnosticMessageResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLDiagnosticMessageResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLDiagnosticMessageResponse : SDLRPCResponseThis RPC is used to tell the head unit to use bluetooth to dial a phone number using the phone.
+ +@since SDL 4.0
+ + +Undocumented
+ + + +@interface SDLDialNumber : SDLRPCRequestUndocumented
+ + + +@interface SDLDialNumber : SDLRPCRequestUp to 40 character string representing the phone number. All characters stripped except for ‘0’-‘9’, ’*’, ’#’, ’,’, ’;’, and ’+’
+ + + +@property (readwrite, strong, nonatomic) NSString *number;var number: String! { get set }Indicates the result, success, or failure of the SDLDialNumber request.
+ +@since SDL 4.0
+ + +Undocumented
+ + + +@interface SDLDialNumberResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLDialNumberResponse : SDLRPCResponseThe supported dimensions of the GPS.
+ +@since SDL 2.0
+ + +Convert String to SDLDimension
+ + + ++ (SDLDimension *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLDimension!The value of the string to get an object for
+SDLDimension
+ +@abstract Store the enumeration of all possible SDLDimension
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!An array that store all possible SDLDimension
+ +@abstract No GPS at all +- returns: the dimension with value of NO_FIX
+ + + ++ (SDLDimension *)NO_FIX;class func NO_FIX() -> SDLDimension!the dimension with value of NO_FIX
+ +@abstract Longitude and latitude of the GPS +- returns: the dimension with value of 2D
+ + + ++ (SDLDimension *)_2D;class func _2D() -> SDLDimension!the dimension with value of 2D
+ +@abstract Longitude and latitude and altitude of the GPS +- returns: the dimension with value of 3D
+ + + ++ (SDLDimension *)_3D;class func _3D() -> SDLDimension!the dimension with value of 3D
+ +Contains information about the display for the SDL system to which the application is currently connected.
+ +@since SDL 1.0
+ + +Constructs a newly allocated SDLDisplayCapabilities object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLDisplayCapabilities object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The type of display
+ +Required
+ + + +@property (readwrite, strong, atomic) SDLDisplayType *displayType;var displayType: SDLDisplayType! { get set }@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).
+ +See
+ SDLTextField + +Required, Array of SDLTextField, 1 - 100 objects
+ + + +@property (readwrite, strong, atomic) NSMutableArray *textFields;var textFields: NSMutableArray! { get set }@abstract An array of SDLImageField elements
+ +@discussion A set of all fields that support images.
+ +See
+ SDLImageField + +Optional, Array of SDLImageField, 1 - 100 objects
+ + + +@property (readwrite, strong, atomic) NSMutableArray *imageFields;var imageFields: NSMutableArray! { get set }@abstract An array of SDLMediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field
+ +See
+ SDLMediaClockFormat + +Required, Array of SDLMediaClockFormats, 0 - 100 objects
+ + + +@property (readwrite, strong, atomic) NSMutableArray *mediaClockFormats;var mediaClockFormats: NSMutableArray! { get set }@abstract The display’s persistent screen supports.
+ +@since SDL 2.0
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *graphicSupported;var graphicSupported: NSNumber! { get set }@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
+ + + +@property (readwrite, strong, atomic) NSMutableArray *templatesAvailable;var templatesAvailable: NSMutableArray! { get set }@abstract A set of all parameters related to a prescribed screen area (e.g. for video / touch input)
+ +Optional
+ + + +@property (readwrite, strong, atomic) SDLScreenParams *screenParams;var screenParams: SDLScreenParams! { get set }@abstract The number of on-screen custom presets available (if any); otherwise omitted
+ +Optional, Integer 1 - 100
+ + + +@property (readwrite, strong, atomic) NSNumber *numCustomPresetsAvailable;var numCustomPresetsAvailable: NSNumber! { get set }Identifies the various display types used by SDL.
+ +@since SDL 1.0
+ + +Convert String to SDLDisplayType
+ + + ++ (SDLDisplayType *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLDisplayType!The value of the string to get an object for
+SDLDisplayType
+ +@abstract Store the enumeration of all possible SDLDisplayType
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLDisplayType
+ +@abstract This display type provides a 2-line x 20 character dot matrix
display.
+ (SDLDisplayType *)CID;class func CID() -> SDLDisplayType!SDLDisplayType with value of CID
+ +Undocumented
+ + + +@interface SDLDisplayType : SDLEnumUndocumented
+ + + +@interface SDLDisplayType : SDLEnum@abstract This display type provides an 8 inch touchscreen display.
+ + + ++ (SDLDisplayType *)NGN;class func NGN() -> SDLDisplayType!SDLDisplayType with value of NGN
+ +Undocumented
+ + + +@interface SDLDisplayType : SDLEnumUndocumented
+ + + +@interface SDLDisplayType : SDLEnumUndocumented
+ + + +@interface SDLDisplayType : SDLEnumUndocumented
+ + + +@interface SDLDisplayType : SDLEnumUndocumented
+ + + +@interface SDLDisplayType : SDLEnumUndocumented
+ + + +@interface SDLDisplayType : SDLEnumEnumeration that describes possible states of driver distraction.
+ +@since SDL 1.0
+ + +Convert String to SDLDisplayType
+ + + ++ (SDLDriverDistractionState *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLDriverDistractionState!The value of the string to get an object for
+SDLDisplayType
+ +@abstract Store the enumeration of all possible SDLDriverDistractionState
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLDriverDistractionState
+ +@abstract Driver distraction rules are in effect.
+ + + ++ (SDLDriverDistractionState *)DD_ON;class func DD_ON() -> SDLDriverDistractionState!a SDLDriverDistractionState with value of DD_ON
+ +@abstract Driver distraction rules are NOT in effect.
+ + + ++ (SDLDriverDistractionState *)DD_OFF;class func DD_OFF() -> SDLDriverDistractionState!a SDLDriverDistractionState with value of DD_OFF
+ +Reflects the status of the eCall Notification. + *Since SmartDeviceLink 2.0 +
+ + +Undocumented
+ + + +@interface SDLECallConfirmationStatus : SDLEnumUndocumented
+ + + +@interface SDLECallConfirmationStatus : SDLEnumNo E-Call signal triggered.
+ + + ++ (SDLECallConfirmationStatus *)NORMAL;class func NORMAL() -> SDLECallConfirmationStatus!An E-Call is being in progress.
+ + + ++ (SDLECallConfirmationStatus *)CALL_IN_PROGRESS;class func CALL_IN_PROGRESS() -> SDLECallConfirmationStatus!CALL_CANCELLED An E-Call was cancelled by the user.
+ + + ++ (SDLECallConfirmationStatus *)CALL_CANCELLED;class func CALL_CANCELLED() -> SDLECallConfirmationStatus!The E-Call sequence is completed.
+ + + ++ (SDLECallConfirmationStatus *)CALL_COMPLETED;class func CALL_COMPLETED() -> SDLECallConfirmationStatus!An E-Call could not be connected.
+ + + ++ (SDLECallConfirmationStatus *)CALL_UNSUCCESSFUL;class func CALL_UNSUCCESSFUL() -> SDLECallConfirmationStatus!E-Call is not configured on this vehicle.
+ + + ++ (SDLECallConfirmationStatus *)ECALL_CONFIGURED_OFF;class func ECALL_CONFIGURED_OFF() -> SDLECallConfirmationStatus!E-Call is considered to be complete without Emergency Operator contact.
+ + + ++ (SDLECallConfirmationStatus *)CALL_COMPLETE_DTMF_TIMEOUT;class func CALL_COMPLETE_DTMF_TIMEOUT() -> SDLECallConfirmationStatus!Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Reflects the emergency event status of the vehicle. + * Since: SmartDeviceLink 2.0 + *
+ + +Undocumented
+ + + +@interface SDLEmergencyEventType : SDLEnumUndocumented
+ + + +@interface SDLEmergencyEventType : SDLEnumNo emergency event has happened.
+ + + ++ (SDLEmergencyEventType *)NO_EVENT;class func NO_EVENT() -> SDLEmergencyEventType!Frontal collision has happened.
+ + + ++ (SDLEmergencyEventType *)FRONTAL;class func FRONTAL() -> SDLEmergencyEventType!Side collision has happened.
+ + + ++ (SDLEmergencyEventType *)SIDE;class func SIDE() -> SDLEmergencyEventType!Rear collision has happened.
+ + + ++ (SDLEmergencyEventType *)REAR;class func REAR() -> SDLEmergencyEventType!A rollover event has happened.
+ + + ++ (SDLEmergencyEventType *)ROLLOVER;class func ROLLOVER() -> SDLEmergencyEventType!The signal is not supported
+ + + ++ (SDLEmergencyEventType *)NOT_SUPPORTED;class func NOT_SUPPORTED() -> SDLEmergencyEventType!Emergency status cannot be determined
+ + + ++ (SDLEmergencyEventType *)FAULT;class func FAULT() -> SDLEmergencyEventType!Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +When this request is invoked, the audio capture stops +
+Function Group: AudioPassThru +
+HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 2.0
+see SDLPerformAudioPassThru
Constructs a new SDLEndAudioPassThru object
+ + + +- (instancetype)init;init!()Constructs a new SDLEndAudioPassThru object indicated by the NSMutableDictionary + parameter +
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+SDLEndAudioPassThruResponse is sent, when SDLEndAudioPassThru has been called
+ +Since SmartDeviceLink 2.0
+ + +Undocumented
+ + + +@interface SDLEndAudioPassThruResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLEndAudioPassThruResponse : SDLRPCResponseUndocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Enumeration listing possible file types.
+ +@since SDL 2.0
+ + +@abstract Convert String to SDLFileType
+ + + ++ (SDLFileType *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLFileType!String value to retrieve the object for
+SDLFileType
+ +@abstract Store the enumeration of all possible SDLFileType
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLFileType
+ +@abstract file type: Bitmap (BMP)
+ + + ++ (SDLFileType *)GRAPHIC_BMP;class func GRAPHIC_BMP() -> SDLFileType!SDLFileType with value of GRAPHIC_BMP
+ +@abstract file type: JPEG
+ + + ++ (SDLFileType *)GRAPHIC_JPEG;class func GRAPHIC_JPEG() -> SDLFileType!SDLFileType with value of GRAPHIC_JPEG
+ +@abstract file type: PNG
+ + + ++ (SDLFileType *)GRAPHIC_PNG;class func GRAPHIC_PNG() -> SDLFileType!SDLFileType with value of GRAPHIC_PNG
+ +@abstract file type: WAVE (WAV)
+ + + ++ (SDLFileType *)AUDIO_WAVE;class func AUDIO_WAVE() -> SDLFileType!SDLFileType with value of AUDIO_WAVE
+ +@abstract file type: MP3
+ + + ++ (SDLFileType *)AUDIO_MP3;class func AUDIO_MP3() -> SDLFileType!SDLFileType with value of AUDIO_MP3
+ +@abstract file type: AAC
+ + + ++ (SDLFileType *)AUDIO_AAC;class func AUDIO_AAC() -> SDLFileType!SDLFileType with value of AUDIO_AAC
+ +@abstract file type: BINARY
+ + + ++ (SDLFileType *)BINARY;class func BINARY() -> SDLFileType!SDLFileType with value of BINARY
+ +@abstract file type: JSON
+ + + ++ (SDLFileType *)JSON;class func JSON() -> SDLFileType!SDLFileType with value of JSON
+ +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
+ + +@abstract Convert String to SDLFuelCutoffStatus
+ + + ++ (SDLFuelCutoffStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLFuelCutoffStatus!String value to retrieve the object for
+SDLFuelCutoffStatus
+ +@abstract Store the enumeration of all possible SDLFuelCutoffStatus
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that stores all possible SDLFuelCutoffStatus
+ +@abstract Fuel is cut off +- returns: the fuel cutoff status: TERMINATE_FUEL
+ + + ++ (SDLFuelCutoffStatus *)TERMINATE_FUEL;class func TERMINATE_FUEL() -> SDLFuelCutoffStatus!the fuel cutoff status: TERMINATE_FUEL
+ +@abstract Fuel is not cut off +- returns: the fuel cutoff status: NORMAL_OPERATION
+ + + ++ (SDLFuelCutoffStatus *)NORMAL_OPERATION;class func NORMAL_OPERATION() -> SDLFuelCutoffStatus!the fuel cutoff status: NORMAL_OPERATION
+ +@abstract Status of the fuel pump cannot be determined +- returns: the fuel cutoff status: FAULT
+ + + ++ (SDLFuelCutoffStatus *)FAULT;class func FAULT() -> SDLFuelCutoffStatus!the fuel cutoff status: FAULT
+ +Describes the GPS data. Not all data will be available on all carlines.
+ +@since SDL 2.0
+ + +Constructs a newly allocated SDLGPSData object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLGPSData object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract longitude degrees
+ +Required, Float, -180 - 180
+ + + +@property (readwrite, strong, atomic) NSNumber *longitudeDegrees;var longitudeDegrees: NSNumber! { get set }@abstract latitude degrees
+ +Required, Float, -90 - 90
+ + + +@property (readwrite, strong, atomic) NSNumber *latitudeDegrees;var latitudeDegrees: NSNumber! { get set }@abstract utc year
+ +Required, Integer, 2010 - 2100
+ + + +@property (readwrite, strong, atomic) NSNumber *utcYear;var utcYear: NSNumber! { get set }@abstract utc month
+ +Required, Integer, 1 - 12
+ + + +@property (readwrite, strong, atomic) NSNumber *utcMonth;var utcMonth: NSNumber! { get set }@abstract utc day
+ +Required, Integer, 1 - 31
+ + + +@property (readwrite, strong, atomic) NSNumber *utcDay;var utcDay: NSNumber! { get set }@abstract utc hours
+ +Required, Integer, 0 - 23
+ + + +@property (readwrite, strong, atomic) NSNumber *utcHours;var utcHours: NSNumber! { get set }@abstract utc minutes
+ +Required, Integer, 0 - 59
+ + + +@property (readwrite, strong, atomic) NSNumber *utcMinutes;var utcMinutes: NSNumber! { get set }@abstract utc seconds
+ +Required, Integer, 0 - 59
+ + + +@property (readwrite, strong, atomic) NSNumber *utcSeconds;var utcSeconds: NSNumber! { get set }Potential Compass Directions
+ + + +@property (readwrite, strong, atomic) SDLCompassDirection *compassDirection;var compassDirection: SDLCompassDirection! { get set }@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
+ + + +@property (readwrite, strong, atomic) NSNumber *pdop;var pdop: NSNumber! { get set }@abstract The horizontal dilution of precision
+ +@discussion If undefined or unavailable, then value shall be set to 0
+ +Required, Float, 0.0 - 10.0
+ + + +@property (readwrite, strong, atomic) NSNumber *hdop;var hdop: NSNumber! { get set }@abstract the vertical dilution of precision
+ +@discussion If undefined or unavailable, then value shall be set to 0
+ +Required, Float, 0.0 - 10.0
+ + + +@property (readwrite, strong, atomic) NSNumber *vdop;var vdop: NSNumber! { get set }@abstract What the coordinates are based on
+ +@discussion YES, if coordinates are based on satellites. NO, if based on dead reckoning.
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *actual;var actual: NSNumber! { get set }@abstract The number of satellites in view
+ +Required, Integer, 0 - 31
+ + + +@property (readwrite, strong, atomic) NSNumber *satellites;var satellites: NSNumber! { get set }The supported dimensions of the GPS
+ +Required
+ + + +@property (readwrite, strong, atomic) SDLDimension *dimension;var dimension: SDLDimension! { get set }@abstract altitude in meters
+ +Required, Float, -10000.0 - 10000.0
+ + + +@property (readwrite, strong, atomic) NSNumber *altitude;var altitude: NSNumber! { get set }@abstract Heading based on the GPS data.
+ +@discussion North is 0, East is 90, etc. Resolution is 0.01
+ +Required, Float, 0.0 - 359.99
+ + + +@property (readwrite, strong, atomic) NSNumber *heading;var heading: NSNumber! { get set }@abstract speed in KPH
+ +Required, Float, 0.0 - 500.0
+ + + +@property (readwrite, strong, atomic) NSNumber *speed;var speed: NSNumber! { get set }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.
+ + +Undocumented
+ + + +@interface SDLGenericResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLGenericResponse : SDLRPCResponseThis RPC allows to request diagnostic module trouble codes from a certain +vehicle module +
+Function Group: ProprietaryData +
+HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ + +Constructs a new SDLGetDTCs object
+ + + +- (instancetype)init;init!()Constructs a new SDLGetDTCs object indicated by the dictionary parameter +
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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
+ + + +@property (readwrite, strong, atomic) NSNumber *ecuName;var ecuName: NSNumber! { get set }@abstract DTC Mask Byte to be sent in diagnostic request to module. NSNumber* dtcMask Minvalue:0; Maxvalue:255
+ + + +@property (readwrite, strong, atomic) NSNumber *dtcMask;var dtcMask: NSNumber! { get set }SDLGetDTCsResponse is sent, when SDLGetDTCs has been called
+ +Since SmartDeviceLink 2.0
+ + +Undocumented
+ + + +@interface SDLGetDTCsResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLGetDTCsResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLGetDTCsResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLGetDTCsResponse : SDLRPCResponseRequests surrent values of specific published vehicle data items. +
+ Function Group: Location, VehicleInfo and DrivingChara +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 2.0
+ See SDLSubscribeVehicleData SDLUnsubscribeVehicleData
@abstract Constructs a new SDLGetVehicleData object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLGetVehicleData object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract A boolean value. If true, requests Gps data
+ + + +@property (readwrite, strong, atomic) NSNumber *gps;var gps: NSNumber! { get set }@abstract A boolean value. If true, requests speed data
+ + + +@property (readwrite, strong, atomic) NSNumber *speed;var speed: NSNumber! { get set }@abstract A boolean value. If true, requests rpm data
+ + + +@property (readwrite, strong, atomic) NSNumber *rpm;var rpm: NSNumber! { get set }@abstract A boolean value. If true, requests FuelLevel data
+ + + +@property (readwrite, strong, atomic) NSNumber *fuelLevel;var fuelLevel: NSNumber! { get set }@abstract A boolean value. If true, requests fuelLevel_State data
+ + + +@property (readwrite, strong, atomic) NSNumber *fuelLevel_State;var fuelLevel_State: NSNumber! { get set }@abstract A boolean value. If true, requests instantFuelConsumption data
+ + + +@property (readwrite, strong, atomic) NSNumber *instantFuelConsumption;var instantFuelConsumption: NSNumber! { get set }@abstract A boolean value. If true, requests externalTemperature data
+ + + +@property (readwrite, strong, atomic) NSNumber *externalTemperature;var externalTemperature: NSNumber! { get set }@abstract A boolean value. If true, requests Vehicle Identification Number
+ + + +@property (readwrite, strong, atomic) NSNumber *vin;var vin: NSNumber! { get set }@abstract A boolean value. If true, requests Currently selected gear data
+ + + +@property (readwrite, strong, atomic) NSNumber *prndl;var prndl: NSNumber! { get set }@abstract A boolean value. If true, requests tire pressure status data
+ + + +@property (readwrite, strong, atomic) NSNumber *tirePressure;var tirePressure: NSNumber! { get set }@abstract A boolean value. If true, requests odometer data
+ + + +@property (readwrite, strong, atomic) NSNumber *odometer;var odometer: NSNumber! { get set }@abstract A boolean value. If true, requests belt Status data
+ + + +@property (readwrite, strong, atomic) NSNumber *beltStatus;var beltStatus: NSNumber! { get set }@abstract A boolean value. If true, requests body Information data
+ + + +@property (readwrite, strong, atomic) NSNumber *bodyInformation;var bodyInformation: NSNumber! { get set }@abstract A boolean value. If true, requests device Status data
+ + + +@property (readwrite, strong, atomic) NSNumber *deviceStatus;var deviceStatus: NSNumber! { get set }@abstract A boolean value. If true, requests driver Braking data
+ + + +@property (readwrite, strong, atomic) NSNumber *driverBraking;var driverBraking: NSNumber! { get set }@abstract A boolean value. If true, requests wiper Status data
+ + + +@property (readwrite, strong, atomic) NSNumber *wiperStatus;var wiperStatus: NSNumber! { get set }@abstract A boolean value. If true, requests Head Lamp Status data
+ + + +@property (readwrite, strong, atomic) NSNumber *headLampStatus;var headLampStatus: NSNumber! { get set }@abstract A boolean value. If true, requests Engine Torque data
+ + + +@property (readwrite, strong, atomic) NSNumber *engineTorque;var engineTorque: NSNumber! { get set }@abstract A boolean value. If true, means the accPedalPosition data has been +subscribed.
+ + + +@property (readwrite, strong, atomic) NSNumber *accPedalPosition;var accPedalPosition: NSNumber! { get set }@abstract A boolean value. If true, means the steeringWheelAngle data has been +subscribed.
+ + + +@property (readwrite, strong, atomic) NSNumber *steeringWheelAngle;var steeringWheelAngle: NSNumber! { get set }Undocumented
+ + + +@interface SDLGetVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLGetVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLGetVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLGetVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLGetVehicleData : SDLRPCRequestGet Vehicle Data Response is sent, when SDLGetVehicleData has been called
+ +Since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLGetVehicleDataResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLGetVehicleDataResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract A SDLGPSData* value. See GPSData.
+ + + +@property (readwrite, strong, atomic) SDLGPSData *gps;var gps: SDLGPSData! { get set }@abstract The vehicle speed in kilometers per hour.
+ + + +@property (readwrite, strong, atomic) NSNumber *speed;var speed: NSNumber! { get set }@abstract The number of revolutions per minute of the engine.
+ + + +@property (readwrite, strong, atomic) NSNumber *rpm;var rpm: NSNumber! { get set }@abstract The fuel level in the tank (percentage)
+ + + +@property (readwrite, strong, atomic) NSNumber *fuelLevel;var fuelLevel: NSNumber! { get set }@abstract A SDLComponentVolumeStatus* value. The fuel level state.
+ + + +@property (readwrite, strong, atomic) SDLComponentVolumeStatus *fuelLevel_State;var fuelLevel_State: SDLComponentVolumeStatus! { get set }@abstract The instantaneous fuel consumption in microlitres.
+ + + +@property (readwrite, strong, atomic) NSNumber *instantFuelConsumption;var instantFuelConsumption: NSNumber! { get set }@abstract The external temperature in degrees celsius.
+ + + +@property (readwrite, strong, atomic) NSNumber *externalTemperature;var externalTemperature: NSNumber! { get set }@abstract The Vehicle Identification Number
+ + + +@property (readwrite, strong, atomic) NSString *vin;var vin: String! { get set }@abstract See PRNDL.
+ + + +@property (readwrite, strong, atomic) SDLPRNDL *prndl;var prndl: SDLPRNDL! { get set }@abstract A SDLTireStatus* value. See TireStatus.
+ + + +@property (readwrite, strong, atomic) SDLTireStatus *tirePressure;var tirePressure: SDLTireStatus! { get set }@abstract Odometer reading in km.
+ + + +@property (readwrite, strong, atomic) NSNumber *odometer;var odometer: NSNumber! { get set }@abstract A SDLBeltStatus* value. The status of the seat belts.
+ + + +@property (readwrite, strong, atomic) SDLBeltStatus *beltStatus;var beltStatus: SDLBeltStatus! { get set }@abstract A SDLBodyInformation* value. The body information including power modes.
+ + + +@property (readwrite, strong, atomic) SDLBodyInformation *bodyInformation;var bodyInformation: SDLBodyInformation! { get set }@abstract A SDLDeviceStatus* value. The device status including signal and battery strength.
+ + + +@property (readwrite, strong, atomic) SDLDeviceStatus *deviceStatus;var deviceStatus: SDLDeviceStatus! { get set }@abstract A SDLVehicleDataResult* value. The status of the brake pedal.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataEventStatus *driverBraking;var driverBraking: SDLVehicleDataEventStatus! { get set }@abstract A SDLWiperStatus* value. The status of the wipers.
+ + + +@property (readwrite, strong, atomic) SDLWiperStatus *wiperStatus;var wiperStatus: SDLWiperStatus! { get set }@abstract A SDLHeadLampStatus* value. Status of the head lamps.
+ + + +@property (readwrite, strong, atomic) SDLHeadLampStatus *headLampStatus;var headLampStatus: SDLHeadLampStatus! { get set }@abstract Torque value for engine (in Nm) on non-diesel variants.
+ + + +@property (readwrite, strong, atomic) NSNumber *engineTorque;var engineTorque: NSNumber! { get set }@abstract Accelerator pedal position (percentage depressed)
+ + + +@property (readwrite, strong, atomic) NSNumber *accPedalPosition;var accPedalPosition: NSNumber! { get set }@abstract Current angle of the steering wheel (in deg)
+ + + +@property (readwrite, strong, atomic) NSNumber *steeringWheelAngle;var steeringWheelAngle: NSNumber! { get set }Undocumented
+ + + +@interface SDLGetVehicleDataResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLGetVehicleDataResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLGetVehicleDataResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLGetVehicleDataResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLGetVehicleDataResponse : SDLRPCResponseProperties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button).
+ +@since SDL 1.0
+ + +Convert String to SDLGlobalProperty +- parameter: value The value of the string to get an object for +- returns: SDLGlobalProperty
+ + + ++ (SDLGlobalProperty *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLGlobalProperty!The value of the string to get an object for
+SDLGlobalProperty
+ +@abstract Store the enumeration of all possible SDLGlobalProperty +- returns: An array that store all possible SDLGlobalProperty
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!An array that store all possible SDLGlobalProperty
+ +@abstract The help prompt to be spoken if the user needs assistance during a user-initiated interaction. +- returns: A SDLGlobalProperty with value of HELPPROMPT
+ + + ++ (SDLGlobalProperty *)HELPPROMPT;class func HELPPROMPT() -> SDLGlobalProperty!A SDLGlobalProperty with value of HELPPROMPT
+ +@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
+ + + ++ (SDLGlobalProperty *)TIMEOUTPROMPT;class func TIMEOUTPROMPT() -> SDLGlobalProperty!A SDLGlobalProperty with value of TIMEOUTPROMPT
+ +Undocumented
+ + + +@interface SDLGlobalProperty : SDLEnumUndocumented
+ + + +@interface SDLGlobalProperty : SDLEnumUndocumented
+ + + +@interface SDLGlobalProperty : SDLEnumUndocumented
+ + + +@interface SDLGlobalProperty : SDLEnumUndocumented
+ + + +@interface SDLGlobalProperty : SDLEnumUndocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Availability of build in Nav. True: Available, False: Not Available
+ +Boolean value. Optional.
+ + + +@property (readwrite, copy, nonatomic) NSNumber *navigation;@NSCopying var navigation: NSNumber! { get set }Availability of build in phone. True: Available, False: Not Available
+ +Boolean value. Optional.
+ + + +@property (readwrite, copy, nonatomic) NSNumber *phoneCall;@NSCopying var phoneCall: NSNumber! { get set }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
+ + +Return HMILevel status (FULL, LIMITED, BACKGROUND, NONE)
+ + + ++ (SDLHMILevel *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLHMILevel!String value to retrieve the object for
+Current HMI level
+ +Store all possible SDLHMILevel values
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array with all possible HMILevel values inside
+ +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
+ + + ++ (SDLHMILevel *)FULL;class func FULL() -> SDLHMILevel!the HMILevel with value of FULL
+ +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)
+ + + ++ (SDLHMILevel *)LIMITED;class func LIMITED() -> SDLHMILevel!the HMILevel with value of LIMITED
+ +App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations:
+ +@discussion
+ (SDLHMILevel *)BACKGROUND;class func BACKGROUND() -> SDLHMILevel!the HMILevel with value of BACKGROUND
+ +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 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
+ (SDLHMILevel *)NONE;class func NONE() -> SDLHMILevel!the HMILevel with value of NONE
+ +Defining sets of HMI levels, which are permitted or prohibited for a given RPC.
+ +@since SDL 2.0
+ + +Constructs a newly allocated SDLHMIPermissions object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLHMIPermissions object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract a set of all HMI levels that are permitted for this given RPC
+ +See
+ SDLHMILevel + +Required, Array of SDLHMILevel, Array size 0 - 100
+ + + +@property (readwrite, strong, atomic) NSMutableArray *allowed;var allowed: NSMutableArray! { get set }@abstract a set of all HMI levels that are prohibited for this given RPC
+ +See
+ SDLHMILevel + +Required, Array of SDLHMILevel, Array size 0 - 100
+ + + +@property (readwrite, strong, atomic) NSMutableArray *userDisallowed;var userDisallowed: NSMutableArray! { get set }Specifies HMI Zones in the vehicle.
+ +@since SDL 1.0
+ + +@abstract SDLHMIZoneCapabilities +- parameter: value The value of the string to get an object for +- returns: SDLHMIZoneCapabilities
+ + + ++ (SDLHMIZoneCapabilities *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLHMIZoneCapabilities!The value of the string to get an object for
+SDLHMIZoneCapabilities
+ +@abstract store all possible SDLHMIZoneCapabilities values +- returns: an array with all possible SDLHMIZoneCapabilities values inside
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array with all possible SDLHMIZoneCapabilities values inside
+ +@abstract Indicates HMI available for front seat passengers. +- returns: a SDLHMIZoneCapabilities with value of FRONT
+ + + ++ (SDLHMIZoneCapabilities *)FRONT;class func FRONT() -> SDLHMIZoneCapabilities!a SDLHMIZoneCapabilities with value of FRONT
+ +@abstract Indicates HMI available for rear seat passengers. +- returns: a SDLHMIZoneCapabilities with value of BACK
+ + + ++ (SDLHMIZoneCapabilities *)BACK;class func BACK() -> SDLHMIZoneCapabilities!a SDLHMIZoneCapabilities with value of BACK
+ +Status of the head lamps
+ + +@abstract Constructs a new SDLHeadLampStatus object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLHeadLampStatus object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract A boolean value. Status of the low beam lamps.
+ + + +@property (readwrite, strong, atomic) NSNumber *lowBeamsOn;var lowBeamsOn: NSNumber! { get set }@abstract A boolean value. Status of the high beam lamps.
+ + + +@property (readwrite, strong, atomic) NSNumber *highBeamsOn;var highBeamsOn: NSNumber! { get set }Undocumented
+ + + +@interface SDLHeadLampStatus : SDLRPCStructUndocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Reflects the ignition switch stability.
+ +@since SDL 2.0
+ + +@abstract return SDLIgnitionStableStatus +- parameter: value The value of the string to get an object for +- returns: SDLIgnitionStableStatus
+ + + ++ (SDLIgnitionStableStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLIgnitionStableStatus!The value of the string to get an object for
+SDLIgnitionStableStatus
+ +@abstract store all possible SDLIgnitionStableStatus values +- returns: an array with all possible SDLIgnitionStableStatus values inside
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array with all possible SDLIgnitionStableStatus values inside
+ +@abstract The current ignition switch status is considered not to be stable. +- returns: the Ignition Stable Status with value of IGNITION_SWITCH_NOT_STABLE
+ + + ++ (SDLIgnitionStableStatus *)IGNITION_SWITCH_NOT_STABLE;class func IGNITION_SWITCH_NOT_STABLE() -> SDLIgnitionStableStatus!the Ignition Stable Status with value of IGNITION_SWITCH_NOT_STABLE
+ +@abstract The current ignition switch status is considered to be stable. +- returns: the Ignition Stable Status with value of IGNITION_SWITCH_STABLE
+ + + ++ (SDLIgnitionStableStatus *)IGNITION_SWITCH_STABLE;class func IGNITION_SWITCH_STABLE() -> SDLIgnitionStableStatus!the Ignition Stable Status with value of IGNITION_SWITCH_STABLE
+ +Undocumented
+ + + +@interface SDLIgnitionStableStatus : SDLEnumReflects the status of ignition..
+ +@since SDL 2.0
+ + +@abstract return SDLIgnitionStatus +- parameter: value The value of the string to get an object for +- returns: SDLIgnitionStatus object
+ + + ++ (SDLIgnitionStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLIgnitionStatus!The value of the string to get an object for
+SDLIgnitionStatus object
+ +@abstract store all possible SDLIgnitionStatus values +- returns: an array with all possible SDLIgnitionStatus values inside
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array with all possible SDLIgnitionStatus values inside
+ +@abstract Ignition status currently unknown +- returns: Ignition Status with value of UNKNOWN
+ + + ++ (SDLIgnitionStatus *)UNKNOWN;class func UNKNOWN() -> SDLIgnitionStatus!Ignition Status with value of UNKNOWN
+ +@abstract Ignition is off +- returns: Ignition Status with value of OFF
+ + + ++ (SDLIgnitionStatus *)OFF;class func OFF() -> SDLIgnitionStatus!Ignition Status with value of OFF
+ +@abstract Ignition is in mode accessory +- returns: Ignition Status with value of ACCESSORY
+ + + ++ (SDLIgnitionStatus *)ACCESSORY;class func ACCESSORY() -> SDLIgnitionStatus!Ignition Status with value of ACCESSORY
+ +@abstract Ignition is in mode run +- returns: Ignition Status with value of RUN
+ + + ++ (SDLIgnitionStatus *)RUN;class func RUN() -> SDLIgnitionStatus!Ignition Status with value of RUN
+ +@abstract Ignition is in mode start +- returns: Ignition Status with value of START
+ + + ++ (SDLIgnitionStatus *)START;class func START() -> SDLIgnitionStatus!Ignition Status with value of START
+ +@abstract Signal is invalid +- returns: Ignition Status with value of INVALID
+ + + ++ (SDLIgnitionStatus *)INVALID;class func INVALID() -> SDLIgnitionStatus!Ignition Status with value of INVALID
+ +Specifies, which image shall be used, e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it.
+ +@since SDL 2.0
+ + +Constructs a newly allocated SDLImage object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLImage object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The static hex icon value or the binary image file name identifier (sent by SDLPutFile)
+ +Required, max length = 65535
+ + + +@property (readwrite, strong, atomic) NSString *value;var value: String! { get set }@abstract Describes, whether it is a static or dynamic image
+ +Required
+ + + +@property (readwrite, strong, atomic) SDLImageType *imageType;var imageType: SDLImageType! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +The name that identifies the filed. + * + * + * @since SmartDeviceLink 3.0 + *
+ + +Undocumented
+ + + +@interface SDLImageFieldName : SDLEnumUndocumented
+ + + +@interface SDLImageFieldName : SDLEnumThe image field for SoftButton + *
+ + + ++ (SDLImageFieldName *)softButtonImage;class func softButtonImage() -> SDLImageFieldName!The first image field for Choice. + *
+ + + ++ (SDLImageFieldName *)choiceImage;class func choiceImage() -> SDLImageFieldName!The scondary image field for Choice. + *
+ + + ++ (SDLImageFieldName *)choiceSecondaryImage;class func choiceSecondaryImage() -> SDLImageFieldName!The image field for vrHelpItem. + *
+ + + ++ (SDLImageFieldName *)vrHelpItem;class func vrHelpItem() -> SDLImageFieldName!The image field for Turn. + *
+ + + ++ (SDLImageFieldName *)turnIcon;class func turnIcon() -> SDLImageFieldName!The image field for the menu icon in SetGlobalProperties. + *
+ + + ++ (SDLImageFieldName *)menuIcon;class func menuIcon() -> SDLImageFieldName!The image filed for AddCommand. + *
+ + + ++ (SDLImageFieldName *)cmdIcon;class func cmdIcon() -> SDLImageFieldName!The iamage field for the app icon ( set by setAppIcon). + *
+ + + ++ (SDLImageFieldName *)appIcon;class func appIcon() -> SDLImageFieldName!The image filed for Show. + *
+ + + ++ (SDLImageFieldName *)graphic;class func graphic() -> SDLImageFieldName!The primary image field for ShowConstant TBT. + *
+ + + ++ (SDLImageFieldName *)showConstantTBTIcon;class func showConstantTBTIcon() -> SDLImageFieldName!The secondary image field for ShowConstant TBT. + *
+ + + ++ (SDLImageFieldName *)showConstantTBTNextTurnIcon;class func showConstantTBTNextTurnIcon() -> SDLImageFieldName!The optional image of a destination / location +@since SDL 4.0
+ + + ++ (SDLImageFieldName *)locationImage;class func locationImage() -> SDLImageFieldName!Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Contains information about the type of image.
+ +@since SDL 2.0
+ + +@abstract return SDLImageType (STATIC / DYNAMIC)
+ + + ++ (SDLImageType *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLImageType!The value of the string to get an object for
+An SDLImageType
+ +@abstract store all possible SDLImageType values
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!An array with all possible SDLImageType values inside
+ +@abstract Just the static hex icon value to be used
+ + + ++ (SDLImageType *)STATIC;class func STATIC() -> SDLImageType!The Image Type with value STATIC
+ +@abstract Binary image file to be used (identifier to be sent by SDLPutFile)
+ +See
+SDLPutFile
+ ++ (SDLImageType *)DYNAMIC;class func DYNAMIC() -> SDLImageType!The Image Type with value DYNAMIC
+ +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
+ + +@abstract SDLInteractionMode +- parameter: value The value of the string to get an object for +- returns: SDLInteractionMode
+ + + ++ (SDLInteractionMode *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLInteractionMode!The value of the string to get an object for
+SDLInteractionMode
+ +@abstract store all possible SDLInteractionMode values +- returns: an array with all possible SDLInteractionMode values inside
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array with all possible SDLInteractionMode values inside
+ +@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
+ + + ++ (SDLInteractionMode *)MANUAL_ONLY;class func MANUAL_ONLY() -> SDLInteractionMode!Current Interaction Mode with value of MANUAL_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
+ + + ++ (SDLInteractionMode *)VR_ONLY;class func VR_ONLY() -> SDLInteractionMode!Current Interaction Mode with value of VR_ONLY
+ +@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)
+ + + ++ (SDLInteractionMode *)BOTH;class func BOTH() -> SDLInteractionMode!Current Interaction Mode with value of BOTH
+ +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Enumeration listing possible keyboard events. + * + * @since SmartDeviceLink 3.0 + *
+ + +Undocumented
+ + + +@interface SDLKeyboardEvent : SDLEnumUndocumented
+ + + +@interface SDLKeyboardEvent : SDLEnumThe use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes). + *
+ + + ++ (SDLKeyboardEvent *)KEYPRESS;class func KEYPRESS() -> SDLKeyboardEvent!The User has finished entering text from the keyboard and submitted the entry. + *
+ + + ++ (SDLKeyboardEvent *)ENTRY_SUBMITTED;class func ENTRY_SUBMITTED() -> SDLKeyboardEvent!The User has pressed the HMI-defined Cancel
button.
+ *
+ (SDLKeyboardEvent *)ENTRY_CANCELLED;class func ENTRY_CANCELLED() -> SDLKeyboardEvent!The User has not finished entering text and the keyboard is aborted with the event of higher priority. + *
+ + + ++ (SDLKeyboardEvent *)ENTRY_ABORTED;class func ENTRY_ABORTED() -> SDLKeyboardEvent!@since SDL 4.0
+ + + ++ (SDLKeyboardEvent *)ENTRY_VOICE;class func ENTRY_VOICE() -> SDLKeyboardEvent!Enumeration listing possible keyboard layouts + * + *Since SmartDeviceLink 3.0 + *
+ + +Undocumented
+ + + +@interface SDLKeyboardLayout : SDLEnumUndocumented
+ + + +@interface SDLKeyboardLayout : SDLEnumQWERTY 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)
+ *
+ (SDLKeyboardLayout *)QWERTY;class func QWERTY() -> SDLKeyboardLayout!QWERTZ 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)
+ *
+ (SDLKeyboardLayout *)QWERTZ;class func QWERTZ() -> SDLKeyboardLayout!AZERTY 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)
+ *
+ (SDLKeyboardLayout *)AZERTY;class func AZERTY() -> SDLKeyboardLayout!Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +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
+ *
Undocumented
+ + + +@interface SDLKeypressMode : SDLEnumUndocumented
+ + + +@interface SDLKeypressMode : SDLEnumSINGLE_KEYPRESS:
Each and every User`s keypress must be reported (new notification for every newly entered single symbol).
+ *
+ (SDLKeypressMode *)SINGLE_KEYPRESS;class func SINGLE_KEYPRESS() -> SDLKeypressMode!QUEUE_KEYPRESSES:
The whole entry is reported only after the User submits it (by ‘Search’ button click displayed on touchscreen keyboard)
+ *
+ (SDLKeypressMode *)QUEUE_KEYPRESSES;class func QUEUE_KEYPRESSES() -> SDLKeypressMode!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).
+ *
+ (SDLKeypressMode *)RESEND_CURRENT_ENTRY;class func RESEND_CURRENT_ENTRY() -> SDLKeypressMode!Specifies the language to be used for TTS, VR, displayed messages/menus
+ +@since SDL 1.0
+ + +@abstract Get a Langusge according to a String
+ + + ++ (SDLLanguage *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLLanguage!The value of the string to get an object for
+The Language
+ +@abstract store all possible Language values
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array with all possible Language values inside
+ +Undocumented
+ + + +@interface SDLLanguage : SDLEnum@abstract Spanish - Mexico
+ + + ++ (SDLLanguage *)ES_MX;class func ES_MX() -> SDLLanguage!@abstract French - Canada
+ + + ++ (SDLLanguage *)FR_CA;class func FR_CA() -> SDLLanguage!@abstract German - Germany
+ + + ++ (SDLLanguage *)DE_DE;class func DE_DE() -> SDLLanguage!@abstract Spanish - Spain
+ + + ++ (SDLLanguage *)ES_ES;class func ES_ES() -> SDLLanguage!@abstract English - Great Britain
+ + + ++ (SDLLanguage *)EN_GB;class func EN_GB() -> SDLLanguage!@abstract Russian - Russia
+ + + ++ (SDLLanguage *)RU_RU;class func RU_RU() -> SDLLanguage!@abstract Turkish - Turkey
+ + + ++ (SDLLanguage *)TR_TR;class func TR_TR() -> SDLLanguage!@abstract Polish - Poland
+ + + ++ (SDLLanguage *)PL_PL;class func PL_PL() -> SDLLanguage!@abstract French - France
+ + + ++ (SDLLanguage *)FR_FR;class func FR_FR() -> SDLLanguage!@abstract Italian - Italy
+ + + ++ (SDLLanguage *)IT_IT;class func IT_IT() -> SDLLanguage!@abstract Swedish - Sweden
+ + + ++ (SDLLanguage *)SV_SE;class func SV_SE() -> SDLLanguage!@abstract Portuguese - Portugal
+ + + ++ (SDLLanguage *)PT_PT;class func PT_PT() -> SDLLanguage!@abstract Dutch (Standard) - Netherlands
+ + + ++ (SDLLanguage *)NL_NL;class func NL_NL() -> SDLLanguage!@abstract English - Australia
+ + + ++ (SDLLanguage *)EN_AU;class func EN_AU() -> SDLLanguage!@abstract Mandarin - China
+ + + ++ (SDLLanguage *)ZH_CN;class func ZH_CN() -> SDLLanguage!@abstract Mandarin - Taiwan
+ + + ++ (SDLLanguage *)ZH_TW;class func ZH_TW() -> SDLLanguage!@abstract Japanese - Japan
+ + + ++ (SDLLanguage *)JA_JP;class func JA_JP() -> SDLLanguage!@abstract Arabic - Saudi Arabia
+ + + ++ (SDLLanguage *)AR_SA;class func AR_SA() -> SDLLanguage!@abstract Korean - South Korea
+ + + ++ (SDLLanguage *)KO_KR;class func KO_KR() -> SDLLanguage!@abstract Portuguese - Brazil
+ + + ++ (SDLLanguage *)PT_BR;class func PT_BR() -> SDLLanguage!@abstract Czech - Czech Republic
+ + + ++ (SDLLanguage *)CS_CZ;class func CS_CZ() -> SDLLanguage!@abstract Danish - Denmark
+ + + ++ (SDLLanguage *)DA_DK;class func DA_DK() -> SDLLanguage!@abstract Norwegian - Norway
+ + + ++ (SDLLanguage *)NO_NO;class func NO_NO() -> SDLLanguage!For touchscreen interactions, the mode of how the choices are presented.
+ +@since SDL 3.0
+ + +Undocumented
+ + + +@interface SDLLayoutMode : SDLEnumUndocumented
+ + + +@interface SDLLayoutMode : SDLEnumThis mode causes the interaction to display the previous set of choices as icons.
+ + + ++ (SDLLayoutMode *)ICON_ONLY;class func ICON_ONLY() -> SDLLayoutMode!This mode causes the interaction to display the previous set of choices as icons along with a search field in the HMI.
+ + + ++ (SDLLayoutMode *)ICON_WITH_SEARCH;class func ICON_WITH_SEARCH() -> SDLLayoutMode!This mode causes the interaction to display the previous set of choices as a list.
+ + + ++ (SDLLayoutMode *)LIST_ONLY;class func LIST_ONLY() -> SDLLayoutMode!This mode causes the interaction to display the previous set of choices as a list along with a search field in the HMI.
+ + + ++ (SDLLayoutMode *)LIST_WITH_SEARCH;class func LIST_WITH_SEARCH() -> SDLLayoutMode!This mode causes the interaction to immediately display a keyboard entry through the HMI.
+ + + ++ (SDLLayoutMode *)KEYBOARD;class func KEYBOARD() -> SDLLayoutMode!Requests the current list of resident filenames for the registered app. Not + supported on First generation SDL vehicles +
+ +Since SmartDeviceLink 2.0
+ + +Constructs a new SDLListFiles object
+ + + +- (instancetype)init;init!()Constructs a new SDLListFiles object indicated by the dictionary parameter +
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+SDLListFilesResponse is sent, when SDLListFiles has been called
+ +Since SmartDeviceLink 2.0
+ + +Undocumented
+ + + +@interface SDLListFilesResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLListFilesResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLListFilesResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLListFilesResponse : SDLRPCResponseUndocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +LockScreen is Not Required
+ + + ++ (SDLLockScreenStatus *)OFF;class func OFF() -> SDLLockScreenStatus!LockScreen is Optional
+ + + ++ (SDLLockScreenStatus *)OPTIONAL;class func OPTIONAL() -> SDLLockScreenStatus!LockScreen is Not Required
+ + + ++ (SDLLockScreenStatus *)REQUIRED;class func REQUIRED() -> SDLLockScreenStatus!The SDLMaintenanceModeStatus class.
+ + +@abstract Maintenance Mode Status +- parameter: value The value of the string to get an object for +- returns: SDLMaintenanceModeStatus
+ + + ++ (SDLMaintenanceModeStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLMaintenanceModeStatus!The value of the string to get an object for
+SDLMaintenanceModeStatus
+ +@abstract declare an array that store all possible Maintenance Mode Status inside +- returns: the array
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!the array
+ +@abstract Maintenance Mode Status : Normal +- returns: the object with value of NORMAL
+ + + ++ (SDLMaintenanceModeStatus *)NORMAL;class func NORMAL() -> SDLMaintenanceModeStatus!the object with value of NORMAL
+ +@abstract Maintenance Mode Status : Near +- returns: the object with value of NEAR
+ + + ++ (SDLMaintenanceModeStatus *)NEAR;class func NEAR() -> SDLMaintenanceModeStatus!the object with value of NEAR
+ +@abstract Maintenance Mode Status : Active +- returns: the object with value of ACTIVE
+ + + ++ (SDLMaintenanceModeStatus *)ACTIVE;class func ACTIVE() -> SDLMaintenanceModeStatus!the object with value of ACTIVE
+ +@abstract Maintenance Mode Status : Feature not present +- returns: the object with value of FEATURE_NOT_PRESENT
+ + + ++ (SDLMaintenanceModeStatus *)FEATURE_NOT_PRESENT;class func FEATURE_NOT_PRESENT() -> SDLMaintenanceModeStatus!the object with value of FEATURE_NOT_PRESENT
+ +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
+ + +@abstract Media Clock Format
+ + + ++ (SDLMediaClockFormat *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLMediaClockFormat!The value of the string to get an object for
+SDLMediaClockFormat
+ +@abstract declare an array that store all possible Media clock formats inside
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!the array
+ +@abstract Media clock format: Clock1
+ +@discussion +
+ (SDLMediaClockFormat *)CLOCK1;class func CLOCK1() -> SDLMediaClockFormat!The SDLMediaClockFormat object with value CLOCK1
+ +@abstract Media clock format: Clock2
+ +@discussion +
+ (SDLMediaClockFormat *)CLOCK2;class func CLOCK2() -> SDLMediaClockFormat!The SDLMediaClockFormat object with value CLOCK2
+ +@abstract Media clock format: Clock3
+ +@discussion +
@since SDL 2.0 + - returns: The SDLMediaClockFormat object with value CLOCK3
+ + + ++ (SDLMediaClockFormat *)CLOCK3;class func CLOCK3() -> SDLMediaClockFormat!The SDLMediaClockFormat object with value CLOCK3
+ +@abstract Media clock format: ClockText1
+ +@discussion +
1or space
+ (SDLMediaClockFormat *)CLOCKTEXT1;class func CLOCKTEXT1() -> SDLMediaClockFormat!The SDLMediaClockFormat object with value CLOCKTEXT1
+ +@abstract Media clock format: ClockText2
+ +@discussion +
1or space
+ (SDLMediaClockFormat *)CLOCKTEXT2;class func CLOCKTEXT2() -> SDLMediaClockFormat!The SDLMediaClockFormat object with value CLOCKTEXT2
+ +@abstract Media clock format: ClockText3
+ +@discussion +
1or space
+ (SDLMediaClockFormat *)CLOCKTEXT3;class func CLOCKTEXT3() -> SDLMediaClockFormat!The SDLMediaClockFormat object with value CLOCKTEXT3
+ +@abstract Media clock format: ClockText4
+ +@discussion +
@since SDL 2.0 + - returns: The SDLMediaClockFormat object with value CLOCKTEXT4
+ + + ++ (SDLMediaClockFormat *)CLOCKTEXT4;class func CLOCKTEXT4() -> SDLMediaClockFormat!The SDLMediaClockFormat object with value CLOCKTEXT4
+ +Used when adding a sub menu to an application menu or existing sub menu.
+ +@since SDL 1.0
+ + +Constructs a newly allocated SDLMenuParams object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLMenuParams object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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
+ + + +@property (readwrite, strong, atomic) NSNumber *parentID;var parentID: NSNumber! { get set }@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.
Optional, Integer, 0 - 1000
+ + + +@property (readwrite, strong, atomic) NSNumber *position;var position: NSNumber! { get set }@abstract the menu name which appears in menu, representing this command
+ +Required, max length 500 characters
+ + + +@property (readwrite, strong, atomic) NSString *menuName;var menuName: String! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +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
+ + +Constructs a newly allocated SDLOnAppInterfaceUnregistered object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLOnAppInterfaceUnregistered object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The reason application’s interface was terminated
+ + + +@property (readwrite, strong, atomic) SDLAppInterfaceUnregisteredReason *reason;var reason: SDLAppInterfaceUnregisteredReason! { get set }Binary data is in binary part of hybrid msg.
+ +HMI Status Requirements: +
Constructs a newly allocated SDLOnAudioPassThru object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLOnAudioPassThru object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+Notifies application that user has depressed or released a button to which + the application has subscribed.
+ +Further information about button events + and button-presses can be found at SDLSubscribeButton. +
+
+ +HMI Status Requirements: +
See
+ SDLSubscribeButton + +@since SDL 1.0
+ + +Constructs a newly allocated SDLOnButtonEvent object
+ + + +- (instancetype)init;init!()@abstract Constructs a newly allocated SDLOnButtonEvent object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The name of the button
+ + + +@property (readwrite, strong, atomic) SDLButtonName *buttonName;var buttonName: SDLButtonName! { get set }@abstract Indicates whether this is an UP or DOWN event
+ + + +@property (readwrite, strong, atomic) SDLButtonEventMode *buttonEventMode;var buttonEventMode: SDLButtonEventMode! { get set }@abstract If ButtonName is CUSTOM_BUTTON
, this references the integer ID passed by a custom button. (e.g. softButton ID)
@since SDL 2.0
+ +Optional, Integer, 0 - 65536
+ + + +@property (readwrite, strong, atomic) NSNumber *customButtonID;var customButtonID: NSNumber! { get set }Notifies application of button press events for buttons to which the + application is subscribed. SDL supports two button press events defined as + follows:
+ +See
+ SDLSubscribeButton + +See
+ SDLUnsubscribeButton + +@since SDL 1.0
+ + +Constructs a newly allocated SDLOnButtonPress object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLOnButtonPress object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract the button’s name
+ +See
+ SDLButtonName + +Required
+ + + +@property (readwrite, strong, atomic) SDLButtonName *buttonName;var buttonName: SDLButtonName! { get set }@abstract Indicates whether this is a LONG or SHORT button press event
+ +See
+ SDLButtonPressMode + +Required
+ + + +@property (readwrite, strong, atomic) SDLButtonPressMode *buttonPressMode;var buttonPressMode: SDLButtonPressMode! { get set }@abstract If ButtonName is CUSTOM_BUTTON
, this references the integer ID passed by a custom button. (e.g. softButton ID)
@since SDL 2.0
+ +Optional, Integer 0 - 65536
+ + + +@property (readwrite, strong, atomic) NSNumber *customButtonID;var customButtonID: NSNumber! { get set }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
+ + +Constructs a newly allocated SDLRPCNotification object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLRPCNotification object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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.
+ + + +@property (readwrite, strong, atomic) NSNumber *cmdID;var cmdID: NSNumber! { get set }@abstract Indicates whether command was selected via voice or via a menu selection (using the OK button).
+ + + +@property (readwrite, strong, atomic) SDLTriggerSource *triggerSource;var triggerSource: SDLTriggerSource! { get set }Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or + not).
+ +HMI Status Requirements:
+ +@since SDL 1.0
+ + +Constructs a newly allocated SDLOnDriverDistraction object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLOnDriverDistraction object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The driver distraction state (i.e. whether driver distraction rules are in effect, or not)
+ + + +@property (readwrite, strong, atomic) SDLDriverDistractionState *state;var state: SDLDriverDistractionState! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +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
+ + +Constructs a newly allocated SDLOnHMIStatus object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLOnHMIStatus object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract SDLHMILevel in effect for the application
+ + + +@property (readwrite, strong, atomic) SDLHMILevel *hmiLevel;var hmiLevel: SDLHMILevel! { get set }@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).
+ + + +@property (readwrite, strong, atomic)
+ SDLAudioStreamingState *audioStreamingState;var audioStreamingState: SDLAudioStreamingState! { get set }@abstract the System Context +@discussion whether a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN)
+ + + +@property (readwrite, strong, atomic) SDLSystemContext *systemContext;var systemContext: SDLSystemContext! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Provides information to what language the SDL HMI language was changed
+ +@since SDL 2.0
+ + +Constructs a newly allocated SDLOnLanguageChange object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLOnLanguageChange object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract Current SDL voice engine (VR+TTS) language
+ + + +@property (readwrite, strong, atomic) SDLLanguage *language;var language: SDLLanguage! { get set }@abstract Current display language
+ + + +@property (readwrite, strong, atomic) SDLLanguage *hmiDisplayLanguage;var hmiDisplayLanguage: SDLLanguage! { get set }To help prevent driver distraction, any SmartDeviceLink application is required to implement a lockscreen that must be enforced while the application is active on the system while the vehicle is in motion.
+
+This lockscreen must perform the following:
+Limit all application control usability from the mobile device with a full-screen static image overlay or separate view.
+For simplicity, the OnLockScreenStatus RPC will be provided via the onOnLockScreenNotification call back. The call back will include the LockScreenStatus enum which indicates if the lockscreen is required, optional or not required.
+The call back also includes details regarding the current HMI_Status level, driver distraction status and user selection status of the application.
+Undocumented
+ + + +@interface SDLOnLockScreenStatus : SDLRPCNotificationUndocumented
+ + + +@interface SDLOnLockScreenStatus : SDLRPCNotificationGet the current driver distraction status(i.e. whether driver distraction rules are in effect, or not)
+ + + +@property (readwrite, strong, atomic) NSNumber *driverDistractionStatus;var driverDistractionStatus: NSNumber! { get set }String
+ +Get user selection status for the application (has the app been selected via hmi or voice command)
+ + + +@property (readwrite, strong, atomic) NSNumber *userSelected;var userSelected: NSNumber! { get set }Boolean the current user selection status
+ +Get the {@linkplain LockScreenStatus} enumeration, indicating if the lockscreen should be required, optional or off
+ + + +@property (readwrite, strong, atomic) SDLLockScreenStatus *lockScreenStatus;var lockScreenStatus: SDLLockScreenStatus! { get set }{@linkplain +LockScreenStatus}
+ +Get HMILevel in effect for the application
+ + + +@property (readwrite, strong, atomic) SDLHMILevel *hmiLevel;var hmiLevel: SDLHMILevel! { get set }{@linkplain +HMILevel} the current HMI Level in effect for the application
+ +Provides update to app of which sets of functions are available
+ +@since SDL 2.0
+ + +Constructs a newly allocated SDLOnPermissionsChange object
+ + + +- (instancetype)init;init!()Constructs a newly allocated SDLOnPermissionsChange object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract Describes change in permissions for a given set of RPCs
+ +Required, Array of SDLPermissionItem, Array size 0 - 500
+ +See
+ SDLPermissionItem + +@property (readwrite, strong, atomic) NSMutableArray *permissionItem;var permissionItem: NSMutableArray! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Request vehicle data.
+ +Since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLOnVehicleData object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLOnVehicleData object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract A SDLGPSData* value. See GPSData.
+ + + +@property (readwrite, strong, atomic) SDLGPSData *gps;var gps: SDLGPSData! { get set }@abstract The vehicle speed in kilometers per hour.
+ + + +@property (readwrite, strong, atomic) NSNumber *speed;var speed: NSNumber! { get set }@abstract The number of revolutions per minute of the engine.
+ + + +@property (readwrite, strong, atomic) NSNumber *rpm;var rpm: NSNumber! { get set }@abstract The fuel level in the tank (percentage)
+ + + +@property (readwrite, strong, atomic) NSNumber *fuelLevel;var fuelLevel: NSNumber! { get set }@abstract A SDLComponentVolumeStatus* value. The fuel level state.
+ + + +@property (readwrite, strong, atomic) SDLComponentVolumeStatus *fuelLevel_State;var fuelLevel_State: SDLComponentVolumeStatus! { get set }@abstract The instantaneous fuel consumption in microlitres.
+ + + +@property (readwrite, strong, atomic) NSNumber *instantFuelConsumption;var instantFuelConsumption: NSNumber! { get set }@abstract The external temperature in degrees celsius.
+ + + +@property (readwrite, strong, atomic) NSNumber *externalTemperature;var externalTemperature: NSNumber! { get set }@abstract The Vehicle Identification Number
+ + + +@property (readwrite, strong, atomic) NSString *vin;var vin: String! { get set }@abstract See PRNDL.
+ + + +@property (readwrite, strong, atomic) SDLPRNDL *prndl;var prndl: SDLPRNDL! { get set }@abstract A SDLTireStatus* value. See TireStatus.
+ + + +@property (readwrite, strong, atomic) SDLTireStatus *tirePressure;var tirePressure: SDLTireStatus! { get set }@abstract Odometer reading in km.
+ + + +@property (readwrite, strong, atomic) NSNumber *odometer;var odometer: NSNumber! { get set }@abstract A SDLBeltStatus* value. The status of the seat belts.
+ + + +@property (readwrite, strong, atomic) SDLBeltStatus *beltStatus;var beltStatus: SDLBeltStatus! { get set }@abstract A SDLBodyInformation* value. The body information including power modes.
+ + + +@property (readwrite, strong, atomic) SDLBodyInformation *bodyInformation;var bodyInformation: SDLBodyInformation! { get set }@abstract A SDLDeviceStatus* value. The device status including signal and battery strength.
+ + + +@property (readwrite, strong, atomic) SDLDeviceStatus *deviceStatus;var deviceStatus: SDLDeviceStatus! { get set }@abstract A SDLVehicleDataResult* value. The status of the brake pedal.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataEventStatus *driverBraking;var driverBraking: SDLVehicleDataEventStatus! { get set }@abstract A SDLWiperStatus* value. The status of the wipers.
+ + + +@property (readwrite, strong, atomic) SDLWiperStatus *wiperStatus;var wiperStatus: SDLWiperStatus! { get set }@abstract A SDLHeadLampStatus* value. Status of the head lamps.
+ + + +@property (readwrite, strong, atomic) SDLHeadLampStatus *headLampStatus;var headLampStatus: SDLHeadLampStatus! { get set }@abstract Torque value for engine (in Nm) on non-diesel variants.
+ + + +@property (readwrite, strong, atomic) NSNumber *engineTorque;var engineTorque: NSNumber! { get set }@abstract Accelerator pedal position (percentage depressed)
+ + + +@property (readwrite, strong, atomic) NSNumber *accPedalPosition;var accPedalPosition: NSNumber! { get set }@abstract Current angle of the steering wheel (in deg)
+ + + +@property (readwrite, strong, atomic) NSNumber *steeringWheelAngle;var steeringWheelAngle: NSNumber! { get set }Undocumented
+ + + +@interface SDLOnVehicleData : SDLRPCNotificationUndocumented
+ + + +@interface SDLOnVehicleData : SDLRPCNotificationUndocumented
+ + + +@interface SDLOnVehicleData : SDLRPCNotificationUndocumented
+ + + +@interface SDLOnVehicleData : SDLRPCNotificationUndocumented
+ + + +@interface SDLOnVehicleData : SDLRPCNotificationThe selected gear the car is in.
+ +@since SDL 2.0
+ + +@abstract get SDLPRNDL according value string
+ + + ++ (SDLPRNDL *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLPRNDL!The value of the string to get an object for
+SDLPRNDL object
+ +@abstract declare an array to store all possible SDLPRNDL values
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!the array
+ +@abstract Park
+ + + ++ (SDLPRNDL *)PARK;class func PARK() -> SDLPRNDL!SDLPRNDL: PARK
+ +@abstract Reverse gear
+ + + ++ (SDLPRNDL *)REVERSE;class func REVERSE() -> SDLPRNDL!SDLPRNDL: REVERSE
+ +@abstract No gear
+ + + ++ (SDLPRNDL *)NEUTRAL;class func NEUTRAL() -> SDLPRNDL!SDLPRNDL: NEUTRAL
+ +@abstract: Drive gear
+ + + ++ (SDLPRNDL *)DRIVE;class func DRIVE() -> SDLPRNDL!SDLPRNDL: DRIVE
+ +@abstract Drive Sport mode
+ + + ++ (SDLPRNDL *)SPORT;class func SPORT() -> SDLPRNDL!SDLPRNDL: SPORT
+ +@abstract 1st gear hold
+ + + ++ (SDLPRNDL *)LOWGEAR;class func LOWGEAR() -> SDLPRNDL!SDLPRNDL: LOWGEAR
+ +@abstract First gear
+ + + ++ (SDLPRNDL *)FIRST;class func FIRST() -> SDLPRNDL!SDLPRNDL: FIRST
+ +@abstract Second gear
+ + + ++ (SDLPRNDL *)SECOND;class func SECOND() -> SDLPRNDL!SDLPRNDL: SECOND
+ +@abstract Third gear
+ + + ++ (SDLPRNDL *)THIRD;class func THIRD() -> SDLPRNDL!SDLPRNDL: THIRD
+ +@abstract Fourth gear
+ + + ++ (SDLPRNDL *)FOURTH;class func FOURTH() -> SDLPRNDL!SDLPRNDL: FOURTH
+ +@abstract Fifth gear
+ + + ++ (SDLPRNDL *)FIFTH;class func FIFTH() -> SDLPRNDL!SDLPRNDL: FIFTH
+ +@abstract Sixth gear
+ + + ++ (SDLPRNDL *)SIXTH;class func SIXTH() -> SDLPRNDL!SDLPRNDL: SIXTH
+ +@abstract Seventh gear
+ + + ++ (SDLPRNDL *)SEVENTH;class func SEVENTH() -> SDLPRNDL!SDLPRNDL: SEVENTH
+ +@abstract Eighth gear
+ + + ++ (SDLPRNDL *)EIGHTH;class func EIGHTH() -> SDLPRNDL!SDLPRNDL: EIGHTH
+ +@abstract Unknown
+ + + ++ (SDLPRNDL *)UNKNOWN;class func UNKNOWN() -> SDLPRNDL!SDLPRNDL: UNKNOWN
+ +@abstract Fault
+ + + ++ (SDLPRNDL *)FAULT;class func FAULT() -> SDLPRNDL!SDLPRNDL: FAULT
+ +Defining sets of parameters, which are permitted or prohibited for a given RPC.
+ +@since SDL 2.0
+ + +@abstract Constructs a newly allocated SDLParameterPermissions object
+ + + +- (instancetype)init;init!()@abstract Constructs a newly allocated SDLParameterPermissions object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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
+ + + +@property (readwrite, strong, atomic) NSMutableArray *allowed;var allowed: NSMutableArray! { get set }@abstract A set of all parameters that are prohibited for this given RPC.
+ +Required, Array of String, max String length = 100, Array size 0 - 100
+ + + +@property (readwrite, strong, atomic) NSMutableArray *userDisallowed;var userDisallowed: NSMutableArray! { get set }This will open an audio pass thru session. By doing so the app can receive + audio data through the vehicle microphone +
+ Function Group: AudioPassThru +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 2.0
+ +See SDLEndAudioPassThru
+ + +@abstract Constructs a new SDLPerformAudioPassThru object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLPerformAudioPassThru object indicated by the NSMutableDictionary +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract initial prompt which will be spoken before opening the audio pass
+thru session by SDL
+@discussion initialPrompt
+ a Vector
+ Notes:
+
+
@property (readwrite, strong, atomic) NSMutableArray *initialPrompt;var initialPrompt: NSMutableArray! { get set }@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
+ + + +@property (readwrite, strong, atomic) NSString *audioPassThruDisplayText1;var audioPassThruDisplayText1: String! { get set }@abstract A line of text displayed during audio capture +@discussion audioPassThruDisplayText2 + a String value representing the line of text displayed during + audio capture +
+ Notes: Maxlength=500
+ + + +@property (readwrite, strong, atomic) NSString *audioPassThruDisplayText2;var audioPassThruDisplayText2: String! { get set }@abstract A samplingRate
+ +@discussion a SamplingRate value representing a 8 or 16 or 22 or 24 khz
+ + + +@property (readwrite, strong, atomic) SDLSamplingRate *samplingRate;var samplingRate: SDLSamplingRate! { get set }@abstract the maximum duration of audio recording in milliseconds
+ +@discussion maxDuration + an Integer value representing the maximum duration of audio + recording in millisecond +
+ Notes: Minvalue:1; Maxvalue:1000000
+ + + +@property (readwrite, strong, atomic) NSNumber *maxDuration;var maxDuration: NSNumber! { get set }@abstract the quality the audio is recorded - 8 bit or 16 bit
+ +@discussion a BitsPerSample value representing 8 bit or 16 bit
+ + + +@property (readwrite, strong, atomic) SDLBitsPerSample *bitsPerSample;var bitsPerSample: SDLBitsPerSample! { get set }@abstract an audioType
+ + + +@property (readwrite, strong, atomic) SDLAudioType *audioType;var audioType: SDLAudioType! { get set }@abstract a Boolean value representing if the current audio source should be
+muted during the APT session
@property (readwrite, strong, atomic) NSNumber *muteAudio;var muteAudio: NSNumber! { get set }Perform Audio Pass Thru Response is sent, when PerformAudioPassThru has been called
+ +Since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLPerformAudioPassThruResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLPerformAudioPassThruResponse object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+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 +
+ Function Group: Base +
+ HMILevel needs to be FULL +
+ +Since SmartDeviceLink 1.0
+ See SDLCreateInteractionChoiceSet SDLDeleteInteractionChoiceSet
@abstract Constructs a new SDLPerformInteraction object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLPerformInteraction object indicated by the NSMutableDictionary +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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
@property (readwrite, strong, atomic) NSString *initialText;var initialText: String! { get set }@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
+ + + +@property (readwrite, strong, atomic) NSMutableArray *initialPrompt;var initialPrompt: NSMutableArray! { get set }@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)
+ + + +@property (readwrite, strong, atomic) SDLInteractionMode *interactionMode;var interactionMode: SDLInteractionMode! { get set }@abstract A Vector
@property (readwrite, strong, atomic) NSMutableArray *interactionChoiceSetIDList;var interactionChoiceSetIDList: NSMutableArray! { get set }@abstract A Vectorhelp
during the VR session
@property (readwrite, strong, atomic) NSMutableArray *helpPrompt;var helpPrompt: NSMutableArray! { get set }@abstract An array of TTSChunks which, taken together, specify the phrase to +be spoken when the listen times out during the VR session
+ + + +@property (readwrite, strong, atomic) NSMutableArray *timeoutPrompt;var timeoutPrompt: NSMutableArray! { get set }@abstract An Integer value representing the amount of time, in milliseconds, +SDL will wait for the user to make a choice (VR or Menu)
+ + + +@property (readwrite, strong, atomic) NSNumber *timeout;var timeout: NSNumber! { get set }@abstract A Voice recognition Help, which is a suggested VR Help Items to +display on-screen during Perform Interaction +@since SmartDeviceLink 2.0
+ + + +@property (readwrite, strong, atomic) NSMutableArray *vrHelp;var vrHelp: NSMutableArray! { get set }Undocumented
+ + + +@interface SDLPerformInteraction : SDLRPCRequestPerformInteraction Response is sent, when SDLPerformInteraction has been called
+ +@since SDL 1.0
+ + +@abstract Constructs a new SDLPerformInteractionResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLPerformInteractionResponse object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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
+ + + +@property (readwrite, strong, atomic) NSNumber *choiceID;var choiceID: NSNumber! { get set }@abstract Manually entered text selection, e.g. through keyboard
+ +@discussion Can be returned in lieu of choiceID, depending on trigger source
+ +Optional, Max length 500 chars
+ + + +@property (readwrite, strong, atomic) NSString *manualTextEntry;var manualTextEntry: String! { get set }@abstract A SDLTriggerSource object which will be shown in the HMI
+ +@discussion Only is valid if resultCode is SUCCESS.
+ + + +@property (readwrite, strong, atomic) SDLTriggerSource *triggerSource;var triggerSource: SDLTriggerSource! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Enumeration that describes possible permission states of a policy table entry.
+ +@since SDL 2.0
+ + +@abstract SDLPermissionStatus
+ + + ++ (SDLPermissionStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLPermissionStatus!The value of the string to get an object for
+a SDLPermissionStatus object
+ +@abstract declare an array to store all possible SDLPermissionStatus values +- returns: the array
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!the array
+ +@abstract permission: allowed +- returns: permission status: ALLOWED
+ + + ++ (SDLPermissionStatus *)ALLOWED;class func ALLOWED() -> SDLPermissionStatus!permission status: ALLOWED
+ +@abstract permission: disallowed +- returns: permission status: DISALLOWED
+ + + ++ (SDLPermissionStatus *)DISALLOWED;class func DISALLOWED() -> SDLPermissionStatus!permission status: DISALLOWED
+ +@abstract permission: user disallowed +- returns: permission status: USER_DISALLOWED
+ + + ++ (SDLPermissionStatus *)USER_DISALLOWED;class func USER_DISALLOWED() -> SDLPermissionStatus!permission status: USER_DISALLOWED
+ +@abstract permission: user consent pending +- returns: permission status: USER_CONSENT_PENDING
+ + + ++ (SDLPermissionStatus *)USER_CONSENT_PENDING;class func USER_CONSENT_PENDING() -> SDLPermissionStatus!permission status: USER_CONSENT_PENDING
+ +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Contains information about on-screen preset capabilities.
+ +@since SDL 2.0
+ + +@abstract Constructs a newly allocated SDLPresetBankCapabilities object
+ + + +- (instancetype)init;init!()@abstract Constructs a newly allocated SDLPresetBankCapabilities object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract If Onscreen custom presets are available.
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *onScreenPresetsAvailable;var onScreenPresetsAvailable: NSNumber! { get set }Reflects the current primary audio source of SDL (if selected).
+ +@since SDL 2.0
+ + +@abstract get SDLPrimaryAudioSource according value string
+ + + ++ (SDLPrimaryAudioSource *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLPrimaryAudioSource!String value to retrieve the object enum for
+SDLPrimaryAudioSource object
+ +@abstract declare an array to store all possible SDLPrimaryAudioSource values +- returns: the array
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!the array
+ +@abstract Currently no source selected +- returns: the current primary audio source: NO_SOURCE_SELECTED
+ + + ++ (SDLPrimaryAudioSource *)NO_SOURCE_SELECTED;class func NO_SOURCE_SELECTED() -> SDLPrimaryAudioSource!the current primary audio source: NO_SOURCE_SELECTED
+ +@abstract USB is current source +- returns: the current primary audio source: USB
+ + + ++ (SDLPrimaryAudioSource *)USB;class func USB() -> SDLPrimaryAudioSource!the current primary audio source: USB
+ +@abstract USB2 is current source +- returns: the current primary audio source: USB2
+ + + ++ (SDLPrimaryAudioSource *)USB2;class func USB2() -> SDLPrimaryAudioSource!the current primary audio source: USB2
+ +@abstract Bluetooth Stereo is current source +- returns: the current primary audio source: BLUETOOTH_STEREO_BTST
+ + + ++ (SDLPrimaryAudioSource *)BLUETOOTH_STEREO_BTST;class func BLUETOOTH_STEREO_BTST() -> SDLPrimaryAudioSource!the current primary audio source: BLUETOOTH_STEREO_BTST
+ +@abstract Line in is current source +- returns: the current primary audio source: LINE_IN
+ + + ++ (SDLPrimaryAudioSource *)LINE_IN;class func LINE_IN() -> SDLPrimaryAudioSource!the current primary audio source: LINE_IN
+ +@abstract iPod is current source +- returns: the current primary audio source: IPOD
+ + + ++ (SDLPrimaryAudioSource *)IPOD;class func IPOD() -> SDLPrimaryAudioSource!the current primary audio source: IPOD
+ +@abstract Mobile app is current source +- returns: the current primary audio source: MOBILE_APP
+ + + ++ (SDLPrimaryAudioSource *)MOBILE_APP;class func MOBILE_APP() -> SDLPrimaryAudioSource!the current primary audio source: MOBILE_APP
+ +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +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.
+ + + +- (void)putFileStream:(NSInputStream *)inputStream
+ withRequest:(SDLPutFile *)putFileRPCRequest;func putFileStream(inputStream: NSInputStream!, withRequest putFileRPCRequest: SDLPutFile!)A stream containing the data to put to the module.
+A SDLPutFile object containing the parameters for the put(s)
+Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +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
+ + +Constructs a new SDLPutFile object
+ + + +- (instancetype)init;init!()Constructs a new SDLPutFile object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+A file reference name
+ +Required, maxlength 255 characters
+ + + +@property (readwrite, strong, atomic) NSString *syncFileName;var syncFileName: String! { get set }A FileType value representing a selected file type
+ +Required
+ + + +@property (readwrite, strong, atomic) SDLFileType *fileType;var fileType: SDLFileType! { get set }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
+ + + +@property (readwrite, strong, atomic) NSNumber *persistentFile;var persistentFile: NSNumber! { get set }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
+ + + +@property (readwrite, strong, atomic) NSNumber *systemFile;var systemFile: NSNumber! { get set }Offset in bytes for resuming partial data chunks.
+ +Integer, Optional, 0 - 100,000,000,000
+ + + +@property (readwrite, strong, atomic) NSNumber *offset;var offset: NSNumber! { get set }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
+ + + +@property (readwrite, strong, atomic) NSNumber *length;var length: NSNumber! { get set }Put File Response is sent, when SDLPutFile has been called
+ +Since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLPutFileResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLPutFileResponse object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+Undocumented
+ + + +@interface SDLPutFileResponse : SDLRPCResponseUndocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Non periodic vehicle data read request. This is an RPC to get diagnostics + data from certain vehicle modules. DIDs of a certain module might differ from + vehicle type to vehicle type +
+ Function Group: ProprietaryData +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLReadDID object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLReadDID object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract An ID of the vehicle module
+
Notes: Minvalue:0; Maxvalue:65535
@property (readwrite, strong, atomic) NSNumber *ecuName;var ecuName: NSNumber! { get set }@abstract Raw data from vehicle data DID location(s)
+
+ Notes:
+
a Vector
+
@property (readwrite, strong, atomic) NSMutableArray *didLocation;var didLocation: NSMutableArray! { get set }Read DID Response is sent, when ReadDID has been called
+ +Since SmartDeviceLink 2.0
+ + +Undocumented
+ + + +@interface SDLReadDIDResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLReadDIDResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLReadDIDResponse : SDLRPCResponseRegisters 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:
+
+ 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
+ +See
+ SDLUnregisterAppInterface SDLOnAppInterfaceUnregistered + +@abstract Constructs a new SDLRegisterAppInterface object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLRegisterAppInterface object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The version of the SDL interface
+ +Required
+ + + +@property (readwrite, strong, atomic) SDLSyncMsgVersion *syncMsgVersion;var syncMsgVersion: SDLSyncMsgVersion! { get set }@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 +
Required, Max length 100 chars
+ + + +@property (readwrite, strong, atomic) NSString *appName;var appName: String! { get set }@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. +
Optional, Array of SDLTTSChunk, Array size 1 - 100
+ +@since SDL 2.0 + - see: SDLTTSChunk
+ + + +@property (readwrite, strong, atomic) NSMutableArray *ttsName;var ttsName: NSMutableArray! { get set }@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)
+ +Optional, Max length 100 chars
+ + + +@property (readwrite, strong, atomic) NSString *ngnMediaScreenAppName;var ngnMediaScreenAppName: String! { get set }@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
+ + + +@property (readwrite, strong, atomic) NSMutableArray *vrSynonyms;var vrSynonyms: NSMutableArray! { get set }@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
+ + + +@property (readwrite, strong, atomic) NSNumber *isMediaApplication;var isMediaApplication: NSNumber! { get set }@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
+ + + +@property (readwrite, strong, atomic) SDLLanguage *languageDesired;var languageDesired: SDLLanguage! { get set }@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
+ + + +@property (readwrite, strong, atomic) SDLLanguage *hmiDisplayLanguageDesired;var hmiDisplayLanguageDesired: SDLLanguage! { get set }@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
+ + + +@property (readwrite, strong, atomic) NSMutableArray *appHMIType;var appHMIType: NSMutableArray! { get set }@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.).
+ +Optional, max length 100 chars
+ + + +@property (readwrite, strong, atomic) NSString *hashID;var hashID: String! { get set }@abstract Information about the connecting device
+ +Optional
+ + + +@property (readwrite, strong, atomic) SDLDeviceInfo *deviceInfo;var deviceInfo: SDLDeviceInfo! { get set }@abstract ID used to validate app with policy table entries
+ +Required, max length 100
+ +@since SDL 2.0
+ + + +@property (readwrite, strong, atomic) NSString *appID;var appID: String! { get set }@abstract Register AppInterface Response is sent, when SDLRegisterAppInterface has been called
+ +Since SmartDeviceLink 1.0
+ + +@abstract Constructs a new SDLRegisterAppInterfaceResponse object
+ + + +- (instancetype)init;init!()Constructs a new SDLRegisterAppInterfaceResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+See
+ SDLSyncMsgVersion + +Optional
+ + + +@property (readwrite, strong, atomic) SDLSyncMsgVersion *syncMsgVersion;var syncMsgVersion: SDLSyncMsgVersion! { get set }The currently active VR+TTS language on Sync.
+ +See
+ SDLLanguage + +Optional
+ + + +@property (readwrite, strong, atomic) SDLLanguage *language;var language: SDLLanguage! { get set }The currently active display language on Sync
+ +See
+ SDLLanguage +@since SmartDeviceLink 2.0 + +Optional
+ + + +@property (readwrite, strong, atomic) SDLLanguage *hmiDisplayLanguage;var hmiDisplayLanguage: SDLLanguage! { get set }See
+ SDLDisplayCapabilities + +Optional
+ + + +@property (readwrite, strong, atomic)
+ SDLDisplayCapabilities *displayCapabilities;var displayCapabilities: SDLDisplayCapabilities! { get set }See
+ SDLButtonCapabilities + +Optional, Array of length 1 - 100, of SDLButtonCapabilities
+ + + +@property (readwrite, strong, atomic) NSMutableArray *buttonCapabilities;var buttonCapabilities: NSMutableArray! { get set }If returned, the platform supports on-screen SoftButtons
+ +See
+ SDLSoftButtonCapabilities + +Optional, Array of length 1 - 100, of SDLSoftButtonCapabilities
+ + + +@property (readwrite, strong, atomic) NSMutableArray *softButtonCapabilities;var softButtonCapabilities: NSMutableArray! { get set }If returned, the platform supports custom on-screen Presets
+ +See
+ SDLPresetBankCapabilities + +Optional
+ + + +@property (readwrite, strong, atomic)
+ SDLPresetBankCapabilities *presetBankCapabilities;var presetBankCapabilities: SDLPresetBankCapabilities! { get set }See
+ SDLHMIZoneCapabilities + +Optional, Array of length 1 - 100, of SDLHMIZoneCapabilities
+ + + +@property (readwrite, strong, atomic) NSMutableArray *hmiZoneCapabilities;var hmiZoneCapabilities: NSMutableArray! { get set }See
+ SDLSpeechCapabilities + +Optional, Array of length 1 - 100, of SDLSpeechCapabilities
+ + + +@property (readwrite, strong, atomic) NSMutableArray *speechCapabilities;var speechCapabilities: NSMutableArray! { get set }See
+ SDLPrerecordedSpeech + +Optional, Array of length 1 - 100, of SDLPrerecordedSpeech
+ + + +@property (readwrite, strong, atomic) NSMutableArray *prerecordedSpeech;var prerecordedSpeech: NSMutableArray! { get set }See
+ SDLVRCapabilities + +Optional, Array of length 1 - 100, of SDLVRCapabilities
+ + + +@property (readwrite, strong, atomic) NSMutableArray *vrCapabilities;var vrCapabilities: NSMutableArray! { get set }See
+ SDLAudioPassThruCapabilities + +Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities
+ + + +@property (readwrite, strong, atomic) NSMutableArray *audioPassThruCapabilities;var audioPassThruCapabilities: NSMutableArray! { get set }Specifies the vehicle’s type
+ +See
+ SDLVehicleType + +Optional, Array of length 1 - 100, of SDLVehicleType
+ + + +@property (readwrite, strong, atomic) SDLVehicleType *vehicleType;var vehicleType: SDLVehicleType! { get set }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
+ + + +@property (readwrite, strong, atomic) NSMutableArray *supportedDiagModes;var supportedDiagModes: NSMutableArray! { get set }See
+ SDLHMICapabilities + +Optional
+ + + +@property (readwrite, strong, atomic) SDLHMICapabilities *hmiCapabilities;var hmiCapabilities: SDLHMICapabilities! { get set }The SmartDeviceLink version
+ +Optional, String max length 100
+ + + +@property (readwrite, strong, atomic) NSString *sdlVersion;var sdlVersion: String! { get set }The software version of the system that implements the SmartDeviceLink core
+ +Optional, String max length 100
+ + + +@property (readwrite, strong, atomic) NSString *systemSoftwareVersion;var systemSoftwareVersion: String! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Resets the passed global properties to their default values as defined by + SDL +
+ The HELPPROMPT global property default value is generated by SDL consists of
+ the first vrCommand of each Command Menu item defined at the moment PTT is
+ pressed
+ The TIMEOUTPROMPT global property default value is the same as the HELPPROMPT
+ global property default value
+
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 1.0 + See SetGlobalProperties
+ + +@abstract Constructs a new SDLResetGlobalProperties object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLResetGlobalProperties object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract An array of one or more GlobalProperty enumeration elements +indicating which global properties to reset to their default value
+ + + +@property (readwrite, strong, atomic) NSMutableArray *properties;var properties: NSMutableArray! { get set }Reset Global Properties Response is sent, when SDLResetGlobalProperties has been called
+ +Since SmartDeviceLink 1.0
+ + +@abstract Constructs a new SDLResetGlobalPropertiesResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLResetGlobalPropertiesResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+Defines the possible result codes returned by SDL to the application in a response to a requested operation
+ +@since SDL 1.0
+ + +@abstract get SDLResult according value string +- parameter: value The value of the string to get an object for +- returns: SDLResult object
+ + + ++ (SDLResult *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLResult!The value of the string to get an object for
+SDLResult object
+ +@abstract declare an array to store all possible SDLResult values +- returns: the array
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!the array
+ +@abstract The request succeeded
+ + + ++ (SDLResult *)SUCCESS;class func SUCCESS() -> SDLResult!@abstract Result code : Invalid Data
+ +@discussion The data sent is invalid. For example: +
+ (SDLResult *)INVALID_DATA;class func INVALID_DATA() -> SDLResult!Undocumented
+ + + +@interface SDLResult : SDLEnum@abstract The request is not supported by SDL
+ + + ++ (SDLResult *)UNSUPPORTED_REQUEST;class func UNSUPPORTED_REQUEST() -> SDLResult!@abstract The system could not process the request because the necessary memory couldn’t be allocated
+ + + ++ (SDLResult *)OUT_OF_MEMORY;class func OUT_OF_MEMORY() -> SDLResult!@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.
+ + + ++ (SDLResult *)TOO_MANY_PENDING_REQUESTS;class func TOO_MANY_PENDING_REQUESTS() -> SDLResult!@abstract One of the provided IDs is not valid. +@discussion For example: +
+ (SDLResult *)INVALID_ID;class func INVALID_ID() -> SDLResult!@abstract The provided name or synonym is a duplicate of some already-defined name or synonym.
+ + + ++ (SDLResult *)DUPLICATE_NAME;class func DUPLICATE_NAME() -> SDLResult!There are already too many registered applications.
+ + + ++ (SDLResult *)TOO_MANY_APPLICATIONS;class func TOO_MANY_APPLICATIONS() -> SDLResult!RegisterApplication has been called again, after a RegisterApplication was successful before.
+ + + ++ (SDLResult *)APPLICATION_REGISTERED_ALREADY;class func APPLICATION_REGISTERED_ALREADY() -> SDLResult!The Head Unit doesn’t support the protocol that is requested by the mobile application.
+ + + ++ (SDLResult *)UNSUPPORTED_VERSION;class func UNSUPPORTED_VERSION() -> SDLResult!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.
+ + + ++ (SDLResult *)WRONG_LANGUAGE;class func WRONG_LANGUAGE() -> SDLResult!A command can not be executed because no application has been registered with RegisterApplication.
+ + + ++ (SDLResult *)APPLICATION_NOT_REGISTERED;class func APPLICATION_NOT_REGISTERED() -> SDLResult!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.
+ + + ++ (SDLResult *)IN_USE;class func IN_USE() -> SDLResult!The user has turned off access to vehicle data, and it is globally unavailable to mobile applications.
+ + + ++ (SDLResult *)VEHICLE_DATA_NOT_ALLOWED;class func VEHICLE_DATA_NOT_ALLOWED() -> SDLResult!The requested vehicle data is not available on this vehicle or is not published.
+ + + ++ (SDLResult *)VEHICLE_DATA_NOT_AVAILABLE;class func VEHICLE_DATA_NOT_AVAILABLE() -> SDLResult!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.
+ + + ++ (SDLResult *)REJECTED;class func REJECTED() -> SDLResult!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.
+ + + ++ (SDLResult *)ABORTED;class func ABORTED() -> SDLResult!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.
+ + + ++ (SDLResult *)IGNORED;class func IGNORED() -> SDLResult!A button that was requested for subscription is not supported under the current system.
+ + + ++ (SDLResult *)UNSUPPORTED_RESOURCE;class func UNSUPPORTED_RESOURCE() -> SDLResult!A specified file could not be found on the head unit.
+ + + ++ (SDLResult *)FILE_NOT_FOUND;class func FILE_NOT_FOUND() -> SDLResult!Provided data is valid but something went wrong in the lower layers.
+ + + ++ (SDLResult *)GENERIC_ERROR;class func GENERIC_ERROR() -> SDLResult!RPC is not authorized in local policy table.
+ + + ++ (SDLResult *)DISALLOWED;class func DISALLOWED() -> SDLResult!RPC is included in a functional group explicitly blocked by the user.
+ + + ++ (SDLResult *)USER_DISALLOWED;class func USER_DISALLOWED() -> SDLResult!Overlay reached the maximum timeout and closed.
+ + + ++ (SDLResult *)TIMED_OUT;class func TIMED_OUT() -> SDLResult!User selected to Cancel Route.
+ + + ++ (SDLResult *)CANCEL_ROUTE;class func CANCEL_ROUTE() -> SDLResult!The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available.
+ + + ++ (SDLResult *)TRUNCATED_DATA;class func TRUNCATED_DATA() -> SDLResult!The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC.
+ + + ++ (SDLResult *)RETRY;class func RETRY() -> SDLResult!The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure.
+ + + ++ (SDLResult *)WARNINGS;class func WARNINGS() -> SDLResult!The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value.
+ + + ++ (SDLResult *)SAVED;class func SAVED() -> SDLResult!The certificate provided during authentication is invalid.
+ + + ++ (SDLResult *)INVALID_CERT;class func INVALID_CERT() -> SDLResult!The certificate provided during authentication is expired.
+ + + ++ (SDLResult *)EXPIRED_CERT;class func EXPIRED_CERT() -> SDLResult!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.
+ + + ++ (SDLResult *)RESUME_FAILED;class func RESUME_FAILED() -> SDLResult!Describes different sampling rates for PerformAudioPassThru
+ +@since SDL 2.0
+ + +@abstract get SDLSamplingRate according value string
+ + + ++ (SDLSamplingRate *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLSamplingRate!The value of the string to get an object for
+SDLSamplingRate object
+ +@abstract declare an array to store all possible SDLSamplingRate values
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!the array
+ +@abstract Sampling rate of 8 kHz
+ + + ++ (SDLSamplingRate *)_8KHZ;class func _8KHZ() -> SDLSamplingRate!SamplingRate of 8KHZ
+ +@abstract Sampling rate of 16 kHz
+ + + ++ (SDLSamplingRate *)_16KHZ;class func _16KHZ() -> SDLSamplingRate!SamplingRate of 16KHZ
+ +@abstract Sampling rate of 22 kHz
+ + + ++ (SDLSamplingRate *)_22KHZ;class func _22KHZ() -> SDLSamplingRate!SamplingRate of 22KHZ
+ +@abstract Sampling rate of 44 kHz
+ + + ++ (SDLSamplingRate *)_44KHZ;class func _44KHZ() -> SDLSamplingRate!SamplingRate of 44KHZ
+ +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +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 +
+HMILevel needs to be FULL +
+ + +@abstract Constructs a new SDLScrollableMessage object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLScrollableMessage object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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 +
+ Notes: Maxlength=500
+ + + +@property (readwrite, strong, atomic) NSString *scrollableMessageBody;var scrollableMessageBody: String! { get set }@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
+ + + +@property (readwrite, strong, atomic) NSNumber *timeout;var timeout: NSNumber! { get set }@abstract Gets/Sets App defined SoftButtons.If omitted on supported displays, only the
+system defined
+ Notes: Minsize=0, Maxsize=8Close
SoftButton will be displayed
+@discussion A VectorObjective-C
+
+
+
+ @property (readwrite, strong, atomic) NSMutableArray *softButtons;Swift
+
+
+
+
+
+var softButtons: NSMutableArray! { get set }
Scrollable Message Response is sent, when SDLScrollableMessage has been called
+ +Since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLScrollableMessageResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLScrollableMessageResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +The longitudinal coordinate of the location.
+ +Float, Required, -180.0 - 180.0
+ + + +@property (readwrite, copy, nonatomic) NSNumber *longitudeDegrees;@NSCopying var longitudeDegrees: NSNumber! { get set }The latitudinal coordinate of the location.
+ +Float, Required, -90.0 - 90.0
+ + + +@property (readwrite, copy, nonatomic) NSNumber *latitudeDegrees;@NSCopying var latitudeDegrees: NSNumber! { get set }Name / title of intended location
+ +Optional, Maxlength = 500 char
+ + + +@property (readwrite, copy, nonatomic) NSString *locationName;var locationName: String! { get set }Description of the intended location / establishment
+ +Optional, MaxLength = 500 char
+ + + +@property (readwrite, copy, nonatomic) NSString *locationDescription;var locationDescription: String! { get set }Array of lines for the location address
+ +Contains String, Optional, Max Array Length = 4, Max String Length = 500
+ + + +@property (readwrite, copy, nonatomic) NSArray *addressLines;var addressLines: [AnyObject]! { get set }Phone number of intended location / establishment
+ +Optional, Max Length = 500
+ + + +@property (readwrite, copy, nonatomic) NSString *phoneNumber;var phoneNumber: String! { get set }Image / icon of intended location
+ +Optional
+ + + +@property (readwrite, strong, nonatomic) SDLImage *locationImage;var locationImage: SDLImage! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Used to set existing local file on SDL as the app’s icon. Not supported on + first generation SDL modules. +
+ +Since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLSetAppIcon object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSetAppIcon object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract A file reference name +@discussion A String value representing a file reference name +
+ Notes: Maxlength=500
+ + + +@property (readwrite, strong, atomic) NSString *syncFileName;var syncFileName: String! { get set }SDLSetAppIconResponse is sent, when SDLSetAppIcon has been called. + * SinceSmartDeviceLink 2.0
+ + +Undocumented
+ + + +@interface SDLSetAppIconResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLSetAppIconResponse : SDLRPCResponseUsed to set an alternate display layout. If not sent, default screen for + given platform will be shown
+ +Since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLSetDisplayLayout object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSetDisplayLayout object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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
@property (readwrite, strong, atomic) NSString *displayLayout;var displayLayout: String! { get set }Set Display Layout Response is sent, when SetDisplayLayout has been called
+ +Since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLSetDisplayLayoutResponse object
+ + + +- (instancetype)init;init!()Undocumented
+ + + +@interface SDLSetDisplayLayoutResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLSetDisplayLayoutResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLSetDisplayLayoutResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLSetDisplayLayoutResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLSetDisplayLayoutResponse : SDLRPCResponseSets value(s) for the specified global property(ies) +
+ Function Group: Base
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 1.0 + See SDLResetGlobalProperties
+ + +@abstract Constructs a new SDLSetGlobalProperties object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSetGlobalProperties object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract Sets a Vector
+ Notes:
+
+
@property (readwrite, strong, atomic) NSMutableArray *helpPrompt;var helpPrompt: NSMutableArray! { get set }@abstract A Vector
@property (readwrite, strong, atomic) NSMutableArray *timeoutPrompt;var timeoutPrompt: NSMutableArray! { get set }@abstract Sets a voice recognition Help Title
+ +@discussion A String value representing a voice recognition Help Title +
+ Notes:
+
@property (readwrite, strong, atomic) NSString *vrHelpTitle;var vrHelpTitle: String! { get set }@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:
+
@property (readwrite, strong, atomic) NSMutableArray *vrHelp;var vrHelp: NSMutableArray! { get set }Undocumented
+ + + +@interface SDLSetGlobalProperties : SDLRPCRequestUndocumented
+ + + +@interface SDLSetGlobalProperties : SDLRPCRequestUndocumented
+ + + +@interface SDLSetGlobalProperties : SDLRPCRequestSet Global Properties Response is sent, when SDLSetGlobalProperties has been called
+ +Since SmartDeviceLink 1.0
+ + +@abstract Constructs a new SDLSetGlobalPropertiesResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSetGlobalPropertiesResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+Sets the media clock/timer value and the update method (e.g.count-up, + count-down, etc.) +
+ Function Group: Base
+ HMILevel needs to be FULL, LIMITIED or BACKGROUND +
+ +Since SmartDeviceLink 1.0
+ + +@abstract Constructs a new SDLSetMediaClockTimer object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSetMediaClockTimer object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract A Start Time with specifying hour, minute, second values
+ +@discussion A startTime object with specifying hour, minute, second values +
+ Notes: +
updateModeis COUNTUP or COUNTDOWN, this parameter + must be provided
@property (readwrite, strong, atomic) SDLStartTime *startTime;var startTime: SDLStartTime! { get set }@abstract An END time of type SDLStartTime, specifying hour, minute, second values
+ +@discussion An SDLStartTime object with specifying hour, minute, second values
+ + + +@property (readwrite, strong, atomic) SDLStartTime *endTime;var endTime: SDLStartTime! { get set }@abstract The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)
+ +@discussion a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME) +
+ Notes: +
@property (readwrite, strong, atomic) SDLUpdateMode *updateMode;var updateMode: SDLUpdateMode! { get set }Set Media Clock Timer Response is sent, when SDLSetMediaClockTimer has been called
+ +Since SmartDeviceLink 1.0
+ + +@abstract Constructs a new SDLSetMediaClockTimerResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSetMediaClockTimerResponse object indicated by the NSMutableDictionary + parameter +
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+Updates the application’s display text area, regardless of whether or not + this text area is visible to the user at the time of the request. The + application’s display text area remains unchanged until updated by subsequent + calls to Show +
+ The content of the application’s display text area is visible to the user + when the application + is FULL or LIMITED, and the + SDLSystemContext=MAIN and no + SDLAlert is in progress +
+ The Show operation cannot be used to create an animated scrolling screen. To + avoid distracting the driver, Show commands cannot be issued more than once + every 4 seconds. Requests made more frequently than this will be rejected +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 1.0 + See SDLAlert SDLSetMediaClockTimer
+ + +@abstract Constructs a new SDLShow object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLShow object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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: +
@property (readwrite, strong, atomic) NSString *mainField1;var mainField1: String! { get set }@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: +
@property (readwrite, strong, atomic) NSString *mainField2;var mainField2: String! { get set }@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 +
+ Notes: +
@property (readwrite, strong, atomic) NSString *mainField3;var mainField3: String! { get set }@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: +
@property (readwrite, strong, atomic) NSString *mainField4;var mainField4: String! { get set }@abstract The alignment that Specifies how mainField1 and mainField2 text + should be aligned on display
+ +@discussion An Enumeration value +
+ Notes: +
@property (readwrite, strong, atomic) SDLTextAlignment *alignment;var alignment: SDLTextAlignment! { get set }@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
+
@property (readwrite, strong, atomic) NSString *statusBar;var statusBar: String! { get set }@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:
+
@property (readwrite, strong, atomic) NSString *mediaClock;var mediaClock: String! { get set }@abstract The text in the track field
+ +@discussion A String value disaplayed in the track field +
+ Notes:
+
@property (readwrite, strong, atomic) NSString *mediaTrack;var mediaTrack: String! { get set }@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
+ @since SmartDeviceLink 2.0
@property (readwrite, strong, atomic) SDLImage *graphic;var graphic: SDLImage! { get set }@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
+ @since SmartDeviceLink 2.0
@property (readwrite, strong, atomic) SDLImage *secondaryGraphic;var secondaryGraphic: SDLImage! { get set }@abstract The the Soft buttons defined by the App
+ +@discussion A Vector value represemting the Soft buttons defined by the + App +
+ Notes:
+
@since SmartDeviceLink 2.0
+ + + +@property (readwrite, strong, atomic) NSMutableArray *softButtons;var softButtons: NSMutableArray! { get set }@abstract The Custom Presets defined by the App
+ +@discussion A Vector value representing the Custom Presets defined by the + App +
+
@property (readwrite, strong, atomic) NSMutableArray *customPresets;var customPresets: NSMutableArray! { get set }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
+ + +Undocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestUndocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestUndocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestUndocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestUndocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestUndocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestUndocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestUndocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestUndocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestUndocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestUndocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestUndocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestUndocumented
+ + + +@interface SDLShowConstantTBT : SDLRPCRequestSDLShowConstantTBTResponse is sent, when SDLShowConstantTBT has been called. + * SinceSmartDeviceLink 2.0
+ + +Undocumented
+ + + +@interface SDLShowConstantTBTResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLShowConstantTBTResponse : SDLRPCResponseShow Response is sent, when Show has been called
+ +Since SmartDeviceLink 1.0
+ + +@abstract Constructs a new SDLShowResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLShowResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+Tire pressure status of a single tire.
+ +@since SmartDeviceLink 2.0
+ + +@abstract Constructs a newly allocated SDLSingleTireStatus object
+ + + +- (instancetype)init;init!()@abstract Constructs a newly allocated SDLSingleTireStatus object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The volume status of a single tire
+ + + +@property (readwrite, strong, atomic) SDLComponentVolumeStatus *status;var status: SDLComponentVolumeStatus! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider
+ +HMILevel needs to be FULL
+ +Since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLSlider object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSlider object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract Represents a number of selectable items on a horizontal axis
+ +Required, Integer, 2 - 26
+ + + +@property (readwrite, strong, atomic) NSNumber *numTicks;var numTicks: NSNumber! { get set }@abstract An Initial position of slider control
+ +Required, Integer, 1 - 26
+ + + +@property (readwrite, strong, atomic) NSNumber *position;var position: NSNumber! { get set }@abstract A text header to display
+ +Rquired, Max length 500 chars
+ + + +@property (readwrite, strong, atomic) NSString *sliderHeader;var sliderHeader: String! { get set }@abstract A text footer to display
+ +@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
+ + + +@property (readwrite, strong, atomic) NSMutableArray *sliderFooter;var sliderFooter: NSMutableArray! { get set }@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.
+ +Optional, Integer, 1000 - 65535
+ + + +@property (readwrite, strong, atomic) NSNumber *timeout;var timeout: NSNumber! { get set }Slider Response is sent, when Slider has been called
+ +Since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLSliderResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSliderResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The selected position of the slider.
+ + + +@property (readwrite, strong, atomic) NSNumber *sliderPosition;var sliderPosition: NSNumber! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Contains information about a SoftButton’s capabilities.
+ +@since SDL 2.0
+ + +@abstract Constructs a newly allocated SDLSoftButtonCapabilities object
+ + + +- (instancetype)init;init!()@abstract Constructs a newly allocated SDLSoftButtonCapabilities object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The button supports a short press.
+ +@discussion Whenever the button is pressed short, onButtonPressed(SHORT) will be invoked.
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *shortPressAvailable;var shortPressAvailable: NSNumber! { get set }@abstract The button supports a LONG press.
+ +@discussion Whenever the button is pressed long, onButtonPressed(LONG) will be invoked.
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *longPressAvailable;var longPressAvailable: NSNumber! { get set }@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
+ + + +@property (readwrite, strong, atomic) NSNumber *upDownAvailable;var upDownAvailable: NSNumber! { get set }@abstract The button supports referencing a static or dynamic image.
+ +Required, Boolean
+ + + +@property (readwrite, strong, atomic) NSNumber *imageSupported;var imageSupported: NSNumber! { get set }SoftButtonType (TEXT / IMAGE / BOTH)
+ + +@abstract get SDLSoftButtonType according value string +- parameter: value NSString +- returns: SDLSoftButtonType object
+ + + ++ (SDLSoftButtonType *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLSoftButtonType!NSString
+SDLSoftButtonType object
+ +@abstract declare an array to store all possible SDLSoftButtonType values +- returns: the array
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!the array
+ +@abstract Text kind Softbutton +- returns: SDLSoftButtonType object with string value TEXT
+ + + ++ (SDLSoftButtonType *)TEXT;class func TEXT() -> SDLSoftButtonType!SDLSoftButtonType object with string value TEXT
+ +@abstract Image kind Softbutton +- returns: SDLSoftButtonType object with string value IMAGE
+ + + ++ (SDLSoftButtonType *)IMAGE;class func IMAGE() -> SDLSoftButtonType!SDLSoftButtonType object with string value IMAGE
+ +@abstract Both (Text & Image) kind Softbutton +- returns: SDLSoftButtonType object with string value BOTH
+ + + ++ (SDLSoftButtonType *)BOTH;class func BOTH() -> SDLSoftButtonType!SDLSoftButtonType object with string value BOTH
+ +Speaks a phrase over the vehicle audio system using SDL’s TTS (text-to-speech) engine. The provided text to be spoken can be simply a text phrase, or it can consist of phoneme specifications to direct SDL’s TTS engine to speak a speech-sculpted
phrase.
Receipt of the Response indicates the completion of the Speak operation, regardless of how the Speak operation may have completed (i.e. successfully, interrupted, terminated, etc.).
+ +Requesting a new Speak operation while the application has another Speak operation already in progress (i.e. no corresponding Response for that in-progress Speak operation has been received yet) will terminate the in-progress Speak operation (causing its corresponding Response to be sent by SDL) and begin the requested Speak operation
+ +Requesting a new Speak operation while the application has an SDLAlert operation already in progress (i.e. no corresponding Response for that in-progress SDLAlert operation has been received yet) will result in the Speak operation request being rejected (indicated in the Response to the Request)
+ +Requesting a new SDLAlert operation while the application has a Speak operation already in progress (i.e. no corresponding Response for that in-progress Speak operation has been received yet) will terminate the in-progress Speak operation (causing its corresponding Response to be sent by SDL) and begin the requested SDLAlert operation
+ +Requesting a new Speak operation while the application has a SDLPerformInteraction operation already in progress (i.e. no corresponding Response for that in-progress SDLPerformInteraction operation has been received yet) will result in the Speak operation request being rejected (indicated in the Response to the Request)
+ +Requesting a SDLPerformInteraction operation while the application has a Speak operation already in progress (i.e. no corresponding Response for that in-progress Speak operation has been received yet) will terminate the in-progress Speak operation (causing its corresponding Response to be sent by SDL) and begin the requested SDLPerformInteraction operation
+ +HMI Status Requirements: +
Notes: +
playedwhen MENU interaction is completed (i.e. SystemContext reverts to MAIN). When SDLAlert + is issued with VR in effect, SDLAlert is queued and
playedwhen VR interaction is completed (i.e. SystemContext reverts to MAIN)
playedback in the order in which they were queued, with all existing rules for
collisionsstill in effect
Additional Notes: +
@since SmartDeviceLink 1.0 + - see: SDLAlert
+ + +@abstract Constructs a new SDLSpeak object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSpeak object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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
+ SDLTTSChunk + +@property (readwrite, strong, atomic) NSMutableArray *ttsChunks;var ttsChunks: NSMutableArray! { get set }Speak Response is sent, when Speak has been called
+ +Since SmartDeviceLink 1.0
+ + +@abstract Constructs a new SDLSpeakResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSpeakResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+Undocumented
+ + +@abstract get SDLSpeechCapabilities according value string
+ + + ++ (SDLSpeechCapabilities *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLSpeechCapabilities!The value of the string to get an object for
+SDLSpeechCapabilities object
+ +@abstract declare an array to store all possible SDLSpeechCapabilities values
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!the array of all possible values
+ +@abstract The SDL platform can speak text phrases.
+ + + ++ (SDLSpeechCapabilities *)TEXT;class func TEXT() -> SDLSpeechCapabilities!SDLSpeechCapabilities of value: TEXT
+ +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Describes the hour, minute and second values used to set the media clock.
+ +@since SDL 1.0
+ + +@abstract Constructs a newly allocated SDLStartTime object
+ + + +- (instancetype)init;init!()@abstract Constructs a newly allocated SDLStartTime object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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.
+ +Required, Integer, 0 - 59
+ + + +@property (readwrite, strong, atomic) NSNumber *hours;var hours: NSNumber! { get set }@abstract The minute of the media clock
+ +Required, Integer, 0 - 59
+ + + +@property (readwrite, strong, atomic) NSNumber *minutes;var minutes: NSNumber! { get set }@abstract The second of the media clock
+ +Required, Integer, 0 - 59
+ + + +@property (readwrite, strong, atomic) NSNumber *seconds;var seconds: NSNumber! { get set }Undocumented
+ + +Undocumented
+ + + + + + +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.
+ +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).
+ +- (void)startVideoSessionWithStartBlock:
+ (nonnull SDLStreamingStartBlock)startBlock;func startVideoSessionWithStartBlock(startBlock: SDLStreamingStartBlock)A block that will be called with the result of attempting to start a video session
+This method will stop a running video session if there is one running.
+ + + +- (void)stopVideoSession;func stopVideoSession()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.
+ + + +- (BOOL)sendVideoData:(nonnull CVImageBufferRef)imageBuffer;func sendVideoData(imageBuffer: CVImageBuffer) -> BoolA CVImageBufferRef to be encoded by Video Toolbox
+Whether or not the data was successfully encoded and sent.
+ +This method will attempt to start an audio session
+ + + +- (void)startAudioStreamingWithStartBlock:
+ (nonnull SDLStreamingStartBlock)startBlock;func startAudioStreamingWithStartBlock(startBlock: SDLStreamingStartBlock)A block that will be called with the result of attempting to start an audio session
+This method will stop a running audio session if there is one running.
+ + + +- (void)stopAudioSession;func stopAudioSession()This method receives PCM audio data and will attempt to send that data across to the head unit for immediate playback
+ + + +- (BOOL)sendAudioData:(nonnull NSData *)pcmAudioData;func sendAudioData(pcmAudioData: NSData) -> BoolThe data in PCM audio format, to be played
+Whether or not the data was successfully sent.
+ +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Establishes a subscription to button notifications for HMI buttons. Buttons
+ are not necessarily physical buttons, but can also be soft
buttons on a
+ touch screen, depending on the display in the vehicle. Once subscribed to a
+ particular button, an application will receive both
+ SDLOnButtonEvent and SDLOnButtonPress notifications
+ whenever that button is pressed. The application may also unsubscribe from
+ notifications for a button by invoking the SDLUnsubscribeButton
+ operation
+
+ When a button is depressed, an SDLOnButtonEvent notification is + sent to the application with a ButtonEventMode of BUTTONDOWN. When that same + button is released, an SDLOnButtonEvent notification is sent to the + application with a ButtonEventMode of BUTTONUP +
+ When the duration of a button depression (that is, time between depression + and release) is less than two seconds, an SDLOnButtonPress + notification is sent to the application (at the moment the button is + released) with a ButtonPressMode of SHORT. When the duration is two or more + seconds, an SDLOnButtonPress notification is sent to the + application (at the moment the two seconds have elapsed) with a + ButtonPressMode of LONG +
+ The purpose of SDLOnButtonPress notifications is to allow for + programmatic detection of long button presses similar to those used to store + presets while listening to the radio, for example +
+ When a button is depressed and released, the sequence in which notifications + will be sent to the application is as follows: +
+ For short presses:
+
+ For long presses:
+
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 1.0
+ See SDLUnsubscribeButton
@abstract Constructs a new SDLSubscribeButton object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSubscribeButton object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The name of the button to subscribe to +@discussion An enum value, see SDLButtonName
+ + + +@property (readwrite, strong, atomic) SDLButtonName *buttonName;var buttonName: SDLButtonName! { get set }SubscribeButton Response is sent, when SDLSubscribeButton has been called
+ +Since SmartDeviceLink 1.0
+ + +@abstract Constructs a new SDLSubscribeButtonResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSubscribeButtonResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+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 +
+ Function Group: Location, VehicleInfo and DrivingChara +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +Since SmartDeviceLink 2.0
+ See SDLUnsubscribeVehicleData SDLGetVehicleData
@abstract Constructs a new SDLSubscribeVehicleData object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSubscribeVehicleData object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract A boolean value. If true, subscribes Gps data
+ + + +@property (readwrite, strong, atomic) NSNumber *gps;var gps: NSNumber! { get set }@abstract A boolean value. If true, subscribes speed data
+ + + +@property (readwrite, strong, atomic) NSNumber *speed;var speed: NSNumber! { get set }@abstract A boolean value. If true, subscribes rpm data
+ + + +@property (readwrite, strong, atomic) NSNumber *rpm;var rpm: NSNumber! { get set }@abstract A boolean value. If true, subscribes FuelLevel data
+ + + +@property (readwrite, strong, atomic) NSNumber *fuelLevel;var fuelLevel: NSNumber! { get set }@abstract A boolean value. If true, subscribes fuelLevel_State data
+ + + +@property (readwrite, strong, atomic) NSNumber *fuelLevel_State;var fuelLevel_State: NSNumber! { get set }@abstract A boolean value. If true, subscribes instantFuelConsumption data
+ + + +@property (readwrite, strong, atomic) NSNumber *instantFuelConsumption;var instantFuelConsumption: NSNumber! { get set }@abstract A boolean value. If true, subscribes externalTemperature data
+ + + +@property (readwrite, strong, atomic) NSNumber *externalTemperature;var externalTemperature: NSNumber! { get set }@abstract A boolean value. If true, subscribes Currently selected gear data
+ + + +@property (readwrite, strong, atomic) NSNumber *prndl;var prndl: NSNumber! { get set }@abstract A boolean value. If true, subscribes tire pressure status data
+ + + +@property (readwrite, strong, atomic) NSNumber *tirePressure;var tirePressure: NSNumber! { get set }@abstract A boolean value. If true, subscribes odometer data
+ + + +@property (readwrite, strong, atomic) NSNumber *odometer;var odometer: NSNumber! { get set }@abstract A boolean value. If true, subscribes belt Status data
+ + + +@property (readwrite, strong, atomic) NSNumber *beltStatus;var beltStatus: NSNumber! { get set }@abstract A boolean value. If true, subscribes body Information data
+ + + +@property (readwrite, strong, atomic) NSNumber *bodyInformation;var bodyInformation: NSNumber! { get set }@abstract A boolean value. If true, subscribes device Status data
+ + + +@property (readwrite, strong, atomic) NSNumber *deviceStatus;var deviceStatus: NSNumber! { get set }@abstract A boolean value. If true, subscribes driver Braking data
+ + + +@property (readwrite, strong, atomic) NSNumber *driverBraking;var driverBraking: NSNumber! { get set }@abstract A boolean value. If true, subscribes wiper Status data
+ + + +@property (readwrite, strong, atomic) NSNumber *wiperStatus;var wiperStatus: NSNumber! { get set }@abstract A boolean value. If true, subscribes Head Lamp Status data
+ + + +@property (readwrite, strong, atomic) NSNumber *headLampStatus;var headLampStatus: NSNumber! { get set }@abstract A boolean value. If true, subscribes Engine Torque data
+ + + +@property (readwrite, strong, atomic) NSNumber *engineTorque;var engineTorque: NSNumber! { get set }@abstract A boolean value. If true, means the accPedalPosition data has been +subscribed.
+ + + +@property (readwrite, strong, atomic) NSNumber *accPedalPosition;var accPedalPosition: NSNumber! { get set }@abstract A boolean value. If true, means the steeringWheelAngle data has been +subscribed.
+ + + +@property (readwrite, strong, atomic) NSNumber *steeringWheelAngle;var steeringWheelAngle: NSNumber! { get set }Undocumented
+ + + +@interface SDLSubscribeVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLSubscribeVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLSubscribeVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLSubscribeVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLSubscribeVehicleData : SDLRPCRequestSubscribe Vehicle Data Response is sent, when SDLSubscribeVehicleData has been called
+ +Since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLSubscribeVehicleDataResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLSubscribeVehicleDataResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract A SDLVehicleDataResult* value. See GPSData.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *gps;var gps: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per hour.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *speed;var speed: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The number of revolutions per minute of the engine.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *rpm;var rpm: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The fuel level in the tank (percentage)
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *fuelLevel;var fuelLevel: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The fuel level state.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *fuelLevel_State;var fuelLevel_State: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption in microlitres.
+ + + +@property (readwrite, strong, atomic)
+ SDLVehicleDataResult *instantFuelConsumption;var instantFuelConsumption: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The external temperature in degrees celsius.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *externalTemperature;var externalTemperature: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. See PRNDL.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *prndl;var prndl: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. See TireStatus.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *tirePressure;var tirePressure: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. Odometer in km.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *odometer;var odometer: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The status of the seat belts.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *beltStatus;var beltStatus: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The body information including power modes.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *bodyInformation;var bodyInformation: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The device status including signal and battery strength.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *deviceStatus;var deviceStatus: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The status of the brake pedal.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *driverBraking;var driverBraking: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The status of the wipers.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *wiperStatus;var wiperStatus: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. Status of the head lamps.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *headLampStatus;var headLampStatus: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on non-diesel variants.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *engineTorque;var engineTorque: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. Accelerator pedal position (percentage depressed)
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *accPedalPosition;var accPedalPosition: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. Current angle of the steering wheel (in deg)
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *steeringWheelAngle;var steeringWheelAngle: SDLVehicleDataResult! { get set }Undocumented
+ + + +@interface SDLSubscribeVehicleDataResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLSubscribeVehicleDataResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLSubscribeVehicleDataResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLSubscribeVehicleDataResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLSubscribeVehicleDataResponse : SDLRPCResponseSpecifies 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
+ + +@abstract Constructs a newly allocated SDLSyncMsgVersion object
+ + + +- (instancetype)init;init!()@abstract Constructs a newly allocated SDLSyncMsgVersion object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The major version indicates versions that is not-compatible to previous versions
+ +Required, Integer, 1 - 10
+ + + +@property (readwrite, strong, atomic) NSNumber *majorVersion;var majorVersion: NSNumber! { get set }@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)
+ +Required, Integer, 0 - 1000
+ + + +@property (readwrite, strong, atomic) NSNumber *minorVersion;var minorVersion: NSNumber! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Enumeration that describes system actions that can be triggered.
+ + +Convert String to SDLSystemAction +- parameter: value String +- returns: SDLSystemAction
+ + + ++ (SDLSystemAction *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLSystemAction!String
+SDLSystemAction
+ +@abstract Store the enumeration of all possible SDLSystemAction +- returns: an array that store all possible SDLSystemAction
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLSystemAction
+ +@abstract Default_Action
+ + + ++ (SDLSystemAction *)DEFAULT_ACTION;class func DEFAULT_ACTION() -> SDLSystemAction!@abstract Steal_Focus
+ + + ++ (SDLSystemAction *)STEAL_FOCUS;class func STEAL_FOCUS() -> SDLSystemAction!@abstract Keep_Context
+ + + ++ (SDLSystemAction *)KEEP_CONTEXT;class func KEEP_CONTEXT() -> SDLSystemAction!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
+ + +Convert String to SDLSystemContext
+ + + ++ (SDLSystemContext *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLSystemContext!String value to retrieve the object for
+SDLSystemContext
+ +@abstract Store the enumeration of all possible SDLSystemContext
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLSystemContext
+ +@abstract No user interaction (user-initiated or app-initiated) is in progress.
+ + + ++ (SDLSystemContext *)MAIN;class func MAIN() -> SDLSystemContext!SDLSystemContext object of value MAIN
+ +@abstract VR-oriented, user-initiated or app-initiated interaction is in-progress.
+ + + ++ (SDLSystemContext *)VRSESSION;class func VRSESSION() -> SDLSystemContext!SDLSystemContext object of value VRSESSION
+ +@abstract Menu-oriented, user-initiated or app-initiated interaction is in-progress.
+ + + ++ (SDLSystemContext *)MENU;class func MENU() -> SDLSystemContext!SDLSystemContext object of value MENU
+ +@abstract The app’s display HMI is currently being obscured by either a system or other app’s overlay.
+ +@since SDL 2.0
+ + + ++ (SDLSystemContext *)HMI_OBSCURED;class func HMI_OBSCURED() -> SDLSystemContext!SDLSystemContext object of value HMI_OBSCURED
+ +@abstract Broadcast only to whichever app has an alert currently being displayed.
+ +@since SDL 2.0
+ + + ++ (SDLSystemContext *)ALERT;class func ALERT() -> SDLSystemContext!SDLSystemContext object of value ALERT
+ +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +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 +
| Name | +Type | +Description | +SmartDeviceLink Ver. Available | +
|---|---|---|---|
| text | +String | +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 typefield. |
+ SmartDeviceLink 1.0 | +
| type | +SpeechCapabilities | +Indicates the type of information in the textfield (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). |
+ SmartDeviceLink 1.0 | +
@since SmartDeviceLink 1.0
+ + +@abstract Constructs a newly allocated SDLTTSChunk object
+ + + +- (instancetype)init;init!()@abstract Constructs a newly allocated SDLTTSChunk object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@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
+ + + +@property (readwrite, strong, atomic) NSString *text;var text: String! { get set }@abstract The type of information in the text
field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).
Required
+ + + +@property (readwrite, strong, atomic) SDLSpeechCapabilities *type;var type: SDLSpeechCapabilities! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +The list of possible alignments of text in a field. May only work on some display types.
+ +@since SDL 1.0
+ + +Convert String to SDLTextAlignment
+ + + ++ (SDLTextAlignment *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLTextAlignment!The value of the string to get an object for
+SDLTextAlignment
+ +@abstract Store the enumeration of all possible SDLTextAlignment
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLTextAlignment
+ +@abstract Text aligned left.
+ + + ++ (SDLTextAlignment *)LEFT_ALIGNED;class func LEFT_ALIGNED() -> SDLTextAlignment!A SDLTextAlignment object with value of LEFT_ALIGNED
+ +@abstract Text aligned right.
+ + + ++ (SDLTextAlignment *)RIGHT_ALIGNED;class func RIGHT_ALIGNED() -> SDLTextAlignment!A SDLTextAlignment object with value of RIGHT_ALIGNED
+ +@abstract Text aligned centered.
+ + + ++ (SDLTextAlignment *)CENTERED;class func CENTERED() -> SDLTextAlignment!A SDLTextAlignment object with value of CENTERED
+ +Struct defining the characteristics of a displayed field on the HMI.
+ +Parameter List +
| Name | +Type | +Description | +SmartDeviceLink Ver. Available | +
|---|---|---|---|
| name | +TextFieldName | +Enumeration identifying the field. | +SDL 1.0 | +
| characterSet | +CharacterSet | +The character set that is supported in this field. | +SDL 1.0 | +
| width | +Int16 | +The number of characters in one row of this field.
+
|
+ SDL 1.0 | +
| rows | +Int16 | +The number of rows for this text field.
+
|
+ SDL 1.0 | +
@since SDL 1.0
+ + +@abstract Constructs a newly allocated SDLTextField object
+ + + +- (instancetype)init;init!()@abstract Constructs a newly allocated SDLTextField object indicated by the dictionary parameter
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use to construct the object
+@abstract The enumeration identifying the field.
+ +See
+ SDLTextFieldName + +Required
+ + + +@property (readwrite, strong, atomic) SDLTextFieldName *name;var name: SDLTextFieldName! { get set }@abstract The character set that is supported in this field.
+ +See
+ SDLCharacterSet + +Required
+ + + +@property (readwrite, strong, atomic) SDLCharacterSet *characterSet;var characterSet: SDLCharacterSet! { get set }@abstract The number of characters in one row of this field.
+ +Required, Integer 1 - 500
+ + + +@property (readwrite, strong, atomic) NSNumber *width;var width: NSNumber! { get set }@abstract The number of rows for this text field.
+ +Required, Integer 1 - 8
+ + + +@property (readwrite, strong, atomic) NSNumber *rows;var rows: NSNumber! { get set }Names of the text fields that can appear on a SDL display.
+ +@since SDL 1.0
+ + +Convert String to SDLTextFieldName
+ + + ++ (SDLTextFieldName *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLTextFieldName!String value to retrieve the object for
+SDLTextFieldName
+ +@abstract Store the enumeration of all possible SDLTextFieldName
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLTextFieldName
+ +@abstract The first line of the first set of main fields of the persistent display. Applies to SDLShow.
+ + + ++ (SDLTextFieldName *)mainField1;class func mainField1() -> SDLTextFieldName!a SDLTextFieldName with value of mainField1
+ +@abstract The second line of the first set of main fields of the persistent display. Applies to SDLShow.
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)mainField2;class func mainField2() -> SDLTextFieldName!a SDLTextFieldName with value of mainField2
+ +@abstract The first line of the second set of main fields of the persistent display. Applies to SDLShow.
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)mainField3;class func mainField3() -> SDLTextFieldName!a SDLTextFieldName with value of mainField3
+ +@abstract The second line of the second set of main fields of the persistent display. Applies to SDLShow.
+ + + ++ (SDLTextFieldName *)mainField4;class func mainField4() -> SDLTextFieldName!a SDLTextFieldName with value of mainField4
+ +@abstract The status bar on the NGN display. Applies to SDLShow.
+ + + ++ (SDLTextFieldName *)statusBar;class func statusBar() -> SDLTextFieldName!a SDLTextFieldName with value of statusBar
+ +@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.
+ + + ++ (SDLTextFieldName *)mediaClock;class func mediaClock() -> SDLTextFieldName!a SDLTextFieldName with value of mediaClock
+ +@abstract The track field of NGN type ACMs. This field is only available for media applications on a NGN display. Applies to SDLShow.
+ +@discussion This field is commonly used to show the current track number
+ + + ++ (SDLTextFieldName *)mediaTrack;class func mediaTrack() -> SDLTextFieldName!a SDLTextFieldName with value of mediaTrack
+ +@abstract The first line of the alert text field. Applies to SDLAlert.
+ + + ++ (SDLTextFieldName *)alertText1;class func alertText1() -> SDLTextFieldName!a SDLTextFieldName with value of alertText1
+ +@abstract The second line of the alert text field. Applies to SDLAlert.
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)alertText2;class func alertText2() -> SDLTextFieldName!a SDLTextFieldName with value of alertText2
+ +@abstract The third line of the alert text field. Applies to SDLAlert.
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)alertText3;class func alertText3() -> SDLTextFieldName!a SDLTextFieldName with value of alertText3
+ +@abstract Long form body of text that can include newlines and tabs. Applies to SDLScrollableMessage.
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)scrollableMessageBody;class func scrollableMessageBody() -> SDLTextFieldName!a SDLTextFieldName with value of scrollableMessageBody
+ +@abstract First line suggestion for a user response (in the case of VR enabled interaction).
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)initialInteractionText;class func initialInteractionText() -> SDLTextFieldName!a SDLTextFieldName with value of initialInteractionText
+ +@abstract First line of navigation text.
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)navigationText1;class func navigationText1() -> SDLTextFieldName!a SDLTextFieldName with value of navigationText1
+ +@abstract Second line of navigation text.
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)navigationText2;class func navigationText2() -> SDLTextFieldName!a SDLTextFieldName with value of navigationText2
+ +@abstract Estimated Time of Arrival time for navigation.
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)ETA;class func ETA() -> SDLTextFieldName!a SDLTextFieldName with value of ETA
+ +@abstract Total distance to destination for navigation.
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)totalDistance;class func totalDistance() -> SDLTextFieldName!a SDLTextFieldName with value of totalDistance
+ +@abstract First line of text for audio pass thru.
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)audioPassThruDisplayText1;class func audioPassThruDisplayText1() -> SDLTextFieldName!a SDLTextFieldName with value of audioPassThruDisplayText1
+ +@abstract Second line of text for audio pass thru.
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)audioPassThruDisplayText2;class func audioPassThruDisplayText2() -> SDLTextFieldName!a SDLTextFieldName with value of audioPassThruDisplayText2
+ +@abstract Header text for slider.
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)sliderHeader;class func sliderHeader() -> SDLTextFieldName!a SDLTextFieldName with value of sliderHeader
+ +@abstract Footer text for slider
+ +@since SDL 2.0
+ + + ++ (SDLTextFieldName *)sliderFooter;class func sliderFooter() -> SDLTextFieldName!a SDLTextFieldName with value of sliderFooter
+ +Primary text for SDLChoice
+ + + ++ (SDLTextFieldName *)menuName;class func menuName() -> SDLTextFieldName!a SDLTextFieldName with value of menuName
+ +Secondary text for SDLChoice
+ + + ++ (SDLTextFieldName *)secondaryText;class func secondaryText() -> SDLTextFieldName!a SDLTextFieldName with value of secondaryText
+ +Tertiary text for SDLChoice
+ + + ++ (SDLTextFieldName *)tertiaryText;class func tertiaryText() -> SDLTextFieldName!a SDLTextFieldName with value of tertiaryText
+ +Optional text to label an app menu button (for certain touchscreen platforms)
+ + + ++ (SDLTextFieldName *)menuTitle;class func menuTitle() -> SDLTextFieldName!a SDLTextFieldName with value of menuTitle
+ +Optional name / title of intended location for SDLSendLocation
+ +@since SDL 4.0
+ + + ++ (SDLTextFieldName *)locationName;class func locationName() -> SDLTextFieldName!a SDLTextFieldName with value of locationName
+ +Optional description of intended location / establishment (if applicable) for SDLSendLocation
+ +@since SDL 4.0
+ + + ++ (SDLTextFieldName *)locationDescription;class func locationDescription() -> SDLTextFieldName!a SDLTextFieldName with value of locationDescription
+ +Optional location address (if applicable) for SDLSendLocation
+ +@since SDL 4.0
+ + + ++ (SDLTextFieldName *)addressLines;class func addressLines() -> SDLTextFieldName!a SDLTextFieldName with value of addressLines
+ +Optional hone number of intended location / establishment (if applicable) for SDLSendLocation
+ +@since SDL 4.0
+ + + ++ (SDLTextFieldName *)phoneNumber;class func phoneNumber() -> SDLTextFieldName!a SDLTextFieldName with value of phoneNumber
+ +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +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
+ + + +@property (readwrite, strong, atomic) NSNumber *touchEventId;var touchEventId: NSNumber! { get set }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.
+ +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
@property (readwrite, strong, atomic) NSMutableArray *timeStamp;var timeStamp: NSMutableArray! { get set }Mandatory, array size 1-1000, contains SDLTouchCoord
+ + + +@property (readwrite, strong, atomic) NSMutableArray *coord;var coord: NSMutableArray! { get set }Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Indicates whether choice/command was selected via VR or via a menu selection (using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN, OK buttons)
+ +@since SDL 1.0
+ + +Convert String to SDLTriggerSource +- parameter: value The value of the string to get an object for +- returns: SDLTriggerSource
+ + + ++ (SDLTriggerSource *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLTriggerSource!The value of the string to get an object for
+SDLTriggerSource
+ +@abstract Store the enumeration of all possible SDLTriggerSource +- returns: an array that store all possible SDLTriggerSource
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLTriggerSource
+ +@abstract Selection made via menu +- returns: SDLTriggerSource with value of MENU
+ + + ++ (SDLTriggerSource *)MENU;class func MENU() -> SDLTriggerSource!SDLTriggerSource with value of MENU
+ +@abstract Selection made via Voice session +- returns: SDLTriggerSource with value of VR
+ + + ++ (SDLTriggerSource *)VR;class func VR() -> SDLTriggerSource!SDLTriggerSource with value of VR
+ +@abstract Selection made via Keyboard +- returns: SDLTriggerSource with value of KEYBOARD
+ + + ++ (SDLTriggerSource *)KEYBOARD;class func KEYBOARD() -> SDLTriggerSource!SDLTriggerSource with value of KEYBOARD
+ +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +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
+ + +@abstract Constructs a new SDLUnregisterAppInterface object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLUnregisterAppInterface object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+Unregister AppInterface Response is sent, when SDLUnregisterAppInterface has been called
+ +@since SmartDeviceLink 1.0
+ + +@abstract Constructs a new SDLUnregisterAppInterfaceResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLUnregisterAppInterfaceResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+Deletes a subscription to button notifications for the specified button. For +more information about button subscriptions, see SDLSubscribeButton +
+Application can unsubscribe from a button that is currently being pressed +(i.e. has not yet been released), but app will not get button event +
+HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +@since SmartDeviceLink 1.0
+See SDLSubscribeButton
@abstract Constructs a new SDLUnsubscribeButton object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLUnsubscribeButton object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract A name of the button to unsubscribe from +@discussion An Enumeration value, see + SDLButtonName
+ + + +@property (readwrite, strong, atomic) SDLButtonName *buttonName;var buttonName: SDLButtonName! { get set }Unsubscribe Button Response is sent, when SDLUnsubscribeButton has been called
+ +@since SmartDeviceLink 1.0
+ + +@abstract Constructs a new SDLUnsubscribeButtonResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLUnsubscribeButtonResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+This function is used to unsubscribe the notifications from the + subscribeVehicleData function +
+ Function Group: Location, VehicleInfo and DrivingChara +
+ HMILevel needs to be FULL, LIMITED or BACKGROUND +
+ +@since SmartDeviceLink 2.0
+ See SDLSubscribeVehicleData SDLGetVehicleData
@abstract Constructs a new SDLUnsubscribeVehicleData object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLUnsubscribeVehicleData object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract A boolean value. If true, unsubscribes Gps data
+ + + +@property (readwrite, strong, atomic) NSNumber *gps;var gps: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes speed data
+ + + +@property (readwrite, strong, atomic) NSNumber *speed;var speed: NSNumber! { get set }@abstract A boolean value. If true, unsubscribe data
+ + + +@property (readwrite, strong, atomic) NSNumber *rpm;var rpm: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes FuelLevel data
+ + + +@property (readwrite, strong, atomic) NSNumber *fuelLevel;var fuelLevel: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes fuelLevel_State data
+ + + +@property (readwrite, strong, atomic) NSNumber *fuelLevel_State;var fuelLevel_State: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes instantFuelConsumption data
+ + + +@property (readwrite, strong, atomic) NSNumber *instantFuelConsumption;var instantFuelConsumption: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes externalTemperature data
+ + + +@property (readwrite, strong, atomic) NSNumber *externalTemperature;var externalTemperature: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes Currently selected gear data
+ + + +@property (readwrite, strong, atomic) NSNumber *prndl;var prndl: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes tire pressure status data
+ + + +@property (readwrite, strong, atomic) NSNumber *tirePressure;var tirePressure: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes odometer data
+ + + +@property (readwrite, strong, atomic) NSNumber *odometer;var odometer: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes belt Status data
+ + + +@property (readwrite, strong, atomic) NSNumber *beltStatus;var beltStatus: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes body Information data
+ + + +@property (readwrite, strong, atomic) NSNumber *bodyInformation;var bodyInformation: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes device Status data
+ + + +@property (readwrite, strong, atomic) NSNumber *deviceStatus;var deviceStatus: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes driver Braking data
+ + + +@property (readwrite, strong, atomic) NSNumber *driverBraking;var driverBraking: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes wiper Status data
+ + + +@property (readwrite, strong, atomic) NSNumber *wiperStatus;var wiperStatus: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes Head Lamp Status data
+ + + +@property (readwrite, strong, atomic) NSNumber *headLampStatus;var headLampStatus: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes Engine Torque data
+ + + +@property (readwrite, strong, atomic) NSNumber *engineTorque;var engineTorque: NSNumber! { get set }@abstract A boolean value. If true, unsubscribes accPedalPosition data
+ + + +@property (readwrite, strong, atomic) NSNumber *accPedalPosition;var accPedalPosition: NSNumber! { get set }Undocumented
+ + + +@interface SDLUnsubscribeVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLUnsubscribeVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLUnsubscribeVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLUnsubscribeVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLUnsubscribeVehicleData : SDLRPCRequestUndocumented
+ + + +@interface SDLUnsubscribeVehicleData : SDLRPCRequestUnsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called
+ +@since SmartDeviceLink 2.0
+ + +@abstract Constructs a new SDLUnsubscribeVehicleDataResponse object
+ + + +- (instancetype)init;init!()@abstract Constructs a new SDLUnsubscribeVehicleDataResponse object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract A SDLVehicleDataResult* value. See GPSData.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *gps;var gps: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per hour.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *speed;var speed: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The number of revolutions per minute of the engine.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *rpm;var rpm: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The fuel level in the tank (percentage)
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *fuelLevel;var fuelLevel: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The fuel level state.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *fuelLevel_State;var fuelLevel_State: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption in microlitres.
+ + + +@property (readwrite, strong, atomic)
+ SDLVehicleDataResult *instantFuelConsumption;var instantFuelConsumption: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The external temperature in degrees celsius.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *externalTemperature;var externalTemperature: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. See PRNDL.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *prndl;var prndl: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. See TireStatus.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *tirePressure;var tirePressure: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. Odometer in km.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *odometer;var odometer: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The status of the seat belts.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *beltStatus;var beltStatus: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The body information including power modes.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *bodyInformation;var bodyInformation: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The device status including signal and battery strength.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *deviceStatus;var deviceStatus: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The status of the brake pedal.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *driverBraking;var driverBraking: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. The status of the wipers.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *wiperStatus;var wiperStatus: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. Status of the head lamps.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *headLampStatus;var headLampStatus: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on non-diesel variants.
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *engineTorque;var engineTorque: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. Accelerator pedal position (percentage depressed)
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *accPedalPosition;var accPedalPosition: SDLVehicleDataResult! { get set }@abstract A SDLVehicleDataResult* value. Current angle of the steering wheel (in deg)
+ + + +@property (readwrite, strong, atomic) SDLVehicleDataResult *steeringWheelAngle;var steeringWheelAngle: SDLVehicleDataResult! { get set }Undocumented
+ + + +@interface SDLUnsubscribeVehicleDataResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLUnsubscribeVehicleDataResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLUnsubscribeVehicleDataResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLUnsubscribeVehicleDataResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLUnsubscribeVehicleDataResponse : SDLRPCResponseSpecifies what function should be performed on the media clock/counter
+ +@since SDL 1.0
+ + +Convert String to SDLUpdateMode +- parameter: value The value of the string to get an object for +- returns: SDLUpdateMode
+ + + ++ (SDLUpdateMode *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLUpdateMode!The value of the string to get an object for
+SDLUpdateMode
+ +@abstract Store the enumeration of all possible SDLUpdateMode +- returns: an array that store all possible SDLUpdateMode
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLUpdateMode
+ +@abstract Starts the media clock timer counting upward, in increments of 1 second. +- returns: SDLUpdateMode with value of COUNTUP
+ + + ++ (SDLUpdateMode *)COUNTUP;class func COUNTUP() -> SDLUpdateMode!SDLUpdateMode with value of COUNTUP
+ +@abstract Starts the media clock timer counting downward, in increments of 1 second. +- returns: SDLUpdateMode with value of COUNTDOWN
+ + + ++ (SDLUpdateMode *)COUNTDOWN;class func COUNTDOWN() -> SDLUpdateMode!SDLUpdateMode with value of COUNTDOWN
+ +@abstract Pauses the media clock timer. +- returns: SDLUpdateMode with value of PAUSE
+ + + ++ (SDLUpdateMode *)PAUSE;class func PAUSE() -> SDLUpdateMode!SDLUpdateMode with value of PAUSE
+ +@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 *)RESUME;class func RESUME() -> SDLUpdateMode!SDLUpdateMode with value of RESUME
+ +@abstract Clear the media clock timer.
+ + + ++ (SDLUpdateMode *)CLEAR;class func CLEAR() -> SDLUpdateMode!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
+ + +Undocumented
+ + + +@interface SDLUpdateTurnList : SDLRPCRequestUndocumented
+ + + +@interface SDLUpdateTurnList : SDLRPCRequestOptional, SDLTurn, 1 - 100 entries
+ + + +@property (readwrite, strong, atomic) NSMutableArray *turnList;var turnList: NSMutableArray! { get set }Required, SDLSoftButton, 0 - 1 Entries
+ + + +@property (readwrite, strong, atomic) NSMutableArray *softButtons;var softButtons: NSMutableArray! { get set }SDLUpdateTurnListResponse is sent, when SDLUpdateTurnList has been called. + * SinceSmartDeviceLink 2.0
+ + +Undocumented
+ + + +@interface SDLUpdateTurnListResponse : SDLRPCResponseUndocumented
+ + + +@interface SDLUpdateTurnListResponse : SDLRPCResponseThe VR capabilities of the connected SDL platform.
+ +@since SDL 1.0
+ + +Convert String to SDLVRCapabilities +- parameter: value The value of the string to get an object for +- returns: SDLVRCapabilities
+ + + ++ (SDLVRCapabilities *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLVRCapabilities!The value of the string to get an object for
+SDLVRCapabilities
+ +@abstract Store the enumeration of all possible SDLVRCapabilities +- returns: an array that store all possible SDLVRCapabilities
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLVRCapabilities
+ +@abstract The SDL platform is capable of recognizing spoken text in the current language. +- returns: an SDLVRCapabilities instance pointer with value of TEXT
+ + + ++ (SDLVRCapabilities *)TEXT;class func TEXT() -> SDLVRCapabilities!an SDLVRCapabilities instance pointer with value of TEXT
+ +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Vehicle Data Activity Status
+ + +@abstract Convert String to SDLVehicleDataActiveStatus +- parameter: value NSString +- returns: SDLVehicleDataActiveStatus
+ + + ++ (SDLVehicleDataActiveStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLVehicleDataActiveStatus!NSString
+SDLVehicleDataActiveStatus
+ +@abstract return the array that store all possible SDLVehicleDataActiveStatus values
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!@abstract SDLVehicleDataActiveStatus : Inactive not confirmed
+ + + ++ (SDLVehicleDataActiveStatus *)INACTIVE_NOT_CONFIRMED;class func INACTIVE_NOT_CONFIRMED() -> SDLVehicleDataActiveStatus!@abstract SDLVehicleDataActiveStatus : Inactive confirmed
+ + + ++ (SDLVehicleDataActiveStatus *)INACTIVE_CONFIRMED;class func INACTIVE_CONFIRMED() -> SDLVehicleDataActiveStatus!@abstract SDLVehicleDataActiveStatus : Active not confirmed
+ + + ++ (SDLVehicleDataActiveStatus *)ACTIVE_NOT_CONFIRMED;class func ACTIVE_NOT_CONFIRMED() -> SDLVehicleDataActiveStatus!@abstract SDLVehicleDataActiveStatus : Active confirmed
+ + + ++ (SDLVehicleDataActiveStatus *)ACTIVE_CONFIRMED;class func ACTIVE_CONFIRMED() -> SDLVehicleDataActiveStatus!@abstract SDLVehicleDataActiveStatus : Fault
+ + + ++ (SDLVehicleDataActiveStatus *)FAULT;class func FAULT() -> SDLVehicleDataActiveStatus!Reflects the status of a vehicle data event; e.g. a seat belt event status.
+ +@since SDL 2.0
+ + +Convert String to SDLVehicleDataEventStatus
+ + + ++ (SDLVehicleDataEventStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLVehicleDataEventStatus!The value of the string to get an object for
+SDLVehicleDataEventStatus
+ +@abstract Store the enumeration of all possible SDLVehicleDataEventStatus
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLVehicleDataEventStatus
+ ++ (SDLVehicleDataEventStatus *)NO_EVENT;class func NO_EVENT() -> SDLVehicleDataEventStatus!The SDLVehicleDataEventStatus instance with value of NO_EVENT
+ ++ (SDLVehicleDataEventStatus *)_NO;class func _NO() -> SDLVehicleDataEventStatus!The SDLVehicleDataEventStatus instance with value of NO
+ ++ (SDLVehicleDataEventStatus *)_YES;class func _YES() -> SDLVehicleDataEventStatus!The SDLVehicleDataEventStatus instance with value of YES
+ +@abstract Vehicle data event is not supported
+ + + ++ (SDLVehicleDataEventStatus *)NOT_SUPPORTED;class func NOT_SUPPORTED() -> SDLVehicleDataEventStatus!the SDLVehicleDataEventStatus instance with value of NOT_SUPPORTED
+ +@abstract The SDLVehicleDataEventStatus instance with value of FAULT
+ + + ++ (SDLVehicleDataEventStatus *)FAULT;class func FAULT() -> SDLVehicleDataEventStatus!Reflects the status of a vehicle data notification.
+ +@since SDL 2.0
+ + +Convert String to SDLVehicleDataNotificationStatus +- parameter: value The value of the string to get an object for +- returns: SDLVehicleDataNotificationStatus
+ + + ++ (SDLVehicleDataNotificationStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLVehicleDataNotificationStatus!The value of the string to get an object for
+SDLVehicleDataNotificationStatus
+ +@abstract Store the enumeration of all possible SDLVehicleDataNotificationStatus +- returns: an array that store all possible SDLVehicleDataNotificationStatus
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLVehicleDataNotificationStatus
+ +@abstract SDLVehicleDataNotificationStatus: NOT_SUPPORTED
+ + + ++ (SDLVehicleDataNotificationStatus *)NOT_SUPPORTED;class func NOT_SUPPORTED() -> SDLVehicleDataNotificationStatus!@abstract SDLVehicleDataNotificationStatus: NORMAL
+ + + ++ (SDLVehicleDataNotificationStatus *)NORMAL;class func NORMAL() -> SDLVehicleDataNotificationStatus!@abstract SDLVehicleDataNotificationStatus: ACTIVE
+ + + ++ (SDLVehicleDataNotificationStatus *)ACTIVE;class func ACTIVE() -> SDLVehicleDataNotificationStatus!@abstract SDLVehicleDataNotificationStatus: NOT_USED
+ + + ++ (SDLVehicleDataNotificationStatus *)NOT_USED;class func NOT_USED() -> SDLVehicleDataNotificationStatus!Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Vehicle Data Result Code
+ + +Convert String to SDLVehicleDataResultCode +- parameter: value String +- returns: SDLVehicleDataResultCode
+ + + ++ (SDLVehicleDataResultCode *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLVehicleDataResultCode!String
+SDLVehicleDataResultCode
+ +@abstract Store the enumeration of all possible SDLVehicleDataResultCode +- returns: an array that store all possible SDLVehicleDataResultCode
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLVehicleDataResultCode
+ +Individual vehicle data item / DTC / DID request or subscription successful
+ + + ++ (SDLVehicleDataResultCode *)SUCCESS;class func SUCCESS() -> SDLVehicleDataResultCode!DTC / DID request successful, however, not all active DTCs or full contents of DID location available
+ + + ++ (SDLVehicleDataResultCode *)TRUNCATED_DATA;class func TRUNCATED_DATA() -> SDLVehicleDataResultCode!This vehicle data item is not allowed for this app by SDL
+ + + ++ (SDLVehicleDataResultCode *)DISALLOWED;class func DISALLOWED() -> SDLVehicleDataResultCode!The user has not granted access to this type of vehicle data item at this time
+ + + ++ (SDLVehicleDataResultCode *)USER_DISALLOWED;class func USER_DISALLOWED() -> SDLVehicleDataResultCode!The ECU ID referenced is not a valid ID on the bus / system
+ + + ++ (SDLVehicleDataResultCode *)INVALID_ID;class func INVALID_ID() -> SDLVehicleDataResultCode!The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system
+ + + ++ (SDLVehicleDataResultCode *)VEHICLE_DATA_NOT_AVAILABLE;class func VEHICLE_DATA_NOT_AVAILABLE() -> SDLVehicleDataResultCode!The vehicle data item is already subscribed
+ + + ++ (SDLVehicleDataResultCode *)DATA_ALREADY_SUBSCRIBED;class func DATA_ALREADY_SUBSCRIBED() -> SDLVehicleDataResultCode!The vehicle data item cannot be unsubscribed because it is not currently subscribed
+ + + ++ (SDLVehicleDataResultCode *)DATA_NOT_SUBSCRIBED;class func DATA_NOT_SUBSCRIBED() -> SDLVehicleDataResultCode!The request for this item is ignored because it is already in progress
+ + + ++ (SDLVehicleDataResultCode *)IGNORED;class func IGNORED() -> SDLVehicleDataResultCode!Reflects the status of a binary vehicle data item.
+ +@since SDL 2.0
+ + +Convert String to SDLVehicleDataStatus +- parameter: value The value of the string to get an object for +- returns: SDLVehicleDataStatus
+ + + ++ (SDLVehicleDataStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLVehicleDataStatus!The value of the string to get an object for
+SDLVehicleDataStatus
+ +@abstract Store the enumeration of all possible SDLVehicleDataStatus +- returns: an array that store all possible SDLVehicleDataStatus
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLVehicleDataStatus
+ +@abstract No data avaliable +- returns: SDLVehicleDataStatus: NO_DATA_EXISTS
+ + + ++ (SDLVehicleDataStatus *)NO_DATA_EXISTS;class func NO_DATA_EXISTS() -> SDLVehicleDataStatus!SDLVehicleDataStatus: NO_DATA_EXISTS
+ +@abstract return SDLVehicleDataStatus: OFF
+ + + ++ (SDLVehicleDataStatus *)OFF;class func OFF() -> SDLVehicleDataStatus!@abstract return SDLVehicleDataStatus: ON
+ + + ++ (SDLVehicleDataStatus *)ON;class func ON() -> SDLVehicleDataStatus!Defines the vehicle data types that can be published and/or subscribed to using SDLSubscribeVehicleData
+ + +Convert String to SDLVehicleDataType
+ + + ++ (SDLVehicleDataType *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLVehicleDataType!String value to retrieve the object for
+SDLVehicleDataType
+ +@abstract Store the enumeration of all possible SDLVehicleDataType
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLVehicleDataType
+ +@abstract SDLVehicleDataType: VEHICLEDATA_GPS
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_GPS;class func VEHICLEDATA_GPS() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_SPEED
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_SPEED;class func VEHICLEDATA_SPEED() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_RPM
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_RPM;class func VEHICLEDATA_RPM() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_FUELLEVEL
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_FUELLEVEL;class func VEHICLEDATA_FUELLEVEL() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_FUELLEVEL_STATE
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_FUELLEVEL_STATE;class func VEHICLEDATA_FUELLEVEL_STATE() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_FUELCONSUMPTION
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_FUELCONSUMPTION;class func VEHICLEDATA_FUELCONSUMPTION() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_EXTERNTEMP
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_EXTERNTEMP;class func VEHICLEDATA_EXTERNTEMP() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_VIN
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_VIN;class func VEHICLEDATA_VIN() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_PRNDL
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_PRNDL;class func VEHICLEDATA_PRNDL() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_TIREPRESSURE
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_TIREPRESSURE;class func VEHICLEDATA_TIREPRESSURE() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_ODOMETER
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_ODOMETER;class func VEHICLEDATA_ODOMETER() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_BELTSTATUS
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_BELTSTATUS;class func VEHICLEDATA_BELTSTATUS() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_BODYINFO
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_BODYINFO;class func VEHICLEDATA_BODYINFO() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_DEVICESTATUS
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_DEVICESTATUS;class func VEHICLEDATA_DEVICESTATUS() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_ECALLINFO
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_ECALLINFO;class func VEHICLEDATA_ECALLINFO() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_AIRBAGSTATUS
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_AIRBAGSTATUS;class func VEHICLEDATA_AIRBAGSTATUS() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_EMERGENCYEVENT
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_EMERGENCYEVENT;class func VEHICLEDATA_EMERGENCYEVENT() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_CLUSTERMODESTATUS
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_CLUSTERMODESTATUS;class func VEHICLEDATA_CLUSTERMODESTATUS() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_MYKEY
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_MYKEY;class func VEHICLEDATA_MYKEY() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_BRAKING
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_BRAKING;class func VEHICLEDATA_BRAKING() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_WIPERSTATUS
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_WIPERSTATUS;class func VEHICLEDATA_WIPERSTATUS() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_HEADLAMPSTATUS
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_HEADLAMPSTATUS;class func VEHICLEDATA_HEADLAMPSTATUS() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_BATTVOLTAGE
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_BATTVOLTAGE;class func VEHICLEDATA_BATTVOLTAGE() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_ENGINETORQUE
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_ENGINETORQUE;class func VEHICLEDATA_ENGINETORQUE() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_ACCPEDAL
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_ACCPEDAL;class func VEHICLEDATA_ACCPEDAL() -> SDLVehicleDataType!@abstract SDLVehicleDataType: VEHICLEDATA_STEERINGWHEEL
+ + + ++ (SDLVehicleDataType *)VEHICLEDATA_STEERINGWHEEL;class func VEHICLEDATA_STEERINGWHEEL() -> SDLVehicleDataType!Describes the type of vehicle the mobile phone is connected with.
+ +@since SDL 2.0
+ + +@abstract Constructs a newly allocated SDLVehicleType object
+ + + +- (instancetype)init;init!()@abstract Constructs a newly allocated SDLVehicleType object indicated by the dictionary parameter +- parameter: dict The dictionary to use
+ + + +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;init!(dictionary dict: NSMutableDictionary!)The dictionary to use
+@abstract The make of the vehicle
+ +@discussion For example, Ford
, Lincoln
, etc.
Optional, Max String length 500 chars
+ + + +@property (readwrite, strong, atomic) NSString *make;var make: String! { get set }@abstract The model of the vehicle
+ +@discussion For example, Fiesta
, Focus
, etc.
Optional, Max String length 500 chars
+ + + +@property (readwrite, strong, atomic) NSString *model;var model: String! { get set }@abstract The model year of the vehicle
+ +@discussion For example, 2013
Optional, Max String length 500 chars
+ + + +@property (readwrite, strong, atomic) NSString *modelYear;var modelYear: String! { get set }@abstract The trim of the vehicle
+ +@discussion For example, SE
, SEL
Optional, Max String length 500 chars
+ + + +@property (readwrite, strong, atomic) NSString *trim;var trim: String! { get set }Reflects the status of a cluster instrument warning light.
+ +@since SDL 2.0
+ + +Convert String to SDLWarningLightStatus +- parameter: value The value of the string to get an object for +- returns: SDLWarningLightStatus
+ + + ++ (SDLWarningLightStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLWarningLightStatus!The value of the string to get an object for
+SDLWarningLightStatus
+ +@abstract Store the enumeration of all possible SDLWarningLightStatus +- returns: an array that store all possible SDLWarningLightStatus
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!an array that store all possible SDLWarningLightStatus
+ +@abstract Warninglight Off +- returns: SDLWarningLightStatus instance with value of OFF
+ + + ++ (SDLWarningLightStatus *)OFF;class func OFF() -> SDLWarningLightStatus!SDLWarningLightStatus instance with value of OFF
+ +@abstract Warninglight On +- returns: SDLWarningLightStatus instance with value of ON
+ + + ++ (SDLWarningLightStatus *)ON;class func ON() -> SDLWarningLightStatus!SDLWarningLightStatus instance with value of ON
+ +@abstract Warninglight is flashing +- returns: SDLWarningLightStatus instance with value of FLASH
+ + + ++ (SDLWarningLightStatus *)FLASH;class func FLASH() -> SDLWarningLightStatus!SDLWarningLightStatus instance with value of FLASH
+ +@abstract Not used +- returns: SDLWarningLightStatus instance with value of NOT_USED
+ + + ++ (SDLWarningLightStatus *)NOT_USED;class func NOT_USED() -> SDLWarningLightStatus!SDLWarningLightStatus instance with value of NOT_USED
+ +Wiper Status
+ + +Convert String to SDLWiperStatus +- parameter: value The value of the string to get an object for +- returns: SDLWiperStatus
+ + + ++ (SDLWiperStatus *)valueOf:(NSString *)value;class func valueOf(value: String!) -> SDLWiperStatus!The value of the string to get an object for
+SDLWiperStatus
+ +@abstract Store the enumeration of all possible SDLWiperStatus +- returns: An array that store all possible SDLWiperStatus
+ + + ++ (NSArray *)values;class func values() -> [AnyObject]!An array that store all possible SDLWiperStatus
+ +@abstract SDLWiperStatus: OFF
+ + + ++ (SDLWiperStatus *)OFF;class func OFF() -> SDLWiperStatus!@abstract SDLWiperStatus: AUTO_OFF
+ + + ++ (SDLWiperStatus *)AUTO_OFF;class func AUTO_OFF() -> SDLWiperStatus!@abstract SDLWiperStatus: OFF_MOVING
+ + + ++ (SDLWiperStatus *)OFF_MOVING;class func OFF_MOVING() -> SDLWiperStatus!@abstract SDLWiperStatus: MAN_INT_OFF
+ + + ++ (SDLWiperStatus *)MAN_INT_OFF;class func MAN_INT_OFF() -> SDLWiperStatus!@abstract SDLWiperStatus: MAN_INT_ON
+ + + ++ (SDLWiperStatus *)MAN_INT_ON;class func MAN_INT_ON() -> SDLWiperStatus!@abstract SDLWiperStatus: MAN_LOW
+ + + ++ (SDLWiperStatus *)MAN_LOW;class func MAN_LOW() -> SDLWiperStatus!@abstract SDLWiperStatus: MAN_HIGH
+ + + ++ (SDLWiperStatus *)MAN_HIGH;class func MAN_HIGH() -> SDLWiperStatus!@abstract SDLWiperStatus: MAN_FLICK
+ + + ++ (SDLWiperStatus *)MAN_FLICK;class func MAN_FLICK() -> SDLWiperStatus!@abstract SDLWiperStatus: WASH
+ + + ++ (SDLWiperStatus *)WASH;class func WASH() -> SDLWiperStatus!@abstract SDLWiperStatus: AUTO_LOW
+ + + ++ (SDLWiperStatus *)AUTO_LOW;class func AUTO_LOW() -> SDLWiperStatus!@abstract SDLWiperStatus: AUTO_HIGH
+ + + ++ (SDLWiperStatus *)AUTO_HIGH;class func AUTO_HIGH() -> SDLWiperStatus!@abstract SDLWiperStatus: COURTESYWIPE
+ + + ++ (SDLWiperStatus *)COURTESYWIPE;class func COURTESYWIPE() -> SDLWiperStatus!@abstract SDLWiperStatus: AUTO_ADJUST
+ + + ++ (SDLWiperStatus *)AUTO_ADJUST;class func AUTO_ADJUST() -> SDLWiperStatus!@abstract SDLWiperStatus: STALLED
+ + + ++ (SDLWiperStatus *)STALLED;class func STALLED() -> SDLWiperStatus!@abstract SDLWiperStatus: NO_DATA_EXISTS
+ + + ++ (SDLWiperStatus *)NO_DATA_EXISTS;class func NO_DATA_EXISTS() -> SDLWiperStatus!The following constants are available globally.
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +The following enums are available globally.
+ + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +The following protocols are available globally.
+ + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + See more + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +Undocumented
+ + + + + + +The following type definitions are available globally.
+ + +Undocumented
+ + + + + + +