Lag when pressing Stream Deck Advanced Locations

Title

Lag when pressing Stream Deck Advanced Locations

What do you expect to happen when you run the script/macro?

I currently have three presets I've set up within the Advanced Memory Locations Template. CLICK, NOISE and POP. Whenever I press these on my Stream Deck within big session they are very slow to load within Pro Tools. I have a lag of around 10/12 seconds.

However, if I add a memory location manaully it's super fast. The problem does not persist in smaller sessions.

Thanks in advance
Peter

Are you seeing an error?

What happens when you run this script?

When I press the button on Stream Deck to activate the macros, it's as if I haven't pressed anything. There's a delay of around 10/12 seconds before the memory location appears.

How were you running this script?

I used a Stream Deck button

How important is this issue to you?

5

Details

{
    "inputExpected": "I currently have three presets I've set up within the Advanced Memory Locations Template. CLICK, NOISE and POP. Whenever I press these on my Stream Deck within big session they are very slow to load within Pro Tools. I have a lag of around 10/12 seconds.\n\nHowever, if I add a memory location manaully it's super fast. The problem does not persist in smaller sessions.\n\nThanks in advance\nPeter",
    "inputIsError": false,
    "inputWhatHappens": "When I press the button on Stream Deck to activate the macros, it's as if I haven't pressed anything. There's a delay of around 10/12 seconds before the memory location appears.",
    "inputHowRun": {
        "key": "-MpfwmPg-2Sb-HxHQAff",
        "title": "I used a Stream Deck button"
    },
    "inputImportance": 5,
    "inputTitle": "Lag when pressing Stream Deck Advanced Locations"
}

Source

const { cueText } = event.props;
const isMemLocWinOpened = sf.ui.proTools.getMenuItem('Window', 'Memory Locations').isMenuChecked
const memoryLocations = sf.proTools.memoryLocationsFetchFromGui().collection.list.filter(x => x.name.match(cueText))
const modifierState = event.keyboardState.asString

/**
 * @param {object} obj
 * @param {string} obj.name
 */
function createMemoryLocationsMarker({ name }) {

    sf.ui.proTools.appActivateMainWindow();
    const dlg = sf.ui.proTools.newMemoryLocationDialog;
    if (!dlg.exists) {
        sf.keyboard.press({ keys: "numpad enter" });
    }

    dlg.elementWaitFor();
    dlg.radioButtons.whoseTitle.is("Marker").first.elementClick();
    dlg.textFields.allItems[1].elementSetTextFieldWithAreaValue({
        value: name,
    });

    dlg.buttons.whoseTitle.is("OK").first.elementClick();
    dlg.elementWaitFor({ waitType: "Disappear", });

}

function paste(memoryLocations) {

    sf.ui.proTools.memoryLocationsGoto({
        memoryLocationNumber: memoryLocations.number
    })
    sf.ui.proTools.menuClick({ menuPath: ["Edit", "Paste"] })
}

function clearMemoryLocations(name) {


    // //  Open mem loc win
    sf.ui.proTools.memoryLocationsShowWindow()

    // Get Memory Locations including...
    const memoryLocations = sf.proTools.memoryLocationsFetch().collection['List'].filter(m => m.name.includes(name))

    // Clear found
    memoryLocations.forEach(memLoc => {
        sf.ui.proTools.memoryLocationsGoto({ memoryLocationNumber: memLoc.number })
        sf.ui.proTools.memoryLocationsWindow.popupButtons.first.popupMenuSelect({ menuPath: ['Clear*'], useWildcards: true });
    });

    ///alert(`Cleared All Memory Locations Names Including: \n\n                       - ${name} -`)

};

function goToNextMatchedMemoryLocation(locationName) {
    let currentTimecode = sf.ui.proTools.getCurrentTimecode().stringValue;

    //  if main counter is bars beats, remove last three digits, since memory locations list ignores them
    currentTimecode.match(/\|/) ? currentTimecode = currentTimecode.slice(0, -3) : null;

    let cleanMainCounter = Number(currentTimecode.replace(/[^0-9]/g, '').trim());

    const memoryLocations = sf.proTools.memoryLocationsFetch().collection["list"].filter(x =>
        Number(x.mainCounterValue.replace(/[^0-9]/g, '').trim()) > cleanMainCounter && x.name.match(locationName)
    );

    try {
        sf.ui.proTools.memoryLocationsGoto({ memoryLocationNumber: memoryLocations[0].number });
    } catch (err) {
        log(`End of location markers containing:\n${locationName}`);
    }
}

function getPreviousMatchedMemoryLocation(locationName) {

    let mainCounter = sf.ui.proTools.getCurrentTimecode().stringValue

    //  if main counter is bars beats, remove last three digits, since memory locations list ignores them
    mainCounter.match(/\|/) ? mainCounter = mainCounter.slice(0, -3) : null

    let cleanMainCounter = Number(mainCounter.replace(/[^0-9]/g, '').trim())

    const memoryLocations = sf.proTools.memoryLocationsFetch().collection["list"].filter(x =>
        Number(x.mainCounterValue.replace(/[^0-9]/g, '').trim()) < cleanMainCounter &&
        x.name.match(locationName)
    ).reverse();

    try {
        sf.ui.proTools.memoryLocationsGoto({
            memoryLocationNumber: memoryLocations[0].number
        });
    } catch (err) { log(`End of location markers containing:\n${locationName}`) }
}

/** Counts the amount of times this function is called during a fixed amount of time 
 * and passes that value to a callback from which different actions can take place.
 * @param {object} args
 * @param {string} args.name - Name for this instance.
 * @param {number} args.waitTime - Amount of time to wait in milliseconds. 
 * @param {function} args.action - Callback to execute when the waitTime is over. Counter value will be passed as an argument.
 */
function actionCounter({ name, waitTime, action }) {
    let actionCounter;

    if (!globalState.actionCounter) globalState.actionCounter = {};
    actionCounter = globalState.actionCounter;

    if (!actionCounter[name]) {
        actionCounter[name] = {
            dateMs: (new Date).valueOf(),
            i: 1
        };
    } else {
        actionCounter[name].i++
        return;
    }

    sf.engine.runInBackground(() => {
        sf.wait({ intervalMs: waitTime, executionMode: "Background" });
        try {
            action(actionCounter[name].i);
        } finally {
            delete globalState.actionCounter
        }
    });
}

function main() {
    
    if (globalState.toggleCreateOrGoTo == undefined || globalState.toggleCreateOrGoTo === true) {

        switch (modifierState) {
            case "cmd":
                memoryLocations.forEach(paste)
                break
            case "":
                createMemoryLocationsMarker({
                    name: cueText,
                });
                break
            case "shift":
                clearMemoryLocations(cueText)
                break
        };
    }

    if (globalState.toggleCreateOrGoTo === false) {
        switch (modifierState) {
            case "cmd":
                memoryLocations.forEach(paste)
                break
            case "":
                actionCounter({
                    name: 'memoryLocaitonFowardorBackwards',
                    waitTime: 500,
                    action: i => {
                        switch (i) {
                            case 1:
                                goToNextMatchedMemoryLocation(cueText)
                                break;
                            case 2:
                                getPreviousMatchedMemoryLocation(cueText)
                                break;
                        }
                    }
                });
                break
            case "shift":
                clearMemoryLocations(cueText)
                break
        };
    }
    // Set initial state of Mem Loc Win
    if (!isMemLocWinOpened) {
        sf.ui.proTools.menuClick({ menuPath: ['Window', 'Memory Locations'], targetValue: "Disable" })
    };
}

main()

---

Links

User UID: Xm0t8L8vbddwUSfY4G9a7IsOZqt2

Feedback Key: sffeedback:Xm0t8L8vbddwUSfY4G9a7IsOZqt2:-N0e3kwp7dhu2U_q8JiZ

Feedback ZIP