Programmer Guide/Macro Library: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
Line 2: Line 2:


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.
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|BUtil]] → misc. utility functions
* [[/UM|UM or EM]] → simple message boxes
* [[/CONLOG|ConLog]] → write messages to [[User_Guide/STX_Console|script console]] and/or [[User_Guide/Log_Window|Log-window]]
* [[/LOGWINDOW|LogWindow]] → [[User_Guide/Log_Window|Log-window]] control functions
* [[/SHOWITEM|ShowItem]] → show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data
* [[/BSF|BSF]] → soundfile management functions
* [[/BSeq|BSeq]] → create, configure and manage a signal sequence
* [[/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==
* [[/COBJ|CObj - the base class for all {{STX}} classes]]
* [[/BXMLDoc|BXMLDoc - general xml document]] &larr; CObj
* [[/BSTXIni|BSTXIni - workspace document]] &larr; BXMLDoc
* [[/BDataSet|BDataSet - project document and project management]] &larr; BXMLDoc


==Alphabetical List of Macros and Classes==
==Alphabetical List of Macros and Classes==
Line 64: Line 12:
kidsonly=yes
kidsonly=yes
/>
/>
==Quick Overview==
;Macros
{|class=keinrahmen
|[[/BUTIL|BUtil]] ||misc. utility functions
|[[/UM|UM or EM]] ||simple message boxes to display user- and error-messages
|[[/CONLOG|ConLog]] ||write messages to [[User_Guide/STX_Console|script console]] and/or [[User_Guide/Log_Window|Log-window]]
|[[/LOGWINDOW|LogWindow]] || [[User_Guide/Log_Window|Log-window]] control functions
|[[/SHOWITEM|ShowItem]] ||show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data
|[[/BSF|BSF]] ||soundfile management functions
|[[/DataSetCmd|DataSetCmd]] ||interface to the main application (Workspace) and its GUI
|}
;Classes
{|class="keinrahmen"
|[[/COBJ|CObj]] ||the base class for all {{STX}} classes ||-
|[[/BSeq|BSeq]] ||create, configure and manage a signal sequence ||CObj
|[[/BXMLDoc|BXMLDoc]] ||general xml document ||CObj
|[[/BSTXIni|BSTXIni]] ||the workspace document ||BXMLDoc
|[[/BDataSet|BDataSet]] ||project document and project management ||BXMLDoc
|}

Revision as of 17:34, 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.

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

Quick Overview

Macros
BUtil misc. utility functions UM or EM simple message boxes to display user- and error-messages 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 DataSetCmd interface to the main application (Workspace) and its GUI
Classes
CObj the base class for all STx classes - BSeq create, configure and manage a signal sequence CObj BXMLDoc general xml document CObj BSTXIni the workspace document BXMLDoc BDataSet project document and project management BXMLDoc
Retrieved from "https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=Programmer_Guide/Macro_Library&oldid=9863"

Navigation menu

Personal tools