media.vlc
Platypush documentation
media.vlc
- class platypush.plugins.media.vlc.MediaVlcPlugin(args=None, fullscreen=False, volume=100, *argv, **kwargs)[source]
Bases:
MediaPlugin
Plugin to control vlc instances
Requires:
python-vlc (
pip install python-vlc
)vlc executable on your system
- __init__(args=None, fullscreen=False, volume=100, *argv, **kwargs)[source]
Create the vlc wrapper.
- Parameters:
args (list[str]) – List of extra arguments to pass to the VLC executable (e.g.
['--sub-language=en', '--snapshot-path=/mnt/snapshots']
)fullscreen (bool) – Set to True if you want media files to be opened in fullscreen by default (can be overridden by .play()) (default: False)
volume (int) – Default media volume (default: 100)
- play(resource=None, subtitles=None, fullscreen=None, volume=None)[source]
Play a resource.
- Parameters:
resource (str) – Resource to play - can be a local file or a remote URL (default: None == toggle play).
subtitles (str) – Path to optional subtitle file
fullscreen (bool) – Set to explicitly enable/disable fullscreen (default: fullscreen configured value or False)
volume – Set to explicitly set the playback volume (default: volume configured value or 100)
- seek(position)[source]
Seek backward/forward by the specified number of seconds
- Parameters:
position (int) – Number of seconds relative to the current cursor
- set_position(position)[source]
Seek backward/forward to the specified absolute position (same as
seek
)
- set_volume(volume)[source]
Set the volume
- Parameters:
volume (float) – Volume value between 0 and 100