Difference between revisions of "Themed Menus"

From MythTV Official Wiki
Jump to: navigation, search
m (Forgot current="y" attribute value)
 
(3 intermediate revisions by one user not shown)
Line 183: Line 183:
 
current aspect ratio will be highlighted.
 
current aspect ratio will be highlighted.
  
If multiple items in a menu match the <code>current="active"</code>
+
Additionally, setting <code>current="y"</code> or
 +
<code>current="t"</code> or <code>current="1"</code> will
 +
unconditionally highlight the menu item.
 +
 
 +
If multiple items in a menu match the <code>current="..."</code>
 
test, an arbitrary one is chosen to be highlighted.
 
test, an arbitrary one is chosen to be highlighted.
  
Line 202: Line 206:
 
comprehensive description of available actiongroups.
 
comprehensive description of available actiongroups.
  
The <code>actiongroup</code></code> attribute is the only required
+
The <code>actiongroup</code> attribute is the only required attribute
attribute of the <code>itemlist</code> element.
+
of the <code>itemlist</code> element.
  
 
{{Note box|'''All action group names are subject to future renaming.'''<br />
 
{{Note box|'''All action group names are subject to future renaming.'''<br />
Line 249: Line 253:
  
 
Currently there are four implementations of Themed Menus.
 
Currently there are four implementations of Themed Menus.
 
In the tables below that describe the available actions,
 
  
 
== Playback OSD menu ==
 
== Playback OSD menu ==
Line 262: Line 264:
 
| align="center"  |<b>Action Group</b>
 
| align="center"  |<b>Action Group</b>
 
| align="center"  |<b>Action Description</b>
 
| align="center"  |<b>Action Description</b>
 +
| align="center"  |<b>Default text (active)</b>
 +
| align="center"  |<b>Default text (inactive)</b>
 
| align="center"  |<b>show="active" condition</b><br />(default true)
 
| align="center"  |<b>show="active" condition</b><br />(default true)
 
| align="center"  |<b>Display condition</b><br />(default true)
 
| align="center"  |<b>Display condition</b><br />(default true)
Line 268: Line 272:
 
| 3D
 
| 3D
 
| Deactivate 3D mode
 
| Deactivate 3D mode
 +
| None
 +
|
 
|  
 
|  
 
| If the video output device supports stereoscopic modes
 
| If the video output device supports stereoscopic modes
Line 274: Line 280:
 
| 3D
 
| 3D
 
| Activate side-by-side 3D mode
 
| Activate side-by-side 3D mode
 +
| Side by Side
 +
|
 
|  
 
|  
| If the video output device supports stereoscopic modes
+
| The video output device supports stereoscopic modes
 
|-
 
|-
 
| 3DSIDEBYSIDEDISCARD
 
| 3DSIDEBYSIDEDISCARD
 
| 3D
 
| 3D
 
| Activate discard side-by-side 3D mode
 
| Activate discard side-by-side 3D mode
 +
| Discard Side by Side
 +
|
 
|  
 
|  
| If the video output device supports stereoscopic modes
+
| The video output device supports stereoscopic modes
 
|-
 
|-
 
| 3DTOPANDBOTTOM
 
| 3DTOPANDBOTTOM
 
| 3D
 
| 3D
 
| Activate top-and-bottom 3D mode
 
| Activate top-and-bottom 3D mode
 +
| Top and Bottom
 +
|
 
|  
 
|  
| If the video output device supports stereoscopic modes
+
| The video output device supports stereoscopic modes
 
|-
 
|-
 
| 3DTOPANDBOTTOMDISCARD
 
| 3DTOPANDBOTTOMDISCARD
 
| 3D
 
| 3D
 
| Activate discard top-and-bottom 3D mode
 
| Activate discard top-and-bottom 3D mode
 +
| Discard Top and Bottom
 +
|
 
|  
 
|  
| If the video output device supports stereoscopic modes
+
| The video output device supports stereoscopic modes
 
|-
 
|-
 
| ADJUSTSTRETCH
 
| ADJUSTSTRETCH
 
| ADJUSTSTRETCH
 
| ADJUSTSTRETCH
| Bring up the timestretch adjustment dialog.
+
| Bring up the timestretch adjustment dialog
 +
| Adjust
 +
|
 
|  
 
|  
 
|  
 
|  
Line 303: Line 319:
 
| ADJUSTSTRETCH0.5
 
| ADJUSTSTRETCH0.5
 
| ADJUSTSTRETCH
 
| ADJUSTSTRETCH
| Set the timestretch value to 0.5x.
+
| Set the timestretch value to 0.5x
 +
| 0.5x
 +
|
 
|  
 
|  
 
|  
 
|  
Line 309: Line 327:
 
| ADJUSTSTRETCH0.9
 
| ADJUSTSTRETCH0.9
 
| ADJUSTSTRETCH
 
| ADJUSTSTRETCH
| Set the timestretch value to 0.9x.
+
| Set the timestretch value to 0.9x
 +
| 0.9x
 +
|
 
|  
 
|  
 
|  
 
|  
Line 315: Line 335:
 
| ADJUSTSTRETCH1.0
 
| ADJUSTSTRETCH1.0
 
| ADJUSTSTRETCH
 
| ADJUSTSTRETCH
| Set the timestretch value to 1.0x.
+
| Set the timestretch value to 1.0x
 +
| 1.0x
 +
|
 
|  
 
|  
 
|  
 
|  
Line 321: Line 343:
 
| ADJUSTSTRETCH1.1
 
| ADJUSTSTRETCH1.1
 
| ADJUSTSTRETCH
 
| ADJUSTSTRETCH
| Set the timestretch value to 1.1x.
+
| Set the timestretch value to 1.1x
 +
| 1.1x
 +
|
 
|  
 
|  
 
|  
 
|  
Line 327: Line 351:
 
| ADJUSTSTRETCH1.2
 
| ADJUSTSTRETCH1.2
 
| ADJUSTSTRETCH
 
| ADJUSTSTRETCH
| Set the timestretch value to 1.2x.
+
| Set the timestretch value to 1.2x
 +
| 1.2x
 +
|
 
|  
 
|  
 
|  
 
|  
Line 333: Line 359:
 
| ADJUSTSTRETCH1.3
 
| ADJUSTSTRETCH1.3
 
| ADJUSTSTRETCH
 
| ADJUSTSTRETCH
| Set the timestretch value to 1.3x.
+
| Set the timestretch value to 1.3x
 +
| 1.3x
 +
|
 
|  
 
|  
 
|  
 
|  
Line 339: Line 367:
 
| ADJUSTSTRETCH1.4
 
| ADJUSTSTRETCH1.4
 
| ADJUSTSTRETCH
 
| ADJUSTSTRETCH
| Set the timestretch value to 1.4x.
+
| Set the timestretch value to 1.4x
 +
| 1.4x
 +
|
 
|  
 
|  
 
|  
 
|  
Line 345: Line 375:
 
| ADJUSTSTRETCH1.5
 
| ADJUSTSTRETCH1.5
 
| ADJUSTSTRETCH
 
| ADJUSTSTRETCH
| Set the timestretch value to 1.5x.
+
| Set the timestretch value to 1.5x
 +
| 1.5x
 +
|
 
|  
 
|  
 
|  
 
|  
Line 352: Line 384:
 
|  
 
|  
 
| Set the video fill mode to "Autodetect"
 
| Set the video fill mode to "Autodetect"
 +
| Auto Detect
 +
|
 
| Current video fill mode is "Autodetect"
 
| Current video fill mode is "Autodetect"
| If the video output device is not HW-accelerated
+
| The video output device is not HW-accelerated
 
|-
 
|-
 
| CANCELPLAYLIST
 
| CANCELPLAYLIST
 
|  
 
|  
 
| Cancel the playlist in progress
 
| Cancel the playlist in progress
 +
| Cancel Playlist
 +
|
 
|  
 
|  
 
| Playlist currently active
 
| Playlist currently active
Line 364: Line 400:
 
|  
 
|  
 
| Open a Live TV Picture-by-Picture window
 
| Open a Live TV Picture-by-Picture window
 +
| Open Live TV PBP
 +
|
 
|  
 
|  
 
| New PbP window possible (at least 1 free recorder, PiP not currently active, etc.)
 
| New PbP window possible (at least 1 free recorder, PiP not currently active, etc.)
Line 370: Line 408:
 
|  
 
|  
 
| Open a Live TV Picture-in-Picture window
 
| Open a Live TV Picture-in-Picture window
 +
| Open Live TV PIP
 +
|
 
|  
 
|  
 
| New PiP window possible (at least 1 free recorder, PbP not currently active, etc.)
 
| New PiP window possible (at least 1 free recorder, PbP not currently active, etc.)
Line 376: Line 416:
 
|  
 
|  
 
| Toggle OSD playback information overlay
 
| Toggle OSD playback information overlay
 +
| Playback Data
 +
|
 
|  
 
|  
 
|  
 
|  
Line 382: Line 424:
 
|  
 
|  
 
| Open the "Jump to Recorded Program" dialog
 
| Open the "Jump to Recorded Program" dialog
 +
| Recorded Program
 +
|
 
|  
 
|  
 
|  
 
|  
Line 388: Line 432:
 
|  
 
|  
 
| Disable external text subtitles
 
| Disable external text subtitles
 +
| Disable External Subtitles
 +
|
 
| External text subtitles currently ''not'' being displayed
 
| External text subtitles currently ''not'' being displayed
 
| Recording contains external text subtitles
 
| Recording contains external text subtitles
Line 394: Line 440:
 
|  
 
|  
 
| Disable forced subtitles
 
| Disable forced subtitles
 +
| Disable Forced Subtitles
 +
|
 
| Forced subtitles current ''not'' enabled
 
| Forced subtitles current ''not'' enabled
 
| Recording contains A/V or text subtitles
 
| Recording contains A/V or text subtitles
Line 400: Line 448:
 
|  
 
|  
 
| Disable subtitle display
 
| Disable subtitle display
 +
| Disable Subtitles
 +
|
 
| Subtitles currently ''not'' being displayed
 
| Subtitles currently ''not'' being displayed
 
| Recording contains subtitles
 
| Recording contains subtitles
Line 406: Line 456:
 
|  
 
|  
 
| Disable audio upmixer
 
| Disable audio upmixer
 +
| Disable Audio Upmixer
 +
|
 
| Upmixing currently ''not'' enabled
 
| Upmixing currently ''not'' enabled
 
| Audio output device supports upmixing
 
| Audio output device supports upmixing
Line 412: Line 464:
 
|  
 
|  
 
| Disable audio visualizer
 
| Disable audio visualizer
 +
| None
 +
|
 
|  
 
|  
 
| Video output device supports visualization
 
| Video output device supports visualization
Line 418: Line 472:
 
|  
 
|  
 
| Edit channel (if playing Live TV), or edit recording (otherwise)
 
| Edit channel (if playing Live TV), or edit recording (otherwise)
 +
| Edit Channel
 +
| Edit Recording
 
| Currently playing Live TV
 
| Currently playing Live TV
 
| Not playing DVD or BD
 
| Not playing DVD or BD
Line 424: Line 480:
 
|  
 
|  
 
| Enable external text subtitles
 
| Enable external text subtitles
 +
| Enable External Subtitles
 +
|
 
| External text subtitles currently being displayed
 
| External text subtitles currently being displayed
 
| Recording contains external text subtitles
 
| Recording contains external text subtitles
Line 430: Line 488:
 
|  
 
|  
 
| Ensable forced subtitles
 
| Ensable forced subtitles
 +
| Enable Forced Subtitles
 +
|
 
| Forced subtitles current enabled
 
| Forced subtitles current enabled
 
| Recording contains A/V or text subtitles
 
| Recording contains A/V or text subtitles
Line 436: Line 496:
 
|  
 
|  
 
| Enable subtitle display
 
| Enable subtitle display
 +
| Enable Subtitles
 +
|
 
| Subtitles currently being displayed
 
| Subtitles currently being displayed
 
| Recording contains subtitles
 
| Recording contains subtitles
Line 442: Line 504:
 
|  
 
|  
 
| Enable audio upmixer
 
| Enable audio upmixer
 +
| Auto Detect
 +
|
 
| Upmixing currently enabled
 
| Upmixing currently enabled
 
| Audio output device supports upmixing
 
| Audio output device supports upmixing
Line 448: Line 512:
 
|  
 
|  
 
| Open "Program Finder" window
 
| Open "Program Finder" window
 +
| Program Finder
 +
|
 
|  
 
|  
 
|  
 
|  
Line 454: Line 520:
 
|  
 
|  
 
| Open "Program Guide" window
 
| Open "Program Guide" window
 +
| Program Guide
 +
|
 
|  
 
|  
 
|  
 
|  
Line 460: Line 528:
 
|  
 
|  
 
| Jump ahead
 
| Jump ahead
 +
| Jump Ahead
 +
|
 
|  
 
|  
 
| Current recording allows jumping
 
| Current recording allows jumping
Line 466: Line 536:
 
|  
 
|  
 
| Jump to previously played recording
 
| Jump to previously played recording
 +
| ''Last recording in the form Title: Subtitle''
 +
|
 
|  
 
|  
 
| Previously played recording exists
 
| Previously played recording exists
Line 472: Line 544:
 
|  
 
|  
 
| Open a Recording Picture-by-Picture window
 
| Open a Recording Picture-by-Picture window
 +
| Open Recording PBP
 +
|
 
|  
 
|  
 
| New PbP window possible (at least 1 available PbP slot, PiP not currently active, etc.)
 
| New PbP window possible (at least 1 available PbP slot, PiP not currently active, etc.)
Line 478: Line 552:
 
|  
 
|  
 
| Open a Recording Picture-in-Picture window
 
| Open a Recording Picture-in-Picture window
 +
| Open Recording PIP
 +
|
 
|  
 
|  
 
| New PiP window possible (at least 1 available PiP slot, PbP not currently active, etc.)
 
| New PiP window possible (at least 1 available PiP slot, PbP not currently active, etc.)
Line 484: Line 560:
 
|  
 
|  
 
| Jump back
 
| Jump back
 +
| Jump Back
 +
|
 
|  
 
|  
 
| Current recording allows jumping
 
| Current recording allows jumping
Line 490: Line 568:
 
|  
 
|  
 
| Jump to DVD chapter menu
 
| Jump to DVD chapter menu
 +
| DVD Chapter Menu
 +
|
 
|  
 
|  
 
| Currently watching a DVD
 
| Currently watching a DVD
Line 496: Line 576:
 
|  
 
|  
 
| Jump to DVD root menu
 
| Jump to DVD root menu
 +
| DVD Root Menu
 +
| Top Menu
 
|  
 
|  
 
| Currently watching a DVD
 
| Currently watching a DVD
Line 502: Line 584:
 
|  
 
|  
 
| Jump to DVD title menu
 
| Jump to DVD title menu
 +
| DVD Title Menu
 +
|
 
|  
 
|  
 
| Currently watching a DVD
 
| Currently watching a DVD
Line 508: Line 592:
 
|  
 
|  
 
| Jump to BluRay popup menu
 
| Jump to BluRay popup menu
 +
| Popup menu
 +
|
 
|  
 
|  
 
| Currently watching a BD
 
| Currently watching a BD
Line 514: Line 600:
 
|  
 
|  
 
| Change active PiP/PbP window
 
| Change active PiP/PbP window
 +
| Change Active Window
 +
|
 
|  
 
|  
 
| Currently displaying at least 1 PiP/PbP window
 
| Currently displaying at least 1 PiP/PbP window
Line 520: Line 608:
 
|  
 
|  
 
| Toggle play/pause state
 
| Toggle play/pause state
 +
| Play
 +
| Pause
 
| Currently paused (not playing)
 
| Currently paused (not playing)
 
|  
 
|  
Line 526: Line 616:
 
|  
 
|  
 
| Jump to previous channel
 
| Jump to previous channel
 +
| Previous Channel
 +
|
 
|  
 
|  
 
| Watching Live TV, and there exists a previously watched channel
 
| Watching Live TV, and there exists a previously watched channel
Line 532: Line 624:
 
|  
 
|  
 
| Start or stop a transcoding job for the current recording (using default transcoding profile)
 
| Start or stop a transcoding job for the current recording (using default transcoding profile)
 +
| Stop Transcoding
 +
|
 
| Transcoding job currently active for this recording
 
| Transcoding job currently active for this recording
 
| Currently watching a recorded program
 
| Currently watching a recorded program
Line 538: Line 632:
 
|  
 
|  
 
| Start or stop a transcoding job for the current recording (using auto-detect transcoding profile)
 
| Start or stop a transcoding job for the current recording (using auto-detect transcoding profile)
 +
| Autodetect
 +
|
 
| Transcoding job currently active for this recording
 
| Transcoding job currently active for this recording
 
| Currently watching a recorded program
 
| Currently watching a recorded program
Line 544: Line 640:
 
|  
 
|  
 
| Start or stop a transcoding job for the current recording (using high-quality transcoding profile)
 
| Start or stop a transcoding job for the current recording (using high-quality transcoding profile)
 +
| High Quality
 +
|
 
| Transcoding job currently active for this recording
 
| Transcoding job currently active for this recording
 
| Currently watching a recorded program
 
| Currently watching a recorded program
Line 550: Line 648:
 
|  
 
|  
 
| Start or stop a transcoding job for the current recording (using low-quality transcoding profile)
 
| Start or stop a transcoding job for the current recording (using low-quality transcoding profile)
 +
| Low Quality
 +
|
 
| Transcoding job currently active for this recording
 
| Transcoding job currently active for this recording
 
| Currently watching a recorded program
 
| Currently watching a recorded program
Line 556: Line 656:
 
|  
 
|  
 
| Start or stop a transcoding job for the current recording (using medium-quality transcoding profile)
 
| Start or stop a transcoding job for the current recording (using medium-quality transcoding profile)
 +
| Medium Quality
 +
|
 
| Transcoding job currently active for this recording
 
| Transcoding job currently active for this recording
 
| Currently watching a recorded program
 
| Currently watching a recorded program
Line 562: Line 664:
 
|  
 
|  
 
| Open "Edit Recording Schedule" window
 
| Open "Edit Recording Schedule" window
 +
| Edit Recording Schedule
 +
|
 
|  
 
|  
 
|  
 
|  
Line 568: Line 672:
 
| SELECTSCAN_
 
| SELECTSCAN_
 
| Set video scan type to "Detect"
 
| Set video scan type to "Detect"
 +
| Detect
 +
|
 
| Current scan type is "Detect"
 
| Current scan type is "Detect"
 
|  
 
|  
Line 574: Line 680:
 
| SELECTSCAN_
 
| SELECTSCAN_
 
| Set video scan type to "Interlaced (Normal)"
 
| Set video scan type to "Interlaced (Normal)"
 +
| Interlaced (Normal)
 +
|
 
| Current scan type is "Interlaced (Normal)"
 
| Current scan type is "Interlaced (Normal)"
 
|  
 
|  
Line 580: Line 688:
 
| SELECTSCAN_
 
| SELECTSCAN_
 
| Set video scan type to "Interlaced (Reversed)"
 
| Set video scan type to "Interlaced (Reversed)"
 +
| Interlaced (Reversed)
 +
|
 
| Current scan type is "Interlaced (Reversed)"
 
| Current scan type is "Interlaced (Reversed)"
 
|  
 
|  
Line 586: Line 696:
 
| SELECTSCAN_
 
| SELECTSCAN_
 
| Set video scan type to "Progressive"
 
| Set video scan type to "Progressive"
 +
| Progressive
 +
|
 
| Current scan type is "Progressive"
 
| Current scan type is "Progressive"
 
|  
 
|  
Line 592: Line 704:
 
|  
 
|  
 
| Swap PiP/PbP windows
 
| Swap PiP/PbP windows
 +
| Swap Windows
 +
|
 
|  
 
|  
 
| Currently displaying at least 2 PiP/PbP windows
 
| Currently displaying at least 2 PiP/PbP windows
Line 598: Line 712:
 
| TOGGLEASPECT
 
| TOGGLEASPECT
 
| Change aspect ratio to "Off"
 
| Change aspect ratio to "Off"
 +
| Off
 +
|
 
| Current aspect ratio is "Off"
 
| Current aspect ratio is "Off"
 
|  
 
|  
Line 604: Line 720:
 
| TOGGLEASPECT
 
| TOGGLEASPECT
 
| Change aspect ratio to "4:3"
 
| Change aspect ratio to "4:3"
 +
| 4:3
 +
|
 
| Current aspect ratio is "4:3"
 
| Current aspect ratio is "4:3"
 
|  
 
|  
Line 610: Line 728:
 
| TOGGLEASPECT
 
| TOGGLEASPECT
 
| Change aspect ratio to "16:9"
 
| Change aspect ratio to "16:9"
 +
| 16:9
 +
|
 
| Current aspect ratio is "16:9"
 
| Current aspect ratio is "16:9"
 
|  
 
|  
Line 616: Line 736:
 
| TOGGLEASPECT
 
| TOGGLEASPECT
 
| Change aspect ratio to "14:9"
 
| Change aspect ratio to "14:9"
 +
| 14:9
 +
|
 
| Current aspect ratio is "14:9"
 
| Current aspect ratio is "14:9"
 
|  
 
|  
Line 622: Line 744:
 
| TOGGLEASPECT
 
| TOGGLEASPECT
 
| Change aspect ratio to "2.35:1"
 
| Change aspect ratio to "2.35:1"
 +
| 2.35
 +
|
 
| Current aspect ratio is "2.35:1"
 
| Current aspect ratio is "2.35:1"
 
|  
 
|  
Line 627: Line 751:
 
| TOGGLEAUDIOSYNC
 
| TOGGLEAUDIOSYNC
 
|  
 
|  
| Bring up the audio synchronization adjustment dialog.
+
| Bring up the audio synchronization adjustment dialog
 +
| Adjust Audio Sync
 +
|
 
|  
 
|  
 
|  
 
|  
Line 634: Line 760:
 
|  
 
|  
 
| Turn auto-expire on or off for this recording
 
| Turn auto-expire on or off for this recording
 +
| Turn Auto-Expire OFF
 +
| Turn Auto-Expire ON
 
| Auto-expire is currently enabled for this recording
 
| Auto-expire is currently enabled for this recording
 
| Curently watching a recorded or in-progress recording
 
| Curently watching a recorded or in-progress recording
Line 640: Line 768:
 
|  
 
|  
 
| Toggle channel browse mode
 
| Toggle channel browse mode
 +
| Toggle Browse Mode
 +
|
 
|  
 
|  
 
| "Browse/change channels from Channel Group" setting is enabled
 
| "Browse/change channels from Channel Group" setting is enabled
Line 646: Line 776:
 
| TOGGLECOMMSKIP
 
| TOGGLECOMMSKIP
 
| Set commercial auto-skip to "Off"
 
| Set commercial auto-skip to "Off"
 +
| Off
 +
|
 
| Current auto-skip mode is "Off"
 
| Current auto-skip mode is "Off"
 
| Curently watching a recorded or in-progress recording
 
| Curently watching a recorded or in-progress recording
Line 652: Line 784:
 
| TOGGLECOMMSKIP
 
| TOGGLECOMMSKIP
 
| Set commercial auto-skip to "On"
 
| Set commercial auto-skip to "On"
 +
| On
 +
|
 
| Current auto-skip mode is "On"
 
| Current auto-skip mode is "On"
 
| Curently watching a recorded or in-progress recording
 
| Curently watching a recorded or in-progress recording
Line 658: Line 792:
 
| TOGGLECOMMSKIP
 
| TOGGLECOMMSKIP
 
| Set commercial auto-skip to "Notify"
 
| Set commercial auto-skip to "Notify"
 +
| Notify
 +
|
 
| Current auto-skip mode is "Notify"
 
| Current auto-skip mode is "Notify"
 
| Curently watching a recorded or in-progress recording
 
| Curently watching a recorded or in-progress recording
Line 664: Line 800:
 
| TOGGLEFILL
 
| TOGGLEFILL
 
| Set the video fill mode to "Off"
 
| Set the video fill mode to "Off"
 +
| Off
 +
|
 
| Current video fill mode is "Off"
 
| Current video fill mode is "Off"
 
|  
 
|  
Line 670: Line 808:
 
| TOGGLEFILL
 
| TOGGLEFILL
 
| Set the video fill mode to "Half"
 
| Set the video fill mode to "Half"
 +
| Half
 +
|
 
| Current video fill mode is "Half"
 
| Current video fill mode is "Half"
 
|  
 
|  
Line 676: Line 816:
 
| TOGGLEFILL
 
| TOGGLEFILL
 
| Set the video fill mode to "Full"
 
| Set the video fill mode to "Full"
 +
| Full
 +
|
 
| Current video fill mode is "Full"
 
| Current video fill mode is "Full"
 
|  
 
|  
Line 682: Line 824:
 
| TOGGLEFILL
 
| TOGGLEFILL
 
| Set the video fill mode to "H.Stretch"
 
| Set the video fill mode to "H.Stretch"
 +
| H.Stretch
 +
|
 
| Current video fill mode is "H.Stretch"
 
| Current video fill mode is "H.Stretch"
 
|  
 
|  
Line 688: Line 832:
 
| TOGGLEFILL
 
| TOGGLEFILL
 
| Set the video fill mode to "V.Stretch"
 
| Set the video fill mode to "V.Stretch"
 +
| V.Stretch
 +
|
 
| Current video fill mode is "V.Stretch"
 
| Current video fill mode is "V.Stretch"
 
|  
 
|  
Line 694: Line 840:
 
| TOGGLEFILL
 
| TOGGLEFILL
 
| Set the video fill mode to "H.Fill"
 
| Set the video fill mode to "H.Fill"
 +
| H.Fill
 +
|
 
| Current video fill mode is "H.Fill"
 
| Current video fill mode is "H.Fill"
 
|  
 
|  
Line 700: Line 848:
 
| TOGGLEFILL
 
| TOGGLEFILL
 
| Set the video fill mode to "V.Fill"
 
| Set the video fill mode to "V.Fill"
 +
| V.Fill
 +
|
 
| Current video fill mode is "V.Fill"
 
| Current video fill mode is "V.Fill"
 
|  
 
|  
Line 706: Line 856:
 
|  
 
|  
 
| Toggle manual zoom mode
 
| Toggle manual zoom mode
 +
| Manual Zoom Mode
 +
|
 
|  
 
|  
 
|  
 
|  
Line 712: Line 864:
 
|  
 
|  
 
| Enable or disable night mode
 
| Enable or disable night mode
 +
| Disable Night Mode
 +
| Enable Night Mode
 
| Night mode currently enabled
 
| Night mode currently enabled
 
| Video output device supports picture attributes
 
| Video output device supports picture attributes
Line 718: Line 872:
 
|  
 
|  
 
| Close Picture-by-Picture windows
 
| Close Picture-by-Picture windows
 +
| Close PBP(s)
 +
|
 
|  
 
|  
 
| PbP currently enabled
 
| PbP currently enabled
Line 724: Line 880:
 
| TOGGLEPICCONTROLS
 
| TOGGLEPICCONTROLS
 
| Adjust picture attribute - "None"
 
| Adjust picture attribute - "None"
 +
| None
 +
|
 
| Picture attributes currently set to studio levels
 
| Picture attributes currently set to studio levels
 
| Video output device supports this picture attribute
 
| Video output device supports this picture attribute
Line 730: Line 888:
 
| TOGGLEPICCONTROLS
 
| TOGGLEPICCONTROLS
 
| Adjust picture attribute - "Brightness"
 
| Adjust picture attribute - "Brightness"
 +
| Brightness
 +
|
 
| Picture attributes currently set to studio levels
 
| Picture attributes currently set to studio levels
 
| Video output device supports this picture attribute
 
| Video output device supports this picture attribute
Line 736: Line 896:
 
| TOGGLEPICCONTROLS
 
| TOGGLEPICCONTROLS
 
| Adjust picture attribute - "Contrast"
 
| Adjust picture attribute - "Contrast"
 +
| Contrast
 +
|
 
| Picture attributes currently set to studio levels
 
| Picture attributes currently set to studio levels
 
| Video output device supports this picture attribute
 
| Video output device supports this picture attribute
Line 742: Line 904:
 
| TOGGLEPICCONTROLS
 
| TOGGLEPICCONTROLS
 
| Adjust picture attribute - "Color"
 
| Adjust picture attribute - "Color"
 +
| Color
 +
|
 
| Picture attributes currently set to studio levels
 
| Picture attributes currently set to studio levels
 
| Video output device supports this picture attribute
 
| Video output device supports this picture attribute
Line 748: Line 912:
 
| TOGGLEPICCONTROLS
 
| TOGGLEPICCONTROLS
 
| Adjust picture attribute - "Hue"
 
| Adjust picture attribute - "Hue"
 +
| Hue
 +
|
 
| Picture attributes currently set to studio levels
 
| Picture attributes currently set to studio levels
 
| Video output device supports this picture attribute
 
| Video output device supports this picture attribute
Line 754: Line 920:
 
| TOGGLEPICCONTROLS
 
| TOGGLEPICCONTROLS
 
| Adjust picture attribute - "Volume"
 
| Adjust picture attribute - "Volume"
 +
| Volume
 +
|
 
| Picture attributes currently set to studio levels
 
| Picture attributes currently set to studio levels
 
| Video output device supports this picture attribute
 
| Video output device supports this picture attribute
Line 760: Line 928:
 
|  
 
|  
 
| Close Picture-in-Picture windows
 
| Close Picture-in-Picture windows
 +
| Close PIP(s)
 +
|
 
|  
 
|  
 
| PiP currently enabled
 
| PiP currently enabled
Line 766: Line 936:
 
|  
 
|  
 
| Switch between Picture-in-Picture and Picture-by-Picture mode
 
| Switch between Picture-in-Picture and Picture-by-Picture mode
 +
| Switch to PBP
 +
| Switch to PIP
 
| Currently displaying PiP (not PbP)
 
| Currently displaying PiP (not PbP)
 
| PiP/PbP currently active, and other mode supported
 
| PiP/PbP currently active, and other mode supported
Line 772: Line 944:
 
| TOGGLESLEEP
 
| TOGGLESLEEP
 
| Enter sleep mode in 30 minutes
 
| Enter sleep mode in 30 minutes
 +
| 30 minute(s)
 +
|
 
|  
 
|  
 
|  
 
|  
Line 778: Line 952:
 
| TOGGLESLEEP
 
| TOGGLESLEEP
 
| Enter sleep mode in 60 minutes
 
| Enter sleep mode in 60 minutes
 +
| 60 minute(s)
 +
|
 
|  
 
|  
 
|  
 
|  
Line 784: Line 960:
 
| TOGGLESLEEP
 
| TOGGLESLEEP
 
| Enter sleep mode in 90 minutes
 
| Enter sleep mode in 90 minutes
 +
| 90 minute(s)
 +
|
 
|  
 
|  
 
|  
 
|  
Line 790: Line 968:
 
| TOGGLESLEEP
 
| TOGGLESLEEP
 
| Enter sleep mode in 120 minutes
 
| Enter sleep mode in 120 minutes
 +
| 120 minute(s)
 +
|
 
|  
 
|  
 
|  
 
|  
Line 796: Line 976:
 
| TOGGLESLEEP
 
| TOGGLESLEEP
 
| Turn sleep mode off
 
| Turn sleep mode off
 +
| Sleep Off
 +
|
 
|  
 
|  
 
| Sleep mode currently enabled
 
| Sleep mode currently enabled
Line 802: Line 984:
 
|  
 
|  
 
| Toggle timestretch mode
 
| Toggle timestretch mode
 +
| Toggle
 +
|
 
|  
 
|  
 
|  
 
|  
Line 808: Line 992:
 
| TOGGLEPICCONTROLS
 
| TOGGLEPICCONTROLS
 
| Adjust picture attribute - "Studio levels"
 
| Adjust picture attribute - "Studio levels"
 +
| Studio Levels
 +
|
 
| Picture attributes currently set to studio levels
 
| Picture attributes currently set to studio levels
 
| Video output device supports this picture attribute
 
| Video output device supports this picture attribute
Line 814: Line 1,000:
 
|  
 
|  
 
| Bring up the adjust subtitle delay dialog
 
| Bring up the adjust subtitle delay dialog
 +
| Adjust Subtitle Delay
 +
|
 
|  
 
|  
 
| Text subtitles are currently enabled
 
| Text subtitles are currently enabled
Line 820: Line 1,008:
 
|  
 
|  
 
| Bring up the adjust subtitle zoom dialog
 
| Bring up the adjust subtitle zoom dialog
 +
| Adjust Subtitle Zoom
 +
|
 
|  
 
|  
 
| Subtitles are currently enabled
 
| Subtitles are currently enabled
Line 826: Line 1,016:
 
|  
 
|  
 
| Toggle teletext menu
 
| Toggle teletext menu
 +
| Toggle Teletext Menu
 +
|
 
|  
 
|  
 
| Teletext menu is available
 
| Teletext menu is available
Line 832: Line 1,024:
 
|  
 
|  
 
| Open "Upcoming Recordings" window
 
| Open "Upcoming Recordings" window
 +
| Upcoming Recordings
 +
|
 
|  
 
|  
 
|  
 
|  
 
|}
 
|}
  
(list of available actiongroups)
+
The following is a list of available action groups, including the list
 +
of actions each action group expands to.
  
 
{| cellpadding="4" border="1"
 
{| cellpadding="4" border="1"
Line 954: Line 1,149:
 
mechanism is especially useful for remote controls with a limited
 
mechanism is especially useful for remote controls with a limited
 
number of buttons.  One can map the menu button to the MENUCOMPACT
 
number of buttons.  One can map the menu button to the MENUCOMPACT
action, and the original menu can be reached via the compact menu.
+
action in the "TV Playback" context, and the original menu can be
 +
reached via the compact menu.
  
 
== Cutlist editor menu ==
 
== Cutlist editor menu ==
Line 972: Line 1,168:
 
| align="center"  |<b>Action Name</b>
 
| align="center"  |<b>Action Name</b>
 
| align="center"  |<b>Action Description</b>
 
| align="center"  |<b>Action Description</b>
 +
| align="center"  |<b>Default text (active)</b>
 +
| align="center"  |<b>Default text (inactive)</b>
 
| align="center"  |<b>show="active" condition</b><br />(default true)
 
| align="center"  |<b>show="active" condition</b><br />(default true)
 
| align="center"  |<b>Display condition</b><br />(default true)
 
| align="center"  |<b>Display condition</b><br />(default true)
Line 977: Line 1,175:
 
| DIALOG_CUTPOINT_CLEARMAP_0
 
| DIALOG_CUTPOINT_CLEARMAP_0
 
| Clear cutlist, i.e. remove all cutlist marks
 
| Clear cutlist, i.e. remove all cutlist marks
 +
| Clear Cuts
 +
|
 
|  
 
|  
 
|  
 
|  
Line 982: Line 1,182:
 
| DIALOG_CUTPOINT_CUTTOBEGINNING_0
 
| DIALOG_CUTPOINT_CUTTOBEGINNING_0
 
| Cut to beginning
 
| Cut to beginning
 +
| Cut to Beginning
 +
|
 
|  
 
|  
 
| Edit point is within the initial non-cut region
 
| Edit point is within the initial non-cut region
Line 987: Line 1,189:
 
| DIALOG_CUTPOINT_CUTTOEND_0
 
| DIALOG_CUTPOINT_CUTTOEND_0
 
| Cut to end
 
| Cut to end
 +
| Cut to End
 +
|
 
|  
 
|  
 
| Edit point is within the final non-cut region
 
| Edit point is within the final non-cut region
Line 992: Line 1,196:
 
| DIALOG_CUTPOINT_DELETE_0
 
| DIALOG_CUTPOINT_DELETE_0
 
| Delete current region, i.e. delete this cut region or join surrounding cut regions
 
| Delete current region, i.e. delete this cut region or join surrounding cut regions
 +
| Delete This Cut
 +
| Join Surrounding Cuts
 
| Edit point is within a cut region
 
| Edit point is within a cut region
 
|  
 
|  
Line 997: Line 1,203:
 
| DIALOG_CUTPOINT_INVERTMAP_0
 
| DIALOG_CUTPOINT_INVERTMAP_0
 
| Reverse cuts, i.e. change cut regions to non-cut regions and vice versa
 
| Reverse cuts, i.e. change cut regions to non-cut regions and vice versa
 +
| Reverse Cuts
 +
|
 
|  
 
|  
 
|  
 
|  
Line 1,002: Line 1,210:
 
| DIALOG_CUTPOINT_LOADCOMMSKIP_0
 
| DIALOG_CUTPOINT_LOADCOMMSKIP_0
 
| Load detected commercials, replacing any existing cut regions
 
| Load detected commercials, replacing any existing cut regions
 +
| Load Detected Commercials
 +
|
 
|  
 
|  
 
|  
 
|  
Line 1,007: Line 1,217:
 
| DIALOG_CUTPOINT_MOVENEXT_0
 
| DIALOG_CUTPOINT_MOVENEXT_0
 
| Move the start of the next cut, or the end of the current cut, to the current edit point
 
| Move the start of the next cut, or the end of the current cut, to the current edit point
 +
| Move Next Cut Start Here
 +
| Move End of Cut Here
 
| Edit point is within a non-cut region
 
| Edit point is within a non-cut region
 
| (if the action is possible in the current context)
 
| (if the action is possible in the current context)
Line 1,012: Line 1,224:
 
| DIALOG_CUTPOINT_MOVEPREV_0
 
| DIALOG_CUTPOINT_MOVEPREV_0
 
| Move the end of the previous cut, or the start of the next cut, to the current edit point
 
| Move the end of the previous cut, or the start of the next cut, to the current edit point
 +
| Move Previous Cut End Here
 +
| Move Start of Cut Here
 
| Edit point is within a non-cut region
 
| Edit point is within a non-cut region
 
| (if the action is possible in the current context)
 
| (if the action is possible in the current context)
Line 1,017: Line 1,231:
 
| DIALOG_CUTPOINT_NEWCUT_0
 
| DIALOG_CUTPOINT_NEWCUT_0
 
| Add a new cut point or region
 
| Add a new cut point or region
 +
| Add New Cut
 +
|
 
|  
 
|  
 
| Edit point is within a non-cut region
 
| Edit point is within a non-cut region
Line 1,022: Line 1,238:
 
| DIALOG_CUTPOINT_REDO_0
 
| DIALOG_CUTPOINT_REDO_0
 
| Redo a previously undone action
 
| Redo a previously undone action
 +
| Redo - %1
 +
|
 
| The undo stack has at least one action to redo
 
| The undo stack has at least one action to redo
 
|  
 
|  
Line 1,027: Line 1,245:
 
| DIALOG_CUTPOINT_REVERTEXIT_0
 
| DIALOG_CUTPOINT_REVERTEXIT_0
 
| Exit cutlist editor without saving
 
| Exit cutlist editor without saving
 +
| Exit Without Saving
 +
|
 
|  
 
|  
 
|  
 
|  
Line 1,032: Line 1,252:
 
| DIALOG_CUTPOINT_REVERT_0
 
| DIALOG_CUTPOINT_REVERT_0
 
| Revert all changes
 
| Revert all changes
 +
| Undo Changes
 +
|
 
|  
 
|  
 
|  
 
|  
Line 1,037: Line 1,259:
 
| DIALOG_CUTPOINT_SAVEEXIT_0
 
| DIALOG_CUTPOINT_SAVEEXIT_0
 
| Save changes and exit
 
| Save changes and exit
 +
| Save Cuts and Exit
 +
|
 
|  
 
|  
 
|  
 
|  
Line 1,042: Line 1,266:
 
| DIALOG_CUTPOINT_SAVEMAP_0
 
| DIALOG_CUTPOINT_SAVEMAP_0
 
| Save changes and continue
 
| Save changes and continue
 +
| Save Cuts
 +
|
 
|  
 
|  
 
|  
 
|  
Line 1,047: Line 1,273:
 
| DIALOG_CUTPOINT_UNDO_0
 
| DIALOG_CUTPOINT_UNDO_0
 
| Undo a previously undone action
 
| Undo a previously undone action
 +
| Undo - %1
 +
|
 
| The undo stack has at least one action to undo
 
| The undo stack has at least one action to undo
 
|  
 
|  

Latest revision as of 13:30, 30 July 2013

The Themed Menu feature allows users and themers to customize the content and structure of hierarchical pop-up menus. This customization is in the form of an XML file in the Theme directory or under the user's home directory.

Users may be most interested in the new Compact menus, which allow the user to collect and reorder their most commonly used menu items into a more convenient list and hierarchy.


Important.png Note: Themed Menus are currently in Beta release.

As such, more menus will eventually become customizable, and many of the action names will be deprecated and renamed.

Overview

A Themed Menu is a simple XML description of a hierarchical menu, consisting of menu, item, and itemlist elements. Here is an example of a themed menu for the Playback OSD.

<?xml version="1.0"?>
<menu text="My Themed Menu">
  <menu text="Submenu">
    <item action="TOGGLESUBDELAY"  text="Adjust Subtitle Delay" />
    <item action="TOGGLEAUDIOSYNC" text="Adjust Audio Sync" />
    <item action="ADJUSTSTRETCH"   text="Adjust Time Stretch" />
  </menu>
  <menu text="Another submenu">
    <item action="PAUSE" text="Play"  show="active" />
    <item action="PAUSE" text="Pause" show="inactive" />
  </menu>
</menu>

This example defines a menu which, at the top level, consists of two submenus, titled "Submenu" and "Another submenu". Navigating to the first submenu shows a list of three actions. The second submenu would actually offer only one action, labeled "Play" or "Pause" depending on current state of playback.

In addition to the item element, the itemlist element expands an action group into a list of actions, which is especially useful when the actions depend on the particular recording or context, such as a list of track names.

Menu file description

A Themed Menu XML file contains a single top-level menu element, whose text attribute is displayed as the menu title.

Below we describe in detail the set of available XML elements, along with each element's available attributes.

The menu element

Menu items are enclosed within a menu element. Nesting menu elements creates a submenu hierarchy.

Example:

<menu text="My Menu Title">
  <menu text="My Submenu Title">
    ...
  </menu>
  <menu text="My Other Submenu Title">
    ...
  </menu>
</menu>

The text attribute

This is the text displayed as the title of the menu or submenu. The text is translated using MythTV's translation infrastucture, so it is wise to reuse existing, already-translated strings for Themed Menus that are distributed to others.

The text attribute is required (otherwise the menu name will be blank).

The item element

The item element describes a menu item with a concrete action. Each item contains internal "show" and "current" state that can be used to partially control the display of the item.

A given item is displayed only if it is actually allowed in the current context. For example, the actions related to jumping to DVD menus would only be shown during DVD/BD playback. Similarly, most of the Picture-In-Picture actions can only be shown while PiP/PbP is active.

Example:

<item action="PAUSE" text="Play"  show="active" />
<item action="PAUSE" text="Pause" show="inactive" />

The action attribute

This is the name of the action to execute when the menu item is selected. See below for a comprehensive description of available actions.

The action attribute is the only required attribute of the item element.


Important.png Note: All action names are subject to future renaming.

The action names correspond to their internal MythTV names and are being exposed externally for the first time. Future normalization and cleanup will likely deprecate and change many of the current action names.

The text attribute

This is the text that appears in the menu item. Every action has a default, translatable text string, so in most cases the text attribute can and should be omitted. Some actions actually have two default strings, one for the "active" state and one for the "inactive" state.

If you need to specify or change the text attribute, and you plan to distribute your XML file to others, try to consider the translation issues. In partcular, try to reuse strings that are already translated.

The show attribute

The show attribute can take two possible values: "active" and "inactive". If the show attribute is present, then the menu item is displayed only when its "show" state matches the show attribute.

show="active" and show="inactive" are typically used in two situations. The first situation is when the action toggles some state, and you want different text attributes depending on the current state. Example:

<item action="PAUSE" text="Play"  show="active" />
<item action="PAUSE" text="Pause" show="inactive" />

The second situation is when you want to suppress a menu item when the action would essentially be a no-op, such as disabling subtitles when subtitles are already turned off. Example:

<item action="DISABLESUBS" text="Disable Subtitles" show="inactive" />
<item action="ENABLESUBS"  text="Enable Subtitles"  show="inactive" />

If the show attribute is not specified, the menu item will always be shown (provided the action is allowed in the current context; see the discussion above).

The current attribute

When a menu is opened, normally the first menu item is highlighted. This can be overridden using current="active". If that action is active in the current context, that menu item will be highlighted rather than the first item. For example:

<menu text="Change Aspect Ratio">
  <item action="TOGGLEASPECT0" text="Off"    current="active" />
  <item action="TOGGLEASPECT1" text="4:3"    current="active" />
  <item action="TOGGLEASPECT3" text="14:9"   current="active" />
  <item action="TOGGLEASPECT2" text="16:9"   current="active" />
  <item action="TOGGLEASPECT4" text="2.35:1" current="active" />
</menu>

In this example, when the "Change Aspect Ratio" menu is opened, the current aspect ratio will be highlighted.

Additionally, setting current="y" or current="t" or current="1" will unconditionally highlight the menu item.

If multiple items in a menu match the current="..." test, an arbitrary one is chosen to be highlighted.

There is one exception to this rule. When navigating back from a submenu into its parent menu, that submenu is always highlighted.

The itemlist element

The itemlist element expands into a list (possibly zero-length) of menu items. In some cases, it is precisely equivalent to a list of item elements, and is just a convenience. In other cases, the set of items is dynamically generated as part of the current context, such as a list of available tracks or DVD titles.

The actiongroup attribute

This is the name of the action group to expand. See below for a comprehensive description of available actiongroups.

The actiongroup attribute is the only required attribute of the itemlist element.


Important.png Note: All action group names are subject to future renaming.

The action group names correspond to prefixes of internal MythTV action names and other internal MythTV logic. Future normalization and cleanup will likely deprecate and change many of the current action group names.

The current attribute

This is equivalent to the current attribute in the item element, as though the attribute were applied to all items in the expansion of the action group.

The include element

The include element allows rudimentary modularization by including the contents of another Themed Menu XML file. It contains a single required attribute, file. Example:

<menu text="Playback Compact Menu">
  <item action="EDIT" />
  <item action="DEBUGOSD" />
  <include file="menu_playback.xml" />
</menu>

There is a limited recursive include depth, in order to avoid infinite recursion.

Themed Menu file search path

When loading a Themed Menu XML file, the first location searched is $MYTHCONFDIR (or, if MYTHCONFDIR is not defined, ~/.mythtv/). If the file is not found, it then uses the standard MythUI theme search path.

This means that a theme developer can provide an overridden version of a Themed Menu, and ultimately the user can override all of these.

Customizable menus

Currently there are four implementations of Themed Menus.

Playback OSD menu

The Playback OSD menu is read from menu_playback.xml, and is displayed during playback via the MENU action (mapped by default to the 'M' key).

Action Name Action Group Action Description Default text (active) Default text (inactive) show="active" condition
(default true)
Display condition
(default true)
3DNONE 3D Deactivate 3D mode None If the video output device supports stereoscopic modes
3DSIDEBYSIDE 3D Activate side-by-side 3D mode Side by Side The video output device supports stereoscopic modes
3DSIDEBYSIDEDISCARD 3D Activate discard side-by-side 3D mode Discard Side by Side The video output device supports stereoscopic modes
3DTOPANDBOTTOM 3D Activate top-and-bottom 3D mode Top and Bottom The video output device supports stereoscopic modes
3DTOPANDBOTTOMDISCARD 3D Activate discard top-and-bottom 3D mode Discard Top and Bottom The video output device supports stereoscopic modes
ADJUSTSTRETCH ADJUSTSTRETCH Bring up the timestretch adjustment dialog Adjust
ADJUSTSTRETCH0.5 ADJUSTSTRETCH Set the timestretch value to 0.5x 0.5x
ADJUSTSTRETCH0.9 ADJUSTSTRETCH Set the timestretch value to 0.9x 0.9x
ADJUSTSTRETCH1.0 ADJUSTSTRETCH Set the timestretch value to 1.0x 1.0x
ADJUSTSTRETCH1.1 ADJUSTSTRETCH Set the timestretch value to 1.1x 1.1x
ADJUSTSTRETCH1.2 ADJUSTSTRETCH Set the timestretch value to 1.2x 1.2x
ADJUSTSTRETCH1.3 ADJUSTSTRETCH Set the timestretch value to 1.3x 1.3x
ADJUSTSTRETCH1.4 ADJUSTSTRETCH Set the timestretch value to 1.4x 1.4x
ADJUSTSTRETCH1.5 ADJUSTSTRETCH Set the timestretch value to 1.5x 1.5x
AUTODETECT_FILL Set the video fill mode to "Autodetect" Auto Detect Current video fill mode is "Autodetect" The video output device is not HW-accelerated
CANCELPLAYLIST Cancel the playlist in progress Cancel Playlist Playlist currently active
CREATEPBPVIEW Open a Live TV Picture-by-Picture window Open Live TV PBP New PbP window possible (at least 1 free recorder, PiP not currently active, etc.)
CREATEPIPVIEW Open a Live TV Picture-in-Picture window Open Live TV PIP New PiP window possible (at least 1 free recorder, PbP not currently active, etc.)
DEBUGOSD Toggle OSD playback information overlay Playback Data
DIALOG_JUMPREC_X_0 Open the "Jump to Recorded Program" dialog Recorded Program
DISABLEEXTTEXT Disable external text subtitles Disable External Subtitles External text subtitles currently not being displayed Recording contains external text subtitles
DISABLEFORCEDSUBS Disable forced subtitles Disable Forced Subtitles Forced subtitles current not enabled Recording contains A/V or text subtitles
DISABLESUBS Disable subtitle display Disable Subtitles Subtitles currently not being displayed Recording contains subtitles
DISABLEUPMIX Disable audio upmixer Disable Audio Upmixer Upmixing currently not enabled Audio output device supports upmixing
DISABLEVISUALISATION Disable audio visualizer None Video output device supports visualization
EDIT Edit channel (if playing Live TV), or edit recording (otherwise) Edit Channel Edit Recording Currently playing Live TV Not playing DVD or BD
ENABLEEXTTEXT Enable external text subtitles Enable External Subtitles External text subtitles currently being displayed Recording contains external text subtitles
ENABLEFORCEDSUBS Ensable forced subtitles Enable Forced Subtitles Forced subtitles current enabled Recording contains A/V or text subtitles
ENABLESUBS Enable subtitle display Enable Subtitles Subtitles currently being displayed Recording contains subtitles
ENABLEUPMIX Enable audio upmixer Auto Detect Upmixing currently enabled Audio output device supports upmixing
FINDER Open "Program Finder" window Program Finder
GUIDE Open "Program Guide" window Program Guide
JUMPFFWD Jump ahead Jump Ahead Current recording allows jumping
JUMPPREV Jump to previously played recording Last recording in the form Title: Subtitle Previously played recording exists
JUMPRECPBP Open a Recording Picture-by-Picture window Open Recording PBP New PbP window possible (at least 1 available PbP slot, PiP not currently active, etc.)
JUMPRECPIP Open a Recording Picture-in-Picture window Open Recording PIP New PiP window possible (at least 1 available PiP slot, PbP not currently active, etc.)
JUMPRWND Jump back Jump Back Current recording allows jumping
JUMPTODVDCHAPTERMENU Jump to DVD chapter menu DVD Chapter Menu Currently watching a DVD
JUMPTODVDROOTMENU Jump to DVD root menu DVD Root Menu Top Menu Currently watching a DVD
JUMPTODVDTITLEMENU Jump to DVD title menu DVD Title Menu Currently watching a DVD
JUMPTOPOPUPMENU Jump to BluRay popup menu Popup menu Currently watching a BD
NEXTPIPWINDOW Change active PiP/PbP window Change Active Window Currently displaying at least 1 PiP/PbP window
PAUSE Toggle play/pause state Play Pause Currently paused (not playing)
PREVCHAN Jump to previous channel Previous Channel Watching Live TV, and there exists a previously watched channel
QUEUETRANSCODE Start or stop a transcoding job for the current recording (using default transcoding profile) Stop Transcoding Transcoding job currently active for this recording Currently watching a recorded program
QUEUETRANSCODE_AUTO Start or stop a transcoding job for the current recording (using auto-detect transcoding profile) Autodetect Transcoding job currently active for this recording Currently watching a recorded program
QUEUETRANSCODE_HIGH Start or stop a transcoding job for the current recording (using high-quality transcoding profile) High Quality Transcoding job currently active for this recording Currently watching a recorded program
QUEUETRANSCODE_LOW Start or stop a transcoding job for the current recording (using low-quality transcoding profile) Low Quality Transcoding job currently active for this recording Currently watching a recorded program
QUEUETRANSCODE_MEDIUM Start or stop a transcoding job for the current recording (using medium-quality transcoding profile) Medium Quality Transcoding job currently active for this recording Currently watching a recorded program
SCHEDULE Open "Edit Recording Schedule" window Edit Recording Schedule
SELECTSCAN_0 SELECTSCAN_ Set video scan type to "Detect" Detect Current scan type is "Detect"
SELECTSCAN_1 SELECTSCAN_ Set video scan type to "Interlaced (Normal)" Interlaced (Normal) Current scan type is "Interlaced (Normal)"
SELECTSCAN_2 SELECTSCAN_ Set video scan type to "Interlaced (Reversed)" Interlaced (Reversed) Current scan type is "Interlaced (Reversed)"
SELECTSCAN_3 SELECTSCAN_ Set video scan type to "Progressive" Progressive Current scan type is "Progressive"
SWAPPIP Swap PiP/PbP windows Swap Windows Currently displaying at least 2 PiP/PbP windows
TOGGLEASPECT0 TOGGLEASPECT Change aspect ratio to "Off" Off Current aspect ratio is "Off"
TOGGLEASPECT1 TOGGLEASPECT Change aspect ratio to "4:3" 4:3 Current aspect ratio is "4:3"
TOGGLEASPECT2 TOGGLEASPECT Change aspect ratio to "16:9" 16:9 Current aspect ratio is "16:9"
TOGGLEASPECT3 TOGGLEASPECT Change aspect ratio to "14:9" 14:9 Current aspect ratio is "14:9"
TOGGLEASPECT4 TOGGLEASPECT Change aspect ratio to "2.35:1" 2.35 Current aspect ratio is "2.35:1"
TOGGLEAUDIOSYNC Bring up the audio synchronization adjustment dialog Adjust Audio Sync
TOGGLEAUTOEXPIRE Turn auto-expire on or off for this recording Turn Auto-Expire OFF Turn Auto-Expire ON Auto-expire is currently enabled for this recording Curently watching a recorded or in-progress recording
TOGGLEBROWSE Toggle channel browse mode Toggle Browse Mode "Browse/change channels from Channel Group" setting is enabled
TOGGLECOMMSKIP0 TOGGLECOMMSKIP Set commercial auto-skip to "Off" Off Current auto-skip mode is "Off" Curently watching a recorded or in-progress recording
TOGGLECOMMSKIP1 TOGGLECOMMSKIP Set commercial auto-skip to "On" On Current auto-skip mode is "On" Curently watching a recorded or in-progress recording
TOGGLECOMMSKIP2 TOGGLECOMMSKIP Set commercial auto-skip to "Notify" Notify Current auto-skip mode is "Notify" Curently watching a recorded or in-progress recording
TOGGLEFILL0 TOGGLEFILL Set the video fill mode to "Off" Off Current video fill mode is "Off"
TOGGLEFILL1 TOGGLEFILL Set the video fill mode to "Half" Half Current video fill mode is "Half"
TOGGLEFILL2 TOGGLEFILL Set the video fill mode to "Full" Full Current video fill mode is "Full"
TOGGLEFILL3 TOGGLEFILL Set the video fill mode to "H.Stretch" H.Stretch Current video fill mode is "H.Stretch"
TOGGLEFILL4 TOGGLEFILL Set the video fill mode to "V.Stretch" V.Stretch Current video fill mode is "V.Stretch"
TOGGLEFILL5 TOGGLEFILL Set the video fill mode to "H.Fill" H.Fill Current video fill mode is "H.Fill"
TOGGLEFILL6 TOGGLEFILL Set the video fill mode to "V.Fill" V.Fill Current video fill mode is "V.Fill"
TOGGLEMANUALZOOM Toggle manual zoom mode Manual Zoom Mode
TOGGLENIGHTMODE Enable or disable night mode Disable Night Mode Enable Night Mode Night mode currently enabled Video output device supports picture attributes
TOGGLEPBPMODE Close Picture-by-Picture windows Close PBP(s) PbP currently enabled
TOGGLEPICCONTROLS0 TOGGLEPICCONTROLS Adjust picture attribute - "None" None Picture attributes currently set to studio levels Video output device supports this picture attribute
TOGGLEPICCONTROLS1 TOGGLEPICCONTROLS Adjust picture attribute - "Brightness" Brightness Picture attributes currently set to studio levels Video output device supports this picture attribute
TOGGLEPICCONTROLS2 TOGGLEPICCONTROLS Adjust picture attribute - "Contrast" Contrast Picture attributes currently set to studio levels Video output device supports this picture attribute
TOGGLEPICCONTROLS3 TOGGLEPICCONTROLS Adjust picture attribute - "Color" Color Picture attributes currently set to studio levels Video output device supports this picture attribute
TOGGLEPICCONTROLS4 TOGGLEPICCONTROLS Adjust picture attribute - "Hue" Hue Picture attributes currently set to studio levels Video output device supports this picture attribute
TOGGLEPICCONTROLS6 TOGGLEPICCONTROLS Adjust picture attribute - "Volume" Volume Picture attributes currently set to studio levels Video output device supports this picture attribute
TOGGLEPIPMODE Close Picture-in-Picture windows Close PIP(s) PiP currently enabled
TOGGLEPIPSTATE Switch between Picture-in-Picture and Picture-by-Picture mode Switch to PBP Switch to PIP Currently displaying PiP (not PbP) PiP/PbP currently active, and other mode supported
TOGGLESLEEP30 TOGGLESLEEP Enter sleep mode in 30 minutes 30 minute(s)
TOGGLESLEEP60 TOGGLESLEEP Enter sleep mode in 60 minutes 60 minute(s)
TOGGLESLEEP90 TOGGLESLEEP Enter sleep mode in 90 minutes 90 minute(s)
TOGGLESLEEP120 TOGGLESLEEP Enter sleep mode in 120 minutes 120 minute(s)
TOGGLESLEEPON TOGGLESLEEP Turn sleep mode off Sleep Off Sleep mode currently enabled
TOGGLESTRETCH Toggle timestretch mode Toggle
TOGGLESTUDIOLEVELS TOGGLEPICCONTROLS Adjust picture attribute - "Studio levels" Studio Levels Picture attributes currently set to studio levels Video output device supports this picture attribute
TOGGLESUBDELAY Bring up the adjust subtitle delay dialog Adjust Subtitle Delay Text subtitles are currently enabled
TOGGLESUBZOOM Bring up the adjust subtitle zoom dialog Adjust Subtitle Zoom Subtitles are currently enabled
TOGGLETTM Toggle teletext menu Toggle Teletext Menu Teletext menu is available
VIEWSCHEDULED Open "Upcoming Recordings" window Upcoming Recordings

The following is a list of available action groups, including the list of actions each action group expands to.

Action Group Action Group Description List of Actions
3D 3D display modes 3DNONE
3DSIDEBYSIDE
3DSIDEBYSIDEDISCARD
3DTOPANDBOTTOM
3DTOPANDBOTTOMDISCARD
ADJUSTSTRETCH Timestretch options ADJUSTSTRETCH
ADJUSTSTRETCH0.5
ADJUSTSTRETCH0.9
ADJUSTSTRETCH1.0
ADJUSTSTRETCH1.1
ADJUSTSTRETCH1.2
ADJUSTSTRETCH1.3
ADJUSTSTRETCH1.4
ADJUSTSTRETCH1.5
CHANGROUP_ List of available channel groups (provided the "Browse/change channels from Channel Group" setting is enabled) Varies
DEINTERLACER_ List of available deinterlacers Varies
JUMPTOCHAPTER List of available chapters Varies
JUMPTOTITLE List of available titles Varies
SELECTAUDIO_ List of available audio tracks Varies
SELECTCC608_ List of available EIA-608 closed caption tracks Varies
SELECTCC708_ List of available EIA-708 closed caption tracks Varies
SELECTRAWTEXT_ List of available text subtitle tracks Varies
SELECTSCAN_ List of available video scan modes SELECTSCAN_0
SELECTSCAN_3
SELECTSCAN_1
SELECTSCAN_2
SELECTSUBTITLE_ List of available A/V subtitle tracks Varies
SELECTTTC_ List of available teletext caption tracks Varies
SWITCHTOANGLE List of available DVD/BD angles Varies
SWITCHTOINPUT_ List of available input cards within Live TV Varies
SWITCHTOSOURCE_ List of available input sources within Live TV Varies
TOGGLEASPECT Video aspect ratio modes TOGGLEASPECT0
TOGGLEASPECT1
TOGGLEASPECT3
TOGGLEASPECT2
TOGGLEASPECT4
TOGGLECOMMSKIP Commercial skip modes TOGGLECOMMSKIP0
TOGGLECOMMSKIP2
TOGGLECOMMSKIP1
TOGGLEFILL Video fill modes TOGGLEFILL0
TOGGLEFILL1
TOGGLEFILL2
TOGGLEFILL3
TOGGLEFILL4
TOGGLEFILL5
TOGGLEFILL6
TOGGLEPICCONTROLS Video picture control modes TOGGLEPICCONTROLS0
TOGGLEPICCONTROLS1
TOGGLEPICCONTROLS2
TOGGLEPICCONTROLS3
TOGGLEPICCONTROLS4
TOGGLESTUDIOLEVELS
TOGGLEPICCONTROLS6
TOGGLESLEEP Sleep modes TOGGLESLEEPON
TOGGLESLEEP30
TOGGLESLEEP60
TOGGLESLEEP90
TOGGLESLEEP120
VISUALISER_ Audio visualizer modes Varies

Playback OSD compact menu

The Playback OSD compact menu is read from menu_playback_compact.xml, and is displayed during playback via the MENUCOMPACT action (mapped by default to the 'Alt+M' key).

The default OSD compact menu is defined as follows:

<menu text="Playback Compact Menu">
  <!-- Insert desired actions here.  End by including the main menu
       so that all actions are ultimately available.  The actions
       may need more descriptive text outside the context of the
       original menu; if so, it's best to find a string from tv_play.cpp
       that is already being translated. -->
  <include file="menu_playback.xml" />
</menu>

Note the inclusion of the main Playback OSD menu at the end. This mechanism is especially useful for remote controls with a limited number of buttons. One can map the menu button to the MENUCOMPACT action in the "TV Playback" context, and the original menu can be reached via the compact menu.

Cutlist editor menu

The cutlist editor menu is read from menu_cutlist.xml, and is displayed during cutlist editing via the MENU action (mapped by default to the 'M' key).

The cutlist editor actions are not part of any action groups at present.

Note: in the text attribute for the Undo and Redo actions, the placeholder '%1' will be replaced with a string representing the action to undo or redo.

Action Name Action Description Default text (active) Default text (inactive) show="active" condition
(default true)
Display condition
(default true)
DIALOG_CUTPOINT_CLEARMAP_0 Clear cutlist, i.e. remove all cutlist marks Clear Cuts
DIALOG_CUTPOINT_CUTTOBEGINNING_0 Cut to beginning Cut to Beginning Edit point is within the initial non-cut region
DIALOG_CUTPOINT_CUTTOEND_0 Cut to end Cut to End Edit point is within the final non-cut region
DIALOG_CUTPOINT_DELETE_0 Delete current region, i.e. delete this cut region or join surrounding cut regions Delete This Cut Join Surrounding Cuts Edit point is within a cut region
DIALOG_CUTPOINT_INVERTMAP_0 Reverse cuts, i.e. change cut regions to non-cut regions and vice versa Reverse Cuts
DIALOG_CUTPOINT_LOADCOMMSKIP_0 Load detected commercials, replacing any existing cut regions Load Detected Commercials
DIALOG_CUTPOINT_MOVENEXT_0 Move the start of the next cut, or the end of the current cut, to the current edit point Move Next Cut Start Here Move End of Cut Here Edit point is within a non-cut region (if the action is possible in the current context)
DIALOG_CUTPOINT_MOVEPREV_0 Move the end of the previous cut, or the start of the next cut, to the current edit point Move Previous Cut End Here Move Start of Cut Here Edit point is within a non-cut region (if the action is possible in the current context)
DIALOG_CUTPOINT_NEWCUT_0 Add a new cut point or region Add New Cut Edit point is within a non-cut region
DIALOG_CUTPOINT_REDO_0 Redo a previously undone action Redo - %1 The undo stack has at least one action to redo
DIALOG_CUTPOINT_REVERTEXIT_0 Exit cutlist editor without saving Exit Without Saving
DIALOG_CUTPOINT_REVERT_0 Revert all changes Undo Changes
DIALOG_CUTPOINT_SAVEEXIT_0 Save changes and exit Save Cuts and Exit
DIALOG_CUTPOINT_SAVEMAP_0 Save changes and continue Save Cuts
DIALOG_CUTPOINT_UNDO_0 Undo a previously undone action Undo - %1 The undo stack has at least one action to undo

Cutlist editor compact menu

The cutlist editor compact menu is read from menu_cutlist_compact.xml, and is displayed during cutlist editing via the MENUCOMPACT action (mapped by default to the 'Alt+M' key).

The default cutlist editor compact menu is defined as follows:

<menu text="Edit Cut Points (Compact)">
  <!-- Insert desired actions here.  End by including the main menu
       so that all actions are ultimately available.  The actions
       may need more descriptive text outside the context of the
       original menu; if so, it's best to find a string from tv_play.cpp
       that is already being translated. -->
  <include file="menu_cutlist.xml" />
</menu>