home-assistant.io/source/_components/media_player.markdown
Daniel Stone e35c8492b9 Added spotify shuffle to Media Player page (#2594)
entity_id is not optional as it seems like it doesn't work if not included. Throws NotImplementedError() otherwise.
2017-05-07 22:55:24 +02:00

4.6 KiB

layout, title, description, date, sidebar, comments, sharing, footer
layout title description date sidebar comments sharing footer
page Media Player Instructions how to setup your media players with Home Assistant. 2015-01-24 14:39 true false true true

Interacts with media players on your network. Please check the sidebar for a full list of supported devices.

{% linkable_title Services %}

{% linkable_title Media control services %}

Available services: turn_on, turn_off, toggle, volume_up, volume_down, media_play_pause, media_play, media_pause, media_stop, media_next_track, media_previous_track, clear_playlist

Service data attribute Optional Description
entity_id yes Target a specific media player. Defaults to all.

{% linkable_title Service media_player/volume_mute %}

Service data attribute Optional Description
entity_id yes Target a specific media player. Defaults to all.
is_volume_muted no True/false for mute/unmute

{% linkable_title Service media_player/volume_set %}

Service data attribute Optional Description
entity_id yes Target a specific media player. Defaults to all.
volume_level no Float for volume level

{% linkable_title Service media_player/volume_transition %}

Service data attribute Optional Description
entity_id yes Target a specific media player. Defaults to all.
volume_level no Float for volume level
transition no Integer for transition time in seconds

{% linkable_title Service media_player/media_seek %}

Service data attribute Optional Description
entity_id yes Target a specific media player. Defaults to all.
seek_position no Position to seek to. The format is platform dependent.

{% linkable_title Service media_player/play_media %}

Service data attribute Optional Description
entity_id yes Target a specific media player. Defaults to all.
media_content_id no A media identifier. The format of this is component dependent. For example, you can provide URLs to Sonos and Cast but only a playlist ID to iTunes.
media_content_type no A media type. Must be one of MUSIC, TVSHOW, VIDEO, EPISODE, CHANNEL or PLAYLIST. For example, to play music you would set media_content_type to MUSIC.

{% linkable_title Service media_player/select_source %}

Service data attribute Optional Description
entity_id yes Target a specific media player. Defaults to all.
source no Name of the source to switch to. Platform dependent.

{% linkable_title Service media_player/shuffle_set %}

Currently only supports Spotify.

Service data attribute Optional Description
entity_id no Target a specific media player. For example media_player.spotify
source no true/false for enabling/disabling shuffle