Difference between revisions of "Plugin MM"
m (1 revision) |
m (1 revision) |
(No difference)
|
Latest revision as of 11:25, 13 January 2021
Go to the main Plugins page.
Go to the complete Plugin List.
Contents
- 1 Plugin Description
- 2 Actions for the MM plugin
- 2.1 AddCurrentToPlaylist
- 2.2 AdjustVolume
- 2.3 CurrentSongData
- 2.4 DoubleUp
- 2.5 GenXML
- 2.6 GetVolume
- 2.7 LoadBySQL
- 2.8 LoadEqPreset
- 2.9 LoadPlaylist
- 2.10 mode settings
- 2.11 Next
- 2.12 NPList
- 2.13 NPShuffle
- 2.14 Pause
- 2.15 Play
- 2.16 Previous
- 2.17 SetCurrentTrack
- 2.18 SetRating
- 2.19 SetVolume
- 2.20 SoftMute
- 2.21 SoftUnmute
- 2.22 Stop
Plugin Description
Actions to control MediaMonkey and to retrieve information about currently playing media.
Actions for the MM plugin
AddCurrentToPlaylist
MM.AddCurrentToPlaylist
Adds the currently playing song to the MediaMonkey playlist named <Playlist>. You cannot add a song to an AutoPlaylist.
- Parameters: 1
- Playlist : Playlist to add current track to [string]
AdjustVolume
MM.AdjustVolume
Modifies the playback volume by <Amount> %
Use a positive number to increase volume.
Use a negative number to reduce volume.
- Parameters: 1
- Amount : +/- ajustment in % [integer]
CurrentSongData
MM.CurrentSongData
Get information about the current song. Parameter should be one of the following:
album / artist / conductor / genre / id / mood / path / playcounter / rating / title / year / occasion / custom1 / ... / custom5
- Parameters: 1
- Data type : [string]
DoubleUp
MM.DoubleUp
Modifies the current playlist by adding a random second song for each artist.
This means you will hear two songs in a row for each artist.
Processing can be a bit slow and will only iterate through a maximum of 50 songs, resulting in up to 100 songs after doubling.
GenXML
MM.GenXML
Generates all payloadXML files based on the MediaMonkey plugin settings.
GetVolume
MM.GetVolume
Returns current MediaMonkey volume from 0 to 100.
LoadBySQL
MM.LoadBySQL
Loads songs according to an SQL query using the specified <Where> clause.
Example where parameter:
rating>75 order by random() limit 25
Special can be set to Replace, Mix, or PlayNext. Default is Replace
Playnext will add new tracks after the current playing song.
Mix will do the following:
1 - Remove all tracks in now playing that precede the current track
2 - Add the newly requested tracks to existing playlist
3 - Shuffle them all together.
For both Mix and Playnext, the current song will continue to play.
- Parameters: 1-2
- Where : sql query where clause used to specify songs to load [string]
- Special : Replace, Mix, or PlayNext [string]
LoadEqPreset
MM.LoadEqPreset
Enables the MM equalizer and loads (if possible) the preset defined by <filename>. The parameter does not need to include the path to the file.
- Parameters: 1
- Filename : <filename> [string]
LoadPlaylist
MM.LoadPlaylist
Loads the playlist with the name <Playlist>.
- Parameters: 1
- Playlist : Name of Playlist to load [string]
mode settings
Enable/disable various MediaMonkey playback modes.
SetAutoDJ
MM.SetAutoDJ
Turn MM autoDJ on or off.
Parameter should be one of: true, false, on, off
- Parameters: 1
- AutoDJ : True or False [boolean]
SetCrossfade
MM.SetCrossfade
Turn MM crossfade between songs on or off.
Parameter should be one of: true, false, on, off
- Parameters: 1
- CrossFade : True or False [boolean]
SetEQ
MM.SetEQ
Turn MM equalizer on or off.
Parameter should be one of: true, false, on, off
- Parameters: 1
- EQ : True or False [boolean]
SetRepeat
MM.SetRepeat
Turn MM song repeat on or off.
Parameter should be one of: true, false, on, off
- Parameters: 1
- Repeat : True or False [boolean]
SetShuffle
MM.SetShuffle
Turn MM song shuffle on or off.
Parameter should be one of: true, false, on, off
- Parameters: 1
- Shuffle : True or False [boolean]
Next
MM.Next
Advance playback to the next song.
NPList
MM.NPList
Returns the current MM "Now playing" playlist.
Returns first <Count> songs starting at song <Index>.
To start at the current song, Use the word current for the <Index> parameter.
This is based on *all* of the songs in the now playing list, regardless of what the currently playing song is (i.e. results returned are not relative to the currently playing song, but to the first song in the playlist).
- Parameters: 0-2
- Count : Number of songs to return (default: 10) [integer]
- Index : Index of first song to return (default: 1) - accepts the word: current [string]
NPShuffle
MM.NPShuffle
Shuffles MM's "now playing" playlist. Shuffles list and puts currently playing song at the beginning of the re-ordered list.
Pause
MM.Pause
Pause playback.
Play
MM.Play
Begin/resume playback.
Previous
MM.Previous
Previous track. If a track is already playing, this action will "rewind" to beginning of currently playing track.
Use the set of actions "MM.Stop" > "MM.Previous" > "MM.Play" if you want it to play the previous track rather than rewinding to beginning of current track.
SetCurrentTrack
MM.SetCurrentTrack
Sets the playhead to track number <index> in the MM "now playing" playlist.
- Parameters: 1
- Index : Track # [integer]
SetRating
MM.SetRating
Sets the rating for the currently playing song.
50 = 2.5 stars, 60 = 3 stars, ... 100 = 5 stars
- Parameters: 1
- Rating : 0-100 [integer]
SetVolume
MM.SetVolume
Sets the playback volume of mediamonkey to <0-100> %
- Parameters: 1
- Volume : 0-100 [integer]
SoftMute
MM.SoftMute
Reduces the MM playback volume to a <Percent>age of its current level. Volume can be restored later using MM.SoftUnmute
- Parameters: 1
- Percent : 0-100 [integer]
SoftUnmute
MM.SoftUnmute
Restores MM volume to the level it was at before using MM.SoftMute
Stop
MM.Stop
Stop playback