Difference between revisions of "Programmer Guide/Macro Library"

From STX Wiki
Jump to navigation Jump to search
Line 5: Line 5:
 
==Macros==
 
==Macros==
 
*[[/BSF|BSF]] → soundfile management functions
 
*[[/BSF|BSF]] → soundfile management functions
*[[/BUTIL|BUtil]] → misc. utility functions
+
*[[Programmer_Guide/Macro_Library/BUTIL|BUtil]] → misc. utility functions
 
*[[/UM|UM or EM]] → simple message boxes
 
*[[/UM|UM or EM]] → simple message boxes
 
*[[/CONLOG|ConLog]] → write messages to [[User_Guide|STX_Console]] Console and/or [[User_Guide/Log_Window|Log-window]]
 
*[[/CONLOG|ConLog]] → write messages to [[User_Guide|STX_Console]] Console and/or [[User_Guide/Log_Window|Log-window]]

Revision as of 19:53, 20 November 2017


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

Classes

Outdated Documentation

ADesc.stx
Implements a set of classes to store and retrieve audio descriptor data in a combined XML/binary format.
Documentation included in source file.
BDataSet.stx
class BDataSet
project document
... · ...
BSeq.stx
class BSeq
signal sequence
... · ...
BSF.stx
macro BSF
soundfile handling
NewDialog · OpenDialog · Open · Close · CloseAll · Select · Truncate
BSTXIni.stx
class BSTXIni
workspace document
... · ...
BUTIL.stx
macro BUTIL
misc. utility functions
MsgBox · EditBox · FileDialog · Copy/Move/DeleteFile · DirectoryDialog · GetDirectory · Directory · GetSwitch · GetKeyWord · GetKeyIndex · SelectTable
BXMLDoc.stx
class BXMLDoc
xml document
... · ...
CAppSetup.stx
Implements the setup dialogs, runtime control classes and the analysis methods for all Viewer-applications.
Documentation included in source file.
CGraphSetup.stx
class CGraphSetup
graphics profile
... · ...
class SGraphColors
graph settings
... · ...
Classes.stx
basic class library
class CObj
the base class
... · ...
class CObjEx
extension class for scripts
... · ...
class ModalDialog
a modal dialog
... · ...
class SetupSheet
property sheets
... · ...
class PlayWave
general play class
... · ...
class SetWaveIO
wave device setup
Implements the wave device settings dialog and some wave device select/query functions.
Documentation included in source file.
class CalibSig
signal calibration
... · ...
class CAppQueue
batch queue
This class is used to control the viewers and other applications started by the workspace application.
Documentation included in source file.
class BSignal
signal processing controller
Implements the dialogs and execution modules for the signal modification methods (amplify, normalize, div. filters) included in the workspace application.
Documentation included in source file.
class CDlgMap
enhanced modal dialog
... · ...
class CMenu
menu handling class
... · ...
class XWave
enhanced wave object
... · ...
class XPlot
general function plot
... · ...
class XGraph
a graph in a XPlot display
... · ...
class CTemplates
manage XML templates
Management class for the templates used by the workspace application (e.g. ASegTemplate).
Documentation included in source file.
class NDLib
signal processing, audio descriptors, ...
... · ...
class TBMGR
toolbox manager and base class
... · ...
class KlattSyn
formant speech synthesis
... · ...
DataSet.stx
macro DataSetCmd
execute dataset command
... · ...
Parameter
class APar
parameter data management
... · ...
StdLib.stx
basic macro library
application management AppLoad · AppMain · AppCleanup · AppHelp
message handling PostMessage · SetMsgHandler · DispatchMsg · MsgQueue · MsgFilter · GetMessage
utilities for standard
STx applications
ExtSetup · PlayCursor · GenerateScaleParams · MetaSegment
file functions stxFileTypeList · stxFileType · SectionFile · FileToolBox
display functions LogWindow · ConLog · UM and EM · ShowItem
dialog and window functions CreateMenu · DoModalDialog · SetModalWindow · GetWindowPos · SetWindowPos · WindowSizeDlg · GetMonitor · GetDesktop · ProgressBox · InitDialogItem · SetControlMode
SPU and graph functions SetGraphXScale · GetOutputValue
SPUs XScaleLinear · XScaleBark · Table2Output · Wave2output


alphabetical list of macros

sort=asc has no subpages to list.