315 lines
15 KiB
HTML
315 lines
15 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>Gstreamer - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions on how to integrate Gstreamer into Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/media_player.gstreamer/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Gstreamer">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/media_player.gstreamer/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions on how to integrate Gstreamer 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="Gstreamer">
|
||
<meta name="twitter:description" content="Instructions on how to integrate Gstreamer into 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="/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>
|
||
</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">
|
||
Gstreamer
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">gstreamer</code> platform allows you to play audio via a <a href="https://gstreamer.freedesktop.org/">gstreamer</a> pipeline. Practically, this means you can play audio directly on the computer running Home Assistant. It is particularly suited for playing TTS. Advanced users can specify a pipeline to transform the audio stream and/or redirect it elsewhere.</p>
|
||
<p>To add a <code class="highlighter-rouge">gstreamer</code> media player to 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_player</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">gstreamer</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>name</strong> (<em>Optional</em>): Name the player.</li>
|
||
<li><strong>pipeline</strong> (<em>Optional</em>): <code class="highlighter-rouge">gst</code> pipeline description.</li>
|
||
</ul>
|
||
<p>Only the <code class="highlighter-rouge">music</code> media type is supported.</p>
|
||
<h2><a class="title-link" name="setup" href="#setup"></a> Setup</h2>
|
||
<p>And then install the following system dependencies:</p>
|
||
<p>Debian/Ubuntu/Rasbian:</p>
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>sudo apt-get install python3-gst-1.0 <span class="se">\</span>
|
||
gir1.2-gstreamer-1.0 gir1.2-gst-plugins-base-1.0 <span class="se">\</span>
|
||
gstreamer1.0-plugins-good gstreamer1.0-plugins-ugly <span class="se">\</span>
|
||
gstreamer1.0-tools
|
||
</code></pre>
|
||
</div>
|
||
<p>Red Hat/Centos/Fedora:</p>
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>sudo yum install -y python-gstreamer1 gstreamer1-plugins-good <span class="se">\</span>
|
||
gstreamer1-plugins-ugly
|
||
</code></pre>
|
||
</div>
|
||
<p>For Fedora replace <code class="highlighter-rouge">yum</code> with <code class="highlighter-rouge">dnf</code>.</p>
|
||
<p>If you’re running Home Assistant in a virtual environment, you’ll need to symlink the system Python’s <code class="highlighter-rouge">gi</code> module into your virtual environment:</p>
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>ln -s /path/to/your/installation/of/gi /path/to/your/venv/lib/python3.4/site-packages
|
||
</code></pre>
|
||
</div>
|
||
<p>On a Raspberry PI, you may need to add the Home Assistant user to the <code class="highlighter-rouge">audio</code> group:</p>
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>sudo usermod -a -G audio <ha_user>
|
||
</code></pre>
|
||
</div>
|
||
<h2><a class="title-link" name="example-usage" href="#example-usage"></a> Example Usage</h2>
|
||
<h3><a class="title-link" name="using-with-tts" href="#using-with-tts"></a> Using with TTS</h3>
|
||
<p>To play TTS on your local computer (for example, if you have speakers attached to your Raspberry PI:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">media_player</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">gstreamer</span>
|
||
|
||
<span class="s">script</span><span class="pi">:</span>
|
||
<span class="s">tts</span><span class="pi">:</span>
|
||
<span class="s">sequence</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">tts.google_say</span> <span class="c1"># or amazon_polly, voicerss, etc</span>
|
||
<span class="s">data</span><span class="pi">:</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">media_player.gstreamer</span>
|
||
<span class="s">message</span><span class="pi">:</span> <span class="s2">"</span><span class="s">example</span><span class="nv"> </span><span class="s">text-to-speech</span><span class="nv"> </span><span class="s">message"</span>
|
||
</code></pre>
|
||
</div>
|
||
<h3><a class="title-link" name="using-with-snapcast" href="#using-with-snapcast"></a> Using with Snapcast</h3>
|
||
<p>To play to a named pipe for consumption by Snapcast:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">media_player</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">gstreamer</span>
|
||
<span class="s">pipeline</span><span class="pi">:</span> <span class="s2">"</span><span class="s">audioresample</span><span class="nv"> </span><span class="s">!</span><span class="nv"> </span><span class="s">audioconvert</span><span class="nv"> </span><span class="s">!</span><span class="nv"> </span><span class="s">audio/x-raw,rate=48000,channels=2,format=S16LE</span><span class="nv"> </span><span class="s">!</span><span class="nv"> </span><span class="s">wavenc</span><span class="nv"> </span><span class="s">!</span><span class="nv"> </span><span class="s">filesink</span><span class="nv"> </span><span class="s">location=/tmp/snapcast_gstreamer"</span>
|
||
</code></pre>
|
||
</div>
|
||
</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.gstreamer.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/gstreamer.png' />
|
||
</div>
|
||
<div class='section'>
|
||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Push
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.39
|
||
</div>
|
||
<div class='section'>
|
||
This is a platform for
|
||
<a href='/components/media_player/'>the Media Player component</a>.
|
||
</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</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.clementine/'>Clementine Music Player</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>
|
||
Gstreamer
|
||
</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.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.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_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.volumio/'>Volumio Media Player</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>
|
||
</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>
|
||
</body>
|
||
</html>
|