home-assistant.github.io/components/media_player/index.html
2017-01-15 17:48:30 +00:00

395 lines
No EOL
14 KiB
HTML

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Media Player - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to setup your media players with Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/media_player/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Media Player">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/media_player/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to setup your media players with Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Media Player">
<meta name="twitter:description" content="Instructions how to setup your media players with Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/ecosystem/">Ecosystem</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
Media Player
</h1>
</header>
<hr class="divider">
<p>Interacts with media players on your network. Please check the sidebar for a full list of supported devices.</p>
<h2><a class="title-link" name="services" href="#services"></a> Services</h2>
<h3><a class="title-link" name="media-control-services" href="#media-control-services"></a> Media control services</h3>
<p>Available services: <code class="highlighter-rouge">turn_on</code>, <code class="highlighter-rouge">turn_off</code>, <code class="highlighter-rouge">toggle</code>, <code class="highlighter-rouge">volume_up</code>, <code class="highlighter-rouge">volume_down</code>, <code class="highlighter-rouge">media_play_pause</code>, <code class="highlighter-rouge">media_play</code>, <code class="highlighter-rouge">media_pause</code>, <code class="highlighter-rouge">media_stop</code>, <code class="highlighter-rouge">media_next_track</code>, <code class="highlighter-rouge">media_previous_track</code>, <code class="highlighter-rouge">clear_playlist</code></p>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>yes</td>
<td>Target a specific media player. Defaults to all.</td>
</tr>
</tbody>
</table>
<h4><a class="title-link" name="service-media_playervolume_mute" href="#service-media_playervolume_mute"></a> Service <code class="highlighter-rouge">media_player/volume_mute</code></h4>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>yes</td>
<td>Target a specific media player. Defaults to all.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">is_volume_muted</code></td>
<td>no</td>
<td>True/false for mute/unmute</td>
</tr>
</tbody>
</table>
<h4><a class="title-link" name="service-media_playervolume_set" href="#service-media_playervolume_set"></a> Service <code class="highlighter-rouge">media_player/volume_set</code></h4>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>yes</td>
<td>Target a specific media player. Defaults to all.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">volume_level</code></td>
<td>no</td>
<td>Float for volume level</td>
</tr>
</tbody>
</table>
<h4><a class="title-link" name="service-media_playermedia_seek" href="#service-media_playermedia_seek"></a> Service <code class="highlighter-rouge">media_player/media_seek</code></h4>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>yes</td>
<td>Target a specific media player. Defaults to all.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">seek_position</code></td>
<td>no</td>
<td>Position to seek to. The format is platform dependent.</td>
</tr>
</tbody>
</table>
<h4><a class="title-link" name="service-media_playerplay_media" href="#service-media_playerplay_media"></a> Service <code class="highlighter-rouge">media_player/play_media</code></h4>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>yes</td>
<td>Target a specific media player. Defaults to all.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">media_content_id</code></td>
<td>no</td>
<td>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.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">media_content_type</code></td>
<td>no</td>
<td>A media type. Must be one of <code class="highlighter-rouge">MUSIC</code>, <code class="highlighter-rouge">TVSHOW</code>, <code class="highlighter-rouge">VIDEO</code>, <code class="highlighter-rouge">EPISODE</code>, <code class="highlighter-rouge">CHANNEL</code> or <code class="highlighter-rouge">PLAYLIST</code>. For example, to play music you would set <code class="highlighter-rouge">media_content_type</code> to <code class="highlighter-rouge">MUSIC</code>.</td>
</tr>
</tbody>
</table>
<h4><a class="title-link" name="service-media_playerselect_source" href="#service-media_playerselect_source"></a> Service <code class="highlighter-rouge">media_player/select_source</code></h4>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>yes</td>
<td>Target a specific media player. Defaults to all.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">source</code></td>
<td>no</td>
<td>Name of the source to switch to. Platform dependent.</td>
</tr>
</tbody>
</table>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/media_player.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
</div>
<h1 class='title delta'>Platforms</h1>
<ul class='divided'>
<li><a href='/components/media_player.denon/'>
Denon Network Receivers
</a></li>
<li><a href='/components/media_player.directv/'>
DirecTV
</a></li>
<li><a href='/components/media_player.dunehd/'>
DuneHD media players
</a></li>
<li><a href='/components/media_player.emby/'>
Emby
</a></li>
<li><a href='/components/media_player.firetv/'>
FireTV
</a></li>
<li><a href='/components/media_player.cast/'>
Google Cast
</a></li>
<li><a href='/components/media_player.gpmdp/'>
Google Play Music Desktop Player
</a></li>
<li><a href='/components/media_player.kodi/'>
Kodi
</a></li>
<li><a href='/components/media_player.lg_netcast/'>
LG Netcast TV
</a></li>
<li><a href='/components/media_player.webostv/'>
LG webOS Smart TV
</a></li>
<li><a href='/components/media_player.squeezebox/'>
Logitech Squeezebox
</a></li>
<li><a href='/components/media_player.mpchc/'>
MPC-HC
</a></li>
<li><a href='/components/media_player.mpd/'>
Music Player Daemon (MPD)
</a></li>
<li><a href='/components/media_player.nad/'>
NAD
</a></li>
<li><a href='/components/media_player.onkyo/'>
Onkyo
</a></li>
<li><a href='/components/media_player.panasonic_viera/'>
Panasonic Viera TV
</a></li>
<li><a href='/components/media_player.pandora/'>
Pandora
</a></li>
<li><a href='/components/media_player.philips_js/'>
Philips TV
</a></li>
<li><a href='/components/media_player.pioneer/'>
Pioneer Network Receivers
</a></li>
<li><a href='/components/media_player.plex/'>
Plex
</a></li>
<li><a href='/components/media_player.roku/'>
Roku
</a></li>
<li><a href='/components/media_player.russound_rnet/'>
Russound RNET
</a></li>
<li><a href='/components/media_player.samsungtv/'>
Samsung Smart TV
</a></li>
<li><a href='/components/media_player.aquostv/'>
Sharp Aquos TV
</a></li>
<li><a href='/components/media_player.snapcast/'>
Snapcast
</a></li>
<li><a href='/components/media_player.sonos/'>
Sonos
</a></li>
<li><a href='/components/media_player.braviatv/'>
Sony Bravia TV
</a></li>
<li><a href='/components/media_player.soundtouch/'>
Soundtouch
</a></li>
<li><a href='/components/media_player.universal/'>
Universal
</a></li>
<li><a href='/components/media_player.vlc/'>
VLC
</a></li>
<li><a href='/components/media_player.yamaha/'>
Yamaha Network Receivers
</a></li>
<li><a href='/components/media_player.cmus/'>
cmus
</a></li>
<li><a href='/components/media_player.itunes/'>
iTunes
</a></li>
</ul>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>