Site updated at 2016-10-04 08:54:28 UTC

This commit is contained in:
Travis CI 2016-10-04 08:54:28 +00:00
parent ea47716da2
commit 85dddf9230
24 changed files with 84 additions and 88 deletions

View file

@ -97,40 +97,40 @@
<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="s">platform</span><span class="pi">:</span> <span class="s">universal</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">MEDIA_PLAYER_NAME</span>
<span class="s">children</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">media_player.CHILD_1_ID</span>
<span class="pi">-</span> <span class="s">media_player.CHILD_2_ID</span>
<span class="s">commands</span><span class="pi">:</span>
<span class="s">turn_on</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">SERVICE</span>
<span class="s">data</span><span class="pi">:</span> <span class="s">SERVICE_DATA</span>
<span class="s">turn_off</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">SERVICE</span>
<span class="s">data</span><span class="pi">:</span> <span class="s">SERVICE_DATA</span>
<span class="s">volume_up</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">SERVICE</span>
<span class="s">data</span><span class="pi">:</span> <span class="s">SERVICE_DATA</span>
<span class="s">volume_down</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">SERVICE</span>
<span class="s">data</span><span class="pi">:</span> <span class="s">SERVICE_DATA</span>
<span class="s">volume_mute</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">SERVICE</span>
<span class="s">data</span><span class="pi">:</span> <span class="s">SERVICE_DATA</span>
<span class="s">attributes</span><span class="pi">:</span>
<span class="s">is_volume_muted</span><span class="pi">:</span> <span class="s">ENTITY_ID|ATTRIBUTE</span>
<span class="s">state</span><span class="pi">:</span> <span class="s">ENTITY_ID|ATTRIBUTE</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">universal</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">MEDIA_PLAYER_NAME</span>
<span class="s">children</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">media_player.CHILD_1_ID</span>
<span class="pi">-</span> <span class="s">media_player.CHILD_2_ID</span>
<span class="s">commands</span><span class="pi">:</span>
<span class="s">turn_on</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">SERVICE</span>
<span class="s">data</span><span class="pi">:</span> <span class="s">SERVICE_DATA</span>
<span class="s">turn_off</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">SERVICE</span>
<span class="s">data</span><span class="pi">:</span> <span class="s">SERVICE_DATA</span>
<span class="s">volume_up</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">SERVICE</span>
<span class="s">data</span><span class="pi">:</span> <span class="s">SERVICE_DATA</span>
<span class="s">volume_down</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">SERVICE</span>
<span class="s">data</span><span class="pi">:</span> <span class="s">SERVICE_DATA</span>
<span class="s">volume_mute</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">SERVICE</span>
<span class="s">data</span><span class="pi">:</span> <span class="s">SERVICE_DATA</span>
<span class="s">attributes</span><span class="pi">:</span>
<span class="s">is_volume_muted</span><span class="pi">:</span> <span class="s">ENTITY_ID|ATTRIBUTE</span>
<span class="s">state</span><span class="pi">:</span> <span class="s">ENTITY_ID|ATTRIBUTE</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong>: The name to assign the player</li>
<li><strong>children</strong>: Ordered list of child media players this entity will control</li>
<li><strong>commands</strong> <em>Optional</em>: Commands to be overwritten. Possible entries are <em>turn_on</em>, <em>turn_off</em>, <em>volume_up</em>, <em>volume_down</em>, and <em>volume_mute</em>.</li>
<li><strong>attributes</strong> <em>Optional</em>: Attributes that can be overwritten. Possible entries are <em>is_volume_muted</em> and <em>state</em>. The values should be an entity id and state attribute separated by a bar (|). If the entity ids state should be used, then only the entity id should be provided.</li>
<li><strong>name</strong> (<em>Required</em>): The name to assign the player</li>
<li><strong>children</strong> (<em>Required</em>): Ordered list of child media players this entity will control</li>
<li><strong>commands</strong> (<em>Optional</em>): Commands to be overwritten. Possible entries are <em>turn_on</em>, <em>turn_off</em>, <em>volume_up</em>, <em>volume_down</em>, and <em>volume_mute</em>.</li>
<li><strong>attributes</strong> (<em>Optional</em>): Attributes that can be overwritten. Possible entries are <em>is_volume_muted</em> and <em>state</em>. The values should be an entity id and state attribute separated by a bar (|). If the entity ids state should be used, then only the entity id should be provided.</li>
</ul>
<p>The universal media player will primarily imitate one of its <em>children</em>. The first child in the list that is active (not idle/off) will be controlled the universal media player. The universal media player will also inherit its state from the first active child. Entities in the <em>children</em> list must be media players.</p>