Programmer Guide/Macro Library/Kernal/DataSetCmd: Difference between revisions
(initial import) |
|||
| (13 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
This macro implements an interface to send a command to the DataSet application (the {{STX}} Workspace). It can only be used whilst the DataSet application is running. | |||
Before a <code>DATASETCMD</code> function is called, the Workspace object (<code>$BSTXINI</code>) and the DataSet object (<code>$BDATASET</code>) must be unlocked (detached) if they were locked (attached) by the calling application. If one of these objects is locked, a deadlock situation may occur. | |||
'''Note''': The up-to-date description of important '''DataSetCmd''' functions for user script programming can be found [[Programmer_Guide/Macro_Library/DataSetCmd|here]]. | |||
== | ==General Usage== | ||
<code>DATASETCMD <var>subcommand</var> [ <var>args</var> ]</code> | <code>DATASETCMD <var>subcommand</var> [ <var>args</var> ]</code> | ||
;<var>subcommand</var> | ;<var>subcommand</var> | ||
| Line 22: | Line 18: | ||
:The command specific arguments (see below). | :The command specific arguments (see below). | ||
The <code>DATASETCMD</code> command alone does not return a result. The following subcommands are implemented. | |||
{{TOC limit|2}} | |||
==GETSELECTED== | ==GETSELECTED== | ||
| Line 55: | Line 48: | ||
=====Usage:===== | =====Usage:===== | ||
#list := DATASETCMD GETSELECTED SETS | |||
=====Result:===== | =====Result:===== | ||
A table where each entry has one of the following formats, depending on the set type: | A table where each entry has one of the following formats, depending on the set type (AFile, ASequence, ASegList or Set): | ||
<code>AFile ; elementId ; elementIref ; samplingRate ; numberOfChannels ; fullFilePath</code> | <code>AFile ; elementId ; elementIref ; samplingRate ; numberOfChannels ; fullFilePath</code> | ||
| Line 70: | Line 63: | ||
| | ||
==SETSELECTED== | ==SETSELECTED== | ||
| Line 141: | Line 135: | ||
==SAVEDATASET== | ==SAVEDATASET== | ||
Save the | Save the project file to disk. | ||
=====Usage:===== | |||
<code>DATASETCMD SAVEDATASET [ <var>auto</var> ]</code> | |||
Set <var>auto</var> to 1 if the project should be saved without asking the user for confirmation. | |||
=====Result:===== | |||
An empty string. | |||
==SAVEDATASETAS== | ==SAVEDATASETAS== | ||
| Line 153: | Line 156: | ||
Close the Workspace application. | Close the Workspace application. | ||
==OPENMENU== | ==OPENMENU== | ||
| Line 167: | Line 169: | ||
Update the Detail window of the DataSet browser. | Update the Detail window of the DataSet browser. | ||
==REFRESHALL== | ==REFRESHALL== | ||
Latest revision as of 11:05, 22 October 2018
This macro implements an interface to send a command to the DataSet application (the STx Workspace). It can only be used whilst the DataSet application is running.
Before a DATASETCMD function is called, the Workspace object ($BSTXINI) and the DataSet object ($BDATASET) must be unlocked (detached) if they were locked (attached) by the calling application. If one of these objects is locked, a deadlock situation may occur.
Note: The up-to-date description of important DataSetCmd functions for user script programming can be found here.
General Usage
DATASETCMD subcommand [ args ]
- subcommand
- The command to be sent to the DataSet application.
- args
- The command specific arguments (see below).
The DATASETCMD command alone does not return a result. The following subcommands are implemented.
Contents
- 1 General Usage
- 2 GETSELECTED
- 3 SETSELECTED
- 4 SELECTSCRIPT
- 5 NEWDATASET
- 6 OPENWORKSPACE
- 7 SAVEWORKSPACE
- 8 SAVEWORKSPACEAS
- 9 OPENDATASET
- 10 SAVEDATASET
- 11 SAVEDATASETAS
- 12 EXIT
- 13 OPENMENU
- 14 CLOSEMENU
- 15 REFRESHMENU
- 16 REFRESHDETAIL
- 17 REFRESHALL
- 18 NEWSCRIPT
- 19 EDITSCRIPT
- 20 TESTSCRIPT
- 21 GETSCRIPTINFO
- 22 SETSCRIPTINFO
- 23 SD0UPDATE
- 24 DIALOGLAYOUT
- 25 DIALOGGETATTRIBUTES
- 26 SAVECONTEXT
- 27 RESTORECONTEXT
- 28 AUTOSAVE
GETSELECTED
Retrieve a list of selected segments or parameters from the Workspace Detail. Note that this command can only be called from the BScript environment (i.e. a script).
Usage:
#list := DATASETCMD GETSELECTED SEGMENTS
Result:
A table where each entry has the following format:
audioSetIref ; audioSegmentId ; audioChannelAttributeValue
Usage:
#list := DATASETCMD GETSELECTED PARAMETERS
Result:
A table where each entry has the following format:
audioSetIref ; audioSegmentId ; indexOfAnalysedChannel ; parameterMethodName ; parameterType
Usage:
#list := DATASETCMD GETSELECTED SETS
Result:
A table where each entry has one of the following formats, depending on the set type (AFile, ASequence, ASegList or Set):
AFile ; elementId ; elementIref ; samplingRate ; numberOfChannels ; fullFilePath
ASequence ; elementId ; elementIref ; samplingRate ; numberOfChannels
ASegList ; elementId ; elementIref
Set ; elementId ; elementIref
SETSELECTED
Selects an audio-set element in the Overview (by IREF) and select segments in the Detail (by ID). Note that this command currently only works for AFile and ASegList audio sets.
Usage:
DATASETCMD SETSELECTED iref ; segList
Parameters:
- iref
- The IREF to an audio set element.
- segList
- A semi-colon separated list of segment IDs in the element referenced by iref.
SELECTSCRIPT
Shows a dialog to select a script file in the Script Controller.
Usage:
DATASETCMD SELECTSCRIPT [ defaultFile ]
Result:
An empty string.
NEWDATASET
Opens a dialog to create a new (empty) DataSet file.
Usage:
DATASETCMD NEWDATASET [ fileName ]
Parameters:
- fileName
- The file name to use for the new DataSet. If no file name is specified, the user is asked to specify one.
Result:
An empty string if successful, or an error code on failure.
OPENWORKSPACE
This function should not be used by script programmers!
SAVEWORKSPACE
Saves the workspace to disk.
SAVEWORKSPACEAS
Displays a dialog prompting the user to save the workspace to a new file.
OPENDATASET
Displays a dialog prompting the user to select an existing DataSet file to open.
SAVEDATASET
Save the project file to disk.
Usage:
DATASETCMD SAVEDATASET [ auto ]
Set auto to 1 if the project should be saved without asking the user for confirmation.
Result:
An empty string.
SAVEDATASETAS
Display a dialog prompt the user to save the DataSet to a new file.
EXIT
Close the Workspace application.
OPENMENU
This function should not be used by script programmers!
CLOSEMENU
This function should not be used by script programmers!
REFRESHMENU
This function should not be used by script programmers!
REFRESHDETAIL
Update the Detail window of the DataSet browser.
REFRESHALL
Update the DataSet and Application & Setup Tree windows.
NEWSCRIPT
Shows a dialog to create a new script file.
Usage:
DATASETCMD NEWSCRIPT [ par ]
Parameters:
- par
- If par 1 is passed, the script is opened for editing (default). If a global variable is passed, then the new script name is stored in the variable. If not, the script is imported into the Script Controller.
Result:
An empty string if successful, or an error code on failure.
EDITSCRIPT
Starts the application associated with the script file for editing.
TESTSCRIPT
Tests the source code of the selected script.
GETSCRIPTINFO
This function should not be used by script programmers!
SETSCRIPTINFO
This function should not be used by script programmers!
SD0UPDATE
This function should not be used by script programmers!
DIALOGLAYOUT
Browser display layout dialog.
DIALOGGETATTRIBUTES
Update attribute dialog.
SAVECONTEXT
This function should not be used by script programmers!
RESTORECONTEXT
This function should not be used by script programmers!
AUTOSAVE
Turns the DataSet autosave feature on and off.
Usage:
DATASETCMD AUTOSAVE ON|OFF
Array
