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

Class ChangeRegistration

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct
         com.smartdevicelink.proxy.RPCMessage
             com.smartdevicelink.proxy.RPCRequest

Package
com.smartdevicelink.proxy.rpc

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.

Function Group: Base

HMILevel can by any

Note:

SDL will send the language value confirmed to be supported by HMI via UI.GetCapabilities.

Parameter List

Name Type Description Req. Notes Version Available
Language Language Requested SDL voice engine (VR+TTS) language registration. Y SmartDeviceLink 2.0
hmiDisplayLanguage Language Request display language registration. Y Minvalue=0; Maxvalue=2000000000 SmartDeviceLink 2.0
appName String Request new app name registration N maxlength:100 SmartDeviceLink 2.0
ttsName TTSChunk Request new ttsName registration N minsize:1; maxsize:100 SmartDeviceLink 2.0
ngnMediaScreenAppName String Request new app short name registration N maxlength: 100 SmartDeviceLink 2.0
vrSynonyms String Request new VR synonyms registration N maxlength: 40; minsize:1; maxsize:100 SmartDeviceLink 2.0

Response

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

DISALLOWED

Fields

KEY_LANGUAGE

public static final java.lang.String KEY_LANGUAGE
Constant Value
"language"

KEY_HMI_DISPLAY_LANGUAGE

public static final java.lang.String KEY_HMI_DISPLAY_LANGUAGE
Constant Value
"hmiDisplayLanguage"

KEY_APP_NAME

public static final java.lang.String KEY_APP_NAME
Constant Value
"appName"

KEY_TTS_NAME

public static final java.lang.String KEY_TTS_NAME
Constant Value
"ttsName"

KEY_NGN_MEDIA_SCREEN_NAME

public static final java.lang.String KEY_NGN_MEDIA_SCREEN_NAME
Constant Value
"ngnMediaScreenAppName"

KEY_VR_SYNONYMS

public static final java.lang.String KEY_VR_SYNONYMS
Constant Value
"vrSynonyms"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCRequest onResponseListener
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

ChangeRegistration()

Constructs a new ChangeRegistration object

public ChangeRegistration()

ChangeRegistration( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new ChangeRegistration object indicated by the Hashtable parameter

public ChangeRegistration(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash
The Hashtable to use

ChangeRegistration( Language language, Language hmiDisplayLanguage )

Constructs a new ChangeRegistration object

public ChangeRegistration(Language language,Language hmiDisplayLanguage)

Parameters

language
a language value
hmiDisplayLanguage
a Language value

Methods

setLanguage( Language language )

Sets language

public void setLanguage(Language language)

Parameters

language
a language value

getLanguage()

Gets language

public com.smartdevicelink.proxy.rpc.enums.Language getLanguage()

setHmiDisplayLanguage( Language hmiDisplayLanguage )

Sets HMI display language

public void setHmiDisplayLanguage(Language hmiDisplayLanguage)

Parameters

hmiDisplayLanguage
a Language value

getHmiDisplayLanguage()

Gets HMI display language

public com.smartdevicelink.proxy.rpc.enums.Language getHmiDisplayLanguage()

setAppName( String appName )

Sets app name

public void setAppName(String appName)

Parameters

appName
App name to set

getAppName()

Gets app name

public java.lang.String getAppName()

setNgnMediaScreenAppName( String ngnAppName )

Sets NGN media screen app name

public void setNgnMediaScreenAppName(String ngnAppName)

Parameters

ngnAppName
The NGN app name

getNgnMediaScreenAppName()

Gets NGN media screen app name

public java.lang.String getNgnMediaScreenAppName()

setTtsName( java.util.List<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName )

Sets the TTS name

public void setTtsName(java.util.List<com.smartdevicelink.proxy.rpc.TTSChunk> ttsName)

Parameters

ttsName
The TTS name to set

getTtsName()

Gets the TTS name

public java.util.List getTtsName()

getVrSynonyms()

Gets the List representing the an array of 1-100 elements, each element containing a voice-recognition synonym

public java.util.List getVrSynonyms()

setVrSynonyms( java.util.List<java.lang.String> vrSynonyms )

Sets a vrSynonyms representing the an array of 1-100 elements, each element containing a voice-recognition synonym

public void setVrSynonyms(java.util.List<java.lang.String> vrSynonyms)

Parameters

vrSynonyms
a List value representing the an array of 1-100 elements

Notes:

  • Each vr synonym is limited to 40 characters, and there can be 1-100 synonyms in array
  • May not be the same (by case insensitive comparison) as the name or any synonym of any currently-registered application

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCRequest getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener
com.smartdevicelink.proxy.RPCMessage getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section