home-assistant.github.io/components/media_player.vlc/index.html
2017-01-18 07:52:01 +00:00

303 lines
No EOL
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>VLC - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how to integrate VLC media player into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/media_player.vlc/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="VLC">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/media_player.vlc/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on how to integrate VLC media player 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="VLC">
<meta name="twitter:description" content="Instructions on how to integrate VLC media player 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="/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">
VLC
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">vlc</code> platform allows you to control <a href="http://www.videolan.org/vlc/index.html">VLC media player</a>.</p>
<p>To add a VLC 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">vlc</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): The name to use in the frontend.</li>
<li><strong>arguments</strong> (<em>Optional</em>): Additional arguments to be passed to VLC.</li>
</ul>
<p>Only “music” media type is supported for now.</p>
<p>This service will control a background VLC instance, therefore you cannot use this to control a VLC instance launched on your desktop, unlike the Kodi media player for example.</p>
<h2><a class="title-link" name="full-configuration" href="#full-configuration"></a> Full configuration</h2>
<p>A full configuration for VLC could llok like the one below:</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">vlc</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">speaker_1</span>
<span class="s">arguments</span><span class="pi">:</span> <span class="s1">'</span><span class="s">--alsa-audio-device=hw:1,0'</span>
</code></pre>
</div>
<h5><a class="title-link" name="additional-configuration-on-macos" href="#additional-configuration-on-macos"></a> Additional configuration on macOS</h5>
<p>On macOS phython-vlc wont find the VLC plugin directory unless you add this to the users <code class="highlighter-rouge">.bash_profile</code> that is running Home Assistant:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="nb">export </span><span class="nv">VLC_PLUGIN_PATH</span><span class="o">=</span><span class="nv">$VLC_PLUGIN_PATH</span>:/Applications/VLC.app/Contents/MacOS/plugins
</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.vlc.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/videolan.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 Polling
</div>
<div class='section'>
Introduced in release: 0.35
</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.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/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.universal/'>Universal</a>
</li>
<li>
VLC
</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>.<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>