View source for Scripting Reference

{{intro|1=This is an experiemental page, not linked to from anywhere, to list automation commands.

* '''Yes''' these are the same as normal commands, as in the menus, just presented differently.
* {{todo}} Add parameters.
* Most of this page is automatically generated.
}}

<div id="remove_special"></div>
===[[Edit_Menu:_Remove Special|Edit: Remove Special]]===
{{note|For more "advanced" removal of audio }}
{| class="prettytablerows" rules = "rows" border = "2" width="100%"
!width="15%"|Automation Id
!width="15%"|Action
!width="30%"|Parameters
!width="55%"|Description
|-
|SplitDelete
|[[Edit_Menu:_Remove Special#split_delete|Split Delete]]
|''none''
|Same as Delete, but none of the audio data or labels to right of the selection are shifted.
|}
{{hoverext|hover=|ext=}}
<div id="play"></div>
===[[Transport_Menu:_Play|Transport: Play]]===
{{note|These commands control playback in Audacity. You can Start, Stop or Pause playback of the audio in your project. }}
{| class="prettytablerows" rules = "rows" border = "2" width="100%"
!width="15%"|Automation Id
!width="15%"|Action
!width="30%"|Parameters
!width="55%"|Description
|-
|Play
|[[Transport_Menu:_Play#play_stop|Play/Stop]]
|''none''
|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 [[Timeline]] position it last started from. You can also assign separate shortcuts for [[#play|Play]] and [[#stop|Stop]]. 
|}
{{hoverext|hover=|ext=}}
<div id="record"></div>
===[[Transport_Menu:_Record|Transport: Record]]===
{{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 an a new track. }}
{| class="prettytablerows" rules = "rows" border = "2" width="100%"
!width="15%"|Automation Id
!width="15%"|Action
!width="30%"|Parameters
!width="55%"|Description
|-
|Record1stChoice
|[[Transport_Menu:_Record#record|Record]]
|''none''
|Starts recording at the end of the currently [[Audacity Selection|selected]] track(s). 
|-
|Record2ndChoice
|[[Transport_Menu:_Record#record_new_track|Record New Track]]
|''none''
|Recording begins on a new track at either the current cursor location or at the beginning of the current selection.
|}
{{hoverext|hover=|ext=}}
<div id="tracks"></div>
==[[Tracks_Menu|Tracks Menu]]==
{{note|For extending a selection to more tracks. }}
{| class="prettytablerows" rules = "rows" border = "2" width="100%"
!width="15%"|Automation Id
!width="15%"|Action
!width="30%"|Parameters
!width="55%"|Description
|-
|RemoveTracks
|[[Tracks_Menu#remove_tracks|Remove Tracks]]
|''none''
|Removes the selected track(s) from the project. Even if only part of a track is selected, the entire track is removed.
|}
{{hoverext|hover=|ext=}}
<div id="generate"></div>
==[[Generate_Menu|Generate Menu]]==
{{note|Generate }}
{| class="prettytablerows" rules = "rows" border = "2" width="100%"
!width="15%"|Automation Id
!width="15%"|Action
!width="30%"|Parameters
!width="55%"|Description
|-
|Chirp
|[[Generate_Menu#chirp|Chirp...]]
|''double'' '''StartFreq''', (default:440.000000)<br>
''double'' '''EndFreq''', (default:1320.000000)<br>
''double'' '''StartAmp''', (default:0.800000)<br>
''double'' '''EndAmp''', (default:0.100000)<br>
''enum'' '''Waveform''', (default:0)<br>
* Sine
* Square
* Sawtooth
* Square, no alias
''enum'' '''Interpolation''', (default:0)<br>
* Linear
* Logarithmic

|Generates four different types of tone waveform like the [[#Tone...|Tone Generator]], but additionally allows setting of the starting and ending amplitude and frequency.
|-
|DtmfTones
|[[Generate_Menu#dtmf_tones|DTMF Tones...]]
|''string'' '''Sequence''', (default:audacity)<br>
''double'' '''Duty Cycle''', (default:55.000000)<br>
''double'' '''Amplitude''', (default:0.800000)<br>

|Generates dual-tone multi-frequency (DTMF) tones like those produced by the keypad on telephones.
|-
|Noise
|[[Generate_Menu#noise|Noise...]]
|''enum'' '''Type''', (default:0)<br>
* White
* Pink
* Brownian
''double'' '''Amplitude''', (default:0.800000)<br>

|Generates 'white', 'pink' or 'brown' noise.
|-
|Tone
|[[Generate_Menu#tone|Tone...]]
|''double'' '''Frequency''', (default:440.000000)<br>
''double'' '''Amplitude''', (default:0.800000)<br>
''enum'' '''Waveform''', (default:0)<br>
* Sine
* Square
* Sawtooth
* Square, no alias
''enum'' '''Interpolation''', (default:0)<br>
* Linear
* Logarithmic

|Generates one of four different tone waveforms: ''Sine'', ''Square'', ''Sawtooth'' or ''Square (no alias)'', and a frequency between 1 Hz and ''half the current project rate''.
|}
{{hoverext|hover=|ext=}}
<div id="effect"></div>
==[[Effect_Menu|Effect Menu]]==
{{note|Effect }}
{| class="prettytablerows" rules = "rows" border = "2" width="100%"
!width="15%"|Automation Id
!width="15%"|Action
!width="30%"|Parameters
!width="55%"|Description
|-
|Amplify
|[[Effect_Menu#amplify|Amplify...]]
|''float'' '''Ratio''', (default:0.900000)<br>

|Increases or decreases the volume of the audio you have selected.
|-
|AutoDuck
|[[Effect_Menu#auto_duck|Auto Duck...]]
|''double'' '''DuckAmountDb''', (default:-12.000000)<br>
''double'' '''InnerFadeDownLen''', (default:0.000000)<br>
''double'' '''InnerFadeUpLen''', (default:0.000000)<br>
''double'' '''OuterFadeDownLen''', (default:0.500000)<br>
''double'' '''OuterFadeUpLen''', (default:0.500000)<br>
''double'' '''ThresholdDb''', (default:-30.000000)<br>
''double'' '''MaximumPause''', (default:1.000000)<br>

|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.
|-
|BassAndTreble
|[[Effect_Menu#bass_and_treble|Bass and Treble...]]
|''double'' '''Bass''', (default:0.000000)<br>
''double'' '''Treble''', (default:0.000000)<br>
''double'' '''Gain''', (default:0.000000)<br>
''bool'' '''Link Sliders''', (default:False)<br>

|Increases or decreases the lower  '''''[[Glossary#frequency|frequencies]]'''''  and higher frequencies of your audio independently; behaves just like the bass and treble controls on a stereo system.
|-
|ChangePitch
|[[Effect_Menu#change_pitch|Change Pitch...]]
|''double'' '''Percentage''', (default:0.000000)<br>
''bool'' '''SBSMS''', (default:False)<br>

|Change the pitch of a selection without changing its tempo.
|-
|ChangeSpeed
|[[Effect_Menu#change_speed|Change Speed...]]
|''double'' '''Percentage''', (default:0.000000)<br>

|Change the speed of a selection, also changing its pitch.
|-
|ChangeTempo
|[[Effect_Menu#change_tempo|Change Tempo...]]
|''double'' '''Percentage''', (default:0.000000)<br>
''bool'' '''SBSMS''', (default:False)<br>

|Change the tempo and length (duration) of a selection without changing its pitch.
|-
|ClickRemoval
|[[Effect_Menu#click_removal|Click Removal...]]
|''int'' '''Threshold''', (default:200)<br>
''int'' '''Width''', (default:20)<br>

|Click Removal is designed to remove clicks on audio tracks and is especially suited to declicking recordings made from vinyl records.
|-
|Compressor
|[[Effect_Menu#compressor|Compressor...]]
|''double'' '''Threshold''', (default:-12.000000)<br>
''double'' '''NoiseFloor''', (default:-40.000000)<br>
''double'' '''Ratio''', (default:2.000000)<br>
''double'' '''AttackTime''', (default:0.200000)<br>
''double'' '''ReleaseTime''', (default:1.000000)<br>
''bool'' '''Normalize''', (default:True)<br>
''bool'' '''UsePeak''', (default:False)<br>

|Compresses the '''''[[Glossary#dynamic_range|dynamic range]]''''' by two alternative methods. The default "'''''[[Glossary#rms|RMS]]'''''" 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 '''''[[Glossary#gain|gain]]''''' can be applied to either method, making the result as loud as possible without '''''[[Glossary#clipping|clipping]]''''', but not changing the dynamic range further. 
|-
|Distortion
|[[Effect_Menu#distortion|Distortion...]]
|''enum'' '''Type''', (default:0)<br>
* Hard Clipping
* Soft Clipping
* Soft Overdrive
* Medium Overdrive
* Hard Overdrive
* Cubic Curve (odd harmonics)
* Even Harmonics
* Expand and Compress
* Leveller
* Rectifier Distortion
* Hard Limiter 1413
''bool'' '''DC Block''', (default:False)<br>
''double'' '''Threshold dB''', (default:-6.000000)<br>
''double'' '''Noise Floor''', (default:-70.000000)<br>
''double'' '''Parameter 1''', (default:50.000000)<br>
''double'' '''Parameter 2''', (default:50.000000)<br>
''int'' '''Repeats''', (default:1)<br>

|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 [https://en.wikipedia.org/wiki/Waveshaper waveshaper]. 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. 
|-
|Echo
|[[Effect_Menu#echo|Echo...]]
|''float'' '''Delay''', (default:1.000000)<br>
''float'' '''Decay''', (default:0.500000)<br>

|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 [[Effect Menu#Delay|Delay]]. 
|-
|Equalization
|[[Effect_Menu#equalization|Equalization...]]
|''size_t'' '''FilterLength''', (default:4001)<br>
''string'' '''CurveName''', (default:unnamed)<br>
''bool'' '''InterpolateLin''', (default:False)<br>
''enum'' '''InterpolationMethod''', (default:0)<br>
* B-spline
* Cosine
* Cubic

|Adjusts the volume levels of particular frequencies.
|-
|Normalize
|[[Effect_Menu#normalize|Normalize...]]
|''double'' '''Level''', (default:-1.000000)<br>
''bool'' '''ApplyGain''', (default:True)<br>
''bool'' '''RemoveDcOffset''', (default:True)<br>
''bool'' '''StereoIndependent''', (default:False)<br>

|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 [[DC offset]] from the track.
|-
|Paulstretch
|[[Effect_Menu#paulstretch|Paulstretch...]]
|''float'' '''Stretch Factor''', (default:10.000000)<br>
''float'' '''Time Resolution''', (default:0.250000)<br>

|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. 
|-
|Phaser
|[[Effect_Menu#phaser|Phaser...]]
|''int'' '''Stages''', (default:2)<br>
''int'' '''DryWet''', (default:128)<br>
''double'' '''Freq''', (default:0.400000)<br>
''double'' '''Phase''', (default:0.000000)<br>
''int'' '''Depth''', (default:100)<br>
''int'' '''Feedback''', (default:0)<br>
''double'' '''Gain''', (default:-6.000000)<br>

|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 '''''[[Glossary#frequency|Frequency]]''''' Oscillator (LFO).
|-
|Repeat
|[[Effect_Menu#repeat|Repeat...]]
|''int'' '''Count''', (default:1)<br>

|Repeats the selection the specified number of times.
|-
|Reverb
|[[Effect_Menu#reverb|Reverb...]]
|''double'' '''RoomSize''', (default:75.000000)<br>
''double'' '''Delay''', (default:10.000000)<br>
''double'' '''Reverberance''', (default:50.000000)<br>
''double'' '''HfDamping''', (default:50.000000)<br>
''double'' '''ToneLow''', (default:100.000000)<br>
''double'' '''ToneHigh''', (default:100.000000)<br>
''double'' '''WetGain''', (default:-1.000000)<br>
''double'' '''DryGain''', (default:-1.000000)<br>
''double'' '''StereoWidth''', (default:100.000000)<br>
''bool'' '''WetOnly''', (default:False)<br>

|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". 
|-
|TimeScale
|[[Effect_Menu#sliding_time_scale_pitch_shift|Sliding Time Scale/Pitch Shift...]]
|''double'' '''RatePercentChangeStart''', (default:0.000000)<br>
''double'' '''RatePercentChangeEnd''', (default:0.000000)<br>
''double'' '''PitchHalfStepsStart''', (default:0.000000)<br>
''double'' '''PitchHalfStepsEnd''', (default:0.000000)<br>
''double'' '''PitchPercentChangeStart''', (default:0.000000)<br>
''double'' '''PitchPercentChangeEnd''', (default:0.000000)<br>

|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.
|-
|TruncateSilence
|[[Effect_Menu#truncate_silence|Truncate Silence...]]
|''enum'' '''Db''', (default:0)<br>
* -20 dB
* -25 dB
* -30 dB
* -35 dB
* -40 dB
* -45 dB
* -50 dB
* -55 dB
* -60 dB
* -65 dB
* -70 dB
* -75 dB
* -80 dB
''enum'' '''Action''', (default:0)<br>
* Truncate Detected Silence
* Compress Excess Silence
''double'' '''Minimum''', (default:0.500000)<br>
''double'' '''Truncate''', (default:0.500000)<br>
''double'' '''Compress''', (default:50.000000)<br>
''bool'' '''Independent''', (default:False)<br>

|Automatically try to find and eliminate audible silences. Don't use with faded audio.
|-
|Wahwah
|[[Effect_Menu#wahwah|Wahwah...]]
|''double'' '''Freq''', (default:1.500000)<br>
''double'' '''Phase''', (default:0.000000)<br>
''int'' '''Depth''', (default:70)<br>
''double'' '''Resonance''', (default:2.500000)<br>
''int'' '''Offset''', (default:30)<br>
''double'' '''Gain''', (default:-6.000000)<br>

|Rapid tone quality variations, like that guitar sound so popular in the 1970's.
|}
{{hoverext|hover=|ext=}}
<div id="analyze"></div>
==[[Analyze_Menu|Analyze Menu]]==
{{note|Analyze }}
{| class="prettytablerows" rules = "rows" border = "2" width="100%"
!width="15%"|Automation Id
!width="15%"|Action
!width="30%"|Parameters
!width="55%"|Description
|-
|FindClipping
|[[Analyze_Menu#find_clipping|Find Clipping...]]
|''int'' '''Duty Cycle Start''', (default:3)<br>
''int'' '''Duty Cycle End''', (default:3)<br>

|Displays runs of '''''[[Glossary#clipping|clipped]]''''' samples in a [[Label Tracks|Label Track]], as a screen-reader accessible alternative to {{menu|[[View Menu|View]] > [[View Menu#Show Clipping|Show Clipping]]}}. A run must include at least one clipped sample, but may include unclipped samples too. 
|}
{{hoverext|hover=|ext=}}
<div id="extra"></div>
==[[Extra_Menu|Extra Menu]]==
{{note|Extra optional commands. }}
{| class="prettytablerows" rules = "rows" border = "2" width="100%"
!width="15%"|Automation Id
!width="15%"|Action
!width="30%"|Parameters
!width="55%"|Description
|-
|DemoCommand
|[[Extra_Menu#demo_command|Demo Command]]
|''float'' '''Delay''', (default:1.000000)<br>
''float'' '''Decay''', (default:0.500000)<br>

| no tip string.
|-
|ScreenshotCommand
|[[Extra_Menu#screenshot|Screenshot]]
|''string'' '''Path''', (default:)<br>
''enum'' '''CaptureWhat''', (default:window)<br>
* window
* fullwindow
* windowplus
* fullscreen
* toolbars
* menus
* effects
* preferences
* selectionbar
* spectralselection
* tools
* transport
* mixer
* meter
* playmeter
* recordmeter
* edit
* device
* scrub
* transcription
* trackpanel
* ruler
* tracks
* firsttrack
* secondtrack
''enum'' '''Background''', (default:None)<br>
* Blue
* White
* None

| no tip string.
|}
{{hoverext|hover=|ext=}}
<div id="track"></div>
===[[Extra_Menu:_Track|Extra: Track]]===
{{note|Extra commands to operate on a track that has focus }}
{| class="prettytablerows" rules = "rows" border = "2" width="100%"
!width="15%"|Automation Id
!width="15%"|Action
!width="30%"|Parameters
!width="55%"|Description
|-
|TrackMute
|[[Extra_Menu:_Track#mute_unmute_focused_track|Mute/Unmute focused track]]
|''none''
|Toggles the Mute button on the focused track.
|}
{{hoverext|hover=|ext=}}