Action IDs: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(http://wiki.xbmc.org/index.php?title=Keymap&oldid=52359)
Line 1: Line 1:
{{XBMC wiki toc}}
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].
This is a list of all predefined actions in XBMC. Additional actions are available by using built-in functions. See [[List of Built In Functions]] for more details on the built-in functions.
{|


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]


=== General actions available throughout most of XBMC ===
A full list of Sections is here: [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp#L228 ButtonTranslator.cpp]
{| class="wikitable"
|- 
|  '''Action'''
|  '''Description'''
|- 
|  left
|  Left
|- 
|  right
|  Right
|- 
|  up
|  Up
|- 
|  down
|  Down
|- 
|  pageup
|  Page Up
|- 
|  pagedown
|  Page Down
|- 
|  select
|  Select Item
|- 
|  highlight
|  Highlight Item
|- 
|  parentdir
|  Go to the parent directory (cd ..)
|- 
|  previousmenu
|  Go back a menu
|- 
|  info
|  Show Info
|- 
|  screenshot
|  Takes a screenshot
|- 
|  poweroff
|  Power off the device
|- 
|  volumeup
|  Increase volume
|- 
|  volumedown
|  Decrease volume
|- 
|  mute
|  Mute
|- 
|  contextmenu
|  Toggle the context menu
|- 
|  scrollup
|  Scroll Up in list
|- 
|  scrolldown
|  Scroll Down in list
|- 
|  close
|  Close open dialog box
|-
|  togglefullscreen
|  Switch between fullscreen and window mode
|- 
|  number0
|  Remote number 0
|- 
|  number1
|  Remote number 1
|- 
|  number2
|  Remote number 2
|- 
|  number3
|  Remote number 3
|- 
|  number4
|  Remote number 4
|- 
|  number5
|  Remote number 5
|- 
|  number6
|  Remote number 6
|- 
|  number7
|  Remote number 7
|- 
|  number8
|  Remote number 8
|- 
|  number9
|  Remote number 9
|}
 
=== General actions available while video or music are playing ===
{| class="wikitable"
|- 
|  '''Action'''
|  '''Description'''
|- 
|  play
|  Play & Unpause
|- 
|  pause
|  Pause & Unpause
|- 
|  stop
|  Stop
|- 
|  fastforward
|  Fast Forward
|- 
|  rewind
|  Rewind
|- 
|  skipnext
|  Skip to next item in playlist
|- 
|  skipprevious
|  Skip to previous item in playlist
|- 
|  fullscreen
|  Switch between GUI and Video or Visualisation
|- 
|  [[codecinfo]]
|  Shows codec information
|- 
|  analogseekforward
|  Forward analog control of the seek bar
|- 
|  analogseekback
|  Backward analog control of the seek bar
|- 
|  analogfastforward
|  Analog Fastfoward
|- 
|  analogrewind
|  Analog Rewind
|}


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]


=== Actions available only in Music and Videos windows only ===
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.
{| class="wikitable"
|- 
|  '''Action'''
|  '''Description'''
|- 
|  playlist
|  Shows the current playlist
|- 
|  queue
|  Queues the current item
|}
|


 
{| class="wikitable"  
=== Actions available only in playlists view (Now Showing) ===
|-  
{| class="wikitable"
| '''Action'''
|-
| '''Description'''
|   '''Action'''
|-  
|   '''Description'''
|  Left
|-   
|  Move left off a control.
|   moveitemup
|-
|   Move item up in playlist
|  Right
|-   
|  Move right off a control.
|   moveitemdown
|-
|   Move item down in playlist
|  Up
|}
| Move up off a control.
 
|-
 
| Down
=== Actions available only in Full Screen Video ===
| Move down off a control.
{| class="wikitable"
|-
|-   
|  Select
|   '''Action'''
|  Select a button, or an item from a list of thumb view.
|   '''Description'''
|-
|-   
|  PageUp
|   stepforward
|  Scroll up on page in a list, thumb, or text view.
|   Small jump forward in playtime
|-  
|-   
|  PageDown
|   stepback
| Scroll down on page in a list, thumb, or text view.
|   Small jump backward in playtime
|-
|-   
| Highlight
|   bigstepforward
|  Highlight an item in a list or thumb view.
|   Big jump forward in playtime, or next chapter
|-
|-   
| ParentDir
|   bigstepback
|  Go up a folder to the parent folder.
|   Big jumpbackward in playtime, or previous chapter
|-
|-   
|  PreviousMenu
|   smallstepback
| Go back to the previous menu screen.
|   Jump back 7 seconds
|-  
|-   
| Info
|   osd
| Show the information about the currently highlighted item, or currently playing item.
|   Show OSD
|-
|-   
|  Pause
|   aspectratio
| Pause the currently playing item.
|   Switch between zoom modes
|-  
|-   
|  Stop
|   showsubtitles
| Stop the currently playing item.
|   Toggle subtitles on or off
|-
|-   
| SkipNext
|   nextsubtitle
| Skip to the next item in a playlist or scene in a video.
|   Switch to next subtitle
|-  
|-   
|  SkipPrevious
|   subtitledelay
| Skip to the previous item in a playlist or scene in a video.
|   Show subtitle delay slider
|-
|-   
| FullScreen
|   subtitledelayminus
|  Toggles fullscreen modes (either visualisation or video playback)
|   Decrease subtitle delay
|-  
|-   
| AspectRatio
|   subtitledelayplus
| Toggle through the various aspect ratio modes (Normal is the preferred option).
|   Increase subtitle delay
|-
|-   
|  StepForward
|   audiodelay
|  Step forward 1% in the movie.
|   Show audio delay slider
|-  
|-   
|  StepBack
|   audiodelayminus
| Step back 1% in the movie.
|   Decrease AV sync delay
|-
|-
| BigStepForward
|   audiodelayplus
|  Step forward 10% in the movie.
|   Increase AV sync delay
|-  
|-
| BigStepBack
|   audionextlanguage
| Step back 10% in the movie.
|   Switch to next audio track
|-
|-   
| SmallStepBack
|   showtime
|  Step back 7 seconds in the current video.
|   Show current play time
|-  
|-   
| OSD
|   showvideomenu
|  Toggles the OSD while playing an item.
|   Show DVD menu (not implemented yet)
|-
|}
| PlayDVD
 
| Start playing a DVD (goes to the DVD menu)
=== Actions available during a picture slideshow ===
|-
{| class="wikitable"
|  ShowVideoMenu
|-   
|  Go to the DVD Video menu when playing a DVD.
|   '''Action'''
|-
|   '''Description'''
|  ShowSubtitles
|-   
|  Toggles whether subtitles are shown or not.
|   nextpicture
|-
|   Skips to next picture in slideshow
|  NextSubtitle
|-   
|  Change to the next subtitle language, if there is more than one.
|   previouspicture
|-
|   Skips to previous picture in slideshow
|  CodecInfo
|-   
|  Show codec information about the currently playing item (during video or visualisation playback)
|   zoomout
|-
|   Decreases zoom by one level
|  NextPicture
|-   
|  Move to the next picture in a slideshow.
|   zoomin
|-
|   Increases zoom by one level
|  PreviousPicture
|-   
|  Move to the previous picture in a slideshow.
|   zoomnormal
|-  
|   Normal zoom level (100%)
| ZoomOut
|-   
| Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|   zoomlevel1
|-
|   Zoom level 1 (120%)
|  ZoomIn
|-   
|  Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|   zoomlevel2
|-
|   Zoom level 2 (150%)
|  IncreasePAR
|-   
|  Used in video fullscreen to increase the pixel aspect ratio (stretch).
|   zoomlevel3
|-
|   Zoom level 3 (200%)
|  DecreasePAR
|-
|  Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|   zoomlevel4
|-  
|   Zoom level 4 (280%)
|  Queue
|-   
| Queue the item to the current playlist
|   zoomlevel5
|-
|   Zoom level 5 (400%)
| Playlist
|-   
|  Toggle to playlist view from My Music or My Videos
|   zoomlevel6
|-
|   Zoom level 6 (600%)
|  ZoomNormal
|-   
|  Normal (fullscreen) viewing in My Pictures
|   zoomlevel7
|-
|   Zoom level 7 (900%)
|  ZoomLevel1
|-
|  Zoom to 120% in My Pictures
|   zoomlevel8
|-
|   Zoom level 8 (1350%)
|  ZoomLevel2
|-   
|  Zoom to 150% in My Pictures
|   zoomlevel9
|-
|   Zoom level 9 (2000%)
|  ZoomLevel3
|-   
|  Zoom to 200% in My Pictures
|   analogmove
|-
|   Move around a zoomed picture
|  ZoomLevel4
|-   
|  Zoom to 280% in My Pictures
|   rotate
|-  
|   Rotate picture 90 degrees
|  ZoomLevel5
|}
| Zoom to 400% in My Pictures
 
|-
 
|  ZoomLevel6
=== Actions available in screen calibration ===
| Zoom to 600% in My Pictures
{| class="wikitable"
|-  
|-   
| ZoomLevel7
|   '''Action'''
| Zoom to 900% in My Pictures
|   '''Description'''
|-
|-
|  ZoomLevel8
|   nextcalibration
|  Zoom to 1350% in My Pictures
|   Switches between arrows in video screen calibration
|-  
|-   
|  ZoomLevel9
|   resetcalibration
| Zoom to 2000% in My Pictures
|   Reset video screen calibation to defaults
|-
|-   
| NextCalibration
|   analogmove
|  Used in Video + GUI calibration
|   Move the items in video screen calibration
|-  
|-   
| ResetCalibration
|   nextresolution
| Used in Video + GUI calibration
|   Change to next resolution during video screen calibration
|-
| AnalogMove
|  Move in the calibration screens, and while zoomed in My Pictures.
|-  
|  Rotate
| Rotate a picture in My Pictures
|-
| Close
|  Used to close a dialog
|-
|  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)
|-
| 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
|-
|  Number0
|  Used to input the number 0
|-  
| Number1
| Used to input the number 1
|-
|  Number2
| Used to input the number 2
|-
|  Number3
| Used to input the number 3
|-  
| Number4
| Used to input the number 4
|-
|  Number5
| Used to input the number 5
|-  
| Number6
| Used to input the number 6
|-
| Number7
|  Used to input the number 7
|-  
| Number8
|  Used to input the number 8
|-
| Number9
| Used to input the number 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), or unpause a paused item.
|-
|  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.
|-
|  XBMC.ShutDown()
|  Shutdown and power off
|-  
| VolumeUp
| Increase the volume of playback.
|-
|  VolumeDown
|  Decrease the volume of playback.
|-
|  Mute
|  Mute the volume.
|-
|  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
|-
|  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
|-
|  ShowPreset
|  Shows the current visualisation preset (milkdrop/spectrum)
|-  
| PresetList
| Pops up the visualisation preset list (milkdrop/spectrum)
|-  
|  NextPreset
| Next visualisation preset
|-
| PreviousPreset
|  Previous visualisation preset
|-  
| LockPreset
|  Lock the current visualisation preset
|-
| RandomPreset
| Switch to a new random preset
|-  
| IncreaseRating
| Unused
|-
| DecreaseRating
|  Unused
|-
|  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.
|-
|  JumpSMS2-9
| Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-  
| FilterSMS2-9
| Filter a list in music or videos using SMS-style input.
|-  
| XBMC.ActivateWindow(MyVideos)
| Go to My Videos.
|-
|  XBMC.ActivateWindow(MyMusic)
| Go to My Music.
|-  
| XBMC.ActivateWindow(MyPictures)
| Go to My Pictures.
|-
|  XBMC.ActivateWindow(Home)
|  Go to Home window.  Go back from within a context in the UI.
|-
| 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. 
|}
|}
=== Actions available in the File Manager ===
{| class="wikitable"
|- 
|  '''Action'''
|  '''Description'''
|- 
|  delete
|  Delete current item (also valid in music, video, pictures, and playlist windows)
|- 
|  copy
|  Copy current item
|- 
|  move
|  Move current item
|- 
|  rename
|  Renames current item
|}
=== Actions available during a music visualisation ===
{| class="wikitable"
|- 
|  '''Action'''
|  '''Description'''
|- 
|  osd
|  Show OSD
|- 
|  showpreset
|  Displays current preset
|- 
|  ActivateWindow(VisualisationPresetList)
|  Displays preset menu
|- 
|  nextpreset
|  Next preset
|- 
|  previouspreset
|  Previous preset
|- 
|  lockpreset
|  Lock current preset
|- 
|  randompreset
|  Pick a random preset
|- 
|  increaserating
|  Increase preset rating
|- 
|  decreaserating
|  Decrease preset rating
|}
|}
[[Category:Development]]
[[Category:Python]]
[[Category:Skin Development]]
[[Category:Remotes]]

Revision as of 16:04, 29 October 2012

An up to date list of the available actions can be found in the TranslateActionString() method in in ButtonTranslator.cpp.

A reference of default XBMC keys and their associated actions can be found in: Default keymaps shipped with xbmc

A full list of Sections is here: ButtonTranslator.cpp

For those debugging integer action codes from the debug log, the mapping of action codes to constants is in Key.h

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.

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.
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.
PreviousMenu Go back to the previous menu screen.
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 the next item in a playlist or scene in a video.
SkipPrevious Skip to the previous item in a playlist or scene in a video.
FullScreen Toggles fullscreen modes (either visualisation or video playback)
AspectRatio Toggle through the various aspect ratio modes (Normal is the preferred option).
StepForward Step forward 1% in the movie.
StepBack Step back 1% in the movie.
BigStepForward Step forward 10% in the movie.
BigStepBack Step back 10% in the movie.
SmallStepBack Step back 7 seconds in the current video.
OSD Toggles the OSD 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.
CodecInfo Show codec information about the currently playing item (during video or visualisation 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
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
Close Used to close a dialog
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)
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
Number0 Used to input the number 0
Number1 Used to input the number 1
Number2 Used to input the number 2
Number3 Used to input the number 3
Number4 Used to input the number 4
Number5 Used to input the number 5
Number6 Used to input the number 6
Number7 Used to input the number 7
Number8 Used to input the number 8
Number9 Used to input the number 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), or unpause a paused item.
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.
XBMC.ShutDown() Shutdown and power off
VolumeUp Increase the volume of playback.
VolumeDown Decrease the volume of playback.
Mute Mute the volume.
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
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
ShowPreset Shows the current visualisation preset (milkdrop/spectrum)
PresetList Pops up the visualisation preset list (milkdrop/spectrum)
NextPreset Next visualisation preset
PreviousPreset Previous visualisation preset
LockPreset Lock the current visualisation preset
RandomPreset Switch to a new random preset
IncreaseRating Unused
DecreaseRating Unused
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.
JumpSMS2-9 Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
FilterSMS2-9 Filter a list in music or videos using SMS-style input.
XBMC.ActivateWindow(MyVideos) Go to My Videos.
XBMC.ActivateWindow(MyMusic) Go to My Music.
XBMC.ActivateWindow(MyPictures) Go to My Pictures.
XBMC.ActivateWindow(Home) Go to Home window. Go back from within a context in the UI.
XBMC.ActivateWindow(type,path to playlist) Opens the window for the desired playlist
XBMC.ActivateWindow(windowid) Go a window specified by ''windowid. See the list of window IDs for the list of valid values. Not all ids will work on all themes.
Retrieved from "https://kodi.wiki/index.php?title=Action_IDs&oldid=54551"