Skip to content

KeyEvents

jsiegenthaler edited this page Jan 17, 2023 · 23 revisions

KeyEvents are also often referred to as Key Codes.

Key Macros

You can send a sequence of keys as a Key Macro (from v2.1.0). See the Wiki Key Macro page for full details

Known Keys

A collection of known key commands that control the set-top box via mqtt. You can use these to change the remote key mappings of the eosstb plugin if you wish.

Note that the standard Apple TV Remote is limited and does not provide buttons for all possible commands. You can map different commands for single or double tap of the remote buttons.

The list of keys below are listed in approximately the same order as the physical set-top box remote control layout.

  • Power: Turns the system on or off. Same as the [Power] button on the top of the set-top box remote

  • NextUserProfile: Displays the profiles and moves to the next profile. Same as the [Profile] button on the right side of the set-top box remote

  • MediaTopMenu: Displays the top menu page (home page) on the TV. Same as the [Home] button on the set-top box remote

  • Guide: Displays the TV GUIDE page on the TV. Same as the [Guide] button on the set-top box remote

  • TV: Goes back to live TV or the last viewed TV channel. Same as the [TV] button on the set-top box remote

  • Escape: Escapes (exits) out of any current menu on the TV. Same as the [⮌] (Back) button on the set-top box remote

  • ContextMenu: Displays a context menu on the current TV program. Same as the [...] (Options) button on the set-top box remote

  • ArrowUp, ArrowDown, ArrowLeft, ArrowRight: the navigation arrow buttons on the set-top box remote

  • Enter: the [OK] button on the set-top box remote

  • Info: Displays the INFO screen on the TV showing info about the current TV program

  • Help: Displays the SETTINGS INFO page on the TV, allowing you to access settings quickly

  • ChannelUp: Move up the channel list by one channel, same as the [/\] (Channel Up) button on the set-top box remote

  • ChannelDown: Move down the channel list by one channel, same as the [\/] (Channel Down) button on the set-top box remote

  • MediaPause: Toggles between Pause and Play of the currently playing program. Same as the [>|| ] (Play/Pause) button on the set-top box remote

  • MediaPlayPause: Toggles between Pause and Play of the currently playing program. Same as the [>|| ] (Play/Pause) button on the set-top box remote

  • MediaRewind: Rewinds the currently playing program. Same as the [<<] (Rewind) button on the set-top box remote

  • MediaFastForward: Fast-forwards the currently playing program. Same as the [>>] (FastForward) button on the set-top box remote

  • MediaRecord: Starts recording the currently playing program. Same as the [o] (Record) button on the set-top box remote

  • MediaStop: Stops the currently playing program

  • 0-9: The 10 numbers [1], [2], [3], [4], [5], [6], [7], [8], [9], [0] on the number keypad on the remote control. Used to directly access channels.

  • Red, Green, Yellow, Blue: The four coloured buttons found on GB and IE remote controls, to access special TV functions

  • Teletext: Displays the Teletext screen on channels that support Teletext

Unknown Keys

If you know of the KeyEvents for these keys, please let me know:

  • VoiceControl - the remote control button to activate voice control
Clone this wiki locally