Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
iOS Documentation
SDLRegisterAppInterfaceResponse

SDLRegisterAppInterfaceResponse Class Reference

Section Contents

Overview

Response to SDLRegisterAppInterface

@since SDL 1.0

sdlMsgVersion

Specifies the negotiated version number of the SmartDeviceLink protocol that is to be supported by the mobile application.

SDLMsgVersion, Optional

@since SDL 1.0

Objective-C

@property (nonatomic, strong, nullable) SDLMsgVersion *sdlMsgVersion;

Swift

var sdlMsgVersion: SDLMsgVersion? { get set }

language

The currently active VR+TTS language on the module. See “Language” for options.

SDLLanguage, Optional

@since SDL 1.0

Objective-C

@property (nonatomic, strong, nullable) SDLLanguage language;

Swift

var language: SDLLanguage? { get set }

hmiDisplayLanguage

The currently active display language on the module. See “Language” for options.

SDLLanguage, Optional

@since SDL 2.0

Objective-C

@property (nonatomic, strong, nullable) SDLLanguage hmiDisplayLanguage;

Swift

var hmiDisplayLanguage: SDLLanguage? { get set }

displayCapabilities

Contains information about the display’s capabilities.

SDLDisplayCapabilities, Optional

@since SDL 1.0

Objective-C

@property (nonatomic, strong, nullable) SDLDisplayCapabilities *displayCapabilities;

Swift

var displayCapabilities: SDLDisplayCapabilities? { get set }

buttonCapabilities

Contains information about the head unit button capabilities.

Array of SDLButtonCapabilities, Optional, Array of length 1 - 100

@since SDL 1.0

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLButtonCapabilities *> *buttonCapabilities;

Swift

var buttonCapabilities: [SDLButtonCapabilities]? { get set }

softButtonCapabilities

Contains information about the head unit soft button capabilities.

Array of SDLSoftButtonCapabilities, Optional, Array of length 1 - 100

@since SDL 2.0

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLSoftButtonCapabilities *> *softButtonCapabilities;

Swift

var softButtonCapabilities: [SDLSoftButtonCapabilities]? { get set }

presetBankCapabilities

If returned, the platform supports custom on-screen Presets

SDLPresetBankCapabilities, Optional

@since SDL 2.0

Objective-C

@property (nonatomic, strong, nullable) SDLPresetBankCapabilities *presetBankCapabilities;

Swift

var presetBankCapabilities: SDLPresetBankCapabilities? { get set }

hmiZoneCapabilities

Contains information about the HMI zone capabilities.

Array of SDLHMIZoneCapabilities, Optional, Array of length 1 - 100

@since SDL 1.0

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLHMIZoneCapabilities> *hmiZoneCapabilities;

Swift

var hmiZoneCapabilities: [SDLHMIZoneCapabilities]? { get set }

speechCapabilities

Contains information about the text-to-speech capabilities.

Array of SDLSpeechCapabilities, Optional, Array of length 1 - 100

@since SDL 1.0

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLSpeechCapabilities> *speechCapabilities;

Swift

var speechCapabilities: [SDLSpeechCapabilities]? { get set }

prerecordedSpeech

Contains a list of prerecorded speech items present on the platform.

Array of SDLPrerecordedSpeech, Optional, Array of length 1 - 100

@since SDL 3.0

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLPrerecordedSpeech> *prerecordedSpeech;

Swift

var prerecordedSpeech: [SDLPrerecordedSpeech]? { get set }

vrCapabilities

Contains information about the VR capabilities.

Array of SDLVRCapabilities, Optional, Array of length 1 - 100

@since SDL 1.0

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLVRCapabilities> *vrCapabilities;

Swift

var vrCapabilities: [SDLVRCapabilities]? { get set }

audioPassThruCapabilities

Describes different audio type configurations for PerformAudioPassThru, e.g. {8kHz,8-bit,PCM}. The audio is recorded in monaural.

Array of SDLAudioPassThruCapabilities, Optional, Array of length 1 - 100

@since SDL 2.0

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLAudioPassThruCapabilities *> *audioPassThruCapabilities;

Swift

var audioPassThruCapabilities: [SDLAudioPassThruCapabilities]? { get set }

pcmStreamCapabilities

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

SDLAudioPassThruCapabilities, Optional

@since SDL 4.1

Objective-C

@property (nonatomic, strong, nullable) SDLAudioPassThruCapabilities *pcmStreamCapabilities;

Swift

var pcmStreamCapabilities: SDLAudioPassThruCapabilities? { get set }

vehicleType

Specifies the vehicle’s type. See VehicleType.

@deprecated in SmartDeviceLink 7.1.0

@added in SmartDeviceLink 2.0.0

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleType *vehicleType;

Swift

var vehicleType: SDLVehicleType? { get set }

supportedDiagModes

Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for DiagnosticMessage requests. If a mode outside this list is requested, it will be rejected.

Array of Integers, Optional, Array of length 1 - 100, Value range: 0 - 255

@since SDL 3.0

Objective-C

@property (nonatomic, strong, nullable) NSArray<NSNumber *> *supportedDiagModes;

Swift

var supportedDiagModes: [NSNumber]? { get set }

hmiCapabilities

Specifies the HMI capabilities.

SDLHMICapabilities, Optional

@since SDL 3.0

Objective-C

@property (nonatomic, strong, nullable) SDLHMICapabilities *hmiCapabilities;

Swift

var hmiCapabilities: SDLHMICapabilities? { get set }

sdlVersion

The version of SDL Core running on the connected head unit

String, Optional, Max length: 100

@since SDL 3.0

Objective-C

@property (nonatomic, strong, nullable) NSString *sdlVersion;

Swift

var sdlVersion: String? { get set }

systemSoftwareVersion

The software version of the system that implements the SmartDeviceLink core.

{“string_min_length”: 1, “string_max_length”: 100}

@deprecated in SDL 7.1.0

@added in SDL 3.0.0

Objective-C

@property (nonatomic, strong, nullable) NSString *systemSoftwareVersion;

Swift

var systemSoftwareVersion: String? { get set }

iconResumed

Existence of apps icon at system. If true, apps icon was resumed at system. If false, apps icon is not resumed at system.

Bool, Optional

@since SDL 5.0

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *iconResumed;

Swift

var iconResumed: (NSNumber & SDLBool)? { get set }
View on GitHub.com
Previous Section Next Section