mirror of
https://github.com/audacity/audacity-manual.git
synced 2025-12-16 04:22:00 -06:00
4682 lines
172 KiB
HTML
4682 lines
172 KiB
HTML
<!DOCTYPE html>
|
|
<html class="client-nojs" lang="en" dir="ltr">
|
|
<head>
|
|
<meta charset="UTF-8"/>
|
|
<title>Scripting Reference - Audacity Manual</title>
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="ResourceLoaderDynamicStyles" content=""/>
|
|
|
|
<meta name="generator" content="MediaWiki 1.28.2"/>
|
|
<link rel="shortcut icon" href="../favicon.ico"/>
|
|
<link rel="search" type="application/opensearchdescription+xml" href="https://alphamanual.audacityteam.org/m/opensearch_desc.php" title="Audacity Development Manual (en)"/>
|
|
<link rel="EditURI" type="application/rsd+xml" href="https://alphamanual.audacityteam.org/m/api.php?action=rsd"/>
|
|
<link rel="copyright" href="http://creativecommons.org/licenses/by/3.0/"/>
|
|
|
|
<link rel="stylesheet" href="../m/skins/monobook/main.css/303.css" media="screen" />
|
|
</head>
|
|
<body class="mediawiki ltr sitedir-ltr mw-hide-empty-elt ns-0 ns-subject page-Scripting_Reference rootpage-Scripting_Reference skin-monobook action-view"><div id="globalWrapper">
|
|
<div id="column-content">
|
|
<div id="content" class="mw-body" role="main">
|
|
<a id="top"></a>
|
|
|
|
<div class="mw-indicators">
|
|
</div>
|
|
<h1 id="firstHeading" class="firstHeading" lang="en">Scripting Reference</h1>
|
|
|
|
<div id="bodyContent" class="mw-body-content">
|
|
<div id="siteSub">From Audacity Development Manual</div>
|
|
<div id="contentSub"></div>
|
|
<div id="jump-to-nav" class="mw-jump">Jump to: <a href="#column-one">navigation</a>, <a href="https://alphamanual.audacityteam.org/man/Scripting_Reference#searchInput">search</a></div>
|
|
|
|
|
|
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr"><p><br />
|
|
</p>
|
|
|
|
<div class="intro">This page lists scripting commands.
|
|
<p><b>Yes</b> these are the same commands as in the <a href="menu_reference.html" title="Menu Reference">menus</a>, same as in <a href="keyboard_shortcut_reference.html" title="Keyboard Shortcut Reference">"Commands and Shortcuts"</a> too, just presented differently.
|
|
</p>
|
|
<ul><li> Presented in a format useful to people using:
|
|
<ul><li> <a href="macros.html" title="Macros">Macros</a> or </li>
|
|
<li> Python <a href="scripting.html" title="Scripting">Scripting</a> or </li>
|
|
<li> <a href="nyquist_macros.html" title="Nyquist-Macros">AUD-DO</a>.</li></ul></li>
|
|
<li> Most of this page is automatically generated.</li></ul>
|
|
<div class="note">A few commands are intentionally omitted from the Macro Manager (such as "Close:") because they are unsuitable for use in Macros.</div></div><div style="margin-top:12px; margin-bottom:12px; margin-left:24px; margin-right:24px">
|
|
<table style="background:#FEFFD0; color:black; border:1px solid #999999; padding-left:12px; padding-right:12px" width="100%" align="center">
|
|
|
|
<tr>
|
|
<td width="30px" valign="top" align="center"><img alt="Advice" src="../m/images/b/ba/warningicon.png" title="Advice" width="24" height="24" />
|
|
</td>
|
|
<td align="left" valign="top"> This table shows the items in the menus that are scriptable.
|
|
<ul><li> The Scripting Ids, parameters and defaults are all likely to change between versions.</li>
|
|
<li> Boolean values must be given as <b>1</b> (true) or <b>0</b> (false).</li></ul>
|
|
</td></tr></table></div>
|
|
<div id="file_menu"></div>
|
|
<h2><span class="mw-headline" id="File_Menu"><a href="file_menu.html" title="File Menu">File Menu</a></span></h2>
|
|
<div class="note">The File Menu provides commands for creating, opening and saving Audacity projects and importing and exporting audio files </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>New:</b>
|
|
</td>
|
|
<td><a href="file_menu.html#new" title="File Menu">New</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Creates a new empty project window, to start working on new or imported tracks.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Open:</b>
|
|
</td>
|
|
<td><a href="file_menu.html#open" title="File Menu">Open</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Presents a standard dialog box where you can select either audio files, a list of files (.LOF) or an Audacity Project file to open.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Close:</b>
|
|
</td>
|
|
<td><a href="file_menu.html#close" title="File Menu">Close</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Closes the current project window, prompting you to save your work if you have not saved.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SaveProject:</b>
|
|
</td>
|
|
<td><a href="file_menu.html#save_project" title="File Menu">Save Project</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Various ways to save a project.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ExportAudio:</b>
|
|
</td>
|
|
<td><a href="file_menu.html#export_audio" title="File Menu">Export Audio</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Export audio files in various formats.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PageSetup:</b>
|
|
</td>
|
|
<td><a href="file_menu.html#page_setup" title="File Menu">Page Setup</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Opens the standard Page Setup dialog box prior to printing
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Print:</b>
|
|
</td>
|
|
<td><a href="file_menu.html#print" title="File Menu">Print</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Prints all the waveforms in the current project window (and the contents of Label Tracks or other tracks), with the Timeline above. Everything is printed to one page.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Exit:</b>
|
|
</td>
|
|
<td><a href="file_menu.html#exit" title="File Menu">Exit</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Closes all project windows and exits Audacity. If there are any unsaved changes to your project, Audacity will ask if you want to save them.
|
|
</td></tr></table>
|
|
<div id="file_save_project_submenu"></div>
|
|
<h3><span class="mw-headline" id="File:_Save_Project"><a href="file_menu_save_project.html" title="File Menu: Save Project">File: Save Project</a></span></h3>
|
|
<div class="note">Various ways to save a project. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Save:</b>
|
|
</td>
|
|
<td><a href="file_menu_save_project.html#save_project" title="File Menu: Save Project">Save Project</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Saves the current Audacity project .AUP3 file.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SaveAs:</b>
|
|
</td>
|
|
<td><a href="file_menu_save_project.html#save_project_as" title="File Menu: Save Project">Save Project As</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as "Save Project" above, but allows you to save a copy of an open project to a different name or location
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SaveCopy:</b>
|
|
</td>
|
|
<td><a href="file_menu_save_project.html#save_lossless_copy_of_project" title="File Menu: Save Project">Save Lossless Copy of Project</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Saves the current Audacity project .AUP3 file.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SaveCompressed:</b>
|
|
</td>
|
|
<td><a href="file_menu_save_project.html#save_compressed_copy_of_project" title="File Menu: Save Project">Save Compressed Copy of Project</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Saves in the audacity .aup3 project file format, but compressed (Suitable for mailing)
|
|
</td></tr></table>
|
|
<div id="file_export_submenu"></div>
|
|
<h3><span class="mw-headline" id="File:_Export_Other"><a href="file_menu_export_other.html" title="File Menu: Export Other">File: Export Other</a></span></h3>
|
|
<div class="note">For exporting audio files </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>ExportLabels:</b>
|
|
</td>
|
|
<td><a href="file_menu_export_other.html#export_labels" title="File Menu: Export Other">Export Labels</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Exports audio at one or more labels to file(s).
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ExportMIDI:</b>
|
|
</td>
|
|
<td><a href="file_menu_export_other.html#export_midi" title="File Menu: Export Other">Export MIDI</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Exports MIDI (note tracks) to a MIDI file.
|
|
</td></tr></table>
|
|
<div id="file_import_submenu"></div>
|
|
<h3><span class="mw-headline" id="File:_Import"><a href="file_menu_import.html" title="File Menu: Import">File: Import</a></span></h3>
|
|
<div class="note">For importing audio files or label files into your project </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>ImportAudio:</b>
|
|
</td>
|
|
<td><a href="file_menu_import.html#audio" title="File Menu: Import">Audio</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Similar to 'Open', except that the file is added as a new track to your existing project.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ImportLabels:</b>
|
|
</td>
|
|
<td><a href="file_menu_import.html#labels" title="File Menu: Import">Labels</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Launches a file selection window where you can choose to <i>import</i> a single text file into the project containing point or region <a href="label_tracks.html" title="Label Tracks">labels</a>. For more information about the syntax for labels files, see <a href="label_tracks.html#export" title="Label Tracks">Importing and Exporting Labels</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ImportMIDI:</b>
|
|
</td>
|
|
<td><a href="file_menu_import.html#midi" title="File Menu: Import">MIDI</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Imports a <i><b><a href="glossary.html#midi" title="Glossary">MIDI</a></b></i> (MIDI or MID <i><b><a href="glossary.html#extension" title="Glossary">extension</a></b></i>) or Allegro (GRO) file to a <a href="note_tracks.html" title="Note Tracks">Note Track</a> where simple cut-and-paste edits can be performed. The result can be exported with the <span class="menu">File > Export> > <a href="file_menu_export.html#export_midi" title="File Menu: Export">Export MIDI</a></span> command. <b>Note:</b> Currently, MIDI and Allegro files cannot be played.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ImportRaw:</b>
|
|
</td>
|
|
<td><a href="file_menu_import.html#raw_data" title="File Menu: Import">Raw Data</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Attempts to import an uncompressed audio file that might be "raw" data without any headers to define its format, might have incorrect headers or be otherwise partially corrupted, or might be in a format that Audacity is unable to recognize. Raw data in textual format cannot be imported.
|
|
</td></tr></table>
|
|
<div id="edit_menu"></div>
|
|
<h2><span class="mw-headline" id="Edit_Menu"><a href="edit_menu.html" title="Edit Menu">Edit Menu</a></span></h2>
|
|
<div class="note">The Edit Menu provides standard edit commands (Undo, Redo, Cut, Copy, Paste and Delete) plus many other commands specific to editing audio or labels </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Undo:</b>
|
|
</td>
|
|
<td><a href="edit_menu.html#undo" title="Edit Menu">Undo</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Undoes the most recent editing action.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Redo:</b>
|
|
</td>
|
|
<td><a href="edit_menu.html#redo" title="Edit Menu">Redo</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Redoes the most recently undone editing action.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Cut:</b>
|
|
</td>
|
|
<td><a href="edit_menu.html#cut" title="Edit Menu">Cut</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Removes the selected audio data and/or labels and places these on the Audacity clipboard. By default, any audio or labels to right of the selection are shifted to the left.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Delete:</b>
|
|
</td>
|
|
<td><a href="edit_menu.html#delete" title="Edit Menu">Delete</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Removes the selected audio data and/or labels without copying these to the Audacity clipboard. By default, any audio or labels to right of the selection are shifted to the left.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Copy:</b>
|
|
</td>
|
|
<td><a href="edit_menu.html#copy" title="Edit Menu">Copy</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Copies the selected audio data to the Audacity clipboard without removing it from the project.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Paste:</b>
|
|
</td>
|
|
<td><a href="edit_menu.html#paste" title="Edit Menu">Paste</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Inserts whatever is on the Audacity clipboard at the position of the selection cursor in the project, replacing whatever audio data is currently selected, if any.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Duplicate:</b>
|
|
</td>
|
|
<td><a href="edit_menu.html#duplicate" title="Edit Menu">Duplicate</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Creates a new track containing only the current selection as a new clip.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>EditMetaData:</b>
|
|
</td>
|
|
<td><a href="edit_menu.html#metadata" title="Edit Menu">Metadata</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>The Metadata Editor modifies information about a track, such as the artist and genre. Typically used with MP3 files.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Preferences:</b>
|
|
</td>
|
|
<td><a href="edit_menu.html#preferences" title="Edit Menu">Preferences</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Preferences let you change most of the default behaviors and settings of Audacity. On Mac, Preferences are in the <a href="audacity_menu.html" title="Audacity Menu">Audacity Menu</a> and the default shortcut is <span class="kbrd" style="background-color: #d0d0f8">⌘ + ,</span>.
|
|
</td></tr></table>
|
|
<div id="edit_remove_special_submenu"></div>
|
|
<h3><span class="mw-headline" id="Edit:_Remove_Special"><a href="edit_menu_remove_special.html" title="Edit Menu: Remove Special">Edit: Remove Special</a></span></h3>
|
|
</li></ul>
|
|
<div class="note">For more "advanced" removal of audio </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>SplitCut:</b>
|
|
</td>
|
|
<td><a href="edit_menu_remove_special.html#split_cut" title="Edit Menu: Remove Special">Split Cut</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as Cut, but none of the audio data or labels to right of the selection are shifted.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SplitDelete:</b>
|
|
</td>
|
|
<td><a href="edit_menu_remove_special.html#split_delete" title="Edit Menu: Remove Special">Split Delete</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as Delete, but none of the audio data or labels to right of the selection are shifted.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Silence:</b>
|
|
</td>
|
|
<td><a href="edit_menu_remove_special.html#silence_audio" title="Edit Menu: Remove Special">Silence Audio</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Replaces the currently selected audio with absolute silence. Does not affect label tracks.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Trim:</b>
|
|
</td>
|
|
<td><a href="edit_menu_remove_special.html#trim_audio" title="Edit Menu: Remove Special">Trim Audio</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Deletes all audio but the selection. If there are other separate <a href="audacity_tracks_and_clips.html" title="Audacity Tracks and Clips">clips</a> in the same track these are not removed or shifted unless trimming the entire length of a clip or clips. Does not affect label tracks.
|
|
</td></tr></table>
|
|
<div id="edit_clip_boundaries_submenu"></div>
|
|
<h3><span class="mw-headline" id="Edit:_Clip_Boundaries"><a href="edit_menu_clip_boundaries.html" title="Edit Menu: Clip Boundaries">Edit: Clip Boundaries</a></span></h3>
|
|
</li></ul>
|
|
<div class="note">Create or remove separate clips in the audio track. A clip inside an audio track is a separate section of that track which has been split so that it can be manipulated somewhat independently of the other clips in the track. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Split:</b>
|
|
</td>
|
|
<td><a href="edit_menu_clip_boundaries.html#split" title="Edit Menu: Clip Boundaries">Split</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Splits the current clip into two clips at the cursor point, or into three clips at the selection boundaries.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SplitNew:</b>
|
|
</td>
|
|
<td><a href="edit_menu_clip_boundaries.html#split_new" title="Edit Menu: Clip Boundaries">Split New</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Does a Split Cut on the current selection in the current track, then creates a new track and pastes the selection into the new track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Join:</b>
|
|
</td>
|
|
<td><a href="edit_menu_clip_boundaries.html#join" title="Edit Menu: Clip Boundaries">Join</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>If you select an area that overlaps one or more clips, they are all joined into one large clip. Regions in-between clips become silence.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Disjoin:</b>
|
|
</td>
|
|
<td><a href="edit_menu_clip_boundaries.html#detach_at_silences" title="Edit Menu: Clip Boundaries">Detach at Silences</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>In a selection region that includes absolute silences, creates individual non-silent clips between the regions of silence. The silence becomes blank space between the clips.
|
|
</td></tr></table>
|
|
<div id="edit_labels_submenu"></div>
|
|
<h3><span class="mw-headline" id="Edit:_Labels"><a href="edit_menu_labels.html" title="Edit Menu: Labels">Edit: Labels</a></span></h3>
|
|
<div class="note">These commands are to add and edit labels. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>EditLabels:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labels.html#edit_labels" title="Edit Menu: Labels">Label Editor</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Brings up a dialog box showing all of your labels in a keyboard-accessible tabular view. Handy buttons in the dialog let you insert or delete a label, or import and export labels to a file. See <a href="labels_editor.html" title="Labels Editor">Label Editor</a> for more details.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>AddLabel:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labels.html#add_label_at_selection" title="Edit Menu: Labels">Add Label at Selection</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Creates a new, empty label at the cursor or at the selection region.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>AddLabelPlaying:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labels.html#add_label_at_playback_position" title="Edit Menu: Labels">Add Label at Playback Position</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Creates a new, empty label at the current playback or recording position.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PasteNewLabel:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labels.html#paste_text_to_new_label" title="Edit Menu: Labels">Paste Text to New Label</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Pastes the text on the Audacity clipboard at the cursor position in the currently selected label track. If there is no selection in the label track a point label is created. If a region is selected in the label track a region label is created. If no label track is selected one is created, and a new label is created.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TypeToCreateLabel:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labels.html#type_to_create_a_label_onoff" title="Edit Menu: Labels">Type to Create a Label (on/off)</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When a label track has the colored focus border, if this option is on, just type to create a label. Otherwise you must create a label first.
|
|
</td></tr></table>
|
|
<div id="edit_labeled_audio_submenu"></div>
|
|
<h3><span class="mw-headline" id="Edit:_Labeled_Audio"><a href="edit_menu_labeled_audio.html" title="Edit Menu: Labeled Audio">Edit: Labeled Audio</a></span></h3>
|
|
</li></ul>
|
|
<div class="note">Labeled Audio commands apply standard Edit Menu commands to the audio of one or more regions that are labeled. The labels themselves are not affected. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>CutLabels:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labeled_audio.html#cut" title="Edit Menu: Labeled Audio">Cut</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as the Cut command, but operates on labeled audio regions.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>DeleteLabels:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labeled_audio.html#delete" title="Edit Menu: Labeled Audio">Delete</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as the Delete command, but operates on labeled audio regions.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SplitCutLabels:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labeled_audio.html#split_cut" title="Edit Menu: Labeled Audio">Split Cut</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as the Split Cut command, but operates on labeled audio regions.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SplitDeleteLabels:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labeled_audio.html#split_delete" title="Edit Menu: Labeled Audio">Split Delete</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as the Split Delete command, but operates on labeled audio regions.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SilenceLabels:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labeled_audio.html#silence_audio" title="Edit Menu: Labeled Audio">Silence Audio</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as the Silence Audio command, but operates on labeled audio regions.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CopyLabels:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labeled_audio.html#copy" title="Edit Menu: Labeled Audio">Copy</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as the Copy command, but operates on labeled audio regions.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SplitLabels:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labeled_audio.html#split" title="Edit Menu: Labeled Audio">Split</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as the Split command, but operates on labeled audio regions or points.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>JoinLabels:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labeled_audio.html#join" title="Edit Menu: Labeled Audio">Join</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as the Join command, but operates on labeled audio regions or points. You may need to select the audio and use <span class="menu">Edit > Clip Boundaries > <a href="edit_menu_clip_boundaries.html#join" title="Edit Menu: Clip Boundaries">Join</a></span>, to join all regions or points.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>DisjoinLabels:</b>
|
|
</td>
|
|
<td><a href="edit_menu_labeled_audio.html#detach_at_silences" title="Edit Menu: Labeled Audio">Detach at Silences</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as the Detach at Silences command, but operates on labeled audio regions.
|
|
</td></tr></table>
|
|
<div id="select_menu"></div>
|
|
<h2><span class="mw-headline" id="Select_Menu"><a href="select_menu.html" title="Select Menu">Select Menu</a></span></h2>
|
|
<div class="note">Select Menu has commands that enable you make selections of tracks or parts of the tracks in your project. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>SelectAll:</b>
|
|
</td>
|
|
<td><a href="select_menu.html#all" title="Select Menu">All</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selects all of the audio in all of the tracks.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelectNone:</b>
|
|
</td>
|
|
<td><a href="select_menu.html#none" title="Select Menu">None</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Deselects all of the audio in all of the tracks.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelCursorStoredCursor:</b>
|
|
</td>
|
|
<td><a href="select_menu.html#cursor_to_stored_cursor_position" title="Select Menu">Cursor to Stored Cursor Position</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selects from the position of the cursor to the previously stored cursor position
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>StoreCursorPosition:</b>
|
|
</td>
|
|
<td><a href="select_menu.html#store_cursor_position" title="Select Menu">Store Cursor Position</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Stores the current cursor position for use in a later selection
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ZeroCross:</b>
|
|
</td>
|
|
<td><a href="select_menu.html#at_zero_crossings" title="Select Menu">At Zero Crossings</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the edges of a selection region (or the cursor position) slightly so they are at a rising zero crossing point.
|
|
</td></tr></table>
|
|
<div id="select_tracks_submenu"></div>
|
|
<h3><span class="mw-headline" id="Select:_Tracks"><a href="select_menu_tracks.html" title="Select Menu: Tracks">Select: Tracks</a></span></h3>
|
|
<div class="note">Tracks </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>SelAllTracks:</b>
|
|
</td>
|
|
<td><a href="select_menu_tracks.html#in_all_tracks" title="Select Menu: Tracks">In All Tracks</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Extends the current selection up and/or down into all tracks in the project.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelSyncLockTracks:</b>
|
|
</td>
|
|
<td><a href="select_menu_tracks.html#in_all_synclocked_tracks" title="Select Menu: Tracks">In All Sync-Locked Tracks</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Extends the current selection up and/or down into all sync-locked tracks in the currently selected track group.
|
|
</td></tr></table>
|
|
<div id="select_region_submenu"></div>
|
|
<h3><span class="mw-headline" id="Select:_Region"><a href="select_menu_region.html" title="Select Menu: Region">Select: Region</a></span></h3>
|
|
<div class="note">For modifying, saving and restoring a selection. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>SetLeftSelection:</b>
|
|
</td>
|
|
<td><a href="select_menu_region.html#left_at_playback_position" title="Select Menu: Region">Left at Playback Position</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When Audacity is playing, recording or paused, sets the left boundary of a potential selection by moving the cursor to the current position of the green playback cursor (or red recording cursor).<p> Otherwise, opens the "Set Left Selection Boundary" dialog for adjusting the time position of the left-hand selection boundary. If there is no selection, moving the time digits backwards creates a selection ending at the former cursor position, and moving the time digits forwards provides a way to move the cursor forwards to an exact point. </p>
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SetRightSelection:</b>
|
|
</td>
|
|
<td><a href="select_menu_region.html#right_at_playback_position" title="Select Menu: Region">Right at Playback Position</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When Audacity is playing, recording or paused, sets the right boundary of the selection, thus drawing the selection from the cursor position to the current position of the green playback cursor (or red recording cursor). <p> Otherwise, opens the "Set Right Selection Boundary" dialog for adjusting the time position of the right-hand selection boundary. If there is no selection, moving the time digits forwards creates a selection starting at the former cursor position, and moving the time digits backwards provides a way to move the cursor backwards to an exact point. </p>
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelTrackStartToCursor:</b>
|
|
</td>
|
|
<td><a href="select_menu_region.html#track_start_to_cursor" title="Select Menu: Region">Track Start to Cursor</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selects a region in the selected track(s) from the start of the track to the cursor position.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelCursorToTrackEnd:</b>
|
|
</td>
|
|
<td><a href="select_menu_region.html#cursor_to_track_end" title="Select Menu: Region">Cursor to Track End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selects a region in the selected track(s) from the cursor position to the end of the track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelTrackStartToEnd:</b>
|
|
</td>
|
|
<td><a href="select_menu_region.html#track_start_to_end" title="Select Menu: Region">Track Start to End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selects a region in the selected track(s) from the start of the track to the end of the track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelSave:</b>
|
|
</td>
|
|
<td><a href="select_menu_region.html#store_selection" title="Select Menu: Region">Store Selection</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Stores the end points of a selection for later reuse.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelRestore:</b>
|
|
</td>
|
|
<td><a href="select_menu_region.html#retrieve_selection" title="Select Menu: Region">Retrieve Selection</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Retrieves the end points of a previously stored selection.
|
|
</td></tr></table>
|
|
<div id="select_spectral_submenu"></div>
|
|
<h3><span class="mw-headline" id="Select:_Spectral"><a href="select_menu_spectral.html" title="Select Menu: Spectral">Select: Spectral</a></span></h3>
|
|
<div class="note">For making a selection of a frequency range. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>ToggleSpectralSelection:</b>
|
|
</td>
|
|
<td><a href="select_menu_spectral.html#toggle_spectral_selection" title="Select Menu: Spectral">Toggle Spectral Selection</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Changes between selecting a time range and selecting the last selected <a href="spectral_selection.html" title="Spectral Selection">spectral selection</a> in that time range. This command toggles the spectral selection even if not in Spectrogram view, but you must be in Spectrogram view to use the spectral selection in one of the <a href="effect_menu.html#spectral_multi" title="Effect Menu">Spectral edit</a> effects.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NextHigherPeakFrequency:</b>
|
|
</td>
|
|
<td><a href="select_menu_spectral.html#next_higher_peak_frequency" title="Select Menu: Spectral">Next Higher Peak Frequency</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When in Spectrogram view, snaps the center frequency to the next higher frequency peak, moving the spectral selection upwards.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NextLowerPeakFrequency:</b>
|
|
</td>
|
|
<td><a href="select_menu_spectral.html#next_lower_peak_frequency" title="Select Menu: Spectral">Next Lower Peak Frequency</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When in Spectrogram views snaps the center frequency to the next lower frequency peak, moving the spectral selection downwards.
|
|
</td></tr></table>
|
|
<div id="select_clip_boundaries_submenu"></div>
|
|
<h3><span class="mw-headline" id="Select:_Clip_Boundaries"><a href="select_menu_clip_boundaries.html" title="Select Menu: Clip Boundaries">Select: Clip Boundaries</a></span></h3>
|
|
<div class="note">For modifying a selection, taking account of clips. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>SelPrevClipBoundaryToCursor:</b>
|
|
</td>
|
|
<td><a href="select_menu_clip_boundaries.html#previous_clip_boundary_to_cursor" title="Select Menu: Clip Boundaries">Previous Clip Boundary to Cursor</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selects from the current cursor position back to the right-hand edge of the previous clip.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelCursorToNextClipBoundary:</b>
|
|
</td>
|
|
<td><a href="select_menu_clip_boundaries.html#cursor_to_next_clip_boundary" title="Select Menu: Clip Boundaries">Cursor to Next Clip Boundary</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selects from the current cursor position forward to the left-hand edge of the next clip.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelPrevClip:</b>
|
|
</td>
|
|
<td><a href="select_menu_clip_boundaries.html#previous_clip" title="Select Menu: Clip Boundaries">Previous Clip</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the selection to the previous clip.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelNextClip:</b>
|
|
</td>
|
|
<td><a href="select_menu_clip_boundaries.html#next_clip" title="Select Menu: Clip Boundaries">Next Clip</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the selection to the next clip.
|
|
</td></tr></table>
|
|
<div id="view_menu"></div>
|
|
<h2><span class="mw-headline" id="View_Menu"><a href="view_menu.html" title="View Menu">View Menu</a></span></h2>
|
|
<div class="note">View Menu has commands that determine the amount of detail you see in all the tracks in the project window. It also lets you show or hide Toolbars and some additional windows such as Undo History. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>UndoHistory:</b>
|
|
</td>
|
|
<td><a href="view_menu.html#history" title="View Menu">History</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Brings up the History window which can then be left open while using Audacity normally. History lists all undoable actions performed in the current project, including importing.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Karaoke:</b>
|
|
</td>
|
|
<td><a href="view_menu.html#karaoke" title="View Menu">Karaoke</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Brings up the Karaoke window, which displays the labels in a "bouncing ball" scrolling display
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>MixerBoard:</b>
|
|
</td>
|
|
<td><a href="view_menu.html#mixer_board" title="View Menu">Mixer</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Mixer is an alternative view to the audio tracks in the main tracks window. Analogous to a hardware mixer board, each audio track is displayed in a Track Strip.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowExtraMenus:</b>
|
|
</td>
|
|
<td><a href="view_menu.html#extra_menus_onoff" title="View Menu">Extra Menus (on/off)</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Shows extra menus with many extra less-used commands.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowClipping:</b>
|
|
</td>
|
|
<td><a href="view_menu.html#show_clipping_onoff" title="View Menu">Show Clipping in Waveform</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Option to show or not show audio that is too loud (in red) on the wave form.
|
|
</td></tr></table>
|
|
<div id="view_zoom_submenu"></div>
|
|
<h3><span class="mw-headline" id="View:_Zoom"><a href="view_menu_zoom.html" title="View Menu: Zoom">View: Zoom</a></span></h3>
|
|
<div class="note">Zoom in/out on the horizontal axis. Show more detail or show a longer length of time. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>ZoomIn:</b>
|
|
</td>
|
|
<td><a href="view_menu_zoom.html#zoom_in" title="View Menu: Zoom">Zoom In</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Zooms in on the horizontal axis of the audio displaying more detail over a shorter length of time.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ZoomNormal:</b>
|
|
</td>
|
|
<td><a href="view_menu_zoom.html#zoom_normal" title="View Menu: Zoom">Zoom Normal</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Zooms to the default view which displays about one inch per second.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ZoomOut:</b>
|
|
</td>
|
|
<td><a href="view_menu_zoom.html#zoom_out" title="View Menu: Zoom">Zoom Out</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Zooms out displaying less detail over a greater length of time.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ZoomSel:</b>
|
|
</td>
|
|
<td><a href="view_menu_zoom.html#zoom_to_selection" title="View Menu: Zoom">Zoom to Selection</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Zooms in or out so that the selected audio fills the width of the window.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ZoomToggle:</b>
|
|
</td>
|
|
<td><a href="view_menu_zoom.html#zoom_toggle" title="View Menu: Zoom">Zoom Toggle</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Changes the zoom back and forth between two preset levels.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>AdvancedVZoom:</b>
|
|
</td>
|
|
<td><a href="view_menu_zoom.html#advanced_vertical_zooming" title="View Menu: Zoom">Advanced Vertical Zooming</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Enable for left-click gestures in the vertical scale to control zooming.
|
|
</td></tr></table>
|
|
<div id="view_track_size_submenu"></div>
|
|
<h3><span class="mw-headline" id="View:_Track_Size"><a href="view_menu_track_size.html" title="View Menu: Track Size">View: Track Size</a></span></h3>
|
|
<div class="note">Controls the sizes of tracks. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>FitInWindow:</b>
|
|
</td>
|
|
<td><a href="view_menu_track_size.html#fit_to_width" title="View Menu: Track Size">Fit to Width</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Zooms out until the entire project just fits in the window.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>FitV:</b>
|
|
</td>
|
|
<td><a href="view_menu_track_size.html#fit_to_height" title="View Menu: Track Size">Fit to Height</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Adjusts the height of all the tracks until they fit in the project window.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CollapseAllTracks:</b>
|
|
</td>
|
|
<td><a href="view_menu_track_size.html#collapse_all_tracks" title="View Menu: Track Size">Collapse All Tracks</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Collapses all tracks to take up the minimum amount of space.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ExpandAllTracks:</b>
|
|
</td>
|
|
<td><a href="view_menu_track_size.html#expand_collapsed_tracks" title="View Menu: Track Size">Expand Collapsed Tracks</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Expands all collapsed tracks to their original size before the last collapse.
|
|
</td></tr></table>
|
|
<div id="view_skip_to_submenu"></div>
|
|
<h3><span class="mw-headline" id="View:_Skip_to"><a href="view_menu_skip_to.html" title="View Menu: Skip to">View: Skip to</a></span></h3>
|
|
<div class="note">Move forward/backwards through the audio </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>SkipSelStart:</b>
|
|
</td>
|
|
<td><a href="view_menu_skip_to.html#selection_start" title="View Menu: Skip to">Selection Start</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When there is a selection, moves the cursor to the start of the selection and removes the selection.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SkipSelEnd:</b>
|
|
</td>
|
|
<td><a href="view_menu_skip_to.html#selection_end" title="View Menu: Skip to">Selection End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When there is a selection, moves the cursor to the end of the selection and removes the selection.
|
|
</td></tr></table>
|
|
<div id="view_toolbars_submenu"></div>
|
|
<h3><span class="mw-headline" id="View:_Toolbars"><a href="view_menu_toolbars.html" title="View Menu: Toolbars">View: Toolbars</a></span></h3>
|
|
<div class="note">Toolbars can be used to determine which of the Audacity toolbars are displayed. By default all toolbars are shown except Spectral Selection, Cut/Copy/Paste and Spectral Selection </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>ResetToolbars:</b>
|
|
</td>
|
|
<td><a href="view_menu_toolbars.html#reset_toolbars" title="View Menu: Toolbars">Reset Toolbars</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Using this command positions all toolbars in default location and size as they were when Audacity was first installed
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowTransportTB:</b>
|
|
</td>
|
|
<td><a href="view_menu_toolbars.html#transport_toolbar" title="View Menu: Toolbars">Transport Toolbar</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Controls playback and recording and skips to start or end of project when neither playing or recording
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowToolsTB:</b>
|
|
</td>
|
|
<td><a href="view_menu_toolbars.html#tools_toolbar" title="View Menu: Toolbars">Tools Toolbar</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Chooses various tools for selection, volume adjustment, zooming and time-shifting of audio
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowRecordMeterTB:</b>
|
|
</td>
|
|
<td><a href="view_menu_toolbars.html#recording_meter_toolbar" title="View Menu: Toolbars">Recording Meter Toolbar</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Displays recording levels and toggles input monitoring when not recording
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowPlayMeterTB:</b>
|
|
</td>
|
|
<td><a href="view_menu_toolbars.html#playback_meter_toolbar" title="View Menu: Toolbars">Playback Meter Toolbar</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Displays playback levels
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowMixerTB:</b>
|
|
</td>
|
|
<td><a href="view_menu_toolbars.html#mixer_toolbar" title="View Menu: Toolbars">Mixer Toolbar</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Adjusts the recording and playback volumes of the devices currently selected in Audio Setup Toolbar
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowEditTB:</b>
|
|
</td>
|
|
<td><a href="view_menu_toolbars.html#edit_toolbar" title="View Menu: Toolbars">Edit Toolbar</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Cut, copy, paste, trim audio, silence audio, undo, redo, zoom tools
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowTranscriptionTB:</b>
|
|
</td>
|
|
<td><a href="view_menu_toolbars.html#playatspeed_toolbar" title="View Menu: Toolbars">Play-at-Speed Toolbar</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Plays audio at a slower or faster speed than normal, affecting pitch
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowScrubbingTB:</b>
|
|
</td>
|
|
<td><a href="view_menu_toolbars.html#scrub_toolbar" title="View Menu: Toolbars">Scrub Toolbar</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Controls playback and recording and skips to start or end of project when neither playing or recording
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowDeviceTB:</b>
|
|
</td>
|
|
<td><a href="view_menu_toolbars.html#device_toolbar" title="View Menu: Toolbars">Device Toolbar</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selects audio host, recording device, number of recording channels and playback device
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowSelectionTB:</b>
|
|
</td>
|
|
<td><a href="view_menu_toolbars.html#selection_toolbar" title="View Menu: Toolbars">Selection Toolbar</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Adjusts cursor and region position by keyboard input
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShowSpectralSelectionTB:</b>
|
|
</td>
|
|
<td><a href="view_menu_toolbars.html#spectral_selection_toolbar" title="View Menu: Toolbars">Spectral Selection Toolbar</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Displays and lets you adjust the current spectral (frequency) selection without having to be in Spectrogram view
|
|
</td></tr></table>
|
|
<div id="transport_menu"></div>
|
|
<h2><span class="mw-headline" id="Transport_Menu"><a href="transport_menu.html" title="Transport Menu">Transport Menu</a></span></h2>
|
|
<div class="note">Transport Menu commands let you play or stop, loop play, scrub play or record (including timed and sound activated recordings). </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>RescanDevices:</b>
|
|
</td>
|
|
<td><a href="transport_menu.html#rescan_audio_devices" title="Transport Menu">Rescan Audio Devices</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Rescan for audio devices connected to your computer, and update the playback and recording dropdown menus in Audio Setup Toolbar
|
|
</td></tr></table>
|
|
<div id="transport_playing_submenu"></div>
|
|
<h3><span class="mw-headline" id="Transport:_Playing"><a href="transport_menu_playing.html" title="Transport Menu: Playing">Transport: Playing</a></span></h3>
|
|
|
|
<div class="note">These commands control playback in Audacity. You can Start, Stop or Pause playback of the audio in your project. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>PlayStop:</b>
|
|
</td>
|
|
<td><a href="transport_menu_playing.html#playstop" title="Transport Menu: Playing">Play/Stop</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Starts and stops playback or stops a recording (stopping does not change the restart position). Therefore using any play or record command after stopping with "Play/Stop" will start playback or recording from the same <a href="timeline.html" title="Timeline">Timeline</a> position it last started from. You can also assign separate shortcuts for <a href="#play">Play</a> and <a href="#stop">Stop</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlayStopSelect:</b>
|
|
</td>
|
|
<td><a href="transport_menu_playing.html#playstop_and_set_cursor" title="Transport Menu: Playing">Play/Stop and Set Cursor</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Starts playback like "Play/Stop", but stopping playback sets the restart position to the stop point. When stopped, this command is the same as "Play/Stop". When playing, this command stops playback and moves the cursor (or the start of the selection) to the position where playback stopped.
|
|
</td></tr>
|
|
|
|
<tr>
|
|
<td><b>Pause:</b>
|
|
</td>
|
|
<td><a href="transport_menu_playing.html#pause" title="Transport Menu: Playing">Pause</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Temporarily pauses playing or recording without losing your place.
|
|
</td></tr></table>
|
|
<div id="transport_recording_submenu"></div>
|
|
<h3><span class="mw-headline" id="Transport:_Recording"><a href="transport_menu_recording.html" title="Transport Menu: Recording">Transport: Recording</a></span></h3>
|
|
<div class="note">These commands control recording in Audacity. You can Start, Stop or Pause recording in your project. You can either start a recording on your existing track or on a new track. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Record1stChoice:</b>
|
|
</td>
|
|
<td><a href="transport_menu_recording.html#record" title="Transport Menu: Recording">Record</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Starts recording at the end of the currently <a href="audacity_selection.html" title="Audacity Selection">selected</a> track(s).
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Record2ndChoice:</b>
|
|
</td>
|
|
<td><a href="transport_menu_recording.html#record_new_track" title="Transport Menu: Recording">Record New Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Recording begins on a new track at either the current cursor location or at the beginning of the current selection.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TimerRecord:</b>
|
|
</td>
|
|
<td><a href="transport_menu_recording.html#timer_record" title="Transport Menu: Recording">Timer Record</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Brings up the Timer Record dialog.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PunchAndRoll:</b>
|
|
</td>
|
|
<td><a href="transport_menu_recording.html#punch_and_roll_record" title="Transport Menu: Recording">Punch and Roll Record</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Re-record over audio, with a pre-roll of audio that comes before.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Pause:</b>
|
|
</td>
|
|
<td><a href="transport_menu_recording.html#pause" title="Transport Menu: Recording">Pause</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Temporarily pauses playing or recording without losing your place.
|
|
</td></tr></table>
|
|
<div id="transport_scrubbing_submenu"></div>
|
|
<h3><span class="mw-headline" id="Transport:_Scrubbing"><a href="transport_menu_scrubbing.html" title="Transport Menu: Scrubbing">Transport: Scrubbing</a></span></h3>
|
|
<div class="note">Scrubbing is the action of moving the mouse pointer right or left so as to adjust the position, speed or direction of playback, listening to the audio at the same time - a convenient way to quickly navigate the waveform to find a particular event of interest. Speed changes are made by rotating the mouse wheel while scrubbing. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Scrub:</b>
|
|
</td>
|
|
<td><a href="transport_menu_scrubbing.html#scrub" title="Transport Menu: Scrubbing">Scrub</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Scrubbing is the action of moving the mouse pointer right or left so as to adjust the position, speed or direction of playback, listening to the audio at the same time.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Seek:</b>
|
|
</td>
|
|
<td><a href="transport_menu_scrubbing.html#seek" title="Transport Menu: Scrubbing">Seek</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Seeking is similar to Scrubbing except that it is playback with skips, similar to using the seek button on a CD player.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ToggleScrubRuler:</b>
|
|
</td>
|
|
<td><a href="transport_menu_scrubbing.html#scrub_ruler" title="Transport Menu: Scrubbing">Scrub Ruler</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Shows (or hides) the scrub ruler, which is just below the timeline.
|
|
</td></tr></table>
|
|
<div id="transport_cursor_to_submenu"></div>
|
|
<h3><span class="mw-headline" id="Transport:_Cursor_to"><a href="transport_menu_cursor_to.html" title="Transport Menu: Cursor to">Transport: Cursor to</a></span></h3>
|
|
<div class="note">These commands let you move the cursor to the start or end of the selection, track or any adjacent Clip that you may have </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>CursSelStart:</b>
|
|
</td>
|
|
<td><a href="transport_menu_cursor_to.html#selection_start" title="Transport Menu: Cursor to">Selection Start</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the left edge of the current selection to the center of the screen, without changing the <a href="zooming.html" title="Zooming">zoom</a> level.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CursSelEnd:</b>
|
|
</td>
|
|
<td><a href="transport_menu_cursor_to.html#selection_end" title="Transport Menu: Cursor to">Selection End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the right edge of the current selection to the center of the screen, without changing the <a href="zooming.html" title="Zooming">zoom</a> level.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CursTrackStart:</b>
|
|
</td>
|
|
<td><a href="transport_menu_cursor_to.html#track_start" title="Transport Menu: Cursor to">Track Start</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the cursor to the start of the selected track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CursTrackEnd:</b>
|
|
</td>
|
|
<td><a href="transport_menu_cursor_to.html#track_end" title="Transport Menu: Cursor to">Track End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the cursor to the end of the selected track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CursPrevClipBoundary:</b>
|
|
</td>
|
|
<td><a href="transport_menu_cursor_to.html#previous_clip_boundary" title="Transport Menu: Cursor to">Previous Clip Boundary</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the cursor position back to the right-hand edge of the previous clip
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CursNextClipBoundary:</b>
|
|
</td>
|
|
<td><a href="transport_menu_cursor_to.html#next_clip_boundary" title="Transport Menu: Cursor to">Next Clip Boundary</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the cursor position forward to the left-hand edge of the next clip
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CursProjectStart:</b>
|
|
</td>
|
|
<td><a href="transport_menu_cursor_to.html#project_start" title="Transport Menu: Cursor to">Project Start</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the cursor to the beginning of the project.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CursProjectEnd:</b>
|
|
</td>
|
|
<td><a href="transport_menu_cursor_to.html#project_end" title="Transport Menu: Cursor to">Project End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the cursor to the end of the project.
|
|
</td></tr></table>
|
|
<p><br />
|
|
</p>
|
|
<div id="transport_transport_options_submenu"></div>
|
|
<h3><span class="mw-headline" id="Transport:_Transport_Options"><a href="transport_menu_transport_options.html" title="Transport Menu: Transport Options">Transport: Transport Options</a></span></h3>
|
|
<div class="note">This submenu lets you manage and set various options for transport (playing and recording) in Audacity </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>SoundActivationLevel:</b>
|
|
</td>
|
|
<td><a href="transport_menu_transport_options.html#sound_activation_level" title="Transport Menu: Transport Options">Sound Activation Level</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Sets the activation level above which Sound Activated Recording will record.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SoundActivation:</b>
|
|
</td>
|
|
<td><a href="transport_menu_transport_options.html#sound_activated_recording_onoff" title="Transport Menu: Transport Options">Sound Activated Recording (on/off)</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Toggles on and off the Sound Activated Recording option.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PinnedHead:</b>
|
|
</td>
|
|
<td><a href="transport_menu_transport_options.html#pinned_playrecord_head_on.2Foff" title="Transport Menu: Transport Options">Enable pinned play head</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>You can change Audacity to play and record with a fixed head pinned to the Timeline. You can adjust the position of the fixed head by dragging it
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Overdub:</b>
|
|
</td>
|
|
<td><a href="transport_menu_transport_options.html#overdub_onoff" title="Transport Menu: Transport Options">Hear other tracks during recording
|
|
</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Toggles on and off the Hear other tracks during recording (overdub) option.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SWPlaythrough:</b>
|
|
</td>
|
|
<td><a href="transport_menu_transport_options.html#software_playthrough_onoff" title="Transport Menu: Transport Options">Enable audible input monitoring</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Toggles on and off the Enable audible input monitoring option.
|
|
</td></tr></table>
|
|
<div id="tracks_menu"></div>
|
|
<h2><span class="mw-headline" id="Tracks_Menu"><a href="tracks_menu.html" title="Tracks Menu">Tracks Menu</a></span></h2>
|
|
<div class="note">Tracks Menu provides commands for creating and removing tracks, applying operations to selected tracks such as mixing, resampling or converting from stereo to mono, and lets you add or edit labels. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Resample:</b>
|
|
</td>
|
|
<td><a href="tracks_menu.html#resample" title="Tracks Menu">Resample</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Allows you to resample the selected track(s) to a new sample rate for use in the project
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>RemoveTracks:</b>
|
|
</td>
|
|
<td><a href="tracks_menu.html#remove_tracks" title="Tracks Menu">Remove Tracks</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Removes the selected track(s) from the project. Even if only part of a track is selected, the entire track is removed.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SyncLock:</b>
|
|
</td>
|
|
<td><a href="tracks_menu.html#synclock_tracks_onoff" title="Tracks Menu">Sync-Lock Tracks (on/off)</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Ensures that length changes occurring anywhere in a defined group of tracks also take place in all audio or label tracks in that group.
|
|
</td></tr></table>
|
|
<div id="tracks_add_new_submenu"></div>
|
|
<h3><span class="mw-headline" id="Tracks:_Add_New"><a href="tracks_menu_add_new.html" title="Tracks Menu: Add New">Tracks: Add New</a></span></h3>
|
|
<div class="note">Adds a new track </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>NewMonoTrack:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_add_new.html#mono_track" title="Tracks Menu: Add New">Mono Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Creates a new empty mono audio track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NewStereoTrack:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_add_new.html#stereo_track" title="Tracks Menu: Add New">Stereo Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Adds an empty stereo track to the project
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NewLabelTrack:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_add_new.html#label_track" title="Tracks Menu: Add New">Label Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Adds an empty label track to the project
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NewTimeTrack:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_add_new.html#time_track" title="Tracks Menu: Add New">Time Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Adds an empty time track to the project. Time tracks are used to speed up and slow down audio.
|
|
</td></tr></table>
|
|
<div id="tracks_mix_submenu"></div>
|
|
<h3><span class="mw-headline" id="Tracks:_Mix"><a href="tracks_menu_mix.html" title="Tracks Menu: Mix">Tracks: Mix</a></span></h3>
|
|
<div class="note">Mixes down selected tracks to mono or stereo tracks </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Stereo to Mono:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_mix.html#mix_stereo_down_to_mono" title="Tracks Menu: Mix">Mix Stereo Down to Mono</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Converts the selected stereo track(s) into the same number of mono tracks, combining left and right channels equally by averaging the volume of both channels.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>MixAndRender:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_mix.html#mix_and_render" title="Tracks Menu: Mix">Mix and Render</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Mixes down all selected tracks to a single mono or stereo track, rendering to the waveform all real-time transformations that had been applied (such as track <i><b><a href="glossary.html#gain" title="Glossary">gain</a></b></i>, panning, <a href="envelope_tool.html" title="Envelope Tool">amplitude envelopes</a> or a change in <a href="audio_settings_preferences.html" title="Audio Settings Preferences">Project Sample Rate</a>).
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>MixAndRenderToNewTrack:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_mix.html#mix_and_render_to_new_track" title="Tracks Menu: Mix">Mix and Render to New Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Same as <span class="menu">Tracks > <a href="tracks_menu.html#mix_and_render" title="Tracks Menu">Mix and Render</a></span> except that the original tracks are preserved rather than being replaced by the resulting "Mix" track.
|
|
</td></tr></table>
|
|
<div id="tracks_muteunmute_submenu"></div>
|
|
<h3><span class="mw-headline" id="Tracks:_Mute.2FUnmute"><a href="tracks_menu_mute_unmute.html" title="Tracks Menu: Mute Unmute">Tracks: Mute/Unmute</a></span></h3>
|
|
<div class="note">Mutes or unmutes audio tracks in the project </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>MuteAllTracks:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_mute/unmute.html#mute_all_tracks" class="mw-redirect" title="Tracks Menu: Mute/Unmute">Mute All Tracks</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Mutes all the audio tracks in the project as if you had used the mute buttons from the Track Control Panel on each track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>UnmuteAllTracks:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_mute/unmute.html#unmute_all_tracks" class="mw-redirect" title="Tracks Menu: Mute/Unmute">Unmute All Tracks</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Unmutes all the audio tracks in the project as if you had released the mute buttons from the Track Control Panel on each track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>MuteTracks:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_mute/unmute.html#mute_tracks" class="mw-redirect" title="Tracks Menu: Mute/Unmute">Mute Tracks</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Mutes the selected tracks.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>UnmuteTracks:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_mute/unmute.html#unmute_tracks" class="mw-redirect" title="Tracks Menu: Mute/Unmute">Unmute Tracks</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Unmutes the selected tracks.
|
|
</td></tr></table>
|
|
<div id="tracks_pan_submenu"></div>
|
|
<h3><span class="mw-headline" id="Tracks:_Pan"><a href="tracks_menu_pan.html" title="Tracks Menu: Pan">Tracks: Pan</a></span></h3>
|
|
<div class="note">Pans left right or center audio tracks in the project </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>PanLeft:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_pan.html#left" title="Tracks Menu: Pan">Left</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Pan selected audio to left speaker
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PanRight:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_pan.html#right" title="Tracks Menu: Pan">Right</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Pan selected audio centrally.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PanCenter:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_pan.html#center" title="Tracks Menu: Pan">Center</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Pan selected audio to right speaker.
|
|
</td></tr></table>
|
|
<div id="tracks_align_tracks_submenu"></div>
|
|
<h3><span class="mw-headline" id="Tracks:_Align_Tracks"><a href="tracks_menu_align_tracks.html" title="Tracks Menu: Align Tracks">Tracks: Align Tracks</a></span></h3>
|
|
<div class="note">Commands that provide an automatic way of aligning selected tracks with the cursor, the selection, or with the start of the project. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Align_EndToEnd:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_align_tracks.html#align_end_to_end" title="Tracks Menu: Align Tracks">Align End to End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Aligns the selected tracks one after the other, based on their top-to-bottom order in the project window.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Align_Together:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_align_tracks.html#align_together" title="Tracks Menu: Align Tracks">Align Together</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Align the selected tracks so that they start at the same (averaged) start time.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Align_StartToZero:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_align_tracks.html#start_to_zero" title="Tracks Menu: Align Tracks">Start to Zero</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Aligns the start of selected tracks with the start of the project.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Align_StartToSelStart:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_align_tracks.html#start_to_cursorselection_start" title="Tracks Menu: Align Tracks">Start to Cursor/Selection Start</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Aligns the start of selected tracks with the current cursor position or with the start of the current selection.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Align_StartToSelEnd:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_align_tracks.html#start_to_selection_end" title="Tracks Menu: Align Tracks">Start to Selection End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Aligns the start of selected tracks with the end of the current selection.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Align_EndToSelStart:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_align_tracks.html#end_to_cursorselection_start" title="Tracks Menu: Align Tracks">End to Cursor/Selection Start</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Aligns the end of selected tracks with the current cursor position or with the start of the current selection.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Align_EndToSelEnd:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_align_tracks.html#end_to_selection_end" title="Tracks Menu: Align Tracks">End to Selection End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Aligns the end of selected tracks with the end of the current selection.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>MoveSelectionWithTracks:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_align_tracks.html#move_selection_with_tracks_onoff" title="Tracks Menu: Align Tracks">Move Selection with Tracks (on/off)</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Toggles on/off the selection moving with the realigned tracks, or staying put.
|
|
</td></tr></table>
|
|
<div id="tracks_sort_tracks_submenu"></div>
|
|
<h3><span class="mw-headline" id="Tracks:_Sort_Tracks"><a href="tracks_menu_sort_tracks.html" title="Tracks Menu: Sort Tracks">Tracks: Sort Tracks</a></span></h3>
|
|
<div class="note">Sorts all tracks in the project from top to bottom in the project window, by Start Time or by Name. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>SortByTime:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_sort_tracks.html#by_start_time" title="Tracks Menu: Sort Tracks">By Start Time</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Sort tracks in order of start time.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SortByName:</b>
|
|
</td>
|
|
<td><a href="tracks_menu_sort_tracks.html#by_name" title="Tracks Menu: Sort Tracks">By Name</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Sort tracks in order by name.
|
|
</td></tr></table>
|
|
<div id="generate_menu"></div>
|
|
<h2><span class="mw-headline" id="Generate_Menu"><a href="generate_menu.html" title="Generate Menu">Generate Menu</a></span></h2>
|
|
<div class="note">Generate Menu lets you create audio containing tones, noise or silence. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>ManageGenerators:</b>
|
|
</td>
|
|
<td><a href="generate_menu.html#add_remove_plugins" title="Generate Menu">Plugin Manager</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selecting this option from the Effect Menu (or the <a href="generate_menu.html" title="Generate Menu">Generate Menu</a> or <a href="analyze_menu.html" title="Analyze Menu">Analyze Menu</a>) takes you to a dialog where you can enable or disable particular Effects, Generators and Analyzers in Audacity. Even if you do not add any third-party plugins, you can use this to make the Effect menu shorter or longer as required. For details see <a href="manage_effects_generators_and_analyzers.html" title="Manage Effects, Generators and Analyzers">Plugin Manager</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Built-in:</b>
|
|
</td>
|
|
<td><a href="generate_menu.html#builtin" title="Generate Menu">Built-in</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Shows the list of available Audacity built-in effects but only if the user has effects "Grouped by Type" in Effects Preferences.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Nyquist:</b>
|
|
</td>
|
|
<td><a href="generate_menu.html#nyquist" title="Generate Menu">Nyquist</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Shows the list of available Nyquist effects but only if the user has effects "Grouped by Type" in Effects Preferences.
|
|
</td></tr></table>
|
|
<div id="generate_builtin_submenu"></div>
|
|
<h3><span class="mw-headline" id="Generate:_Built-in"><a href="generate_menu.html" title="Generate Menu">Generate: Built-in</a></span></h3>
|
|
<div class="note">Shows the list of available Audacity built-in effects but only if the user has effects "Grouped by Type" in Effects Preferences. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Chirp:</b>
|
|
</td>
|
|
<td><a href="generate_menu.html#chirp" title="Generate Menu">Chirp</a>
|
|
</td>
|
|
<td><i>double <b>StartFreq</b>, (default:440)</i><br />
|
|
<p><i>double <b>EndFreq</b>, (default:1320)</i><br />
|
|
<i>double <b>StartAmp</b>, (default:0.8)</i><br />
|
|
<i>double <b>EndAmp</b>, (default:0.1)</i><br />
|
|
<i>enum <b>Waveform</b>, (default:Sine)</i><br />
|
|
</p>
|
|
<ul><li> Sine</li>
|
|
<li> Square</li>
|
|
<li> Sawtooth</li>
|
|
<li> Square, no alias</li></ul>
|
|
<p><i>enum <b>Interpolation</b>, (default:Linear)</i><br />
|
|
</p>
|
|
<ul><li> Linear</li>
|
|
<li> Logarithmic</li></ul>
|
|
</td>
|
|
<td>Generates four different types of tone waveforms like the <a href="#Tone">Tone Generator</a>, but additionally allows setting of the starting and ending amplitude and frequency.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>DtmfTones:</b>
|
|
</td>
|
|
<td><a href="generate_menu.html#dtmf_tones" title="Generate Menu">DTMF Tones</a>
|
|
</td>
|
|
<td><i>string <b>Sequence</b>, (default:audacity)</i><br />
|
|
<p><i>double <b>Duty Cycle</b>, (default:55)</i><br />
|
|
<i>double <b>Amplitude</b>, (default:0.8)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Generates dual-tone multi-frequency (DTMF) tones like those produced by the keypad on telephones.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Noise:</b>
|
|
</td>
|
|
<td><a href="generate_menu.html#noise" title="Generate Menu">Noise</a>
|
|
</td>
|
|
<td><i>enum <b>Type</b>, (default:White)</i><br />
|
|
<ul><li> White</li>
|
|
<li> Pink</li>
|
|
<li> Brownian</li></ul>
|
|
<p><i>double <b>Amplitude</b>, (default:0.8)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Generates 'white', 'pink' or 'brown' noise.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Tone:</b>
|
|
</td>
|
|
<td><a href="generate_menu.html#tone" title="Generate Menu">Tone</a>
|
|
</td>
|
|
<td><i>double <b>Frequency</b>, (default:440)</i><br />
|
|
<p><i>double <b>Amplitude</b>, (default:0.8)</i><br />
|
|
<i>enum <b>Waveform</b>, (default:Sine)</i><br />
|
|
</p>
|
|
<ul><li> Sine</li>
|
|
<li> Square</li>
|
|
<li> Sawtooth</li>
|
|
<li> Square, no alias</li></ul>
|
|
<p><i>enum <b>Interpolation</b>, (default:Linear)</i><br />
|
|
</p>
|
|
<ul><li> Linear</li>
|
|
<li> Logarithmic</li></ul>
|
|
</td>
|
|
<td>Generates one of four different tone waveforms: <i>Sine</i>, <i>Square</i>, <i>Sawtooth</i> or <i>Square (no alias)</i>, and a frequency between 1 Hz and <i>half the current [[Audio Settings Preferences|Project Sample Rate</i>.
|
|
</td></tr></table>
|
|
<div id="generate_nyquist_submenu"></div>
|
|
<h3><span class="mw-headline" id="Generate:_Nyquist"><a href="generate_menu.html" title="Generate Menu">Generate: Nyquist</a></span></h3>
|
|
<div class="note">Shows the list of available Nyquist effects but only if the user has effects "Grouped by Type" in Effects Preferences. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Pluck:</b>
|
|
</td>
|
|
<td><a href="generate_menu.html#pluck" title="Generate Menu">Pluck</a>
|
|
</td>
|
|
<td><i>int <b>pitch</b>, (default:0)</i><br />
|
|
<p><i>enum <b>fade</b>, (default:Abrupt)</i><br />
|
|
</p>
|
|
<ul><li> Abrupt</li>
|
|
<li> Gradual</li></ul>
|
|
<p><i>double <b>dur</b>, (default:0)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>A synthesized pluck tone with abrupt or gradual fade-out, and selectable pitch corresponding to a <i><b><a href="glossary.html#midi" title="Glossary">MIDI</a></b></i> note.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>RhythmTrack:</b>
|
|
</td>
|
|
<td><a href="generate_menu.html#rhythm_track" title="Generate Menu">Rhythm Track</a>
|
|
</td>
|
|
<td><i>double <b>tempo</b>, (default:0)</i><br />
|
|
<p><i>int <b>timesig</b>, (default:0)</i><br />
|
|
<i>double <b>swing</b>, (default:0)</i><br />
|
|
<i>int <b>bars</b>, (default:0)</i><br />
|
|
<i>double <b>click-track-dur</b>, (default:0)</i><br />
|
|
<i>double <b>offset</b>, (default:0)</i><br />
|
|
<i>enum <b>click-type</b>, (default:Metronome)</i><br />
|
|
</p>
|
|
<ul><li> Metronome</li>
|
|
<li> Ping (short)</li>
|
|
<li> Ping (long)</li>
|
|
<li> Cowbell</li>
|
|
<li> ResonantNoise</li>
|
|
<li> NoiseClick</li>
|
|
<li> Drip (short)</li>
|
|
<li> Drip (long)</li></ul>
|
|
<p><i>int <b>high</b>, (default:0)</i><br />
|
|
<i>int <b>low</b>, (default:0)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Generates a track with regularly spaced sounds at a specified tempo and number of beats per measure (bar).
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>RissetDrum:</b>
|
|
</td>
|
|
<td><a href="generate_menu.html#risset_drum" title="Generate Menu">Risset Drum</a>
|
|
</td>
|
|
<td><i>double <b>freq</b>, (default:0)</i><br />
|
|
<p><i>double <b>decay</b>, (default:0)</i><br />
|
|
<i>double <b>cf</b>, (default:0)</i><br />
|
|
<i>double <b>bw</b>, (default:0)</i><br />
|
|
<i>double <b>noise</b>, (default:0)</i><br />
|
|
<i>double <b>gain</b>, (default:0)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Produces a realistic drum sound.
|
|
</td></tr></table>
|
|
<div id="effect_menu"></div>
|
|
<h2><span class="mw-headline" id="Effect_Menu"><a href="effect_menu.html" title="Effect Menu">Effect Menu</a></span></h2>
|
|
<div class="note">Audacity includes many built-in effects and also lets you use a wide range of plugin effects. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>ManageEffects:</b>
|
|
</td>
|
|
<td><a href="effect_menu.html#add_remove_plugins" title="Effect Menu">Plugin Manager</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selecting this option from the Effect Menu (or the <a href="generate_menu.html" title="Generate Menu">Generate Menu</a> or <a href="analyze_menu.html" title="Analyze Menu">Analyze Menu</a>) takes you to a dialog where you can enable or disable particular Effects, Generators and Analyzers in Audacity. Even if you do not add any third-party plugins, you can use this to make the Effect menu shorter or longer as required. For details see <a href="manage_effects_generators_and_analyzers.html" title="Manage Effects, Generators and Analyzers">Plugin Manager</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>RepeatLastEffect:</b>
|
|
</td>
|
|
<td><a href="effect_menu.html#repeat_last_effect" title="Effect Menu">Repeat Last Effect</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Repeats the last used effect at its last used settings and without displaying any dialog.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>LADSPA:</b>
|
|
</td>
|
|
<td><a href="effect_menu.html#ladspa" title="Effect Menu">LADSPA</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Shows the list of available LADSPA effects but only if the user has effects "Grouped by Type" in Effects Preferences.
|
|
</td></tr></table>
|
|
<div id="effect_builtin_submenu"></div>
|
|
<h3><span class="mw-headline" id="Effect:_Built-in"><a href="effect_menu_built_in.html" title="Effect Menu: Built-in">Effect: Built-in</a></span></h3>
|
|
<div class="note"> No special notes for Built-in </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Amplify:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#amplify" title="Effect Menu: Built-in">Amplify</a>
|
|
</td>
|
|
<td><i>float <b>Ratio</b>, (default:0.9)</i><br />
|
|
<p><i>bool <b>AllowClipping</b>, (default:False)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Increases or decreases the volume of the audio you have selected.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>AutoDuck:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#auto_duck" title="Effect Menu: Built-in">Auto Duck</a>
|
|
</td>
|
|
<td><i>double <b>DuckAmountDb</b>, (default:-12)</i><br />
|
|
<p><i>double <b>InnerFadeDownLen</b>, (default:0)</i><br />
|
|
<i>double <b>InnerFadeUpLen</b>, (default:0)</i><br />
|
|
<i>double <b>OuterFadeDownLen</b>, (default:0.5)</i><br />
|
|
<i>double <b>OuterFadeUpLen</b>, (default:0.5)</i><br />
|
|
<i>double <b>ThresholdDb</b>, (default:-30)</i><br />
|
|
<i>double <b>MaximumPause</b>, (default:1)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Reduces (ducks) the volume of one or more tracks whenever the volume of a specified "control" track reaches a particular level. Typically used to make a music track softer whenever speech in a commentary track is heard.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>BassAndTreble:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#bass_and_treble" title="Effect Menu: Built-in">Bass and Treble</a>
|
|
</td>
|
|
<td><i>double <b>Bass</b>, (default:0)</i><br />
|
|
<p><i>double <b>Treble</b>, (default:0)</i><br />
|
|
<i>double <b>Gain</b>, (default:0)</i><br />
|
|
<i>bool <b>Link Sliders</b>, (default:False)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Increases or decreases the lower <i><b><a href="glossary.html#frequency" title="Glossary">frequencies</a></b></i> and higher frequencies of your audio independently; behaves just like the bass and treble controls on a stereo system.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ChangePitch:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#change_pitch" title="Effect Menu: Built-in">Change Pitch</a>
|
|
</td>
|
|
<td><i>double <b>Percentage</b>, (default:0)</i><br />
|
|
<p><i>bool <b>SBSMS</b>, (default:False)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Change the pitch of a selection without changing its tempo.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ChangeSpeed:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#change_speed" title="Effect Menu: Built-in">Change Speed and Pitch</a>
|
|
</td>
|
|
<td><i>double <b>Percentage</b>, (default:0)</i><br />
|
|
</td>
|
|
<td>Change the speed of a selection, also changing its pitch.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ChangeTempo:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#change_tempo" title="Effect Menu: Built-in">Change Tempo</a>
|
|
</td>
|
|
<td><i>double <b>Percentage</b>, (default:0)</i><br />
|
|
<p><i>bool <b>SBSMS</b>, (default:False)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Change the tempo and length (duration) of a selection without changing its pitch.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ClickRemoval:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#click_removal" title="Effect Menu: Built-in">Click Removal</a>
|
|
</td>
|
|
<td><i>int <b>Threshold</b>, (default:200)</i><br />
|
|
<p><i>int <b>Width</b>, (default:20)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Click Removal is designed to remove clicks on audio tracks and is especially suited to declicking recordings made from vinyl records.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Compressor:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#compressor" title="Effect Menu: Built-in">Compressor</a>
|
|
</td>
|
|
<td><i>double <b>Threshold</b>, (default:-12)</i><br />
|
|
<p><i>double <b>NoiseFloor</b>, (default:-40)</i><br />
|
|
<i>double <b>Ratio</b>, (default:2)</i><br />
|
|
<i>double <b>AttackTime</b>, (default:0.2)</i><br />
|
|
<i>double <b>ReleaseTime</b>, (default:1)</i><br />
|
|
<i>bool <b>Normalize</b>, (default:True)</i><br />
|
|
<i>bool <b>UsePeak</b>, (default:False)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Compresses the <i><b><a href="glossary.html#dynamic_range" title="Glossary">dynamic range</a></b></i> by two alternative methods. The default "<i><b><a href="glossary.html#rms" title="Glossary">RMS</a></b></i>" method makes the louder parts softer, but leaves the quieter audio alone. The alternative "peaks" method makes the entire audio louder, but amplifies the louder parts less than the quieter parts. Make-up <i><b><a href="glossary.html#gain" title="Glossary">gain</a></b></i> can be applied to either method, making the result as loud as possible without <i><b><a href="glossary.html#clipping" title="Glossary">clipping</a></b></i>, but not changing the dynamic range further.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Distortion:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#distortion" title="Effect Menu: Built-in">Distortion</a>
|
|
</td>
|
|
<td><i>enum <b>Type</b>, (default:Hard Clipping)</i><br />
|
|
<ul><li> Hard Clipping</li>
|
|
<li> Soft Clipping</li>
|
|
<li> Soft Overdrive</li>
|
|
<li> Medium Overdrive</li>
|
|
<li> Hard Overdrive</li>
|
|
<li> Cubic Curve (odd harmonics)</li>
|
|
<li> Even Harmonics</li>
|
|
<li> Expand and Compress</li>
|
|
<li> Leveller</li>
|
|
<li> Rectifier Distortion</li>
|
|
<li> Hard Limiter 1413</li></ul>
|
|
<p><i>bool <b>DC Block</b>, (default:False)</i><br />
|
|
<i>double <b>Threshold dB</b>, (default:-6)</i><br />
|
|
<i>double <b>Noise Floor</b>, (default:-70)</i><br />
|
|
<i>double <b>Parameter 1</b>, (default:50)</i><br />
|
|
<i>double <b>Parameter 2</b>, (default:50)</i><br />
|
|
<i>int <b>Repeats</b>, (default:1)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Use the Distortion effect to make the audio sound distorted. By distorting the waveform the frequency content is changed, which will often make the sound "crunchy" or "abrasive". Technically this effect is a <a rel="nofollow" class="external text" href="https://en.wikipedia.org/wiki/Waveshaper">waveshaper</a>. The result of waveshaping is equivalent to applying non-linear amplification to the audio waveform. Preset shaping functions are provided, each of which produces a different type of distortion.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Echo:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#echo" title="Effect Menu: Built-in">Echo</a>
|
|
</td>
|
|
<td><i>float <b>Delay</b>, (default:1)</i><br />
|
|
<p><i>float <b>Decay</b>, (default:0.5)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Repeats the selected audio again and again, normally softer each time and normally not blended into the original sound until some time after it starts. The delay time between each repeat is fixed, with no pause in between each repeat. For a more configurable echo effect with a variable delay time and pitch-changed echoes, see <a href="effect_menu.html#Delay" title="Effect Menu">Delay</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>FadeIn:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#fade_in" title="Effect Menu: Built-in">Fade In</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Applies a <i><b><a href="glossary.html#linear" title="Glossary">linear</a></b></i> fade-in to the selected audio - the rapidity of the fade-in depends entirely on the length of the selection it is applied to. For a more customizable <i><b><a href="glossary.html#log" title="Glossary">logarithmic</a></b></i> fade, use the <a href="envelope_tool.html" title="Envelope Tool">Envelope Tool</a> on the <a href="tools_toolbar.html" title="Tools Toolbar">Tools Toolbar</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>FadeOut:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#fade_out" title="Effect Menu: Built-in">Fade Out</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Applies a <i><b><a href="glossary.html#linear" title="Glossary">linear</a></b></i> fade-out to the selected audio - the rapidity of the fade-out depends entirely on the length of the selection it is applied to. For a more customizable <i><b><a href="glossary.html#log" title="Glossary">logarithmic</a></b></i> fade, use the <a href="envelope_tool.html" title="Envelope Tool">Envelope Tool</a> on the <a href="tools_toolbar.html" title="Tools Toolbar">Tools Toolbar</a>.<br />
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>FilterCurve:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#filter_curve" title="Effect Menu: Built-in">Filter Curve EQ</a>
|
|
</td>
|
|
<td><i>size_t <b>FilterLength</b>, (default:8191)</i><br />
|
|
<p><i>bool <b>InterpolateLin</b>, (default:False)</i><br />
|
|
<i>enum <b>InterpolationMethod</b>, (default:B-spline)</i><br />
|
|
</p>
|
|
<ul><li> B-spline</li>
|
|
<li> Cosine</li>
|
|
<li> Cubic</li></ul>
|
|
<p><i>double <b>f0</b>, (default:0)</i><br />
|
|
<i>double <b>v0</b>, (default:0)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Adjusts the volume levels of particular frequencies
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>GraphicEq:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#graphic_eq" title="Effect Menu: Built-in">Graphic EQ</a>
|
|
</td>
|
|
<td><i>size_t <b>FilterLength</b>, (default:8191)</i><br />
|
|
<p><i>bool <b>InterpolateLin</b>, (default:False)</i><br />
|
|
<i>enum <b>InterpolationMethod</b>, (default:B-spline)</i><br />
|
|
</p>
|
|
<ul><li> B-spline</li>
|
|
<li> Cosine</li>
|
|
<li> Cubic</li></ul>
|
|
<p><i>double <b>f0</b>, (default:0)</i><br />
|
|
<i>double <b>v0</b>, (default:0)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Adjusts the volume levels of particular frequencies
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Invert:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#invert" title="Effect Menu: Built-in">Invert</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>This effect flips the audio samples upside-down. This normally does not affect the sound of the audio at all. It is occasionally useful for vocal removal.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>LoudnessNormalization:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#loudness_normalization" title="Effect Menu: Built-in">Loudness Normalization</a>
|
|
</td>
|
|
<td><i>bool <b>StereoIndependent</b>, (default:False)</i><br />
|
|
<p><i>double <b>LUFSLevel</b>, (default:-23)</i><br />
|
|
<i>double <b>RMSLevel</b>, (default:-20)</i><br />
|
|
<i>bool <b>DualMono</b>, (default:True)</i><br />
|
|
<i>int <b>NormalizeTo</b>, (default:0)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Changes the perceived loudness of the audio.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NoiseReduction:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#noise_reduction" title="Effect Menu: Built-in">Noise Reduction</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td><s>This effect is ideal for reducing constant background noise such as fans, tape noise, or hums. It will not work very well for removing talking or music in the background. More details <a href="noise_reduction.html" title="Noise Reduction">here</a></s><br />This effect is not currently available from scripting.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Normalize:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#normalize" title="Effect Menu: Built-in">Normalize</a>
|
|
</td>
|
|
<td><i>double <b>PeakLevel</b>, (default:-1)</i><br />
|
|
<p><i>bool <b>ApplyGain</b>, (default:True)</i><br />
|
|
<i>bool <b>RemoveDcOffset</b>, (default:True)</i><br />
|
|
<i>bool <b>StereoIndependent</b>, (default:False)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Use the Normalize effect to set the maximum amplitude of a track, equalize the amplitudes of the left and right channels of a stereo track and optionally remove any <a href="dc_offset.html" title="DC offset">DC offset</a> from the track
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Paulstretch:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#paulstretch" title="Effect Menu: Built-in">Paulstretch</a>
|
|
</td>
|
|
<td><i>float <b>Stretch Factor</b>, (default:10)</i><br />
|
|
<p><i>float <b>Time Resolution</b>, (default:0.25)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Use Paulstretch only for an extreme time-stretch or "stasis" effect, This may be useful for synthesizer pad sounds, identifying performance glitches or just creating interesting aural textures. Use Change Tempo or Sliding Time Scale rather than Paulstretch for tasks like slowing down a song to a "practice" tempo.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Phaser:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#phaser" title="Effect Menu: Built-in">Phaser</a>
|
|
</td>
|
|
<td><i>int <b>Stages</b>, (default:2)</i><br />
|
|
<p><i>int <b>DryWet</b>, (default:128)</i><br />
|
|
<i>double <b>Freq</b>, (default:0.4)</i><br />
|
|
<i>double <b>Phase</b>, (default:0)</i><br />
|
|
<i>int <b>Depth</b>, (default:100)</i><br />
|
|
<i>int <b>Feedback</b>, (default:0)</i><br />
|
|
<i>double <b>Gain</b>, (default:-6)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>The name "Phaser" comes from "Phase Shifter", because it works by combining phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a Low <i><b><a href="glossary.html#frequency" title="Glossary">Frequency</a></b></i> Oscillator (LFO).
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Repair:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#repair" title="Effect Menu: Built-in">Repair</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Fix one particular short click, pop or other glitch no more than 128 samples long.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Repeat:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#repeat" title="Effect Menu: Built-in">Repeat</a>
|
|
</td>
|
|
<td><i>int <b>Count</b>, (default:1)</i><br />
|
|
</td>
|
|
<td>Repeats the selection the specified number of times.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Reverb:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#reverb" title="Effect Menu: Built-in">Reverb</a>
|
|
</td>
|
|
<td><i>double <b>RoomSize</b>, (default:75)</i><br />
|
|
<p><i>double <b>Delay</b>, (default:10)</i><br />
|
|
<i>double <b>Reverberance</b>, (default:50)</i><br />
|
|
<i>double <b>HfDamping</b>, (default:50)</i><br />
|
|
<i>double <b>ToneLow</b>, (default:100)</i><br />
|
|
<i>double <b>ToneHigh</b>, (default:100)</i><br />
|
|
<i>double <b>WetGain</b>, (default:-1)</i><br />
|
|
<i>double <b>DryGain</b>, (default:-1)</i><br />
|
|
<i>double <b>StereoWidth</b>, (default:100)</i><br />
|
|
<i>bool <b>WetOnly</b>, (default:False)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>A configurable stereo reverberation effect with built-in and user-added presets. It can be used to add ambience (an impression of the space in which a sound occurs) to a mono sound. Also use it to increase reverberation in stereo audio that sounds too "dry" or "close".
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Reverse:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#reverse" title="Effect Menu: Built-in">Reverse</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Reverses the selected audio; after the effect the end of the audio will be heard first and the beginning last.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SlidingStretch:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#sliding_stretch" title="Effect Menu: Built-in">Sliding Stretch</a>
|
|
</td>
|
|
<td><i>double <b>RatePercentChangeStart</b>, (default:0)</i><br />
|
|
<p><i>double <b>RatePercentChangeEnd</b>, (default:0)</i><br />
|
|
<i>double <b>PitchHalfStepsStart</b>, (default:0)</i><br />
|
|
<i>double <b>PitchHalfStepsEnd</b>, (default:0)</i><br />
|
|
<i>double <b>PitchPercentChangeStart</b>, (default:0)</i><br />
|
|
<i>double <b>PitchPercentChangeEnd</b>, (default:0)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>This effect allows you to make a continuous change to the tempo and/or pitch of a selection by choosing initial and/or final change values.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TruncateSilence:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#truncate_silence" title="Effect Menu: Built-in">Truncate Silence</a>
|
|
</td>
|
|
<td><i>double <b>Threshold</b>, (default:-20)</i><br />
|
|
<p><i>enum <b>Action</b>, (default:Truncate Detected Silence)</i><br />
|
|
</p>
|
|
<ul><li> Truncate Detected Silence</li>
|
|
<li> Compress Excess Silence</li></ul>
|
|
<p><i>double <b>Minimum</b>, (default:0.5)</i><br />
|
|
<i>double <b>Truncate</b>, (default:0.5)</i><br />
|
|
<i>double <b>Compress</b>, (default:50)</i><br />
|
|
<i>bool <b>Independent</b>, (default:False)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Automatically try to find and eliminate audible silences. Do not use this with faded audio.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Wahwah:</b>
|
|
</td>
|
|
<td><a href="effect_menu_built_in.html#wahwah" title="Effect Menu: Built-in">Wahwah</a>
|
|
</td>
|
|
<td><i>double <b>Freq</b>, (default:1.5)</i><br />
|
|
<p><i>double <b>Phase</b>, (default:0)</i><br />
|
|
<i>int <b>Depth</b>, (default:70)</i><br />
|
|
<i>double <b>Resonance</b>, (default:2.5)</i><br />
|
|
<i>int <b>Offset</b>, (default:30)</i><br />
|
|
<i>double <b>Gain</b>, (default:-6)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Rapid tone quality variations, like that guitar sound so popular in the 1970's.
|
|
</td></tr></table>
|
|
<div id="effect_nyquist_submenu"></div>
|
|
<h3><span class="mw-headline" id="Effect:_Nyquist"><a href="effect_menu_nyquist.html" title="Effect Menu: Nyquist">Effect: Nyquist</a></span></h3>
|
|
<div class="note"> No special notes for Nyquist </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>AdjustableFade:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#adjustable_fade" title="Effect Menu: Nyquist">Adjustable Fade</a>
|
|
</td>
|
|
<td><i>enum <b>type</b>, (default:Up)</i><br />
|
|
<ul><li> Up</li>
|
|
<li> Down</li>
|
|
<li> SCurveUp</li>
|
|
<li> SCurveDown</li></ul>
|
|
<p><i>double <b>curve</b>, (default:0)</i><br />
|
|
<i>enum <b>units</b>, (default:Percent)</i><br />
|
|
</p>
|
|
<ul><li> Percent</li>
|
|
<li> dB</li></ul>
|
|
<p><i>double <b>gain0</b>, (default:0)</i><br />
|
|
<i>double <b>gain1</b>, (default:0)</i><br />
|
|
<i>enum <b>preset</b>, (default:None)</i><br />
|
|
</p>
|
|
<ul><li> None</li>
|
|
<li> LinearIn</li>
|
|
<li> LinearOut</li>
|
|
<li> ExponentialIn</li>
|
|
<li> ExponentialOut</li>
|
|
<li> LogarithmicIn</li>
|
|
<li> LogarithmicOut</li>
|
|
<li> RoundedIn</li>
|
|
<li> RoundedOut</li>
|
|
<li> CosineIn</li>
|
|
<li> CosineOut</li>
|
|
<li> SCurveIn</li>
|
|
<li> SCurveOut</li></ul>
|
|
</td>
|
|
<td>enables you to control the shape of the fade (non-linear fading) to be applied by adjusting various parameters; allows partial <i>(that is not from or to zero)</i> fades up or down.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ClipFix:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#clip_fix" title="Effect Menu: Nyquist">Clip Fix</a>
|
|
</td>
|
|
<td><i>double <b>threshold</b>, (default:0)</i><br />
|
|
<p><i>double <b>gain</b>, (default:0)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Clip Fix attempts to reconstruct clipped regions by interpolating the lost signal.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CrossfadeClips:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#crossfade_clips" title="Effect Menu: Nyquist">Crossfade Clips</a>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>Use Crossfade Clips to apply a simple crossfade to a selected pair of clips in a single audio track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CrossfadeTracks:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#crossfade_tracks" title="Effect Menu: Nyquist">Crossfade Tracks</a>
|
|
</td>
|
|
<td><i>enum <b>type</b>, (default:ConstantGain)</i><br />
|
|
<ul><li> ConstantGain</li>
|
|
<li> ConstantPower1</li>
|
|
<li> ConstantPower2</li>
|
|
<li> CustomCurve</li></ul>
|
|
<p><i>double <b>curve</b>, (default:0)</i><br />
|
|
<i>enum <b>direction</b>, (default:Automatic)</i><br />
|
|
</p>
|
|
<ul><li> Automatic</li>
|
|
<li> OutIn</li>
|
|
<li> InOut</li></ul>
|
|
</td>
|
|
<td>Use Crossfade Tracks to make a smooth transition between two overlapping tracks one above the other. Place the track to be faded out above the track to be faded in then select the overlapping region in both tracks and apply the effect.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Delay:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#delay" title="Effect Menu: Nyquist">Delay</a>
|
|
</td>
|
|
<td><i>enum <b>delay-type</b>, (default:Regular)</i><br />
|
|
<ul><li> Regular</li>
|
|
<li> BouncingBall</li>
|
|
<li> ReverseBouncingBall</li></ul>
|
|
<p><i>double <b>dgain</b>, (default:0)</i><br />
|
|
<i>double <b>delay</b>, (default:0)</i><br />
|
|
<i>enum <b>pitch-type</b>, (default:PitchTempo)</i><br />
|
|
</p>
|
|
<ul><li> PitchTempo</li>
|
|
<li> LQPitchShift</li></ul>
|
|
<p><i>double <b>shift</b>, (default:0)</i><br />
|
|
<i>int <b>number</b>, (default:0)</i><br />
|
|
<i>enum <b>constrain</b>, (default:Yes)</i><br />
|
|
</p>
|
|
<ul><li> Yes</li>
|
|
<li> No</li></ul>
|
|
</td>
|
|
<td>A configurable delay effect with variable delay time and pitch shifting of the delays.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>High-passFilter:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#highpass_filter" title="Effect Menu: Nyquist">High-Pass Filter</a>
|
|
</td>
|
|
<td><i>double <b>frequency</b>, (default:0)</i><br />
|
|
<p><i>enum <b>rolloff</b>, (default:dB6)</i><br />
|
|
</p>
|
|
<ul><li> dB6</li>
|
|
<li> dB12</li>
|
|
<li> dB24</li>
|
|
<li> dB36</li>
|
|
<li> dB48</li></ul>
|
|
</td>
|
|
<td>Passes frequencies above its cutoff frequency and attenuates frequencies below its cutoff frequency.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Limiter:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#limiter" title="Effect Menu: Nyquist">Limiter</a>
|
|
</td>
|
|
<td><i>enum <b>type</b>, (default:SoftLimit)</i><br />
|
|
<ul><li> SoftLimit</li>
|
|
<li> HardLimit</li>
|
|
<li> SoftClip</li>
|
|
<li> HardClip</li></ul>
|
|
<p><i>double <b>gain-L</b>, (default:0)</i><br />
|
|
<i>double <b>gain-R</b>, (default:0)</i><br />
|
|
<i>double <b>thresh</b>, (default:0)</i><br />
|
|
<i>double <b>hold</b>, (default:0)</i><br />
|
|
<i>enum <b>makeup</b>, (default:No)</i><br />
|
|
</p>
|
|
<ul><li> No</li>
|
|
<li> Yes</li></ul>
|
|
</td>
|
|
<td>Limiter passes signals below a specified input level unaffected or gently reduced, while preventing the peaks of stronger signals from exceeding this threshold. Mastering engineers often use this type of dynamic range compression combined with make-up gain to increase the perceived loudness of an audio recording during the audio mastering process.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Low-passFilter:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#lowpass_filter" title="Effect Menu: Nyquist">Low-Pass Filter</a>
|
|
</td>
|
|
<td><i>double <b>frequency</b>, (default:0)</i><br />
|
|
<p><i>enum <b>rolloff</b>, (default:dB6)</i><br />
|
|
</p>
|
|
<ul><li> dB6</li>
|
|
<li> dB12</li>
|
|
<li> dB24</li>
|
|
<li> dB36</li>
|
|
<li> dB48</li></ul>
|
|
</td>
|
|
<td>Passes frequencies below its cutoff frequency and attenuates frequencies above its cutoff frequency.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NotchFilter:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#notch_filter" title="Effect Menu: Nyquist">Notch Filter</a>
|
|
</td>
|
|
<td><i>double <b>frequency</b>, (default:0)</i><br />
|
|
<p><i>double <b>q</b>, (default:0)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Greatly attenuate ("notch out"), a narrow frequency band. This is a good way to remove mains hum or a whistle confined to a specific frequency with minimal damage to the remainder of the audio.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SpectralEditMultiTool:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#spectral_edit_multi_tool" title="Effect Menu: Nyquist">Spectral edit multi tool</a>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>When the selected track is in <a href="audio_track_dropdown_menu.html#spgram" title="Audio Track Dropdown Menu">spectrogram</a> or <a href="audio_track_dropdown_menu.html#spgram_log" title="Audio Track Dropdown Menu">spectrogram log(f)</a> view, applies a <i><b><a href="glossary.html#notch" title="Glossary">notch filter</a></b></i>, <i><b><a href="glossary.html#hp" title="Glossary">high pass filter</a></b></i> or <i><b><a href="glossary.html#lp" title="Glossary">low pass filter</a></b></i> according to the spectral selection made. This effect can also be used to change the audio quality as an alternative to using <a href="equalization.html" title="Equalization">Equalization</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SpectralEditParametricEq:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#spectral_edit_parametric_eq" title="Effect Menu: Nyquist">Spectral edit parametric EQ</a>
|
|
</td>
|
|
<td><i>double <b>control-gain</b>, (default:0)</i><br />
|
|
</td>
|
|
<td>When the selected track is in <a href="audio_track_dropdown_menu.html#spgram" title="Audio Track Dropdown Menu">spectrogram</a> or <a href="audio_track_dropdown_menu.html#spgram_log" title="Audio Track Dropdown Menu">spectrogram log(f)</a> view and the spectral selection has a center frequency and an upper and lower boundary, performs the specified <i><b><a href="glossary.html#band_stop" title="Glossary">band cut</a></b></i> or <i><b><a href="glossary.html#band_pass" title="Glossary">band boost</a></b></i>. This can be used as an alternative to <a href="equalization.html" title="Equalization">Equalization</a> or may also be useful to repair damaged audio by reducing frequency spikes or boosting other frequencies to mask spikes.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SpectralEditShelves:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#spectral_edit_shelves" title="Effect Menu: Nyquist">Spectral edit shelves</a>
|
|
</td>
|
|
<td><i>double <b>control-gain</b>, (default:0)</i><br />
|
|
</td>
|
|
<td>When the selected track is in <a href="audio_track_dropdown_menu.html#spgram" title="Audio Track Dropdown Menu">spectrogram</a> or <a href="audio_track_dropdown_menu.html#spgram_log" title="Audio Track Dropdown Menu">spectrogram log(f)</a> view, applies either a low- or high-frequency shelving filter or both filters, according to the spectral selection made. This can be used as an alternative to <a href="equalization.html" title="Equalization">Equalization</a> or may also be useful to repair damaged audio by reducing frequency spikes or boosting other frequencies to mask spikes.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>StudioFadeOut:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#studio_fade_out" title="Effect Menu: Nyquist">Studio Fade Out</a>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>Applies a more musical fade out to the selected audio, giving a more pleasing sounding result.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Tremolo:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#tremolo" title="Effect Menu: Nyquist">Tremolo</a>
|
|
</td>
|
|
<td><i>enum <b>wave</b>, (default:Sine)</i><br />
|
|
<ul><li> Sine</li>
|
|
<li> Triangle</li>
|
|
<li> Sawtooth</li>
|
|
<li> InverseSawtooth</li>
|
|
<li> Square</li></ul>
|
|
<p><i>int <b>phase</b>, (default:0)</i><br />
|
|
<i>int <b>wet</b>, (default:0)</i><br />
|
|
<i>double <b>lfo</b>, (default:0)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Modulates the volume of the selection at the depth and rate selected in the dialog. The same as the tremolo effect familiar to guitar and keyboard players.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>VocalReductionAndIsolation:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#vocal_reduction_and_isolation" title="Effect Menu: Nyquist">Vocal Reduction and Isolation</a>
|
|
</td>
|
|
<td><i>enum <b>action</b>, (default:RemoveToMono)</i><br />
|
|
<ul><li> RemoveToMono</li>
|
|
<li> Remove</li>
|
|
<li> Isolate</li>
|
|
<li> IsolateInvert</li>
|
|
<li> RemoveCenterToMono</li>
|
|
<li> RemoveCenter</li>
|
|
<li> IsolateCenter</li>
|
|
<li> IsolateCenterInvert</li>
|
|
<li> Analyze</li></ul>
|
|
<p><i>double <b>strength</b>, (default:0)</i><br />
|
|
<i>double <b>low-transition</b>, (default:0)</i><br />
|
|
<i>double <b>high-transition</b>, (default:0)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Attempts to remove or isolate center-panned audio from a stereo track. Most "Remove" options in this effect preserve the stereo image.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Vocoder:</b>
|
|
</td>
|
|
<td><a href="effect_menu_nyquist.html#vocoder" title="Effect Menu: Nyquist">Vocoder</a>
|
|
</td>
|
|
<td><i>double <b>dst</b>, (default:0)</i><br />
|
|
<p><i>enum <b>mst</b>, (default:BothChannels)</i><br />
|
|
</p>
|
|
<ul><li> BothChannels</li>
|
|
<li> RightOnly</li></ul>
|
|
<p><i>int <b>bands</b>, (default:0)</i><br />
|
|
<i>double <b>track-vl</b>, (default:0)</i><br />
|
|
<i>double <b>noise-vl</b>, (default:0)</i><br />
|
|
<i>double <b>radar-vl</b>, (default:0)</i><br />
|
|
<i>double <b>radar-f</b>, (default:0)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Synthesizes audio (usually a voice) in the left channel of a stereo track with a <i>carrier wave</i> (typically white noise) in the right channel to produce a modified version of the left channel. Vocoding a normal voice with white noise will produce a robot-like voice for special effects.
|
|
</td></tr></table>
|
|
<div id="analyze_menu"></div>
|
|
<h2><span class="mw-headline" id="Analyze_Menu"><a href="analyze_menu.html" title="Analyze Menu">Analyze Menu</a></span></h2>
|
|
<div class="note">The Analyze Menu contains tools for finding out about the characteristics of your audio, or labeling key feature. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>ManageAnalyzers:</b>
|
|
</td>
|
|
<td><a href="analyze_menu.html#add_remove_plugins" title="Analyze Menu">Plugin Manager</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selecting this option from the Effect Menu (or the <a href="generate_menu.html" title="Generate Menu">Generate Menu</a> or <a href="analyze_menu.html" title="Analyze Menu">Analyze Menu</a>) takes you to a dialog where you can enable or disable particular Effects, Generators and Analyzers in Audacity. Even if you do not add any third-party plugins, you can use this to make the Effect menu shorter or longer as required. For details see <a href="manage_effects_generators_and_analyzers.html" title="Manage Effects, Generators and Analyzers">Plugin Manager</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ContrastAnalyser:</b>
|
|
</td>
|
|
<td><a href="analyze_menu.html#contrast" title="Analyze Menu">Contrast</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Analyzes a single mono or stereo speech track to determine the average <i><b><a href="glossary.html#rms" title="Glossary">RMS</a></b></i> <i>difference in volume</i> (contrast) between foreground speech and background music, audience noise or similar. The purpose is to determine if the speech will be intelligible to the hard of hearing.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlotSpectrum:</b>
|
|
</td>
|
|
<td><a href="analyze_menu.html#plot_spectrum" title="Analyze Menu">Plot Spectrum</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Takes the selected audio (which is a set of sound pressure values at points in time) and converts it to a graph of frequencies against <i><b><a href="glossary.html#amplitude" title="Glossary">amplitudes</a></b></i>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>FindClipping:</b>
|
|
</td>
|
|
<td><a href="analyze_menu.html#find_clipping" title="Analyze Menu">Find Clipping</a>
|
|
</td>
|
|
<td><i>int <b>Duty Cycle Start</b>, (default:3)</i><br />
|
|
<p><i>int <b>Duty Cycle End</b>, (default:3)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Displays runs of <i><b><a href="glossary.html#clipping" title="Glossary">clipped</a></b></i> samples in a <a href="label_tracks.html" title="Label Tracks">Label Track</a>, as a screen-reader accessible alternative to <span class="menu"><a href="view_menu.html" title="View Menu">View</a> > <a href="view_menu.html#Show_Clipping" title="View Menu">Show Clipping in Waveform</a></span>. A run must include at least one clipped sample, but may include unclipped samples too.
|
|
</td></tr></table>
|
|
<div id="analyze_nyquist_submenu"></div>
|
|
<h3><span class="mw-headline" id="Analyze:_Nyquist"><a href="analyze_menu.html" title="Analyze Menu">Analyze: Nyquist</a></span></h3>
|
|
<div class="note"> No special notes for Nyquist </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>BeatFinder:</b>
|
|
</td>
|
|
<td><a href="analyze_menu.html#beat_finder" title="Analyze Menu">Beat Finder</a>
|
|
</td>
|
|
<td><i>int <b>thresval</b>, (default:0)</i><br />
|
|
</td>
|
|
<td>Attempts to place <a href="label_tracks.html" title="Label Tracks">labels</a> at beats which are much louder than the surrounding audio. It's a fairly rough and ready tool, and will not necessarily work well on a typical modern pop music track with compressed <i><b><a href="glossary.html#dynamic_range" title="Glossary">dynamic range</a></b></i>. If you do not get enough beats detected, try reducing the "Threshold Percentage" setting.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>LabelSounds:</b>
|
|
</td>
|
|
<td><a href="analyze_menu.html#label_sounds" title="Analyze Menu">Label Sounds</a>
|
|
</td>
|
|
<td><i>double <b>threshold</b>, (default:0)</i><br />
|
|
<p><i>enum <b>measurement</b>, (default:peak)</i><br />
|
|
</p>
|
|
<ul><li> peak</li>
|
|
<li> avg</li>
|
|
<li> rms</li></ul>
|
|
<p><i>double <b>sil-dur</b>, (default:0)</i><br />
|
|
<i>double <b>snd-dur</b>, (default:0)</i><br />
|
|
<i>enum <b>type</b>, (default:before)</i><br />
|
|
</p>
|
|
<ul><li> before</li>
|
|
<li> after</li>
|
|
<li> around</li>
|
|
<li> between</li></ul>
|
|
<p><i>double <b>pre-offset</b>, (default:0)</i><br />
|
|
<i>double <b>post-offset</b>, (default:0)</i><br />
|
|
<i>string <b>text</b>, (default:"")</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Divides up a track by placing <a href="label_tracks.html" title="Label Tracks">labels</a> for areas of sound that are separated by silence.
|
|
</td></tr></table>
|
|
<div id="tools_menu"></div>
|
|
<h2><span class="mw-headline" id="Tools_Menu"><a href="tools_menu.html" title="Tools Menu">Tools Menu</a></span></h2>
|
|
<div class="note">The Tools Menu contains customisable tools. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>ManageTools:</b>
|
|
</td>
|
|
<td><a href="tools_menu.html#add_remove_plugins" title="Tools Menu">Plugin Manager</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selecting this option from the Effect Menu (or the <a href="generate_menu.html" title="Generate Menu">Generate Menu</a> or <a href="analyze_menu.html" title="Analyze Menu">Analyze Menu</a>) takes you to a dialog where you can enable or disable particular Effects, Generators and Analyzers in Audacity. Even if you do not add any third-party plugins, you can use this to make the Effect menu shorter or longer as required. For details see <a href="manage_effects_generators_and_analyzers.html" title="Manage Effects, Generators and Analyzers">Plugin Manager</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ManageMacros:</b>
|
|
</td>
|
|
<td><a href="tools_menu.html#macros" title="Tools Menu">Macros</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Creates a new macro or edits an existing macro.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Apply Macro:</b>
|
|
</td>
|
|
<td><a href="tools_menu.html#apply_macro" title="Tools Menu">Apply Macro</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Displays a menu with list of all your Macros. Selecting any of these Macros by clicking on it will cause that Macro to be applied to the current project.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Screenshot:</b>
|
|
</td>
|
|
<td><a href="tools_menu.html#screenshot" title="Tools Menu">Screenshot</a>
|
|
</td>
|
|
<td><i>string <b>Path</b>, (default:)</i><br />
|
|
<p><i>enum <b>CaptureWhat</b>, (default:Window)</i><br />
|
|
</p>
|
|
<ul><li> Window</li>
|
|
<li> FullWindow</li>
|
|
<li> WindowPlus</li>
|
|
<li> Fullscreen</li>
|
|
<li> Toolbars</li>
|
|
<li> Effects</li>
|
|
<li> Scriptables</li>
|
|
<li> Preferences</li>
|
|
<li> Selectionbar</li>
|
|
<li> SpectralSelection</li>
|
|
<li> Timer</li>
|
|
<li> Tools</li>
|
|
<li> Transport</li>
|
|
<li> Mixer</li>
|
|
<li> Meter</li>
|
|
<li> PlayMeter</li>
|
|
<li> RecordMeter</li>
|
|
<li> Edit</li>
|
|
<li> Device</li>
|
|
<li> Scrub</li>
|
|
<li> Play-at-Speed</li>
|
|
<li> Trackpanel</li>
|
|
<li> Ruler</li>
|
|
<li> Tracks</li>
|
|
<li> FirstTrack</li>
|
|
<li> FirstTwoTracks</li>
|
|
<li> FirstThreeTracks</li>
|
|
<li> FirstFourTracks</li>
|
|
<li> SecondTrack</li>
|
|
<li> TracksPlus</li>
|
|
<li> FirstTrackPlus</li>
|
|
<li> AllTracks</li>
|
|
<li> AllTracksPlus</li></ul>
|
|
<p><i>enum <b>Background</b>, (default:None)</i><br />
|
|
</p>
|
|
<ul><li> Blue</li>
|
|
<li> White</li>
|
|
<li> None</li></ul>
|
|
<p><i>bool <b>ToTop</b>, (default:True)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>A tool, mainly used in documentation, to capture screenshots of Audacity.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Benchmark:</b>
|
|
</td>
|
|
<td><a href="tools_menu.html#run_benchmark" title="Tools Menu">Run Benchmark</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>A tool for measuring the performance of one part of Audacity.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NyquistPrompt:</b>
|
|
</td>
|
|
<td><a href="tools_menu.html#nyquist_prompt" title="Tools Menu">Nyquist Prompt</a>
|
|
</td>
|
|
<td><i>string <b>Command</b>, (default:)</i><br />
|
|
<p><i>int <b>Version</b>, (default:3)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Brings up a dialog where you can enter Nyquist commands. Nyquist is a programming language for generating, processing and analyzing audio.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NyquistPlug-inInstaller:</b>
|
|
</td>
|
|
<td><a href="tools_menu.html#nyquist_plugin_installer" title="Tools Menu">Nyquist Plug-in Installer</a>
|
|
</td>
|
|
<td><i>string <b>files</b>, (default:)</i><br />
|
|
<p><i>enum <b>overwrite</b>, (default:Disallow)</i><br />
|
|
</p>
|
|
<ul><li> Disallow</li>
|
|
<li> Allow</li></ul>
|
|
</td>
|
|
<td>A Nyquist plugin that simplifies the installation of other Nyquist plugins.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>RegularIntervalLabels:</b>
|
|
</td>
|
|
<td><a href="tools_menu.html#regular_interval_labels" title="Tools Menu">Regular Interval Labels</a>
|
|
</td>
|
|
<td><i>enum <b>mode</b>, (default:Both)</i><br />
|
|
<ul><li> Both</li>
|
|
<li> Number</li>
|
|
<li> Interval</li></ul>
|
|
<p><i>int <b>totalnum</b>, (default:0)</i><br />
|
|
<i>double <b>interval</b>, (default:0)</i><br />
|
|
<i>double <b>region</b>, (default:0)</i><br />
|
|
<i>enum <b>adjust</b>, (default:No)</i><br />
|
|
</p>
|
|
<ul><li> No</li>
|
|
<li> Yes</li></ul>
|
|
<p><i>string <b>labeltext</b>, (default:)</i><br />
|
|
<i>enum <b>zeros</b>, (default:TextOnly)</i><br />
|
|
</p>
|
|
<ul><li> TextOnly</li>
|
|
<li> OneBefore</li>
|
|
<li> TwoBefore</li>
|
|
<li> ThreeBefore</li>
|
|
<li> OneAfter</li>
|
|
<li> TwoAfter</li>
|
|
<li> ThreeAfter</li></ul>
|
|
<p><i>int <b>firstnum</b>, (default:0)</i><br />
|
|
<i>enum <b>verbose</b>, (default:Details)</i><br />
|
|
</p>
|
|
<ul><li> Details</li>
|
|
<li> Warnings</li>
|
|
<li> None</li></ul>
|
|
</td>
|
|
<td>Places <a href="label_tracks.html" title="Label Tracks">labels</a> in a long track so as to divide it into smaller, equally sized segments.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SampleDataExport:</b>
|
|
</td>
|
|
<td><a href="tools_menu.html#sample_data_export" title="Tools Menu">Sample Data Export</a>
|
|
</td>
|
|
<td><i>int <b>number</b>, (default:0)</i><br />
|
|
<p><i>enum <b>units</b>, (default:dB)</i><br />
|
|
</p>
|
|
<ul><li> dB</li>
|
|
<li> Linear</li></ul>
|
|
<p><i>string <b>filename</b>, (default:)</i><br />
|
|
<i>enum <b>fileformat</b>, (default:None)</i><br />
|
|
</p>
|
|
<ul><li> None</li>
|
|
<li> Count</li>
|
|
<li> Time</li></ul>
|
|
<p><i>enum <b>header</b>, (default:None)</i><br />
|
|
</p>
|
|
<ul><li> None</li>
|
|
<li> Minimal</li>
|
|
<li> Standard</li>
|
|
<li> All</li></ul>
|
|
<p><i>string <b>optext</b>, (default:)</i><br />
|
|
<i>enum <b>channel-layout</b>, (default:SameLine)</i><br />
|
|
</p>
|
|
<ul><li> SameLine</li>
|
|
<li> Alternate</li>
|
|
<li> LFirst</li></ul>
|
|
<p><i>enum <b>messages</b>, (default:Yes)</i><br />
|
|
</p>
|
|
<ul><li> Yes</li>
|
|
<li> Errors</li>
|
|
<li> None</li></ul>
|
|
</td>
|
|
<td>Reads the values of successive samples from the selected audio and prints this data to a plain text, CSV or HTML file.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SampleDataImport:</b>
|
|
</td>
|
|
<td><a href="tools_menu.html#sample_data_import" title="Tools Menu">Sample Data Import</a>
|
|
</td>
|
|
<td><i>string <b>filename</b>, (default:)</i><br />
|
|
<p><i>enum <b>bad-data</b>, (default:ThrowError)</i><br />
|
|
</p>
|
|
<ul><li> ThrowError</li>
|
|
<li> ReadAsZero</li></ul>
|
|
</td>
|
|
<td>Reads numeric values from a plain ASCII text file and creates a PCM sample for each numeric value read.
|
|
</td></tr></table>
|
|
<div id="tools_apply_macro_submenu"></div>
|
|
<h3><span class="mw-headline" id="Tools:_Apply_Macro"><a href="tools_menu_apply_macro.html" title="Tools Menu: Apply Macro">Tools: Apply Macro</a></span></h3>
|
|
<div class="note">Displays a menu with list of all your Macros. Selecting any of these Macros by clicking on it will cause that Macro to be applied to the current project. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>ApplyMacrosPalette:</b>
|
|
</td>
|
|
<td><a href="tools_menu_apply_macro.html#palette" title="Tools Menu: Apply Macro">Palette</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Displays a menu with list of all your Macros which can be applied to the current project or to audio files..
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Macro_FadeEnds:</b>
|
|
</td>
|
|
<td><a href="tools_menu_apply_macro.html#fade_ends" title="Tools Menu: Apply Macro">Fade Ends</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Fades in the first second and fades out the last second of a track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Macro_MP3Conversion:</b>
|
|
</td>
|
|
<td><a href="tools_menu_apply_macro.html#mp3_conversion" title="Tools Menu: Apply Macro">MP3 Conversion</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Converts MP3.
|
|
</td></tr></table>
|
|
<div id="extra_menu"></div>
|
|
<h2><span class="mw-headline" id="Extra_Menu"><a href="extra_menu.html" title="Extra Menu">Extra Menu</a></span></h2>
|
|
<div class="note">The Extra menu provides access to additional Commands that are not available in the normal default Audacity menus. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>PlayAtSpeed:</b>
|
|
</td>
|
|
<td><a href="extra_menu.html#playatspeed" title="Extra Menu">Play-at-Speed</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Extra commands related to play at speed
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>FullScreenOnOff:</b>
|
|
</td>
|
|
<td><a href="extra_menu.html#full_screen_onoff" title="Extra Menu">Full Screen (on/off)</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Toggle full screen mode with no title bar
|
|
</td></tr></table>
|
|
<div id="extra_transport_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Transport"><a href="extra_menu_transport.html" title="Extra Menu: Transport">Extra: Transport</a></span></h3>
|
|
<div class="note">Extra commands related to play and record </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Play:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#play" title="Extra Menu: Transport">Play</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Play (or stop) audio
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Stop:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#stop" title="Extra Menu: Transport">Stop</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Stop audio
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlayOneSec:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#play_one_second" title="Extra Menu: Transport">Play One Second</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Plays for one second centered on the current <b>mouse pointer</b> position (not from the current cursor position). See <a href="playing_and_recording.html#Play_One_Second_.281.29" title="Playing and Recording">this page</a> for an example.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlayToSelection:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#play_to_selection" title="Extra Menu: Transport">Play to Selection</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Plays to or from the current <b>mouse pointer</b> position to or from the start or end of the selection, depending on the pointer position. See <a href="playing_and_recording.html#Play_To_Selection_.28B.29" title="Playing and Recording">this page</a> for more details.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlayBeforeSelectionStart:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#play_before_selection_start" title="Extra Menu: Transport">Play Before Selection Start</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Plays a short period before the start of the selected audio, the period before shares the setting of the cut preview.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlayAfterSelectionStart:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#play_after_selection_start" title="Extra Menu: Transport">Play After Selection Start</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Plays a short period after the start of the selected audio, the period after shares the setting of the cut preview.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlayBeforeSelectionEnd:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#play_before_selection_end" title="Extra Menu: Transport">Play Before Selection End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Plays a short period before the end of the selected audio, the period before shares the setting of the cut preview.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlayAfterSelectionEnd:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#play_after_selection_end" title="Extra Menu: Transport">Play After Selection End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Plays a short period after the end of the selected audio, the period after shares the setting of the cut preview.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlayBeforeAndAfterSelectionStart:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#play_before_and_after_selection_start" title="Extra Menu: Transport">Play Before and After Selection Start</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Plays a short period before and after the start of the selected audio, the periods before and after share the setting of the cut preview.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlayBeforeAndAfterSelectionEnd:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#play_before_and_after_selection_end" title="Extra Menu: Transport">Play Before and After Selection End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Plays a short period before and after the end of the selected audio, the periods before and after share the setting of the cut preview.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlayCutPreview:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#play_cut_preview" title="Extra Menu: Transport">Play Cut Preview</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Plays audio excluding the selection
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ScrubBackwards:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#scrubbers" title="Extra Menu: Transport">Scrub Backwards</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Does nothing, is there so that users can know what the default shortcut key is, and so they can change it in <a href="keyboard_preferences.html" title="Keyboard Preferences">Shortcuts Preferences</a> if they want to.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ScrubForwards:</b>
|
|
</td>
|
|
<td><a href="extra_menu_transport.html#scrubbers" title="Extra Menu: Transport">Scrub Forwards</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Does nothing, is there so that users can know what the default shortcut key is, and so they can change it in <a href="keyboard_preferences.html" title="Keyboard Preferences">Shortcuts Preferences</a> if they want to.
|
|
</td></tr></table>
|
|
<div id="extra_tools_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Tools"><a href="extra_menu_tools.html" title="Extra Menu: Tools">Extra: Tools</a></span></h3>
|
|
<div class="note">Extra commands to select the tool, for example time-shift, envelopes, multi-tool. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>SelectTool:</b>
|
|
</td>
|
|
<td><a href="extra_menu_tools.html#selection_tool" title="Extra Menu: Tools">Selection Tool</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Chooses Selection tool.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>EnvelopeTool:</b>
|
|
</td>
|
|
<td><a href="extra_menu_tools.html#envelope_tool" title="Extra Menu: Tools">Envelope Tool</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Chooses Envelope tool.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>DrawTool:</b>
|
|
</td>
|
|
<td><a href="extra_menu_tools.html#draw_tool" title="Extra Menu: Tools">Draw Tool</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Chooses Draw tool.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>MultiTool:</b>
|
|
</td>
|
|
<td><a href="extra_menu_tools.html#multi_tool" title="Extra Menu: Tools">Multi Tool</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Chooses the Multi-Tool
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PrevTool:</b>
|
|
</td>
|
|
<td><a href="extra_menu_tools.html#previous_tool" title="Extra Menu: Tools">Previous Tool</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Cycles backwards through the tools, starting from the currently selected tool: starting from Selection, it would navigate to Multi-tool to Zoom to Draw to Envelope to Selection.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NextTool:</b>
|
|
</td>
|
|
<td><a href="extra_menu_tools.html#next_tool" title="Extra Menu: Tools">Next Tool</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Cycles forwards through the tools, starting from the currently selected tool: starting from Selection, it would navigate to Envelope to Draw to Zoom to Multi-tool to Selection.
|
|
</td></tr></table>
|
|
<div id="extra_mixer_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Mixer"><a href="extra_menu_mixer.html" title="Extra Menu: Mixer">Extra: Mixer</a></span></h3>
|
|
<div class="note">Extra commands related to volume </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>OutputGain:</b>
|
|
</td>
|
|
<td><a href="extra_menu_mixer.html#adjust_playback_volume" title="Extra Menu: Mixer">Adjust Playback Volume</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Displays the Playback Volume dialog. You can type a new value for the playback volume (between 0 and 1), or press <span class="kbrd" style="background-color: #e0e0f0">Tab</span>, then use the left and right arrow keys to adjust the slider.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>OutputGainInc:</b>
|
|
</td>
|
|
<td><a href="extra_menu_mixer.html#increase_playback_volume" title="Extra Menu: Mixer">Increase Playback Volume</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Each key press will increase the playback volume by 0.1.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>OutputGainDec:</b>
|
|
</td>
|
|
<td><a href="extra_menu_mixer.html#decrease_playback_volume" title="Extra Menu: Mixer">Decrease Playback Volume</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Each key press will decrease the playback volume by 0.1.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>InputGain:</b>
|
|
</td>
|
|
<td><a href="extra_menu_mixer.html#adjust_recording_volume" title="Extra Menu: Mixer">Adjust Recording Volume</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Displays the Recording Volume dialog. You can type a new value for the recording volume (between 0 and 1), or press <span class="kbrd" style="background-color: #e0e0f0">Tab</span>, then use the left and right arrow keys to adjust the slider.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>InputGainInc:</b>
|
|
</td>
|
|
<td><a href="extra_menu_mixer.html#increase_recording_volume" title="Extra Menu: Mixer">Increase Recording Volume</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Each key press will increase the recording volume by 0.1.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>InputGainDec:</b>
|
|
</td>
|
|
<td><a href="extra_menu_mixer.html#decrease_recording_volume" title="Extra Menu: Mixer">Decrease Recording Volume</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Each key press will decrease the recording volume by 0.1.
|
|
</td></tr></table>
|
|
<div id="extra_edit_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Edit"><a href="extra_menu_edit.html" title="Extra Menu: Edit">Extra: Edit</a></span></h3>
|
|
<div class="note">Extra commands related to editing </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>DeleteKey:</b>
|
|
</td>
|
|
<td><a href="extra_menu_edit.html#delete_key" title="Extra Menu: Edit">Delete Key</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Deletes the selection. When focus is in <a href="selection_toolbar.html" title="Selection Toolbar">Selection Toolbar</a>, BACKSPACE is not a shortcut but navigates back to the previous digit and sets it to zero.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>DeleteKey2:</b>
|
|
</td>
|
|
<td><a href="extra_menu_edit.html#delete_key2" title="Extra Menu: Edit">Delete Key2</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Deletes the selection.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TimeShiftLeft:</b>
|
|
</td>
|
|
<td><a href="extra_menu_edit.html#time_shift_left" title="Extra Menu: Edit">Time Shift Left</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the <a href="audio_tracks.html#focus" title="Audio Tracks">currently focused</a> audio track (or a separate <a href="audacity_tracks_and_clips.html" title="Audacity Tracks and Clips">clip</a> in that track which contains the editing cursor or <a href="audacity_selection.html" title="Audacity Selection">selection region</a>) one screen pixel to left.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TimeShiftRight:</b>
|
|
</td>
|
|
<td><a href="extra_menu_edit.html#time_shift_right" title="Extra Menu: Edit">Time Shift Right</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the <a href="audio_tracks.html#focus" title="Audio Tracks">currently focused</a> audio track (or a separate <a href="audacity_tracks_and_clips.html" title="Audacity Tracks and Clips">clip</a> in that track which contains the editing cursor or <a href="audacity_selection.html" title="Audacity Selection">selection region</a>) one screen pixel to right.
|
|
</td></tr></table>
|
|
<div id="extra_playatspeed_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Play-at-Speed"><a href="extra_menu_play_at_speed.html" title="Extra Menu: Play-at-Speed">Extra: Play-at-Speed</a></span></h3>
|
|
<div class="note">Extra commands related to play at speed </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>PlayAtSpeed:</b>
|
|
</td>
|
|
<td><a href="extra_menu_play_at_speed.html#normal_playatspeed" title="Extra Menu: Play-at-Speed">Normal Play-at-Speed</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Play audio at a faster or slower speed
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlayAtSpeedLooped:</b>
|
|
</td>
|
|
<td><a href="extra_menu_play_at_speed.html#loop_playatspeed" title="Extra Menu: Play-at-Speed">Loop Play-at-Speed</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Combines looped play and play at speed
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlayAtSpeedCutPreview:</b>
|
|
</td>
|
|
<td><a href="extra_menu_play_at_speed.html#play_cut_previewatspeed" title="Extra Menu: Play-at-Speed">Play Cut Preview-at-Speed</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Combines cut preview and play at speed
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SetPlaySpeed:</b>
|
|
</td>
|
|
<td><a href="extra_menu_play_at_speed.html#adjust_playback_speed" title="Extra Menu: Play-at-Speed">Adjust Playback Speed</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Displays the Playback Speed dialog. You can type a new value for the playback volume (between 0 and 1), or press <span class="kbrd" style="background-color: #e0e0f0">Tab</span>, then use the left and right arrow keys to adjust the slider.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlaySpeedInc:</b>
|
|
</td>
|
|
<td><a href="extra_menu_play_at_speed.html#increase_playback_speed" title="Extra Menu: Play-at-Speed">Increase Playback Speed</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Each key press will increase the playback speed by 0.1.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PlaySpeedDec:</b>
|
|
</td>
|
|
<td><a href="extra_menu_play_at_speed.html#decrease_playback_speed" title="Extra Menu: Play-at-Speed">Decrease Playback Speed</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Each key press will decrease the playback speed by 0.1.
|
|
</td></tr></table>
|
|
<div id="extra_seek_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Seek"><a href="extra_menu_seek.html" title="Extra Menu: Seek">Extra: Seek</a></span></h3>
|
|
<div class="note">Extra commands related to seeking </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>SeekLeftShort:</b>
|
|
</td>
|
|
<td><a href="extra_menu_seek.html#short_seek_left_during_playback" title="Extra Menu: Seek">Short Seek Left During Playback</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Skips the playback cursor back one second by default.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SeekRightShort:</b>
|
|
</td>
|
|
<td><a href="extra_menu_seek.html#short_seek_right_during_playback" title="Extra Menu: Seek">Short Seek Right During Playback</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Skips the playback cursor forward one second by default.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SeekLeftLong:</b>
|
|
</td>
|
|
<td><a href="extra_menu_seek.html#long_seek_left_during_playback" title="Extra Menu: Seek">Long Seek Left During Playback</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Skips the playback cursor back 15 seconds by default.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SeekRightLong:</b>
|
|
</td>
|
|
<td><a href="extra_menu_seek.html#long_seek_right_during_playback" title="Extra Menu: Seek">Long Seek Right During Playback</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Skips the playback cursor forward 15 seconds by default.
|
|
</td></tr></table>
|
|
<div id="extra_device_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Device"><a href="extra_menu_device.html" title="Extra Menu: Device">Extra: Device</a></span></h3>
|
|
<div class="note">Extra commands related to selecting a device </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>InputDevice:</b>
|
|
</td>
|
|
<td><a href="extra_menu_device.html#change_recording_device" title="Extra Menu: Device">Change Recording Device</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Displays the Select recording Device dialog for choosing the recording device, but only if the "Recording Device" dropdown menu in Audio Setup Toolbar has entries for devices. Otherwise, an recording error message will be displayed.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>OutputDevice:</b>
|
|
</td>
|
|
<td><a href="extra_menu_device.html#change_playback_device" title="Extra Menu: Device">Change Playback Device</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Displays the Select Playback Device dialog for choosing the playback device, but only if the "Playback Device" dropdown menu in Audio Setup Toolbar has entries for devices. Otherwise, an error message will be displayed.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>AudioHost:</b>
|
|
</td>
|
|
<td><a href="extra_menu_device.html#change_audio_host" title="Extra Menu: Device">Change Audio Host</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Displays the Select Audio Host dialog for choosing the particular interface with which Audacity communicates with your chosen playback and recording devices.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>InputChannels:</b>
|
|
</td>
|
|
<td><a href="extra_menu_device.html#change_recording_channels" title="Extra Menu: Device">Change Recording Channels</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Displays the Select Recording Channels dialog for choosing the number of channels to be recorded by the chosen recording device.
|
|
</td></tr></table>
|
|
<div id="extra_selection_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Selection"><a href="extra_menu_selection.html" title="Extra Menu: Selection">Extra: Selection</a></span></h3>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>SnapToOff:</b>
|
|
</td>
|
|
<td><a href="extra_menu_selection.html#snapto_off" title="Extra Menu: Selection">Snap-To Off</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Equivalent to setting the Snap To control in Selection Toolbar to "Off".
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SnapToNearest:</b>
|
|
</td>
|
|
<td><a href="extra_menu_selection.html#snapto_nearest" title="Extra Menu: Selection">Snap-To Nearest</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Equivalent to setting the Snap To control in Selection Toolbar to "Nearest".
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SnapToPrior:</b>
|
|
</td>
|
|
<td><a href="extra_menu_selection.html#snapto_prior" title="Extra Menu: Selection">Snap-To Prior</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Equivalent to setting the Snap To control in Selection Toolbar to "Prior".
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelStart:</b>
|
|
</td>
|
|
<td><a href="extra_menu_selection.html#selection_to_start" title="Extra Menu: Selection">Selection to Start</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Select from cursor to start of track
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelEnd:</b>
|
|
</td>
|
|
<td><a href="extra_menu_selection.html#selection_to_end" title="Extra Menu: Selection">Selection to End</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Select from cursor to end of track
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelExtLeft:</b>
|
|
</td>
|
|
<td><a href="extra_menu_selection.html#selection_extend_left" title="Extra Menu: Selection">Selection Extend Left</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Increases the size of the selection by extending it to the left. The amount of increase is dependent on the zoom level. If there is no selection one is created starting at the cursor position.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelExtRight:</b>
|
|
</td>
|
|
<td><a href="extra_menu_selection.html#selection_extend_right" title="Extra Menu: Selection">Selection Extend Right</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Increases the size of the selection by extending it to the right. The amount of increase is dependent on the zoom level. If there is no selection one is created starting at the cursor position.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelSetExtLeft:</b>
|
|
</td>
|
|
<td><a href="extra_menu_selection.html#set_or_extend_left_selection" title="Extra Menu: Selection">Set (or Extend) Left Selection</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Extend selection left a little (is this a duplicate?)
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelSetExtRight:</b>
|
|
</td>
|
|
<td><a href="extra_menu_selection.html#set_or_extend_right_selection" title="Extra Menu: Selection">Set (or Extend) Right Selection</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Extend selection right a litlle (is this a duplicate?)
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelCntrLeft:</b>
|
|
</td>
|
|
<td><a href="extra_menu_selection.html#selection_contract_left" title="Extra Menu: Selection">Selection Contract Left</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Decreases the size of the selection by contracting it from the right. The amount of decrease is dependent on the zoom level. If there is no selection no action is taken.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelCntrRight:</b>
|
|
</td>
|
|
<td><a href="extra_menu_selection.html#selection_contract_right" title="Extra Menu: Selection">Selection Contract Right</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Decreases the size of the selection by contracting it from the left. The amount of decrease is dependent on the zoom level. If there is no selection no action is taken.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>MoveToPrevLabel:</b>
|
|
</td>
|
|
<td><a href="extra_menu_play_at_speed.html#move_to_previous_label" title="Extra Menu: Play-at-Speed">Move to Previous Label</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves selection to the previous label
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>MoveToNextLabel:</b>
|
|
</td>
|
|
<td><a href="extra_menu_play_at_speed.html#move_to_next_label" title="Extra Menu: Play-at-Speed">Move to Next Label</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves selection to the next label
|
|
</td></tr></table>
|
|
<div id="extra_timeline_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Timeline">Extra: Timeline</span></h3>
|
|
<div class="note">Extra commands related to changing the format of the Timeline </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>MinutesandSeconds:</b>
|
|
</td>
|
|
<td>Minutes and Seconds
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Changes the <a href="timeline.html" title="Timeline"><b>Timeline</b></a> display format to <b>Minutes and Seconds</b> <i>(default setting)</i>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>BeatsandMeasures:</b>
|
|
</td>
|
|
<td>Beats and Measures
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Changes the <a href="timeline.html" title="Timeline"><b>Timeline</b></a> display format to <b>Beats and Measures</b>.
|
|
</td></tr></table>
|
|
<div id="extra_focus_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Focus"><a href="extra_menu_focus.html" title="Extra Menu: Focus">Extra: Focus</a></span></h3>
|
|
<div class="note">Extra commands to set focus, usually focus on one track </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>PrevFrame:</b>
|
|
</td>
|
|
<td><a href="extra_menu_focus.html#move_backward_from_toolbars_to_tracks" title="Extra Menu: Focus">Move Backward from Toolbars to Tracks</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Move backward through currently focused toolbar in <a href="toolbars_overview.html#upper_tooldock" title="Toolbars Overview">Upper Toolbar dock area</a>, Track View and currently focused toolbar in <a href="toolbars_overview.html#lower_tooldock" title="Toolbars Overview">Lower Toolbar dock area</a>. Each use moves the keyboard focus as indicated.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NextFrame:</b>
|
|
</td>
|
|
<td><a href="extra_menu_focus.html#move_forward_from_toolbars_to_tracks" title="Extra Menu: Focus">Move Forward from Toolbars to Tracks</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Move forward through currently focused toolbar in <a href="toolbars_overview.html#upper_tooldock" title="Toolbars Overview">Upper Toolbar dock area</a>, Track View and currently focused toolbar in <a href="toolbars_overview.html#lower_tooldock" title="Toolbars Overview">Lower Toolbar dock area</a>. Each use moves the keyboard focus as indicated.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>PrevTrack:</b>
|
|
</td>
|
|
<td><a href="extra_menu_focus.html#move_focus_to_previous_track" title="Extra Menu: Focus">Move Focus to Previous Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Focus one track up
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NextTrack:</b>
|
|
</td>
|
|
<td><a href="extra_menu_focus.html#move_focus_to_next_track" title="Extra Menu: Focus">Move Focus to Next Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Focus one track down
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>FirstTrack:</b>
|
|
</td>
|
|
<td><a href="extra_menu_focus.html#move_focus_to_first_track" title="Extra Menu: Focus">Move Focus to First Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Focus on first track
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>LastTrack:</b>
|
|
</td>
|
|
<td><a href="extra_menu_focus.html#move_focus_to_last_track" title="Extra Menu: Focus">Move Focus to Last Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Focus on last track
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShiftUp:</b>
|
|
</td>
|
|
<td><a href="extra_menu_focus.html#move_focus_to_previous_and_select" title="Extra Menu: Focus">Move Focus to Previous and Select</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Focus one track up and select it
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ShiftDown:</b>
|
|
</td>
|
|
<td><a href="extra_menu_focus.html#move_focus_to_next_and_select" title="Extra Menu: Focus">Move Focus to Next and Select</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Focus one track down and select it
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Toggle:</b>
|
|
</td>
|
|
<td><a href="extra_menu_focus.html#toggle_focused_track" title="Extra Menu: Focus">Toggle Focused Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Toggle focus on current track
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ToggleAlt:</b>
|
|
</td>
|
|
<td><a href="extra_menu_focus.html#toggle_focused_track" title="Extra Menu: Focus">Toggle Focused Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Toggle focus on current track
|
|
</td></tr></table>
|
|
<div id="extra_cursor_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Cursor"><a href="extra_menu_cursor.html" title="Extra Menu: Cursor">Extra: Cursor</a></span></h3>
|
|
<div class="note">Extra commands to move the cursor </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>CursorLeft:</b>
|
|
</td>
|
|
<td><a href="extra_menu_cursor.html#cursor_left" title="Extra Menu: Cursor">Cursor Left</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When not playing audio, moves the editing cursor one screen pixel to left. When a <a href="snapping_toolbar.html" title="Snapping Toolbar">Snap</a> option is chosen, moves the cursor to the preceding unit of time as determined by the current <a href="audacity_selection.html#selection_formats" title="Audacity Selection">selection format</a>. If the key is held down, the cursor speed depends on the length of the tracks. When playing audio, moves the playback cursor as described at "Cursor Short Jump Left"
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CursorRight:</b>
|
|
</td>
|
|
<td><a href="extra_menu_cursor.html#cursor_right" title="Extra Menu: Cursor">Cursor Right</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When not playing audio, moves the editing cursor one screen pixel to right. When a <a href="snapping_toolbar.html" title="Snapping Toolbar">Snap</a> option is chosen, moves the cursor to the following unit of time as determined by the current <a href="audacity_selection.html#selection_formats" title="Audacity Selection">selection format</a>. If the key is held down, the cursor speed depends on the length of the tracks. When playing audio, moves the playback cursor as described at "Cursor Short Jump Right"
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CursorShortJumpLeft:</b>
|
|
</td>
|
|
<td><a href="extra_menu_cursor.html#cursor_short_jump_left" title="Extra Menu: Cursor">Cursor Short Jump Left</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When not playing audio, moves the editing cursor one second left by default. When playing audio, moves the playback cursor one second left by default. The default value can be changed by adjusting the "Short Period" under "Seek Time when playing" in <a href="playback_preferences.html" title="Playback Preferences">Playback Preferences</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CursorShortJumpRight:</b>
|
|
</td>
|
|
<td><a href="extra_menu_cursor.html#cursor_short_jump_right" title="Extra Menu: Cursor">Cursor Short Jump Right</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When not playing audio, moves the editing cursor one second right by default. When playing audio, moves the playback cursor one second right by default. The default value can be changed by adjusting the "Short Period" under "Seek Time when playing" in <a href="playback_preferences.html" title="Playback Preferences">Playback Preferences</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CursorLongJumpLeft:</b>
|
|
</td>
|
|
<td><a href="extra_menu_cursor.html#cursor_long_jump_left" title="Extra Menu: Cursor">Cursor Long Jump Left</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When not playing audio, moves the editing cursor 15 seconds left by default. When playing audio, moves the playback cursor 15 seconds left by default. The default value can be changed by adjusting the "Long Period" under "Seek Time when playing" in <a href="playback_preferences.html" title="Playback Preferences">Playback Preferences</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CursorLongJumpRight:</b>
|
|
</td>
|
|
<td><a href="extra_menu_cursor.html#cursor_long_jump_right" title="Extra Menu: Cursor">Cursor Long Jump Right</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>When not playing audio, moves the editing cursor 15 seconds right by default. When playing audio, moves the playback cursor 15 seconds right by default. The default value can be changed by adjusting the "Long Period" under "Seek Time when playing" in <a href="playback_preferences.html" title="Playback Preferences">Playback Preferences</a>.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ClipLeft:</b>
|
|
</td>
|
|
<td><a href="extra_menu_cursor.html#clip_left" title="Extra Menu: Cursor">Clip Left</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the <a href="audio_tracks.html#focus" title="Audio Tracks">currently focused</a> audio track (or a separate <a href="audacity_tracks_and_clips.html" title="Audacity Tracks and Clips">clip</a> in that track which contains the editing cursor or <a href="audacity_selection.html" title="Audacity Selection">selection region</a>) one screen pixel to left.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>ClipRight:</b>
|
|
</td>
|
|
<td><a href="extra_menu_cursor.html#clip_right" title="Extra Menu: Cursor">Clip Right</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the <a href="audio_tracks.html#focus" title="Audio Tracks">currently focused</a> audio track (or a separate <a href="audacity_tracks_and_clips.html" title="Audacity Tracks and Clips">clip</a> in that track which contains the editing cursor or <a href="audacity_selection.html" title="Audacity Selection">selection region</a>) one screen pixel to right.
|
|
</td></tr></table>
|
|
<div id="extra_track_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Track"><a href="extra_menu_track.html" title="Extra Menu: Track">Extra: Track</a></span></h3>
|
|
<div class="note">Extra commands to operate on a track that has focus </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>TrackPan:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#change_pan_on_focused_track" title="Extra Menu: Track">Change Pan on Focused Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Brings up the Pan dialog for the focused track where you can enter a pan value, or use the slider for finer control of panning than is available when using the track pan slider.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackPanLeft:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#pan_left_on_focused_track" title="Extra Menu: Track">Pan Left on Focused Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Controls the pan slider on the focused track. Each keypress changes the pan value by 10% left.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackPanRight:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#pan_right_on_focused_track" title="Extra Menu: Track">Pan Right on Focused Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Controls the pan slider on the focused track. Each keypress changes the pan value by 10% right.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackGain:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#change_gain_on_focused_track" title="Extra Menu: Track">Change Gain on Focused Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Brings up the Gain dialog for the focused track where you can enter a gain value, or use the slider for finer control of gain than is available when using the track pan slider.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackGainInc:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#increase_gain_on_focused_track" title="Extra Menu: Track">Increase Gain on Focused Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Controls the gain slider on the focused track. Each keypress increases the gain value by 1 dB.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackGainDec:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#decrease_gain_on_focused_track" title="Extra Menu: Track">Decrease Gain on Focused Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Controls the gain slider on the focused track. Each keypress decreases the gain value by 1 dB.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackMenu:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#open_menu_on_focused_track" title="Extra Menu: Track">Open Menu on Focused Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Opens the <a href="audio_track_dropdown_menu.html" title="Audio Track Dropdown Menu">Audio Track Dropdown Menu</a> on the focused <a href="audio_tracks.html" title="Audio Tracks">audio track</a> or <a href="tracks.html" title="Tracks">other track type</a>. In the audio track dropdown, use <span class="kbrd" style="background-color: #e0e0f0">Up</span>, and <span class="kbrd" style="background-color: #e0e0f0">Down</span>, arrow keys to navigate the menu and <span class="kbrd" style="background-color: #e0e0f0">Enter</span>, to select a menu item. Use <span class="kbrd" style="background-color: #e0e0f0">Right</span>, arrow to open the "Set Sample Format" and "Set Rate" choices or <span class="kbrd" style="background-color: #e0e0f0">Left</span>, arrow to leave those choices.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackMute:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#muteunmute_focused_track" title="Extra Menu: Track">Mute/Unmute Focused Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Toggles the Mute button on the focused track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackSolo:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#solounsolo_focused_track" title="Extra Menu: Track">Solo/Unsolo Focused Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Toggles the Solo button on the focused track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackClose:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#close_focused_track" title="Extra Menu: Track">Close Focused Track</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Close (remove) the focused track only.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackMoveUp:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#move_focused_track_up" title="Extra Menu: Track">Move Focused Track Up</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the focused track up by one track and moves the focus there.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackMoveDown:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#move_focused_track_down" title="Extra Menu: Track">Move Focused Track Down</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the focused track down by one track and moves the focus there.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackMoveTop:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#move_focused_track_to_top" title="Extra Menu: Track">Move Focused Track to Top</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the focused track up to the top of the track table and moves the focus there.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>TrackMoveBottom:</b>
|
|
</td>
|
|
<td><a href="extra_menu_track.html#move_focused_track_to_bottom" title="Extra Menu: Track">Move Focused Track to Bottom</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Moves the focused track down to the bottom of the track table and moves the focus there.
|
|
</td></tr></table>
|
|
<div id="extra_scriptables_i_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Scriptables_I"><a href="extra_menu_scriptables_i.html" title="Extra Menu: Scriptables I">Extra: Scriptables I</a></span></h3>
|
|
<div class="note">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") </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>SelectTime:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_i.html#select_time" title="Extra Menu: Scriptables I">Select Time</a>
|
|
</td>
|
|
<td><i>double <b>Start</b>, (default:unchanged)</i><br />
|
|
<p><i>double <b>End</b>, (default:unchanged)</i><br />
|
|
<i>enum <b>RelativeTo</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> ProjectStart</li>
|
|
<li> Project</li>
|
|
<li> ProjectEnd</li>
|
|
<li> SelectionStart</li>
|
|
<li> Selection</li>
|
|
<li> SelectionEnd</li></ul>
|
|
</td>
|
|
<td>Modifies the temporal selection. Start and End are time. FromEnd allows selection from the end, which is handy to fade in and fade out a track. <p>Note carefully that the Start time should be a negative number relative to the chosen start position.</p>
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelectFrequencies:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_i.html#select_frequencies" title="Extra Menu: Scriptables I">Select Frequencies</a>
|
|
</td>
|
|
<td><i>double <b>High</b>, (default:unchanged)</i><br />
|
|
<p><i>double <b>Low</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Modifies what frequencies are selected. High and Low are for spectral selection.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SelectTracks:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_i.html#select_tracks" title="Extra Menu: Scriptables I">Select Tracks</a>
|
|
</td>
|
|
<td><i>double <b>Track</b>, (default:unchanged)</i><br />
|
|
<p><i>double <b>TrackCount</b>, (default:unchanged)</i><br />
|
|
<i>enum <b>Mode</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Set</li>
|
|
<li> Add</li>
|
|
<li> Remove</li></ul>
|
|
</td>
|
|
<td>Modifies which tracks are selected. First and Last are track numbers. High and Low are for spectral selection. The Mode parameter allows complex selections, e.g adding or removing tracks from the current selection.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SetTrackStatus:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_i.html#set_track_status" title="Extra Menu: Scriptables I">Set Track Status</a>
|
|
</td>
|
|
<td><i>string <b>Name</b>, (default:unchanged)</i><br />
|
|
<p><i>bool <b>Selected</b>, (default:unchanged)</i><br />
|
|
<i>bool <b>Focused</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Sets properties for a track or channel (or both).Name is used to set the name. It is not used in choosing the track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SetTrackAudio:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_i.html#set_track_audio" title="Extra Menu: Scriptables I">Set Track Audio</a>
|
|
</td>
|
|
<td><i>bool <b>Mute</b>, (default:unchanged)</i><br />
|
|
<p><i>bool <b>Solo</b>, (default:unchanged)</i><br />
|
|
<i>double <b>Gain</b>, (default:unchanged)</i><br />
|
|
<i>double <b>Pan</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Sets properties for a track or channel (or both). Can set pan, gain, mute and solo.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SetTrackVisuals:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_i.html#set_track_visuals" title="Extra Menu: Scriptables I">Set Track Visuals</a>
|
|
</td>
|
|
<td><i>int <b>Height</b>, (default:unchanged)</i><br />
|
|
<p><i>enum <b>Display</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Waveform</li>
|
|
<li> Spectrogram</li>
|
|
<li> Multi-view</li></ul>
|
|
<p><i>enum <b>Scale</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Linear</li>
|
|
<li> dB</li></ul>
|
|
<p><i>enum <b>Color</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Color0</li>
|
|
<li> Color1</li>
|
|
<li> Color2</li>
|
|
<li> Color3</li></ul>
|
|
<p><i>enum <b>VZoom</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Reset</li>
|
|
<li> Times2</li>
|
|
<li> HalfWave</li></ul>
|
|
<p><i>double <b>VZoomHigh</b>, (default:unchanged)</i><br />
|
|
<i>double <b>VZoomLow</b>, (default:unchanged)</i><br />
|
|
<i>bool <b>SpecPrefs</b>, (default:unchanged)</i><br />
|
|
<i>bool <b>SpectralSel</b>, (default:unchanged)</i><br />
|
|
<i>enum <b>Scheme</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Color (default)</li>
|
|
<li> Color (classic)</li>
|
|
<li> Grayscale</li>
|
|
<li> Inverse Grayscale</li></ul>
|
|
</td>
|
|
<td>Sets visual properties for a track or channel (or both). SpectralPrefs=1 sets the track to use general preferences, SpectralPrefs=1 per track prefs. When using general preferences, SetPreferences can be used to change a preference and so affect display of the track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>GetPreference:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_i.html#get_preference" title="Extra Menu: Scriptables I">Get Preference</a>
|
|
</td>
|
|
<td><i>string <b>Name</b>, (default:)</i><br />
|
|
</td>
|
|
<td>Gets a single preference setting.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SetPreference:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_i.html#set_preference" title="Extra Menu: Scriptables I">Set Preference</a>
|
|
</td>
|
|
<td><i>string <b>Name</b>, (default:)</i><br />
|
|
<p><i>string <b>Value</b>, (default:)</i><br />
|
|
<i>bool <b>Reload</b>, (default:False)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Sets a single preference setting. Some settings such as them changes require a reload (use Reload=1), but this takes time and slows down a script.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SetClip:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_i.html#set_clip" title="Extra Menu: Scriptables I">Set Clip</a>
|
|
</td>
|
|
<td><i>double <b>At</b>, (default:unchanged)</i><br />
|
|
<p><i>enum <b>Color</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Color0</li>
|
|
<li> Color1</li>
|
|
<li> Color2</li>
|
|
<li> Color3</li></ul>
|
|
<p><i>double <b>Start</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Modify a clip by stating the track or channel a time within it. Color and start position can be set. Try to avoid overlapping clips, as Audacity will allow it, but does not like them.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SetEnvelope:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_i.html#set_envelope" title="Extra Menu: Scriptables I">Set Envelope</a>
|
|
</td>
|
|
<td><i>double <b>Time</b>, (default:unchanged)</i><br />
|
|
<p><i>double <b>Value</b>, (default:unchanged)</i><br />
|
|
<i>bool <b>Delete</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Modify an envelope by specifying a track or channel and a time within it. You cannot yet delete individual envelope points, but can delete the whole envelope using Delete=1.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SetLabel:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_i.html#set_label" title="Extra Menu: Scriptables I">Set Label</a>
|
|
</td>
|
|
<td><i>int <b>Label</b>, (default:0)</i><br />
|
|
<p><i>string <b>Text</b>, (default:unchanged)</i><br />
|
|
<i>double <b>Start</b>, (default:unchanged)</i><br />
|
|
<i>double <b>End</b>, (default:unchanged)</i><br />
|
|
<i>bool <b>Selected</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Modifies an existing label. You must give it the label number.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SetProject:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_i.html#set_project" title="Extra Menu: Scriptables I">Set Project</a>
|
|
</td>
|
|
<td><i>string <b>Name</b>, (default:unchanged)</i><br />
|
|
<p><i>double <b>Rate</b>, (default:unchanged)</i><br />
|
|
<i>int <b>X</b>, (default:unchanged)</i><br />
|
|
<i>int <b>Y</b>, (default:unchanged)</i><br />
|
|
<i>int <b>Width</b>, (default:unchanged)</i><br />
|
|
<i>int <b>Height</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Sets the project window to a particular location and size. Can also change the caption - but that is cosmetic and may be overwritten again later by Audacity.
|
|
</td></tr></table>
|
|
<div id="extra_scriptables_ii_submenu"></div>
|
|
<h3><span class="mw-headline" id="Extra:_Scriptables_II"><a href="extra_menu_scriptables_ii.html" title="Extra Menu: Scriptables II">Extra: Scriptables II</a></span></h3>
|
|
<div class="note">Like Scriptables I, but these ones are less commonly used from the menu. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>Select:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_ii.html#select" title="Extra Menu: Scriptables II">Select</a>
|
|
</td>
|
|
<td><i>double <b>Start</b>, (default:unchanged)</i><br />
|
|
<p><i>double <b>End</b>, (default:unchanged)</i><br />
|
|
<i>enum <b>RelativeTo</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> ProjectStart</li>
|
|
<li> Project</li>
|
|
<li> ProjectEnd</li>
|
|
<li> SelectionStart</li>
|
|
<li> Selection</li>
|
|
<li> SelectionEnd</li></ul>
|
|
<p><i>double <b>High</b>, (default:unchanged)</i><br />
|
|
<i>double <b>Low</b>, (default:unchanged)</i><br />
|
|
<i>double <b>Track</b>, (default:unchanged)</i><br />
|
|
<i>double <b>TrackCount</b>, (default:unchanged)</i><br />
|
|
<i>enum <b>Mode</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Set</li>
|
|
<li> Add</li>
|
|
<li> Remove</li></ul>
|
|
</td>
|
|
<td>Selects audio. Start and End are time. First and Last are track numbers. High and Low are for spectral selection. FromEnd allows selection from the end, which is handy to fade in and fade out a track. The Mode parameter allows complex selections, e.g adding or removing tracks from the current selection.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SetTrack:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_ii.html#set_track" title="Extra Menu: Scriptables II">Set Track</a>
|
|
</td>
|
|
<td><i>string <b>Name</b>, (default:unchanged)</i><br />
|
|
<p><i>bool <b>Selected</b>, (default:unchanged)</i><br />
|
|
<i>bool <b>Focused</b>, (default:unchanged)</i><br />
|
|
<i>bool <b>Mute</b>, (default:unchanged)</i><br />
|
|
<i>bool <b>Solo</b>, (default:unchanged)</i><br />
|
|
<i>double <b>Gain</b>, (default:unchanged)</i><br />
|
|
<i>double <b>Pan</b>, (default:unchanged)</i><br />
|
|
<i>int <b>Height</b>, (default:unchanged)</i><br />
|
|
<i>enum <b>Display</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Waveform</li>
|
|
<li> Spectrogram</li></ul>
|
|
<p><i>enum <b>Scale</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Linear</li>
|
|
<li> dB</li></ul>
|
|
<p><i>enum <b>Color</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Color0</li>
|
|
<li> Color1</li>
|
|
<li> Color2</li>
|
|
<li> Color3</li></ul>
|
|
<p><i>enum <b>VZoom</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Reset</li>
|
|
<li> Times2</li>
|
|
<li> HalfWave</li></ul>
|
|
<p><i>double <b>VZoomHigh</b>, (default:unchanged)</i><br />
|
|
<i>double <b>VZoomLow</b>, (default:unchanged)</i><br />
|
|
<i>bool <b>SpecPrefs</b>, (default:unchanged)</i><br />
|
|
<i>bool <b>SpectralSel</b>, (default:unchanged)</i><br />
|
|
<i>bool <b>GrayScale</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Sets properties for a track or channel (or both). Setting one channel of a stereo track can lead to interesting results. That's most used when setting relative sizing of the two channels. SpectralPrefs=1 sets the track to use general preferences, SpectralPrefs=1 per track prefs. When using general preferences, SetPreferences can be used to change a preference and so affect display of the track. Name is used to set the name. It is not used in choosing the track.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>GetInfo:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_ii.html#get_info" title="Extra Menu: Scriptables II">Get Info</a>
|
|
</td>
|
|
<td><i>enum <b>Type</b>, (default:Commands)</i><br />
|
|
<ul><li> Commands</li>
|
|
<li> Menus</li>
|
|
<li> Preferences</li>
|
|
<li> Tracks</li>
|
|
<li> Clips</li>
|
|
<li> Envelopes</li>
|
|
<li> Labels</li>
|
|
<li> Boxes</li></ul>
|
|
<p><i>enum <b>Format</b>, (default:JSON)</i><br />
|
|
</p>
|
|
<ul><li> JSON</li>
|
|
<li> LISP</li>
|
|
<li> Brief</li></ul>
|
|
</td>
|
|
<td>Gets information in a list in one of three formats.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Message:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_ii.html#message" title="Extra Menu: Scriptables II">Message</a>
|
|
</td>
|
|
<td><i>string <b>Text</b>, (default:Some message)</i><br />
|
|
</td>
|
|
<td>Used in testing. Sends the Text string back to you.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Help:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_ii.html#help" title="Extra Menu: Scriptables II">Help</a>
|
|
</td>
|
|
<td><i>string <b>Command</b>, (default:Help)</i><br />
|
|
<p><i>enum <b>Format</b>, (default:JSON)</i><br />
|
|
</p>
|
|
<ul><li> JSON</li>
|
|
<li> LISP</li>
|
|
<li> Brief</li></ul>
|
|
</td>
|
|
<td>This is an extract from GetInfo Commands, with just one command.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Import2:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_ii.html#import" title="Extra Menu: Scriptables II">Import</a>
|
|
</td>
|
|
<td><i>string <b>Filename</b>, (default:)</i><br />
|
|
</td>
|
|
<td>Imports from a file. The automation command uses a text box to get the file name rather than a normal file-open dialog.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Export2:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_ii.html#export" title="Extra Menu: Scriptables II">Export</a>
|
|
</td>
|
|
<td><i>string <b>Filename</b>, (default:exported.wav)</i><br />
|
|
<p><i>int <b>NumChannels</b>, (default:1)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Exports selected audio to a named file. This version of export has the full set of export options. However, a current limitation is that the detailed option settings are always stored to and taken from saved preferences. The net effect is that for a given format, the most recently used options for that format will be used. In the current implementation, <b>NumChannels</b> should be 1 (mono) or 2 (stereo).
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>OpenProject2:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_ii.html#open_project" title="Extra Menu: Scriptables II">Open Project</a>
|
|
</td>
|
|
<td><i>string <b>Filename</b>, (default:test.aup3)</i><br />
|
|
<p><i>bool <b>AddToHistory</b>, (default:false)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Opens a project.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>SaveProject2:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_ii.html#save_project" title="Extra Menu: Scriptables II">Save Project</a>
|
|
</td>
|
|
<td><i>string <b>Filename</b>, (default:name.aup3)</i><br />
|
|
<p><i>bool <b>AddToHistory</b>, (default:False)</i><br />
|
|
<i>bool <b>Compress</b>, (default:False)</i><br />
|
|
</p>
|
|
</td>
|
|
<td>Saves a project.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Drag:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_ii.html#move_mouse" title="Extra Menu: Scriptables II">Move Mouse</a>
|
|
</td>
|
|
<td><i>int <b>Id</b>, (default:unchanged)</i><br />
|
|
<p><i>string <b>Window</b>, (default:unchanged)</i><br />
|
|
<i>double <b>FromX</b>, (default:unchanged)</i><br />
|
|
<i>double <b>FromY</b>, (default:unchanged)</i><br />
|
|
<i>double <b>ToX</b>, (default:unchanged)</i><br />
|
|
<i>double <b>ToY</b>, (default:unchanged)</i><br />
|
|
<i>enum <b>RelativeTo</b>, (default:unchanged)</i><br />
|
|
</p>
|
|
<ul><li> Panel</li>
|
|
<li> App</li>
|
|
<li> Track0</li>
|
|
<li> Track1</li></ul>
|
|
</td>
|
|
<td>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. If To is specified, the command does a drag, otherwise just a hover.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CompareAudio:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_ii.html#compare_audio" title="Extra Menu: Scriptables II">Compare Audio</a>
|
|
</td>
|
|
<td><i>float <b>Threshold</b>, (default:0)</i><br />
|
|
</td>
|
|
<td>Compares selected range on two tracks. Reports on the differences and similarities.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Screenshot:</b>
|
|
</td>
|
|
<td><a href="extra_menu_scriptables_ii.html#screenshot_short_format" title="Extra Menu: Scriptables II">Screenshot (short format)</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>A version of Tools -> Screenshot with a more minimal GUI. One of the most useful options is All_Tracks. The _Plus suffix includes the timeline.
|
|
</td></tr></table>
|
|
<div id="help_menu"></div>
|
|
<h2><span class="mw-headline" id="Help_Menu"><a href="help_menu.html" title="Help Menu">Help Menu</a></span></h2>
|
|
<div class="note">The Help Menu lets you find out more about the Audacity application and how to use it. It also includes some diagnostic tools. </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>QuickHelp:</b>
|
|
</td>
|
|
<td><a href="help_menu.html#quick_help" title="Help Menu">Quick Help</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>A brief version of help with some of the most essential information.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Manual:</b>
|
|
</td>
|
|
<td><a href="help_menu.html#manual" title="Help Menu">Manual</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Opens the manual in the default browser.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Updates:</b>
|
|
</td>
|
|
<td><a href="help_menu.html#check_for_updates" title="Help Menu">Check for Updates</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Checks online to see if this is the latest version of Audacity.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>About:</b>
|
|
</td>
|
|
<td><a href="help_menu.html#about_audacity" title="Help Menu">About Audacity</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Brings a dialog with information about Audacity, such as who wrote it, what features are enabled and the GNU GPL v2 license.
|
|
</td></tr></table>
|
|
<div id="help_diagnostics_submenu"></div>
|
|
<h3><span class="mw-headline" id="Help:_Diagnostics"><a href="help_menu_diagnostics.html" title="Help Menu: Diagnostics">Help: Diagnostics</a></span></h3>
|
|
<div class="note">A set of diagnostic tools </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>DeviceInfo:</b>
|
|
</td>
|
|
<td><a href="help_menu_diagnostics.html#audio_device_info" title="Help Menu: Diagnostics">Audio Device Info</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Shows technical information about your detected audio device(s).
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>MidiDeviceInfo:</b>
|
|
</td>
|
|
<td><a href="help_menu_diagnostics.html#midi_device_info" title="Help Menu: Diagnostics">MIDI Device Info</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Shows technical information about your detected MIDI device(s).
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>Log:</b>
|
|
</td>
|
|
<td><a href="help_menu_diagnostics.html#show_log" title="Help Menu: Diagnostics">Show Log</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Launches the "Audacity Log" window, the log is largely a debugging aid, having timestamps for each entry
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CrashReport:</b>
|
|
</td>
|
|
<td><a href="help_menu_diagnostics.html#generate_support_data" title="Help Menu: Diagnostics">Generate Support Data</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Selecting this will generate a Debug report which could be useful in aiding the developers to identify bugs in Audacity or in third-party plugins
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>CheckDeps:</b>
|
|
</td>
|
|
<td><a href="help_menu_diagnostics.html#check_dependencies" title="Help Menu: Diagnostics">Check Dependencies</a>
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td>Lists any WAV or AIFF audio files that your project depends on, and allows you to copy these files into the project
|
|
</td></tr></table>
|
|
<p><br />
|
|
</p>
|
|
<div id="no_menu"></div>
|
|
<h2><span class="mw-headline" id="No_Menu">No Menu</span></h2>
|
|
<div class="note"> These are additional commands that do not appear in any menu </div>
|
|
<table class="prettytablerows" rules="rows" border="2" width="100%">
|
|
<tr>
|
|
<th width="15%">Scripting Id
|
|
</th>
|
|
<th width="15%">Action
|
|
</th>
|
|
<th width="30%">Parameters
|
|
</th>
|
|
<th width="55%">Description
|
|
</th></tr>
|
|
<tr>
|
|
<td><b>PrevWindow:</b>
|
|
</td>
|
|
<td>Previous Window
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td> Navigates to the previous window.
|
|
</td></tr>
|
|
<tr>
|
|
<td><b>NextWindow:</b>
|
|
</td>
|
|
<td>Next Window
|
|
</td>
|
|
<td><i>none</i>
|
|
</td>
|
|
<td> Navigates to the next window.
|
|
</td></tr></table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="visualClear"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="column-one">
|
|
|
|
|
|
|
|
<div class="portlet" id="p-logo" role="banner">
|
|
<a href="../index.html" class="mw-wiki-logo" title="Visit the main page"></a>
|
|
</div>
|
|
|
|
<div class="generated-sidebar portlet" id="p-Navigation" role="navigation">
|
|
<h3>Navigation</h3>
|
|
<div class='pBody'>
|
|
<ul><li> <a href="../index.html" title="Main Page"><span title="Front page, complete with clickable image of Audacity screen.">Manual Home Page</span></a>
|
|
<ul><li> <a href="audacity_tour_guide.html" title="Audacity Tour Guide"><span title="A quick tour of selected features of Audacity. It doesn't tell you how to use features it would be much too long if it did. Rather it tells you about some of the features that exist in Audacity and will help you learn a little about those.">Tour Guide</span></a></li></ul></li>
|
|
<li> <a href="how_to_use_audacity.html" title="How to use Audacity"><span title="Quick Help, Audacity Foundations, Editing with Audacity, Help with Advanced Topics">Using Audacity</span></a>
|
|
<ul><li> <a href="../quick_help.html" title="Quick Help"><span title="A brief guide to help you get started with Audacity">Getting Started</span></a></li>
|
|
<li> <a href="how_to_use_audacity.html" title="How to use Audacity"><span title="A comprehensive guide to using Audacity">How-Tos</span></a></li>
|
|
<li> <a href="tutorials_for_audacity.html" title="Tutorials for Audacity"><span title="A guide to the tutorials that provide step-by-step instructions for performing common tasks in Audacity">Tutorials</span></a></li>
|
|
<li> <a href="tips.html" title="Tips"><span title="A guide to particular aspects of working with Audacity: Navigation. Playback, Audio Alignment">Tips</span></a></li></ul></li>
|
|
<li> <a href="../index.html#reference" title="Main Page"><span title="The components of the Audacity Graphical User Interface">Audacity GUI</span></a>
|
|
<ul><li> <a href="menu_reference.html" title="Menu Reference"><span title="A guide to the menus and submenus in Audacity">Menu Bar</span></a></li>
|
|
<li> <a href="toolbars_overview.html" title="Toolbars Overview"><span title="A guide to the various Toolbars used in Audacity">Toolbars</span></a></li>
|
|
<li> <a href="audio_tracks.html" title="Audio Tracks"><span title="A guide to the various types of track">Tracks</span></a></li>
|
|
<li> <a href="index_of_effects_generators_and_analyzers.html" title="Index of Effects, Generators and Analyzers"><span title="A quick index to the Effects, Generators and Analyzers that are shipped with Audacity">Effects</span></a></li></ul></li>
|
|
<li> <a href="customization.html" title="Customization"><span title="Adjust settings, change keyboard shortcuts, add plugins">Customizing</span></a>
|
|
<ul><li> <a href="preferences.html" title="Preferences"><span title="A guide to Preferences, which let you change most of the default behaviors of Audacity">Preferences</span></a></li>
|
|
<li> <a href="keyboard_shortcut_reference.html" title="Keyboard Shortcut Reference"><span title="A list of all the commands in the Audacity menus and all pre-defined keyboard shortcuts">Shortcut keys</span></a></li>
|
|
<li> <a href="customization.html#plugins" title="Customization"><span title="You can download and install plugins to add extra functionality to Audacity. Plugins can give you extra effects, or more audio generation and analysis capability.">Plugins</span></a></li>
|
|
<li> <a href="themes.html" title="Themes"><span title="Audacity now comes supplied with four pre-configured, user-selectable themes. This enables you to choose the look and feel you prefer for Audacity's interface.">Themes</span></a></li>
|
|
<li> <a href="customizing_toolbar_layout.html" title="Customizing Toolbar Layout"><span title="Audacity's toolbars can all be re-positioned (in the tooldocks or free-floating) and some can be resized.">Toolbars</span></a></li>
|
|
<li> <a href="manage_effects_generators_and_analyzers.html" title="Manage Effects, Generators and Analyzers"><span title="Manage your list of available built-in Effects, Generators, Analyzers and plugins with the Plugin Manager">Effects</span></a></li></ul></li></ul>
|
|
</div>
|
|
</div>
|
|
<div class="generated-sidebar portlet" id="p-Reference" role="navigation">
|
|
<h3>Reference</h3>
|
|
<div class='pBody'>
|
|
<ul><li> <a href="../index.html#reference" title="Main Page"><span title="Reference guide to the Audacity project window - you can hover over and click on the image to learn more">Reference</span></a>
|
|
<ul><li> <a href="searching_the_manual.html" title="Searching the Manual"><span title="Tips on how to Search the Audacity Manual">Search the Manual</span></a></li>
|
|
<li> <a href="digital_audio.html" title="Digital Audio"><span title="A beginner's guide to digital audio">Digital Audio</span></a></li>
|
|
<li> <a href="glossary.html" title="Glossary"><span title="Brief explanations of technical terms related to digital audio, with some links to Wikipedia for much more comprehensive explanations">Glossary</span></a></li>
|
|
<li> <a href="#" title="Scripting Reference"><span title="Audacity Commands that are in menus, that can be used from Macros, Nyquist and Python">All Commands</span></a></li>
|
|
<li> <a href="faq_errors.html" title="FAQ:Errors"><span title="FAQ on common errors encountered when using Audacity">Errors</span></a></li>
|
|
<li> <a href="subject_index.html" title="Subject Index"><span title="A short, limited, index of the Manual">Index</span></a></li></ul></li>
|
|
<li> <a href="faq.html" title="FAQ"><span title="Frequently Asked Questions - most common questions are answered in the FAQ">FAQ</span></a></li></ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="generated-sidebar portlet" id="p-Useful_Links" role="navigation">
|
|
<h3>Useful Links</h3>
|
|
<div class='pBody'>
|
|
<ul><li> <span title="Audacity Forum (best place for support requests)"><a rel="nofollow" class="external text" href="https://forum.audacityteam.org/">Forum</a></span></li>
|
|
<li> <span title="Audacity Wiki Home Page"><a rel="nofollow" class="external text" href="https://support.audacityteam.org/">Audacity Support</a></span></li>
|
|
<li> <span title="Audacity Latest Release"><a rel="nofollow" class="external text" href="https://www.audacityteam.org/download/">Latest Release</a></span></li></ul>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
<div class="visualClear"></div>
|
|
<div id="footer" role="contentinfo">
|
|
<div id="f-copyrightico">
|
|
|
|
</div>
|
|
<div id="f-poweredbyico">
|
|
<a href="https://www.mediawiki.org/"><img src="../m/resources/assets/poweredby_mediawiki_88x31.png" alt="Powered by MediaWiki" srcset="/m/resources/assets/poweredby_mediawiki_132x47.png 1.5x, /m/resources/assets/poweredby_mediawiki_176x62.png 2x" width="88" height="31"/></a>
|
|
</div>
|
|
|
|
<div align="center"><ul id="f_list"><li>This version created on 2025-12-04 - <a href="https://alphamanual.audacityteam.org/man/Scripting_Reference">Check current version of this page (development Manual)</a></li></ul></div>
|
|
</div>
|
|
</div>
|
|
</body></html>
|