Action IDs: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
← Older edit
Ned Scott (talk | contribs)
15,105 edits
No edit summary
CastagnaIT (talk | contribs)
Patroller
62 edits
add PreviousSubtitle, add missing CycleSubtitle
 
(82 intermediate revisions by 17 users not shown)
Line 1: Line 1:
An up to date list of the available actions can be found in the ''TranslateActionString()'' method in in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp ButtonTranslator.cpp].
<section begin="Action IDs" />
 
;Main actions
A reference of default XBMC keys and their associated actions can be found in: [https://github.com/xbmc/xbmc/tree/master/system/keymaps Default keymaps shipped with xbmc]
{| class="prettytable sort sortable"
 
|-
A full list of Sections is here: [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp#L228 ButtonTranslator.cpp]
! Action
 
! Description
For those debugging integer action codes from the debug log, the mapping of action codes to constants is in [https://github.com/xbmc/xbmc/blob/master/xbmc/guilib/Key.h Key.h]
|-
 
| <code>Left</code> || Move left off a control.
In addition to the following actions, you can also use the [[Built-in functions available to FTP, Webserver, skins, keymap and to python]] in XBMC.
|-
 
| <code>Right</code> || Move right off a control.
{| class="wikitable"
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>Enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder. '''(deprecated, same meaning of "Back" action)'''
|-
| <code>ParentFolder</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>Back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|-
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|-
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>OSD</code> || Toggles the OSD (On Screen Display) while playing an item.
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one (does not allow subtitles to be disabled).
|-
| <code>PreviousSubtitle</code> || Change to the previous subtitle language, if there is more than one (does not allow subtitles to be disabled). '''(v22 Piers addition)'''
|-
| <code>CycleSubtitle</code> || Change to the next subtitle language, if there is more than one (it also allow subtitles to be disabled).
|-
| <code>SubtitleShiftUp</code> || Move subtitles up
|-
| <code>SubtitleShiftDown</code> || Move subtitles down
|-  
|-  
| '''Action'''
| <code>SubtitleAlign</code> || Subtitle position control
| '''Description'''
|-  
|-  
| Left || Move left off a control.
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-  
|-  
| Right || Move right off a control.
| <code>PlayerProcessInfo</code> || Show player process information about the currently playing item (during video or visualisation playback)
|-  
|-  
| Up  || Move up off a control.
| <code>PlayerProgramSelect</code> || Show dialog to select a program tv channel (during video playback)
|-  
|-  
| Down || Move down off a control.
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-  
|-  
| Select || Select a button, or an item from a list of thumb view.
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-  
|-  
| PageUp || Scroll up on page in a list, thumb, or text view.
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-  
|-  
| PageDown || Scroll down on page in a list, thumb, or text view.
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-  
|-  
| Highlight || Highlight an item in a list or thumb view.
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-  
|-  
| ParentDir || Go up a folder to the parent folder.
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-  
|-  
| PreviousMenu || Go back to the previous menu screen.
| <code>Queue</code> || Queue the item to the current playlist
|-  
|-  
| Info || Show the information about the currently highlighted item, or currently playing item.
| <code>PlayNext</code> || Queue the item to the next position in the current playlist
|-  
|-  
| Pause || Pause the currently playing item.
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. Used in the [[Advanced_library_filtering|advanced filter]] for the video library.
|-  
|-  
| Stop || Stop the currently playing item.
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-  
|-  
| SkipNext || Skip to the next item in a playlist or scene in a video.
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-  
|-  
| SkipPrevious || Skip to the previous item in a playlist or scene in a video.
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-  
|-  
| FullScreen || Toggles fullscreen modes (either visualisation or video playback)
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-  
|-  
| AspectRatio || Toggle through the various aspect ratio modes (Normal is the preferred option).
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-  
|-  
| StepForward || Step forward 1% in the movie.
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-  
|-  
| StepBack || Step back 1% in the movie.
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-  
|-  
| BigStepForward || Step forward 10% in the movie.
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-  
|-  
| BigStepBack || Step back 10% in the movie.
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-  
|-  
| SmallStepBack || Step back 7 seconds in the current video.
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-  
|-  
| OSD || Toggles the OSD while playing an item.
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-  
|-  
| PlayDVD || Start playing a DVD (goes to the DVD menu)
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-  
|-  
| ShowVideoMenu || Go to the DVD Video menu when playing a DVD.
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-  
|-  
| ShowSubtitles || Toggles whether subtitles are shown or not.
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-  
|-  
| NextSubtitle || Change to the next subtitle language, if there is more than one.
| <code>Rotate</code> || Rotate a picture in My Pictures
|-  
|-  
| CodecInfo || Show codec information about the currently playing item (during video or visualisation playback)
| <code>rotateccw</code> || Rotate current picture counterclockwise during slideshow.
|-  
|-  
| NextPicture || Move to the next picture in a slideshow.
| <code>Close</code> || Used to close a dialog
|-  
|-  
| PreviousPicture || Move to the previous picture in a slideshow.
| <code>subtitledelay</code> || Show the current delay amount of subtitles.
|-  
|-  
| ZoomOut || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-  
|-  
| ZoomIn || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-  
|-  
| IncreasePAR || Used in video fullscreen to increase the pixel aspect ratio (stretch).
| <code>audiodelay</code> || Show the current delay amount of audio.
|-  
|-  
| DecreasePAR || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)  
|-  
|-  
| Queue || Queue the item to the current playlist
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-  
|-  
| Playlist || Toggle to playlist view from My Music or My Videos
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-  
|-  
| ZoomNormal || Normal (fullscreen) viewing in My Pictures
| <code>NextResolution</code> || Used in Video calibration
|-  
|-  
| ZoomLevel1 || Zoom to 120% in My Pictures
| <code>Number''<0-9>''</code> || Used to input the number 0 through 9
|-  
|-  
| ZoomLevel2 || Zoom to 150% in My Pictures
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-  
|-  
| ZoomLevel3 || Zoom to 200% in My Pictures
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-  
|-  
| ZoomLevel4 || Zoom to 280% in My Pictures
| <code>Play</code> || Play the selected item (or folder of items).
|-  
|-  
| ZoomLevel5 || Zoom to 400% in My Pictures
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-  
|-  
| ZoomLevel6 || Zoom to 600% in My Pictures
| <code>Delete</code> || Used in My Files to delete a file.
|-  
|-  
| ZoomLevel7 || Zoom to 900% in My Pictures
| <code>Copy</code> || Used in My Files to copy a file.
|-  
|-  
| ZoomLevel8 || Zoom to 1350% in My Pictures
| <code>Move</code> || Used in My Files to move a file.
|-  
|-  
| ZoomLevel9 || Zoom to 2000% in My Pictures
| <code>Rename</code> || Used in My Files to rename a file.
|-  
|-  
| NextCalibration || Used in Video + GUI calibration
| <code>HideSubmenu</code> || <depreciated>
|-  
|-  
| ResetCalibration || Used in Video + GUI calibration
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-  
|-  
| AnalogMove || Move in the calibration screens, and while zoomed in My Pictures.
| <code>Reboot</code> || Reboot
|-  
|-  
| Rotate || Rotate a picture in My Pictures
| <code>ShutDown()</code> || Shutdown and power off
|-  
|-  
| Close || Used to close a dialog
| <code>VolumeUp</code> || Increase the volume of playback.
|-  
|-  
| SubtitleDelayMinus || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
| <code>VolumeDown</code> || Decrease the volume of playback.
|-  
|-  
| SubtitleDelayPlus || Increase the delay amount of subtitles (use if subtitles are displaying too early)
| <code>Mute</code> || Mute the volume.
|-  
|-  
| AudioDelayMinus || Decrease the delay amount of audio (use if audio is being heard too early)
| <code>volampup</code> || Increase volume amplification.
|-  
|-  
| AudioDelayPlus || Increase the delay amount of audio (use if audio is being heard too late)
| <code>volampdown</code> || Decrease volume amplification.
|-  
|-  
| AudioNextLanguage || Change to the next audio track in a video with multiple audio tracks.
| <code>audiotoggledigital</code> || Switch between digital / analog audio.
|-  
|-  
| NextResolution || Used in Video calibration
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-  
|-  
| Number0 || Used to input the number 0
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-  
|-  
| Number1 || Used to input the number 1
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-  
|-  
| Number2 || Used to input the number 2
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-  
|-  
| Number3 || Used to input the number 3
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-  
|-  
| Number4 || Used to input the number 4
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-  
|-  
| Number5 || Used to input the number 5
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-  
|-  
| Number6 || Used to input the number 6
| <code>MoveItemUp</code> || Used to rearrange playlists
|-  
|-  
| Number7 || Used to input the number 7
| <code>MoveItemDown</code> || Used to rearrange playlists
|-  
|-  
| Number8 || Used to input the number 8
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-  
|-  
| Number9 || Used to input the number 9
| <code>ContextMenu</code> || Pops up a contextual menu
|-  
|-  
| FastForward || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-  
|-  
| Rewind || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-  
|-  
| Play || Play the selected item (or folder of items), or unpause a paused item.
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-  
|-  
| Delete || Used in My Files to delete a file.
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-  
|-  
| Copy || Used in My Files to copy a file.
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-  
|-  
| Move || Used in My Files to move a file.
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-  
|-  
| Rename || Used in My Files to rename a file.
| <code>NextPreset</code> || Next visualisation preset
|-  
|-  
| HideSubmenu || <depreciated>
| <code>PreviousPreset</code> || Previous visualisation preset
|-  
|-  
| Screenshot || Take a screenshot of the current screen.
| <code>LockPreset</code> || Lock the current visualisation preset
|-  
|-  
| XBMC.ShutDown() || Shutdown and power off
| <code>RandomPreset</code> || Switch to a new random preset
|-  
|-  
| VolumeUp || Increase the volume of playback.
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-  
|-  
| VolumeDown || Decrease the volume of playback.
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-  
|-  
| Mute || Mute the volume.
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-  
|-  
| BackSpace || Used in the virtual keyboards to delete one letter.
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-  
|-  
| ScrollUp || Variable speed scroll up for analog keys (stick or triggers)
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-  
|-  
| ScrollDown || Variable speed scroll down for analog keys (stick or triggers)
| <code>JumpSMS''<2-9>''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-  
|-  
| AnalogFastForward || Variable speed fast forward for analog keys (stick or triggers)
| <code>FilterSMS''<2-9>''</code> || Filter a list in music or videos using SMS-style input.
|-  
|-  
| AnalogRewind || Variable speed rewind for analog keys (stick or triggers)
| <code>verticalshiftup</code> || Shift up video image currently played.
|-  
|-  
| AnalogSeekForward || Variable speed seeking for analog keys (stick or triggers)
| <code>verticalshiftdown</code> || Shift down video image currently played.
|-  
|-  
| AnalogSeekBack || Variable speed seeking for analog keys (stick or triggers)
| <code>scanitem</code> || Scan selected item for video or music files.
|-  
|-  
| MoveItemUp || Used to rearrange playlists
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-  
|-  
| MoveItemDown || Used to rearrange playlists
| <code>increasevisrating</code> || Increase the preset rate for visualization.
|-  
|-  
| ContextMenu || Pops up a contextual menu
| <code>decreasevisrating</code> || Decrease the preset rate for visualization.
|-  
|-  
| Shift || Used in Virtual Keyboard to switch to upper or lower case letters
| <code>firstpage</code> || Move to the first element of the page.
|-  
|-  
| Symbols || Used in Virtual Keyboard to switch to or from symbols mode
| <code>lastpage</code> || Move to the last element of the page.
|-  
|-  
| CursorLeft || Used in Virtual Keyboard to move the current cursor point to the left
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-  
|-  
| CursorRight || Used in Virtual Keyboard to move the current cursor point to the right
| <code>red</code> || Used to simulate red button click for the teletext.
|-  
|-  
| ShowTime || Used to show the current play time in music + video playback
| <code>green</code> || Used to simulate green button click for the teletext.
|-  
|-  
| ShowPreset || Shows the current visualisation preset (milkdrop/spectrum)
| <code>yellow</code> || Used to simulate yellow button click for the teletext.
|-  
|-  
| PresetList || Pops up the visualisation preset list (milkdrop/spectrum)
| <code>blue</code> || Used to simulate blue button click for the teletext.
|-  
|-  
| NextPreset || Next visualisation preset
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|-  
|-  
| PreviousPreset || Previous visualisation preset
| <code>CreatEpisodeBookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|-  
|-  
| LockPreset || Lock the current visualisation preset
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-  
|-  
| RandomPreset || Switch to a new random preset
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-  
|-  
| IncreaseRating || Unused
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|-  
|-  
| DecreaseRating || Unused
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|-  
|-  
| ToggleWatched || Toggles watched/unwatched status for Videos
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|-  
|-  
| NextLetter || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-  
|-  
| PrevLetter || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-  
|-  
| JumpSMS2-9 || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|-  
|-  
| FilterSMS2-9 || Filter a list in music or videos using SMS-style input.
| <code>ToggleCommSkip</code> || Enable / Disable commercial skipping (based on [[Edit_decision_list]] file) during video playback.
|-  
|-  
| XBMC.ActivateWindow(MyVideos) || Go to My Videos.
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-  
|-  
| XBMC.ActivateWindow(MyMusic) || Go to My Music.
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-  
|-  
| XBMC.ActivateWindow(MyPictures) || Go to My Pictures.
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players. '''(v13 Gotham addition)'''
|-  
|-  
| XBMC.ActivateWindow(Home) || Go to Home window.  Go back from within a context in the UI.
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|- || XBMC.ActivateWindow(type,path to playlist) || Opens the window for the desired playlist
|-  
|-  
| XBMC.ActivateWindow('''''[[Window IDs|windowid]]''''') || Go a window specified by ''''windowid''. See the [[Window IDs|list of window IDs]] for the list of valid values. Not all ids will work on all themes. 
| <code>SetRating</code> || For use when playing music. Will pop-up a 1-10 userrating select dialog, to rate the currently playing song. '''(v17 Krypton addition)'''
|-
| <code>DialogSelectVideo</code> || Open a window dialog to select a video stream. '''(v22 Piers addition)'''
|-
| <code>DialogSelectAudio</code> || Open a window dialog to select an audio stream. '''(v22 Piers addition)'''
|-
| <code>DialogSelectSubtitle</code> || Open a window dialog to select a subtitle stream. '''(v22 Piers addition)'''
|-
|}
|}
;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />
== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)
== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]
{{updated|21}}
[[Category:Remotes]]
[[Category:Skin development]]

Latest revision as of 07:09, 4 December 2024

Main actions
Action Description
Left Move left off a control.
Right Move right off a control.
Up Move up off a control.
Down Move down off a control.
Select Select a button, or an item from a list of thumb view.
Enter ? (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
PageUp Scroll up on page in a list, thumb, or text view.
PageDown Scroll down on page in a list, thumb, or text view.
Highlight Highlight an item in a list or thumb view.
ParentDir Go up a folder to the parent folder. (deprecated, same meaning of "Back" action)
ParentFolder Go up a folder to the parent folder.
PreviousMenu Go back to the previous menu screen.
Back Go back in navigation.
Info Show the information about the currently highlighted item, or currently playing item.
Pause Pause the currently playing item.
Stop Stop the currently playing item.
SkipNext Skip to next video in playlist. If no playlist, then skip to next chapter in video.
SkipPrevious Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
FullScreen Toggles full-screen content playback (either visualisation or video playback)
togglefullscreen Changes whether the app is displayed full-screen or windowed (on windowing OSs)
AspectRatio Toggle through the various aspect ratio modes (Normal is the preferred option).
StepForward Step forward 30 seconds in a video.
StepBack Step back 30 seconds in a video.
BigStepForward Step forward 10 minutes in video.
BigStepBack Step back 10 minutes in video.
SmallStepBack Step back 7 seconds in the current video.
Seek(##) A definable seek action, where ## is a number of seconds. For example, to make a seek action that goes forward 25 seconds use Seek(25), and to make a seek action that goes back 36 seconds use Seek(-36). (v15 Isengard addition)
ChapterOrBigStepForward Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. (v13 Gotham addition)
ChapterOrBigStepBack Go to previous chapter in video, If no chapters, then step back 10 minutes in video. (v13 Gotham addition)
NextScene Go to next scene that is marked in an Edit_decision_list file.
PreviousScene Go to previous scene that is marked in an Edit_decision_list file.
OSD Toggles the OSD (On Screen Display) while playing an item.
PlayDVD Start playing a DVD (goes to the DVD menu)
ShowVideoMenu Go to the DVD Video menu when playing a DVD.
ShowSubtitles Toggles whether subtitles are shown or not.
NextSubtitle Change to the next subtitle language, if there is more than one (does not allow subtitles to be disabled).
PreviousSubtitle Change to the previous subtitle language, if there is more than one (does not allow subtitles to be disabled). (v22 Piers addition)
CycleSubtitle Change to the next subtitle language, if there is more than one (it also allow subtitles to be disabled).
SubtitleShiftUp Move subtitles up
SubtitleShiftDown Move subtitles down
SubtitleAlign Subtitle position control
CodecInfo Show codec information about the currently playing item (during video or visualisation playback)
PlayerProcessInfo Show player process information about the currently playing item (during video or visualisation playback)
PlayerProgramSelect Show dialog to select a program tv channel (during video playback)
NextPicture Move to the next picture in a slideshow.
PreviousPicture Move to the previous picture in a slideshow.
ZoomOut Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
ZoomIn Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
IncreasePAR Used in video fullscreen to increase the pixel aspect ratio (stretch).
DecreasePAR Used in video fullscreen to decrease the pixel aspect ratio (stretch).
Queue Queue the item to the current playlist
PlayNext Queue the item to the next position in the current playlist
Filter Opens the mediafilter dialog in the video and musiclibrary. Used in the advanced filter for the video library.
Playlist Toggle to playlist view from My Music or My Videos
ZoomNormal Normal (fullscreen) viewing in My Pictures
ZoomLevel1 Zoom to 120% in My Pictures
ZoomLevel2 Zoom to 150% in My Pictures
ZoomLevel3 Zoom to 200% in My Pictures
ZoomLevel4 Zoom to 280% in My Pictures
ZoomLevel5 Zoom to 400% in My Pictures
ZoomLevel6 Zoom to 600% in My Pictures
ZoomLevel7 Zoom to 900% in My Pictures
ZoomLevel8 Zoom to 1350% in My Pictures
ZoomLevel9 Zoom to 2000% in My Pictures
NextCalibration Used in Video + GUI calibration
ResetCalibration Used in Video + GUI calibration
AnalogMove Move in the calibration screens, and while zoomed in My Pictures.
Rotate Rotate a picture in My Pictures
rotateccw Rotate current picture counterclockwise during slideshow.
Close Used to close a dialog
subtitledelay Show the current delay amount of subtitles.
SubtitleDelayMinus Decrease the delay amount of subtitles (use if subtitles are displaying too late)
SubtitleDelayPlus Increase the delay amount of subtitles (use if subtitles are displaying too early)
audiodelay Show the current delay amount of audio.
AudioDelayMinus Decrease the delay amount of audio (use if audio is being heard too early)
AudioDelayPlus Increase the delay amount of audio (use if audio is being heard too late)
AudioNextLanguage Change to the next audio track in a video with multiple audio tracks.
NextResolution Used in Video calibration
Number<0-9> Used to input the number 0 through 9
FastForward Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
Rewind Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
Play Play the selected item (or folder of items).
PlayPause Play the selected item (or folder of items). Will also pause media when something is already playing.
Delete Used in My Files to delete a file.
Copy Used in My Files to copy a file.
Move Used in My Files to move a file.
Rename Used in My Files to rename a file.
HideSubmenu <depreciated>
Screenshot Take a screenshot of the current screen.
Reboot Reboot
ShutDown() Shutdown and power off
VolumeUp Increase the volume of playback.
VolumeDown Decrease the volume of playback.
Mute Mute the volume.
volampup Increase volume amplification.
volampdown Decrease volume amplification.
audiotoggledigital Switch between digital / analog audio.
BackSpace Used in the virtual keyboards to delete one letter.
ScrollUp Variable speed scroll up for analog keys (stick or triggers)
ScrollDown Variable speed scroll down for analog keys (stick or triggers)
AnalogFastForward Variable speed fast forward for analog keys (stick or triggers)
AnalogRewind Variable speed rewind for analog keys (stick or triggers)
AnalogSeekForward Variable speed seeking for analog keys (stick or triggers)
AnalogSeekBack Variable speed seeking for analog keys (stick or triggers)
MoveItemUp Used to rearrange playlists
MoveItemDown Used to rearrange playlists
Menu Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) (v16 Jarvis addition)
ContextMenu Pops up a contextual menu
Shift Used in Virtual Keyboard to switch to upper or lower case letters
Symbols Used in Virtual Keyboard to switch to or from symbols mode
CursorLeft Used in Virtual Keyboard to move the current cursor point to the left
CursorRight Used in Virtual Keyboard to move the current cursor point to the right
ShowTime Used to show the current play time in music + video playback
visualisationpresetlist Shows the visualisation preset list
ShowPreset Shows the current visualisation preset (milkdrop/spectrum)
NextPreset Next visualisation preset
PreviousPreset Previous visualisation preset
LockPreset Lock the current visualisation preset
RandomPreset Switch to a new random preset
IncreaseRating Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
DecreaseRating Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
ToggleWatched Toggles watched/unwatched status for Videos
NextLetter Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
PrevLetter Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
JumpSMS<2-9> Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
FilterSMS<2-9> Filter a list in music or videos using SMS-style input.
verticalshiftup Shift up video image currently played.
verticalshiftdown Shift down video image currently played.
scanitem Scan selected item for video or music files.
reloadkeymaps Reload keymap, loading any changes made to the keymap since started up.
increasevisrating Increase the preset rate for visualization.
decreasevisrating Decrease the preset rate for visualization.
firstpage Move to the first element of the page.
lastpage Move to the last element of the page.
guiprofile ? (ACTION_GUIPROFILE_BEGIN)
red Used to simulate red button click for the teletext.
green Used to simulate green button click for the teletext.
yellow Used to simulate yellow button click for the teletext.
blue Used to simulate blue button click for the teletext.
CreateBookmark Creates a bookmark of the currently playing Video (v13 Gotham addition)
CreatEpisodeBookmark Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode (v13 Gotham addition)
NextChannelGroup PVR Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. (v13 Gotham addition)
PreviousChannelGroup PVR Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. (v13 Gotham addition)
ChannelUp PVR Used to switch up to the next channel. Works only if you playback TV or radio (v13 Gotham addition)
ChannelDown PVR Used to switch down to the previous channel. Works only if you playback TV or radio(v13 Gotham addition)
PlayPvr PVR Starts playback a TV or radio channel depends on the last played channel. (v13 Gotham addition)
PlayPvrTV PVR Starts playback a TV channel. Will playback the last played channel if available. (v13 Gotham addition)
PlayPvrRadio PVR Starts playback a radio channel. Will playback the last played channel if available. (v13 Gotham addition)
Record PVR record current playing channel or selected item in windows like EPG (v13 Gotham addition)
ToggleCommSkip Enable / Disable commercial skipping (based on Edit_decision_list file) during video playback.
StereoMode Toggle 3D/Stereoscopic mode (v13 Gotham addition)
ToggleStereoMode Toggle 3D/Stereoscopic mode (v13 Gotham addition)
SwitchPlayer Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players. (v13 Gotham addition)
UpdateLibrary(video) Update Movie/TV-Show library (only tested with v13 Gotham addition).
SetRating For use when playing music. Will pop-up a 1-10 userrating select dialog, to rate the currently playing song. (v17 Krypton addition)
DialogSelectVideo Open a window dialog to select a video stream. (v22 Piers addition)
DialogSelectAudio Open a window dialog to select an audio stream. (v22 Piers addition)
DialogSelectSubtitle Open a window dialog to select a subtitle stream. (v22 Piers addition)
Other
Action Description
noop No action. Used to specifically disable a key.


Removed action IDs

  • PresetList - replaced with visualisationpresetlist in a previous version (unknown?)

See also

Retrieved from "https://kodi.wiki/index.php?title=Action_IDs&oldid=253895"