Package com.unitech.api.keymap

Class KeymappingCtrl

  • public class KeymappingCtrl
extends java.lang.Object
    This controller is used to manage the Programmable Key API.

    • Field Detail

      • KEY_PROGRAMMABLE_KEYS_SET

        public static final java.lang.String KEY_PROGRAMMABLE_KEYS_SET
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_KEY

        public static final java.lang.String KEY_PROGRAMMABLE_KEY
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_KEY_NAME

        public static final java.lang.String KEY_PROGRAMMABLE_KEY_NAME
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_KEY_CODE

        public static final java.lang.String KEY_PROGRAMMABLE_KEY_CODE
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_WAKEUP

        public static final java.lang.String KEY_PROGRAMMABLE_WAKEUP
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_BROADCAST_DOWN

        public static final java.lang.String KEY_PROGRAMMABLE_BROADCAST_DOWN
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_BROADCAST_UP

        public static final java.lang.String KEY_PROGRAMMABLE_BROADCAST_UP
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_DOWN_PARAMS

        public static final java.lang.String KEY_PROGRAMMABLE_DOWN_PARAMS
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_UP_PARAMS

        public static final java.lang.String KEY_PROGRAMMABLE_UP_PARAMS
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_PARAMS_KEY

        public static final java.lang.String KEY_PROGRAMMABLE_PARAMS_KEY
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_PARAMS_VALUE

        public static final java.lang.String KEY_PROGRAMMABLE_PARAMS_VALUE
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_DOWN_KEY

        public static final java.lang.String KEY_PROGRAMMABLE_DOWN_KEY
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_UP_KEY

        public static final java.lang.String KEY_PROGRAMMABLE_UP_KEY
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_DOWN_VALUE

        public static final java.lang.String KEY_PROGRAMMABLE_DOWN_VALUE
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_UP_VALUE

        public static final java.lang.String KEY_PROGRAMMABLE_UP_VALUE
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_START_ACTIVITY_PARAMS

        public static final java.lang.String KEY_PROGRAMMABLE_START_ACTIVITY_PARAMS
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_START_ACTIVITY_PARAM

        public static final java.lang.String KEY_PROGRAMMABLE_START_ACTIVITY_PARAM
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_START_ACTIVITY_KEY

        public static final java.lang.String KEY_PROGRAMMABLE_START_ACTIVITY_KEY
        See Also:
        Constant Field Values

      • KEY_PROGRAMMABLE_START_ACTIVITY_VALUE

        public static final java.lang.String KEY_PROGRAMMABLE_START_ACTIVITY_VALUE
        See Also:
        Constant Field Values

      • KEY_IMPORT_PROGRAMMABLE_KEYS

        public static final java.lang.String KEY_IMPORT_PROGRAMMABLE_KEYS
        See Also:
        Constant Field Values

      • KEY_IMPORT_PROGRAMMABLE_KEYS_ENABLE

        public static final java.lang.String KEY_IMPORT_PROGRAMMABLE_KEYS_ENABLE
        See Also:
        Constant Field Values

      • KEY_IMPORT_PROGRAMMABLE_KEYS_FILE_PATH

        public static final java.lang.String KEY_IMPORT_PROGRAMMABLE_KEYS_FILE_PATH
        See Also:
        Constant Field Values

      • KEY_EXPORT_PROGRAMMABLE_KEYS

        public static final java.lang.String KEY_EXPORT_PROGRAMMABLE_KEYS
        See Also:
        Constant Field Values

      • KEY_EXPORT_PROGRAMMABLE_KEYS_ENABLE

        public static final java.lang.String KEY_EXPORT_PROGRAMMABLE_KEYS_ENABLE
        See Also:
        Constant Field Values

      • KEY_EXPORT_PROGRAMMABLE_KEYS_FILE_PATH

        public static final java.lang.String KEY_EXPORT_PROGRAMMABLE_KEYS_FILE_PATH
        See Also:
        Constant Field Values

      • KEY_RESET_PROGRAMMABLE_KEYS

        public static final java.lang.String KEY_RESET_PROGRAMMABLE_KEYS
        See Also:
        Constant Field Values

      • TAG_BROADCAST_KEY_DOWN

        public static final java.lang.String TAG_BROADCAST_KEY_DOWN
        See Also:
        Constant Field Values

      • TAG_ACTION_PARAMS

        public static final java.lang.String TAG_ACTION_PARAMS
        See Also:
        Constant Field Values

      • TAG_BROADCAST_KEY_UP

        public static final java.lang.String TAG_BROADCAST_KEY_UP
        See Also:
        Constant Field Values

      • TAG_START_ACTIVITY_PARAMS

        public static final java.lang.String TAG_START_ACTIVITY_PARAMS
        See Also:
        Constant Field Values

      • BUNDLE_ERROR_CODE

        public static final java.lang.String BUNDLE_ERROR_CODE
        See Also:
        Constant Field Values

      • BUNDLE_ERROR_MSG

        public static final java.lang.String BUNDLE_ERROR_MSG
        See Also:
        Constant Field Values

      • INTENT_RESULT_MESSAGE

        public static final java.lang.String INTENT_RESULT_MESSAGE
        See Also:
        Constant Field Values

      • ACTION_KEY_EXPORT

        public static final java.lang.String ACTION_KEY_EXPORT
        See Also:
        Constant Field Values

      • ACTION_KEY_IMPORT

        public static final java.lang.String ACTION_KEY_IMPORT
        See Also:
        Constant Field Values

      • tmpIntent

        public static volatile android.content.Intent tmpIntent

      • tmpResultCode

        public static volatile java.lang.Integer tmpResultCode

    • Method Detail

      • getInstance

        public static KeymappingCtrl getInstance​(android.content.Context context)
        Get an instance of the KeymappingCtrl
        Parameters:
        context - The context which will use this controller instance
        Returns:
        A KeymappingCtrl instance

      • enableKeyMapping

        public android.os.Bundle enableKeyMapping​(boolean enabled)
        Enable or disable the Programmable Key service
        Parameters:
        enabled - true: Enable, false: Disable
        Returns:
        A bundle contains the error code and message
        int errorCode = bundle.getInt("errorCode"), (error:1, success=0)
        String errorMsg = bundle.getString("errorMsg");

      • addKeyMappings

        public android.os.Bundle addKeyMappings​(java.lang.String keyName,
                                        java.lang.String keyCode,
                                        boolean wakeup,
                                        java.lang.String broadcastDownAction,
                                        android.os.Bundle[] broadcastDownParams,
                                        java.lang.String broadcastUpAction,
                                        android.os.Bundle[] broadcastUpParams,
                                        android.os.Bundle[] startActivityParams)
        Add a key mapping into the Programmable Key list
        Parameters:
        keyName - The key name what you want to remap, e.g. "VOLUME_UP"
        keyCode - The key code that you want to remap to, e.g. "25" (VOLUME_DOWN) or "com.unitech.keyremap" (target activity)
        wakeup - Set that pressing the key will wake the screen up or not.
        broadcastDownAction - Set the broadcast action if you want system to send a broadcast while pressing the key down.
        broadcastDownParams - Set the broadcast extras if you want system to send a broadcast while pressing the key down.
        A bundle contains 2 string extras: "Key" and "Value"
        broadcastUpAction - Set the broadcast action if you want system to send a broadcast while releasing the key.
        broadcastUpParams - Set the broadcast extras if you want system to send a broadcast while releasing the key.
        A bundle contains 2 string extras: "Key" and "Value"
        startActivityParams - Set the extras of the activity intent if the key code is set to start an activity
        A bundle contains 2 string extras: "Key" and "Value"
        Returns:
        A bundle contains the error code and message
        int errorCode = bundle.getInt("errorCode"), (error:1, success=0)
        String errorMsg = bundle.getString("errorMsg");

      • resetKeyMappings

        public android.os.Bundle resetKeyMappings()
        Reset all of the key mappings from the Programmable Key service
        Returns:
        A bundle contains the error code and message
        int errorCode = bundle.getInt("errorCode"), (error:1, success=0)
        String errorMsg = bundle.getString("errorMsg");

      • importKeyMappings

        public android.os.Bundle importKeyMappings​(java.lang.String folderPath)
        Import the settings of the key mappings to the folder
        Parameters:
        folderPath - The folder path of settings, e.g. "/sdcard/progkey/"
        Returns:
        A bundle contains the error code and message
        int errorCode = bundle.getInt("errorCode"), (error:1, success=0)
        String errorMsg = bundle.getString("errorMsg");

      • exportKeyMappings

        public android.os.Bundle exportKeyMappings​(java.lang.String folderPath)
        Export the settings of the key mappings to the folder
        Parameters:
        folderPath - The folder path of settings, e.g. "/sdcard/progkey/"
        Returns:
        A bundle contains the error code and message
        int errorCode = bundle.getInt("errorCode"), (error:1, success=0)
        String errorMsg = bundle.getString("errorMsg");

      • getKeyMapping

        public android.os.Bundle getKeyMapping​(java.lang.String keyName)

      • resetKeyMapping

        public android.os.Bundle resetKeyMapping​(java.lang.String keyName)