Kodi Development  20.0
for Binary and Script based Add-Ons

Detailed Description

Action Id's
Actions that we have defined.

Enumeration Type Documentation

◆ ADDON_ACTION

Enumerator
ADDON_ACTION_NONE 

0: None.

ADDON_ACTION_MOVE_LEFT 

1: Move left.

ADDON_ACTION_MOVE_RIGHT 

2: Move right.

ADDON_ACTION_MOVE_UP 

3: Move up.

ADDON_ACTION_MOVE_DOWN 

4: Move down.

ADDON_ACTION_PAGE_UP 

5: Page up.

ADDON_ACTION_PAGE_DOWN 

6: Page down.

ADDON_ACTION_SELECT_ITEM 

7: Select item.

ADDON_ACTION_HIGHLIGHT_ITEM 

8: Highlight item.

ADDON_ACTION_PARENT_DIR 

9: Parent directory.

ADDON_ACTION_PREVIOUS_MENU 

10: Previous menu.

ADDON_ACTION_SHOW_INFO 

11: Show info.

ADDON_ACTION_PAUSE 

12: Pause.

ADDON_ACTION_STOP 

13: Stop.

ADDON_ACTION_NEXT_ITEM 

14: Next item.

ADDON_ACTION_PREV_ITEM 

15: Previous item.

ADDON_ACTION_FORWARD 

16: Can be used to specify specific action in a window, Playback control is handled in ADDON_ACTION_PLAYER_*

ADDON_ACTION_REWIND 

17: Can be used to specify specific action in a window, Playback control is handled in ADDON_ACTION_PLAYER_*

ADDON_ACTION_SHOW_GUI 

18: Toggle between GUI and movie or GUI and visualisation.

ADDON_ACTION_ASPECT_RATIO 

19: Toggle quick-access zoom modes. Can b used in videoFullScreen.zml window id=2005

ADDON_ACTION_STEP_FORWARD 

20: Seek +1% in the movie. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_STEP_BACK 

21: Seek -1% in the movie. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_BIG_STEP_FORWARD 

22: Seek +10% in the movie. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_BIG_STEP_BACK 

23: Seek -10% in the movie. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_SHOW_OSD 

24: Show/hide OSD. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_SHOW_SUBTITLES 

25: Turn subtitles on/off. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_NEXT_SUBTITLE 

26: Switch to next subtitle of movie. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_PLAYER_DEBUG 

27: Show debug info for VideoPlayer

ADDON_ACTION_NEXT_PICTURE 

28: Show next picture of slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_PREV_PICTURE 

29: Show previous picture of slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_ZOOM_OUT 

30: Zoom in picture during slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_ZOOM_IN 

31: Zoom out picture during slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_TOGGLE_SOURCE_DEST 

32: Used to toggle between source view and destination view. Can be used in myfiles.xml window id=3

ADDON_ACTION_SHOW_PLAYLIST 

33: Used to toggle between current view and playlist view. Can b used in all mymusic xml files

ADDON_ACTION_QUEUE_ITEM 

34: Used to queue a item to the playlist. Can b used in all mymusic xml files

ADDON_ACTION_REMOVE_ITEM 

35: Not used anymore

ADDON_ACTION_SHOW_FULLSCREEN 

36: Not used anymore

ADDON_ACTION_ZOOM_LEVEL_NORMAL 

37: Zoom 1x picture during slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_ZOOM_LEVEL_1 

38: Zoom 2x picture during slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_ZOOM_LEVEL_2 

39: Zoom 3x picture during slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_ZOOM_LEVEL_3 

40: Zoom 4x picture during slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_ZOOM_LEVEL_4 

41: Zoom 5x picture during slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_ZOOM_LEVEL_5 

42: Zoom 6x picture during slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_ZOOM_LEVEL_6 

43: Zoom 7x picture during slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_ZOOM_LEVEL_7 

44: Zoom 8x picture during slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_ZOOM_LEVEL_8 

45: Zoom 9x picture during slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_ZOOM_LEVEL_9 

46: Zoom 10x picture during slideshow. Can b used in slideshow.xml window id=2007

ADDON_ACTION_CALIBRATE_SWAP_ARROWS 

47: Select next arrow. Can b used in: settingsScreenCalibration.xml windowid=11

ADDON_ACTION_CALIBRATE_RESET 

48: Reset calibration to defaults. Can b used in: settingsScreenCalibration.xml windowid=11/settingsUICalibration.xml windowid=10

ADDON_ACTION_ANALOG_MOVE 

49: Analog thumbstick move. Can b used in: slideshow.xml windowid=2007/settingsScreenCalibration.xml windowid=11/settingsUICalibration.xml windowid=10

Note
see also ADDON_ACTION_ANALOG_MOVE_X_LEFT, ADDON_ACTION_ANALOG_MOVE_X_RIGHT, ADDON_ACTION_ANALOG_MOVE_Y_UP, ADDON_ACTION_ANALOG_MOVE_Y_DOWN
ADDON_ACTION_ROTATE_PICTURE_CW 

50: Rotate current picture clockwise during slideshow. Can be used in slideshow.xml window id=2007

ADDON_ACTION_ROTATE_PICTURE_CCW 

51: Rotate current picture counterclockwise during slideshow. Can be used in slideshow.xml window id=2007

ADDON_ACTION_SUBTITLE_DELAY_MIN 

52: Decrease subtitle/movie Delay. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_SUBTITLE_DELAY_PLUS 

53: Increase subtitle/movie Delay. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_AUDIO_DELAY_MIN 

54: Increase avsync delay. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_AUDIO_DELAY_PLUS 

55: Decrease avsync delay. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_AUDIO_NEXT_LANGUAGE 

56: Select next language in movie. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_CHANGE_RESOLUTION 

57: Switch 2 next resolution. Can b used during screen calibration settingsScreenCalibration.xml windowid=11

ADDON_ACTION_REMOTE_0 

58: remote keys 0-9. are used by multiple windows for example in videoFullScreen.xml window id=2005 you can enter time (mmss) to jump to particular point in the movie with spincontrols you can enter 3digit number to quickly set spincontrol to desired value

Remote key 0

ADDON_ACTION_REMOTE_1 

59: Remote key 1

ADDON_ACTION_REMOTE_2 

60: Remote key 2

ADDON_ACTION_REMOTE_3 

61: Remote key 3

ADDON_ACTION_REMOTE_4 

62: Remote key 4

ADDON_ACTION_REMOTE_5 

63: Remote key 5

ADDON_ACTION_REMOTE_6 

64: Remote key 6

ADDON_ACTION_REMOTE_7 

65: Remote key 7

ADDON_ACTION_REMOTE_8 

66: Remote key 8

ADDON_ACTION_REMOTE_9 

67: Remote key 9

ADDON_ACTION_PLAYER_PROCESS_INFO 

69: Show player process info (video decoder, pixel format, pvr signal strength and the like

ADDON_ACTION_PLAYER_PROGRAM_SELECT 

70: Program select.

ADDON_ACTION_PLAYER_RESOLUTION_SELECT 

71: Resolution select.

ADDON_ACTION_SMALL_STEP_BACK 

76: Jumps a few seconds back during playback of movie. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_PLAYER_FORWARD 

77: FF in current file played. global action, can be used anywhere

ADDON_ACTION_PLAYER_REWIND 

78: RW in current file played. global action, can be used anywhere

ADDON_ACTION_PLAYER_PLAY 

79: Play current song. Unpauses song and sets playspeed to 1x. global action, can be used anywhere

ADDON_ACTION_DELETE_ITEM 

80: Delete current selected item. Can be used in myfiles.xml window id=3 and in myvideoTitle.xml window id=25

ADDON_ACTION_COPY_ITEM 

81: Copy current selected item. Can be used in myfiles.xml window id=3

ADDON_ACTION_MOVE_ITEM 

82: move current selected item. Can be used in myfiles.xml window id=3

ADDON_ACTION_TAKE_SCREENSHOT 

85: Take a screenshot.

ADDON_ACTION_RENAME_ITEM 

87: Rename item.

ADDON_ACTION_VOLUME_UP 

87: Volume up.

ADDON_ACTION_VOLUME_DOWN 

87: Volume down.

ADDON_ACTION_VOLAMP 

90: Volume amplication.

ADDON_ACTION_MUTE 

90: Mute.

ADDON_ACTION_NAV_BACK 

90: Nav back.

ADDON_ACTION_VOLAMP_UP 

90: Volume amp up,

ADDON_ACTION_VOLAMP_DOWN 

94: Volume amp down.

ADDON_ACTION_CREATE_EPISODE_BOOKMARK 

95: Creates an episode bookmark on the currently playing video file containing more than one episode

ADDON_ACTION_CREATE_BOOKMARK 

96: Creates a bookmark of the currently playing video file

ADDON_ACTION_CHAPTER_OR_BIG_STEP_FORWARD 

97: Goto the next chapter, if not available perform a big step forward

ADDON_ACTION_CHAPTER_OR_BIG_STEP_BACK 

98: Goto the previous chapter, if not available perform a big step back

ADDON_ACTION_CYCLE_SUBTITLE 

99: Switch to next subtitle of movie, but will not enable/disable the subtitles. Can be used in videoFullScreen.xml window id=2005

ADDON_ACTION_MOUSE_START 

100: Mouse action values start.

Ends with ADDON_ACTION_MOUSE_END.

ADDON_ACTION_MOUSE_LEFT_CLICK 

100: Mouse left click.

ADDON_ACTION_MOUSE_RIGHT_CLICK 

101: Mouse right click.

ADDON_ACTION_MOUSE_MIDDLE_CLICK 

102: Mouse middle click.

ADDON_ACTION_MOUSE_DOUBLE_CLICK 

103: Mouse double click.

ADDON_ACTION_MOUSE_WHEEL_UP 

104: Mouse wheel up.

ADDON_ACTION_MOUSE_WHEEL_DOWN 

105: Mouse wheel down.

ADDON_ACTION_MOUSE_DRAG 

106: Mouse drag.

ADDON_ACTION_MOUSE_MOVE 

107: Mouse move.

ADDON_ACTION_MOUSE_LONG_CLICK 

108: Mouse long click.

ADDON_ACTION_MOUSE_DRAG_END 

109: Mouse drag end.

ADDON_ACTION_MOUSE_END 

109: Mouse action values end.

Starts with ADDON_ACTION_MOUSE_START.

ADDON_ACTION_BACKSPACE 

110: Backspace.

ADDON_ACTION_SCROLL_UP 

111: Scroll up.

ADDON_ACTION_SCROLL_DOWN 

112: Scroll down.

ADDON_ACTION_ANALOG_FORWARD 

113: Analog forward.

ADDON_ACTION_ANALOG_REWIND 

114: Analog rewind.

ADDON_ACTION_MOVE_ITEM_UP 

115: move item up in playlist

ADDON_ACTION_MOVE_ITEM_DOWN 

116: move item down in playlist

ADDON_ACTION_CONTEXT_MENU 

117: pops up the context menu

ADDON_ACTION_SHIFT 

118: stuff for virtual keyboard shortcuts

ADDON_ACTION_SYMBOLS 

119: stuff for virtual keyboard shortcuts

ADDON_ACTION_CURSOR_LEFT 

120: stuff for virtual keyboard shortcuts

ADDON_ACTION_CURSOR_RIGHT 

121: stuff for virtual keyboard shortcuts

ADDON_ACTION_BUILT_IN_FUNCTION 

122: Build in function

ADDON_ACTION_SHOW_OSD_TIME 

114: Displays current time, can be used in videoFullScreen.xml window id=2005

ADDON_ACTION_ANALOG_SEEK_FORWARD 

124: Seeks forward, and displays the seek bar.

ADDON_ACTION_ANALOG_SEEK_BACK 

125: Seeks backward, and displays the seek bar.

ADDON_ACTION_VIS_PRESET_SHOW 

126: Visualization preset show.

ADDON_ACTION_VIS_PRESET_NEXT 

128: Visualization preset next.

ADDON_ACTION_VIS_PRESET_PREV 

129: Visualization preset previous.

ADDON_ACTION_VIS_PRESET_LOCK 

130: Visualization preset lock.

ADDON_ACTION_VIS_PRESET_RANDOM 

131: Visualization preset random.

ADDON_ACTION_VIS_RATE_PRESET_PLUS 

132: Visualization preset plus.

ADDON_ACTION_VIS_RATE_PRESET_MINUS 

133: Visualization preset minus.

ADDON_ACTION_SHOW_VIDEOMENU 

134: Show Videomenu

ADDON_ACTION_ENTER 

135: Enter.

ADDON_ACTION_INCREASE_RATING 

136: Increase rating.

ADDON_ACTION_DECREASE_RATING 

137: Decrease rating.

ADDON_ACTION_NEXT_SCENE 

138: Switch to next scene/cutpoint in movie.

ADDON_ACTION_PREV_SCENE 

139: Switch to previous scene/cutpoint in movie.

ADDON_ACTION_NEXT_LETTER 

140: Jump through a list or container to next letter.

ADDON_ACTION_PREV_LETTER 

141: Jump through a list or container to previous letter.

ADDON_ACTION_JUMP_SMS2 

142: Jump direct to a particular letter using SMS-style input

Jump to SMS2.

ADDON_ACTION_JUMP_SMS3 

143: Jump to SMS3.

ADDON_ACTION_JUMP_SMS4 

144: Jump to SMS4.

ADDON_ACTION_JUMP_SMS5 

145: Jump to SMS5.

ADDON_ACTION_JUMP_SMS6 

146: Jump to SMS6.

ADDON_ACTION_JUMP_SMS7 

147: Jump to SMS7.

ADDON_ACTION_JUMP_SMS8 

148: Jump to SMS8.

ADDON_ACTION_JUMP_SMS9 

149: Jump to SMS9.

ADDON_ACTION_FILTER_CLEAR 

150: Filter clear.

ADDON_ACTION_FILTER_SMS2 

151: Filter SMS2.

ADDON_ACTION_FILTER_SMS3 

152: Filter SMS3.

ADDON_ACTION_FILTER_SMS4 

153: Filter SMS4.

ADDON_ACTION_FILTER_SMS5 

154: Filter SMS5.

ADDON_ACTION_FILTER_SMS6 

155: Filter SMS6.

ADDON_ACTION_FILTER_SMS7 

156: Filter SMS7.

ADDON_ACTION_FILTER_SMS8 

157: Filter SMS8.

ADDON_ACTION_FILTER_SMS9 

158: Filter SMS9.

ADDON_ACTION_FIRST_PAGE 

159: First page.

ADDON_ACTION_LAST_PAGE 

160: Last page.

ADDON_ACTION_AUDIO_DELAY 

161: Audio delay.

ADDON_ACTION_SUBTITLE_DELAY 

162: Subtitle delay.

ADDON_ACTION_MENU 

163: Menu.

ADDON_ACTION_SET_RATING 

164: Set rating.

ADDON_ACTION_RECORD 

170: Record.

ADDON_ACTION_PASTE 

180: Paste.

ADDON_ACTION_NEXT_CONTROL 

181: Next control.

ADDON_ACTION_PREV_CONTROL 

182: Previous control.

ADDON_ACTION_CHANNEL_SWITCH 

183: Channel switch.

ADDON_ACTION_CHANNEL_UP 

184: Channel up.

ADDON_ACTION_CHANNEL_DOWN 

185: Channel down.

ADDON_ACTION_NEXT_CHANNELGROUP 

186: Next channel group.

ADDON_ACTION_PREVIOUS_CHANNELGROUP 

187: Previous channel group.

ADDON_ACTION_PVR_PLAY 

188: PVR play.

ADDON_ACTION_PVR_PLAY_TV 

189: PVR play TV.

ADDON_ACTION_PVR_PLAY_RADIO 

190: PVR play radio.

ADDON_ACTION_PVR_SHOW_TIMER_RULE 

191: PVR show timer rule.

ADDON_ACTION_CHANNEL_NUMBER_SEP 

192: Channel number sep

ADDON_ACTION_PVR_ANNOUNCE_REMINDERS 

193: PVR announce reminders

ADDON_ACTION_TOGGLE_FULLSCREEN 

199: Switch 2 desktop resolution

ADDON_ACTION_TOGGLE_WATCHED 

200: Toggle watched status (videos)

ADDON_ACTION_SCAN_ITEM 

201: Scan item

ADDON_ACTION_TOGGLE_DIGITAL_ANALOG 

202: Switch digital <-> analog

ADDON_ACTION_RELOAD_KEYMAPS 

203: Reloads CButtonTranslator's keymaps

ADDON_ACTION_GUIPROFILE_BEGIN 

204: Start the GUIControlProfiler running

ADDON_ACTION_TELETEXT_RED 

215: Teletext Color button Red to control TopText

ADDON_ACTION_TELETEXT_GREEN 

216: Teletext Color button Green to control TopText

ADDON_ACTION_TELETEXT_YELLOW 

217: Teletext Color button Yellow to control TopText

ADDON_ACTION_TELETEXT_BLUE 

218: Teletext Color button Blue to control TopText

ADDON_ACTION_INCREASE_PAR 

219: Increase par.

ADDON_ACTION_DECREASE_PAR 

220: Decrease par.

ADDON_ACTION_VSHIFT_UP 

227: Shift up video image in VideoPlayer

ADDON_ACTION_VSHIFT_DOWN 

228: Shift down video image in VideoPlayer

ADDON_ACTION_PLAYER_PLAYPAUSE 

229: Play/pause. If playing it pauses, if paused it plays.

ADDON_ACTION_SUBTITLE_VSHIFT_UP 

230: Shift up subtitles in VideoPlayer

ADDON_ACTION_SUBTITLE_VSHIFT_DOWN 

231: Shift down subtitles in VideoPlayer

ADDON_ACTION_SUBTITLE_ALIGN 

232: Toggle vertical alignment of subtitles

ADDON_ACTION_FILTER 

233: Filter.

ADDON_ACTION_SWITCH_PLAYER 

234: Switch player.

ADDON_ACTION_STEREOMODE_NEXT 

235: Stereo mode next.

ADDON_ACTION_STEREOMODE_PREVIOUS 

236: Stereo mode previous.

ADDON_ACTION_STEREOMODE_TOGGLE 

237: Turns 3d mode on/off.

ADDON_ACTION_STEREOMODE_SELECT 

238: Stereo mode select.

ADDON_ACTION_STEREOMODE_TOMONO 

239: Stereo mode to mono.

ADDON_ACTION_STEREOMODE_SET 

240: Stereo mode set.

ADDON_ACTION_SETTINGS_RESET 

241: Settings reset.

ADDON_ACTION_SETTINGS_LEVEL_CHANGE 

242: Settings level change.

ADDON_ACTION_TRIGGER_OSD 

243: Show autoclosing OSD. Can b used in videoFullScreen.xml window id=2005

ADDON_ACTION_INPUT_TEXT 

244: Input text.

ADDON_ACTION_VOLUME_SET 

245: Volume set.

ADDON_ACTION_TOGGLE_COMMSKIP 

246: Toggle commercial skip.

ADDON_ACTION_BROWSE_SUBTITLE 

247: Browse for subtitle. Can be used in videofullscreen

ADDON_ACTION_PLAYER_RESET 

248: Send a reset command to the active game

ADDON_ACTION_TOGGLE_FONT 

249: Toggle font. Used in TextViewer dialog

ADDON_ACTION_VIDEO_NEXT_STREAM 

250: Cycle video streams. Used in videofullscreen.

ADDON_ACTION_QUEUE_ITEM_NEXT 

251: Used to queue an item to the next position in the playlist

ADDON_ACTION_HDR_TOGGLE 

247: Toggle display HDR on/off

ADDON_ACTION_VOICE_RECOGNIZE 

300: Voice actions

ADDON_ACTION_TOUCH_TAP 

401: Touch actions

ADDON_ACTION_TOUCH_TAP_TEN 

410: Touch actions

ADDON_ACTION_TOUCH_LONGPRESS 

411: Touch actions

ADDON_ACTION_TOUCH_LONGPRESS_TEN 

412: Touch actions

ADDON_ACTION_GESTURE_NOTIFY 

500: Gesture notify.

ADDON_ACTION_GESTURE_BEGIN 

501: Gesture begin.

ADDON_ACTION_GESTURE_ZOOM 

502: Send action with point and currentPinchScale (fingers together < 1.0 -> fingers apart > 1.0)

ADDON_ACTION_GESTURE_ROTATE 

503: Gesture rotate.

ADDON_ACTION_GESTURE_PAN 

504: Gesture pan.

ADDON_ACTION_GESTURE_ABORT 

505: Gesture was interrupted in unspecified state

ADDON_ACTION_GESTURE_SWIPE_LEFT 

511: Gesture swipe left.

ADDON_ACTION_GESTURE_SWIPE_LEFT_TEN 

520: Gesture swipe left ten

ADDON_ACTION_GESTURE_SWIPE_RIGHT 

521: Gesture swipe right

ADDON_ACTION_GESTURE_SWIPE_RIGHT_TEN 

530: Gesture swipe right ten

ADDON_ACTION_GESTURE_SWIPE_UP 

531: Gesture swipe up

ADDON_ACTION_GESTURE_SWIPE_UP_TEN 

540: Gesture swipe up ten

ADDON_ACTION_GESTURE_SWIPE_DOWN 

541: Gesture swipe down.

ADDON_ACTION_GESTURE_SWIPE_DOWN_TEN 

550: Gesture swipe down ten.

ADDON_ACTION_GESTURE_END 

599: 5xx is reserved for additional gesture actions

ADDON_ACTION_ANALOG_MOVE_X_LEFT 

601: Analog thumbstick move, horizontal axis, left; see ADDON_ACTION_ANALOG_MOVE

ADDON_ACTION_ANALOG_MOVE_X_RIGHT 

602: Analog thumbstick move, horizontal axis, right; see ADDON_ACTION_ANALOG_MOVE

ADDON_ACTION_ANALOG_MOVE_Y_UP 

603: Analog thumbstick move, vertical axis, up; see ADDON_ACTION_ANALOG_MOVE

ADDON_ACTION_ANALOG_MOVE_Y_DOWN 

604: Analog thumbstick move, vertical axis, down; see ADDON_ACTION_ANALOG_MOVE

ADDON_ACTION_ERROR 

998: ERROR action is used to play an error sound.

ADDON_ACTION_NOOP 

999: The NOOP action can be specified to disable an input event. This is useful in user keyboard.xml etc to disable actions specified in the system mappings.