ControlRoom PlugIn API

API for ControlRoom Hangout PlugIn

class hangout_api.gadgets.control_room.ControlRoom(base)

ControlRoom plugin for OnAir

audio(participant_name, mute=None)

Controls audio of OnAir participant. Allows to mute, un-mute or get current states of participant audio.

As arguments takes:

• participant_name - name of participant (‘Doe John’)
• mute - optional argument, takes True or False

In case if no mute argument was provided returns current state.

In case if no mute argument was provided returns:

• True - went to opposite state

  (from ‘on’ to ‘off’, or from ‘off’ to ‘on’)

• False -desired state was already chosen

>>> hangout.controlroom.audio('Doe John', mute=True)
True
>>> hangout.controlroom.audio('Doe John')
True
>>> hangout.controlroom.audio('Doe John', mute=True)
False
>>> hangout.controlroom.audio('Doe John', mute=False)
True
>>> hangout.controlroom.audio('Doe John')
False
>>> hangout.controlroom.audio('Doe John', mute=False)
False

video(participant_name, mute=None)

Controls video of OnAir participant. Allows to mute, un-mute or get current states of participant video.

As arguments takes:

• participant_name - name of participant (‘Doe John’)
• mute - optional argument, takes True or False

In case if no mute argument was provided returns current state.

In case if no mute argument was provided returns:

• True - went to opposite state

  (from ‘on’ to ‘off’, or from ‘off’ to ‘on’)

• False -desired state was already chosen

>>> hangout.controlroom.video('Doe John', mute=True)
True
>>> hangout.controlroom.video('Doe John')
True
>>> hangout.controlroom.video('Doe John', mute=True)
False
>>> hangout.controlroom.video('Doe John', mute=False)
True
>>> hangout.controlroom.video('Doe John')
False
>>> hangout.controlroom.video('Doe John', mute=False)
False

hangout_api.gadgets.control_room.get_status(controller)

returns status True or False from controller node, to get status it looks at ‘aria-pressed’ node attribute