Difference between revisions of "Scripting Syntax"

From Audacity Wiki
Jump to: navigation, search
(ednote update.)
(Marked page for deletion)
 
Line 1: Line 1:
 
* See also [https://manual.audacityteam.org/man/scripting.html scripting] in the manual.
 
* See also [https://manual.audacityteam.org/man/scripting.html scripting] in the manual.
  
 +
{{ednote|[[ToDo-2]]'''Steve 30Jun20:''' This page needs to be deleted,
 +
* links to it updating,
 +
* discussion moving to a new page or meging with related content.
 +
 +
 +
<pre>
 
{{ednote|1= &nbsp;
 
{{ednote|1= &nbsp;
 
'''James:''' The old 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.   
Line 8: Line 14:
 
** Something like the [https://alphamanual.audacityteam.org/man/Keyboard_Shortcut_Reference Shortcuts page] in the manual might be more use.
 
** 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. }}
Line 70: Line 77:
 
{{Send_Receive_Title}}
 
{{Send_Receive_Title}}
 
{{Send_Receive|1=GetLabels|2=GetLabels finished: OK}}
 
{{Send_Receive|1=GetLabels|2=GetLabels finished: OK}}
 
+
</pre>
 +
}}
  
  
 
[[Category:For Developers]]
 
[[Category:For Developers]]

Latest revision as of 20:27, 30 June 2020

ToDo-2Steve 30Jun20: This page needs to be deleted,
  • links to it updating,
  • discussion moving to a new page or meging with related content.


{{ednote|1=  
'''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 [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|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
* [[WIT_Audacity_Menus|Sample output]]


'''Parameters:'''
{{Param|1=''Dummy''|2=This parameter does not exist.}}


'''Examples:'''
{{Send_Receive_Title}}
{{Send_Receive|1=GetMenusPlus|2=GetMenuPlus finished: OK}}

==GetBoxes:==

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


'''Parameters:'''
{{Param|1=''Dummy''|2=This parameter does not exist.}}


'''Examples:'''
{{Send_Receive_Title}}
{{Send_Receive|1=GetBoxes|2=GetBoxes finished: OK}}


==GetClips:==

Gets a list of all the clips in JSON format


'''Parameters:'''
{{Param|1=''Dummy''|2=This parameter does not exist.}}


'''Examples:'''
{{Send_Receive_Title}}
{{Send_Receive|1=GetClips|2=GetClips finished: OK}}


==GetLabels:==

Gets a list of all the labels in JSON format


'''Parameters:'''
{{Param|1=''Dummy''|2=This parameter does not exist.}}


'''Examples:'''
{{Send_Receive_Title}}
{{Send_Receive|1=GetLabels|2=GetLabels finished: OK}}