Platypush documentation

music

music

class platypush.message.event.music.MusicEvent(status, track, plugin_name=None, *args, **kwargs)[source]

Bases: Event

Base class for music events

__init__(status, track, plugin_name=None, *args, **kwargs)[source]
Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.music.MusicPauseEvent(*args, **kwargs)[source]

Bases: MusicEvent

Event fired upon playback paused

__init__(*args, **kwargs)[source]
Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.music.MusicPlayEvent(status=None, track=None, *args, **kwargs)[source]

Bases: MusicEvent

Event fired upon music player playback start

__init__(status=None, track=None, *args, **kwargs)[source]
Parameters:

  • status (dict) – Player status

  • track (dict) – Track being played

class platypush.message.event.music.MusicStopEvent(*args, **kwargs)[source]

Bases: MusicEvent

Event fired upon playback stop

__init__(*args, **kwargs)[source]
Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.music.MuteChangeEvent(mute, status=None, track=None, *args, **kwargs)[source]

Bases: MusicEvent

Event fired upon mute change

__init__(mute, status=None, track=None, *args, **kwargs)[source]
Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.music.NewPlayingTrackEvent(status=None, track=None, *args, **kwargs)[source]

Bases: MusicEvent

Event fired when a new track is being played

__init__(status=None, track=None, *args, **kwargs)[source]
Parameters:

  • status (dict) – Player status

  • track (dict) – Track being played

class platypush.message.event.music.PlaybackConsumeModeChangeEvent(state, status=None, track=None, *args, **kwargs)[source]

Bases: MusicEvent

Event fired upon consume mode change

__init__(state, status=None, track=None, *args, **kwargs)[source]
Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.music.PlaybackRandomModeChangeEvent(state, status=None, track=None, *args, **kwargs)[source]

Bases: MusicEvent

Event fired upon random mode change

__init__(state, status=None, track=None, *args, **kwargs)[source]
Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.music.PlaybackRepeatModeChangeEvent(state, status=None, track=None, *args, **kwargs)[source]

Bases: MusicEvent

Event fired upon repeat mode change

__init__(state, status=None, track=None, *args, **kwargs)[source]
Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.music.PlaybackSingleModeChangeEvent(state, status=None, track=None, *args, **kwargs)[source]

Bases: MusicEvent

Event fired upon single mode change

__init__(state, status=None, track=None, *args, **kwargs)[source]
Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.music.PlaylistChangeEvent(changes=None, status=None, track=None, *args, **kwargs)[source]

Bases: MusicEvent

Event fired upon playlist change

__init__(changes=None, status=None, track=None, *args, **kwargs)[source]
Parameters:

  • changes (list) – List with the tracks being added or removed

  • status (dict) – Player status

  • track (dict) – Track being played

class platypush.message.event.music.SeekChangeEvent(position, status=None, track=None, *args, **kwargs)[source]

Bases: MusicEvent

Event fired upon seek change

__init__(position, status=None, track=None, *args, **kwargs)[source]
Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.music.VolumeChangeEvent(volume, status=None, track=None, *args, **kwargs)[source]

Bases: MusicEvent

Event fired upon volume change

__init__(volume, status=None, track=None, *args, **kwargs)[source]
Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

previous

mqtt

next

music.snapcast