Extra Menu: Scriptables II

The Extra > Scriptables II menu provides commands typically used in scripting, for example via Macros or Python.

Click on the image to learn more

 

These commands were originally written for scripting Audacity, e.g via a Python script that uses mod-script-pipe. The commands though are also present in the menu, available from Macros, and available from within Nyquist using (aud-do "command")

Many of these commands have optional values. Where the dialog shows a checkbox 'Set', leaving the box unticked leaves the corresponding value unchanged. When using the same command in scripting, leaving the value out entirely has the same effect.

Select  

Selects audio. See the corresponding discussion on the Scriptables I page for what the various fields do.

Set Track 

Sets values for selected tracks. See the corresponding discussion on the Scriptables I page for what the various fields do.

Get Info  

Gets information in a list in one of three formats.

Message  

Used in testing. Sends the Text string back to you.

Help  

This is an extract from GetInfo Commands, with just one command.

Import  

Imports from an audio file. The automation command uses a text box to get the file name rather than a normal file-open dialog.

You have to give the full file name (including path and filename extension).

Export  

Exports to a file. When using Export2 you have to give the full file name (including path and filename extension).

• File Name: file name.
• Number of Channels: 1 for mono, 2 for stereo.

These two are for the future, a newer version with more options.

Exports to an audio file.

• Format: file format to use.
• Number of Channels:1 for mono, 2 for stereo.
• Options: these allow for fine tuning of the file format, and the options available depend on the file format chosen.
• Folder: path where the file should be exported to.
• File Name: the file name. This can use Automatic Names such as ${TRACK} to construct custom names that depend on what track or clip was exported.
• Overwrite existing file if ticked, files can be overwritten without warning. If not ticked, Audacity will add a number on to the end of the name, if the file being exported to already exists.

Next  

Coming soon...

Selects the next track, clip or label. This command also sets the appropriate Automatic Name, which is particularly useful with the Export command. The command can be configured to prompt when in a macro, to allow application of a macro to all tracks, clips, labels, in a project.

Open Project  

Opens an Audacity project.

Save Project  

Saves an Audacity project.

Move Mouse  

Experimental command (called Drag in scripting) that moves the mouse.
An Id can be used to move the mouse into a button to get the hover effect.
Window names can be used instead of Ids.
If To is specified, the command does a drag, otherwise just a hover.

This IS an experimental command, and it is tricky to use effectively. It is best to look at example scripts to see how it can be used.

Compare Audio  

Compares selected range on two tracks. Reports on the differences and similarities.

Screenshot (short format)  

A version of Help > Screenshot with a more minimal GUI. One of the most useful options is All_Tracks.
The _Plus suffix includes the timeline.

If you give a path, Audacity will provide a default filename. If you give a filename, Audacity will use that.