TVInputDevice API

Methods

getSupportedKeys

Retrieves the list of keys can be registered with the registerKey() method.

InputDeviceKey[] getSupportedKeys();
             

Since: 2.3

Mandatory keys will not be retrieved by this method.

Privilege level: public

Privilege: http://tizen.org/privilege/tv.inputdevice

Exceptions:

• WebAPIException

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type UnknownError in case of any error.

Code example:

 var i, keyCode = {}, supportedKeys;
 supportedKeys = tizen.tvinputdevice.getSupportedKeys();
 for (i = 0; i < supportedKeys.length; i++) {
     keyCode[supportedKeys[i].name] = supportedKeys[i].code;
 }
 if(keyCode.hasOwnProperty("ChannelUp")) {
     tizen.tvinputdevice.registerKey("ChannelUp");
 }
 window.addEventListener("keydown", function(keyEvent) {
     // identify the key by the numeric code from the keyEvent
     if(keyEvent.keyCode === keyCode.ChannelUp) {
         console.log("The CHANNEL UP was pressed");
     }
 });

 

getKey

Returns information about the key which has the given name.

InputDeviceKey? getKey(InputDeviceKeyName keyName);
             

Since: 2.3

Privilege level: public

Privilege: http://tizen.org/privilege/tv.inputdevice

Parameters:

• keyName: The name of the key to retrieve

Return value:

InputDeviceKey InputDeviceKey object for the given key name, or null if the key is not supported

Exceptions:

• WebAPIException

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type InvalidValuesError if the given keyName is invalid (e.g. name is empty string)

  • with error type UnknownError in any other error case.

registerKey

Registers an input device key to receive DOM keyboard event when it is pressed or released.

void registerKey(InputDeviceKeyName keyName);
             

Since: 2.3

When an application wants to react to the Input Device keys being pressed, it should register this key.

An application cannot register the mandatory keys (ArrowLeft, ArrowRight, ArrowUp, ArrowDown, Enter, Back).

Privilege level: public

Privilege: http://tizen.org/privilege/tv.inputdevice

Parameters:

• keyName: The name of the key which should generate DOM key events when pressed

Exceptions:

• WebAPIException

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type InvalidValuesError, if the given keyName is invalid or not supported (e.g. name is empty string).

  • with error type UnknownError in any other error case.

Code example:

 var keys = ["VolumeUp", "VolumeDown"], i;
 for (i = 0; i < keys.length; i++) {
     try {
         tizen.tvinputdevice.registerKey(keys[i]);
     } catch(error) {
         console.log("failed to register " + keys[i] + ": " + error);
     }
 }
 

unregisterKey

Unregisters an input device key.

void unregisterKey(InputDeviceKeyName keyName);
             

Since: 2.3

Privilege level: public

Privilege: http://tizen.org/privilege/tv.inputdevice

Parameters:

• keyName: The name of the key which should not be monitored any longer

Exceptions:

• WebAPIException

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type InvalidValuesError, if the given keyName is invalid or not supported (e.g. name is empty string).

  • with error type UnknownError in any error case.

Code example:

 tizen.tvinputdevice.unregisterKey("VolumeDown");
 

registerKeyBatch

Registers a batch of input device keys to receive DOM keyboard events when any of them is pressed or released.

void registerKeyBatch(InputDeviceKeyName[] keyNames, optional SuccessCallback? successCallback, optional ErrorCallback? errorCallback);
             

Since: 2.4

When an application wants to react to the input device key presses, it should register those keys.

An application cannot register the mandatory keys (ArrowLeft, ArrowRight, ArrowUp, ArrowDown, Enter, Back).

The errorCallback is launched with this error type:

• InvalidValuesError: If any of the given keyNames is invalid or not supported.
• UnknownError: In case of any other error.

Privilege level: public

Privilege: http://tizen.org/privilege/tv.inputdevice

Parameters:

• keyNames: The array with the names of the keys which will generate DOM key events when they are pressed
• successCallback [optional] [nullable]: Callback method to be invoked when keys are registered
• errorCallback [optional] [nullable]: Callback method to be invoked when an error has occurred

Exceptions:

• WebAPIException

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type InvalidValuesError, if any of the given keyNames is invalid or not supported (e.g. name is empty string).

  • with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.

  • with error type UnknownError in any other error case.

Code example:

 function errorCB(err) {
     console.log( 'The following error occurred: ' +  err.name);
 }

 function successCB() {
     console.log('Registered successfully');
 }

 var keys = ["VolumeUp", "VolumeDown"];
 tizen.tvinputdevice.registerKeyBatch(keys, successCB, errorCB);
 

unregisterKeyBatch

Unregisters a batch of input device keys.

void unregisterKeyBatch(InputDeviceKeyName[] keyNames, optional SuccessCallback? successCallback, optional ErrorCallback? errorCallback);
             

Since: 2.4

The errorCallback is launched with this error type:

• InvalidValuesError: If any of the given keyNames is invalid or not supported.
• UnknownError: In case of any other error.

Privilege level: public

Privilege: http://tizen.org/privilege/tv.inputdevice

Parameters:

• keyNames: The array with the names of the keys to unregister
• successCallback [optional] [nullable]: Callback method to be invoked when keys are unregistered
• errorCallback [optional] [nullable]: Callback method to be invoked when an error has occurred

Exceptions:

• WebAPIException

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type InvalidValuesError, if any of the given keyNames is invalid or not supported (e.g. name is empty string).

  • with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.

  • with error type UnknownError in any error case.

Code example:

 function errorCB(err) {
     console.log( 'The following error occurred: ' +  err.name);
 }

 function successCB() {
     console.log('Unregistered successfully');
 }
 var keys = ["VolumeUp", "VolumeDown"];
 tizen.tvinputdevice.unregisterKeyBatch(keys, successCB, errorCB);