music.snapcast
Platypush documentation
music.snapcast
- class platypush.message.event.music.snapcast.ClientConnectedEvent(client, host='localhost', *args, **kwargs)[source]
Bases:
SnapcastEvent
Event fired upon client connection
- __init__(client, host='localhost', *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.snapcast.ClientDisconnectedEvent(client, host='localhost', *args, **kwargs)[source]
Bases:
SnapcastEvent
Event fired upon client disconnection
- __init__(client, host='localhost', *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.snapcast.ClientLatencyChangeEvent(client, latency, host='localhost', *args, **kwargs)[source]
Bases:
SnapcastEvent
Event fired upon latency change on a client
- __init__(client, latency, host='localhost', *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.snapcast.ClientNameChangeEvent(client, name, host='localhost', *args, **kwargs)[source]
Bases:
SnapcastEvent
Event fired upon name change of a client
- __init__(client, name, host='localhost', *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.snapcast.ClientVolumeChangeEvent(client, volume, muted, host='localhost', *args, **kwargs)[source]
Bases:
SnapcastEvent
Event fired upon volume change or mute status change on a client
- __init__(client, volume, muted, host='localhost', *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.snapcast.GroupMuteChangeEvent(group, muted, host='localhost', *args, **kwargs)[source]
Bases:
SnapcastEvent
Event fired upon mute status change
- __init__(group, muted, host='localhost', *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.snapcast.GroupStreamChangeEvent(group, stream, host='localhost', *args, **kwargs)[source]
Bases:
SnapcastEvent
Event fired upon group stream change
- __init__(group, stream, host='localhost', *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.snapcast.ServerUpdateEvent(server, host='localhost', *args, **kwargs)[source]
Bases:
SnapcastEvent
Event fired upon stream update
- __init__(server, host='localhost', *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.snapcast.SnapcastEvent(host='localhost', *args, **kwargs)[source]
Bases:
Event
Base class for Snapcast events
- __init__(host='localhost', *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.snapcast.StreamUpdateEvent(stream_id, stream, host='localhost', *args, **kwargs)[source]
Bases:
SnapcastEvent
Event fired upon stream update
- __init__(stream_id, stream, host='localhost', *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).