Programmer Guide/Macro Library: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Macros and Classes of the Standard Library}}
{{DISPLAYTITLE:Macros and Classes of the Standard Library}}
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.


==Alphabetical List of Macros and Classes==
<splist
parent=Programmer_Guide/Macro_Library
sort=asc
sortby=title
showpath=no
liststyle=bar
kidsonly=yes
/>


==Macros==
==Quick Overview==
* [[/BUTIL|BUtil]] &rarr; misc. utility functions
;Macros
* [[/UM|UM or EM]] &rarr; simple message boxes
{|class=keinrahmen
* [[/CONLOG|ConLog]] &rarr; write messages to [[User_Guide/STX_Console|script console]] and/or [[User_Guide/Log_Window|Log-window]]
|'''Name''' ||'''Description'''
* [[/LOGWINDOW|LogWindow]] &rarr; [[User_Guide/Log_Window|Log-window]] control functions
|-
* [[/SHOWITEM|ShowItem]] &rarr; show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data
|[[/BUTIL|BUtil]] ||misc. utility functions
* [[/BSF|BSF]] &rarr; soundfile management functions
* [[/BSeq|BSeq]] &rarr; create, configure and manage a signal sequence
* [[/DataSetCmd|DataSetCmd]] &rarr; interface to the main application (Workspace) and its GUI
 
{|class="keinrahmen"
!name !!type !!description
|-
|-
|<code>@ParSoundFileNew</code> ||variable ||default values for function [[#NewDialog|NewDialog]]
|[[/UM|UM or EM]] ||simple message boxes to display user- and error-messages
|-
|-
|<code>@ListAudioSampleCode</code> ||variable ||list of defined sample code keywords
|[[/CONLOG|ConLog]] ||write messages to [[User_Guide/STX_Console|script console]] and/or [[User_Guide/Log_Window|Log-window]]
|-
|-
|<code>@MaxAudioChannels</code> ||variable ||maximum number of soundfile channels
|[[/LOGWINDOW|LogWindow]] || [[User_Guide/Log_Window|Log-window]] control functions
|-
|-
|<code>@MaxAudioSRate</code> ||variable ||maximum sampling rate in Hz
|[[/SHOWITEM|ShowItem]] ||show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data
|-
|-
|<code>@ListAudioSRate</code> ||variable ||list of standard sampling rate values
|[[/BSF|BSF]] ||soundfile management functions
|-
|-
|<code>@TempDir</code> ||variable ||directory for temporary files
|[[/DataSetCmd|DataSetCmd]] ||interface to the main application (Workspace) and its GUI
|}
 
;Classes
{|class="keinrahmen"
|'''Name''' ||'''Description''' ||'''Parent-Class'''
|-
|-
|<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]]
|[[/COBJ|CObj]] ||the base class for all {{STX}} classes ||
|-
|-
|<code>SoundFileList</code> ||variable ||name of the shared soundfile table item (see [[../BSTXIni|BSTXIni]]); the following information is stored in the table fields:<BR>
|[[/BSeq|BSeq]] ||create, configure and manage a signal sequence ||CObj
<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.
|[[/BXMLDoc|BXMLDoc]] ||general xml document ||CObj
|-
|-
|<code>CSF</code> ||variable ||full path of the selected (active) soundfile.
|[[/BSTXIni|BSTXIni]] ||the workspace document ||BXMLDoc
|-
|-
|<code>CSFH</code> ||variable ||header parameters of the selected (active) soundfile.<BR>
|[[/BDataSet|BDataSet]] ||project document and project management ||BXMLDoc
<code>CSFH=srate nchannels nsamples code type accessmode</code>
|}
|}


==Classes==
==See also==
* [[/COBJ|CObj - the base class for all {{STX}} classes]]
[[/Kernal|Macros and Classes of the STx Kernal]]
* [[/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==
<splist
parent=Programmer_Guide/Macro_Library
sort=asc
sortby=title
showpath=no
liststyle=bar
kidsonly=yes
/>

Latest revision as of 11:41, 7 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
Name Description
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
Name Description Parent-Class
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

See also

Macros and Classes of the STx Kernal

Retrieved from "https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=Programmer_Guide/Macro_Library&oldid=9885"

Navigation menu

Personal tools