media_player.py

Go to the documentation of this file.

"""Support for Clementine Music Player as media player."""
 
from __future__ import annotations
 
from datetime import timedelta
import time
 
from clementineremote import ClementineRemote
import voluptuous as vol
 
from homeassistant.components.media_player import (
    PLATFORM_SCHEMA as MEDIA_PLAYER_PLATFORM_SCHEMA,
    MediaPlayerEntity,
    MediaPlayerEntityFeature,
    MediaPlayerState,
    MediaType,
)
from homeassistant.const import CONF_ACCESS_TOKEN, CONF_HOST, CONF_NAME, CONF_PORT
from homeassistant.core import HomeAssistant
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
DEFAULT_NAME = "Clementine Remote"
DEFAULT_PORT = 5500
 
SCAN_INTERVAL = timedelta(seconds=5)
 
PLATFORM_SCHEMA = MEDIA_PLAYER_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_HOST): cv.string,
        vol.Optional(CONF_ACCESS_TOKEN): cv.positive_int,
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
    }
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the Clementine platform."""
 
    host = config[CONF_HOST]
    port = config[CONF_PORT]
    token = config.get(CONF_ACCESS_TOKEN)
 
    client = ClementineRemote(host, port, token, reconnect=True)
 
    add_entities([ClementineDevice(client, config[CONF_NAME])])
 
 
class ClementineDevice(MediaPlayerEntity):
    """Representation of Clementine Player."""
 
    _attr_media_content_type = MediaType.MUSIC
    _attr_supported_features = (
        MediaPlayerEntityFeature.PAUSE
        | MediaPlayerEntityFeature.VOLUME_STEP
        | MediaPlayerEntityFeature.PREVIOUS_TRACK
        | MediaPlayerEntityFeature.VOLUME_SET
        | MediaPlayerEntityFeature.NEXT_TRACK
        | MediaPlayerEntityFeature.SELECT_SOURCE
        | MediaPlayerEntityFeature.PLAY
    )
 
    def __init__(self, client, name):
        """Initialize the Clementine device."""
        self._client_client = client
        self._attr_name_attr_name = name
 
    def update(self) -> None:
        """Retrieve the latest data from the Clementine Player."""
        try:
            client = self._client_client
 
            if client.state == "Playing":
                self._attr_state_attr_state = MediaPlayerState.PLAYING
            elif client.state == "Paused":
                self._attr_state_attr_state = MediaPlayerState.PAUSED
            elif client.state == "Disconnected":
                self._attr_state_attr_state = MediaPlayerState.OFF
            else:
                self._attr_state_attr_state = MediaPlayerState.PAUSED
 
            if client.last_update and (time.time() - client.last_update > 40):
                self._attr_state_attr_state = MediaPlayerState.OFF
 
            volume = float(client.volume) if client.volume else 0.0
            self._attr_volume_level_attr_volume_level = volume / 100.0
            if client.active_playlist_id in client.playlists:
                self._attr_source_attr_source = client.playlists[client.active_playlist_id]["name"]
            else:
                self._attr_source_attr_source = "Unknown"
            self._attr_source_list_attr_source_list = [s["name"] for s in client.playlists.values()]
 
            if client.current_track:
                self._attr_media_title_attr_media_title = client.current_track["title"]
                self._attr_media_artist_attr_media_artist = client.current_track["track_artist"]
                self._attr_media_album_name_attr_media_album_name = client.current_track["track_album"]
                self._attr_media_image_hash_attr_media_image_hash = client.current_track["track_id"]
            else:
                self._attr_media_image_hash_attr_media_image_hash = None
 
        except Exception:
            self._attr_state_attr_state = MediaPlayerState.OFF
            raise
 
    def select_source(self, source: str) -> None:
        """Select input source."""
        client = self._client_client
        sources = [s for s in client.playlists.values() if s["name"] == source]
        if len(sources) == 1:
            client.change_song(sources[0]["id"], 0)
 
    async def async_get_media_image(self) -> tuple[bytes | None, str | None]:
        """Fetch media image of current playing image."""
        if self._client_client.current_track:
            image = bytes(self._client_client.current_track["art"])
            return (image, "image/png")
 
        return None, None
 
    def volume_up(self) -> None:
        """Volume up the media player."""
        newvolume = min(self._client_client.volume + 4, 100)
        self._client_client.set_volume(newvolume)
 
    def volume_down(self) -> None:
        """Volume down media player."""
        newvolume = max(self._client_client.volume - 4, 0)
        self._client_client.set_volume(newvolume)
 
    def mute_volume(self, mute: bool) -> None:
        """Send mute command."""
        self._client_client.set_volume(0)
 
    def set_volume_level(self, volume: float) -> None:
        """Set volume level."""
        self._client_client.set_volume(int(100 * volume))
 
    def media_play_pause(self) -> None:
        """Simulate play pause media player."""
        if self.statestatestatestatestate == MediaPlayerState.PLAYING:
            self.media_pausemedia_pausemedia_pause()
        else:
            self.media_playmedia_playmedia_play()
 
    def media_play(self) -> None:
        """Send play command."""
        self._attr_state_attr_state = MediaPlayerState.PLAYING
        self._client_client.play()
 
    def media_pause(self) -> None:
        """Send media pause command to media player."""
        self._attr_state_attr_state = MediaPlayerState.PAUSED
        self._client_client.pause()
 
    def media_next_track(self) -> None:
        """Send next track command."""
        self._client_client.next()
 
    def media_previous_track(self) -> None:
        """Send the previous track command."""
        self._client_client.previous()