Home Assistant Unofficial Reference 2024.12.1
media_player.py
Go to the documentation of this file.
1 """Fully Kiosk Browser media player."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from homeassistant.components import media_source
9  BrowseMedia,
10  MediaPlayerEntity,
11  MediaPlayerState,
12  MediaType,
13  async_process_play_media_url,
14 )
15 from homeassistant.core import HomeAssistant, callback
16 from homeassistant.exceptions import HomeAssistantError
17 from homeassistant.helpers.entity_platform import AddEntitiesCallback
18 
19 from . import FullyKioskConfigEntry
20 from .const import AUDIOMANAGER_STREAM_MUSIC, MEDIA_SUPPORT_FULLYKIOSK
21 from .coordinator import FullyKioskDataUpdateCoordinator
22 from .entity import FullyKioskEntity
23 
24 
26  hass: HomeAssistant,
27  config_entry: FullyKioskConfigEntry,
28  async_add_entities: AddEntitiesCallback,
29 ) -> None:
30  """Set up the Fully Kiosk Browser media player entity."""
31  coordinator = config_entry.runtime_data
32  async_add_entities([FullyMediaPlayer(coordinator)])
33 
34 
36  """Representation of a Fully Kiosk Browser media player entity."""
37 
38  _attr_name = None
39  _attr_supported_features = MEDIA_SUPPORT_FULLYKIOSK
40  _attr_assumed_state = True
41 
42  def __init__(self, coordinator: FullyKioskDataUpdateCoordinator) -> None:
43  """Initialize the media player entity."""
44  super().__init__(coordinator)
45  self._attr_unique_id_attr_unique_id = f"{coordinator.data['deviceID']}-mediaplayer"
46  self._attr_state_attr_state = MediaPlayerState.IDLE
47 
48  async def async_play_media(
49  self, media_type: MediaType | str, media_id: str, **kwargs: Any
50  ) -> None:
51  """Play a piece of media."""
52  if media_source.is_media_source_id(media_id):
53  play_item = await media_source.async_resolve_media(
54  self.hasshasshass, media_id, self.entity_identity_id
55  )
56  media_id = async_process_play_media_url(self.hasshasshass, play_item.url)
57 
58  if media_type.startswith("audio/"):
59  media_type = MediaType.MUSIC
60  elif media_type.startswith("video/"):
61  media_type = MediaType.VIDEO
62  if media_type == MediaType.MUSIC:
63  self._attr_media_content_type_attr_media_content_type = MediaType.MUSIC
64  await self.coordinator.fully.playSound(media_id, AUDIOMANAGER_STREAM_MUSIC)
65  elif media_type == MediaType.VIDEO:
66  self._attr_media_content_type_attr_media_content_type = MediaType.VIDEO
67  await self.coordinator.fully.sendCommand(
68  "playVideo",
69  url=media_id,
70  stream=AUDIOMANAGER_STREAM_MUSIC,
71  showControls=1,
72  exitOnCompletion=1,
73  )
74  else:
75  raise HomeAssistantError(f"Unsupported media type {media_type}")
76  self._attr_state_attr_state = MediaPlayerState.PLAYING
77  self.async_write_ha_stateasync_write_ha_state()
78 
79  async def async_media_stop(self) -> None:
80  """Stop playing media."""
81  if self._attr_media_content_type_attr_media_content_type == MediaType.VIDEO:
82  await self.coordinator.fully.sendCommand("stopVideo")
83  else:
84  await self.coordinator.fully.stopSound()
85  self._attr_state_attr_state = MediaPlayerState.IDLE
86  self.async_write_ha_stateasync_write_ha_state()
87 
88  async def async_set_volume_level(self, volume: float) -> None:
89  """Set volume level, range 0..1."""
90  await self.coordinator.fully.setAudioVolume(
91  int(volume * 100), AUDIOMANAGER_STREAM_MUSIC
92  )
93  self._attr_volume_level_attr_volume_level = volume
94  self.async_write_ha_stateasync_write_ha_state()
95 
96  async def async_browse_media(
97  self,
98  media_content_type: MediaType | str | None = None,
99  media_content_id: str | None = None,
100  ) -> BrowseMedia:
101  """Implement the WebSocket media browsing helper."""
102  return await media_source.async_browse_media(
103  self.hasshasshass,
104  media_content_id,
105  content_filter=lambda item: item.media_content_type.startswith("audio/")
106  or item.media_content_type.startswith("video/"),
107  )
108 
109  @callback
110  def _handle_coordinator_update(self) -> None:
111  """Handle updated data from the coordinator."""
112  self._attr_state_attr_state = (
113  MediaPlayerState.PLAYING
114  if "soundUrlPlaying" in self.coordinator.data
115  else MediaPlayerState.IDLE
116  )
117  self.async_write_ha_stateasync_write_ha_state()
None __init__(self, FullyKioskDataUpdateCoordinator coordinator)
Definition: media_player.py:42
None async_play_media(self, MediaType|str media_type, str media_id, **Any kwargs)
Definition: media_player.py:50
BrowseMedia async_browse_media(self, MediaType|str|None media_content_type=None, str|None media_content_id=None)
None async_setup_entry(HomeAssistant hass, FullyKioskConfigEntry config_entry, AddEntitiesCallback async_add_entities)
Definition: media_player.py:29
str async_process_play_media_url(HomeAssistant hass, str media_content_id, *bool allow_relative_url=False, bool for_supervisor_network=False)
Definition: browse_media.py:36