Official Kodi Wiki - User contributions [en]

Add-on:Fox News

2022-06-25T06:42:42Z

Okichatan: fixed forum link. It was going to ConTV addon

{{Addon
|Name=Fox News
|provider-name=t1m
|ID=plugin.video.fox.news
|latest-version=7.0.0
|extension point=xbmc.python.pluginsource
|provides=video
|Summary=Fox News Videos
|Description=Fox News Videos
|Platform=all
|Language=en
|License=GPL-2.0-or-later
|Forum=https://forum.kodi.tv/showthread.php?tid=57175
|Website=www.foxnews.com
|Source=https://github.com/learningit/repo-plugins
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/matrix/plugin.video.fox.news/resources/icon.png}}

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Video add-ons]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Jarvis add-on repository]]
[[Category:Krypton add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Nexus add-on repository]]

Action IDs

2019-03-24T08:02:03Z

Okichatan: spelled out OSD acronym

<section begin="Action IDs" />
;Main actions
{| class="prettytable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <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.
|-
| <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 [[EDL]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[EDL]] 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.
|-
| <code>SubtitleShiftUp</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_UP)
|-
| <code>SubtitleShiftDown</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_DOWN)
|-
| <code>SubtitleAlign</code> || '''?''' (ACTION_SUBTITLE_ALIGN)
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>PlayNext</code> || Queue the item to the next position in the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. {{editor note|seems to only use the [[advanced filter]] for the video library?}}
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || '''?''' (ACTION_ROTATE_PICTURE_CCW)
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || '''?''' (ACTION_SUBTITLE_DELAY)
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || '''?''' (ACTION_AUDIO_DELAY)
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''<0-9>''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items). {{note|You may want to use <code>playpause</code> instead of just "play", since it will no longer pause media already being played.}}
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || '''?''' (ACTION_VOLAMP_UP)
|-
| <code>volampdown</code> || '''?''' (ACTION_VOLAMP_DOWN)
|-
| <code>audiotoggledigital</code> || '''?''' (ACTION_TOGGLE_DIGITAL_ANALOG)
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|-
| <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)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <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.
|-
| <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.
|-
| <code>JumpSMS''<2-9>''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''<2-9>''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || '''?''' (ACTION_VSHIFT_UP)
|-
| <code>verticalshiftdown</code> || '''?''' (ACTION_VSHIFT_DOWN)
|-
| <code>scanitem</code> || '''?''' (ACTION_SCAN_ITEM)
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_PLUS)
|-
| <code>decreasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_MINUS)
|-
| <code>firstpage</code> || '''?''' (ACTION_FIRST_PAGE)
|-
| <code>lastpage</code> || '''?''' (ACTION_LAST_PAGE)
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || '''?''' (ACTION_TELETEXT_RED)
|-
| <code>green</code> || '''?''' (ACTION_TELETEXT_GREEN)
|-
| <code>yellow</code> || '''?''' (ACTION_TELETEXT_YELLOW)
|-
| <code>blue</code> || '''?''' (ACTION_TELETEXT_BLUE)
|-
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|-
| <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)'''
|-
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|-
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|-
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|-
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players (defined in [[playercorefactory.xml]]). '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
| <code>SetRatring</code> || For use in the MusicOSD.xml window. Will pop-up a 1-10 userrating select dialog, to rate the currently playing song. '''(v17 Krypton 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]]

{{Isengard updated}}

[[Category:Remotes]]
[[Category:Skin development]]

Keymap

2019-03-24T08:00:46Z

Okichatan: spelled out OSD acronym

{{mininav| [[Remote controls]] }}
<section begin="intro" />Keymaps are XML base files that define the mappings of keys (keyboard keys, mouse/remote/joysticks buttons and more) to Kodi actions.<section end="intro" />

== Customizing keymaps through the GUI ==
{{main|Add-on:Keymap Editor}}
Users can customize keymaps for remotes in GUI by using the community [[Add-on:Keymap Editor|Keymap Editor]] add-on.

== Location of keymaps ==
User modified keymap files must be stored in the "'''keymaps'''" folder in the [[userdata]] folder:
{{#lsth:userdata|Location of the UserData folder}}

=== Defaults ===
Default keymaps are included when Kodi is installed, but users should not edit those install files directly. Instead, place user modified keymaps in the [[userdata]]/keymaps/ directory.

Kodi can process multiple keymap files and does so like this:

* All *.xml files from the default install settings and userdata/kemaps/ folders are applied as keymaps.
* All *.xml files are processed in alphabetical order.
* Keymaps defined in an .xml file add to or override mappings in previous .xml file.
* Keymaps defined in the userdata folder add to or override mappings in the global keymap.

By default there will be no files in these locations, so grab one from the link below to make a new one/over-ride:

* ''' https://github.com/xbmc/xbmc/tree/master/system/keymaps '''
* ''' https://github.com/kodi-game/peripheral.joystick/tree/master/peripheral.joystick/resources/buttonmaps/xml '''

== Structure ==

There is one '''global''' keymap and several '''window'''-specific keymaps.<br />
Kodi falls back to the global map when the window-specific map hasn't bound the key being pressed.

The format of keymapping files is as follows:

<syntaxhighlight lang=xml enclose="div">
<keymap>
<global>
<gamepad>
<A>Select</A>
[...]
</gamepad>

<remote>
<select>Select</select>
[...]
</remote>

<keyboard>
<enter>Select</enter>
[...]
</keyboard>

<mouse>
<leftclick>Select</leftclick>
[...]
</mouse>

<universalremote>
<obc25>XBMC.ActivateWindow(MyMusic)</obc25>
[...]
</universalremote>

<joystick name="PLAYSTATION(R)3 Controller (00:1B:FB:F6:E0:F2)">
<button id="15">Select</button>
[...]
</joystick>
</global>

<Home>
[...]
</Home>

[...]

</keymap>
</syntaxhighlight>

As you can see, it's divided into a <global> section, and a number of window sections (such as <Home>).<br />
A list of the available window names can be seen [[Window IDs|here]]. The WINDOW can also be a custom window formatted as <windowId#> (e. g. <window1113>). <br />
Each of these sections can contain Gamepad, Remote, Keyboard, Universal Remote, and custom Joystick sections.

The format for mapping a particular key under one of these device types is as follows:
<syntaxhighlight lang=xml enclose="div">
<keyname>action</keyname>
</syntaxhighlight>

== Keynames ==
Depending on your device you will need to use a specific "keyname".
=== Gamepads ===
An up to date list of the available actions can be found in the source code of Kodi in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp ButtonTranslator.cpp] where the ''TranslateGamepadString()'' function does the work.

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<gamepad>
<A>Select</A>
</gamepad>
</syntaxhighlight>

=== Remotes ===
An up to date list of IR-remote button names can be found in the source code of Kodi [https://github.com/xbmc/xbmc/blob/master/xbmc/input/IRTranslator.cpp IRTranslator.cpp]. See the method TranslateString().

The available actions are discussed in section [[Keymap#Actions|Actions]].

{{Note|Some remotes (e.g. FLIRC) are actually seen as "keyboards". Those will need to use the <keyboard> tag instead.}}

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<remote>
<play>Play</play>
</remote>
</syntaxhighlight>

=== Universal Remotes ===
To map Universal Remote buttons using the RCA infrared protocol, you may add '''<universalremote>''' sections to keymap.xml.<br />
In this case, the tags used are <obc#> where # is the original button code (OBC) of the button.<br />
You would put it inside a <universalremote> section in the <window> or <global> sections.

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<universalremote>
<obc148>Stop</obc148>
</universalremote>
</syntaxhighlight>

:Will map ''Stop Playback'' to the RCA DVD repeat button <obc148>, which is not used by Kodi by default.

* '''Note:''' ensure that the <universalremote> section is '''NOT''' added 'within' the <remote> section - it can appear before or after. Otherwise it will not be recognised and produces errors in the logfile.

Remote keys can be observed in the kodi.log file ('''~/.kodi/temp/kodi.log''' on Linux) when debugging is enabled in the GUI (Settings -> debugging ). The list of pre-defined OBC codes can be found at [https://github.com/xbmc/xbmc/blob/master/xbmc/input/XBIRRemote.h XBIRRemote.h].

=== Keyboards ===
Valid keyboard keymap syntax includes <keyname>, <key id="">, and <keyname mod="">.

Mapping for arbitrary key codes can be configured using the following syntax:
<syntaxhighlight lang=xml enclose="div">
<key id="123">
</syntaxhighlight>
where "123" is replaced by the key code.

A full list of valid keynames can be found in
* the ''TranslateKeyboardString()'' method in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp ButtonTranslator.cpp]
* or in [[List of Kodi keynames]].<br />

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<keyboard>
<key id="123">action</key> -- id is the keys keycode. >
<a mod="shift,alt">action</a> -- corresponds to shift-alt-a, the mod="" syntax is enabled since build 26407. >
<space>action</space> -- for a complete list of valid keynames, see ButtonTranslator.cpp or List of Kodi keynames above. >
</keyboard>
</syntaxhighlight>

;Modifiers
* shift
* alt
* ctrl

=== Mouse ===

As this highly depends on the mouse you are using and which kind of buttons are available, we only mention the most common buttons on a mouse:
<syntaxhighlight lang=xml enclose="div">
<keymap>
<mouse>
<global>
<leftclick>...</leftclick>
<middleclick>...</middleclick>
<rightclick>...</rightclick>
<wheelup>...</wheelup>
<wheeldown>...</wheeldown>
</global>
</mouse>
</keymap>
</syntaxhighlight>

'''''Example for changing the volume while on MusicOSD (On Screen Display) window using the mouse wheel'''''

<syntaxhighlight lang=xml enclose="div">
<keymap>
<MusicOSD>
<mouse>
<wheeldown>VolumeDown</wheeldown>
<wheelup>VolumeUp</wheelup>
</mouse>
</MusicOSD>
</keymap>
</syntaxhighlight>

=== Custom Joystick Configuration ===
Custom joysticks are defined using the following syntax:
<syntaxhighlight lang=xml enclose="div">
<joystick name="JOYSTICK NAME">
<button id="BUTTON ID">action</button>
</joystick>
</syntaxhighlight>

Getting the joystick name:
* On linux: 'cat /proc/bus/input/devices'
* or see your Kodi log file

Getting the button ids:
* 'id' is the button ID used by SDL. Joystick button ids of connected joysticks appear in kodi.log when they are pressed. Use your log to map custom buttons to actions.

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<joystick name="PLAYSTATION(R)3 Controller (00:1B:FB:F6:E0:F2)">
<button id="15">Select</button>
<button id="14">PreviousMenu</button>
</joystick>
</syntaxhighlight>

== Long-press ==
{{note| Longpress seems to only be working on keyboard keymaps at the moment }}
Depending on the device, many remotes, keyboards, and gamepads can use the long-press modifier. This allows a button to do a separate action when held for a short period of time. The syntax for this is as follows:

<pre><button mod="longpress">action</button></pre>

Not all devices will correctly work with the longpress action, but most should.

{{Note|Long-press will disable keyrepeat for that key/window.}}

=== Removing a long-press action from a default keymap ===
If you want to simply remove a long-press action, rather than override it, you can place an empty long-press tag in a keymap. This also has the effect of re-enabling keyrepeat for the short-press action.

For example, this will remove the context menu action from the default keyboard.xml keymap:

<pre>
<keymap>
<global>
<keyboard>
<return mod="longpress"></return>
<enter mod="longpress"></enter>
</keyboard>
</global>
</keymap>
</pre>

== Commands ==
The most recent available actions can be found in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ActionTranslator.cpp ActionTranslator.cpp].

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/input/Key.h Key.h]

In addition to the following actions, you can also use '''[[Built-in scripting]]''' in Kodi.

=== Actions ===
{{Main|Action IDs}}
{{#lst:Action IDs|Action IDs}}

=== Functions ===
{{main|List of built-in functions|Built-in scripting}}
{{#lst:List of built-in functions|functions}}

== Windows ==
{{main|Window IDs}}
{{#lst:Window IDs|main content}}

== Additional keys ==
Other keys that can be mapped to actions.

=== Media keyboards/remotes ===
* browser_back
* browser_forward
* browser_refresh
* browser_stop
* browser_search
* browser_favorites
* browser_home
* volume_mute
* volume_down
* volume_up
* next_track
* prev_track
* stop
* play_pause
* launch_mail
* launch_media_select
* launch_app1
* launch_app2
* play
* pause
* fastforward
* rewind
* channelup
* channeldown

=== Mouse actions ===
* leftclick
* rightclick
* middleclick
* doubleclick
* wheelup
* wheeldown
* mousemove
* mousedrag
* mousedragstart
* mousedragend
* mouserdrag - right button drag
* mouserdragstart - start of right button drag
* mouserdragend - end of right button drag

== Examples and pre-made keymaps ==
{{see|:Category:Custom keymaps}}

== See also ==
* [[Remote controls]]
* [[Keyboard controls]]
'''Development:'''
* [[Add-on development]]
* [[Python development]]
* [[Skinning]]

{{Updated|16}}

[[Category:Development]]
[[Category:Manual]]
[[Category:Remotes]]
[[Category:Settings]]
[[Category:Controls]]

Log file/Advanced

2018-02-07T11:36:10Z

Okichatan: /* Location */ added Raspberry Pi log location

{{mininav| [[Troubleshooting]] | [[HOW-TO:Submit a bug report]] | [[Log file]] }}

:{{bigger|''Not sure what to do, but someone just asked you for a "log file", "debug log", "kodi.log", or "xbmc.log"? '''[[Log file/Easy|Click here]].'''''}}

<section being="intro" />At some point during your foray into {{kodi}}, you will likely come up against a problem that isn't made 100% clear from errors in the GUI. This is where the log file comes into play. {{kodi}} writes all sorts of useful stuff to its log, which is why it should be included with every bug/problem report. Don't be afraid of its contents! Often a quick glance through the log will turn up a simple typo or missing file which you can easily fix on your own.<section end="intro" />

= Enable debugging = 
If someone asks for a debug log then debugging needs to be enabled. There are three ways to do this:

# Select the enable debug options in the '''[[#GUI settings|GUI settings]]'''
# Use an '''[[#advancedsettings.xml|advancedsettings.xml]]''' file
# Toggle debug logging with a '''[[#Keyboard or remote shortcut|keyboard or remote shortcut]]'''

== GUI settings ==
Most users only need to enable debug logging in the GUI.

In {{highlight|bordered=yes|[[Settings/System#Logging|Settings -> System -> Logging]]}} toggle the '''''Enable debug logging''''' setting.

{{#lst:Settings/System|debugging}}

== Turn on debugging using a file (advancedsettings.xml) ==
{{anchor|advancedsettings.xml}}
You can manually enable debug logging directly using an [[advancedsettings.xml]] file. This is especially useful if {{kodi}} is crashing during start-up and you are unable to turn debugging on via the GUI. The advancedsettings.xml file is simply a plain text document that is saved in the [[userdata folder]] and read when {{kodi}} first starts up. You can use the following examples to enable debug logging:

{{note|Be sure to format this as a '''plain text''' document, and make sure it is titled <code>advancedsettings.xml</code> and make sure the extension is ''just'' <code>.xml</code> and not something like ".xml.txt" or ".xml.doc". }}

=== advancedsettings.xml for normal debugging ===
If you want '''basic debug logging''' then use this. This the same as enabling logging in the GUI without enabling component-specific logging. Start with this one first if you are not sure which mode to use:

<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
</advancedsettings>
</syntaxhighlight>

=== advancedsettings.xml for input devices ===
''Useful as you cannot enable debug logging in the GUI if your input devices don't work.''

If you only want debug logging with verbose components for '''input devices''' (JSON-RPC, CEC, HTTP, for remotes, smart phone remotes, web remotes, etc) then use this:
<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
<debug>
<extralogging>true</extralogging>
<setextraloglevel>64,1024, 16384</setextraloglevel>
<showloginfo>true</showloginfo> 
</debug>
</advancedsettings>
</syntaxhighlight>

=== advancedsettings.xml for everything ===
If you want debug logging with '''all verbose components''' enabled use this.

{{note|Normally, you don't want to use this one unless specifically asked for it, as it will create a very hard-to-read debug log.}}

<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
<debug>
<extralogging>true</extralogging>
<setextraloglevel>32,64,128,256,512,1024,2048,4096,8192,16384,32768,65536</setextraloglevel>
<showloginfo>true</showloginfo>
</debug>
</advancedsettings>
</syntaxhighlight>

=== Technical notes ===
{{collapse top}}
Everything except the <code><loglevel></code> tag is actually taken from guisettings.xml, but they can be used in the advancedsettings.xml file as a way to manually enable them.

As one can see from the previous sections, individual component logging is set using the <code><setextraloglevel></code> tag. A complete list of the components and their setting value follows:

{| class="prettytable"
! Component !! setting value
|-
| LOGSAMBA || 32
|-
| LOGCURL || 64
|-
| LOGFFMPEG || 128
|-
| LOGDBUS || 512
|-
| LOGJSONRPC || 1024
|-
| LOGAUDIO || 2048
|-
| LOGAIRTUNES || 4096
|-
| LOGUPNP || 8192
|-
| LOGCEC || 16384
|-
| LOGVIDEO || 32768
|-
| LOGWEBSERVER || 65536
|}
{{collapse bottom}}

== Password warning ==
{{Log file password warning}}

== Keyboard or remote shortcut ==
By plugging in a keyboard, debug mode can be toggled by pressing {{keypress|shift|ctrl|D}}

Other keys, or buttons on remotes, can be used to toggle debug mode. Just use the [[action ID]] <code>toggledebug</code> along with a custom '''[[keymap]]'''.

== Component-specific logging ==

For more extensive logging, several system components can be selected to put in more detailed debug messages in Kodi's log file. Multiple components can be selected for extending the debugging of the Kodi application.

[[File:Component-logging-selection.jpg|500px|Component logging selection window|right]]

First, you need to enable this feature via toggling

{{highlight|bordered=yes|[[Settings/System#Logging|Settings -> System -> Logging -> Enable component-specific logging]]}}.

Then specifiy which components you want logged into the Kodi log file.

{{highlight|bordered=yes|[[Settings/System#Logging|Settings -> System -> Logging -> - Specify component-specific logging...]]}}.

One or more components can be selected for further investigating the debugging on your Kodi device, subject to your Kodi hardware capabilities.

* The SMB library
* The libcURL library (HTTP(S), DAV)
* The FFmpeg libraries
* The Audio component
* The Video component
* D-Bus calls
* JSON-RPC requests
* The Webserver component
* The Airtunes library
* The UPnP components
* The libCEC library
* The Database component
* Audio/video timing information

= So what do I do with this thing? =

Whatever you do, please '''DO NOT''' paste it directly into IRC, a forum post or ticket on the bug tracker. This not only clutters said text, but the log is nearly impossible to read like this. If your log file is too big for the following methods, please restart {{kodi}} to start a clean log file file, recreate the problem in as few steps as possible, then stop {{kodi}} and try again. If it is still too large, try disabling features such as "scan library on startup", which spam's a lot of info to the log (unless of course this is where the problem is).

:{{note|{{big|'''Always include the whole debug log.''' Don't assume which portions of the log are relevant or not. }} }}

:{{note|Make sure you have enabled "debug logging". The normal log file, without debugging enabled, is almost always useless when it comes to troubleshooting!}}

=== In the forums and IRC ===
Use a pastesite such as http://pastebin.com , or http://paste.ubuntu.com on when posting on the forums. Simply visit one of these sites, paste or upload your log and hit submit. After a few seconds you'll have a nice short URL to paste in your post. Be sure to select an appropriate time to keep your paste around when submitting!

=== On the bug tracker ===
Just upload the log to your ticket as an attachment. '''DO NOT''' archive (zip,rar,tar,etc) it in anyway! Trac will let us view it right on the site without downloading.

=== Watch it locally, perhaps spotting errors you can fix or report ===
Using 'tail -f {location}' you can watch the log from a cmd/console (better with 2 displays), or better, via ssh (won't distract the gui).

= Log files =
* '''kodi.log''' or '''xbmc.log''' - This is the log file of most recent (or currently running) {{kodi}} session.
* '''kodi.old.log''' or '''xbmc.old.log''' - This is the log file from the last Kodi session. If {{kodi}} crashes AND you have restarted it before viewing the log, this is the one you want.

=== Location ===
''kodi.log'' {{small|(or ''xbmc.log'')}} and ''kodi.old.log'' {{small|(or ''xbmc.old.log'')}} are located here, depending on your platform:
{|class="prettytable"
! style="background: lightgrey; width: 150px" | '''Operative system'''
! style="background: lightgrey; width: 800px" | '''File/Folder Paths'''
|-
| colspan=2 | ''Directories and files named <code>'''kodi'''</code> were called <code>'''xbmc'''</code> in versions before v14.''
|-
|'''Android''' || {{note|The first folder might be different on various devices:}}
*<code>''<data/sdcard/Android>''/data/org.xbmc.kodi/cache/temp/kodi.log</code>

*<code>/sdcard/Android/data/org.xbmc.kodi/files/.kodi/temp/kodi.log</code>

*<code>/storage/emulated/0/Android/data/org.xbmc.kodi/files/.kodi/temp/kodi.log</code>
|-
|'''iOS/ATV2''' || <code>/private/var/mobile/Library/Preferences/kodi.log</code>
|-
|'''Linux''' || <code>$HOME/.kodi/temp/kodi.log</code>
|-
|'''Raspberry Pi''' || <code>/storage/.kodi/temp/kodi.log</code>
|-
|'''macOS''' || <code>/Users/''<username>''/Library/Logs/kodi.log</code>
|-
|'''Windows desktop''' || <code>%APPDATA%\Kodi\kodi.log</code>
|-
|'''Windows store (UWP)''' || <code>%LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\kodi.log</code>
|-
| '''[[Special protocol]]''' || <code>special://logpath (this can be used by scripts)</code>
|}

See '''[[Log file/File manager access]]''' for how to copy the debug log file using the [[File manager]].

= Easy ways to get and post the log file =
=== Debug log add-on ===
{{main|Log file/Easy}}
You can use the '''[[Add-on:Kodi Log Uploader|Kodi Logfile Uploader]]''' to make the process of getting your debug log easier.

=== Automatic pastebin log in Linux via command line ===
You can generate a debug.log [http://en.wikipedia.org/wiki/Pastebin Pastebin] link automatically quickly to post anywhere that requires a debug.log.
<br />
:'''''See also:''''' [[SSH|Accessing Kodi via SSH]] e.g. Putty

:{{note|Don't forget to [[#Enable debugging|enable debugging]]}}
<pre>sudo apt-get install pastebinit -y

cat $HOME/.kodi/temp/kodi.log | pastebinit</pre>
''(or cat $HOME/.Kodi/temp/kodi.log | pastebinit)''

Submit the link you get in any forums discussion where you post about '''any''' problem.

= Technical details about log files =
{{Editor note|This section might be outdated now that {{kodi}} has component-level logging. Some of it should still be true, but just keep in mind that this section hasn't been totally cleaned up for v13 and v14 yet.}}

=== Layout ===
Each event is logged to one line of the {{kodi}} log file which is formatted as follows...
<pre>[TIMESTAMP] T:[THREADID] M:[FREEMEM] [LEVEL]: [MESSAGE]</pre>
* '''TIMESTAMP''' - The wall time at which the event occurred.
* '''THREADID''' - The thread identification number of the thread in which the event occurred.
* '''FREEMEM''' - The amount of memory (in bytes) free at the time of the event.
* '''LEVEL''' - The severity of the event.
* '''MESSAGE''' - A brief description and/or important information about the event.

=== Log levels ===
There are two different types levels when talking about the {{kodi}} log. The first is the severity of event that has occurred. The second controls which severity levels are actually printed out to the log.

;Severity levels
In order from least to most severe...
* '''DEBUG''' - In depth information about the status of {{kodi}}. This information can pretty much only be deciphered by a developer or long time {{kodi}} power user.
* '''INFO''' - Something has happened. It's not a problem, we just thought you might want to know. Fairly excessive output that most people won't care about.
* '''NOTICE''' - Similar to INFO but the average Joe might want to know about these events. This level and above are logged by default.
* '''WARNING''' - Something potentially bad has happened. If {{kodi}} did something you didn't expect, this is probably why. Watch for errors to follow.
* '''ERROR''' - This event is bad. Something has failed. You likely noticed problems with the application be it skin artifacts, failure of playback a crash, etc.
* '''FATAL''' - We're screwed. {{kodi}} is about to crash.

;Log file control levels
In order from least to most information provided...
* '''None''' - No logging will occur. ''kodi.log'' will likely be created but should remain empty.
* '''Normal''' - The default loglevel. Events with a severity of NOTICE or greater will be logged.
* '''Debug''' - All events are logged. This level (or higher) is all that you should bother someone else with.
* '''Debug w/ Visuals''' - Same printed log as ''Debug'', but free memory and CPU usage are rendered on the screen as well.
* '''SMB Debug''' - Same as ''Debug w/ Visuals'' with the addition of ridiculous amounts of Samba debugging info. Use this only if asked.


= See also =
* [[HOW-TO:Submit a bug report]]
* [[Bug tracker]]
* [[Troubleshooting]]

{{Updated|17}}

[[Category:Development]]
[[Category:Trac]]
[[Category:Manual]]
[[Category:Troubleshooting]]
[[Category:Advanced topics]]

Archive:Custom video entries

2015-12-31T12:29:09Z

Okichatan: /* NFO files */ added how to add artwork to your home movie

{{mininav|[[Video library]]|[[Video management|Management]]}}
<section begin="intro" />Need to add videos such as home movies or other videos that are not normally found by Kodi's scrapers? This page will show you a few solutions on adding custom videos, such as home movies, clips, special editions, and more. <section end="intro" />

== JustUseTheFileName ==
To simply add videos to the library as movies without any special info you can [[add-on manager|install]] the JustUseTheFileName scraper: http://up.kibje.com/20130711/metadata.justUseFilename.org.zip

== NFO files ==
{{main|NFO files}}
* Add [[NFO files]] for each file. For step-by-steps look at the additional guides below.
* Here's a basic/bare minimal example of an NFO file:
<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="utf-8"?>
<movie>
<title>Some title</title>
<originaltitle>Some title just in case - you most likely dont need this either</originaltitle>
<sorttitle>It will sort by this title if you include it</sorttitle>
<genre>HomeMovies</genre>
<id>-1</id>
</movie>
</syntaxhighlight>
* If you like to use photo (aka artwork, poster); Save the desired .jpg file in the '''same folder as the movie and the NFO file'''. The jpg file should be named '''exactly the same''' as the video file to which it refers, '''except''' add "-poster" to the jpg filename, so for 'cartrip.mkv', the artwork file should be named 'cartrip-poster.jpg'. Kodi will import the jpg image automatically.
* Kodi will only look at your NFO files ONCE. To refresh see: [[Video library/Updating or removing videos#Refreshing the library]]

== Filtering custom videos ==
{{see|Custom home items}}

== Additional guides ==
* [http://forum.kodi.tv/showthread.php?tid=118344&pid=1299816#pid1299816 Best way to have "home videos" in Kodi (Kodi forum)]

{{Isengard updated}}

[[Category:Manual]]
[[Category:Video library]]