Key API Reference in ui

Actual implementation of Key for Android.

Source set: Android

public actual class Key(public val keyCode: Long)

Actual implementation of Key for Android.

Parameters


keyCode	an integer code representing the key pressed.

Members

Companion

Source set: Android

public actual companion object

Properties

Unknown

Source set: Android

public val Unknown: Key

Unknown key.

SoftLeft

Source set: Android

public val SoftLeft: Key

Soft Left key.

Usually situated below the display on phones and used as a multi-function feature key for selecting a software defined function shown on the bottom left of the display.

SoftRight

Source set: Android

public val SoftRight: Key

Soft Right key.

Usually situated below the display on phones and used as a multi-function feature key for selecting a software defined function shown on the bottom right of the display.

Home

Source set: Android

@Deprecated(
            "`Key.Home` is never delivered to applications. For the keyboard \"Home\" key " +
                "use `Key.MoveHome`. For the system \"Home\" key (unlikely to be needed), use " +
                "`Key.SystemHome`",
            level = DeprecationLevel.ERROR,
        )
        public val Home: Key

System Home key.

This key is handled by the framework and is never delivered to applications.

SystemHome

Source set: Android

public val SystemHome: Key

System Home key.

This key is handled by the framework and is never delivered to applications.

Back

Source set: Android

public val Back: Key

Back key.

Help

Source set: Android

public val Help: Key

Help key.

NavigatePrevious

Source set: Android

public val NavigatePrevious: Key

Navigate to previous key.

Goes backward by one item in an ordered collection of items.

NavigateNext

Source set: Android

public val NavigateNext: Key

Navigate to next key.

Advances to the next item in an ordered collection of items.

NavigateIn

Source set: Android

public val NavigateIn: Key

Navigate in key.

Activates the item that currently has focus or expands to the next level of a navigation hierarchy.

NavigateOut

Source set: Android

public val NavigateOut: Key

Navigate out key.

Backs out one level of a navigation hierarchy or collapses the item that currently has focus.

SystemNavigationUp

Source set: Android

public val SystemNavigationUp: Key

Consumed by the system for navigation up.

SystemNavigationDown

Source set: Android

public val SystemNavigationDown: Key

Consumed by the system for navigation down.

SystemNavigationLeft

Source set: Android

public val SystemNavigationLeft: Key

Consumed by the system for navigation left.

SystemNavigationRight

Source set: Android

public val SystemNavigationRight: Key

Consumed by the system for navigation right.

Call

Source set: Android

public val Call: Key

Call key.

EndCall

Source set: Android

public val EndCall: Key

End Call key.

DirectionUp

Source set: Android

public val DirectionUp: Key

Up Arrow Key / Directional Pad Up key.

May also be synthesized from trackball motions.

DirectionDown

Source set: Android

public val DirectionDown: Key

Down Arrow Key / Directional Pad Down key.

May also be synthesized from trackball motions.

DirectionLeft

Source set: Android

public val DirectionLeft: Key

Left Arrow Key / Directional Pad Left key.

May also be synthesized from trackball motions.

DirectionRight

Source set: Android

public val DirectionRight: Key

Right Arrow Key / Directional Pad Right key.

May also be synthesized from trackball motions.

DirectionCenter

Source set: Android

public val DirectionCenter: Key

Center Arrow Key / Directional Pad Center key.

May also be synthesized from trackball motions.

DirectionUpLeft

Source set: Android

public val DirectionUpLeft: Key

Directional Pad Up-Left.

DirectionDownLeft

Source set: Android

public val DirectionDownLeft: Key

Directional Pad Down-Left.

DirectionUpRight

Source set: Android

public val DirectionUpRight: Key

Directional Pad Up-Right.

DirectionDownRight

Source set: Android

public val DirectionDownRight: Key

Directional Pad Down-Right.

VolumeUp

Source set: Android

public val VolumeUp: Key

Volume Up key.

Adjusts the speaker volume up.

VolumeDown

Source set: Android

public val VolumeDown: Key

Volume Down key.

Adjusts the speaker volume down.

Power

Source set: Android

public val Power: Key

Power key.

Camera

Source set: Android

public val Camera: Key

Camera key.

Used to launch a camera application or take pictures.

Clear

Source set: Android

public val Clear: Key

Clear key.

Zero

Source set: Android

public val Zero: Key

'0' key.

One

Source set: Android

public val One: Key

'1' key.

Two

Source set: Android

public val Two: Key

'2' key.

Three

Source set: Android

public val Three: Key

'3' key.

Four

Source set: Android

public val Four: Key

'4' key.

Five

Source set: Android

public val Five: Key

'5' key.

Six

Source set: Android

public val Six: Key

'6' key.

Seven

Source set: Android

public val Seven: Key

'7' key.

Eight

Source set: Android

public val Eight: Key

'8' key.

Nine

Source set: Android

public val Nine: Key

'9' key.

Plus

Source set: Android

public val Plus: Key

'+' key.

Minus

Source set: Android

public val Minus: Key

'-' key.

Multiply

Source set: Android

public val Multiply: Key

'*' key.

Equals

Source set: Android

public val Equals: Key

'=' key.

Pound

Source set: Android

public val Pound: Key

'#' key.

A

Source set: Android

public val A: Key

'A' key.

B

Source set: Android

public val B: Key

'B' key.

C

Source set: Android

public val C: Key

'C' key.

D

Source set: Android

public val D: Key

'D' key.

E

Source set: Android

public val E: Key

'E' key.

F

Source set: Android

public val F: Key

'F' key.

G

Source set: Android

public val G: Key

'G' key.

H

Source set: Android

public val H: Key

'H' key.

I

Source set: Android

public val I: Key

'I' key.

J

Source set: Android

public val J: Key

'J' key.

K

Source set: Android

public val K: Key

'K' key.

L

Source set: Android

public val L: Key

'L' key.

M

Source set: Android

public val M: Key

'M' key.

N

Source set: Android

public val N: Key

'N' key.

O

Source set: Android

public val O: Key

'O' key.

P

Source set: Android

public val P: Key

'P' key.

Q

Source set: Android

public val Q: Key

'Q' key.

R

Source set: Android

public val R: Key

'R' key.

S

Source set: Android

public val S: Key

'S' key.

T

Source set: Android

public val T: Key

'T' key.

U

Source set: Android

public val U: Key

'U' key.

V

Source set: Android

public val V: Key

'V' key.

W

Source set: Android

public val W: Key

'W' key.

X

Source set: Android

public val X: Key

'X' key.

Y

Source set: Android

public val Y: Key

'Y' key.

Z

Source set: Android

public val Z: Key

'Z' key.

Comma

Source set: Android

public val Comma: Key

',' key.

Period

Source set: Android

public val Period: Key

'.' key.

AltLeft

Source set: Android

public val AltLeft: Key

Left Alt modifier key.

AltRight

Source set: Android

public val AltRight: Key

Right Alt modifier key.

ShiftLeft

Source set: Android

public val ShiftLeft: Key

Left Shift modifier key.

ShiftRight

Source set: Android

public val ShiftRight: Key

Right Shift modifier key.

Tab

Source set: Android

public val Tab: Key

Tab key.

Spacebar

Source set: Android

public val Spacebar: Key

Space key.

Symbol

Source set: Android

public val Symbol: Key

Symbol modifier key.

Used to enter alternate symbols.

Browser

Source set: Android

public val Browser: Key

Browser special function key.

Used to launch a browser application.

Envelope

Source set: Android

public val Envelope: Key

Envelope special function key.

Used to launch a mail application.

Enter

Source set: Android

public val Enter: Key

Enter key.

Backspace

Source set: Android

public val Backspace: Key

Backspace key.

Deletes characters before the insertion point, unlike Delete.

Delete

Source set: Android

public val Delete: Key

Delete key.

Deletes characters ahead of the insertion point, unlike Backspace.

Escape

Source set: Android

public val Escape: Key

Escape key.

CtrlLeft

Source set: Android

public val CtrlLeft: Key

Left Control modifier key.

CtrlRight

Source set: Android

public val CtrlRight: Key

Right Control modifier key.

CapsLock

Source set: Android

public val CapsLock: Key

Caps Lock key.

ScrollLock

Source set: Android

public val ScrollLock: Key

Scroll Lock key.

MetaLeft

Source set: Android

public val MetaLeft: Key

Left Meta modifier key.

MetaRight

Source set: Android

public val MetaRight: Key

Right Meta modifier key.

Function

Source set: Android

public val Function: Key

Function modifier key.

PrintScreen

Source set: Android

public val PrintScreen: Key

System Request / Print Screen key.

Break

Source set: Android

public val Break: Key

Break / Pause key.

MoveHome

Source set: Android

public val MoveHome: Key

Home Movement key.

Used for scrolling or moving the cursor around to the start of a line or to the top of a list.

MoveEnd

Source set: Android

public val MoveEnd: Key

End Movement key.

Used for scrolling or moving the cursor around to the end of a line or to the bottom of a list.

Insert

Source set: Android

public val Insert: Key

Insert key.

Toggles insert / overwrite edit mode.

Cut

Source set: Android

public val Cut: Key

Cut key.

Copy

Source set: Android

public val Copy: Key

Copy key.

Paste

Source set: Android

public val Paste: Key

Paste key.

Grave

Source set: Android

public val Grave: Key

'`' (backtick) key.

LeftBracket

Source set: Android

public val LeftBracket: Key

'[' key.

RightBracket

Source set: Android

public val RightBracket: Key

']' key.

Slash

Source set: Android

public val Slash: Key

'/' key.

Backslash

Source set: Android

public val Backslash: Key

'\' key.

Semicolon

Source set: Android

public val Semicolon: Key

';' key.

Apostrophe

Source set: Android

public val Apostrophe: Key

''' (apostrophe) key.

At

Source set: Android

public val At: Key

'@' key.

Number

Source set: Android

public val Number: Key

Number modifier key.

Used to enter numeric symbols. This key is not Num Lock; it is more like AltLeft.

HeadsetHook

Source set: Android

public val HeadsetHook: Key

Headset Hook key.

Used to hang up calls and stop media.

Focus

Source set: Android

public val Focus: Key

Camera Focus key.

Used to focus the camera.

Source set: Android

public val Menu: Key

Menu key.

Notification

Source set: Android

public val Notification: Key

Notification key.

Search

Source set: Android

public val Search: Key

Search key.

PageUp

Source set: Android

public val PageUp: Key

Page Up key.

PageDown

Source set: Android

public val PageDown: Key

Page Down key.

PictureSymbols

Source set: Android

public val PictureSymbols: Key

Picture Symbols modifier key.

Used to switch symbol sets (Emoji, Kao-moji).

SwitchCharset

Source set: Android

public val SwitchCharset: Key

Switch Charset modifier key.

Used to switch character sets (Kanji, Katakana).

ButtonA

Source set: Android

public val ButtonA: Key

A Button key.

On a game controller, the A button should be either the button labeled A or the first button on the bottom row of controller buttons.

ButtonB

Source set: Android

public val ButtonB: Key

B Button key.

On a game controller, the B button should be either the button labeled B or the second button on the bottom row of controller buttons.

ButtonC

Source set: Android

public val ButtonC: Key

C Button key.

On a game controller, the C button should be either the button labeled C or the third button on the bottom row of controller buttons.

ButtonX

Source set: Android

public val ButtonX: Key

X Button key.

On a game controller, the X button should be either the button labeled X or the first button on the upper row of controller buttons.

ButtonY

Source set: Android

public val ButtonY: Key

Y Button key.

On a game controller, the Y button should be either the button labeled Y or the second button on the upper row of controller buttons.

ButtonZ

Source set: Android

public val ButtonZ: Key

Z Button key.

On a game controller, the Z button should be either the button labeled Z or the third button on the upper row of controller buttons.

ButtonL1

Source set: Android

public val ButtonL1: Key

L1 Button key.

On a game controller, the L1 button should be either the button labeled L1 (or L) or the top left trigger button.

ButtonR1

Source set: Android

public val ButtonR1: Key

R1 Button key.

On a game controller, the R1 button should be either the button labeled R1 (or R) or the top right trigger button.

ButtonL2

Source set: Android

public val ButtonL2: Key

L2 Button key.

On a game controller, the L2 button should be either the button labeled L2 or the bottom left trigger button.

ButtonR2

Source set: Android

public val ButtonR2: Key

R2 Button key.

On a game controller, the R2 button should be either the button labeled R2 or the bottom right trigger button.

ButtonThumbLeft

Source set: Android

public val ButtonThumbLeft: Key

Left Thumb Button key.

On a game controller, the left thumb button indicates that the left (or only) joystick is pressed.

ButtonThumbRight

Source set: Android

public val ButtonThumbRight: Key

Right Thumb Button key.

On a game controller, the right thumb button indicates that the right joystick is pressed.

ButtonStart

Source set: Android

public val ButtonStart: Key

Start Button key.

On a game controller, the button labeled Start.

ButtonSelect

Source set: Android

public val ButtonSelect: Key

Select Button key.

On a game controller, the button labeled Select.

ButtonMode

Source set: Android

public val ButtonMode: Key

Mode Button key.

On a game controller, the button labeled Mode.

Button1

Source set: Android

public val Button1: Key

Generic Game Pad Button #1.

Button2

Source set: Android

public val Button2: Key

Generic Game Pad Button #2.

Button3

Source set: Android

public val Button3: Key

Generic Game Pad Button #3.

Button4

Source set: Android

public val Button4: Key

Generic Game Pad Button #4.

Button5

Source set: Android

public val Button5: Key

Generic Game Pad Button #5.

Button6

Source set: Android

public val Button6: Key

Generic Game Pad Button #6.

Button7

Source set: Android

public val Button7: Key

Generic Game Pad Button #7.

Button8

Source set: Android

public val Button8: Key

Generic Game Pad Button #8.

Button9

Source set: Android

public val Button9: Key

Generic Game Pad Button #9.

Button10

Source set: Android

public val Button10: Key

Generic Game Pad Button #10.

Button11

Source set: Android

public val Button11: Key

Generic Game Pad Button #11.

Button12

Source set: Android

public val Button12: Key

Generic Game Pad Button #12.

Button13

Source set: Android

public val Button13: Key

Generic Game Pad Button #13.

Button14

Source set: Android

public val Button14: Key

Generic Game Pad Button #14.

Button15

Source set: Android

public val Button15: Key

Generic Game Pad Button #15.

Button16

Source set: Android

public val Button16: Key

Generic Game Pad Button #16.

Forward

Source set: Android

public val Forward: Key

Forward key.

Navigates forward in the history stack. Complement of Back.

F1

Source set: Android

public val F1: Key

F1 key.

F2

Source set: Android

public val F2: Key

F2 key.

F3

Source set: Android

public val F3: Key

F3 key.

F4

Source set: Android

public val F4: Key

F4 key.

F5

Source set: Android

public val F5: Key

F5 key.

F6

Source set: Android

public val F6: Key

F6 key.

F7

Source set: Android

public val F7: Key

F7 key.

F8

Source set: Android

public val F8: Key

F8 key.

F9

Source set: Android

public val F9: Key

F9 key.

F10

Source set: Android

public val F10: Key

F10 key.

F11

Source set: Android

public val F11: Key

F11 key.

F12

Source set: Android

public val F12: Key

F12 key.

NumLock

Source set: Android

public val NumLock: Key

Num Lock key.

This is the Num Lock key; it is different from Number. This key alters the behavior of other keys on the numeric keypad.

NumPad0

Source set: Android

public val NumPad0: Key

Numeric keypad '0' key.

NumPad1

Source set: Android

public val NumPad1: Key

Numeric keypad '1' key.

NumPad2

Source set: Android

public val NumPad2: Key

Numeric keypad '2' key.

NumPad3

Source set: Android

public val NumPad3: Key

Numeric keypad '3' key.

NumPad4

Source set: Android

public val NumPad4: Key

Numeric keypad '4' key.

NumPad5

Source set: Android

public val NumPad5: Key

Numeric keypad '5' key.

NumPad6

Source set: Android

public val NumPad6: Key

Numeric keypad '6' key.

NumPad7

Source set: Android

public val NumPad7: Key

Numeric keypad '7' key.

NumPad8

Source set: Android

public val NumPad8: Key

Numeric keypad '8' key.

NumPad9

Source set: Android

public val NumPad9: Key

Numeric keypad '9' key.

NumPadDivide

Source set: Android

public val NumPadDivide: Key

Numeric keypad '/' key (for division).

NumPadMultiply

Source set: Android

public val NumPadMultiply: Key

Numeric keypad '*' key (for multiplication).

NumPadSubtract

Source set: Android

public val NumPadSubtract: Key

Numeric keypad '-' key (for subtraction).

NumPadAdd

Source set: Android

public val NumPadAdd: Key

Numeric keypad '+' key (for addition).

NumPadDot

Source set: Android

public val NumPadDot: Key

Numeric keypad '.' key (for decimals or digit grouping).

NumPadComma

Source set: Android

public val NumPadComma: Key

Numeric keypad ',' key (for decimals or digit grouping).

NumPadEnter

Source set: Android

public val NumPadEnter: Key

Numeric keypad Enter key.

NumPadEquals

Source set: Android

public val NumPadEquals: Key

Numeric keypad '=' key.

NumPadLeftParenthesis

Source set: Android

public val NumPadLeftParenthesis: Key

Numeric keypad '(' key.

NumPadRightParenthesis

Source set: Android

public val NumPadRightParenthesis: Key

Numeric keypad ')' key.

MediaPlay

Source set: Android

public val MediaPlay: Key

Play media key.

MediaPause

Source set: Android

public val MediaPause: Key

Pause media key.

MediaPlayPause

Source set: Android

public val MediaPlayPause: Key

Play/Pause media key.

MediaStop

Source set: Android

public val MediaStop: Key

Stop media key.

MediaRecord

Source set: Android

public val MediaRecord: Key

Record media key.

MediaNext

Source set: Android

public val MediaNext: Key

Play Next media key.

MediaPrevious

Source set: Android

public val MediaPrevious: Key

Play Previous media key.

MediaRewind

Source set: Android

public val MediaRewind: Key

Rewind media key.

MediaFastForward

Source set: Android

public val MediaFastForward: Key

Fast Forward media key.

MediaClose

Source set: Android

public val MediaClose: Key

Close media key.

May be used to close a CD tray, for example.

MediaAudioTrack

Source set: Android

public val MediaAudioTrack: Key

Audio Track key.

Switches the audio tracks.

MediaEject

Source set: Android

public val MediaEject: Key

Eject media key.

May be used to eject a CD tray, for example.

MediaTopMenu

Source set: Android

public val MediaTopMenu: Key

Media Top Menu key.

Goes to the top of media menu.

MediaSkipForward

Source set: Android

public val MediaSkipForward: Key

Skip forward media key.

MediaSkipBackward

Source set: Android

public val MediaSkipBackward: Key

Skip backward media key.

MediaStepForward

Source set: Android

public val MediaStepForward: Key

Step forward media key.

Steps media forward, one frame at a time.

MediaStepBackward

Source set: Android

public val MediaStepBackward: Key

Step backward media key.

Steps media backward, one frame at a time.

MicrophoneMute

Source set: Android

public val MicrophoneMute: Key

Mute key.

Mutes the microphone, unlike VolumeMute.

VolumeMute

Source set: Android

public val VolumeMute: Key

Volume Mute key.

Mutes the speaker, unlike MicrophoneMute.

This key should normally be implemented as a toggle such that the first press mutes the speaker and the second press restores the original volume.

Info

Source set: Android

public val Info: Key

Info key.

Common on TV remotes to show additional information related to what is currently being viewed.

ChannelUp

Source set: Android

public val ChannelUp: Key

Channel up key.

On TV remotes, increments the television channel.

ChannelDown

Source set: Android

public val ChannelDown: Key

Channel down key.

On TV remotes, decrements the television channel.

ZoomIn

Source set: Android

public val ZoomIn: Key

Zoom in key.

ZoomOut

Source set: Android

public val ZoomOut: Key

Zoom out key.

Tv

Source set: Android

public val Tv: Key

TV key.

On TV remotes, switches to viewing live TV.

Window

Source set: Android

public val Window: Key

Window key.

On TV remotes, toggles picture-in-picture mode or other windowing functions. On Android Wear devices, triggers a display offset.

Guide

Source set: Android

public val Guide: Key

Guide key.

On TV remotes, shows a programming guide.

Dvr

Source set: Android

public val Dvr: Key

DVR key.

On some TV remotes, switches to a DVR mode for recorded shows.

Bookmark

Source set: Android

public val Bookmark: Key

Bookmark key.

On some TV remotes, bookmarks content or web pages.

Captions

Source set: Android

public val Captions: Key

Toggle captions key.

Switches the mode for closed-captioning text, for example during television shows.

Settings

Source set: Android

public val Settings: Key

Settings key.

Starts the system settings activity.

TvPower

Source set: Android

public val TvPower: Key

TV power key.

On TV remotes, toggles the power on a television screen.

TvInput

Source set: Android

public val TvInput: Key

TV input key.

On TV remotes, switches the input on a television screen.

SetTopBoxPower

Source set: Android

public val SetTopBoxPower: Key

Set-top-box power key.

On TV remotes, toggles the power on an external Set-top-box.

SetTopBoxInput

Source set: Android

public val SetTopBoxInput: Key

Set-top-box input key.

On TV remotes, switches the input mode on an external Set-top-box.

AvReceiverPower

Source set: Android

public val AvReceiverPower: Key

A/V Receiver power key.

On TV remotes, toggles the power on an external A/V Receiver.

AvReceiverInput

Source set: Android

public val AvReceiverInput: Key

A/V Receiver input key.

On TV remotes, switches the input mode on an external A/V Receiver.

ProgramRed

Source set: Android

public val ProgramRed: Key

Red "programmable" key.

On TV remotes, acts as a contextual/programmable key.

ProgramGreen

Source set: Android

public val ProgramGreen: Key

Green "programmable" key.

On TV remotes, acts as a contextual/programmable key.

ProgramYellow

Source set: Android

public val ProgramYellow: Key

Yellow "programmable" key.

On TV remotes, acts as a contextual/programmable key.

ProgramBlue

Source set: Android

public val ProgramBlue: Key

Blue "programmable" key.

On TV remotes, acts as a contextual/programmable key.

AppSwitch

Source set: Android

public val AppSwitch: Key

App switch key.

Should bring up the application switcher dialog.

Source set: Android

public val LanguageSwitch: Key

Language Switch key.

Toggles the current input language such as switching between English and Japanese on a QWERTY keyboard. On some devices, the same function may be performed by pressing Shift+Space.

MannerMode

Source set: Android

public val MannerMode: Key

Manner Mode key.

Toggles silent or vibrate mode on and off to make the device behave more politely in certain settings such as on a crowded train. On some devices, the key may only operate when long-pressed.

Toggle2D3D

Source set: Android

public val Toggle2D3D: Key

3D Mode key.

Toggles the display between 2D and 3D mode.

Contacts

Source set: Android

public val Contacts: Key

Contacts special function key.

Used to launch an address book application.

Calendar

Source set: Android

public val Calendar: Key

Calendar special function key.

Used to launch a calendar application.

Music

Source set: Android

public val Music: Key

Music special function key.

Used to launch a music player application.

Calculator

Source set: Android

public val Calculator: Key

Calculator special function key.

Used to launch a calculator application.

ZenkakuHankaru

Source set: Android

public val ZenkakuHankaru: Key

Japanese full-width / half-width key.

Eisu

Source set: Android

public val Eisu: Key

Japanese alphanumeric key.

Muhenkan

Source set: Android

public val Muhenkan: Key

Japanese non-conversion key.

Henkan

Source set: Android

public val Henkan: Key

Japanese conversion key.

KatakanaHiragana

Source set: Android

public val KatakanaHiragana: Key

Japanese katakana / hiragana key.

Yen

Source set: Android

public val Yen: Key

Japanese Yen key.

Ro

Source set: Android

public val Ro: Key

Japanese Ro key.

Kana

Source set: Android

public val Kana: Key

Japanese kana key.

Assist

Source set: Android

public val Assist: Key

Assist key.

Launches the global assist activity. Not delivered to applications.

BrightnessDown

Source set: Android

public val BrightnessDown: Key

Brightness Down key.

Adjusts the screen brightness down.

BrightnessUp

Source set: Android

public val BrightnessUp: Key

Brightness Up key.

Adjusts the screen brightness up.

Sleep

Source set: Android

public val Sleep: Key

Sleep key.

Puts the device to sleep. Behaves somewhat like Power but it has no effect if the device is already asleep.

WakeUp

Source set: Android

public val WakeUp: Key

Wakeup key.

Wakes up the device. Behaves somewhat like Power but it has no effect if the device is already awake.

SoftSleep

Source set: Android

public val SoftSleep: Key

Put device to sleep unless a wakelock is held.

Pairing

Source set: Android

public val Pairing: Key

Pairing key.

Initiates peripheral pairing mode. Useful for pairing remote control devices or game controllers, especially if no other input mode is available.

LastChannel

Source set: Android

public val LastChannel: Key

Last Channel key.

Goes to the last viewed channel.

TvDataService

Source set: Android

public val TvDataService: Key

TV data service key.

Displays data services like weather, sports.

VoiceAssist

Source set: Android

public val VoiceAssist: Key

Voice Assist key.

Launches the global voice assist activity. Not delivered to applications.

TvRadioService

Source set: Android

public val TvRadioService: Key

Radio key.

Toggles TV service / Radio service.

TvTeletext

Source set: Android

public val TvTeletext: Key

Teletext key.

Displays Teletext service.

TvNumberEntry

Source set: Android

public val TvNumberEntry: Key

Number entry key.

Initiates to enter multi-digit channel number when each digit key is assigned for selecting separate channel. Corresponds to Number Entry Mode (0x1D) of CEC User Control Code.

TvTerrestrialAnalog

Source set: Android

public val TvTerrestrialAnalog: Key

Analog Terrestrial key.

Switches to analog terrestrial broadcast service.

TvTerrestrialDigital

Source set: Android

public val TvTerrestrialDigital: Key

Digital Terrestrial key.

Switches to digital terrestrial broadcast service.

TvSatellite

Source set: Android

public val TvSatellite: Key

Satellite key.

Switches to digital satellite broadcast service.

TvSatelliteBs

Source set: Android

public val TvSatelliteBs: Key

BS key.

Switches to BS digital satellite broadcasting service available in Japan.

TvSatelliteCs

Source set: Android

public val TvSatelliteCs: Key

CS key.

Switches to CS digital satellite broadcasting service available in Japan.

TvSatelliteService

Source set: Android

public val TvSatelliteService: Key

BS/CS key.

Toggles between BS and CS digital satellite services.

TvNetwork

Source set: Android

public val TvNetwork: Key

Toggle Network key.

Toggles selecting broadcast services.

TvAntennaCable

Source set: Android

public val TvAntennaCable: Key

Antenna/Cable key.

Toggles broadcast input source between antenna and cable.

TvInputHdmi1

Source set: Android

public val TvInputHdmi1: Key

HDMI #1 key.

Switches to HDMI input #1.

TvInputHdmi2

Source set: Android

public val TvInputHdmi2: Key

HDMI #2 key.

Switches to HDMI input #2.

TvInputHdmi3

Source set: Android

public val TvInputHdmi3: Key

HDMI #3 key.

Switches to HDMI input #3.

TvInputHdmi4

Source set: Android

public val TvInputHdmi4: Key

HDMI #4 key.

Switches to HDMI input #4.

TvInputComposite1

Source set: Android

public val TvInputComposite1: Key

Composite #1 key.

Switches to composite video input #1.

TvInputComposite2

Source set: Android

public val TvInputComposite2: Key

Composite #2 key.

Switches to composite video input #2.

TvInputComponent1

Source set: Android

public val TvInputComponent1: Key

Component #1 key.

Switches to component video input #1.

TvInputComponent2

Source set: Android

public val TvInputComponent2: Key

Component #2 key.

Switches to component video input #2.

TvInputVga1

Source set: Android

public val TvInputVga1: Key

VGA #1 key.

Switches to VGA (analog RGB) input #1.

TvAudioDescription

Source set: Android

public val TvAudioDescription: Key

Audio description key.

Toggles audio description off / on.

TvAudioDescriptionMixingVolumeUp

Source set: Android

public val TvAudioDescriptionMixingVolumeUp: Key

Audio description mixing volume up key.

Increase the audio description volume as compared with normal audio volume.

TvAudioDescriptionMixingVolumeDown

Source set: Android

public val TvAudioDescriptionMixingVolumeDown: Key

Audio description mixing volume down key.

Lessen audio description volume as compared with normal audio volume.

TvZoomMode

Source set: Android

public val TvZoomMode: Key

Zoom mode key.

Changes Zoom mode (Normal, Full, Zoom, Wide-zoom, etc.)

TvContentsMenu

Source set: Android

public val TvContentsMenu: Key

Contents menu key.

Goes to the title list. Corresponds to Contents Menu (0x0B) of CEC User Control Code

TvMediaContextMenu

Source set: Android

public val TvMediaContextMenu: Key

Media context menu key.

Goes to the context menu of media contents. Corresponds to Media Context-sensitive Menu (0x11) of CEC User Control Code.

TvTimerProgramming

Source set: Android

public val TvTimerProgramming: Key

Timer programming key.

Goes to the timer recording menu. Corresponds to Timer Programming (0x54) of CEC User Control Code.

StemPrimary

Source set: Android

public val StemPrimary: Key

Primary stem key for Wearables.

Main power/reset button.

Stem1

Source set: Android

public val Stem1: Key

Generic stem key 1 for Wearables.

Stem2

Source set: Android

public val Stem2: Key

Generic stem key 2 for Wearables.

Stem3

Source set: Android

public val Stem3: Key

Generic stem key 3 for Wearables.

AllApps

Source set: Android

public val AllApps: Key

Show all apps.

Refresh

Source set: Android

public val Refresh: Key

Refresh key.

ThumbsUp

Source set: Android

public val ThumbsUp: Key

Thumbs up key. Apps can use this to let user up-vote content.

ThumbsDown

Source set: Android

public val ThumbsDown: Key

Thumbs down key. Apps can use this to let user down-vote content.

ProfileSwitch

Source set: Android

public val ProfileSwitch: Key

Used to switch current account that is consuming content. May be consumed by system to set account globally.

NumPadDirectionUp

Source set: Android

public val NumPadDirectionUp: Key

Numeric keypad Up Arrow Key. Unsupported on Android.

NumPadDirectionDown

Source set: Android

public val NumPadDirectionDown: Key

Numeric keypad Down Arrow Key. Unsupported on Android.

NumPadDirectionLeft

Source set: Android

public val NumPadDirectionLeft: Key

Numeric keypad Left Arrow Key. Unsupported on Android.

NumPadDirectionRight

Source set: Android

public val NumPadDirectionRight: Key

Numeric keypad Right Arrow Key. Unsupported on Android.

NumPadMoveHome

Source set: Android

public val NumPadMoveHome: Key

Numeric keypad Home Key. Unsupported on Android.

NumPadMoveEnd

Source set: Android

public val NumPadMoveEnd: Key

Numeric keypad End Key. Unsupported on Android.

NumPadPageUp

Source set: Android

public val NumPadPageUp: Key

Numeric keypad Page Up Key. Unsupported on Android.

NumPadPageDown

Source set: Android

public val NumPadPageDown: Key

Numeric keypad Page Down Key. Unsupported on Android.

NumPadInsert

Source set: Android

public val NumPadInsert: Key

Numeric keypad Insert Key. Unsupported on Android.

NumPadDelete

Source set: Android

public val NumPadDelete: Key

Numeric keypad Delete key. Unsupported on Android.

Source set: Common

public expect class Key(public val keyCode: Long)

Represents keys on a keyboard.

Parameters


keyCode	a Long value representing the key pressed. Note: This keycode can be used to uniquely identify a hardware key. It is different from the native keycode.

Members

Companion

Source set: Common

public companion object

Properties

Unknown

Source set: Common

public val Unknown: Key

Unknown key.

SoftLeft

Source set: Common

public val SoftLeft: Key

Soft Left key.

Usually situated below the display on phones and used as a multi-function feature key for selecting a software defined function shown on the bottom left of the display.

SoftRight

Source set: Common

public val SoftRight: Key

Soft Right key.

Usually situated below the display on phones and used as a multi-function feature key for selecting a software defined function shown on the bottom right of the display.

Home

Source set: Common

@Deprecated(
            "`Key.Home` is never delivered to applications. For the keyboard \"Home\" key " +
                "use `Key.MoveHome`. For the system \"Home\" key (unlikely to be needed), use " +
                "`Key.SystemHome`",
            level = DeprecationLevel.ERROR,
        )
        public val Home: Key

System Home key.

This key is handled by the framework and is never delivered to applications.

SystemHome

Source set: Common

public val SystemHome: Key

System Home key.

This key is handled by the framework and is never delivered to applications.

Back

Source set: Common

public val Back: Key

Back key.

Help

Source set: Common

public val Help: Key

Help key.

NavigatePrevious

Source set: Common

public val NavigatePrevious: Key

Navigate to previous key.

Goes backward by one item in an ordered collection of items.

NavigateNext

Source set: Common

public val NavigateNext: Key

Navigate to next key.

Advances to the next item in an ordered collection of items.

NavigateIn

Source set: Common

public val NavigateIn: Key

Navigate in key.

Activates the item that currently has focus or expands to the next level of a navigation hierarchy.

NavigateOut

Source set: Common

public val NavigateOut: Key

Navigate out key.

Backs out one level of a navigation hierarchy or collapses the item that currently has focus.

SystemNavigationUp

Source set: Common

public val SystemNavigationUp: Key

Consumed by the system for navigation up.

SystemNavigationDown

Source set: Common

public val SystemNavigationDown: Key

Consumed by the system for navigation down.

SystemNavigationLeft

Source set: Common

public val SystemNavigationLeft: Key

Consumed by the system for navigation left.

SystemNavigationRight

Source set: Common

public val SystemNavigationRight: Key

Consumed by the system for navigation right.

Call

Source set: Common

public val Call: Key

Call key.

EndCall

Source set: Common

public val EndCall: Key

End Call key.

DirectionUp

Source set: Common

public val DirectionUp: Key

Up Arrow Key / Directional Pad Up key.

May also be synthesized from trackball motions.

DirectionDown

Source set: Common

public val DirectionDown: Key

Down Arrow Key / Directional Pad Down key.

May also be synthesized from trackball motions.

DirectionLeft

Source set: Common

public val DirectionLeft: Key

Left Arrow Key / Directional Pad Left key.

May also be synthesized from trackball motions.

DirectionRight

Source set: Common

public val DirectionRight: Key

Right Arrow Key / Directional Pad Right key.

May also be synthesized from trackball motions.

DirectionCenter

Source set: Common

public val DirectionCenter: Key

Center Arrow Key / Directional Pad Center key.

May also be synthesized from trackball motions.

DirectionUpLeft

Source set: Common

public val DirectionUpLeft: Key

Directional Pad Up-Left.

DirectionDownLeft

Source set: Common

public val DirectionDownLeft: Key

Directional Pad Down-Left.

DirectionUpRight

Source set: Common

public val DirectionUpRight: Key

Directional Pad Up-Right.

DirectionDownRight

Source set: Common

public val DirectionDownRight: Key

Directional Pad Down-Right.

VolumeUp

Source set: Common

public val VolumeUp: Key

Volume Up key.

Adjusts the speaker volume up.

VolumeDown

Source set: Common

public val VolumeDown: Key

Volume Down key.

Adjusts the speaker volume down.

Power

Source set: Common

public val Power: Key

Power key.

Camera

Source set: Common

public val Camera: Key

Camera key.

Used to launch a camera application or take pictures.

Clear

Source set: Common

public val Clear: Key

Clear key.

Zero

Source set: Common

public val Zero: Key

'0' key.

One

Source set: Common

public val One: Key

'1' key.

Two

Source set: Common

public val Two: Key

'2' key.

Three

Source set: Common

public val Three: Key

'3' key.

Four

Source set: Common

public val Four: Key

'4' key.

Five

Source set: Common

public val Five: Key

'5' key.

Six

Source set: Common

public val Six: Key

'6' key.

Seven

Source set: Common

public val Seven: Key

'7' key.

Eight

Source set: Common

public val Eight: Key

'8' key.

Nine

Source set: Common

public val Nine: Key

'9' key.

Plus

Source set: Common

public val Plus: Key

'+' key.

Minus

Source set: Common

public val Minus: Key

'-' key.

Multiply

Source set: Common

public val Multiply: Key

'*' key.

Equals

Source set: Common

public val Equals: Key

'=' key.

Pound

Source set: Common

public val Pound: Key

'#' key.

A

Source set: Common

public val A: Key

'A' key.

B

Source set: Common

public val B: Key

'B' key.

C

Source set: Common

public val C: Key

'C' key.

D

Source set: Common

public val D: Key

'D' key.

E

Source set: Common

public val E: Key

'E' key.

F

Source set: Common

public val F: Key

'F' key.

G

Source set: Common

public val G: Key

'G' key.

H

Source set: Common

public val H: Key

'H' key.

I

Source set: Common

public val I: Key

'I' key.

J

Source set: Common

public val J: Key

'J' key.

K

Source set: Common

public val K: Key

'K' key.

L

Source set: Common

public val L: Key

'L' key.

M

Source set: Common

public val M: Key

'M' key.

N

Source set: Common

public val N: Key

'N' key.

O

Source set: Common

public val O: Key

'O' key.

P

Source set: Common

public val P: Key

'P' key.

Q

Source set: Common

public val Q: Key

'Q' key.

R

Source set: Common

public val R: Key

'R' key.

S

Source set: Common

public val S: Key

'S' key.

T

Source set: Common

public val T: Key

'T' key.

U

Source set: Common

public val U: Key

'U' key.

V

Source set: Common

public val V: Key

'V' key.

W

Source set: Common

public val W: Key

'W' key.

X

Source set: Common

public val X: Key

'X' key.

Y

Source set: Common

public val Y: Key

'Y' key.

Z

Source set: Common

public val Z: Key

'Z' key.

Comma

Source set: Common

public val Comma: Key

',' key.

Period

Source set: Common

public val Period: Key

'.' key.

AltLeft

Source set: Common

public val AltLeft: Key

Left Alt modifier key.

AltRight

Source set: Common

public val AltRight: Key

Right Alt modifier key.

ShiftLeft

Source set: Common

public val ShiftLeft: Key

Left Shift modifier key.

ShiftRight

Source set: Common

public val ShiftRight: Key

Right Shift modifier key.

Tab

Source set: Common

public val Tab: Key

Tab key.

Spacebar

Source set: Common

public val Spacebar: Key

Space key.

Symbol

Source set: Common

public val Symbol: Key

Symbol modifier key.

Used to enter alternate symbols.

Browser

Source set: Common

public val Browser: Key

Browser special function key.

Used to launch a browser application.

Envelope

Source set: Common

public val Envelope: Key

Envelope special function key.

Used to launch a mail application.

Enter

Source set: Common

public val Enter: Key

Enter key.

Backspace

Source set: Common

public val Backspace: Key

Backspace key.

Deletes characters before the insertion point, unlike Delete.

Delete

Source set: Common

public val Delete: Key

Delete key.

Deletes characters ahead of the insertion point, unlike Backspace.

Escape

Source set: Common

public val Escape: Key

Escape key.

CtrlLeft

Source set: Common

public val CtrlLeft: Key

Left Control modifier key.

CtrlRight

Source set: Common

public val CtrlRight: Key

Right Control modifier key.

CapsLock

Source set: Common

public val CapsLock: Key

Caps Lock key.

ScrollLock

Source set: Common

public val ScrollLock: Key

Scroll Lock key.

MetaLeft

Source set: Common

public val MetaLeft: Key

Left Meta modifier key.

MetaRight

Source set: Common

public val MetaRight: Key

Right Meta modifier key.

Function

Source set: Common

public val Function: Key

Function modifier key.

PrintScreen

Source set: Common

public val PrintScreen: Key

System Request / Print Screen key.

Break

Source set: Common

public val Break: Key

Break / Pause key.

MoveHome

Source set: Common

public val MoveHome: Key

Home Movement key.

Used for scrolling or moving the cursor around to the start of a line or to the top of a list.

MoveEnd

Source set: Common

public val MoveEnd: Key

End Movement key.

Used for scrolling or moving the cursor around to the end of a line or to the bottom of a list.

Insert

Source set: Common

public val Insert: Key

Insert key.

Toggles insert / overwrite edit mode.

Cut

Source set: Common

public val Cut: Key

Cut key.

Copy

Source set: Common

public val Copy: Key

Copy key.

Paste

Source set: Common

public val Paste: Key

Paste key.

Grave

Source set: Common

public val Grave: Key

'`' (backtick) key.

LeftBracket

Source set: Common

public val LeftBracket: Key

'[' key.

RightBracket

Source set: Common

public val RightBracket: Key

']' key.

Slash

Source set: Common

public val Slash: Key

'/' key.

Backslash

Source set: Common

public val Backslash: Key

'\' key.

Semicolon

Source set: Common

public val Semicolon: Key

';' key.

Apostrophe

Source set: Common

public val Apostrophe: Key

''' (apostrophe) key.

At

Source set: Common

public val At: Key

'@' key.

Number

Source set: Common

public val Number: Key

Number modifier key.

Used to enter numeric symbols. This key is not Num Lock; it is more like AltLeft.

HeadsetHook

Source set: Common

public val HeadsetHook: Key

Headset Hook key.

Used to hang up calls and stop media.

Focus

Source set: Common

public val Focus: Key

Camera Focus key.

Used to focus the camera.

Source set: Common

public val Menu: Key

Menu key.

Notification

Source set: Common

public val Notification: Key

Notification key.

Search

Source set: Common

public val Search: Key

Search key.

PageUp

Source set: Common

public val PageUp: Key

Page Up key.

PageDown

Source set: Common

public val PageDown: Key

Page Down key.

PictureSymbols

Source set: Common

public val PictureSymbols: Key

Picture Symbols modifier key.

Used to switch symbol sets (Emoji, Kao-moji).

SwitchCharset

Source set: Common

public val SwitchCharset: Key

Switch Charset modifier key.

Used to switch character sets (Kanji, Katakana).

ButtonA

Source set: Common

public val ButtonA: Key

A Button key.

On a game controller, the A button should be either the button labeled A or the first button on the bottom row of controller buttons.

ButtonB

Source set: Common

public val ButtonB: Key

B Button key.

On a game controller, the B button should be either the button labeled B or the second button on the bottom row of controller buttons.

ButtonC

Source set: Common

public val ButtonC: Key

C Button key.

On a game controller, the C button should be either the button labeled C or the third button on the bottom row of controller buttons.

ButtonX

Source set: Common

public val ButtonX: Key

X Button key.

On a game controller, the X button should be either the button labeled X or the first button on the upper row of controller buttons.

ButtonY

Source set: Common

public val ButtonY: Key

Y Button key.

On a game controller, the Y button should be either the button labeled Y or the second button on the upper row of controller buttons.

ButtonZ

Source set: Common

public val ButtonZ: Key

Z Button key.

On a game controller, the Z button should be either the button labeled Z or the third button on the upper row of controller buttons.

ButtonL1

Source set: Common

public val ButtonL1: Key

L1 Button key.

On a game controller, the L1 button should be either the button labeled L1 (or L) or the top left trigger button.

ButtonR1

Source set: Common

public val ButtonR1: Key

R1 Button key.

On a game controller, the R1 button should be either the button labeled R1 (or R) or the top right trigger button.

ButtonL2

Source set: Common

public val ButtonL2: Key

L2 Button key.

On a game controller, the L2 button should be either the button labeled L2 or the bottom left trigger button.

ButtonR2

Source set: Common

public val ButtonR2: Key

R2 Button key.

On a game controller, the R2 button should be either the button labeled R2 or the bottom right trigger button.

ButtonThumbLeft

Source set: Common

public val ButtonThumbLeft: Key

Left Thumb Button key.

On a game controller, the left thumb button indicates that the left (or only) joystick is pressed.

ButtonThumbRight

Source set: Common

public val ButtonThumbRight: Key

Right Thumb Button key.

On a game controller, the right thumb button indicates that the right joystick is pressed.

ButtonStart

Source set: Common

public val ButtonStart: Key

Start Button key.

On a game controller, the button labeled Start.

ButtonSelect

Source set: Common

public val ButtonSelect: Key

Select Button key.

On a game controller, the button labeled Select.

ButtonMode

Source set: Common

public val ButtonMode: Key

Mode Button key.

On a game controller, the button labeled Mode.

Button1

Source set: Common

public val Button1: Key

Generic Game Pad Button #1.

Button2

Source set: Common

public val Button2: Key

Generic Game Pad Button #2.

Button3

Source set: Common

public val Button3: Key

Generic Game Pad Button #3.

Button4

Source set: Common

public val Button4: Key

Generic Game Pad Button #4.

Button5

Source set: Common

public val Button5: Key

Generic Game Pad Button #5.

Button6

Source set: Common

public val Button6: Key

Generic Game Pad Button #6.

Button7

Source set: Common

public val Button7: Key

Generic Game Pad Button #7.

Button8

Source set: Common

public val Button8: Key

Generic Game Pad Button #8.

Button9

Source set: Common

public val Button9: Key

Generic Game Pad Button #9.

Button10

Source set: Common

public val Button10: Key

Generic Game Pad Button #10.

Button11

Source set: Common

public val Button11: Key

Generic Game Pad Button #11.

Button12

Source set: Common

public val Button12: Key

Generic Game Pad Button #12.

Button13

Source set: Common

public val Button13: Key

Generic Game Pad Button #13.

Button14

Source set: Common

public val Button14: Key

Generic Game Pad Button #14.

Button15

Source set: Common

public val Button15: Key

Generic Game Pad Button #15.

Button16

Source set: Common

public val Button16: Key

Generic Game Pad Button #16.

Forward

Source set: Common

public val Forward: Key

Forward key.

Navigates forward in the history stack. Complement of Back.

F1

Source set: Common

public val F1: Key

F1 key.

F2

Source set: Common

public val F2: Key

F2 key.

F3

Source set: Common

public val F3: Key

F3 key.

F4

Source set: Common

public val F4: Key

F4 key.

F5

Source set: Common

public val F5: Key

F5 key.

F6

Source set: Common

public val F6: Key

F6 key.

F7

Source set: Common

public val F7: Key

F7 key.

F8

Source set: Common

public val F8: Key

F8 key.

F9

Source set: Common

public val F9: Key

F9 key.

F10

Source set: Common

public val F10: Key

F10 key.

F11

Source set: Common

public val F11: Key

F11 key.

F12

Source set: Common

public val F12: Key

F12 key.

NumLock

Source set: Common

public val NumLock: Key

Num Lock key.

This is the Num Lock key; it is different from Number. This key alters the behavior of other keys on the numeric keypad.

NumPad0

Source set: Common

public val NumPad0: Key

Numeric keypad '0' key.

NumPad1

Source set: Common

public val NumPad1: Key

Numeric keypad '1' key.

NumPad2

Source set: Common

public val NumPad2: Key

Numeric keypad '2' key.

NumPad3

Source set: Common

public val NumPad3: Key

Numeric keypad '3' key.

NumPad4

Source set: Common

public val NumPad4: Key

Numeric keypad '4' key.

NumPad5

Source set: Common

public val NumPad5: Key

Numeric keypad '5' key.

NumPad6

Source set: Common

public val NumPad6: Key

Numeric keypad '6' key.

NumPad7

Source set: Common

public val NumPad7: Key

Numeric keypad '7' key.

NumPad8

Source set: Common

public val NumPad8: Key

Numeric keypad '8' key.

NumPad9

Source set: Common

public val NumPad9: Key

Numeric keypad '9' key.

NumPadDivide

Source set: Common

public val NumPadDivide: Key

Numeric keypad '/' key (for division).

NumPadMultiply

Source set: Common

public val NumPadMultiply: Key

Numeric keypad '*' key (for multiplication).

NumPadSubtract

Source set: Common

public val NumPadSubtract: Key

Numeric keypad '-' key (for subtraction).

NumPadAdd

Source set: Common

public val NumPadAdd: Key

Numeric keypad '+' key (for addition).

NumPadDot

Source set: Common

public val NumPadDot: Key

Numeric keypad '.' key (for decimals or digit grouping).

NumPadComma

Source set: Common

public val NumPadComma: Key

Numeric keypad ',' key (for decimals or digit grouping).

NumPadEnter

Source set: Common

public val NumPadEnter: Key

Numeric keypad Enter key.

NumPadEquals

Source set: Common

public val NumPadEquals: Key

Numeric keypad '=' key.

NumPadLeftParenthesis

Source set: Common

public val NumPadLeftParenthesis: Key

Numeric keypad '(' key.

NumPadRightParenthesis

Source set: Common

public val NumPadRightParenthesis: Key

Numeric keypad ')' key.

NumPadDirectionUp

Source set: Common

public val NumPadDirectionUp: Key

Numeric keypad Up Arrow Key.

NumPadDirectionDown

Source set: Common

public val NumPadDirectionDown: Key

Numeric keypad Down Arrow Key.

NumPadDirectionLeft

Source set: Common

public val NumPadDirectionLeft: Key

Numeric keypad Left Arrow Key.

NumPadDirectionRight

Source set: Common

public val NumPadDirectionRight: Key

Numeric keypad Right Arrow Key.

NumPadMoveHome

Source set: Common

public val NumPadMoveHome: Key

Numeric keypad Home Key.

NumPadMoveEnd

Source set: Common

public val NumPadMoveEnd: Key

Numeric keypad End Key.

NumPadPageUp

Source set: Common

public val NumPadPageUp: Key

Numeric keypad Page Up Key.

NumPadPageDown

Source set: Common

public val NumPadPageDown: Key

Numeric keypad Page Down Key.

NumPadInsert

Source set: Common

public val NumPadInsert: Key

Numeric keypad Insert Key.

NumPadDelete

Source set: Common

public val NumPadDelete: Key

Numeric keypad Delete Key.

MediaPlay

Source set: Common

public val MediaPlay: Key

Play media key.

MediaPause

Source set: Common

public val MediaPause: Key

Pause media key.

MediaPlayPause

Source set: Common

public val MediaPlayPause: Key

Play/Pause media key.

MediaStop

Source set: Common

public val MediaStop: Key

Stop media key.

MediaRecord

Source set: Common

public val MediaRecord: Key

Record media key.

MediaNext

Source set: Common

public val MediaNext: Key

Play Next media key.

MediaPrevious

Source set: Common

public val MediaPrevious: Key

Play Previous media key.

MediaRewind

Source set: Common

public val MediaRewind: Key

Rewind media key.

MediaFastForward

Source set: Common

public val MediaFastForward: Key

Fast Forward media key.

MediaClose

Source set: Common

public val MediaClose: Key

Close media key.

May be used to close a CD tray, for example.

MediaAudioTrack

Source set: Common

public val MediaAudioTrack: Key

Audio Track key.

Switches the audio tracks.

MediaEject

Source set: Common

public val MediaEject: Key

Eject media key.

May be used to eject a CD tray, for example.

MediaTopMenu

Source set: Common

public val MediaTopMenu: Key

Media Top Menu key.

Goes to the top of media menu.

MediaSkipForward

Source set: Common

public val MediaSkipForward: Key

Skip forward media key.

MediaSkipBackward

Source set: Common

public val MediaSkipBackward: Key

Skip backward media key.

MediaStepForward

Source set: Common

public val MediaStepForward: Key

Step forward media key.

Steps media forward, one frame at a time.

MediaStepBackward

Source set: Common

public val MediaStepBackward: Key

Step backward media key.

Steps media backward, one frame at a time.

MicrophoneMute

Source set: Common

public val MicrophoneMute: Key

Mute key.

Mutes the microphone, unlike VolumeMute.

VolumeMute

Source set: Common

public val VolumeMute: Key

Volume Mute key.

Mutes the speaker, unlike MicrophoneMute.

This key should normally be implemented as a toggle such that the first press mutes the speaker and the second press restores the original volume.

Info

Source set: Common

public val Info: Key

Info key.

Common on TV remotes to show additional information related to what is currently being viewed.

ChannelUp

Source set: Common

public val ChannelUp: Key

Channel up key.

On TV remotes, increments the television channel.

ChannelDown

Source set: Common

public val ChannelDown: Key

Channel down key.

On TV remotes, decrements the television channel.

ZoomIn

Source set: Common

public val ZoomIn: Key

Zoom in key.

ZoomOut

Source set: Common

public val ZoomOut: Key

Zoom out key.

Tv

Source set: Common

public val Tv: Key

TV key.

On TV remotes, switches to viewing live TV.

Window

Source set: Common

public val Window: Key

Window key.

On TV remotes, toggles picture-in-picture mode or other windowing functions. On Android Wear devices, triggers a display offset.

Guide

Source set: Common

public val Guide: Key

Guide key.

On TV remotes, shows a programming guide.

Dvr

Source set: Common

public val Dvr: Key

DVR key.

On some TV remotes, switches to a DVR mode for recorded shows.

Bookmark

Source set: Common

public val Bookmark: Key

Bookmark key.

On some TV remotes, bookmarks content or web pages.

Captions

Source set: Common

public val Captions: Key

Toggle captions key.

Switches the mode for closed-captioning text, for example during television shows.

Settings

Source set: Common

public val Settings: Key

Settings key.

Starts the system settings activity.

TvPower

Source set: Common

public val TvPower: Key

TV power key.

On TV remotes, toggles the power on a television screen.

TvInput

Source set: Common

public val TvInput: Key

TV input key.

On TV remotes, switches the input on a television screen.

SetTopBoxPower

Source set: Common

public val SetTopBoxPower: Key

Set-top-box power key.

On TV remotes, toggles the power on an external Set-top-box.

SetTopBoxInput

Source set: Common

public val SetTopBoxInput: Key

Set-top-box input key.

On TV remotes, switches the input mode on an external Set-top-box.

AvReceiverPower

Source set: Common

public val AvReceiverPower: Key

A/V Receiver power key.

On TV remotes, toggles the power on an external A/V Receiver.

AvReceiverInput

Source set: Common

public val AvReceiverInput: Key

A/V Receiver input key.

On TV remotes, switches the input mode on an external A/V Receiver.

ProgramRed

Source set: Common

public val ProgramRed: Key

Red "programmable" key.

On TV remotes, acts as a contextual/programmable key.

ProgramGreen

Source set: Common

public val ProgramGreen: Key

Green "programmable" key.

On TV remotes, acts as a contextual/programmable key.

ProgramYellow

Source set: Common

public val ProgramYellow: Key

Yellow "programmable" key.

On TV remotes, acts as a contextual/programmable key.

ProgramBlue

Source set: Common

public val ProgramBlue: Key

Blue "programmable" key.

On TV remotes, acts as a contextual/programmable key.

AppSwitch

Source set: Common

public val AppSwitch: Key

App switch key.

Should bring up the application switcher dialog.

Source set: Common

public val LanguageSwitch: Key

Language Switch key.

Toggles the current input language such as switching between English and Japanese on a QWERTY keyboard. On some devices, the same function may be performed by pressing Shift+Space.

MannerMode

Source set: Common

public val MannerMode: Key

Manner Mode key.

Toggles silent or vibrate mode on and off to make the device behave more politely in certain settings such as on a crowded train. On some devices, the key may only operate when long-pressed.

Toggle2D3D

Source set: Common

public val Toggle2D3D: Key

3D Mode key.

Toggles the display between 2D and 3D mode.

Contacts

Source set: Common

public val Contacts: Key

Contacts special function key.

Used to launch an address book application.

Calendar

Source set: Common

public val Calendar: Key

Calendar special function key.

Used to launch a calendar application.

Music

Source set: Common

public val Music: Key

Music special function key.

Used to launch a music player application.

Calculator

Source set: Common

public val Calculator: Key

Calculator special function key.

Used to launch a calculator application.

ZenkakuHankaru

Source set: Common

public val ZenkakuHankaru: Key

Japanese full-width / half-width key.

Eisu

Source set: Common

public val Eisu: Key

Japanese alphanumeric key.

Muhenkan

Source set: Common

public val Muhenkan: Key

Japanese non-conversion key.

Henkan

Source set: Common

public val Henkan: Key

Japanese conversion key.

KatakanaHiragana

Source set: Common

public val KatakanaHiragana: Key

Japanese katakana / hiragana key.

Yen

Source set: Common

public val Yen: Key

Japanese Yen key.

Ro

Source set: Common

public val Ro: Key

Japanese Ro key.

Kana

Source set: Common

public val Kana: Key

Japanese kana key.

Assist

Source set: Common

public val Assist: Key

Assist key.

Launches the global assist activity. Not delivered to applications.

BrightnessDown

Source set: Common

public val BrightnessDown: Key

Brightness Down key.

Adjusts the screen brightness down.

BrightnessUp

Source set: Common

public val BrightnessUp: Key

Brightness Up key.

Adjusts the screen brightness up.

Sleep

Source set: Common

public val Sleep: Key

Sleep key.

Puts the device to sleep. Behaves somewhat like Power but it has no effect if the device is already asleep.

WakeUp

Source set: Common

public val WakeUp: Key

Wakeup key.

Wakes up the device. Behaves somewhat like Power but it has no effect if the device is already awake.

SoftSleep

Source set: Common

public val SoftSleep: Key

Put device to sleep unless a wakelock is held.

Pairing

Source set: Common

public val Pairing: Key

Pairing key.

Initiates peripheral pairing mode. Useful for pairing remote control devices or game controllers, especially if no other input mode is available.

LastChannel

Source set: Common

public val LastChannel: Key

Last Channel key.

Goes to the last viewed channel.

TvDataService

Source set: Common

public val TvDataService: Key

TV data service key.

Displays data services like weather, sports.

VoiceAssist

Source set: Common

public val VoiceAssist: Key

Voice Assist key.

Launches the global voice assist activity. Not delivered to applications.

TvRadioService

Source set: Common

public val TvRadioService: Key

Radio key.

Toggles TV service / Radio service.

TvTeletext

Source set: Common

public val TvTeletext: Key

Teletext key.

Displays Teletext service.

TvNumberEntry

Source set: Common

public val TvNumberEntry: Key

Number entry key.

Initiates to enter multi-digit channel number when each digit key is assigned for selecting separate channel. Corresponds to Number Entry Mode (0x1D) of CEC User Control Code.

TvTerrestrialAnalog

Source set: Common

public val TvTerrestrialAnalog: Key

Analog Terrestrial key.

Switches to analog terrestrial broadcast service.

TvTerrestrialDigital

Source set: Common

public val TvTerrestrialDigital: Key

Digital Terrestrial key.

Switches to digital terrestrial broadcast service.

TvSatellite

Source set: Common

public val TvSatellite: Key

Satellite key.

Switches to digital satellite broadcast service.

TvSatelliteBs

Source set: Common

public val TvSatelliteBs: Key

BS key.

Switches to BS digital satellite broadcasting service available in Japan.

TvSatelliteCs

Source set: Common

public val TvSatelliteCs: Key

CS key.

Switches to CS digital satellite broadcasting service available in Japan.

TvSatelliteService

Source set: Common

public val TvSatelliteService: Key

BS/CS key.

Toggles between BS and CS digital satellite services.

TvNetwork

Source set: Common

public val TvNetwork: Key

Toggle Network key.

Toggles selecting broadcast services.

TvAntennaCable

Source set: Common

public val TvAntennaCable: Key

Antenna/Cable key.

Toggles broadcast input source between antenna and cable.

TvInputHdmi1

Source set: Common

public val TvInputHdmi1: Key

HDMI #1 key.

Switches to HDMI input #1.

TvInputHdmi2

Source set: Common

public val TvInputHdmi2: Key

HDMI #2 key.

Switches to HDMI input #2.

TvInputHdmi3

Source set: Common

public val TvInputHdmi3: Key

HDMI #3 key.

Switches to HDMI input #3.

TvInputHdmi4

Source set: Common

public val TvInputHdmi4: Key

HDMI #4 key.

Switches to HDMI input #4.

TvInputComposite1

Source set: Common

public val TvInputComposite1: Key

Composite #1 key.

Switches to composite video input #1.

TvInputComposite2

Source set: Common

public val TvInputComposite2: Key

Composite #2 key.

Switches to composite video input #2.

TvInputComponent1

Source set: Common

public val TvInputComponent1: Key

Component #1 key.

Switches to component video input #1.

TvInputComponent2

Source set: Common

public val TvInputComponent2: Key

Component #2 key.

Switches to component video input #2.

TvInputVga1

Source set: Common

public val TvInputVga1: Key

VGA #1 key.

Switches to VGA (analog RGB) input #1.

TvAudioDescription

Source set: Common

public val TvAudioDescription: Key

Audio description key.

Toggles audio description off / on.

TvAudioDescriptionMixingVolumeUp

Source set: Common

public val TvAudioDescriptionMixingVolumeUp: Key

Audio description mixing volume up key.

Increase the audio description volume as compared with normal audio volume.

TvAudioDescriptionMixingVolumeDown

Source set: Common

public val TvAudioDescriptionMixingVolumeDown: Key

Audio description mixing volume down key.

Lessen audio description volume as compared with normal audio volume.

TvZoomMode

Source set: Common

public val TvZoomMode: Key

Zoom mode key.

Changes Zoom mode (Normal, Full, Zoom, Wide-zoom, etc.)

TvContentsMenu

Source set: Common

public val TvContentsMenu: Key

Contents menu key.

Goes to the title list. Corresponds to Contents Menu (0x0B) of CEC User Control Code

TvMediaContextMenu

Source set: Common

public val TvMediaContextMenu: Key

Media context menu key.

Goes to the context menu of media contents. Corresponds to Media Context-sensitive Menu (0x11) of CEC User Control Code.

TvTimerProgramming

Source set: Common

public val TvTimerProgramming: Key

Timer programming key.

Goes to the timer recording menu. Corresponds to Timer Programming (0x54) of CEC User Control Code.

StemPrimary

Source set: Common

public val StemPrimary: Key

Primary stem key for Wearables.

Main power/reset button.

Stem1

Source set: Common

public val Stem1: Key

Generic stem key 1 for Wearables.

Stem2

Source set: Common

public val Stem2: Key

Generic stem key 2 for Wearables.

Stem3

Source set: Common

public val Stem3: Key

Generic stem key 3 for Wearables.

AllApps

Source set: Common

public val AllApps: Key

Show all apps.

Refresh

Source set: Common

public val Refresh: Key

Refresh key.

ThumbsUp

Source set: Common

public val ThumbsUp: Key

Thumbs up key. Apps can use this to let user up-vote content.

ThumbsDown

Source set: Common

public val ThumbsDown: Key

Thumbs down key. Apps can use this to let user down-vote content.

ProfileSwitch

Source set: Common

public val ProfileSwitch: Key

Used to switch current account that is consuming content. May be consumed by system to set account globally.

Invalidation.Placement ← Previous KeyEvent Next →