-
Notifications
You must be signed in to change notification settings - Fork 1
/
audacity.jsd
288 lines (204 loc) · 11.5 KB
/
audacity.jsd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
:function AnnounceOn
:Returns int True if messages should be spoken
:Synopsis Indicate whether messages related to certain Audacity operations should be spoken
:Param string/sKey No Description
:function FocusInTrackPanel
:Returns int True if focus is in the track panel
:Description Indicates if the focus is in the track panel.
:function SaySelectionPosition
:Description Says the selection start or end position
:Category Positioning
:Param int/iPosition The ID of the start or end selection position
:Param string/sMessage Spoken message
:function MarkerMovement
:Param string/sScript The script to be performed.
:Param string/sAlert The alert message to be spoken
:function MouseMovement
:Description Used to bypass scripts such as MouseLeft, MouseRight etc. that are assigned to Audacity keys while in the main window.
:Param string/sScript The script to perform.
:function AnnounceKeyMessage
:Description Speak a message for an Audacity hotkey if appropriate and send the key to Audacity.
:Param string/Message The message to speak
:function SayNotStopped
:function SayNoProject
:Description Speaks a message when no project is open. For example, pressing the [ key will speak this message, and the script will exit.
:Category Say
:function NoProject
:Returns int True if no project is open
:Description This function indicates that no project is open (there are no tracks in track panel).
:function AutoStartEvent
:function HandleCustomWindows
:Returns int No Return Description
:Synopsis Announce when focus changes to a different area of the main window.
:function SayFocusedObject
:function IsToolbar
:Returns int True if window hWnd is a toolbar, False otherwise
:Synopsis Return True if hWnd is one of the toolbars.
:Description Return True if hWnd is one of the toolbars. The toolbars are in a window named ToolDock under the app window. It is the second window, the selection bar is inside the window following it, which is also named ToolDock. Assumes focus is in the main window.
:Param handle/hWnd handle of toolbar
:function GetToolbar
:Returns handle toolbar containing the current control
:Description When focus is on a toolbar control returns the handle of the toolbar containing the control
:function FocusInMainWindow
:Returns int No Return Description
:function GetPositionField
:Returns string Value of field
:Description Get the value of one of the selection fields
:Param handle/hWnd Handle of position control
:script SaySelectionStart
:Synopsis Says the value of the Selection Start control
:Description Says the value of the Selection Start control. If pressed twice quickly, moves focus to it.
:script SaySelectionEnd
:Synopsis Say the end position or length of the selection
:Description Say the end position or length of the selection. Also says whether End or Length is selected. If pressed twice quickly, moves focus to it.
:script SayActiveCursor
:Synopsis Says the Audio Position value
:Description If the PC cursor is active, says the value of the Audio Position control. If the PC cursor is not active or it is pressed twice quickly, says the cursor position.
:script ScriptFileName
:script AudacityScriptKeyHelp
:Synopsis Displays Audacity JAWS hot key help in the virtual viewer.
:Description Press twice quickly to display default JAWS hot key help.
:function ShowJawsGuide
:Description Runs the default web browser to display the Audacity Guide for JAWS web page.
:script AudacityKeysHelp
:Synopsis Displays Audacity shortcut keys in the virtual viewer.
:Description Press twice quickly to display Windows shortcut keys
:script MouseUp
:Synopsis Increase track gain or move the mouse pointer/JAWS cursor up
:Description In the Audacity main window you must activate the JAWS cursor to perform the default action. The number of pixels for mouse movement is determined by the mouse movement variable. The value of the mouse movement variable is set in default JCF. It can be modified by using home row utility scripts. This keystroke is useful for accurately positioning the mouse pointer.
:script MouseDown
:Synopsis Decrease track gain or move the mouse pointer/JAWS cursor down
:Description In the Audacity main window you must activate the JAWS cursor to perform the default action. The number of pixels for mouse movement is determined by the mouse movement variable. The value of the mouse movement variable is set in default JCF. It can be modified by using home row utility scripts. This keystroke is useful for accurately positioning the mouse pointer.
:script MouseLeft
:Synopsis Pan left or move the mouse pointer/JAWS cursor to the left
:Description In the Audacity main window you must activate the JAWS cursor to perform the default action. The number of pixels for mouse movement is determined by the mouse movement variable. The value of the mouse movement variable is set in default JCF. It can be modified by using home row utility scripts. This keystroke is useful for accurately positioning the mouse pointer.
:script MouseRight
:Synopsis Pan right or move the mouse pointer/JAWS cursor to the right
:Description In the Audacity main window you must activate the Jaws cursor to perform the default action. The number of pixels for mouse movement is determined by the mouse movement variable. The value of the mouse movement variable is set in default JCF. It can be modified by using home row utility scripts. This keystroke is useful for accurately positioning the mouse pointer.
:script SelectionStart
:Synopsis Says the selection start position
:Description When the [ key is pressed, says the selection start position.
:Category Positioning
:script SelectionEnd
:Synopsis Says the selection end position
:Description When the ] key is pressed, says the selection end position.
:Category Positioning
:script FinishMarkerRight
:Synopsis Moves the end of the selection to the right by a small amount
:script FinishMarkerLeft
:Synopsis Moves the end of the selection to the left by a small amount
:script StartMarkerRight
:Synopsis Moves the start of the selection to the right by a small amount
:script StartMarkerLeft
:Synopsis Moves the start of the selection to the left by a small amount
:script JAWSHome
:script JAWSEnd
:script MoveToStartOfSelectedTracks
:Synopsis Moves cursor to start of audio in selected tracks
:script MoveToEndOfSelectedTracks
:Synopsis Moves cursor to end of audio in selected tracks
:script SelectToBeginning
:Synopsis Moves the selection start to the start of the audio in the selected tracks
:script SelectToEnd
:Synopsis Moves the selection end to the end of the audio in the selected tracks
:script SelectFromStartOfLine
:Synopsis Select from current position to the start of file
:script SelectToEndOfLine
:Synopsis Select from current position to the end of file
:script DeleteSelectedAudio
:Synopsis Deletes the selected audio.
:script JAWSDelete
:Synopsis In track panel delete selected audio, otherwise does normal delete.
:Description If focus is in the main window, a project exists, and audio is selected, the DEL key will delete it. In this case we perform the script DeleteSelectedAudio. Otherwise we perform the default script.
:script JAWSBackspace
:Synopsis Similar to JAWSDelete.
:script SayPriorCharacter
:script SayNextCharacter
:script Copy
:Synopsis Copies selected audio to clipboard
:Description Copy the selected audio to the clipboard if focus is in the main window. Otherwise, perform the default script.
:script CutToClipboard
:Synopsis Cuts selected audio to clipboard
:script DeselectAll
:Synopsis Deselects all audio in current open project
:script CloseFocusTrack
:Synopsis Close the currently focused track
:script AnnounceOnOff
:Synopsis Toggle the announcement of Audacity messages on or off
:script NextDocumentWindow
:Synopsis In the toolbars moves to the next toolbar.
:script PreviousDocumentWindow
:Synopsis In the toolbars moves to the previous toolbar.
:function GetAudacityState
:Returns int a bit mask of the ST_ state constants, or 0 if the Transport toolbar cannot be found
:Synopsis returns the current program state-- play, record, pause
:script SayAudacityState
:Synopsis Says the current program state-- play, record, pause
:script Enter
:Synopsis In the main window when not stopped, pause/unpause (if "ENTER during play/record pauses" option activated).
:script CtrlEnter
:Synopsis In the main window when not stopped, send ENTER (if "ENTER during play/record pauses" option activated).
:function GetObjState
:Returns int object state. Use CTRL constants from hjconst.jsh to interpret, not state constants from msaaconst.jsh
:Synopsis Returns the object state of the object in the window
:Description Works for windows whose object name is the same as the window name
:Param handle/hWnd window to inspect
:function IsStopped
:Returns int TRUE if currently stopped or the Transport toolbar cannot be found. Returns False otherwise.
:Synopsis Determines if Audacity is currently stopped
:Description Determines if Audacity is currently stopped. Returns TRUE if stopped or the Transport toolbar cannot be found. This is used to keep cursor position from being spoken unless Audacity is stopped.
:script AdjustJawsVerbosity
:script AdjustJAWSOptions
:function NodeHlp
:Returns string No Return Description
:Param string/sNodeName No Description
:function UOAnnounceMessages
:Returns string No Return Description
:Param int No Description
:function UOAnnounceMessagesHlp
:Returns string No Return Description
:function UOAnnounceToolbars
:Returns string No Return Description
:Param int No Description
:function UOAnnounceToolbarsHlp
:Returns string No Return Description
:function UOEnterPause
:Returns string No Return Description
:Param int No Description
:function UOEnterPauseHlp
:Returns string No Return Description
:function AddDefaultConfig
:Description Sets the JAWS options for Audacity to their default values and writes them to the .jsi file.
:script ResetConfig
:Synopsis Reset all audacity JAWS script config options to their default values.
:script SayAppVersion
:script SelectAll
:function ProcessVST
:Description Activates Preset, Load Preset, and Save Preset controls in VST plugin dialogs.
:Param int/iControlID control to activate
:script VSTPreset
:Synopsis Set focus to the preset control in VST dialogs.
:Description Adds support for an access key to set focus to the preset control in VST dialogs.
:script VSTLoadPreset
:Synopsis Activates the Load button to load a preset in some VST plugin dialogs
:script VSTSavePreset
:Synopsis Activates the Save button to save a preset in some VST dialogs
:script SayJump
:Synopsis Speaks the position after executing a short/long jump key
:function IsTrackSelected
:Returns int True if current track is selected
:Description Indicates whether the track is selected
:function SayNoTrackSelected
:Description Warn when the user performs a script that requires the current track to be selected.
:function IsWarningDialog
:Returns int True if focus is in the warning dialog
:Description Verify that focus is in the warning dialog that appears when importing uncompressed audio files.
:script SayLine
:script SwitchChainsList
:Synopsis Switch between the Chains and Chain lists in the Edit Chains dialog.
:script PasteFromClipboard
:script ShowCopyright
:function CheckAudacityVersion
:Returns int True if the version of Audacity is <= the specified version.
:Description Varify that current audacity version is equal to or higher than a given version.
:param String/sCheckver the version to compare against in the form "major,minor,build,fix". Trailing segments may be omitted, in which case they are not checked. Ex: "2,0,3" to verify that the program version is 2.0.3 or higher.