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

SDLRegisterAppInterface Class Reference

Section Contents

Overview

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

Until the application receives its first SDLOnHMIStatus Notification, its HMI Status is assumed to be: SDLHMILevel=NONE, SDLAudioStreamingState =NOT_AUDIBLE, SDLSystemContext=MAIN

All SDL® resources which the application creates or uses (e.g. Choice Sets, Command Menu, etc.) are associated with the application’s interface registration. Therefore, when the interface registration ends, the SDL® resources associated with the application are disposed of. As a result, even though the application itself may continue to run on its host platform (e.g. mobile device) after the interface registration terminates, the application will not be able to use the SDL® HMI without first establishing a new interface registration and re-creating its required SDL® resources. That is, SDL® resources created by (or on behalf of) an application do not persist beyond the life-span of the interface registration

Resources and settings whose lifespan is tied to the duration of an application’s interface registration:

  • Choice Sets
  • Command Menus (built by successive calls to SDLAddCommand )
  • Media clock timer display value
  • Media clock timer display value
  • Media clock timer display value

The autoActivateID is used to grant an application the HMILevel and AudioStreamingState it had when it last disconnected

Notes: The autoActivateID parameter, and associated behavior, is currently ignored by SDL®

When first calling this method (i.e. first time within life cycle of mobile app), an autoActivateID should not be included. After successfully registering an interface, an autoActivateID is returned to the mobile application for it to use in subsequent connections. If the connection between SDL® and the mobile application is lost, such as the vehicle is turned off while the application is running, the autoActivateID can then be passed in another call to RegisterAppInterface to re-acquire SDLHMILevel=FULL

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

There is no time limit for how long the autoActivateID is valid (i.e. would confer focus and opt-in)

HMILevel is not defined before registering

@since SDL 1.0

See

SDLUnregisterAppInterface SDLOnAppInterfaceUnregistered

-initWithLifecycleConfiguration:

Undocumented

Objective-C

- (instancetype)initWithLifecycleConfiguration:(SDLLifecycleConfiguration *)lifecycleConfiguration;

Swift

init(lifecycleConfiguration: SDLLifecycleConfiguration)

-initWithAppName:appId:languageDesired:

Undocumented

Objective-C

- (instancetype)initWithAppName:(NSString *)appName appId:(NSString *)appId languageDesired:(SDLLanguage)languageDesired;

Swift

init(appName: String, appId: String, languageDesired: SDLLanguage)

-initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:

Undocumented

Objective-C

- (instancetype)initWithAppName:(NSString *)appName appId:(NSString *)appId languageDesired:(SDLLanguage)languageDesired isMediaApp:(BOOL)isMediaApp appTypes:(NSArray<SDLAppHMIType> *)appTypes shortAppName:(nullable NSString *)shortAppName;

Swift

init(appName: String, appId: String, languageDesired: SDLLanguage, isMediaApp: Bool, appTypes: [SDLAppHMIType], shortAppName: String?)

-initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:

Undocumented

Objective-C

- (instancetype)initWithAppName:(NSString *)appName appId:(NSString *)appId languageDesired:(SDLLanguage)languageDesired isMediaApp:(BOOL)isMediaApp appTypes:(NSArray<SDLAppHMIType> *)appTypes shortAppName:(nullable NSString *)shortAppName ttsName:(nullable NSArray<SDLTTSChunk *> *)ttsName vrSynonyms:(nullable NSArray<NSString *> *)vrSynonyms hmiDisplayLanguageDesired:(SDLLanguage)hmiDisplayLanguageDesired resumeHash:(nullable NSString *)resumeHash;

Swift

init(appName: String, appId: String, languageDesired: SDLLanguage, isMediaApp: Bool, appTypes: [SDLAppHMIType], shortAppName: String?, ttsName: [SDLTTSChunk]?, vrSynonyms: [String]?, hmiDisplayLanguageDesired: SDLLanguage, resumeHash: String?)

syncMsgVersion

The version of the SDL interface

Required

Objective-C

@property (readwrite, strong, nonatomic)
    SDLSyncMsgVersion *_Nonnull syncMsgVersion;

Swift

var syncMsgVersion: SDLSyncMsgVersion { get set }

appName

The Mobile Application’s Name, This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SmartDeviceLink

@discussion

  • Needs to be unique over all applications.
  • May not be empty.
  • May not start with a new line character.
  • May not interfere with any name or synonym of previously registered applications and any predefined blacklist of words (global commands).
  • Needs to be unique over all applications. Applications with the same name will be rejected.
  • Required, Max length 100 chars

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nonnull appName;

    Swift

    var appName: String { get set }

    ttsName

    TTS string for VR recognition of the mobile application name.

    @discussion Meant to overcome any failing on speech engine in properly pronouncing / understanding app name.

  • Needs to be unique over all applications.
  • May not be empty.
  • May not start with a new line character.
  • Optional, Array of SDLTTSChunk, Array size 1 - 100

    @since SDL 2.0

    See

    SDLTTSChunk

    Objective-C

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

    Swift

    var ttsName: [SDLTTSChunk]? { get set }

    ngnMediaScreenAppName

    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

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
        NSString *ngnMediaScreenAppName;

    Swift

    var ngnMediaScreenAppName: String? { get set }

    vrSynonyms

    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

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
        NSArray<NSString *> *vrSynonyms;

    Swift

    var vrSynonyms: [String]? { get set }

    isMediaApplication

    Indicates if the application is a media or a non-media application.

    @discussion Only media applications will be able to stream audio to head units that is audible outside of the BT media source.

    Required, Boolean

    Objective-C

    @property (readwrite, strong, nonatomic)
        NSNumber<SDLBool> *_Nonnull isMediaApplication;

    Swift

    var isMediaApplication: NSNumber & SDLBool { get set }

    languageDesired

    A Language enumeration indicating what language the application intends to use for user interaction (TTS and VR).

    @discussion If there is a mismatch with the head unit, the app will be able to change this registration with changeRegistration prior to app being brought into focus.

    Required

    Objective-C

    @property (readwrite, strong, nonatomic) SDLLanguage _Nonnull languageDesired;

    Swift

    var languageDesired: SDLLanguage { get set }

    hmiDisplayLanguageDesired

    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

    Objective-C

    @property (readwrite, strong, nonatomic)
        SDLLanguage _Nonnull hmiDisplayLanguageDesired;

    Swift

    var hmiDisplayLanguageDesired: SDLLanguage { get set }

    appHMIType

    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

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
        NSArray<SDLAppHMIType> *appHMIType;

    Swift

    var appHMIType: [SDLAppHMIType]? { get set }

    hashID

    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

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSString *hashID;

    Swift

    var hashID: String? { get set }

    deviceInfo

    Information about the connecting device

    Optional

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) SDLDeviceInfo *deviceInfo;

    Swift

    var deviceInfo: SDLDeviceInfo? { get set }

    appID

    ID used to validate app with policy table entries

    Required, max length 100

    @since SDL 2.0

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nonnull appID;

    Swift

    var appID: String { get set }

    appInfo

    Information about the application running

    Optional

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) SDLAppInfo *appInfo;

    Swift

    var appInfo: SDLAppInfo? { get set }
    View on GitHub.com
    Previous Section Next Section