# Command reference

The shortcut key combinations shown in this chapter are the default ones. They can of course be changed.

## Menu bar

Note that many menu entries are only enabled when they are applicable to the file currently loaded in &kplayer;. For example, the items on the View menu will be disabled when playing audio only files.

### File menu

&Ctrl;O Open...

  Displays the standard Open File dialog and lets you choose a file or several files to put on the playlist and start playing.

&Ctrl;U Open URL...

  Displays the standard Open URL dialog and lets you type or paste in a URL to put on the playlist and start playing. The URL can be a remote network location, a local file path, a &kde; I/O Slave URL or a special URL for playing from various types of devices like DVD, video CD, audio CD, TV or DVB.

Open Recent

  Displays a submenu listing the most recently opened files and URLs and lets you choose one to put on the playlist and start playing.

&Ctrl;S Load Subtitles...

  Displays the standard Open File dialog and lets you choose a subtitle file to use with the current file or URL. If you load subtitles when video is playing, &kplayer; will restart playback with the subtitles. By default it will also remember the subtitles you choose in the current file properties. This command is available for video files.

Load Subtitle URL...

  Displays the standard Open URL dialog and lets you type or paste in a subtitle URL to use with the current file or URL. If you load subtitles when video is playing, &kplayer; will restart playback with the subtitles. By default it will also remember the subtitles you choose in the current file properties. This command is available for video files.

Unload Subtitles

  Unloads the currently loaded subtitles, and if video is playing, restarts playback without subtitles. This command is available when subtitles are loaded.

Clear Log

  Removes all messages from the message log.

&Alt;&Enter; Properties...

  Opens the File Properties dialog that lets you choose many options specific to the currently loaded file. See the File properties micro-HOWTO for details.

&Ctrl;Q Quit

  Saves the playlist and all settings, stops playing and closes &kplayer;.

### View menu

Commands on this menu are only available for video files.

&Ctrl;F Full Screen

  Switches to full screen video display and back to normal mode. Double clicking the video area also switches between full screen and normal window size.

&Ctrl;+ Zoom In

  Enlarges the video area by one half of the original video size of the current file.

&Ctrl;- Zoom Out

  Reduces the video area by one half of the original video size of the current file.

Zoom to 50&percnt;

  Resizes the video area to one half of the original video size of the current file.

&Ctrl;&Backspace; Zoom to 100&percnt;

  Resizes the video area to the original video size of the current file.

Zoom to 150&percnt;

  Resizes the video area to 150&percnt; of the original video size of the current file.

Zoom to 200&percnt;

  Resizes the video area to twice the original video size of the current file.

Zoom to 250&percnt;

  Resizes the video area to 250&percnt; of the original video size of the current file.

Zoom to 300&percnt;

  Resizes the video area to thrice the original video size of the current file.

Maintain Original Aspect

  Toggles the option to maintain the original video aspect ratio of the current file.

Maintain Current Aspect

  Toggles the option to maintain the current video aspect ratio.

Force 4 to 3 Aspect

  Toggles the option to maintain four to three video aspect ratio.

Force 16 to 9 Aspect

  Toggles the option to maintain sixteen to nine video aspect ratio.

### Player menu

&Enter; Play

  Starts playback of the current file. If the player has been paused, this command resumes playback. This command is available when a file is loaded.

Space Pause

  Pauses or resumes playback of the current file. This command is available when the player is not idle.

&Esc; Stop

  Stops playback of the current file. This command is available when the player is not idle.

Right Arrow Forward

  Moves playback forward by one percent of the time length of the current file. This command is available when playing a file.

&Ctrl;Right Arrow Fast Forward

  Moves playback forward by ten percent of the time length of the current file. This command is available when playing a file.

Left Arrow Backward

  Moves playback backward by one percent of the time length of the current file. This command is available when playing a file.

&Ctrl;Left Arrow Fast Backward

  Moves playback backward by ten percent of the time length of the current file. This command is available when playing a file.

&Ctrl;Home Back to Start

  Moves playback to the beginning of the current file. This command is available when playing a file.

Soft Frame Dropping

  Toggles the soft frame dropping option. If your system is too slow to play a file, &mplayer; can drop some frames so playback does not slow down. The soft option drops frames less agressively than the hard one, and should not cause playback problems. The Frame drop option can also be set on the Advanced page either globally in &kplayer; Settings or for a particular file in the File Properties.

Hard Frame Dropping

  Toggles the hard frame dropping option. If your system is too slow to play a file, &mplayer; can drop some frames so playback does not slow down. The hard option drops frames more agressively than the soft one, and may sometimes break decoding. The Frame drop option can also be set on the Advanced page either globally in &kplayer; Settings or for a particular file in the File Properties.

#### Audio submenu

Down Arrow Decrease Volume

  Decreases the sound volume.

Up Arrow Increase Volume

  Increases the sound volume.

&Ctrl;\ Mute

  Turns the sound on or off.

&Ctrl;] Decrease Delay

  Decreases the delay of sound relative to video.

&Ctrl;[ Increase Delay

  Increases the delay of sound relative to video.

#### Video submenu

This menu is only available for video files.

&Ctrl;1 Decrease Contrast

  Decreases the video contrast.

&Ctrl;2 Increase Contrast

  Increases the video contrast.

&Ctrl;3 Decrease Brightness

  Decreases the video brightness.

&Ctrl;4 Increase Brightness

  Increases the video brightness.

&Ctrl;5 Decrease Hue

  Decreases the video hue.

&Ctrl;6 Increase Hue

  Increases the video hue.

&Ctrl;7 Decrease Saturation

  Decreases the video saturation.

&Ctrl;8 Increase Saturation

  Increases the video saturation.

#### Subtitles submenu

This menu is only available when subtitles are loaded.

Show

  Shows or hides the subtitles.

&Ctrl;, Move Down

  Moves the subtitles down.

&Ctrl;. Move Up

  Moves the subtitles up.

&Ctrl;' Decrease Delay

  Decreases the delay of subtitles relative to video.

&Ctrl;; Increase Delay

  Increases the delay of subtitles relative to video.

### Playlist menu

For a detailed description of the playlist feature see the Playlist micro-HOWTO.

&Ctrl;P Show Playlist

  Shows or hides the playlist toolbar.

&Ctrl;E Show Editor

  Shows or hides the playlist editor.

Show Toolbar

  Shows or hides the playlist editor toolbar.

&Alt;Right Arrow Next

  Starts playing the next item on the current playlist.

&Alt;Left Arrow Previous

  Starts playing the previous item on the current playlist.

Loop

  Toggles the option to start playing items from the beginning of the playlist after playing the last item on the playlist.

Shuffle

  Toggles the option to play playlist items in a random order.

Temporary List For New Entries

  Toggles the option to use a temporary playlist when adding new entries. When enabled, this option locks the main playlist, so when you load new items using File Open or File Open URL commands, by dragging and dropping files onto &kplayer; window, or by starting &kplayer; with file arguments, it creates a temporary playlist, puts the new items on it and starts playing them. To start playing items from the main playlist again, choose Playlist Play From Playlist.

Play Selection Only

  Toggles the option to only play items selected in the playlist editor.

Clear Before Adding Entries

  Toggles the option to clear the current playlist before adding new items to it. The current playlist can be either the main playlist or the temporary playlist when the Temporary List For New Entries option is enabled.

Play From Playlist

  Starts playing items from the main playlist. This command is only available when a temporary playlist is being used that has been created because the Temporary List For New Entries option had been enabled.

F2 Rename

  Starts edit mode for the current item in the playlist editor so you can change the item name. This command is available when playlist editor is shown and is not empty.

Properties...

  Opens File Properties dialog for the current item in the playlist editor. See the File properties micro-HOWTO for details. This command is available when playlist editor is shown and is not empty.

Move Up

  Moves the currently selected items up in the playlist editor. This command is available when playlist editor is shown and some items are selected.

Move Down

  Moves the currently selected items down in the playlist editor. This command is available when playlist editor is shown and some items are selected.

  You can also move items around by clicking and dragging them with the &LMB;.

Remove

  Removes from the main playlist items currently selected in the playlist editor. This command is available when playlist editor is shown and some items are selected.

Clear

  Removes all items from the main playlist in the playlist editor. This command is available when playlist editor is shown and is not empty.

### Settings menu

&Ctrl;M Show Menubar

  Shows or hides the menu bar.

Show Statusbar

  Shows or hides the status bar.

&Ctrl;L Show Message Log

  Shows or hides the message log.

Show Main Toolbar

  Shows or hides the main toolbar.

Show Progress Toolbar

  Shows or hides the progress toolbar. This command is available when the time length of the current file is known.

Show Volume Toolbar

  Shows or hides the volume toolbar.

Show Contrast Toolbar

  Shows or hides the contrast toolbar. This command is available for video files.

Show Brightness Toolbar

  Shows or hides the brightness toolbar. This command is available for video files.

Show Hue Toolbar

  Shows or hides the hue toolbar. This command is available for video files.

Show Saturation Toolbar

  Shows or hides the saturation toolbar. This command is available for video files.

Configure Shortcuts...

  Opens a dialog that lets you see and change &kplayer;'s shortcut key bindings, or associations between actions and the corresponding keys or combinations of keys that activate them. If you change the bindings, make sure not to duplicate an existing shortcut and also not to use the &Shift; key for your new shortcuts, because the &Shift; key has a special function in &kplayer;.

Configure &kplayer;...

  Opens a dialog that lets you configure the program, modifying various aspects of its functionality, user interface and interaction with &mplayer;. For more information see the Configuration dialog chapter and the Advanced configuration micro-HOWTO in this manual.

### Help menu

&kplayer; Handbook

  Opens and displays the &kplayer; user manual.

What's This...

  Changes the mouse pointer to a question mark and lets you click a &kplayer; interface element to get a quick description of its purpose and functionality.

Report Bug...

  Opens a dialog that allows you to send a bug report to the &kplayer; developer. However, the recommended way to report a bug is to collect information using this dialog and then submit it following the instructions in the Bug reporting micro-HOWTO.

About &kplayer;...

  Displays some brief information about &kplayer;'s version number, authors and license agreement.

About &kde;...

  Shows some information about the version of &kde; that you are running.

## Toolbars

### Main toolbar

The main toolbar contains the most useful &kplayer; commands and options.

- Open and Open URL buttons invoke the corresponding actions from the File menu that display dialog boxes allowing you to open and play local files or remote URLs.

- Properties button corresponds to the command on the File menu that will open the File Properties dialog for the current file.

- Play, Pause and Stop buttons correspond to the commands on the Player menu and will respectively start, pause and stop playback of the current file.

- Zoom In and Zoom Out buttons invoke the commands on the View menu that respectively enlarge and reduce the video area by one half of the original video size of the current file.

- Maintain Aspect button corresponds to the command on the general popup menu that will toggle the option to maintain the video aspect ratio.

- Full Screen button invokes the command on the View menu that switches to the full screen mode and back the to normal mode.

- Volume, Contrast, Brightness, Hue and Saturation buttons display popup sliders allowing you to adjust those settings. If you want the slider to stay visible instead of disappearing when it loses the input focus, use the slider toolbars instead. As usual, if you hold the &Shift; key down, the changes you make to the settings will be applied only to the current file and stored in its properties.

### Playlist toolbar

The playlist toolbar contains the current playlist and the most frequently used playlist commands and options.

- The playlist combo box in the closed state displays the current playlist item. You can drop down the combo box to see the entire list and select a different item to load and play.

- Next and Previous buttons correspond to the commands on the Playlist menu and will select the next or previous item on the playlist and start playing it.

- Loop button is the same as the corresponding command on the Playlist menu that toggles the option to continue playing from the top of the current playlist after playing the last item.

- Shuffle button is also the same as the corresponding command on the Playlist menu and will toggle the option to play items in random order.

### Progress and seeking toolbar

The progress and seeking toolbar is available when &kplayer; knows the time length of the current file. It shows the current playback progress and lets you seek, which is to say, move the playback position forward or backward.

- The progress slider reflects the current playback position relative to the total time length of the current file, and also lets you seek or change the current position. To seek forward and backward by the distance between the tick marks on the slider, left click to the right or left of the slider thumb. To seek to a specific point, middle click that point, or left click and drag the slider thumb to that point. If your mouse has a wheel, you can roll it up (away from you) to seek forward or down (towards you) to seek backward when the mouse pointer is over the slider. If you hold down the &Ctrl; key on the keyboard when rolling the wheel, seeking will be faster.

- Fast Forward and Fast Backward buttons corresponds to the commands on the Player menu that seek forward or backward by the amount which by default is the same as the distance between slider marks. However, internally they use different seeking technique (relative as opposed to absolute), and so sometimes may give different results than left clicking the slider.

### Volume toolbar

The volume toolbar allows you to control the sound volume.

- The volume slider allows you to change the sound volume. If you hold the &Shift; key down, the setting will be applied only to the current file and stored in its properties. If you want the slider to always disappear after you have changed the volume, hide this toolbar and use the popup slider on the main toolbar instead.

- Show Volume Toolbar button corresponds to the command on the Settings menu and will hide the toolbar when clicked.

- Mute button turns the sound off and back on, without changing the normal sound volume. It is the same as the command on the Audio submenu of the Player menu.

### Contrast toolbar

The contrast toolbar allows you to control the video contrast.

- The contrast slider allows you to change the video contrast. If you hold the &Shift; key down, the setting will be applied only to the current file and stored in its properties. If you want the slider to always disappear after you have changed the contrast, hide this toolbar and use the popup slider on the main toolbar instead.

- Show Contrast Toolbar button corresponds to the command on the Settings menu and will hide the toolbar when clicked.

### Brightness toolbar

The brightness toolbar allows you to control the video brightness.

- The brightness slider allows you to change the video brightness. If you hold the &Shift; key down, the setting will be applied only to the current file and stored in its properties. If you want the slider to always disappear after you have changed the brightness, hide this toolbar and use the popup slider on the main toolbar instead.

- Show Brightness Toolbar button corresponds to the command on the Settings menu and will hide the toolbar when clicked.

### Hue toolbar

The hue toolbar allows you to control the video hue.

- The hue slider allows you to change the video hue. If you hold the &Shift; key down, the setting will be applied only to the current file and stored in its properties. If you want the slider to always disappear after you have changed the hue, hide this toolbar and use the popup slider on the main toolbar instead.

- Show Hue Toolbar button corresponds to the command on the Settings menu and will hide the toolbar when clicked.

### Saturation toolbar

The saturation toolbar allows you to control the video saturation.

- The saturation slider allows you to change the video saturation. If you hold the &Shift; key down, the setting will be applied only to the current file and stored in its properties. If you want the slider to always disappear after you have changed the saturation, hide this toolbar and use the popup slider on the main toolbar instead.

- Show Saturation Toolbar button corresponds to the command on the Settings menu and will hide the toolbar when clicked.

### Playlist editor toolbar

Playlist editor has its own toolbar that contains a few commands and an option that affect the editor and are also available on the Playlist menu.

- Temporary List For New Entries button toggles the option to use a temporary playlist when adding new entries. When enabled, this option locks the main playlist, so when you load new items using File Open or File Open URL commands, by dragging and dropping files onto &kplayer; window, or by starting &kplayer; with file arguments, it creates a temporary playlist, puts the new items on it and starts playing them. To start playing items from the main playlist again, choose Playlist Play From Playlist.

- Move Up and Move Down buttons move the items currently selected in the playlist editor. You can also move the items around by clicking and dragging them with the &LMB;.

- Remove button removes the currently selected items from the playlist editor.

- Clear button removes all items from the playlist editor.

## Popup menus

Like any half decent &kde; program, &kplayer; sports popup menus that you can get by right clicking different parts of it.

### General popup menu

When you right click the video area, the menu bar or the status bar, you get the general popup menu that includes the most frequently used &kplayer; commands and options.

- Open and Open URL commands invoke the corresponding actions from the File menu that display dialog boxes allowing you to open and play local files or remote URLs.

- Properties command corresponds to the command on the File menu that will open the File Properties dialog for the current file.

- Play, Pause and Stop commands correspond to the actions on the Player menu and will respectively start, pause and stop playback of the current file.

- Maintain Aspect command toggles the option to maintain the video aspect ratio.

- Full Screen command invokes the action on the View menu that switches to the full screen mode and back to the normal mode.

- The commands on the Settings submenu are the same as the commands on the Settings menu and will show or hide the menu bar, status bar, message log, playlist toolbar, playlist editor, main toolbar, progress and seeking toolbar and volume toolbar.

### Playlist popup menu

When you right click an item on the playlist, &kplayer; displays a menu that lists commands applicable to the playlist item or to the currently selected items, as well as some playlist options.

- Play command loads and plays the item you right clicked.

- Rename command starts edit mode for the item you right clicked so you can change its name.

- Properties... command opens the File Properties dialog for the item you right clicked. See the File properties micro-HOWTO for details.

- Temporary List For New Entries command toggles the option to use a temporary playlist when adding new entries. When enabled, this option locks the main playlist, so when you load new items using File Open or File Open URL commands, by dragging and dropping files onto &kplayer; window, or by starting &kplayer; with file arguments, it creates a temporary playlist, puts the new items on it and starts playing them. To start playing items from the main playlist again, choose Playlist Play From Playlist.

- Play Selection Only command toggles the option to only play items selected in the playlist editor.

- Move Up and Move Down commands move the items currently selected in the playlist editor. You can also move the items around by clicking and dragging them with the &LMB;.

- Remove command removes the currently selected items from the playlist editor.

- Clear command removes all items from the playlist editor.

### Message log popup menu

When you right click the message log, &kplayer; displays a menu that lists commands applicable to the message log.

- Select All command selects all the text in the message log.

- Copy command copies the selected message log text to the clipboard.

### Toolbar popup menu

When you right click a &kplayer; toolbar, you get a standard &kde; toolbar popup menu. It contains options that allow you to change the toolbar orientation, text position and icon size.

### Title bar popup menu

When you right click the &kplayer; title bar, you get a standard &kde; title bar popup menu. You can also get it by left clicking the little button in the top left corner of &kplayer; window or by pressing &Alt;F3. The menu contains commands that let you maximize, minimize, restore, move and resize the &kplayer; window, as well as a few options, some of which you may find useful. For example, the Keep Above Others option on the Advanced lets you keep the &kplayer; window on top of all other program windows.

## KPart

&kplayer; features a KPart, which is an applet that can be embedded into other programs and used to watch video or play audio. You can configure programs like &konqueror; File Manager and &kmldonkey; to embed the &kplayer;'s KPart and play files with it. &konqueror; Web Browser can also be configured to use the &kplayer; KPart to display multimedia objects embedded in web pages.

You can tell &konqueror; to use &kplayer; for playing multimedia files and URLs by going to the File Associations page either in the &konqueror; configuration dialog or in &kcontrolcenter; and moving &kplayer; to the top of the list of programs for each media type you want &kplayer; to play, both on the Program tab and on the Embedded tab. It is recommended that you choose the option to Open Separate Program, which will give you a whole lot more options and better interface when playing multimedia compared to an embedded KPart. However, when an object is embedded into a web page, &konqueror; has no choice but to use the KPart. In that situation the best thing is to right click the multimedia object and select the Start &kplayer; command described below.

Following is a complete list of user interface elements that &kplayer;'s KPart provides whenever possible. However, when the KPart is embedded into a web page, only the right click popup menu will be available.

### Player menu

This menu contains Play, Pause, Stop, Forward, Fast Forward, Backward, Fast Backward and Back to Start commands from the Player menu of the full &kplayer;, and Decrease Volume, Increase Volume and Mute commands from its Audio submenu, as well as Maintain Aspect command from the general popup menu and Properties command from the File menu found in the full &kplayer;, as well as Start &kplayer; command from the KPart popup menu described below.

### Main toolbar

This toolbar contains Play, Pause, Stop, Maintain Aspect, Volume and Properties buttons which as the same as the ones on the main toolbar in the full &kplayer;.

### Progress toolbar

This toolbar is the same as the Progress toolbar in the full &kplayer;.

### Volume toolbar

This toolbar is the same as the Volume toolbar in the full &kplayer;.

### Popup menu

Right clicking the video area of &kplayer; KPart embedded into another program gives you a popup menu.

The top item on the menu is Start &kplayer; command that will stop playback, open the full &kplayer;, put the multimedia file or URL on the playlist and start playing it. It is always recommended that you choose this command, since it will give you better interface and more options when playing the multimedia.

The popup menu also contains Play, Pause, Stop, Maintain Aspect and Properties commands which as the same as the ones on the general popup menu in the full &kplayer;.

## Mouse wheel

The action of the mouse wheel in &kplayer; depends on where the mouse cursor is positioned.

If the cursor is positioned over a slider, rolling the mouse wheel will change the setting that the slider controls, like playback position, sound volume, video contrast and so on. Rolling the wheel up (away from you) increases the setting, while rolling it down (towards you) decreases it. You can hold down the &Ctrl; key on the keyboard when rolling the wheel to change the setting faster.

Rolling the wheel when the mouse pointer is positioned over a window that has a scroll bar, like the playlist editor or the message log, will scroll the window up or down. Rolling the wheel over the playlist combo box will likewise scroll it up or down, switch to a different entry and start playing it.

When the mouse pointer is in the video area, rolling the wheel up (away from you) will zoom in, that is, enlarge the video area, and rolling the wheel down (towards you) will zoom out, or reduce the video area. However, if &kplayer; cannot resize the video area, for example when the window is full screen or maximized, it will instead seek, or move the playback point, forward when rolling the wheel up (away from you) or backward when rolling it down (towards you). In that case you can also hold down the &Ctrl; key on the keyboard to seek faster.