12.120 emacspeak-m-player

Defines an Emacspeak front-end for interacting with mplayer. Program mplayer is a versatile media player capable of playing many streaming media formats. This module provides complete access to all mplayer functionality from a convenient Emacs interface.

12.120.1 Usage

The main entry-point is command emacspeak-multimedia bound to C-e ;. This prompts for and launches the desired media stream. Once a stream is playing, you can control it with single-letter keystrokes in the *M-Player* buffer. Alternatively, you can switch away from that buffer to do real work, And invoke m-player commands by first pressing prefix-key C-e ;. If your Emacs supports repeat-mode, — See (emacs)repeating you can avoid the need to repeatedly press the prefix-key C-e ; each time; with repeat-mode active, you only need to press the prefix C-e ; the first time; subsequent invocations can happen via single-letter presses as long as they are performed in a sequence. As an example, pressing v in the *M-Player* buffer prompts for and sets the volume; When not in the *M-Player* buffer, you can achieve the same by pressing C-e ; v. Press C-h b in the *M-Player* buffer to list m-player keybindings.

12.120.2 Emacspeak-M-Player Commands

12.120.2.1 emacspeak-m-player

Command: emacspeak-m-player (resource &optional play-list)
Play  resource, or play dynamic playlist if set.  Optional prefix argument
play-list interprets resource as a play-list.  Second interactive
prefix arg adds option -allow-dangerous-playlist-parsing to mplayer.
See command M-x emacspeak-m-player-add-dynamic for adding to the
dynamic playlist. 

(fn RESOURCE &optional PLAY-LIST)

12.120.2.2 emacspeak-m-player-add-autopan

Command: emacspeak-m-player-add-autopan
Add autopan effect.

12.120.2.3 emacspeak-m-player-add-autosat

Command: emacspeak-m-player-add-autosat
Add ZamAutoSat (auto saturation) effect.

12.120.2.4 emacspeak-m-player-add-dynamic

Command: emacspeak-m-player-add-dynamic (file)
Add file to the current  dynamic playlist.

(fn FILE)

12.120.2.5 emacspeak-m-player-add-equalizer

Command: emacspeak-m-player-add-equalizer (&optional reset)
Add equalizer.  Equalizer is updated as each change
is made, and the final effect set by pressing RET.  Interactive prefix
arg ‘reset’ starts with all filters set to 0.

(fn &optional RESET)

12.120.2.6 emacspeak-m-player-add-filter

Command: emacspeak-m-player-add-filter (filter-name &optional edit)
Adds  filter with completion.
 Optional interactive prefix arg ‘edit’ edits the.

(fn FILTER-NAME &optional EDIT)

12.120.2.7 emacspeak-m-player-add-ladspa

Command: emacspeak-m-player-add-ladspa
Apply plugin to running MPlayer.
Copies  invocation string to kill-ring so it can be added easily to
our pre-defined filters if appropriate.

12.120.2.8 emacspeak-m-player-add-loop

Command: emacspeak-m-player-add-loop (&optional prompt)
Add loop 10 is default.

(fn &optional PROMPT)

12.120.2.9 emacspeak-m-player-alt-src-step

Command: emacspeak-m-player-alt-src-step (step)
Move within an ASF playlist.

(fn STEP)

12.120.2.10 emacspeak-m-player-amark-add

Command: emacspeak-m-player-amark-add (name &optional prompt-position)
Set AMark ‘name’ at current position.
Interactive prefix arg prompts for position.
As the default, use current position.

(fn NAME &optional PROMPT-POSITION)

12.120.2.11 emacspeak-m-player-amark-jump

Command: emacspeak-m-player-amark-jump
Jump to AMark.

12.120.2.12 emacspeak-m-player-amark-save

Command: emacspeak-m-player-amark-save
Save amarks.

12.120.2.13 emacspeak-m-player-apply-reverb

Command: emacspeak-m-player-apply-reverb (preset)
Prompt for and apply a reverb preset.
  You need to use mplayer built with ladspa support, and have package
  tap-reverb already installed.

(fn PRESET)

12.120.2.14 emacspeak-m-player-backward-10min

Command: emacspeak-m-player-backward-10min
Move backward ten minutes.

12.120.2.15 emacspeak-m-player-backward-10s

Command: emacspeak-m-player-backward-10s
Move back 10 seconds.

12.120.2.16 emacspeak-m-player-backward-1min

Command: emacspeak-m-player-backward-1min
Move back 1 minute.

12.120.2.17 emacspeak-m-player-balance

Command: emacspeak-m-player-balance
Set left/right balance.

12.120.2.18 emacspeak-m-player-balance-channels

Command: emacspeak-m-player-balance-channels
Mono to stereo.

12.120.2.19 emacspeak-m-player-bind-hotkey

Command: emacspeak-m-player-bind-hotkey (directory key)
Binds key to invoke m-player  on specified directory.

(fn DIRECTORY KEY)

12.120.2.20 emacspeak-m-player-browse-history

Command: emacspeak-m-player-browse-history
Create a  media history browser from media-history.

12.120.2.21 emacspeak-m-player-clear-filters

Command: emacspeak-m-player-clear-filters
Clear all filters

12.120.2.22 emacspeak-m-player-command

Command: emacspeak-m-player-command (key)
Invoke MPlayer commands.

(fn KEY)

12.120.2.23 emacspeak-m-player-customize

Command: emacspeak-m-player-customize
Use Customize to set MPlayer options.

12.120.2.24 emacspeak-m-player-delete-filter

Command: emacspeak-m-player-delete-filter (filter)
Delete filter.

(fn FILTER)

12.120.2.25 emacspeak-m-player-delete-ladspa

Command: emacspeak-m-player-delete-ladspa
Delete plugin from  running MPlayer.

12.120.2.26 emacspeak-m-player-display-percent

Command: emacspeak-m-player-display-percent
Display current percentage.

12.120.2.27 emacspeak-m-player-double-speed

Command: emacspeak-m-player-double-speed
Scale speed by 2.0

12.120.2.28 emacspeak-m-player-edit-reverb

Command: emacspeak-m-player-edit-reverb
Edit ladspa reverb filter.
  You need to use mplayer built with ladspa support, and have package
  tap-reverb already installed.

12.120.2.29 emacspeak-m-player-end-track

Command: emacspeak-m-player-end-track
Move to end.

12.120.2.30 emacspeak-m-player-eq-controls

Command: emacspeak-m-player-eq-controls (v)
Manipulate values in  vector using minibuffer.
Applies  the resulting value at each step.

(fn V)

12.120.2.31 emacspeak-m-player-eq-preset

Command: emacspeak-m-player-eq-preset (name)
Prompts for  and apply equalizer preset.

The following presets are available:

flat classical club dance full-bass full-bass-and-treble
 full-treble headphones large-hall live party pop reggae rock
 ska soft soft-rock techno 

(fn NAME)

12.120.2.32 emacspeak-m-player-faster

Command: emacspeak-m-player-faster
Speed up  playback. 

12.120.2.33 emacspeak-m-player-forward-10min

Command: emacspeak-m-player-forward-10min
Move forward ten minutes.

12.120.2.34 emacspeak-m-player-forward-10s

Command: emacspeak-m-player-forward-10s
Move forward 10 seconds.

12.120.2.35 emacspeak-m-player-forward-1min

Command: emacspeak-m-player-forward-1min
Move forward by 1 minute.

12.120.2.36 emacspeak-m-player-from-history

Command: emacspeak-m-player-from-history (&optional prefix)
C-; h
C-x @ h h
Play media from the front of media-history.
   Interactive prefix arg invokes media history browser.

(fn &optional PREFIX)

12.120.2.37 emacspeak-m-player-get-length

Command: emacspeak-m-player-get-length
Display length of track.

12.120.2.38 emacspeak-m-player-half-speed

Command: emacspeak-m-player-half-speed
Scale speed by 0.5.

12.120.2.39 emacspeak-m-player-left-channel

Command: emacspeak-m-player-left-channel
Play both channels on left.

12.120.2.40 emacspeak-m-player-locate-media

Command: emacspeak-m-player-locate-media (pattern)
C-z l
C-; l
C-e z l
C-x @ h l
Locate media matching  pattern.  The results can be
played as a play-list by pressing [RET] on the first line, see
 M-x emacspeak-dired-open-this-file locally bound to C-RET
to play  tracks.

(fn PATTERN)

12.120.2.41 emacspeak-m-player-loop

Command: emacspeak-m-player-loop (&optional raw)
C-e x :
M-Player with repeat indefinitely  turned on.
Interactive prefix ‘raw’ reads a raw URL.

(fn &optional RAW)

12.120.2.42 emacspeak-m-player-mode

Command: emacspeak-m-player-mode
Major mode for m-player interaction. 

Key             Binding
——————————————————————————-
C-a             emacspeak-amark-browse
C-l             ladspa
SPC             emacspeak-m-player-pause
%               emacspeak-m-player-display-percent
’         emacspeak-m-player-add-loop
(               emacspeak-m-player-left-channel
)               emacspeak-m-player-right-channel
+               emacspeak-m-player-volume-up
,               emacspeak-m-player-backward-10s
-               emacspeak-m-player-volume-down
.               emacspeak-m-player-forward-10s
/               emacspeak-m-player-restore-process
1 .. 9          emacspeak-m-player-volume-set
;               emacspeak-m-player-pop-to-player
<            emacspeak-m-player-backward-1min
=               emacspeak-m-player-volume-up
>            emacspeak-m-player-forward-1min
?               emacspeak-m-player-show-pos
A               emacspeak-m-player-amark-add
C               emacspeak-m-player-clear-filters
E               emacspeak-m-player-add-equalizer
G               emacspeak-m-player-seek-percentage
L               emacspeak-m-player-get-length
M               emacspeak-m-player-show-data
O               emacspeak-m-player-reset-options
P               emacspeak-m-player-apply-reverb
Q               emacspeak-m-player-quit
R               emacspeak-m-player-edit-reverb
S               emacspeak-m-player-amark-save
T               emacspeak-speak-brief-time
[               emacspeak-m-player-slower
\               emacspeak-m-player-persist-process
]               emacspeak-m-player-faster
a               emacspeak-m-player-add-autopan
b               emacspeak-m-player-balance-channels
c               emacspeak-m-player-slave-command
d               emacspeak-m-player-delete-filter
e               emacspeak-m-player-eq-preset
f               emacspeak-m-player-add-filter
g               emacspeak-m-player-seek-absolute
h               emacspeak-m-player-from-history
i               emacspeak-m-player-stream-info
j               emacspeak-m-player-amark-jump
k               emacspeak-m-player-quit
l               emacspeak-m-player-store-link
m               emacspeak-m-player-mode-line
n               emacspeak-m-player-next-track
o               emacspeak-m-player-customize
p               emacspeak-m-player-previous-track
r               emacspeak-m-player-seek-relative
s               emacspeak-m-player-scale-speed
t               emacspeak-m-player-skip-tracks
v               emacspeak-m-player-volume-change
w               emacspeak-m-player-write-clip
x               emacspeak-m-player-pan
z               emacspeak-m-player-add-autosat
{               emacspeak-m-player-half-speed
}               emacspeak-m-player-double-speed
DEL             emacspeak-m-player-reset-speed
<down>            emacspeak-m-player-forward-1min
<end>             emacspeak-m-player-end-track
<home>            emacspeak-m-player-start-track
<left>            emacspeak-m-player-backward-10s
<next>            emacspeak-m-player-forward-10min
<prior>           emacspeak-m-player-backward-10min
<right>           emacspeak-m-player-forward-10s
<up>              emacspeak-m-player-backward-1min

M-,             emacspeak-m-player-set-clip-start
M-.             emacspeak-m-player-set-clip-end

In addition to any hooks its parent mode ‘special-mode’ might have
run, this mode runs the hook ‘emacspeak-m-player-mode-hook’, as the
final or penultimate step during initialization.

12.120.2.43 emacspeak-m-player-mode-line

Command: emacspeak-m-player-mode-line
Mode-line for M-Player buffers.

12.120.2.44 emacspeak-m-player-next-track

Command: emacspeak-m-player-next-track
Next track.

12.120.2.45 emacspeak-m-player-pan

Command: emacspeak-m-player-pan
Pan from left to right   and back  one step at a time.

12.120.2.46 emacspeak-m-player-pause

Command: emacspeak-m-player-pause
Pause or unpause.

12.120.2.47 emacspeak-m-player-persist-process

Command: emacspeak-m-player-persist-process (&optional name)
Persists  m-player process instance by renaming its buffer.
Optional interactive prefix arg prompts for name to use for  player.

(fn &optional NAME)

12.120.2.48 emacspeak-m-player-play-rss

Command: emacspeak-m-player-play-rss (rss-url)
Play an RSS stream.

(fn RSS-URL)

12.120.2.49 emacspeak-m-player-play-tree-up

Command: emacspeak-m-player-play-tree-up (step)
Move within the play tree.

(fn STEP)

12.120.2.50 emacspeak-m-player-pop-to-player

Command: emacspeak-m-player-pop-to-player
Pop to m-player buffer.

12.120.2.51 emacspeak-m-player-previous-track

Command: emacspeak-m-player-previous-track
Previous track.

12.120.2.52 emacspeak-m-player-quit

Command: emacspeak-m-player-quit
Quit.

12.120.2.53 emacspeak-m-player-rem-history

Command: emacspeak-m-player-rem-history (url)
Remove URL from media history

(fn URL)

12.120.2.54 emacspeak-m-player-reset-options

Command: emacspeak-m-player-reset-options
Reset MPlayer options.

12.120.2.55 emacspeak-m-player-reset-speed

Command: emacspeak-m-player-reset-speed
Reset  speed.

12.120.2.56 emacspeak-m-player-restore-process

Command: emacspeak-m-player-restore-process
Restore emacspeak-m-player-process from current buffer.
Check first if current buffer is in emacspeak-m-player-mode.

12.120.2.57 emacspeak-m-player-right-channel

Command: emacspeak-m-player-right-channel
Play on right channel.

12.120.2.58 emacspeak-m-player-scale-speed

Command: emacspeak-m-player-scale-speed (factor)
Scale speed by factor.

(fn FACTOR)

12.120.2.59 emacspeak-m-player-seek-absolute

Command: emacspeak-m-player-seek-absolute (pos)
Seek  to absolute pos in seconds.
The time position can also be specified as HH:MM:SS.

(fn POS)

12.120.2.60 emacspeak-m-player-seek-percentage

Command: emacspeak-m-player-seek-percentage (pos)
Seek  to absolute pos in percent.

(fn POS)

12.120.2.61 emacspeak-m-player-seek-relative

Command: emacspeak-m-player-seek-relative (offset)
Seek  by offset from current position.
Time offset can be specified as a number of seconds, or as HH:MM:SS.

(fn OFFSET)

12.120.2.62 emacspeak-m-player-set-clip-end

Command: emacspeak-m-player-set-clip-end
Set end of clip mark.

12.120.2.63 emacspeak-m-player-set-clip-start

Command: emacspeak-m-player-set-clip-start
Set start of clip. 

12.120.2.64 emacspeak-m-player-show-data

Command: emacspeak-m-player-show-data
Display metadata after refreshing it if needed.

12.120.2.65 emacspeak-m-player-show-pos

Command: emacspeak-m-player-show-pos
Display current position in track.

12.120.2.66 emacspeak-m-player-shuffle

Command: emacspeak-m-player-shuffle
C-e x ;
M-Player with shuffle turned on.

12.120.2.67 emacspeak-m-player-skip-tracks

Command: emacspeak-m-player-skip-tracks (step)
Skip tracks.

(fn STEP)

12.120.2.68 emacspeak-m-player-slave-command

Command: emacspeak-m-player-slave-command (command)
Dispatch slave command.

(fn COMMAND)

12.120.2.69 emacspeak-m-player-slower

Command: emacspeak-m-player-slower
Slow down playback. 

12.120.2.70 emacspeak-m-player-start-track

Command: emacspeak-m-player-start-track
Move to beginning.

12.120.2.72 emacspeak-m-player-stream-info

Command: emacspeak-m-player-stream-info (&optional toggle-cue)
Speak and display metadata.
Interactive prefix arg toggles automatic cueing of ICY info updates.

(fn &optional TOGGLE-CUE)

12.120.2.73 emacspeak-m-player-toggle-extrastereo

Command: emacspeak-m-player-toggle-extrastereo
Toggle application of extrastereo filter to all streams.

12.120.2.74 emacspeak-m-player-url

Command: emacspeak-m-player-url (url &optional playlist-p)
C-, u
C-x @ a u
Call emacspeak-m-player on  URL.
URL fragment specifies optional start position.

(fn URL &optional PLAYLIST-P)

12.120.2.75 emacspeak-m-player-using-hrtf

Command: emacspeak-m-player-using-hrtf
Add af resample=48000,hrtf to startup options.
This will work if the soundcard is set to 48000.

12.120.2.76 emacspeak-m-player-using-openal

Command: emacspeak-m-player-using-openal
Use openal.  

12.120.2.77 emacspeak-m-player-volume-change

Command: emacspeak-m-player-volume-change (value)
Set volume.

(fn VALUE)

12.120.2.78 emacspeak-m-player-volume-down

Command: emacspeak-m-player-volume-down
Volume down.

12.120.2.79 emacspeak-m-player-volume-set

Command: emacspeak-m-player-volume-set (&optional arg)
Set Volume in steps from 1 to 9.

(fn &optional ARG)

12.120.2.80 emacspeak-m-player-volume-up

Command: emacspeak-m-player-volume-up
Volume up.

12.120.2.81 emacspeak-m-player-write-clip

Command: emacspeak-m-player-write-clip
Split selected range using SoX

12.120.2.82 emacspeak-multimedia

Command: emacspeak-multimedia
C-e ;
Start or control Emacspeak multimedia player.
Controls media playback when already playing.

Key             Binding
——————————————————————————-
C-a             emacspeak-amark-browse
C-l             ladspa
SPC             emacspeak-m-player-pause
%               emacspeak-m-player-display-percent
’         emacspeak-m-player-add-loop
(               emacspeak-m-player-left-channel
)               emacspeak-m-player-right-channel
+               emacspeak-m-player-volume-up
,               emacspeak-m-player-backward-10s
-               emacspeak-m-player-volume-down
.               emacspeak-m-player-forward-10s
/               emacspeak-m-player-restore-process
1 .. 9          emacspeak-m-player-volume-set
;               emacspeak-m-player-pop-to-player
<            emacspeak-m-player-backward-1min
=               emacspeak-m-player-volume-up
>            emacspeak-m-player-forward-1min
?               emacspeak-m-player-show-pos
A               emacspeak-m-player-amark-add
C               emacspeak-m-player-clear-filters
E               emacspeak-m-player-add-equalizer
G               emacspeak-m-player-seek-percentage
L               emacspeak-m-player-get-length
M               emacspeak-m-player-show-data
O               emacspeak-m-player-reset-options
P               emacspeak-m-player-apply-reverb
Q               emacspeak-m-player-quit
R               emacspeak-m-player-edit-reverb
S               emacspeak-m-player-amark-save
T               emacspeak-speak-brief-time
[               emacspeak-m-player-slower
\               emacspeak-m-player-persist-process
]               emacspeak-m-player-faster
a               emacspeak-m-player-add-autopan
b               emacspeak-m-player-balance-channels
c               emacspeak-m-player-slave-command
d               emacspeak-m-player-delete-filter
e               emacspeak-m-player-eq-preset
f               emacspeak-m-player-add-filter
g               emacspeak-m-player-seek-absolute
h               emacspeak-m-player-from-history
i               emacspeak-m-player-stream-info
j               emacspeak-m-player-amark-jump
k               emacspeak-m-player-quit
l               emacspeak-m-player-store-link
m               emacspeak-m-player-mode-line
n               emacspeak-m-player-next-track
o               emacspeak-m-player-customize
p               emacspeak-m-player-previous-track
r               emacspeak-m-player-seek-relative
s               emacspeak-m-player-scale-speed
t               emacspeak-m-player-skip-tracks
v               emacspeak-m-player-volume-change
w               emacspeak-m-player-write-clip
x               emacspeak-m-player-pan
z               emacspeak-m-player-add-autosat
{               emacspeak-m-player-half-speed
}               emacspeak-m-player-double-speed
DEL             emacspeak-m-player-reset-speed
<down>            emacspeak-m-player-forward-1min
<end>             emacspeak-m-player-end-track
<home>            emacspeak-m-player-start-track
<left>            emacspeak-m-player-backward-10s
<next>            emacspeak-m-player-forward-10min
<prior>           emacspeak-m-player-backward-10min
<right>           emacspeak-m-player-forward-10s
<up>              emacspeak-m-player-backward-1min

M-,             emacspeak-m-player-set-clip-start
M-.             emacspeak-m-player-set-clip-end

12.120.3 emacspeak-m-player Options

Variable: User Option emacspeak-m-player-clips
Directory where we store clips.

Default Value:

"/home/raman/mp3/clips"

Variable: User Option emacspeak-m-player-custom-filters
Additional filters to apply to streams.

Default Value:

nil

Variable: User Option emacspeak-media-location-bindings
Map  keys  to launch MPlayer on a  directory.

Default Value:

nil