Programmer Guide/Macro Library: Difference between revisions
From STX Wiki
Jump to navigationJump to search
(→Macros) |
|||
| Line 13: | Line 13: | ||
* [[/BSeq|BSeq]] → create, configure and manage a signal sequence | * [[/BSeq|BSeq]] → create, configure and manage a signal sequence | ||
* [[/DataSetCmd|DataSetCmd]] → interface to the main application (Workspace) and its GUI | * [[/DataSetCmd|DataSetCmd]] → interface to the main application (Workspace) and its GUI | ||
{|class="keinrahmen" | |||
!name !!type !!description | |||
|- | |||
|<code>@ParSoundFileNew</code> ||variable ||default values for function [[#NewDialog|NewDialog]] | |||
|- | |||
|<code>@ListAudioSampleCode</code> ||variable ||list of defined sample code keywords | |||
|- | |||
|<code>@MaxAudioChannels</code> ||variable ||maximum number of soundfile channels | |||
|- | |||
|<code>@MaxAudioSRate</code> ||variable ||maximum sampling rate in Hz | |||
|- | |||
|<code>@ListAudioSRate</code> ||variable ||list of standard sampling rate values | |||
|- | |||
|<code>@TempDir</code> ||variable ||directory for temporary files | |||
|- | |||
|<code>BSFOpenList</code> ||table item ||list of open soundfiles (only for [[Programmer_Guide/BScript|BScript]] applications); this table is used by the functions [[#Open|Open]], [[#Close|Close]] and [[#CloseAll|CloseAll]] | |||
|- | |||
|<code>SoundFileList</code> ||variable ||name of the shared soundfile table item (see [[../BSTXIni|BSTXIni]]); the following information is stored in the table fields:<BR> | |||
<code>File</code> = full path<BR> | |||
<code>SRate</code> = sampling rate in Hz<BR> | |||
<code>Channels</code> = number of channels<BR> | |||
<code>Length</code> = signal length in seconds<BR> | |||
<code>Used</code> = open-counter<BR> | |||
<code>Code</code> = sampling code<BR> | |||
<code>Mode</code> = accesss mode<BR> | |||
Because the table is shared between shells, the LOCK/UNLOCK methods should be used to access the table. Do not change table content! | |||
|- | |||
|<code>AutoCloseSF</code> ||variable ||if set to <code>1</code>all soundfiles opened by a [[Programmer_Guide/BScript|BScript]] application are closed when the script exits. | |||
|- | |||
|<code>CSF</code> ||variable ||full path of the selected (active) soundfile. | |||
|- | |||
|<code>CSFH</code> ||variable ||header parameters of the selected (active) soundfile.<BR> | |||
<code>CSFH=srate nchannels nsamples code type accessmode</code> | |||
|} | |||
==Classes== | ==Classes== | ||
Revision as of 17:25, 6 March 2018
This section describes the STx standard macros and classes. They are all linked into the library file stx.lib, which is part of the standard installation, and loaded on program start. A detailed description is only given for the most useful macros and classes. For a description of all other macros and classes not described here, you must look to the source files.
Macros
- BUtil → misc. utility functions
- UM or EM → simple message boxes
- ConLog → write messages to script console and/or Log-window
- LogWindow → Log-window control functions
- ShowItem → show shell item properties and/or data
- BSF → soundfile management functions
- BSeq → create, configure and manage a signal sequence
- DataSetCmd → interface to the main application (Workspace) and its GUI
| name | type | description |
|---|---|---|
@ParSoundFileNew |
variable | default values for function NewDialog |
@ListAudioSampleCode |
variable | list of defined sample code keywords |
@MaxAudioChannels |
variable | maximum number of soundfile channels |
@MaxAudioSRate |
variable | maximum sampling rate in Hz |
@ListAudioSRate |
variable | list of standard sampling rate values |
@TempDir |
variable | directory for temporary files |
BSFOpenList |
table item | list of open soundfiles (only for BScript applications); this table is used by the functions Open, Close and CloseAll |
SoundFileList |
variable | name of the shared soundfile table item (see BSTXIni); the following information is stored in the table fields:
|
AutoCloseSF |
variable | if set to 1all soundfiles opened by a BScript application are closed when the script exits.
|
CSF |
variable | full path of the selected (active) soundfile. |
CSFH |
variable | header parameters of the selected (active) soundfile.
|
Classes
- CObj - the base class for all STx classes
- BXMLDoc - general xml document ← CObj
- BSTXIni - workspace document ← BXMLDoc
- BDataSet - project document and project management ← BXMLDoc
Alphabetical List of Macros and Classes
ADesc · APar · BDataSet · BSF · BSTXIni · BSeq · BUTIL · BXMLDoc · CDlgMap · CMenu · COBJ · CONLOG · CObjEx · CREATEMENU · CTemplates · DISPATCHMSG · DOMODALDIALOG · DataSetCmd · EM · EXTSETUP · GENERATESCALEPARAMS · GETDESKTOP · GETMESSAGE · GETMONITOR · GETOUTPUTVALUE · GETWINDOWPOS · INITDIALOGITEM · Kernal · KlattSyn · LOGMSG · LOGWINDOW · METASEGMENT · MSGQUEUE · ModalDialog · PLAYCURSOR · POSTMESSAGE · PROGRESSBOX · Playwave · SECTIONFILE · SETCONTROLMODE · SETGRAPHXSCALE · SETMSGHANDLER · SETWAVEIO · SETWINDOWPOS · SHOWITEM · SOURCEFILE · SetupSheet · TBMGR · UM · WINDOWSIZEDLG · XGraph · XPlot · XWave
