Platypush documentation

media

media

class platypush.message.event.media.MediaEvent(player=None, plugin=None, *args, **kwargs)[source]

Bases: Event

Base class for media events

__init__(player=None, plugin=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.media.MediaMuteChangedEvent(mute, player=None, plugin=None, *args, **kwargs)[source]

Bases: MediaEvent

Event triggered when the media is muted/unmuted

__init__(mute, player=None, plugin=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.media.MediaPauseEvent(player=None, plugin=None, *args, **kwargs)[source]

Bases: MediaEvent

Event triggered when a media playback is paused

__init__(player=None, plugin=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.media.MediaPlayEvent(player=None, plugin=None, resource=None, title=None, *args, **kwargs)[source]

Bases: MediaEvent

Event triggered when a new media content is played

__init__(player=None, plugin=None, resource=None, title=None, *args, **kwargs)[source]
Parameters:

resource (str) – File name or URI of the played video

class platypush.message.event.media.MediaPlayRequestEvent(player=None, plugin=None, resource=None, title=None, *args, **kwargs)[source]

Bases: MediaEvent

Event triggered when a new media playback request is received

__init__(player=None, plugin=None, resource=None, title=None, *args, **kwargs)[source]
Parameters:

resource (str) – File name or URI of the played video

class platypush.message.event.media.MediaResumeEvent(player=None, plugin=None, *args, **kwargs)[source]

Bases: MediaEvent

Event triggered when a media playback is resumed

__init__(player=None, plugin=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.media.MediaSeekEvent(position, player=None, plugin=None, *args, **kwargs)[source]

Bases: MediaEvent

Event triggered when the time position in the media changes

__init__(position, player=None, plugin=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.media.MediaStopEvent(player=None, plugin=None, *args, **kwargs)[source]

Bases: MediaEvent

Event triggered when a media is stopped

__init__(player=None, plugin=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.media.MediaVolumeChangedEvent(volume, player=None, plugin=None, *args, **kwargs)[source]

Bases: MediaEvent

Event triggered when the media volume changes

__init__(volume, player=None, plugin=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.media.NewPlayingMediaEvent(player=None, plugin=None, resource=None, *args, **kwargs)[source]

Bases: MediaEvent

Event triggered when a new media source is being played

__init__(player=None, plugin=None, resource=None, *args, **kwargs)[source]
Parameters:

resource (str) – File name or URI of the played resource

previous

matrix

next

midi