MediaEngine Plugin
From
Contents |
Media Engine
Overview
This plugin handles the actual playing and audio routing of music files. It will eventually also handle video playback, but at the moment it only does audio. This is also a core plugin, without which RevFE just sits idle. MediaEngine has several key features, which tightly integrate it with the MediaLibrary as well as the GUI. When MediaEngine see's "event:playlistloaded" fired from MediaLibrary, it requests the current list of songs, via "MediaLibrary:playlist getsongfilenames !title!" MediaLibrary replies back with: "Sender:playlist songlist !title! !basestring! !path1! !album1! !artist1! !title1! !track1! !pathN! !albumN! !artistN! !titleN! !trackN!" MediaEngine takes this list, and creates its own Playlist of files, including the id3 information. This allows MediaEngine to have the all the relevant current file information without having to query MediaLibrary unless a new playlist is loaded.
Skinning Properties
propertyMap
- sys_volume
- Percentage of full volume, integer from 0 to 100
- currentSongText
- Currently playing song text, generally tag->artist and tag->title.
- currentSongIndex
- index based on the currentPlaylistModel of the currently playing song
- totalTimeText
- Total song length, in format hh:mm:ss without leading hour and minute 0's
- elapsedTimeText
- Elapsed song time in format hh:mm:ss without leading hour and minute 0's
- remainingTimeText
- Remaining song time, in format hh:mm:ss without leading hour and minute 0's
Standard ListModels
none
Complex ListModels
none
Events
- event:mediachange !filename! !index!
- Fired when media has been changed. Index is the index in currentPlaylistModel
- event:mediaengine_volumechanged !volume!
- Fired when volume is changed. !volume! is 0 to !00
- event:mediastate !state!
- Fired when media starts or stops. State can be: "media:playing" or "media:stopped"
Available Commands
- MediaEngine:media play !index!
- Starts media playback of index in currentPlaylistModel. If index is not included, then start playing the current song
- MediaEngine:media pause
- Pause current media
- MediaEngine:media prev
- Move to the previous media file and begin playback
- MediaEngine:media next
- Move to the next media file and begin playback
- MediaEngine:media stop
- Stop playback
- MediaEngine:media mute
- Toggle mute
- MediaEngine:media setpos !position!
- Set position in the media. !position! is a percentage of total length, 0 to 100
- MediaEngine:media setvolume !volume!
- Set volume of the media playback. !volume! is a percentage from 0 to 100.
- MediaEngine:media volup
- Increase volume by 10%
- MediaEngine:media voldown
- Decrease volume by 10%
