ToggleMonitorRole.js

/********************************************************
Copyright (c) 2024 Cisco and/or its affiliates.
This software is licensed to you under the terms of the Cisco Sample
Code License, Version 1.1 (the "License"). You may obtain a copy of the
License at
               https://developer.cisco.com/docs/licenses
All use of the material herein must be in accordance with the terms of
the License. All rights not expressly granted by the License are
reserved. Unless required by applicable law or agreed to separately in
writing, software distributed under the License is distributed on an "AS
IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied.

*********************************************************

 * Author(s):               Gerardo Chaves
 *                          Solutions Engineer
 *                          Cisco Systems
 *                          gchaves@cisco.com
 * 
 * 
 * Released: April 22, 2025
 * 
 * Version 1.0.0
 * 
 * Description: 
 *    - Implements a custom panel button to toggle the monitor role of a specific monitor
 * 
 * Tested Devices
 *     - Codec Pro
*/

import xapi from 'xapi';

// set the ID of the microphone to toggle below
const MonitorId = '2'

const button_color_red = '#D43B52'
const button_color_green = '#1D805F'

async function init() {
    console.log({ Message: `Intializing Macro [${_main_macro_name()}...]` })
    await buildUI()
    await StartSubscriptions()

    console.log({ Message: `Macro [${_main_macro_name()}] initialization Complete!` })
}


//Iterates over the Subscribe Object
async function StartSubscriptions() {
    const subs = Object.getOwnPropertyNames(Subscribe);
    subs.sort();
    let mySubscriptions = [];
    subs.forEach(element => {
        Subscribe[element]();
        mySubscriptions.push(element);
        Subscribe[element] = function () {
            console.warn({ Warn: `The [${element}] subscription is already active, unable to fire it again` });
        };
    });
    console.log({ Message: 'Subscriptions Set', Details: { Total_Subs: subs.length, Active_Subs: mySubscriptions.join(', ') } });
};


//Define all Event/Status subscriptions needed for the macro
const Subscribe = {
    PanelClicked: function () { xapi.Event.UserInterface.Extensions.Panel.Clicked.on(handle.Event.PanelClicked) }
}

const handle = {
    Event: {
        PanelClicked: function (event) {
            console.log(event.PanelId)
            if (event.PanelId == 'toggle_role_mode') {
                ToggleMode();
            }
        }
    }
}

function delay(ms) { return new Promise(resolve => { setTimeout(resolve, ms) }) }


async function ToggleMode() {
    console.log({ Message: `Toggle Mode ${MonitorId}` })
    //const current_value = await xapi.Config.Audio.Input.Microphone[1].Mode.get()
    //console.log({ Message: `Current Mode ${MonitorId} current value: ${current_value}` })

    const current_value = await xapi.Config.Video.Output.Connector[parseInt(MonitorId)].MonitorRole.get()
    console.log({ Message: `Current Monitor ${MonitorId} mode current value: ${current_value}` })


    let toggle_value = ''
    let tog_color = ''
    if (current_value == 'First') { toggle_value = 'Second' } else { toggle_value = 'First' };

    if (current_value == 'First') {
        toggle_value = 'Second';
        tog_color = button_color_red;
    }
    else {
        toggle_value = 'First';
        tog_color = button_color_green;
    };

    console.log({ Message: `Setting Mode ${MonitorId} to : ${toggle_value}` })
    //await xapi.Config.Audio.Input.Microphone[1].Mode.set(toggle_value);
    await xapi.Config.Video.Output.Connector[parseInt(MonitorId)].MonitorRole.set(toggle_value);
    await xapi.Command.UserInterface.Extensions.Panel.Update({ PanelId: 'toggle_role_mode', Name: `Monitor${MonitorId} turn ${current_value}`, Color: tog_color });

}

async function buildUI() {
    console.log({ Message: `Building UserInterface...` })


    // delete any previous action buttons
    let customPanelsList = (await xapi.Command.UserInterface.Extensions.List({ ActivityType: 'Custom' }))?.Extensions.Panel;

    if (customPanelsList != undefined) {
        customPanelsList.forEach(async panel => {
            if (panel.PanelId.substring(0, 16) == "toggle_role_mode") {
                await xapi.Command.UserInterface.Extensions.Panel.Remove({ PanelId: panel.PanelId });
                console.log('removed previous panel: ', panel.PanelId)
            }
        })
    }

    // get current state of mic to toggle
    //const current_value = await xapi.Config.Audio.Input.Microphone[1].Mode.get()
    const current_value = await xapi.Config.Video.Output.Connector[parseInt(MonitorId)].MonitorRole.get()

    console.log({ Message: `Current Monitor ${MonitorId} Mode current value: ${current_value}` })
    let tog_state = ''
    let tog_color = ''
    if (current_value == 'First') {
        tog_state = 'First';
        tog_color = button_color_green;
    }
    else {
        tog_state = 'Second';
        tog_color = button_color_red;
    };




    //build  action buttons
    let actionButton_xml = ``
    actionButton_xml = `<Extensions>
        <Version>1.10</Version>
        <Panel>
          <Order>1</Order>
          <PanelId>$toggle_role_mode</PanelId>
          <Origin>local</Origin>
          <Location>HomeScreenAndCallControls</Location>
          <Icon>Tv</Icon>
          <Color>${tog_color}</Color> 
          <Name>Monitor${MonitorId} turn ${tog_state}</Name>
          <ActivityType>Custom</ActivityType>
        </Panel>
      </Extensions>`
    await xapi.Command.UserInterface.Extensions.Panel.Save({ PanelId: 'toggle_role_mode' }, actionButton_xml)
    console.log({ Message: `UserInterface Built!` })
}

init()