home-assistant.github.io/source/_components/media_player.markdown
Martin Hjelmare 216f5a4d02 Fix media_player services (#860)
* Correct service and attribute names and add missing services.
2016-08-28 21:08:25 -06:00

50 lines
2.7 KiB
Markdown

---
layout: page
title: "Media Player"
description: "Instructions how to setup your media players with Home Assistant."
date: 2015-01-24 14:39
sidebar: true
comments: false
sharing: true
footer: 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 | Integer for volume level |
#### {% 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`.