Difference between revisions of "Scripting Syntax"

From Audacity Wiki
Jump to: navigation, search
(Fix ednote.)
(ednote update.)
Line 2: Line 2:
  
 
{{ednote|1=  
 
{{ednote|1=  
* '''James:''' The content of this page has now been corrected, updated and transferred to the alphamanual.   
+
'''James:''' The old content of this page has now been corrected, updated and transferred to the alphamanual.   
* I've implemented missing/incomplete commands.}}
+
* I've implemented missing/incomplete commands.
 +
* We need a rethink of presentation of commands.
 +
** The current format is much too verbose.
 +
** Something like the [https://alphamanual.audacityteam.org/man/Keyboard_Shortcut_Reference Shortcuts page] in the manual might be more use.
 +
}}
  
 
{{alert|This page is work in progress.  The commands here are currently only available in some alpha builds, and the documentation may not quite match the commands implemented.  That is why this is in the wiki rather than in the alphamanual. }}
 
{{alert|This page is work in progress.  The commands here are currently only available in some alpha builds, and the documentation may not quite match the commands implemented.  That is why this is in the wiki rather than in the alphamanual. }}

Revision as of 13:04, 18 January 2018

 

James: The old content of this page has now been corrected, updated and transferred to the alphamanual.

  • I've implemented missing/incomplete commands.
  • We need a rethink of presentation of commands.
    • The current format is much too verbose.
    • Something like the Shortcuts page in the manual might be more use.


Warning icon This page is work in progress. The commands here are currently only available in some alpha builds, and the documentation may not quite match the commands implemented. That is why this is in the wiki rather than in the alphamanual.
Warning icon When commands return a syntax error, the results may subsequently lag behind the requests, which can get confusing.

Overview

This page contains information about an expanded Syntax for GetTrackInfo and SetTrackInfo for the scripting feature in Audacity.


GetMenusPlus:

Gets a list of all the menu items in JSON format


Parameters:

Dummy: This parameter does not exist.


Examples:

Send Receive
GetMenusPlus GetMenuPlus finished: OK

GetBoxes:

Gets a list of all the toolbars and buttons in JSON format


Parameters:

Dummy: This parameter does not exist.


Examples:

Send Receive
GetBoxes GetBoxes finished: OK


GetClips:

Gets a list of all the clips in JSON format


Parameters:

Dummy: This parameter does not exist.


Examples:

Send Receive
GetClips GetClips finished: OK


GetLabels:

Gets a list of all the labels in JSON format


Parameters:

Dummy: This parameter does not exist.


Examples:

Send Receive
GetLabels GetLabels finished: OK