Foobar2000:Preferences:Keyboard Shortcuts: Difference between revisions

From Hydrogenaudio Knowledgebase
No edit summary
m (C3POwen moved page Foobar2000:Preferences:General:Keyboard Shortcuts to Foobar2000:Preferences:Keyboard Shortcuts: Preferences page no longer sits under "General" page.)
 
(19 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{fb2k prefs}}
{{DISPLAYTITLE:foobar2000:Preferences:General:Keyboard Shortcuts}}
[[Category:foobar2000 Preferences|Keyboard Shortcuts]]
{{fb2k prefs|kb-shot-1.png|Keyboard Shortcuts}}
This is the Keyboard Shortcuts page. It contains information for configuring foobar2000 keyboard shortcuts.
This is the '''Keyboard Shortcuts''' page. It contains information for configuring foobar2000 keyboard shortcuts.
[[Image:kb-shot-1.png|Keyboard Shortcuts preferences]]


== Concepts ==
== Concepts ==


Keyboard shortcuts are associated with menu commands. Menu commands may include the main menu bar, context menus, and sub-menus. Several dozen keyboard shortcuts are predefined upon installation of foobar2000. Many of these shortcuts are familiar: '''Ctrl+S''' for “save”, '''Ctrl+P''' for “preferences”, et cetera. It is helpful to review predefined keyboard shortcuts by examining the preferences panel.
Keyboard shortcuts are associated with menu commands. Menu commands may include the main menu bar, context menus, and sub-menus. Several dozen keyboard shortcuts are predefined upon installation of foobar2000. Many of these shortcuts are familiar: {{key press|Ctrl|S}} for “save”, {{key press|Ctrl|P}} for “preferences”, et cetera. It is helpful to review predefined keyboard shortcuts by examining the preferences panel.


Keyboard shortcuts can be defined for unmodified keys, such as '''Z''' for stop, or for modified keys such as '''Ctrl+P''' for 'print.' Possible modifiers are '''Ctrl''', '''Shift,''' and '''Alt.'''
Keyboard shortcuts can be defined for unmodified keys, such as {{key press|Z}} for “stop”, or for modified keys such as {{key press|Ctrl|N}} for “New Playlist.Possible modifiers are {{key press|Ctrl}}, {{key press|Shift}}, {{key press|Alt}}, and {{key press|Win}}.


Keyboard shortcuts have the possibility of being defined as “global”. A global keyboard shortcut takes action even when foobar2000 is running in the background. If foobar2000 is running, global keyboard shortcuts will control it. Users having keyboards equipped with dedicated multi-media keys may wish to assign global keyboard shortcuts to these keys.
Keyboard shortcuts have the possibility of being defined as “global”. A global keyboard shortcut takes action even when foobar2000 is running in the background. If foobar2000 is running, global keyboard shortcuts will control it. Users having keyboards equipped with dedicated multi-media keys may wish to assign global keyboard shortcuts to these keys.


There are no global keyboard shortcuts among the predefined keys. One can easily assign global status to one or more of these keys. Good candidates for global assignment are the volume-controling keys: '''Num +''' and '''Num -'''. Global assignments should be made carefully as they may interfere with your ability to use other applications.
There are no global keyboard shortcuts among the predefined keys. One can easily assign global status to one or more of these keys. Good candidates for global assignment are the volume-controling keys: {{key press|Num +}} and {{key press|Num −}}. Global assignments should be made carefully as they may interfere with your ability to use other applications.
 
===Keyboard Shortcut definition procedure===
*1: in “Assigned Shortcuts” portion: select (highlight) current shortcut or add new shortcut
*2: in “Action” portion:  select (highlight) menu “Action”
*3: in “Key” portion: select (highlight) keystroke field, press keystroke combination.
*4: optionally enable "global hotkey"
*5: press "Apply"


== Keyboard Shortcut preferences panel ==
== Keyboard Shortcut preferences panel ==
Line 21: Line 27:
A related option appears on the "Display" preferences panel. A (normally-checked) box specifies whether shortcuts should be displayed in menus. You may wish to uncheck this to prevent menus from becoming unmanageably wide.
A related option appears on the "Display" preferences panel. A (normally-checked) box specifies whether shortcuts should be displayed in menus. You may wish to uncheck this to prevent menus from becoming unmanageably wide.


==== “Assigned Shortcuts” portion: lists and defines shortcuts ====
=== Assigned shortcuts ===


The top portion of the keyboard shortcut preferences displays a list of existing shortcuts. The list may be sorted by clicking one of headers.
The top portion of the keyboard shortcut preferences displays a list of existing shortcuts. The list may be sorted by clicking one of headers.


==== “Action” portion: menu structure and filter ====
=== Action ===


This middle portion of the preference panel shows the menu commands available for assignment. This portion of the panel may be ignored if you are simply reviewing keyboard shortcuts already defined.
This middle portion of the preference panel shows the menu commands available for assignment. This portion of the panel may be ignored if you are simply reviewing keyboard shortcuts already defined.
Line 33: Line 39:
A filter is available to speed the task of assigning new com­mands. This filter reduces the number of items displayed in the com­mands list, assuming the user enters part of the com­mand name he is looking for. Otherwise, the filter has no effect on foobar2000's operation. Be sure to remove stray char­acters that might be entered in this filter—otherwise you may not be able to see the command you're after!
A filter is available to speed the task of assigning new com­mands. This filter reduces the number of items displayed in the com­mands list, assuming the user enters part of the com­mand name he is looking for. Otherwise, the filter has no effect on foobar2000's operation. Be sure to remove stray char­acters that might be entered in this filter—otherwise you may not be able to see the command you're after!


==== “Key” portion: assignment of keystroke ====
=== Key ===


The final portion of the keyboard shortcuts preferences panel shows the keystroke assigned to a given action. To assign a different keystroke, click in the field and press the new keystroke.
The final portion of the keyboard shortcuts preferences panel shows the keystroke assigned to a given action. To assign a different keystroke, click in the field and press the new keystroke.


== Predefined Keyboard Shortcuts ==
== Predefined keyboard shortcuts ==


There are nine predefined shortcuts in a fresh installation of foobar2000 v0.9.5 and later. All predefined shortcuts are “non-global”, or local, shortcuts. These keyboard shortcuts take effect only when foobar2000 is the active window.  
There are nine predefined shortcuts in a fresh installation of foobar2000 v0.9.5 and later. All predefined shortcuts are “non-global”, or local, shortcuts. These keyboard shortcuts take effect only when foobar2000 is the active window.  


{| border="0" cellpadding="0" cellspacing="2"
{| class="wikitable" style="text-align: center;"
!width="10"|
! Modifier
!width="60"|modifier
! Key
!width="60"|key
! Type
!width="210"|action/menu-command
! style="text-align: left" | Action
!width="10"|
|-  
 
| {{key press|Ctrl}}
|-
| {{key press|P}}
|-
| [main]
|   ||   Ctrl    || F  || Edit/Search    || 
| style="text-align: left" | File / Preferences
|-
|-
|   ||   Ctrl    || || File/New Playlist      || 
| {{key press|Ctrl}}
| {{key press|F}}
| [main]
| style="text-align: left" | Edit / Search
|-
|-
|   ||   Ctrl    || || File/Open...  || 
| {{key press|Alt}}
| {{key press|A}}
| [main]
| style="text-align: left" | View / Always on Top
|-
|-
|   ||   Ctrl    || || File/Preferences  ||
| {{key press|Ctrl}}
| {{key press|N}}
| [main]
| style="text-align: left" | File / New playlist
|-
|-
|   ||   Ctrl    || || File/Save Playlist...  ||
| {{key press|Ctrl}}
| {{key press|W}}
| [main]
| style="text-align: left" | File / Remove playlist
|-
|-
|   ||   Ctrl    || || File/Add Location... || 
| {{key press|Ctrl}}
| {{key press|O}}
| [main]
| style="text-align: left" | File / Open...
|-
|-
|   ||   Ctrl    || || File/Remove Playlist  || 
| {{key press|Ctrl}}
| {{key press|S}}
| [main]
| style="text-align: left" | File / Save playlist...
|-
|-
|   ||   Alt    || Enter ||  [Context]/Properties  ||
| {{key press|Ctrl}}
| {{key press|U}}
| [main]
| style="text-align: left" | File / Add location...
|-
|-
|   ||    Alt   || || View/Always on Top  |
| {{key press|Alt}}
 
| {{key press|Enter}}
| [context]
| style="text-align: left" | Properties
|}
|}


== Effect of additional plugins ==
== Effect of additional plugins ==


Installing additional components to Foobar2000 does not affect existing keyboard shortcuts. A component will not add new keyboard shortcuts, nor will it modify existing shortcuts. However, new components often add menu items to the menu structure. You are allowed to assign keyboard shortcuts to new commands effected by additional plugins.
Installing additional components to foobar2000 does not affect existing keyboard shortcuts. A component will not add new keyboard shortcuts, nor will it modify existing shortcuts. However, new components often add menu items to the menu structure. You are allowed to assign keyboard shortcuts to new commands effected by additional plugins.


In the event a plugin is later removed, and its commands had been assigned to shortcuts, errors would be noted in corresponding entries in the keyboard shortcuts preferences pane (i.e. top portion).
In the event a plugin is later removed, and its commands had been assigned to shortcuts, errors would be noted in corresponding entries in the keyboard shortcuts preferences pane (i.e. top portion).
Line 78: Line 107:
== Removing existing keyboard shortcuts ==
== Removing existing keyboard shortcuts ==


Any and all keyboard shortcuts may be removed. This includes shortcuts present in the Foobar2000 installation.
Any and all keyboard shortcuts may be removed. This includes shortcuts present in the foobar2000 installation.


Should you remove a desired shortcut by accident, refer to the above table and redefine it. Alternatively, you might reset all shortcuts to their original state by clicking the “Reset Page” button.
Should you remove a desired shortcut by accident, refer to the above table and redefine it. Alternatively, you might reset all shortcuts to their original state by clicking the “Reset Page” button.


It is recommended that you do NOT delete (or redefine) the Ctrl+P shortcut. In the event that you had disabled part of your interface, such as hiding the menu bar, you would want to open the preferences panel using Ctrl+P and restore the interface.
It is recommended that you do NOT delete (or redefine) the {{key press|Ctrl|P}} shortcut. In the event that you had disabled part of your interface, such as hiding the menu bar, you would want to open the preferences panel using {{key press|Ctrl|P}} and restore the interface.


== Defining new keyboard shortcuts ==
== Defining new keyboard shortcuts ==


== Multimedia keys ==
=== Multimedia keys ===
 
# Close other software that reacts to multimedia key (for example [[Winamp]])
# Make sure that LibreOffice is not in focus - see [https://bugs.freedesktop.org/show_bug.cgi?id=32664 LibreOffice bug number 32664]).


''Note: This portion of the wiki page applies to a particular combination of hardware (keyboard w/ media keys) and software (IntelliType Pro keyboard driver). The instructions in this section may be useful, if not specifically applicable, to your installation.''
''Note: Set of instruction below applies to a particular combination of hardware (keyboard w/ media keys) and software (IntelliType Pro keyboard driver). The instructions in this section may be useful, if not specifically applicable, to your installation.''


You may wish to redefine your dedicated multimedia keys (stop, play, etc...) to control foobar2000 functions instead of Windows Media Player. Here is one scenario where this was accomplished with a bit of effort.
You may wish to redefine your dedicated multimedia keys (stop, play, etc...) to control foobar2000 functions instead of Windows Media Player. Here is one scenario where this was accomplished with a bit of effort.
Line 96: Line 128:
#Click “Add New” to define a new keyboard shortcut. Next, click in the “Key” field at the bottom of the panel. Press the dedicated media key labeled with the stop icon.
#Click “Add New” to define a new keyboard shortcut. Next, click in the “Key” field at the bottom of the panel. Press the dedicated media key labeled with the stop icon.
# '''Problem:''' nothing appears in the “Key” field when we press the '''Stop''' key. It appears as though foobar2000 cannot see that a key has been pressed—<u>false</u>: ''it can.'' '''Solution:''' Terminate the keyboard driver process using Windows Task Manager. This is brutish, but effective. There are other ways to terminate the process such as disabling the driver from loading when you logon to Windows.
# '''Problem:''' nothing appears in the “Key” field when we press the '''Stop''' key. It appears as though foobar2000 cannot see that a key has been pressed—<u>false</u>: ''it can.'' '''Solution:''' Terminate the keyboard driver process using Windows Task Manager. This is brutish, but effective. There are other ways to terminate the process such as disabling the driver from loading when you logon to Windows.
# Once type32.exe is no longer active, foobar200 can record the media key keypress. Set up new keyboard shortcuts for '''Stop''' and '''Play.''' Make these keyboard shortcuts global if you wish.
# Once type32.exe is no longer active, foobar2000 can record the media key keypress. Set up new keyboard shortcuts for '''Stop''' and '''Play.''' Make these keyboard shortcuts global if you wish.
# Now, logoff from Windows, and login again. This reloads the IntelliType Pro keyboard driver. Start foobar200 and begin playing an audio track. Minimize the foobar2000 window and make a different application active. Test your '''Stop''' and '''Play''' media keys. If they work—and Windows Media Player does not intrude upon your application—you have successfully reoriented your dedicated media keys to work with foobar2000 instead of WMP.
# Now, logoff from Windows, and login again. This reloads the IntelliType Pro keyboard driver. Start foobar200 and begin playing an audio track. Minimize the foobar2000 window and make a different application active. Test your '''Stop''' and '''Play''' media keys. If they work—and Windows Media Player does not intrude upon your application—you have successfully reoriented your dedicated media keys to work with foobar2000 instead of WMP.


Line 102: Line 134:


# Remove the keyboard shortcut definition for the play key from your foobar2000 preferences. Definitions for the other media keys are left alone.
# Remove the keyboard shortcut definition for the play key from your foobar2000 preferences. Definitions for the other media keys are left alone.
# Assign a command line sequence to the Play media key using the IntelliType Pro software. The command line is: <tt>C:\program&nbsp;files\foobar2000\foobar2000.exe&nbsp;/playpause</tt>
# Assign a command line sequence to the Play media key using the IntelliType Pro software. The command line is:
:: 32-bit Windows: {{code|C:\Program Files\foobar2000\foobar2000.exe /playpause}}
:: 64-bit Windows: {{code|C:\Program Files (x86)\foobar2000\foobar2000.exe /playpause}}


== Avoiding conflicts ==
=== Avoiding conflicts ===


foobar2000 does not prevent you from assigning a the same keyboard shortcut more than once. This is the intended design decision because it doesn't unnecessarily encumber you while redefining shortcuts. When a redundant definition occurs within foobar2000, you will see a warning below the list of definitions. Correcting this error is straightforward—scan through the list of assignments and delete the obsolete shortcut definition. The warning should disappear after internal conflicts have been eliminated.
foobar2000 does not prevent you from assigning the same keyboard shortcut more than once. This is the intended design decision because it doesn't unnecessarily encumber you while redefining shortcuts. When a redundant definition occurs within foobar2000, you will see a warning below the list of definitions. Correcting this error is straightforward—scan through the list of assignments and delete the obsolete shortcut definition. The warning should disappear after internal conflicts have been eliminated.


It is possible that a Windows shortcut (or other feature) may interfere with your intended foobar2000 keyboard shortcuts. Troubleshooting this problem is beyond the scope of this wiki.
It is possible that a Windows shortcut (or other feature) may interfere with your intended foobar2000 keyboard shortcuts. Troubleshooting this problem is beyond the scope of this wiki.


Familiarize yourself with Windows shortcut properties, as well as the particulars of your keyboard driver (such as Microsoft's '''IntelliType''' keyboard software. With this knowledge, you should be able to diagnose keyboard assignment conflicts. These conflicts are likely to stem from media key assignments. It is often possible to disable Windows' usage of media keys altogether—'''IntelliType''' permits this, for example. This allows foobar2000 to make exclusive use of the key.
Familiarize yourself with Windows shortcut properties, as well as the particulars of your keyboard driver (such as Microsoft's '''IntelliType''' keyboard software. With this knowledge, you should be able to diagnose keyboard assignment conflicts. These conflicts are likely to stem from media key assignments. It is often possible to disable Windows' usage of media keys altogether—'''IntelliType''' permits this, for example. This allows foobar2000 to make exclusive use of the key.

Latest revision as of 06:11, 21 October 2018

Foobar2000_Logo.png foobar2000
Preferences
Screenshot of the Keyboard Shortcuts page
Screenshot of the Keyboard Shortcuts page

Deprecated pages


Pages marked * are added via third-party components.

This is the Keyboard Shortcuts page. It contains information for configuring foobar2000 keyboard shortcuts.

Concepts

Keyboard shortcuts are associated with menu commands. Menu commands may include the main menu bar, context menus, and sub-menus. Several dozen keyboard shortcuts are predefined upon installation of foobar2000. Many of these shortcuts are familiar: Ctrl+S for “save”, Ctrl+P for “preferences”, et cetera. It is helpful to review predefined keyboard shortcuts by examining the preferences panel.

Keyboard shortcuts can be defined for unmodified keys, such as Z for “stop”, or for modified keys such as Ctrl+N for “New Playlist.” Possible modifiers are Ctrl, ⇧ Shift, Alt, and ⊞ Win.

Keyboard shortcuts have the possibility of being defined as “global”. A global keyboard shortcut takes action even when foobar2000 is running in the background. If foobar2000 is running, global keyboard shortcuts will control it. Users having keyboards equipped with dedicated multi-media keys may wish to assign global keyboard shortcuts to these keys.

There are no global keyboard shortcuts among the predefined keys. One can easily assign global status to one or more of these keys. Good candidates for global assignment are the volume-controling keys: Num + and Num −. Global assignments should be made carefully as they may interfere with your ability to use other applications.

Keyboard Shortcut definition procedure

  • 1: in “Assigned Shortcuts” portion: select (highlight) current shortcut or add new shortcut
  • 2: in “Action” portion: select (highlight) menu “Action”
  • 3: in “Key” portion: select (highlight) keystroke field, press keystroke combination.
  • 4: optionally enable "global hotkey"
  • 5: press "Apply"

Keyboard Shortcut preferences panel

Predefined shortcut definition for Z.
Predefined shortcut definition for Z.

The keyboard shortcut preferences panel is where keyboard shortcuts are added, modified, deleted, or simply inspected.

A related option appears on the "Display" preferences panel. A (normally-checked) box specifies whether shortcuts should be displayed in menus. You may wish to uncheck this to prevent menus from becoming unmanageably wide.

Assigned shortcuts

The top portion of the keyboard shortcut preferences displays a list of existing shortcuts. The list may be sorted by clicking one of headers.

Action

This middle portion of the preference panel shows the menu commands available for assignment. This portion of the panel may be ignored if you are simply reviewing keyboard shortcuts already defined.

Finding menu commands containing “stop”.

A filter is available to speed the task of assigning new com­mands. This filter reduces the number of items displayed in the com­mands list, assuming the user enters part of the com­mand name he is looking for. Otherwise, the filter has no effect on foobar2000's operation. Be sure to remove stray char­acters that might be entered in this filter—otherwise you may not be able to see the command you're after!

Key

The final portion of the keyboard shortcuts preferences panel shows the keystroke assigned to a given action. To assign a different keystroke, click in the field and press the new keystroke.

Predefined keyboard shortcuts

There are nine predefined shortcuts in a fresh installation of foobar2000 v0.9.5 and later. All predefined shortcuts are “non-global”, or local, shortcuts. These keyboard shortcuts take effect only when foobar2000 is the active window.

Modifier Key Type Action
Ctrl P [main] File / Preferences
Ctrl F [main] Edit / Search
Alt A [main] View / Always on Top
Ctrl N [main] File / New playlist
Ctrl W [main] File / Remove playlist
Ctrl O [main] File / Open...
Ctrl S [main] File / Save playlist...
Ctrl U [main] File / Add location...
Alt ↵ Enter [context] Properties

Effect of additional plugins

Installing additional components to foobar2000 does not affect existing keyboard shortcuts. A component will not add new keyboard shortcuts, nor will it modify existing shortcuts. However, new components often add menu items to the menu structure. You are allowed to assign keyboard shortcuts to new commands effected by additional plugins.

In the event a plugin is later removed, and its commands had been assigned to shortcuts, errors would be noted in corresponding entries in the keyboard shortcuts preferences pane (i.e. top portion).

Removing existing keyboard shortcuts

Any and all keyboard shortcuts may be removed. This includes shortcuts present in the foobar2000 installation.

Should you remove a desired shortcut by accident, refer to the above table and redefine it. Alternatively, you might reset all shortcuts to their original state by clicking the “Reset Page” button.

It is recommended that you do NOT delete (or redefine) the Ctrl+P shortcut. In the event that you had disabled part of your interface, such as hiding the menu bar, you would want to open the preferences panel using Ctrl+P and restore the interface.

Defining new keyboard shortcuts

Multimedia keys

  1. Close other software that reacts to multimedia key (for example Winamp)
  2. Make sure that LibreOffice is not in focus - see LibreOffice bug number 32664).

Note: Set of instruction below applies to a particular combination of hardware (keyboard w/ media keys) and software (IntelliType Pro keyboard driver). The instructions in this section may be useful, if not specifically applicable, to your installation.

You may wish to redefine your dedicated multimedia keys (stop, play, etc...) to control foobar2000 functions instead of Windows Media Player. Here is one scenario where this was accomplished with a bit of effort.

  1. Problem: Pressing the “Play” media key starts Windows Media Player. Solution: Disable the Play key using the keyboard control panel in Windows. Go ahead and disable the normal functions for other dedicated media keys as well.
  2. Next, we assign media key keyboard shortcuts in foobar2000. We start by defining two shortcuts: Stop and Play. Open foobar2000 and call up the keyboard shortcuts preferences panel.
  3. Click “Add New” to define a new keyboard shortcut. Next, click in the “Key” field at the bottom of the panel. Press the dedicated media key labeled with the stop icon.
  4. Problem: nothing appears in the “Key” field when we press the Stop key. It appears as though foobar2000 cannot see that a key has been pressed—false: it can. Solution: Terminate the keyboard driver process using Windows Task Manager. This is brutish, but effective. There are other ways to terminate the process such as disabling the driver from loading when you logon to Windows.
  5. Once type32.exe is no longer active, foobar2000 can record the media key keypress. Set up new keyboard shortcuts for Stop and Play. Make these keyboard shortcuts global if you wish.
  6. Now, logoff from Windows, and login again. This reloads the IntelliType Pro keyboard driver. Start foobar200 and begin playing an audio track. Minimize the foobar2000 window and make a different application active. Test your Stop and Play media keys. If they work—and Windows Media Player does not intrude upon your application—you have successfully reoriented your dedicated media keys to work with foobar2000 instead of WMP.

Having a different combination of hardware and software, you may be able to adapt the steps to empower your media keys. A further enhancement to the process allows you to launch foobar2000 by pressing your Play media key:

  1. Remove the keyboard shortcut definition for the play key from your foobar2000 preferences. Definitions for the other media keys are left alone.
  2. Assign a command line sequence to the Play media key using the IntelliType Pro software. The command line is:
32-bit Windows: C:\Program Files\foobar2000\foobar2000.exe /playpause
64-bit Windows: C:\Program Files (x86)\foobar2000\foobar2000.exe /playpause

Avoiding conflicts

foobar2000 does not prevent you from assigning the same keyboard shortcut more than once. This is the intended design decision because it doesn't unnecessarily encumber you while redefining shortcuts. When a redundant definition occurs within foobar2000, you will see a warning below the list of definitions. Correcting this error is straightforward—scan through the list of assignments and delete the obsolete shortcut definition. The warning should disappear after internal conflicts have been eliminated.

It is possible that a Windows shortcut (or other feature) may interfere with your intended foobar2000 keyboard shortcuts. Troubleshooting this problem is beyond the scope of this wiki.

Familiarize yourself with Windows shortcut properties, as well as the particulars of your keyboard driver (such as Microsoft's IntelliType keyboard software. With this knowledge, you should be able to diagnose keyboard assignment conflicts. These conflicts are likely to stem from media key assignments. It is often possible to disable Windows' usage of media keys altogether—IntelliType permits this, for example. This allows foobar2000 to make exclusive use of the key.