File: room.html

package info (click to toggle)
pycontrol4 1.5.0-1
links: PTS, VCS
area: main
in suites: forky, sid
size: 548 kB
sloc: python: 914; makefile: 2
file content (587 lines) | stat: -rw-r--r-- 28,210 bytes
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.6">
<title>pyControl4.room API documentation</title>
<meta name="description" content="Controls Control4 Room devices.">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>pyControl4.room</code></h1>
</header>
<section id="section-intro">
<p>Controls Control4 Room devices.</p>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="pyControl4.room.C4Room"><code class="flex name class">
<span>class <span class="ident">C4Room</span></span>
<span>(</span><span>C4Director, item_id)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class C4Room(C4Entity):
    &#34;&#34;&#34;
    A media-oriented view of a Control4 Room, supporting items of type=&#34;room&#34;
    &#34;&#34;&#34;

    async def isRoomHidden(self) -&gt; bool:
        &#34;&#34;&#34;Returns True if the room is hidden from the end-user&#34;&#34;&#34;
        value = await self.director.getItemVariableValue(self.item_id, &#34;ROOM_HIDDEN&#34;)
        return int(value) != 0

    async def isOn(self) -&gt; bool:
        &#34;&#34;&#34;Returns True/False if the room is &#34;ON&#34; from the director&#39;s perspective&#34;&#34;&#34;
        value = await self.director.getItemVariableValue(self.item_id, &#34;POWER_STATE&#34;)
        return int(value) != 0

    async def setRoomOff(self):
        &#34;&#34;&#34;Turn the room &#34;OFF&#34; &#34;&#34;&#34;
        await self.director.sendPostRequest(
            &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
            &#34;ROOM_OFF&#34;,
            {},
        )

    async def _setSource(self, source_id: int, audio_only: bool):
        &#34;&#34;&#34;
        Sets the room source, turning on the room if necessary.
        If audio_only, only the current audio device is changed
        &#34;&#34;&#34;
        await self.director.sendPostRequest(
            f&#34;/api/v1/items/{self.item_id}/commands&#34;,
            &#34;SELECT_AUDIO_DEVICE&#34; if audio_only else &#34;SELECT_VIDEO_DEVICE&#34;,
            {&#34;deviceid&#34;: source_id},
        )

    async def setAudioSource(self, source_id: int):
        &#34;&#34;&#34;Sets the current audio source for the room&#34;&#34;&#34;
        await self._setSource(source_id, audio_only=True)

    async def setVideoAndAudioSource(self, source_id: int):
        &#34;&#34;&#34;Sets the current audio and video source for the room&#34;&#34;&#34;
        await self._setSource(source_id, audio_only=False)

    async def getVolume(self) -&gt; int:
        &#34;&#34;&#34;Returns the current volume for the room from 0-100&#34;&#34;&#34;
        value = await self.director.getItemVariableValue(self.item_id, &#34;CURRENT_VOLUME&#34;)
        return int(value)

    async def isMuted(self) -&gt; bool:
        &#34;&#34;&#34;Returns True if the room is muted&#34;&#34;&#34;
        value = await self.director.getItemVariableValue(self.item_id, &#34;IS_MUTED&#34;)
        return int(value) != 0

    async def setMuteOn(self):
        &#34;&#34;&#34;Mute the room&#34;&#34;&#34;
        await self.director.sendPostRequest(
            &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
            &#34;MUTE_ON&#34;,
            {},
        )

    async def setMuteOff(self):
        &#34;&#34;&#34;Unmute the room&#34;&#34;&#34;
        await self.director.sendPostRequest(
            &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
            &#34;MUTE_OFF&#34;,
            {},
        )

    async def toggleMute(self):
        &#34;&#34;&#34;Toggle the current mute state for the room&#34;&#34;&#34;
        await self.director.sendPostRequest(
            &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
            &#34;MUTE_TOGGLE&#34;,
            {},
        )

    async def setVolume(self, volume: int):
        &#34;&#34;&#34;Set the room volume, 0-100&#34;&#34;&#34;
        await self.director.sendPostRequest(
            &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
            &#34;SET_VOLUME_LEVEL&#34;,
            {&#34;LEVEL&#34;: volume},
        )

    async def setIncrementVolume(self):
        &#34;&#34;&#34;Decrease volume by 1&#34;&#34;&#34;
        await self.director.sendPostRequest(
            &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
            &#34;PULSE_VOL_UP&#34;,
            {},
        )

    async def setDecrementVolume(self):
        &#34;&#34;&#34;Decrease volume by 1&#34;&#34;&#34;
        await self.director.sendPostRequest(
            &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
            &#34;PULSE_VOL_DOWN&#34;,
            {},
        )

    async def setPlay(self):
        await self.director.sendPostRequest(
            &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
            &#34;PLAY&#34;,
            {},
        )

    async def setPause(self):
        await self.director.sendPostRequest(
            &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
            &#34;PAUSE&#34;,
            {},
        )

    async def setStop(self):
        &#34;&#34;&#34;Stops the currently playing media but does not turn off the room&#34;&#34;&#34;
        await self.director.sendPostRequest(
            &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
            &#34;STOP&#34;,
            {},
        )

    async def getAudioDevices(self):
        &#34;&#34;&#34;
        Note: As tested in OS 3.2.3 this doesn&#39;t work, but may work in previous versions

        Get the audio devices located in the room.
        Note that this is literally the devices in the room,
        not necessarily all devices _playable_ in the room.
        See C4Director.getUiConfiguration for a more accurate list
        &#34;&#34;&#34;
        await self.director.sendGetRequest(
            &#34;/api/v1/locations/rooms/{}/audio_devices&#34;.format(self.item_id)
        )

    async def getVideoDevices(self):
        &#34;&#34;&#34;
        Note: As tested in OS 3.2.3 this doesn&#39;t work, but may work in previous versions

        Get the video devices located in the room.
        Note that this is literally the devices in the room,
        not necessarily all devices _playable_ in the room.
        See C4Director.getUiConfiguration for a more accurate list
        &#34;&#34;&#34;
        await self.director.sendGetRequest(
            &#34;/api/v1/locations/rooms/{}/video_devices&#34;.format(self.item_id)
        )</code></pre>
</details>
<div class="desc"><p>A media-oriented view of a Control4 Room, supporting items of type="room"</p>
<p>Creates a Control4 object.</p>
<h2 id="parameters">Parameters</h2>
<p><code>C4Director</code> - A <code><a title="pyControl4.director.C4Director" href="director.html#pyControl4.director.C4Director">C4Director</a></code> object that corresponds to the Control4 Director that the device is connected to.</p>
<p><code>item_id</code> - The Control4 item ID.</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="pyControl4.C4Entity" href="index.html#pyControl4.C4Entity">C4Entity</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="pyControl4.room.C4Room.getAudioDevices"><code class="name flex">
<span>async def <span class="ident">getAudioDevices</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def getAudioDevices(self):
    &#34;&#34;&#34;
    Note: As tested in OS 3.2.3 this doesn&#39;t work, but may work in previous versions

    Get the audio devices located in the room.
    Note that this is literally the devices in the room,
    not necessarily all devices _playable_ in the room.
    See C4Director.getUiConfiguration for a more accurate list
    &#34;&#34;&#34;
    await self.director.sendGetRequest(
        &#34;/api/v1/locations/rooms/{}/audio_devices&#34;.format(self.item_id)
    )</code></pre>
</details>
<div class="desc"><p>Note: As tested in OS 3.2.3 this doesn't work, but may work in previous versions</p>
<p>Get the audio devices located in the room.
Note that this is literally the devices in the room,
not necessarily all devices <em>playable</em> in the room.
See C4Director.getUiConfiguration for a more accurate list</p></div>
</dd>
<dt id="pyControl4.room.C4Room.getVideoDevices"><code class="name flex">
<span>async def <span class="ident">getVideoDevices</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def getVideoDevices(self):
    &#34;&#34;&#34;
    Note: As tested in OS 3.2.3 this doesn&#39;t work, but may work in previous versions

    Get the video devices located in the room.
    Note that this is literally the devices in the room,
    not necessarily all devices _playable_ in the room.
    See C4Director.getUiConfiguration for a more accurate list
    &#34;&#34;&#34;
    await self.director.sendGetRequest(
        &#34;/api/v1/locations/rooms/{}/video_devices&#34;.format(self.item_id)
    )</code></pre>
</details>
<div class="desc"><p>Note: As tested in OS 3.2.3 this doesn't work, but may work in previous versions</p>
<p>Get the video devices located in the room.
Note that this is literally the devices in the room,
not necessarily all devices <em>playable</em> in the room.
See C4Director.getUiConfiguration for a more accurate list</p></div>
</dd>
<dt id="pyControl4.room.C4Room.getVolume"><code class="name flex">
<span>async def <span class="ident">getVolume</span></span>(<span>self) ‑> int</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def getVolume(self) -&gt; int:
    &#34;&#34;&#34;Returns the current volume for the room from 0-100&#34;&#34;&#34;
    value = await self.director.getItemVariableValue(self.item_id, &#34;CURRENT_VOLUME&#34;)
    return int(value)</code></pre>
</details>
<div class="desc"><p>Returns the current volume for the room from 0-100</p></div>
</dd>
<dt id="pyControl4.room.C4Room.isMuted"><code class="name flex">
<span>async def <span class="ident">isMuted</span></span>(<span>self) ‑> bool</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def isMuted(self) -&gt; bool:
    &#34;&#34;&#34;Returns True if the room is muted&#34;&#34;&#34;
    value = await self.director.getItemVariableValue(self.item_id, &#34;IS_MUTED&#34;)
    return int(value) != 0</code></pre>
</details>
<div class="desc"><p>Returns True if the room is muted</p></div>
</dd>
<dt id="pyControl4.room.C4Room.isOn"><code class="name flex">
<span>async def <span class="ident">isOn</span></span>(<span>self) ‑> bool</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def isOn(self) -&gt; bool:
    &#34;&#34;&#34;Returns True/False if the room is &#34;ON&#34; from the director&#39;s perspective&#34;&#34;&#34;
    value = await self.director.getItemVariableValue(self.item_id, &#34;POWER_STATE&#34;)
    return int(value) != 0</code></pre>
</details>
<div class="desc"><p>Returns True/False if the room is "ON" from the director's perspective</p></div>
</dd>
<dt id="pyControl4.room.C4Room.isRoomHidden"><code class="name flex">
<span>async def <span class="ident">isRoomHidden</span></span>(<span>self) ‑> bool</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def isRoomHidden(self) -&gt; bool:
    &#34;&#34;&#34;Returns True if the room is hidden from the end-user&#34;&#34;&#34;
    value = await self.director.getItemVariableValue(self.item_id, &#34;ROOM_HIDDEN&#34;)
    return int(value) != 0</code></pre>
</details>
<div class="desc"><p>Returns True if the room is hidden from the end-user</p></div>
</dd>
<dt id="pyControl4.room.C4Room.setAudioSource"><code class="name flex">
<span>async def <span class="ident">setAudioSource</span></span>(<span>self, source_id: int)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setAudioSource(self, source_id: int):
    &#34;&#34;&#34;Sets the current audio source for the room&#34;&#34;&#34;
    await self._setSource(source_id, audio_only=True)</code></pre>
</details>
<div class="desc"><p>Sets the current audio source for the room</p></div>
</dd>
<dt id="pyControl4.room.C4Room.setDecrementVolume"><code class="name flex">
<span>async def <span class="ident">setDecrementVolume</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setDecrementVolume(self):
    &#34;&#34;&#34;Decrease volume by 1&#34;&#34;&#34;
    await self.director.sendPostRequest(
        &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
        &#34;PULSE_VOL_DOWN&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"><p>Decrease volume by 1</p></div>
</dd>
<dt id="pyControl4.room.C4Room.setIncrementVolume"><code class="name flex">
<span>async def <span class="ident">setIncrementVolume</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setIncrementVolume(self):
    &#34;&#34;&#34;Decrease volume by 1&#34;&#34;&#34;
    await self.director.sendPostRequest(
        &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
        &#34;PULSE_VOL_UP&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"><p>Decrease volume by 1</p></div>
</dd>
<dt id="pyControl4.room.C4Room.setMuteOff"><code class="name flex">
<span>async def <span class="ident">setMuteOff</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setMuteOff(self):
    &#34;&#34;&#34;Unmute the room&#34;&#34;&#34;
    await self.director.sendPostRequest(
        &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
        &#34;MUTE_OFF&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"><p>Unmute the room</p></div>
</dd>
<dt id="pyControl4.room.C4Room.setMuteOn"><code class="name flex">
<span>async def <span class="ident">setMuteOn</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setMuteOn(self):
    &#34;&#34;&#34;Mute the room&#34;&#34;&#34;
    await self.director.sendPostRequest(
        &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
        &#34;MUTE_ON&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"><p>Mute the room</p></div>
</dd>
<dt id="pyControl4.room.C4Room.setPause"><code class="name flex">
<span>async def <span class="ident">setPause</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setPause(self):
    await self.director.sendPostRequest(
        &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
        &#34;PAUSE&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="pyControl4.room.C4Room.setPlay"><code class="name flex">
<span>async def <span class="ident">setPlay</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setPlay(self):
    await self.director.sendPostRequest(
        &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
        &#34;PLAY&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="pyControl4.room.C4Room.setRoomOff"><code class="name flex">
<span>async def <span class="ident">setRoomOff</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setRoomOff(self):
    &#34;&#34;&#34;Turn the room &#34;OFF&#34; &#34;&#34;&#34;
    await self.director.sendPostRequest(
        &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
        &#34;ROOM_OFF&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"><p>Turn the room "OFF"</p></div>
</dd>
<dt id="pyControl4.room.C4Room.setStop"><code class="name flex">
<span>async def <span class="ident">setStop</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setStop(self):
    &#34;&#34;&#34;Stops the currently playing media but does not turn off the room&#34;&#34;&#34;
    await self.director.sendPostRequest(
        &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
        &#34;STOP&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"><p>Stops the currently playing media but does not turn off the room</p></div>
</dd>
<dt id="pyControl4.room.C4Room.setVideoAndAudioSource"><code class="name flex">
<span>async def <span class="ident">setVideoAndAudioSource</span></span>(<span>self, source_id: int)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setVideoAndAudioSource(self, source_id: int):
    &#34;&#34;&#34;Sets the current audio and video source for the room&#34;&#34;&#34;
    await self._setSource(source_id, audio_only=False)</code></pre>
</details>
<div class="desc"><p>Sets the current audio and video source for the room</p></div>
</dd>
<dt id="pyControl4.room.C4Room.setVolume"><code class="name flex">
<span>async def <span class="ident">setVolume</span></span>(<span>self, volume: int)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setVolume(self, volume: int):
    &#34;&#34;&#34;Set the room volume, 0-100&#34;&#34;&#34;
    await self.director.sendPostRequest(
        &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
        &#34;SET_VOLUME_LEVEL&#34;,
        {&#34;LEVEL&#34;: volume},
    )</code></pre>
</details>
<div class="desc"><p>Set the room volume, 0-100</p></div>
</dd>
<dt id="pyControl4.room.C4Room.toggleMute"><code class="name flex">
<span>async def <span class="ident">toggleMute</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def toggleMute(self):
    &#34;&#34;&#34;Toggle the current mute state for the room&#34;&#34;&#34;
    await self.director.sendPostRequest(
        &#34;/api/v1/items/{}/commands&#34;.format(self.item_id),
        &#34;MUTE_TOGGLE&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"><p>Toggle the current mute state for the room</p></div>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="pyControl4" href="index.html">pyControl4</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="pyControl4.room.C4Room" href="#pyControl4.room.C4Room">C4Room</a></code></h4>
<ul class="">
<li><code><a title="pyControl4.room.C4Room.getAudioDevices" href="#pyControl4.room.C4Room.getAudioDevices">getAudioDevices</a></code></li>
<li><code><a title="pyControl4.room.C4Room.getVideoDevices" href="#pyControl4.room.C4Room.getVideoDevices">getVideoDevices</a></code></li>
<li><code><a title="pyControl4.room.C4Room.getVolume" href="#pyControl4.room.C4Room.getVolume">getVolume</a></code></li>
<li><code><a title="pyControl4.room.C4Room.isMuted" href="#pyControl4.room.C4Room.isMuted">isMuted</a></code></li>
<li><code><a title="pyControl4.room.C4Room.isOn" href="#pyControl4.room.C4Room.isOn">isOn</a></code></li>
<li><code><a title="pyControl4.room.C4Room.isRoomHidden" href="#pyControl4.room.C4Room.isRoomHidden">isRoomHidden</a></code></li>
<li><code><a title="pyControl4.room.C4Room.setAudioSource" href="#pyControl4.room.C4Room.setAudioSource">setAudioSource</a></code></li>
<li><code><a title="pyControl4.room.C4Room.setDecrementVolume" href="#pyControl4.room.C4Room.setDecrementVolume">setDecrementVolume</a></code></li>
<li><code><a title="pyControl4.room.C4Room.setIncrementVolume" href="#pyControl4.room.C4Room.setIncrementVolume">setIncrementVolume</a></code></li>
<li><code><a title="pyControl4.room.C4Room.setMuteOff" href="#pyControl4.room.C4Room.setMuteOff">setMuteOff</a></code></li>
<li><code><a title="pyControl4.room.C4Room.setMuteOn" href="#pyControl4.room.C4Room.setMuteOn">setMuteOn</a></code></li>
<li><code><a title="pyControl4.room.C4Room.setPause" href="#pyControl4.room.C4Room.setPause">setPause</a></code></li>
<li><code><a title="pyControl4.room.C4Room.setPlay" href="#pyControl4.room.C4Room.setPlay">setPlay</a></code></li>
<li><code><a title="pyControl4.room.C4Room.setRoomOff" href="#pyControl4.room.C4Room.setRoomOff">setRoomOff</a></code></li>
<li><code><a title="pyControl4.room.C4Room.setStop" href="#pyControl4.room.C4Room.setStop">setStop</a></code></li>
<li><code><a title="pyControl4.room.C4Room.setVideoAndAudioSource" href="#pyControl4.room.C4Room.setVideoAndAudioSource">setVideoAndAudioSource</a></code></li>
<li><code><a title="pyControl4.room.C4Room.setVolume" href="#pyControl4.room.C4Room.setVolume">setVolume</a></code></li>
<li><code><a title="pyControl4.room.C4Room.toggleMute" href="#pyControl4.room.C4Room.toggleMute">toggleMute</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
</footer>
</body>
</html>