Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.snapcast.media_player Namespace Reference

Classes

class  SnapcastClientDevice
 
class  SnapcastGroupDevice
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 
def handle_async_join (entity, service_call)
 
def handle_async_unjoin (entity, service_call)
 
def handle_set_latency (entity, service_call)
 
def register_services ()
 

Variables

dictionary STREAM_STATUS
 

Detailed Description

Support for interacting with Snapcast clients.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.snapcast.media_player.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Set up the snapcast config entry.

Definition at line 58 of file media_player.py.

◆ handle_async_join()

def homeassistant.components.snapcast.media_player.handle_async_join (   entity,
  service_call 
)
Handle the entity service join.

Definition at line 86 of file media_player.py.

◆ handle_async_unjoin()

def homeassistant.components.snapcast.media_player.handle_async_unjoin (   entity,
  service_call 
)
Handle the entity service unjoin.

Definition at line 93 of file media_player.py.

◆ handle_set_latency()

def homeassistant.components.snapcast.media_player.handle_set_latency (   entity,
  service_call 
)
Handle the entity service set_latency.

Definition at line 100 of file media_player.py.

◆ register_services()

def homeassistant.components.snapcast.media_player.register_services ( )
Register snapcast services.

Definition at line 41 of file media_player.py.

Variable Documentation

◆ STREAM_STATUS

dictionary homeassistant.components.snapcast.media_player.STREAM_STATUS
Initial value:
1 = {
2  "idle": MediaPlayerState.IDLE,
3  "playing": MediaPlayerState.PLAYING,
4  "unknown": None,
5 }

Definition at line 34 of file media_player.py.