TvInfo API

To use Samsung Product API,
<script type="text/javascript" src="$WEBAPIS/webapis/webapis.js"></script>
Should be loaded in index.html

This module defines the device settings value functionalities provided by the Tizen Samsung Product API.

Since : 2.3

Product : TV, AV, B2B

Summary of Interfaces and Methods

Interface	Method
TvInfoManagerObject
TvInfoManager	DOMString getVersion(); TvInfoMenuValue getMenuValue(TvInfoMenuKey key); void setMenuValue(TvInfoMenuKey key, TvInfoMenuValue value, optional SuccessCallback? onsuccess, optional ErrorCallback? onerror); unsigned long addCaptionChangeListener(TvInfoMenuKey key, TvInfoCaptionChangeCallback listener); void removeCaptionChangeListener(unsigned long listenerId); boolean isTvsPicSizeResized(); Any getTvInfoValue(TvInfoKey key); void showCaption(boolean show); void registerInAppCaptionControl(boolean status);
TvInfoCaptionChangeCallback	void onchange(TvInfoMenuKey key);
TvInfoChangeCallback	void onchange(TvInfoKey key);
TvInfoMenuKey
TvInfoMenuValue
TvInfoKey
TvInfoValue

1. Interfaces

1.1 TvInfoManagerObject

Defines a WebApi object instance of the Tizen Samsung Product API.
The webapis.tvinfo object enables access to TvInfo API functionality.

[NoInterfaceObject] interface TvInfoManagerObject {
  readonly attribute TvInfoManager tvinfo;
};

WebApi implements TvInfoManagerObject;

Attributes

readonly TvInfoManager tvinfo
TvInfo API namespace

1.2 TvInfoManager

Provides methods for TvInfo functionalities.

[NoInterfaceObject] interface TvInfoManager {
  attribute TvInfoMenuKey TvInfoMenuKey;
  attribute TvInfoMenuValue TvInfoMenuValue;
  attribute TvInfoKey TvInfoKey;
  attribute TvInfoValue TvInfoValue;

  DOMString getVersion();
  TvInfoMenuValue getMenuValue(TvInfoMenuKey key);
  void setMenuValue(TvInfoMenuKey key, TvInfoMenuValue value, optional SuccessCallback? onsuccess, optional ErrorCallback? onerror);
  unsigned long addCaptionChangeListener(TvInfoMenuKey key, TvInfoCaptionChangeCallback listener);
  void removeCaptionChangeListener(unsigned long listenerId);
  boolean isTvsPicSizeResized();
  Any getTvInfoValue(TvInfoKey key);
  void showCaption(boolean show);
  void registerInAppCaptionControl(boolean status);
};

Attributes

TvInfoMenuKey TvInfoMenuKey
Caption settings key
TvInfoMenuValue TvInfoMenuValue
Device menu settings value
TvInfoKey TvInfoKey
Device information key
TvInfoValue TvInfoValue
Device information value

Methods

getVersion

Retrieves the plugin version number.

DOMString getVersion();

Product : TV, AV, B2B

Return Value :

DOMString : Plugin version

Since : 2.3

Code Example :

try {
  var value = webapis.tvinfo.getVersion();
  console.log("version value = " + value);
} catch (error) {
  console.log("error code = " + error.code);
}

getMenuValue

Retrieves the specified caption or subtitle menu key value.

TvInfoMenuValue getMenuValue(TvInfoMenuKey key);

Product : TV, AV, B2B

Parameters :

key : Caption or subtitle menu key

Return Value :

TvInfoMenuValue : Key value

Exceptions :

WebAPIException
- with error type TypeMismatchError, if an input parameter is not compatible with its expected type.

Since : 2.3

Code Example :

try {
  var value = webapis.tvinfo.getMenuValue(webapis.tvinfo.TvInfoMenuKey.CAPTION_ONOFF_KEY);
  console.log("menu value = " + value);
} catch (error) {
  console.log("error code = " + error.code);
}

setMenuValue

Sets the specified device menu key value.

void setMenuValue(TvInfoMenuKey key, TvInfoMenuValue value, optional SuccessCallback? onsuccess, optional ErrorCallback? onerror);

Product : B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/tvinfo

Parameters :

key : Device menu key
value : Value to be set
onsuccess [optional][nullable] : Callback method to invoke when the device menu key value is successfully set
onerror [optional][nullable] : Callback method to invoke if an error occurs
SecurityError, if the application does not have the privilege to call this method.
NotSupportedError, if this feature is not supported.

Exceptions :

WebAPIException
- with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
- with error type InvalidValuesError, if any input parameter contains an invalid value. (Since plugin version 3.0)

Since : 3.0

Code Example :

function onsuccess(data)  {
  console.log("TvInfo Menu Value data = " + data);
}
function onerror(error)  {
  console.log("error code : " + error.code);
}
try {
  var key = webapis.tvinfo.TvInfoMenuKey.SUBTITLE_ONOFF_KEY;
  var value = webapis.tvinfo.TvInfoMenuValue.ON;
  webapis.tvinfo.setMenuValue(key, value, onsuccess, onerror);
} catch (error) {
  console.log("error code = " + error.code);
}

addCaptionChangeListener

Registers a caption menu change listener callback.

unsigned long addCaptionChangeListener(TvInfoMenuKey key, TvInfoCaptionChangeCallback listener);

Product : TV, AV, B2B

Parameters :

key : Caption menu key
listener : TvInfoCaptionChangeCallback listener

Return Value :

unsigned long : Listener ID

Exceptions :

WebAPIException
- with error type TypeMismatchError, if an input parameter is not compatible with its expected type.

Since : 2.3

Code Example :

var listener = function(key) {
  console.log("TVInfoCaptionChange");
}
try {
  var value = webapis.tvinfo.addCaptionChangeListener(webapis.tvinfo.TvInfoMenuKey.CAPTION_ONOFF_KEY, listener);
  console.log("listener id = " + value);
} catch (error) {
  console.log("error code = " + error.code);
}

removeCaptionChangeListener

Unregisters a caption menu change listener callback.

void removeCaptionChangeListener(unsigned long listenerId);

Product : TV, AV, B2B

Parameters :

listenerId : TvInfoCaptionChangeCallback ID

Exceptions :

WebAPIException
- with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
- with error type InvalidValuesError, if any input parameter contains an invalid value. (Since plugin version 3.0)

Since : 2.3

Code Example :

try {
  webapis.tvinfo.removeCaptionChangeListener(listenerId); // Listener ID defined by addCaptionChangeListener
  console.log("listener id = " + value);
} catch (error) {
  console.log("error code = " + error.code);
}

isTvsPicSizeResized

Checks whether the picture size has been resized.

boolean isTvsPicSizeResized();

Product : TV, AV, B2B

Return Value :

boolean : Boolean value:
true: Yes
false: No

Exceptions :

WebAPIException
- with error type NotSupportedError, if the device is a BD device.

Since : 2.3

Code Example :

try {
  var flag = webapis.tvinfo.isTvsPicSizeResized();
  console.log("flag = " + flag);
} catch (error) {
  console.log("error code = " + error.code);
}

getTvInfoValue

Retrieves the specified device information key value.

Any getTvInfoValue(TvInfoKey key);

Product : TV, AV, B2B

Parameters :

key : device information key

Return Value :

Any : Key value. The return value depends on which TvInfoKey is entered in the key.
The expected value list for each key is described in TvInfoKey.

Exceptions :

WebAPIException
- with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
- with error type InvalidStateError, if device is not connected.
- with error type NotSupportedError, if this feature is not supported.

Since : 2.3

Code Example :

try {
  var value = webapis.tvinfo.getTvInfoValue("SMART_RC_BATTERY");
  console.log("info value = " + value);
} catch (error) {
  console.log("error code = " + error.code);
}

showCaption

If captions are switched on in the device menu, controls the caption visibility state.
If captions are switched off in the device menu, captions are not shown even if the application calls showCaption(true).

void showCaption(boolean show);

Product : TV, AV, B2B

Parameters :

show : Boolean value

Exceptions :

WebAPIException
- with error type TypeMismatchError, if an input parameter is not compatible with its expected type.

Since : 2.3

Code Example :

try {
  webapis.tvinfo.showCaption(true);
} catch (error) {
  console.log("error code = " + error.code);
}

registerInAppCaptionControl

Enables controlling caption display dynamically from within the application.
The application gains full permission to show and hide the captions.
When the application launches or resumes, call registerInAppCaptionControl(true).
When the application is sent to the background or deactivated states, you must call registerInAppCaptionControl(false).

void registerInAppCaptionControl(boolean status);

Product : TV, AV, B2B

Parameters :

status : Enable or disable dynamic caption display control.

Exceptions :

WebAPIException
- with error type TypeMismatchError, if an input parameter is not compatible with its expected type.

Since : 2.3

Code Example :

try {
  webapis.tvinfo.registerInAppCaptionControl(true);
} catch (error) {
  console.log("error code = " + error.code);
}

1.3 TvInfoCaptionChangeCallback

Defines a listener for caption setting change notifications.

[Callback = FunctionOnly, NoInterfaceObject] interface TvInfoCaptionChangeCallback {
  void onchange(TvInfoMenuKey key);
};

Methods

onchange

Callback method for caption setting change notifications.

void onchange(TvInfoMenuKey key);

Product : TV, AV, B2B

Parameters :

key : TvInfoMenuValue value

Since : 2.3

Code Example :

var onchange = function (key){
  console.log(" changed caption setting is = " + key);
};

1.4 TvInfoChangeCallback

Defines a listener for device setting change notifications.

[Callback = FunctionOnly, NoInterfaceObject] interface TvInfoChangeCallback {
  void onchange(TvInfoKey key);
};

Methods

onchange

Callback method for device setting change notifications.

void onchange(TvInfoKey key);

Product : TV, AV, B2B

Parameters :

key : TvInfoKey value

Since : 2.3

Code Example :

var onchange = function (key){
  console.log(" changed setting is = " + key);
};

1.5 TvInfoMenuKey

Defines constants for caption settings keys.

[NoInterfaceObject] interface TvInfoMenuKey {
  const unsigned long CAPTION_ONOFF_KEY = 0;
  const unsigned long CAPTION_MODE_KEY = 1;
  const unsigned long CAPTION_FONT_SIZE_KEY = 2;
  const unsigned long CAPTION_FONT_STYLE_KEY = 3;
  const unsigned long CAPTION_FG_COLOR_KEY = 4;
  const unsigned long CAPTION_FG_OPACITY_KEY = 5;
  const unsigned long CAPTION_BG_COLOR_KEY = 6;
  const unsigned long CAPTION_BG_OPACITY_KEY = 7;
  const unsigned long CAPTION_EDGE_TYPE_KEY = 8;
  const unsigned long CAPTION_EDGE_COLOR_KEY = 9;
  const unsigned long CAPTION_WINDOW_COLOR_KEY = 10;
  const unsigned long CAPTION_WINDOW_OPACITY_KEY = 11;
  const unsigned long ACCESSIBILITY_FOCUS_ZOOM = 12;
  const unsigned long ACCESSIBILITY_HIGH_CONTRAST = 13;
  const unsigned long SMARTHUB_CHANNEL_BOUND_APPS_TICKER = 14;
  const unsigned long VOICE_GUIDE_KEY = 15;
  const unsigned long SUBTITLE_ONOFF_KEY = 16;
  const unsigned long SUBTITLE_MODE_KEY = 17;
  const unsigned long PRIMARY_AUDIO_LANGUAGE_KEY = 18;
  const unsigned long SECONDARY_AUDIO_LANGUAGE_KEY = 19;
  const unsigned long ACCESSIBILITY_VOICE_GUIDE_SPEED = 20;
  const unsigned long CAPTION_STYLE_KEY = 21;
  const DOMString UI_SIZE = "UI_SIZE";
  const DOMString UI_TRANSPARENCY = "UI_TRANSPARENCY";
};

Constants

CAPTION_ONOFF_KEY
Caption On/Off
expected value TvInfoMenuValue
unsigned long CAPTION_OFF = 0;
unsigned long CAPTION_ON = 1;
CAPTION_MODE_KEY
Caption mode. Default: Service 6
expected value TvInfoMenuValue
unsigned long CAPTION_MODE_DEFAULT = 0;
unsigned long CAPTION_MODE_SERVICE1 = 1;
unsigned long CAPTION_MODE_SERVICE2 = 2;
unsigned long CAPTION_MODE_SERVICE3 = 3;
unsigned long CAPTION_MODE_SERVICE4 = 4;
unsigned long CAPTION_MODE_SERVICE5 = 5;
unsigned long CAPTION_MODE_SERVICE6 = 6;
unsigned long CAPTION_MODE_CC1 = 7;
unsigned long CAPTION_MODE_CC2 = 8;
unsigned long CAPTION_MODE_CC3 = 9;
unsigned long CAPTION_MODE_CC4 = 10;
unsigned long CAPTION_MODE_TEXT1 = 11;
unsigned long CAPTION_MODE_TEXT2 = 12;
unsigned long CAPTION_MODE_TEXT3 = 13;
unsigned long CAPTION_MODE_TEXT4 = 14;
CAPTION_FONT_SIZE_KEY
Caption font size
expected value TvInfoMenuValue
unsigned long CAPTION_SIZE_DEFAULT = 0;
unsigned long CAPTION_SIZE_SMALL = 1;
unsigned long CAPTION_SIZE_STANDARD = 2;
unsigned long CAPTION_SIZE_LARGE = 3;
unsigned long CAPTION_SIZE_EXTRA_LARGE = 4;
CAPTION_FONT_STYLE_KEY
Caption font style. Default: Style 6
expected value TvInfoMenuValue
unsigned long CAPTION_FONT_DEFAULT = 0;
unsigned long CAPTION_FONT_STYLE0 = 1;
unsigned long CAPTION_FONT_STYLE1 = 2;
unsigned long CAPTION_FONT_STYLE2 = 3;
unsigned long CAPTION_FONT_STYLE3 = 4;
unsigned long CAPTION_FONT_STYLE4 = 5;
unsigned long CAPTION_FONT_STYLE5 = 6;
unsigned long CAPTION_FONT_STYLE6 = 7;
CAPTION_FG_COLOR_KEY
Caption text foreground color
expected value TvInfoMenuValue
unsigned long CAPTION_COLOR_DEFAULT = 0;
unsigned long CAPTION_COLOR_WHITE = 1;
unsigned long CAPTION_COLOR_BLACK = 2;
unsigned long CAPTION_COLOR_RED = 3;
unsigned long CAPTION_COLOR_GREEN = 4;
unsigned long CAPTION_COLOR_BLUE = 5;
unsigned long CAPTION_COLOR_YELLOW = 6;
unsigned long CAPTION_COLOR_MAGENTA = 7;
unsigned long CAPTION_COLOR_CYAN = 8;
CAPTION_FG_OPACITY_KEY
Caption text foreground opacity
expected value TvInfoMenuValue
unsigned long CAPTION_OPACITY_SOLID = 0;
unsigned long CAPTION_OPACITY_FLASH = 1;
unsigned long CAPTION_OPACITY_TRANSLUCENT = 2;
unsigned long CAPTION_OPACITY_TRANSPARENT = 3;
unsigned long CAPTION_OPACITY_DEFAULT = 4;
unsigned long CAPTION_OPACITY_HIGHLY_TRANSLUCENT = 5;
unsigned long CAPTION_OPACITY_SLIGHTLY_TRANSLUCENT = 6;
CAPTION_BG_COLOR_KEY
Caption text background color
expected value TvInfoMenuValue
unsigned long CAPTION_COLOR_DEFAULT = 0;
unsigned long CAPTION_COLOR_WHITE = 1;
unsigned long CAPTION_COLOR_BLACK = 2;
unsigned long CAPTION_COLOR_RED = 3;
unsigned long CAPTION_COLOR_GREEN = 4;
unsigned long CAPTION_COLOR_BLUE = 5;
unsigned long CAPTION_COLOR_YELLOW = 6;
unsigned long CAPTION_COLOR_MAGENTA = 7;
unsigned long CAPTION_COLOR_CYAN = 8;
CAPTION_BG_OPACITY_KEY
Caption text background opacity
expected value TvInfoMenuValue
unsigned long CAPTION_OPACITY_SOLID = 0;
unsigned long CAPTION_OPACITY_FLASH = 1;
unsigned long CAPTION_OPACITY_TRANSLUCENT = 2;
unsigned long CAPTION_OPACITY_TRANSPARENT = 3;
unsigned long CAPTION_OPACITY_DEFAULT = 4;
unsigned long CAPTION_OPACITY_HIGHLY_TRANSLUCENT = 5;
unsigned long CAPTION_OPACITY_SLIGHTLY_TRANSLUCENT = 6;
CAPTION_EDGE_TYPE_KEY
Caption text edge type
expected value TvInfoMenuValue
unsigned long CAPTION_EDGE_NONE = 0;
unsigned long CAPTION_EDGE_RAISED = 1;
unsigned long CAPTION_EDGE_DEPRESSED = 2;
unsigned long CAPTION_EDGE_UNIFORM = 3;
unsigned long CAPTION_EDGE_DROP_SHADOWED = 4;
CAPTION_EDGE_COLOR_KEY
Caption text edge color
expected value TvInfoMenuValue
unsigned long CAPTION_COLOR_DEFAULT = 0;
unsigned long CAPTION_COLOR_WHITE = 1;
unsigned long CAPTION_COLOR_BLACK = 2;
unsigned long CAPTION_COLOR_RED = 3;
unsigned long CAPTION_COLOR_GREEN = 4;
unsigned long CAPTION_COLOR_BLUE = 5;
unsigned long CAPTION_COLOR_YELLOW = 6;
unsigned long CAPTION_COLOR_MAGENTA = 7;
unsigned long CAPTION_COLOR_CYAN = 8;
CAPTION_WINDOW_COLOR_KEY
Caption text window color
expected value TvInfoMenuValue
unsigned long CAPTION_COLOR_DEFAULT = 0;
unsigned long CAPTION_COLOR_WHITE = 1;
unsigned long CAPTION_COLOR_BLACK = 2;
unsigned long CAPTION_COLOR_RED = 3;
unsigned long CAPTION_COLOR_GREEN = 4;
unsigned long CAPTION_COLOR_BLUE = 5;
unsigned long CAPTION_COLOR_YELLOW = 6;
unsigned long CAPTION_COLOR_MAGENTA = 7;
unsigned long CAPTION_COLOR_CYAN = 8;
CAPTION_WINDOW_OPACITY_KEY
Caption text window opacity
expected value TvInfoMenuValue
unsigned long CAPTION_OPACITY_SOLID = 0;
unsigned long CAPTION_OPACITY_FLASH = 1;
unsigned long CAPTION_OPACITY_TRANSLUCENT = 2;
unsigned long CAPTION_OPACITY_TRANSPARENT = 3;
unsigned long CAPTION_OPACITY_DEFAULT = 4;
unsigned long CAPTION_OPACITY_HIGHLY_TRANSLUCENT = 5;
unsigned long CAPTION_OPACITY_SLIGHTLY_TRANSLUCENT = 6;
ACCESSIBILITY_FOCUS_ZOOM
Focus zoom menu value
expected value TvInfoMenuValue
unsigned long OFF = 0;
unsigned long ON = 1;
ACCESSIBILITY_HIGH_CONTRAST
High Contrast menu value
expected value TvInfoMenuValue
unsigned long OFF = 0;
unsigned long ON = 1;
SMARTHUB_CHANNEL_BOUND_APPS_TICKER
Channel-bound apps ticker menu value
expected value DOMString
"OFF", "ON"
Since : 2.3
VOICE_GUIDE_KEY
Voice guide menu value
expected value TvInfoMenuValue
unsigned long OFF = 0;
unsigned long ON = 1;
SUBTITLE_ONOFF_KEY
Subtitles On/Off
expected value TvInfoMenuValue
unsigned long OFF = 0;
unsigned long ON = 1;
SUBTITLE_MODE_KEY
Subtitle mode
expected value TvInfoMenuValue
unsigned long SUBTITLE_NORMAL = 0;
unsigned long SUBTITLE_HEARING_IMMPEARED = 1;
PRIMARY_AUDIO_LANGUAGE_KEY
Primary Audio Language
expected value TvInfoMenuValue
DOMString AUDIO_LANGUAGE_CODE_AFR = "AFR";
DOMString AUDIO_LANGUAGE_CODE_AKA = "AKA";
DOMString AUDIO_LANGUAGE_CODE_AMH = "AMH";
DOMString AUDIO_LANGUAGE_CODE_ARA = "ARA";
DOMString AUDIO_LANGUAGE_CODE_ASM = "ASM";
DOMString AUDIO_LANGUAGE_CODE_BEN = "BEN";
DOMString AUDIO_LANGUAGE_CODE_BUL = "BUL";
DOMString AUDIO_LANGUAGE_CODE_CAT = "CAT";
DOMString AUDIO_LANGUAGE_CODE_CHI = "CHI";
DOMString AUDIO_LANGUAGE_CODE_CMN = "CMN";
DOMString AUDIO_LANGUAGE_CODE_CZE = "CZE";
DOMString AUDIO_LANGUAGE_CODE_DAG = "DAG";
DOMString AUDIO_LANGUAGE_CODE_DAN = "DAN";
DOMString AUDIO_LANGUAGE_CODE_DUT = "DUT";
DOMString AUDIO_LANGUAGE_CODE_ENG = "ENG";
DOMString AUDIO_LANGUAGE_CODE_EST = "EST";
DOMString AUDIO_LANGUAGE_CODE_EUS = "EUS";
DOMString AUDIO_LANGUAGE_CODE_EWE = "EWE";
DOMString AUDIO_LANGUAGE_CODE_FIN = "FIN";
DOMString AUDIO_LANGUAGE_CODE_FRE = "FRE";
DOMString AUDIO_LANGUAGE_CODE_GAA = "GAA";
DOMString AUDIO_LANGUAGE_CODE_GER = "GER";
DOMString AUDIO_LANGUAGE_CODE_GLA = "GLA";
DOMString AUDIO_LANGUAGE_CODE_GLG = "GLG";
DOMString AUDIO_LANGUAGE_CODE_GOS = "GOS";
DOMString AUDIO_LANGUAGE_CODE_GRE = "GRE";
DOMString AUDIO_LANGUAGE_CODE_GUJ = "GUJ";
DOMString AUDIO_LANGUAGE_CODE_HAU = "HAU";
DOMString AUDIO_LANGUAGE_CODE_HEB = "HEB";
DOMString AUDIO_LANGUAGE_CODE_HIN = "HIN";
DOMString AUDIO_LANGUAGE_CODE_HRV = "HRV";
DOMString AUDIO_LANGUAGE_CODE_HUN = "HUN";
DOMString AUDIO_LANGUAGE_CODE_IGB = "IGB";
DOMString AUDIO_LANGUAGE_CODE_IND = "IND";
DOMString AUDIO_LANGUAGE_CODE_IRI = "IRI";
DOMString AUDIO_LANGUAGE_CODE_ITA = "ITA";
DOMString AUDIO_LANGUAGE_CODE_JPN = "JPN";
DOMString AUDIO_LANGUAGE_CODE_KAN = "KAN";
DOMString AUDIO_LANGUAGE_CODE_KOK = "KOK";
DOMString AUDIO_LANGUAGE_CODE_KOR = "KOR";
DOMString AUDIO_LANGUAGE_CODE_LAV = "LAV";
DOMString AUDIO_LANGUAGE_CODE_LIT = "LIT";
DOMString AUDIO_LANGUAGE_CODE_MAL = "MAL";
DOMString AUDIO_LANGUAGE_CODE_MAO = "MAO";
DOMString AUDIO_LANGUAGE_CODE_MAR = "MAR";
DOMString AUDIO_LANGUAGE_CODE_MSA = "MSA";
DOMString AUDIO_LANGUAGE_CODE_NBL = "NBL";
DOMString AUDIO_LANGUAGE_CODE_NOR = "NOR";
DOMString AUDIO_LANGUAGE_CODE_NSO = "NSO";
DOMString AUDIO_LANGUAGE_CODE_NZI = "NZI";
DOMString AUDIO_LANGUAGE_CODE_ORI = "ORI";
DOMString AUDIO_LANGUAGE_CODE_PAN = "PAN";
DOMString AUDIO_LANGUAGE_CODE_PER = "PER";
DOMString AUDIO_LANGUAGE_CODE_POL = "POL";
DOMString AUDIO_LANGUAGE_CODE_POR = "POR";
DOMString AUDIO_LANGUAGE_CODE_QAA = "QAA";
DOMString AUDIO_LANGUAGE_CODE_QAB = "QAB";
DOMString AUDIO_LANGUAGE_CODE_QAC = "QAC";
DOMString AUDIO_LANGUAGE_CODE_ROM = "ROM";
DOMString AUDIO_LANGUAGE_CODE_RUS = "RUS";
DOMString AUDIO_LANGUAGE_CODE_SLK = "SLK";
DOMString AUDIO_LANGUAGE_CODE_SOT = "SOT";
DOMString AUDIO_LANGUAGE_CODE_SPA = "SPA";
DOMString AUDIO_LANGUAGE_CODE_SRP = "SRP";
DOMString AUDIO_LANGUAGE_CODE_SSW = "SSW";
DOMString AUDIO_LANGUAGE_CODE_SWA = "SWA";
DOMString AUDIO_LANGUAGE_CODE_SWE = "SWE";
DOMString AUDIO_LANGUAGE_CODE_TAM = "TAM";
DOMString AUDIO_LANGUAGE_CODE_TEL = "TEL";
DOMString AUDIO_LANGUAGE_CODE_THA = "THA";
DOMString AUDIO_LANGUAGE_CODE_TSN = "TSN";
DOMString AUDIO_LANGUAGE_CODE_TSO = "TSO";
DOMString AUDIO_LANGUAGE_CODE_TUR = "TUR";
DOMString AUDIO_LANGUAGE_CODE_TWI = "TWI";
DOMString AUDIO_LANGUAGE_CODE_UKR = "UKR";
DOMString AUDIO_LANGUAGE_CODE_VAL = "VAL";
DOMString AUDIO_LANGUAGE_CODE_VEN = "VEN";
DOMString AUDIO_LANGUAGE_CODE_VIE = "VIE";
DOMString AUDIO_LANGUAGE_CODE_WEL = "WEL";
DOMString AUDIO_LANGUAGE_CODE_XHO = "XHO";
DOMString AUDIO_LANGUAGE_CODE_XSM = "XSM";
DOMString AUDIO_LANGUAGE_CODE_YOR = "YOR";
DOMString AUDIO_LANGUAGE_CODE_YUE = "YUE";
DOMString AUDIO_LANGUAGE_CODE_ZHO = "ZHO";
DOMString AUDIO_LANGUAGE_CODE_ZUL = "ZUL";
Only the values that can be set in the menu can be set to webapi
SECONDARY_AUDIO_LANGUAGE_KEY
Secondary Audio Language
expected value TvInfoMenuValue
DOMString AUDIO_LANGUAGE_CODE_AFR = "AFR";
DOMString AUDIO_LANGUAGE_CODE_AKA = "AKA";
DOMString AUDIO_LANGUAGE_CODE_AMH = "AMH";
DOMString AUDIO_LANGUAGE_CODE_ARA = "ARA";
DOMString AUDIO_LANGUAGE_CODE_ASM = "ASM";
DOMString AUDIO_LANGUAGE_CODE_BEN = "BEN";
DOMString AUDIO_LANGUAGE_CODE_BUL = "BUL";
DOMString AUDIO_LANGUAGE_CODE_CAT = "CAT";
DOMString AUDIO_LANGUAGE_CODE_CHI = "CHI";
DOMString AUDIO_LANGUAGE_CODE_CMN = "CMN";
DOMString AUDIO_LANGUAGE_CODE_CZE = "CZE";
DOMString AUDIO_LANGUAGE_CODE_DAG = "DAG";
DOMString AUDIO_LANGUAGE_CODE_DAN = "DAN";
DOMString AUDIO_LANGUAGE_CODE_DUT = "DUT";
DOMString AUDIO_LANGUAGE_CODE_ENG = "ENG";
DOMString AUDIO_LANGUAGE_CODE_EST = "EST";
DOMString AUDIO_LANGUAGE_CODE_EUS = "EUS";
DOMString AUDIO_LANGUAGE_CODE_EWE = "EWE";
DOMString AUDIO_LANGUAGE_CODE_FIN = "FIN";
DOMString AUDIO_LANGUAGE_CODE_FRE = "FRE";
DOMString AUDIO_LANGUAGE_CODE_GAA = "GAA";
DOMString AUDIO_LANGUAGE_CODE_GER = "GER";
DOMString AUDIO_LANGUAGE_CODE_GLA = "GLA";
DOMString AUDIO_LANGUAGE_CODE_GLG = "GLG";
DOMString AUDIO_LANGUAGE_CODE_GOS = "GOS";
DOMString AUDIO_LANGUAGE_CODE_GRE = "GRE";
DOMString AUDIO_LANGUAGE_CODE_GUJ = "GUJ";
DOMString AUDIO_LANGUAGE_CODE_HAU = "HAU";
DOMString AUDIO_LANGUAGE_CODE_HEB = "HEB";
DOMString AUDIO_LANGUAGE_CODE_HIN = "HIN";
DOMString AUDIO_LANGUAGE_CODE_HRV = "HRV";
DOMString AUDIO_LANGUAGE_CODE_HUN = "HUN";
DOMString AUDIO_LANGUAGE_CODE_IGB = "IGB";
DOMString AUDIO_LANGUAGE_CODE_IND = "IND";
DOMString AUDIO_LANGUAGE_CODE_IRI = "IRI";
DOMString AUDIO_LANGUAGE_CODE_ITA = "ITA";
DOMString AUDIO_LANGUAGE_CODE_JPN = "JPN";
DOMString AUDIO_LANGUAGE_CODE_KAN = "KAN";
DOMString AUDIO_LANGUAGE_CODE_KOK = "KOK";
DOMString AUDIO_LANGUAGE_CODE_KOR = "KOR";
DOMString AUDIO_LANGUAGE_CODE_LAV = "LAV";
DOMString AUDIO_LANGUAGE_CODE_LIT = "LIT";
DOMString AUDIO_LANGUAGE_CODE_MAL = "MAL";
DOMString AUDIO_LANGUAGE_CODE_MAO = "MAO";
DOMString AUDIO_LANGUAGE_CODE_MAR = "MAR";
DOMString AUDIO_LANGUAGE_CODE_MSA = "MSA";
DOMString AUDIO_LANGUAGE_CODE_NBL = "NBL";
DOMString AUDIO_LANGUAGE_CODE_NOR = "NOR";
DOMString AUDIO_LANGUAGE_CODE_NSO = "NSO";
DOMString AUDIO_LANGUAGE_CODE_NZI = "NZI";
DOMString AUDIO_LANGUAGE_CODE_ORI = "ORI";
DOMString AUDIO_LANGUAGE_CODE_PAN = "PAN";
DOMString AUDIO_LANGUAGE_CODE_PER = "PER";
DOMString AUDIO_LANGUAGE_CODE_POL = "POL";
DOMString AUDIO_LANGUAGE_CODE_POR = "POR";
DOMString AUDIO_LANGUAGE_CODE_QAA = "QAA";
DOMString AUDIO_LANGUAGE_CODE_QAB = "QAB";
DOMString AUDIO_LANGUAGE_CODE_QAC = "QAC";
DOMString AUDIO_LANGUAGE_CODE_ROM = "ROM";
DOMString AUDIO_LANGUAGE_CODE_RUS = "RUS";
DOMString AUDIO_LANGUAGE_CODE_SLK = "SLK";
DOMString AUDIO_LANGUAGE_CODE_SOT = "SOT";
DOMString AUDIO_LANGUAGE_CODE_SPA = "SPA";
DOMString AUDIO_LANGUAGE_CODE_SRP = "SRP";
DOMString AUDIO_LANGUAGE_CODE_SSW = "SSW";
DOMString AUDIO_LANGUAGE_CODE_SWA = "SWA";
DOMString AUDIO_LANGUAGE_CODE_SWE = "SWE";
DOMString AUDIO_LANGUAGE_CODE_TAM = "TAM";
DOMString AUDIO_LANGUAGE_CODE_TEL = "TEL";
DOMString AUDIO_LANGUAGE_CODE_THA = "THA";
DOMString AUDIO_LANGUAGE_CODE_TSN = "TSN";
DOMString AUDIO_LANGUAGE_CODE_TSO = "TSO";
DOMString AUDIO_LANGUAGE_CODE_TUR = "TUR";
DOMString AUDIO_LANGUAGE_CODE_TWI = "TWI";
DOMString AUDIO_LANGUAGE_CODE_UKR = "UKR";
DOMString AUDIO_LANGUAGE_CODE_VAL = "VAL";
DOMString AUDIO_LANGUAGE_CODE_VEN = "VEN";
DOMString AUDIO_LANGUAGE_CODE_VIE = "VIE";
DOMString AUDIO_LANGUAGE_CODE_WEL = "WEL";
DOMString AUDIO_LANGUAGE_CODE_XHO = "XHO";
DOMString AUDIO_LANGUAGE_CODE_XSM = "XSM";
DOMString AUDIO_LANGUAGE_CODE_YOR = "YOR";
DOMString AUDIO_LANGUAGE_CODE_YUE = "YUE";
DOMString AUDIO_LANGUAGE_CODE_ZHO = "ZHO";
DOMString AUDIO_LANGUAGE_CODE_ZUL = "ZUL";
Only the values that can be set in the menu can be set to webapi
ACCESSIBILITY_VOICE_GUIDE_SPEED
voice guide speed
expected value TvInfoMenuValue
DOMString VOICEGUIDE_SPEED_VERY_FAST = "VERY_FAST";
DOMString VOICEGUIDE_SPEED_FAST = "FAST";
DOMString VOICEGUIDE_SPEED_NORMAL= "NORMAL";
DOMString VOICEGUIDE_SPEED_SLOW = "SLOW";
DOMString VOICEGUIDE_SPEED_VERY_SLOW = "VERY_SLOW";
CAPTION_STYLE_KEY
caption style
expected value TvInfoMenuValue
unsigned long CAPTION_STYLE_DEFAULT = 0;
unsigned long CAPTION_STYLE_BOLD = 1;
unsigned long CAPTION_STYLE_ITALIC = 2;
UI_SIZE
size of UI
UI_TRANSPARENCY
transparency level of UI

1.6 TvInfoMenuValue

Defines constants for device menu settings values.

[NoInterfaceObject] interface TvInfoMenuValue {
  const unsigned long OFF = 0;
  const unsigned long ON = 1;
  const unsigned long CAPTION_OFF = 0;
  const unsigned long CAPTION_ON = 1;
  const unsigned long CAPTION_MODE_DEFAULT = 0;
  const unsigned long CAPTION_MODE_SERVICE1 = 1;
  const unsigned long CAPTION_MODE_SERVICE2 = 2;
  const unsigned long CAPTION_MODE_SERVICE3 = 3;
  const unsigned long CAPTION_MODE_SERVICE4 = 4;
  const unsigned long CAPTION_MODE_SERVICE5 = 5;
  const unsigned long CAPTION_MODE_SERVICE6 = 6;
  const unsigned long CAPTION_MODE_CC1 = 7;
  const unsigned long CAPTION_MODE_CC2 = 8;
  const unsigned long CAPTION_MODE_CC3 = 9;
  const unsigned long CAPTION_MODE_CC4 = 10;
  const unsigned long CAPTION_MODE_TEXT1 = 11;
  const unsigned long CAPTION_MODE_TEXT2 = 12;
  const unsigned long CAPTION_MODE_TEXT3 = 13;
  const unsigned long CAPTION_MODE_TEXT4 = 14;
  const unsigned long CAPTION_SIZE_DEFAULT = 0;
  const unsigned long CAPTION_SIZE_SMALL = 1;
  const unsigned long CAPTION_SIZE_STANDARD = 2;
  const unsigned long CAPTION_SIZE_LARGE = 3;
  const unsigned long CAPTION_SIZE_EXTRA_LARGE = 4;
  const unsigned long CAPTION_FONT_DEFAULT = 0;
  const unsigned long CAPTION_FONT_STYLE0 = 1;
  const unsigned long CAPTION_FONT_STYLE1 = 2;
  const unsigned long CAPTION_FONT_STYLE2 = 3;
  const unsigned long CAPTION_FONT_STYLE3 = 4;
  const unsigned long CAPTION_FONT_STYLE4 = 5;
  const unsigned long CAPTION_FONT_STYLE5 = 6;
  const unsigned long CAPTION_FONT_STYLE6 = 7;
  const unsigned long CAPTION_COLOR_DEFAULT = 0;
  const unsigned long CAPTION_COLOR_WHITE = 1;
  const unsigned long CAPTION_COLOR_BLACK = 2;
  const unsigned long CAPTION_COLOR_RED = 3;
  const unsigned long CAPTION_COLOR_GREEN = 4;
  const unsigned long CAPTION_COLOR_BLUE = 5;
  const unsigned long CAPTION_COLOR_YELLOW = 6;
  const unsigned long CAPTION_COLOR_MAGENTA = 7;
  const unsigned long CAPTION_COLOR_CYAN = 8;
  const unsigned long CAPTION_OPACITY_SOLID = 0;
  const unsigned long CAPTION_OPACITY_FLASH = 1;
  const unsigned long CAPTION_OPACITY_TRANSLUCENT = 2;
  const unsigned long CAPTION_OPACITY_TRANSPARENT = 3;
  const unsigned long CAPTION_OPACITY_DEFAULT = 4;
  const unsigned long CAPTION_OPACITY_HIGHLY_TRANSLUCENT = 5;
  const unsigned long CAPTION_OPACITY_SLIGHTLY_TRANSLUCENT = 6;
  const unsigned long CAPTION_EDGE_NONE = 0;
  const unsigned long CAPTION_EDGE_RAISED = 1;
  const unsigned long CAPTION_EDGE_DEPRESSED = 2;
  const unsigned long CAPTION_EDGE_UNIFORM = 3;
  const unsigned long CAPTION_EDGE_DROP_SHADOWED = 4;
  const unsigned long SUBTITLE_NORMAL = 0;
  const unsigned long SUBTITLE_HEARING_IMMPEARED = 1;
  const DOMString AUDIO_LANGUAGE_CODE_AFR = "AFR";
  const DOMString AUDIO_LANGUAGE_CODE_AKA = "AKA";
  const DOMString AUDIO_LANGUAGE_CODE_AMH = "AMH";
  const DOMString AUDIO_LANGUAGE_CODE_ARA = "ARA";
  const DOMString AUDIO_LANGUAGE_CODE_ASM = "ASM";
  const DOMString AUDIO_LANGUAGE_CODE_BEN = "BEN";
  const DOMString AUDIO_LANGUAGE_CODE_BUL = "BUL";
  const DOMString AUDIO_LANGUAGE_CODE_CAT = "CAT";
  const DOMString AUDIO_LANGUAGE_CODE_CHI = "CHI";
  const DOMString AUDIO_LANGUAGE_CODE_CMN = "CMN";
  const DOMString AUDIO_LANGUAGE_CODE_CZE = "CZE";
  const DOMString AUDIO_LANGUAGE_CODE_DAG = "DAG";
  const DOMString AUDIO_LANGUAGE_CODE_DAN = "DAN";
  const DOMString AUDIO_LANGUAGE_CODE_DUT = "DUT";
  const DOMString AUDIO_LANGUAGE_CODE_ENG = "ENG";
  const DOMString AUDIO_LANGUAGE_CODE_EST = "EST";
  const DOMString AUDIO_LANGUAGE_CODE_EUS = "EUS";
  const DOMString AUDIO_LANGUAGE_CODE_EWE = "EWE";
  const DOMString AUDIO_LANGUAGE_CODE_FIN = "FIN";
  const DOMString AUDIO_LANGUAGE_CODE_FRE = "FRE";
  const DOMString AUDIO_LANGUAGE_CODE_GAA = "GAA";
  const DOMString AUDIO_LANGUAGE_CODE_GER = "GER";
  const DOMString AUDIO_LANGUAGE_CODE_GLA = "GLA";
  const DOMString AUDIO_LANGUAGE_CODE_GLG = "GLG";
  const DOMString AUDIO_LANGUAGE_CODE_GOS = "GOS";
  const DOMString AUDIO_LANGUAGE_CODE_GRE = "GRE";
  const DOMString AUDIO_LANGUAGE_CODE_GUJ = "GUJ";
  const DOMString AUDIO_LANGUAGE_CODE_HAU = "HAU";
  const DOMString AUDIO_LANGUAGE_CODE_HEB = "HEB";
  const DOMString AUDIO_LANGUAGE_CODE_HIN = "HIN";
  const DOMString AUDIO_LANGUAGE_CODE_HRV = "HRV";
  const DOMString AUDIO_LANGUAGE_CODE_HUN = "HUN";
  const DOMString AUDIO_LANGUAGE_CODE_IGB = "IGB";
  const DOMString AUDIO_LANGUAGE_CODE_IND = "IND";
  const DOMString AUDIO_LANGUAGE_CODE_IRI = "IRI";
  const DOMString AUDIO_LANGUAGE_CODE_ITA = "ITA";
  const DOMString AUDIO_LANGUAGE_CODE_JPN = "JPN";
  const DOMString AUDIO_LANGUAGE_CODE_KAN = "KAN";
  const DOMString AUDIO_LANGUAGE_CODE_KOK = "KOK";
  const DOMString AUDIO_LANGUAGE_CODE_KOR = "KOR";
  const DOMString AUDIO_LANGUAGE_CODE_LAV = "LAV";
  const DOMString AUDIO_LANGUAGE_CODE_LIT = "LIT";
  const DOMString AUDIO_LANGUAGE_CODE_MAL = "MAL";
  const DOMString AUDIO_LANGUAGE_CODE_MAO = "MAO";
  const DOMString AUDIO_LANGUAGE_CODE_MAR = "MAR";
  const DOMString AUDIO_LANGUAGE_CODE_MSA = "MSA";
  const DOMString AUDIO_LANGUAGE_CODE_NBL = "NBL";
  const DOMString AUDIO_LANGUAGE_CODE_NOR = "NOR";
  const DOMString AUDIO_LANGUAGE_CODE_NSO = "NSO";
  const DOMString AUDIO_LANGUAGE_CODE_NZI = "NZI";
  const DOMString AUDIO_LANGUAGE_CODE_ORI = "ORI";
  const DOMString AUDIO_LANGUAGE_CODE_PAN = "PAN";
  const DOMString AUDIO_LANGUAGE_CODE_PER = "PER";
  const DOMString AUDIO_LANGUAGE_CODE_POL = "POL";
  const DOMString AUDIO_LANGUAGE_CODE_POR = "POR";
  const DOMString AUDIO_LANGUAGE_CODE_QAA = "QAA";
  const DOMString AUDIO_LANGUAGE_CODE_QAB = "QAB";
  const DOMString AUDIO_LANGUAGE_CODE_QAC = "QAC";
  const DOMString AUDIO_LANGUAGE_CODE_ROM = "ROM";
  const DOMString AUDIO_LANGUAGE_CODE_RUS = "RUS";
  const DOMString AUDIO_LANGUAGE_CODE_SLK = "SLK";
  const DOMString AUDIO_LANGUAGE_CODE_SOT = "SOT";
  const DOMString AUDIO_LANGUAGE_CODE_SPA = "SPA";
  const DOMString AUDIO_LANGUAGE_CODE_SRP = "SRP";
  const DOMString AUDIO_LANGUAGE_CODE_SSW = "SSW";
  const DOMString AUDIO_LANGUAGE_CODE_SWA = "SWA";
  const DOMString AUDIO_LANGUAGE_CODE_SWE = "SWE";
  const DOMString AUDIO_LANGUAGE_CODE_TAM = "TAM";
  const DOMString AUDIO_LANGUAGE_CODE_TEL = "TEL";
  const DOMString AUDIO_LANGUAGE_CODE_THA = "THA";
  const DOMString AUDIO_LANGUAGE_CODE_TSN = "TSN";
  const DOMString AUDIO_LANGUAGE_CODE_TSO = "TSO";
  const DOMString AUDIO_LANGUAGE_CODE_TUR = "TUR";
  const DOMString AUDIO_LANGUAGE_CODE_TWI = "TWI";
  const DOMString AUDIO_LANGUAGE_CODE_UKR = "UKR";
  const DOMString AUDIO_LANGUAGE_CODE_VAL = "VAL";
  const DOMString AUDIO_LANGUAGE_CODE_VEN = "VEN";
  const DOMString AUDIO_LANGUAGE_CODE_VIE = "VIE";
  const DOMString AUDIO_LANGUAGE_CODE_WEL = "WEL";
  const DOMString AUDIO_LANGUAGE_CODE_XHO = "XHO";
  const DOMString AUDIO_LANGUAGE_CODE_XSM = "XSM";
  const DOMString AUDIO_LANGUAGE_CODE_YOR = "YOR";
  const DOMString AUDIO_LANGUAGE_CODE_YUE = "YUE";
  const DOMString AUDIO_LANGUAGE_CODE_ZHO = "ZHO";
  const DOMString AUDIO_LANGUAGE_CODE_ZUL = "ZUL";
  const DOMString VOICEGUIDE_SPEED_VERY_FAST = "VERY_FAST";
  const DOMString VOICEGUIDE_SPEED_FAST = "FAST";
  const DOMString VOICEGUIDE_SPEED_NORMAL = "NORMAL";
  const DOMString VOICEGUIDE_SPEED_SLOW = "SLOW";
  const DOMString VOICEGUIDE_SPEED_VERY_SLOW = "VERY_SLOW";
  const unsigned long CAPTION_STYLE_DEFAULT = 0;
  const unsigned long CAPTION_STYLE_BOLD = 1;
  const unsigned long CAPTION_STYLE_ITALIC = 2;
};

Constants

OFF
MenuValue Off
ON
MenuValue On
CAPTION_OFF
Caption Off
CAPTION_ON
Caption On
CAPTION_MODE_DEFAULT
Default Mode
CAPTION_MODE_SERVICE1
Service 1
CAPTION_MODE_SERVICE2
Service 2
CAPTION_MODE_SERVICE3
Service 3
CAPTION_MODE_SERVICE4
Service 4
CAPTION_MODE_SERVICE5
Service 5
CAPTION_MODE_SERVICE6
Service 6
CAPTION_MODE_CC1
English (KOR Localset)
CAPTION_MODE_CC2
Korean (KOR Localset)
CAPTION_MODE_CC3
US Localset only
CAPTION_MODE_CC4
US Localset only
CAPTION_MODE_TEXT1
Text 1
CAPTION_MODE_TEXT2
Text 2
CAPTION_MODE_TEXT3
Text 3
CAPTION_MODE_TEXT4
Text 4
CAPTION_SIZE_DEFAULT
Default
CAPTION_SIZE_SMALL
Small
CAPTION_SIZE_STANDARD
Standard
CAPTION_SIZE_LARGE
Large
CAPTION_SIZE_EXTRA_LARGE
Extra large
CAPTION_FONT_DEFAULT
Default
CAPTION_FONT_STYLE0
Style 0
CAPTION_FONT_STYLE1
Style 1
CAPTION_FONT_STYLE2
Style 2
CAPTION_FONT_STYLE3
Style 3
CAPTION_FONT_STYLE4
Style 4
CAPTION_FONT_STYLE5
Style 5
CAPTION_FONT_STYLE6
Style 6
CAPTION_COLOR_DEFAULT
Default
CAPTION_COLOR_WHITE
White
CAPTION_COLOR_BLACK
Black
CAPTION_COLOR_RED
Red
CAPTION_COLOR_GREEN
Green
CAPTION_COLOR_BLUE
Blue
CAPTION_COLOR_YELLOW
Yellow
CAPTION_COLOR_MAGENTA
Magenta
CAPTION_COLOR_CYAN
Cyan
CAPTION_OPACITY_SOLID
Solid
CAPTION_OPACITY_FLASH
Flashing
CAPTION_OPACITY_TRANSLUCENT
Translucent
CAPTION_OPACITY_TRANSPARENT
Transparent
CAPTION_OPACITY_DEFAULT
Default
CAPTION_OPACITY_HIGHLY_TRANSLUCENT
Highly translucent
CAPTION_OPACITY_SLIGHTLY_TRANSLUCENT
Slightly translucent
CAPTION_EDGE_NONE
No edge
CAPTION_EDGE_RAISED
Raised
CAPTION_EDGE_DEPRESSED
Depressed
CAPTION_EDGE_UNIFORM
Uniform
CAPTION_EDGE_DROP_SHADOWED
Drop shadow
SUBTITLE_NORMAL
Normal subtitles
SUBTITLE_HEARING_IMMPEARED
Subtitles for the hearing-immpeared
AUDIO_LANGUAGE_CODE_AFR
Afrikaans voice mode
AUDIO_LANGUAGE_CODE_AKA
Akan voice mode
AUDIO_LANGUAGE_CODE_AMH
Amharic voice mode
AUDIO_LANGUAGE_CODE_ARA
Arab voice mode
AUDIO_LANGUAGE_CODE_ASM
India-Assamese voice mode
AUDIO_LANGUAGE_CODE_BEN
India-Bengali voice mode
AUDIO_LANGUAGE_CODE_BUL
Bulgarian voice mode
AUDIO_LANGUAGE_CODE_CAT
catala voice mode
AUDIO_LANGUAGE_CODE_CHI
Chinese voice mode
AUDIO_LANGUAGE_CODE_CMN
Chinese (Mandarin) voice mode
AUDIO_LANGUAGE_CODE_CZE
Czech voice mode
AUDIO_LANGUAGE_CODE_DAG
Ghana-Dagbani voice mode
AUDIO_LANGUAGE_CODE_DAN
Danish voice mode
AUDIO_LANGUAGE_CODE_DUT
Dutch voice mode
AUDIO_LANGUAGE_CODE_ENG
English voice mode
AUDIO_LANGUAGE_CODE_EST
Estonia voice mode
AUDIO_LANGUAGE_CODE_EUS
basque voice mode
AUDIO_LANGUAGE_CODE_EWE
Ewe voice mode
AUDIO_LANGUAGE_CODE_FIN
Finnish voice mode
AUDIO_LANGUAGE_CODE_FRE
French voice mode
AUDIO_LANGUAGE_CODE_GAA
Gaa voice mode
AUDIO_LANGUAGE_CODE_GER
German voice mode
AUDIO_LANGUAGE_CODE_GLA
Gaelic voice mode
AUDIO_LANGUAGE_CODE_GLG
Galician voice mode
AUDIO_LANGUAGE_CODE_GOS
Netherlands private code
AUDIO_LANGUAGE_CODE_GRE
Greek voice mode
AUDIO_LANGUAGE_CODE_GUJ
India-Gujarati voice mode
AUDIO_LANGUAGE_CODE_HAU
Hausa voice mode
AUDIO_LANGUAGE_CODE_HEB
Hebrew voice mode
AUDIO_LANGUAGE_CODE_HIN
Hindi voice mode
AUDIO_LANGUAGE_CODE_HRV
Croatian voice mode
AUDIO_LANGUAGE_CODE_HUN
Hungarian voice mode
AUDIO_LANGUAGE_CODE_IGB
Igbo voice mode
AUDIO_LANGUAGE_CODE_IND
Indonesia voice mode
AUDIO_LANGUAGE_CODE_IRI
Irish voice mode
AUDIO_LANGUAGE_CODE_ITA
Italian voice mode
AUDIO_LANGUAGE_CODE_JPN
Japanes voice mode
AUDIO_LANGUAGE_CODE_KAN
India-Kannada voice mode
AUDIO_LANGUAGE_CODE_KOK
India-Kokani voice mode
AUDIO_LANGUAGE_CODE_KOR
Korean voice mode
AUDIO_LANGUAGE_CODE_LAV
Latvian voice mode
AUDIO_LANGUAGE_CODE_LIT
Lithuanian voice mode
AUDIO_LANGUAGE_CODE_MAL
India-Malayalam voice mode
AUDIO_LANGUAGE_CODE_MAO
Maori voice mode
AUDIO_LANGUAGE_CODE_MAR
AUDIO_LANGUAGE_CODE_MSA
India-Marathi voice mode
AUDIO_LANGUAGE_CODE_NBL
Ndebele voice mode
AUDIO_LANGUAGE_CODE_NOR
Norwegian voice mode
AUDIO_LANGUAGE_CODE_NSO
Sotho, Northern voice mode
AUDIO_LANGUAGE_CODE_NZI
Nzema voice mode
AUDIO_LANGUAGE_CODE_ORI
India-Oriya voice mode
AUDIO_LANGUAGE_CODE_PAN
India-Punjabi voice mode
AUDIO_LANGUAGE_CODE_PER
Persisian voice mode
AUDIO_LANGUAGE_CODE_POL
Polish voice mode
AUDIO_LANGUAGE_CODE_POR
Portuguese voice mode
AUDIO_LANGUAGE_CODE_QAA
Singapore preffered audio.
AUDIO_LANGUAGE_CODE_QAB
Singapore secondary audio.
AUDIO_LANGUAGE_CODE_QAC
Singapore third audio
AUDIO_LANGUAGE_CODE_ROM
Rumanian voice mode
AUDIO_LANGUAGE_CODE_RUS
Russian voice mode
AUDIO_LANGUAGE_CODE_SLK
Slovakia voice mode
AUDIO_LANGUAGE_CODE_SOT
Sotho, Southern voice mode
AUDIO_LANGUAGE_CODE_SPA
Spanish voice mode
AUDIO_LANGUAGE_CODE_SRP
Serbian voice mode
AUDIO_LANGUAGE_CODE_SSW
Swati voice mode
AUDIO_LANGUAGE_CODE_SWA
Swahili voice mode
AUDIO_LANGUAGE_CODE_SWE
Swedish voice mode
AUDIO_LANGUAGE_CODE_TAM
tamil voice mode
AUDIO_LANGUAGE_CODE_TEL
India-Telugu voice mode
AUDIO_LANGUAGE_CODE_THA
Thai voice mode
AUDIO_LANGUAGE_CODE_TSN
Thai voice mode
AUDIO_LANGUAGE_CODE_TSO
Tsonga voice mode
AUDIO_LANGUAGE_CODE_TUR
Turkish voice mode
AUDIO_LANGUAGE_CODE_TWI
Twi voice mode
AUDIO_LANGUAGE_CODE_UKR
Ukraine voice mode
AUDIO_LANGUAGE_CODE_VAL
valencia voice mode
AUDIO_LANGUAGE_CODE_VEN
Venda voice mode
AUDIO_LANGUAGE_CODE_VIE
Vietnamese voice mode
AUDIO_LANGUAGE_CODE_WEL
Welsh voice mode
AUDIO_LANGUAGE_CODE_XHO
Xhosa voice mode
AUDIO_LANGUAGE_CODE_XSM
Ghana-Kasem voice mode
AUDIO_LANGUAGE_CODE_YOR
Yoruba voice mode
AUDIO_LANGUAGE_CODE_YUE
Chinese (Cantonese) voice mode
AUDIO_LANGUAGE_CODE_ZHO
Malaysia-Chinense voice mode
AUDIO_LANGUAGE_CODE_ZUL
Zulu voice mode
VOICEGUIDE_SPEED_VERY_FAST
voice guide speed
VOICEGUIDE_SPEED_FAST
voice guide speed
VOICEGUIDE_SPEED_NORMAL
voice guide speed
VOICEGUIDE_SPEED_SLOW
voice guide speed
VOICEGUIDE_SPEED_VERY_SLOW
voice guide speed
CAPTION_STYLE_DEFAULT
caption style
CAPTION_STYLE_BOLD
caption style
CAPTION_STYLE_ITALIC
caption style

1.7 TvInfoKey

Defines constants for device information keys.

[NoInterfaceObject] interface TvInfoKey {
  const DOMString SMART_RC_BATTERY = "SMART_RC_BATTERY";
  const DOMString BOARD_TEMPERATURE = "BOARD_TEMPERATURE";
};

Constants

SMART_RC_BATTERY
remaining battery capacity for smart remote (unit %)
readonly, unchangeable, return long, expected value range (0-100)
Since : 6.5
BOARD_TEMPERATURE
the current temperature of the board
readonly, unchangeable, return long
Since : 6.5

1.8 TvInfoValue

Defines constants for device information values.

[NoInterfaceObject] interface TvInfoValue {
  const unsigned long TV_VIEWER_BG_NOT_EXECUTABLE = 0;
  const unsigned long TV_VIEWER_BG_EXECUTABLE = 1;
};

Constants

TV_VIEWER_BG_NOT_EXECUTABLE
Background execution is not supported
TV_VIEWER_BG_EXECUTABLE
Background execution is supported

2. Full WebIDL

module TvInfo {
  [NoInterfaceObject] interface TvInfoManagerObject {
    readonly attribute TvInfoManager tvinfo;
  };

  WebApi implements TvInfoManagerObject;

  [NoInterfaceObject] interface TvInfoManager {
    attribute TvInfoMenuKey TvInfoMenuKey;
    attribute TvInfoMenuValue TvInfoMenuValue;
    attribute TvInfoKey TvInfoKey;
    attribute TvInfoValue TvInfoValue;
  
    DOMString getVersion();
    TvInfoMenuValue getMenuValue(TvInfoMenuKey key);
    void setMenuValue(TvInfoMenuKey key, TvInfoMenuValue value, optional SuccessCallback? onsuccess, optional ErrorCallback? onerror);
    unsigned long addCaptionChangeListener(TvInfoMenuKey key, TvInfoCaptionChangeCallback listener);
    void removeCaptionChangeListener(unsigned long listenerId);
    boolean isTvsPicSizeResized();
    Any getTvInfoValue(TvInfoKey key);
    void showCaption(boolean show);
    void registerInAppCaptionControl(boolean status);
  };

  [Callback = FunctionOnly, NoInterfaceObject] interface TvInfoCaptionChangeCallback {
    void onchange(TvInfoMenuKey key);
  };

  [Callback = FunctionOnly, NoInterfaceObject] interface TvInfoChangeCallback {
    void onchange(TvInfoKey key);
  };

  [NoInterfaceObject] interface TvInfoMenuKey {
    const unsigned long CAPTION_ONOFF_KEY = 0;
    const unsigned long CAPTION_MODE_KEY = 1;
    const unsigned long CAPTION_FONT_SIZE_KEY = 2;
    const unsigned long CAPTION_FONT_STYLE_KEY = 3;
    const unsigned long CAPTION_FG_COLOR_KEY = 4;
    const unsigned long CAPTION_FG_OPACITY_KEY = 5;
    const unsigned long CAPTION_BG_COLOR_KEY = 6;
    const unsigned long CAPTION_BG_OPACITY_KEY = 7;
    const unsigned long CAPTION_EDGE_TYPE_KEY = 8;
    const unsigned long CAPTION_EDGE_COLOR_KEY = 9;
    const unsigned long CAPTION_WINDOW_COLOR_KEY = 10;
    const unsigned long CAPTION_WINDOW_OPACITY_KEY = 11;
    const unsigned long ACCESSIBILITY_FOCUS_ZOOM = 12;
    const unsigned long ACCESSIBILITY_HIGH_CONTRAST = 13;
    const unsigned long SMARTHUB_CHANNEL_BOUND_APPS_TICKER = 14;
    const unsigned long VOICE_GUIDE_KEY = 15;
    const unsigned long SUBTITLE_ONOFF_KEY = 16;
    const unsigned long SUBTITLE_MODE_KEY = 17;
    const unsigned long PRIMARY_AUDIO_LANGUAGE_KEY = 18;
    const unsigned long SECONDARY_AUDIO_LANGUAGE_KEY = 19;
    const unsigned long ACCESSIBILITY_VOICE_GUIDE_SPEED = 20;
    const unsigned long CAPTION_STYLE_KEY = 21;
    const DOMString UI_SIZE = "UI_SIZE";
    const DOMString UI_TRANSPARENCY = "UI_TRANSPARENCY";
  };

  [NoInterfaceObject] interface TvInfoMenuValue {
    const unsigned long OFF = 0;
    const unsigned long ON = 1;
    const unsigned long CAPTION_OFF = 0;
    const unsigned long CAPTION_ON = 1;
    const unsigned long CAPTION_MODE_DEFAULT = 0;
    const unsigned long CAPTION_MODE_SERVICE1 = 1;
    const unsigned long CAPTION_MODE_SERVICE2 = 2;
    const unsigned long CAPTION_MODE_SERVICE3 = 3;
    const unsigned long CAPTION_MODE_SERVICE4 = 4;
    const unsigned long CAPTION_MODE_SERVICE5 = 5;
    const unsigned long CAPTION_MODE_SERVICE6 = 6;
    const unsigned long CAPTION_MODE_CC1 = 7;
    const unsigned long CAPTION_MODE_CC2 = 8;
    const unsigned long CAPTION_MODE_CC3 = 9;
    const unsigned long CAPTION_MODE_CC4 = 10;
    const unsigned long CAPTION_MODE_TEXT1 = 11;
    const unsigned long CAPTION_MODE_TEXT2 = 12;
    const unsigned long CAPTION_MODE_TEXT3 = 13;
    const unsigned long CAPTION_MODE_TEXT4 = 14;
    const unsigned long CAPTION_SIZE_DEFAULT = 0;
    const unsigned long CAPTION_SIZE_SMALL = 1;
    const unsigned long CAPTION_SIZE_STANDARD = 2;
    const unsigned long CAPTION_SIZE_LARGE = 3;
    const unsigned long CAPTION_SIZE_EXTRA_LARGE = 4;
    const unsigned long CAPTION_FONT_DEFAULT = 0;
    const unsigned long CAPTION_FONT_STYLE0 = 1;
    const unsigned long CAPTION_FONT_STYLE1 = 2;
    const unsigned long CAPTION_FONT_STYLE2 = 3;
    const unsigned long CAPTION_FONT_STYLE3 = 4;
    const unsigned long CAPTION_FONT_STYLE4 = 5;
    const unsigned long CAPTION_FONT_STYLE5 = 6;
    const unsigned long CAPTION_FONT_STYLE6 = 7;
    const unsigned long CAPTION_COLOR_DEFAULT = 0;
    const unsigned long CAPTION_COLOR_WHITE = 1;
    const unsigned long CAPTION_COLOR_BLACK = 2;
    const unsigned long CAPTION_COLOR_RED = 3;
    const unsigned long CAPTION_COLOR_GREEN = 4;
    const unsigned long CAPTION_COLOR_BLUE = 5;
    const unsigned long CAPTION_COLOR_YELLOW = 6;
    const unsigned long CAPTION_COLOR_MAGENTA = 7;
    const unsigned long CAPTION_COLOR_CYAN = 8;
    const unsigned long CAPTION_OPACITY_SOLID = 0;
    const unsigned long CAPTION_OPACITY_FLASH = 1;
    const unsigned long CAPTION_OPACITY_TRANSLUCENT = 2;
    const unsigned long CAPTION_OPACITY_TRANSPARENT = 3;
    const unsigned long CAPTION_OPACITY_DEFAULT = 4;
    const unsigned long CAPTION_OPACITY_HIGHLY_TRANSLUCENT = 5;
    const unsigned long CAPTION_OPACITY_SLIGHTLY_TRANSLUCENT = 6;
    const unsigned long CAPTION_EDGE_NONE = 0;
    const unsigned long CAPTION_EDGE_RAISED = 1;
    const unsigned long CAPTION_EDGE_DEPRESSED = 2;
    const unsigned long CAPTION_EDGE_UNIFORM = 3;
    const unsigned long CAPTION_EDGE_DROP_SHADOWED = 4;
    const unsigned long SUBTITLE_NORMAL = 0;
    const unsigned long SUBTITLE_HEARING_IMMPEARED = 1;
    const DOMString AUDIO_LANGUAGE_CODE_AFR = "AFR";
    const DOMString AUDIO_LANGUAGE_CODE_AKA = "AKA";
    const DOMString AUDIO_LANGUAGE_CODE_AMH = "AMH";
    const DOMString AUDIO_LANGUAGE_CODE_ARA = "ARA";
    const DOMString AUDIO_LANGUAGE_CODE_ASM = "ASM";
    const DOMString AUDIO_LANGUAGE_CODE_BEN = "BEN";
    const DOMString AUDIO_LANGUAGE_CODE_BUL = "BUL";
    const DOMString AUDIO_LANGUAGE_CODE_CAT = "CAT";
    const DOMString AUDIO_LANGUAGE_CODE_CHI = "CHI";
    const DOMString AUDIO_LANGUAGE_CODE_CMN = "CMN";
    const DOMString AUDIO_LANGUAGE_CODE_CZE = "CZE";
    const DOMString AUDIO_LANGUAGE_CODE_DAG = "DAG";
    const DOMString AUDIO_LANGUAGE_CODE_DAN = "DAN";
    const DOMString AUDIO_LANGUAGE_CODE_DUT = "DUT";
    const DOMString AUDIO_LANGUAGE_CODE_ENG = "ENG";
    const DOMString AUDIO_LANGUAGE_CODE_EST = "EST";
    const DOMString AUDIO_LANGUAGE_CODE_EUS = "EUS";
    const DOMString AUDIO_LANGUAGE_CODE_EWE = "EWE";
    const DOMString AUDIO_LANGUAGE_CODE_FIN = "FIN";
    const DOMString AUDIO_LANGUAGE_CODE_FRE = "FRE";
    const DOMString AUDIO_LANGUAGE_CODE_GAA = "GAA";
    const DOMString AUDIO_LANGUAGE_CODE_GER = "GER";
    const DOMString AUDIO_LANGUAGE_CODE_GLA = "GLA";
    const DOMString AUDIO_LANGUAGE_CODE_GLG = "GLG";
    const DOMString AUDIO_LANGUAGE_CODE_GOS = "GOS";
    const DOMString AUDIO_LANGUAGE_CODE_GRE = "GRE";
    const DOMString AUDIO_LANGUAGE_CODE_GUJ = "GUJ";
    const DOMString AUDIO_LANGUAGE_CODE_HAU = "HAU";
    const DOMString AUDIO_LANGUAGE_CODE_HEB = "HEB";
    const DOMString AUDIO_LANGUAGE_CODE_HIN = "HIN";
    const DOMString AUDIO_LANGUAGE_CODE_HRV = "HRV";
    const DOMString AUDIO_LANGUAGE_CODE_HUN = "HUN";
    const DOMString AUDIO_LANGUAGE_CODE_IGB = "IGB";
    const DOMString AUDIO_LANGUAGE_CODE_IND = "IND";
    const DOMString AUDIO_LANGUAGE_CODE_IRI = "IRI";
    const DOMString AUDIO_LANGUAGE_CODE_ITA = "ITA";
    const DOMString AUDIO_LANGUAGE_CODE_JPN = "JPN";
    const DOMString AUDIO_LANGUAGE_CODE_KAN = "KAN";
    const DOMString AUDIO_LANGUAGE_CODE_KOK = "KOK";
    const DOMString AUDIO_LANGUAGE_CODE_KOR = "KOR";
    const DOMString AUDIO_LANGUAGE_CODE_LAV = "LAV";
    const DOMString AUDIO_LANGUAGE_CODE_LIT = "LIT";
    const DOMString AUDIO_LANGUAGE_CODE_MAL = "MAL";
    const DOMString AUDIO_LANGUAGE_CODE_MAO = "MAO";
    const DOMString AUDIO_LANGUAGE_CODE_MAR = "MAR";
    const DOMString AUDIO_LANGUAGE_CODE_MSA = "MSA";
    const DOMString AUDIO_LANGUAGE_CODE_NBL = "NBL";
    const DOMString AUDIO_LANGUAGE_CODE_NOR = "NOR";
    const DOMString AUDIO_LANGUAGE_CODE_NSO = "NSO";
    const DOMString AUDIO_LANGUAGE_CODE_NZI = "NZI";
    const DOMString AUDIO_LANGUAGE_CODE_ORI = "ORI";
    const DOMString AUDIO_LANGUAGE_CODE_PAN = "PAN";
    const DOMString AUDIO_LANGUAGE_CODE_PER = "PER";
    const DOMString AUDIO_LANGUAGE_CODE_POL = "POL";
    const DOMString AUDIO_LANGUAGE_CODE_POR = "POR";
    const DOMString AUDIO_LANGUAGE_CODE_QAA = "QAA";
    const DOMString AUDIO_LANGUAGE_CODE_QAB = "QAB";
    const DOMString AUDIO_LANGUAGE_CODE_QAC = "QAC";
    const DOMString AUDIO_LANGUAGE_CODE_ROM = "ROM";
    const DOMString AUDIO_LANGUAGE_CODE_RUS = "RUS";
    const DOMString AUDIO_LANGUAGE_CODE_SLK = "SLK";
    const DOMString AUDIO_LANGUAGE_CODE_SOT = "SOT";
    const DOMString AUDIO_LANGUAGE_CODE_SPA = "SPA";
    const DOMString AUDIO_LANGUAGE_CODE_SRP = "SRP";
    const DOMString AUDIO_LANGUAGE_CODE_SSW = "SSW";
    const DOMString AUDIO_LANGUAGE_CODE_SWA = "SWA";
    const DOMString AUDIO_LANGUAGE_CODE_SWE = "SWE";
    const DOMString AUDIO_LANGUAGE_CODE_TAM = "TAM";
    const DOMString AUDIO_LANGUAGE_CODE_TEL = "TEL";
    const DOMString AUDIO_LANGUAGE_CODE_THA = "THA";
    const DOMString AUDIO_LANGUAGE_CODE_TSN = "TSN";
    const DOMString AUDIO_LANGUAGE_CODE_TSO = "TSO";
    const DOMString AUDIO_LANGUAGE_CODE_TUR = "TUR";
    const DOMString AUDIO_LANGUAGE_CODE_TWI = "TWI";
    const DOMString AUDIO_LANGUAGE_CODE_UKR = "UKR";
    const DOMString AUDIO_LANGUAGE_CODE_VAL = "VAL";
    const DOMString AUDIO_LANGUAGE_CODE_VEN = "VEN";
    const DOMString AUDIO_LANGUAGE_CODE_VIE = "VIE";
    const DOMString AUDIO_LANGUAGE_CODE_WEL = "WEL";
    const DOMString AUDIO_LANGUAGE_CODE_XHO = "XHO";
    const DOMString AUDIO_LANGUAGE_CODE_XSM = "XSM";
    const DOMString AUDIO_LANGUAGE_CODE_YOR = "YOR";
    const DOMString AUDIO_LANGUAGE_CODE_YUE = "YUE";
    const DOMString AUDIO_LANGUAGE_CODE_ZHO = "ZHO";
    const DOMString AUDIO_LANGUAGE_CODE_ZUL = "ZUL";
    const DOMString VOICEGUIDE_SPEED_VERY_FAST = "VERY_FAST";
    const DOMString VOICEGUIDE_SPEED_FAST = "FAST";
    const DOMString VOICEGUIDE_SPEED_NORMAL = "NORMAL";
    const DOMString VOICEGUIDE_SPEED_SLOW = "SLOW";
    const DOMString VOICEGUIDE_SPEED_VERY_SLOW = "VERY_SLOW";
    const unsigned long CAPTION_STYLE_DEFAULT = 0;
    const unsigned long CAPTION_STYLE_BOLD = 1;
    const unsigned long CAPTION_STYLE_ITALIC = 2;
  };

  [NoInterfaceObject] interface TvInfoKey {
    const DOMString SMART_RC_BATTERY = "SMART_RC_BATTERY";
    const DOMString BOARD_TEMPERATURE = "BOARD_TEMPERATURE";
  };

  [NoInterfaceObject] interface TvInfoValue {
    const unsigned long TV_VIEWER_BG_NOT_EXECUTABLE = 0;
    const unsigned long TV_VIEWER_BG_EXECUTABLE = 1;
  };

};

TvInfo API

Summary of Interfaces and Methods

1. Interfaces

1.1 TvInfoManagerObject

Attributes

1.2 TvInfoManager

Attributes

Methods

getVersion

getMenuValue

setMenuValue

addCaptionChangeListener

removeCaptionChangeListener

isTvsPicSizeResized

getTvInfoValue

showCaption

registerInAppCaptionControl

1.3 TvInfoCaptionChangeCallback

Methods

onchange

1.4 TvInfoChangeCallback

Methods

onchange

1.5 TvInfoMenuKey

Constants

1.6 TvInfoMenuValue

Constants

1.7 TvInfoKey

Constants

1.8 TvInfoValue

Constants

2. Full WebIDL

Manage Your Cookies

Essential Cookies

Analytical/Performance Cookies

Functionality Cookies

Advertising Cookies

Preferences Submitted