How to ensure that All Groups are suspended

Then you'd do like this:

The menuClickPopupMenu action returns a property menuWasClicked that tells you whether or not the action needed to click the menu item to get to the desired targetValue.

Inside the finally block I'm then checking to see, if the menu was clicked, it should be clicked again, this time disregarding any targetValue.

The try/finally block is there to make sure that even if the script fails inside the try block, it's always gonna run the finally block, and so even upon a failure, the Suspend state should be returned to normal.

sf.ui.proTools.groupsEnsureGroupListIsVisible();

var groupListPopup = sf.ui.proTools.groupsOpenListPopupMenu().popupMenu;
var menuWasClicked = groupListPopup.menuClickPopupMenu({
    menuPath: ["Suspend All Groups"],
    targetValue: 'Enable'
}).menuWasClicked;
sf.ui.proTools.appActivateMainWindow();

try {
    //Do something with groups suspended...

} finally {
    if (menuWasClicked) {
        groupListPopup.menuClickPopupMenu({
            menuPath: ["Suspend All Groups"]
        });
    }
}

Hi @chrscheuer,

I've been trying to use the doWithGroupsSuspended callback function as a part of a larger script;

function doWithGroupsSuspended(callback) {
    sf.ui.proTools.groupsEnsureGroupListIsVisible();

    var groupListPopup = sf.ui.proTools.groupsOpenListPopupMenu().popupMenu;
    var menuWasClicked = groupListPopup.menuClickPopupMenu({
        menuPath: ["Suspend All Groups"],
        targetValue: 'Enable'
    }).menuWasClicked;
    sf.ui.proTools.appActivateMainWindow();

    try {
        callback();
    } finally {
        if (menuWasClicked) {
            groupListPopup.menuClickPopupMenu({
                menuPath: ["Suspend All Groups"],
            });
        }
    }
}

doWithGroupsSuspended(function () {
    log('Test Log');
});

But I get this error;

10.11.2020 14:27:55.63 <info> [Backend]: #Key: ctrl+x  (7) -> TEST SCRIPT [ckhci226h0005wq10g46xe1kp]

10.11.2020 14:27:55.63 <info> [Backend]: >> Command: TEST SCRIPT [user:ckgsisa950009c110xlamn0jq:ckh3rxrhz000aw610yf08ycy2#ckh3rcyxr0005w610trwlwksj]

10.11.2020 14:27:55.71 <info> [Backend]: Clicking with mouse here: 219, 1112

10.11.2020 14:27:55.86 <info> [Backend]: PopupMenu full role:AXMenu

10.11.2020 14:27:55.86 <info> [Backend]: Clicking popup menu element: Suspend All Groups

10.11.2020 14:27:56.28 <info> [Backend]: Clicking with mouse here: 72, 30

10.11.2020 14:27:56.31 <info> [Backend]: [LOG] Test

10.11.2020 14:27:57.06 <info> [Backend]: Logging unknown error in action (02) ClickPopupMenuAction: kAXErrorInvalidUIElement
Logging unknown error in action (02) RunCommandAction: Setup: Track Name to Comments: Line 117
!! Command Error: TEST SCRIPT [user:ckgsisa950009c110xlamn0jq:ckh3rxrhz000aw610yf08ycy2#ckh3rcyxr0005w610trwlwksj]:
kAXErrorInvalidUIElement (Setup: Track Name to Comments: Line 117)
    SoundFlow.Shortcuts.AXUIElementException: kAXErrorInvalidUIElement
   at SoundFlow.Shortcuts.AXUIElement.GetSubElements(String) + 0x1a5
   at SoundFlow.Shortcuts.AXUIElement.GetPopupMenuPathRecursive(String[], List`1, Boolean&, Boolean) + 0x447
   at SoundFlow.Shortcuts.AXUIElement.GetPopupMenuPath(Boolean, String[]) + 0x4f
   at SoundFlow.Shortcuts.Automation.Actions.ClickPopupMenuAction.<Execute>d__16.MoveNext() + 0x69
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() + 0x1c
   at sfbackend!<BaseAddress>+0x168260b
   at sfbackend!<BaseAddress>+0x1682546
   at SoundFlow.Shortcuts.Automation.AutoAction`1.<Run>d__20.MoveNext() + 0x317

<< Command: TEST SCRIPT [user:ckgsisa950009c110xlamn0jq:ckh3rxrhz000aw610yf08ycy2#ckh3rcyxr0005w610trwlwksj]

Any thoughts on how to get around this?

Note: The error only occurs when "Suspend All Groups" is checked in the "Groups List Popup Menu" prior to running the script.

Thanks in advance!

Hi @Brett_Ryan_Stewart,

I think I have a function that does this already... I'll take a look and get back to you. :-)

Hi Brett_Ryan_Stewart,

Untested, but this should do the trick...

function doWithGroupsSuspended(callback) {
    sf.ui.proTools.groupsEnsureGroupListIsVisible();

    const groupListPopup = sf.ui.proTools.mainWindow.groupListPopupButton;
    var menuWasClicked = groupListPopup.popupMenuFetchAllItems().menuItems
        .filter(menuItem => menuItem.element.isMenuChecked)
        .filter(checkedItems => checkedItems.names.includes('Suspend All Groups')).length === 1;

    sf.ui.proTools.appActivateMainWindow();

    if (!menuWasClicked) {
        //Toggle Suspend All Groups via Groups List Popup menu.
        groupListPopup.popupMenuSelect({ menuPath: ["Suspend All Groups"], });

        //Toggle Suspend All Groups with Keyboard Shortcut
        //sf.keyboard.press({ keys: "cmd+shift+g", });
    }

    try {
        callback();
    } finally {
        if (!menuWasClicked) {
            //Toggle Suspend All Groups via Groups List Popup menu.
            groupListPopup.popupMenuSelect({ menuPath: ["Suspend All Groups"], });

            //Toggle Suspend All Groups with Keyboard Shortcut
            //sf.keyboard.press({ keys: "cmd+shift+g", });
        }
    }
}

function main() {
    sf.ui.proTools.mainWindow.elementRaise();

    /* //Calling command "Set Views: Edit Window - Main Area" from package "Kitch's Command Template Collection" (installed from user/pkg/version "uOwKfD26NbWKAWotin3dmnSne7B3/ckdt68led0000yz10dsi5hqgy/cklua4ezl0005gw10s4qp897s")
    sf.soundflow.runCommand({
        commandId: 'user:cky89mb710006mx10pbwr4gzx:ckdt9nmjb0005jw103ityzq5i',
        props: {
            viewInsertsAE: "Enable",
            viewInsertsFJ: "Enable",
            viewSendsAE: "Enable",
            viewSendsFJ: "Enable",
        }
    }); */

    //Calling command "!Remove Inactive Inserts ONLY" from package "Default Package"
    sf.soundflow.runCommand({
        commandId: 'package:ckyhvbsc10004tg10x77xsc1s',
        props: {}
    });

    /* //Calling command "Set Views: Edit Window - Main Area" from package "Kitch's Command Template Collection" (installed from user/pkg/version "uOwKfD26NbWKAWotin3dmnSne7B3/ckdt68led0000yz10dsi5hqgy/cklua4ezl0005gw10s4qp897s")
    sf.soundflow.runCommand({
        commandId: 'user:cky89mb710006mx10pbwr4gzx:ckdt9nmjb0005jw103ityzq5i',
        props: {
            viewInsertsAE: "Disable",
            viewInsertsFJ: "Disable",
            viewSendsAE: "Disable",
            viewSendsFJ: "Disable",
        }
    }); */

}

doWithGroupsSuspended(() => {
    main();
});

You can apply this to your other script by replacing the contents of the main function with your code.

Essentially what it does is runs all the code before the try section of the doWithGroupsSuspended then runs the callback (which is the main function), then finally once it completes that runs the finally block of the doWithGroupsSuspended function.

I hope that helps.

Rock on!