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 newly allocated SDLChangeRegistration object with required parameters
- (nonnull instancetype)initWithLanguage:(nonnull SDLLanguage)language
hmiDisplayLanguage:
(nonnull SDLLanguage)hmiDisplayLanguage;
init(language: SDLLanguage, hmiDisplayLanguage: SDLLanguage)
the name of the button
the module where the button should be pressed
An instance of the SDLChangeRegistration class.
Constructs a newly allocated SDLChangeRegistration object with all parameters
- (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;
init(language: SDLLanguage, hmiDisplayLanguage: SDLLanguage, appName: String?, ttsName: [SDLTTSChunk]?, ngnMediaScreenAppName: String?, vrSynonyms: [String]?)
the language the app wants to change to
HMI display language
request a new app name registration
request a new TTSName registration
request a new app short name registration
request a new VR synonyms registration
An instance of the SDLChangeRegistration class.
The language the app wants to change to
@property (nonatomic, strong) SDLLanguage _Nonnull language;
var language: SDLLanguage { get set }
HMI display language
@property (nonatomic, strong) SDLLanguage _Nonnull hmiDisplayLanguage;
var hmiDisplayLanguage: SDLLanguage { get set }
Request a new app name registration
Optional, Max string length 100 chars
@property (nonatomic, copy, nullable) NSString *appName;
var appName: String? { get set }
Request a new TTSName registration.
Optional, Array of SDLTTSChunk, 1 - 100 elements
@property (nonatomic, copy, nullable) NSArray<SDLTTSChunk *> *ttsName;
var ttsName: [SDLTTSChunk]? { get set }
Request a new app short name registration
Optional, Max string length 100 chars
@property (nonatomic, copy, nullable) 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 (nonatomic, copy, nullable) NSArray<NSString *> *vrSynonyms;
var vrSynonyms: [String]? { get set }