Scripts Fails to Open Track Rename Window

Hey Ben,
Without seeing all of the code in the referenced commands it won't be possible to see where things are going wrong.

The good news is @samuel_henriques wrote an excellent and blindingly fast script that will copy the track names of all selected tracks to the comments field. I use it constantly.

It also will clear the comments on selected tracks if you have the alt/option key held down.
(If you're using a keyboard trigger you'll need to assign two triggers this script to get the alt function - one without the alt key and one with.)

function setComments(hasAlt) {
    sf.ui.proTools.appActivateMainWindow()
    sf.ui.proTools.invalidate()

    //Get selected Tracks
    const selectedTracks = sf.ui.proTools.selectedTrackHeaders

    //Scrool to view first track
    selectedTracks[0].trackScrollToView()

    // Open rename window
    selectedTracks[0].popupButtons.first.mouseClickElement({ clickCount: 2 })

    // Wait for rename window
    sf.ui.proTools.windows.whoseTitle.is(selectedTracks[0].popupButtons.first.value.invalidate().value).first.elementWaitFor();

    //Get the elements of text fields and buttons 
    const [trackName, comments] = sf.ui.proTools.focusedWindow.invalidate().textFields.map(x => x)
    const [ok, cncl, pr, next] = sf.ui.proTools.focusedWindow.buttons.map(x => x)


    // Loop all tracks
    for (let i = 0; i < selectedTracks.length; i++) {

        if (hasAlt) {
            // Clear comments
            comments.elementSetTextFieldWithAreaValue({
                value: '',
            });
        } else {
            // Set track name in Cmments
            while (true) {
                if (trackName.value.invalidate().value != comments.value.invalidate().value) {
                    comments.elementSetTextFieldWithAreaValue({
                        value: trackName.value.invalidate().value,
                    });
                    sf.wait({ intervalMs: 5 })
                } else {
                    break;
                }
            };
        };
        // If its the last track press ok, else press next
        if (i === selectedTracks.length - 1) {
            ok.elementClick()
        } else {
            next.elementClick()
        };

    };
};



const hasAlt = event.keyboardState.hasAlt

setComments(hasAlt)

Hi Ben,

One thing I can see here (which speaks to the reliability of the script) is that you are using quite a few keyboard simulations here. That will generally be less reliable than using UI automation, which is what SoundFlow is focused on doing. It is encouraged that you avoid using keyboard/mouse simulation wherever possible. For example, tabbing to the next text field should be dropped in favor of the "Set Value of Text Field with Text Area" action. Copy/Paste actions should be handled using the "Menu Click" action rather than Cmd+C, etc. Moving between tracks in the Rename dialog should use the "Click UI Element" on the "Previous" or "Next" buttons, rather than using Cmd+Right.

It seems to be failing to open the Rename dialog. There is a known bug with Pro Tools 2022.9 where popup menus accessed at the bottom of the window (where you get the down arrow to scroll through the menu) will produce a weird UI bug. It does seem to affect SoundFlow's ability to read the menu items properly. This is a Pro Tools 2022.9 flaw, not a flaw in SoundFlow. This is the macro version of the workaround I've been using. You can insert this before the "OPEN TRACK RENAME ON SELECTED" command. This will scroll the track to the top of the window and allow the popup menu to function properly.

More fundamentally, the command you're using to open the Rename dialog in the first place doesn't open the rename dialog that allows for moving between tracks (if you right click the track and select "Rename...", you'll see there are no options for "Previous" or "Next"). That is likely causing instability as well. The Rename dialog you're looking for is the one you open by double-clicking the the track header, which can be accomplished using the "Mouse Click" action.

Hope this helps!

Hey Ben,

I took a look at the logs before my original response, so I can see what was happening at least the last time you ran the macro. In that instance, it seems like it failed due to the Pro Tools bug I mentioned. I don't see any other reason based on the available information. If you can share a screen recording of it failing that could help fill in some blanks.

Pro Tools not being focused when it should be, at least when using SoundFlow, for me has usually been the result of not activating the main window directly after the dialogs. This happens anytime there's a dialog or app open, since the OS does not recognize these as "focused" (you'll notice that the PT menus are still what appear at the top even when you're working in an SF app). You're in a tough spot because you're compiling commands that may not necessarily play well together.

I am now noticing that this is the dialog that comes up if you choose "rename..." from right-clicking on the track name, rather than double-clicking. But unless Im wrong, this script is supposed to do the double-click.