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]#
Parameters:

  • target (str) – Target node

  • origin (str) – Origin node (default: current node)

  • id (str) – Event ID (default: auto-generated)

  • timestamp (float) – Event timestamp (default: current time)

  • logging_level – Logging level for this event (default: logging.INFO)

  • disable_web_clients_notification – Don’t send a notification of this event to the websocket clients

  • kwargs – Additional arguments for the event

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]#
Parameters:

  • target (str) – Target node

  • origin (str) – Origin node (default: current node)

  • id (str) – Event ID (default: auto-generated)

  • timestamp (float) – Event timestamp (default: current time)

  • logging_level – Logging level for this event (default: logging.INFO)

  • disable_web_clients_notification – Don’t send a notification of this event to the websocket clients

  • kwargs – Additional arguments for the event

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]#
Parameters:

  • target (str) – Target node

  • origin (str) – Origin node (default: current node)

  • id (str) – Event ID (default: auto-generated)

  • timestamp (float) – Event timestamp (default: current time)

  • logging_level – Logging level for this event (default: logging.INFO)

  • disable_web_clients_notification – Don’t send a notification of this event to the websocket clients

  • kwargs – Additional arguments for the event

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]#
Parameters:

  • target (str) – Target node

  • origin (str) – Origin node (default: current node)

  • id (str) – Event ID (default: auto-generated)

  • timestamp (float) – Event timestamp (default: current time)

  • logging_level – Logging level for this event (default: logging.INFO)

  • disable_web_clients_notification – Don’t send a notification of this event to the websocket clients

  • kwargs – Additional arguments for the event

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]#
Parameters:

  • target (str) – Target node

  • origin (str) – Origin node (default: current node)

  • id (str) – Event ID (default: auto-generated)

  • timestamp (float) – Event timestamp (default: current time)

  • logging_level – Logging level for this event (default: logging.INFO)

  • disable_web_clients_notification – Don’t send a notification of this event to the websocket clients

  • kwargs – Additional arguments for the event

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]#
Parameters:

  • target (str) – Target node

  • origin (str) – Origin node (default: current node)

  • id (str) – Event ID (default: auto-generated)

  • timestamp (float) – Event timestamp (default: current time)

  • logging_level – Logging level for this event (default: logging.INFO)

  • disable_web_clients_notification – Don’t send a notification of this event to the websocket clients

  • kwargs – Additional arguments for the event

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]#
Parameters:

  • target (str) – Target node

  • origin (str) – Origin node (default: current node)

  • id (str) – Event ID (default: auto-generated)

  • timestamp (float) – Event timestamp (default: current time)

  • logging_level – Logging level for this event (default: logging.INFO)

  • disable_web_clients_notification – Don’t send a notification of this event to the websocket clients

  • kwargs – Additional arguments for the event

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