Module pyControl4.room

Controls Control4 Room devices.

Classes

class C4Room (C4Director, item_id)

Expand source code

class C4Room(C4Entity):
    """
    A media-oriented view of a Control4 Room, supporting items of type="room"
    """

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

    async def isOn(self) -> bool:
        """Returns True/False if the room is "ON" from the director's perspective"""
        value = await self.director.getItemVariableValue(self.item_id, "POWER_STATE")
        return int(value) != 0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    async def getAudioDevices(self):
        """
        Note: As tested in OS 3.2.3 this doesn'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
        """
        await self.director.sendGetRequest(
            "/api/v1/locations/rooms/{}/audio_devices".format(self.item_id)
        )

    async def getVideoDevices(self):
        """
        Note: As tested in OS 3.2.3 this doesn'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
        """
        await self.director.sendGetRequest(
            "/api/v1/locations/rooms/{}/video_devices".format(self.item_id)
        )

A media-oriented view of a Control4 Room, supporting items of type="room"

Creates a Control4 object.

Parameters

C4Director - A C4Director object that corresponds to the Control4 Director that the device is connected to.

item_id - The Control4 item ID.

Ancestors

• C4Entity

Methods

async def getAudioDevices(self)

Expand source code

async def getAudioDevices(self):
    """
    Note: As tested in OS 3.2.3 this doesn'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
    """
    await self.director.sendGetRequest(
        "/api/v1/locations/rooms/{}/audio_devices".format(self.item_id)
    )

Note: As tested in OS 3.2.3 this doesn'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

async def getVideoDevices(self)

Expand source code

async def getVideoDevices(self):
    """
    Note: As tested in OS 3.2.3 this doesn'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
    """
    await self.director.sendGetRequest(
        "/api/v1/locations/rooms/{}/video_devices".format(self.item_id)
    )

Note: As tested in OS 3.2.3 this doesn'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

async def getVolume(self) ‑> int

Expand source code

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

Returns the current volume for the room from 0-100

async def isMuted(self) ‑> bool

Expand source code

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

Returns True if the room is muted

async def isOn(self) ‑> bool

Expand source code

async def isOn(self) -> bool:
    """Returns True/False if the room is "ON" from the director's perspective"""
    value = await self.director.getItemVariableValue(self.item_id, "POWER_STATE")
    return int(value) != 0

Returns True/False if the room is "ON" from the director's perspective

async def isRoomHidden(self) ‑> bool

Expand source code

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

Returns True if the room is hidden from the end-user

async def setAudioSource(self, source_id: int)

Expand source code

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

Sets the current audio source for the room

async def setDecrementVolume(self)

Expand source code

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

Decrease volume by 1

async def setIncrementVolume(self)

Expand source code

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

Decrease volume by 1

async def setMuteOff(self)

Expand source code

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

Unmute the room

async def setMuteOn(self)

Expand source code

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

Mute the room

async def setPause(self)

Expand source code

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

async def setPlay(self)

Expand source code

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

async def setRoomOff(self)

Expand source code

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

Turn the room "OFF"

async def setStop(self)

Expand source code

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

Stops the currently playing media but does not turn off the room

async def setVideoAndAudioSource(self, source_id: int)

Expand source code

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

Sets the current audio and video source for the room

async def setVolume(self, volume: int)

Expand source code

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

Set the room volume, 0-100

async def toggleMute(self)

Expand source code

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

Toggle the current mute state for the room