374 lines
16 KiB
HTML
374 lines
16 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 Extractor - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate the Media Extractor into Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/media_extractor/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Media Extractor">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/media_extractor/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate the Media Extractor into 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 Extractor">
|
||
<meta name="twitter:description" content="Instructions how to integrate the Media Extractor into Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection, print" 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 class='site-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="/docs/">Docs</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>
|
||
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
||
</ul>
|
||
</nav>
|
||
<div class='search-container' style='display: none'>
|
||
<div class='search'>
|
||
<i class="icon-search"></i>
|
||
<input id='search' placeholder='Search the docs…'>
|
||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||
</div>
|
||
</div>
|
||
</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 Extractor
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">media_extractor</code> component gets a stream URL and sends it to a media player entity. This component can extract entity specific streams if configured accordingly.</p>
|
||
<p class="note">
|
||
Media extractor doesn’t transcode streams, it just tries to find stream that match requested query.
|
||
</p>
|
||
<p>To use the media extractor service in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">media_extractor</span><span class="pi">:</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>default_query</strong> (<em>Optional</em>): Set default stream query for all devices (‘best’ by default).</li>
|
||
<li><strong>customize</strong> (<em>Optional</em>): Set entity specific values. For example:</li>
|
||
</ul>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">media_extractor</span><span class="pi">:</span>
|
||
<span class="s">default_query</span><span class="pi">:</span> <span class="s">worst</span>
|
||
<span class="s">customize</span><span class="pi">:</span>
|
||
<span class="s">media_player.my_sonos</span><span class="pi">:</span>
|
||
<span class="s">video</span><span class="pi">:</span> <span class="s">bestvideo</span>
|
||
<span class="s">music</span><span class="pi">:</span> <span class="s">bestaudio[ext=mp3]</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>This configuration sets query for all service calls like to ‘bestaudio’ with the mp3 extension:</p>
|
||
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
|
||
</span><span class="nt">"entity_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"media_player.my_sonos"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"media_content_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://soundcloud.com/bruttoband/brutto-11"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"media_content_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"music"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre>
|
||
</div>
|
||
<p>Query examples with explanations:</p>
|
||
<ul>
|
||
<li><strong>bestvideo</strong>: Best video only stream</li>
|
||
<li><strong>best</strong>: Best video + audio stream</li>
|
||
<li><strong>bestaudio[ext=m4a]</strong>: Best audio stream with m4a extension</li>
|
||
<li><strong>worst</strong>: Worst video + audio stream</li>
|
||
<li><strong>bestaudio[ext=m4a]/bestaudio[ext=ogg]/bestaudio</strong>: Best m4a audio, otherwise best ogg audio and only then any best audio</li>
|
||
</ul>
|
||
<p>More info about queries <a href="https://github.com/rg3/youtube-dl#format-selection">here</a></p>
|
||
<h3><a class="title-link" name="use-the-service" href="#use-the-service"></a> Use the service</h3>
|
||
<p>Use <img src="/images/screenshots/developer-tool-services-icon.png" alt="service developer tool icon" class="no-shadow" height="38" /> <strong>Services</strong> from the <strong>Developer Tools</strong>. Choose <code class="highlighter-rouge">media_extractor</code> from the dropdown menu <strong>Domain</strong> and <code class="highlighter-rouge">play_media</code> from <strong>Service</strong>, enter something like the JSON sample from above into the <strong>Service Data</strong> field, and hit <strong>CALL SERVICE</strong>.</p>
|
||
<p>This will download the file from the given URL.</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>Name(s) of entities to seek media on, e.g., <code class="highlighter-rouge">media_player.living_room_chromecast</code>. Defaults to all.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">media_content_id</code></td>
|
||
<td>no</td>
|
||
<td>The ID of the content to play. Platform dependent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">media_content_type</code></td>
|
||
<td>no</td>
|
||
<td>The type of the content to play. Must be one of MUSIC, TVSHOW, VIDEO, EPISODE, CHANNEL or PLAYLIST MUSIC.</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_extractor.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/home-assistant.png' />
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.49
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Media Player</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/media_player.anthemav/'>Anthem A/V Receivers</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.apple_tv/'>Apple TV Media Player</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.bluesound/'>Bluesound</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.clementine/'>Clementine Music Player</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.denonavr/'>Denon AVR Network Receivers</a>
|
||
</li>
|
||
<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.frontier_silicon/'>Frontier Silicon Internet Radios</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.gstreamer/'>Gstreamer</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.openhome/'>Linn / Openhome</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.squeezebox/'>Logitech Squeezebox</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.ue_smart_radio/'>Logitech UE Smart Radio</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.mpchc/'>MPC-HC</a>
|
||
</li>
|
||
<li>
|
||
Media Extractor
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.monoprice/'>Monoprice 6-Zone Amplifier</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.nadtcp/'>NAD tcp</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.onkyo/'>Onkyo</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.liveboxplaytv/'>Orange Livebox Play TV</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/sensor.plex/'>Plex Activity Monitor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.roku/'>Roku</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.russound_rio/'>Russound RIO</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.spotify/'>Spotify</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.vizio/'>Vizio SmartCast TV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.volumio/'>Volumio Media Player</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.yamaha_musiccast/'>Yamaha MusicCast Receivers</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.yamaha/'>Yamaha Network Receivers</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.ziggo_mediabox_xl/'>Ziggo Mediabox XL</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.cmus/'>cmus</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.itunes/'>iTunes</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</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> (no support!).<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>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</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>
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
||
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
docsearch({
|
||
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
||
indexName: 'home-assistant',
|
||
inputSelector: '#search',
|
||
debug: false // Set debug to true if you want to inspect the dropdown
|
||
});
|
||
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'none';
|
||
});
|
||
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'block';
|
||
document.getElementById('toggle').checked = false;
|
||
document.querySelector('.search-container input').focus();
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|