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

SDLChangeRegistration Class Reference

Section Contents

Overview

If the app recognizes during the app registration that the SDL HMI language (voice/TTS and/or display) does not match the app language, the app will be able (but does not need) to change this registration with changeRegistration prior to app being brought into focus.

Any HMILevel allowed

@since SDL 2.0

-initWithLanguage:hmiDisplayLanguage:

Constructs a newly allocated SDLChangeRegistration object with required parameters

Objective-C

- (nonnull instancetype)initWithLanguage:(nonnull SDLLanguage)language
                      hmiDisplayLanguage:
                          (nonnull SDLLanguage)hmiDisplayLanguage;

Swift

init(language: SDLLanguage, hmiDisplayLanguage: SDLLanguage)

Parameters

language

the name of the button

hmiDisplayLanguage

the module where the button should be pressed

Return Value

An instance of the SDLChangeRegistration class.

-initWithLanguage:hmiDisplayLanguage:appName:ttsName:ngnMediaScreenAppName:vrSynonyms:

Constructs a newly allocated SDLChangeRegistration object with all parameters

Objective-C

- (nonnull instancetype)
         initWithLanguage:(nonnull SDLLanguage)language
       hmiDisplayLanguage:(nonnull SDLLanguage)hmiDisplayLanguage
                  appName:(nullable NSString *)appName
                  ttsName:(nullable NSArray<SDLTTSChunk *> *)ttsName
    ngnMediaScreenAppName:(nullable NSString *)ngnMediaScreenAppName
               vrSynonyms:(nullable NSArray<NSString *> *)vrSynonyms;

Swift

init(language: SDLLanguage, hmiDisplayLanguage: SDLLanguage, appName: String?, ttsName: [SDLTTSChunk]?, ngnMediaScreenAppName: String?, vrSynonyms: [String]?)

Parameters

language

the language the app wants to change to

hmiDisplayLanguage

HMI display language

appName

request a new app name registration

ttsName

request a new TTSName registration

ngnMediaScreenAppName

request a new app short name registration

vrSynonyms

request a new VR synonyms registration

Return Value

An instance of the SDLChangeRegistration class.

language

The language the app wants to change to

Objective-C

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

Swift

var language: SDLLanguage { get set }

hmiDisplayLanguage

HMI display language

Objective-C

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

Swift

var hmiDisplayLanguage: SDLLanguage { get set }

appName

Request a new app name registration

Optional, Max string length 100 chars

Objective-C

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

Swift

var appName: String? { get set }

ttsName

Request a new TTSName registration.

Optional, Array of SDLTTSChunk, 1 - 100 elements

Objective-C

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

Swift

var ttsName: [SDLTTSChunk]? { get set }

ngnMediaScreenAppName

Request a new app short name registration

Optional, Max string length 100 chars

Objective-C

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

Swift

var ngnMediaScreenAppName: String? { get set }

vrSynonyms

Request a new VR synonyms registration

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

Objective-C

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

Swift

var vrSynonyms: [String]? { get set }
View on GitHub.com
Previous Section Next Section