Programmer Guide/Macro Library: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
![[/ADesc|ADesc.stx]] | ![[/ADesc|ADesc.stx]] | ||
|- | |- | ||
|'''class ADesc<BR>general audio descriptor management''' | |'''class [[/ADesc|ADesc]]<BR>general audio descriptor management''' | ||
|[[/ADesc#...|...]] · ... | |[[/ADesc#...|...]] · ... | ||
|- | |- | ||
![[/BDataSet|BDataSet.stx]] | ![[/BDataSet|BDataSet.stx]] | ||
|- | |- | ||
|'''class BDataSet<BR>project document''' | |'''class [[/BDataSet|BDataSet]]<BR>project document''' | ||
|[[/BDataSet#...|...]] · ... | |[[/BDataSet#...|...]] · ... | ||
|- | |- | ||
![[/BSeq|BSeq.stx]] | ![[/BSeq|BSeq.stx]] | ||
|- | |- | ||
|'''class BSeq<BR>signal sequence''' | |'''class [[/BSeq|BSeq]]<BR>signal sequence''' | ||
|[[/CAppSetup#...|...]] · ... | |[[/CAppSetup#...|...]] · ... | ||
|- | |- | ||
![[/BSF|BSF.stx]] | ![[/BSF|BSF.stx]] | ||
|- | |- | ||
|'''macro BSF<BR>soundfile handling | |'''macro [[/BSF|BSF]]<BR>soundfile handling | ||
|[[/BSF#NewDialog|NewDialog]] · [[/BSF#OpenDialog|OpenDialog]] · [[/BSF#Open|Open]] · [[/BSF#Close|Close]] · [[/BSF#CloseAll|CloseAll]] · [[/BSF#Select|Select]] · [[/BSF#Truncate|Truncate]] | |[[/BSF#NewDialog|NewDialog]] · [[/BSF#OpenDialog|OpenDialog]] · [[/BSF#Open|Open]] · [[/BSF#Close|Close]] · [[/BSF#CloseAll|CloseAll]] · [[/BSF#Select|Select]] · [[/BSF#Truncate|Truncate]] | ||
|- | |- | ||
![[/BSTXIni|BSTXIni.stx]] | ![[/BSTXIni|BSTXIni.stx]] | ||
|- | |- | ||
|'''class BSTXIni<BR>workspace document''' | |'''class [[/BSTXIni|BSTXIni]]<BR>workspace document''' | ||
|[[/BSTXIni#...|...]] · ... | |[[/BSTXIni#...|...]] · ... | ||
|- | |- | ||
![[/BUTIL|BUTIL.stx]] | ![[/BUTIL|BUTIL.stx]] | ||
|- | |- | ||
| '''macro BUTIL<BR>misc. utility functions''' | | '''macro [[/BUTIL|BUTIL]]<BR>misc. utility functions''' | ||
|[[/BUTIL#MsgBox|MsgBox]] · [[/BUTIL#EditBox|EditBox]] · [[/BUTIL#FileDialog|FileDialog]] · [[/BUTIL#FileCommands|Copy/Move/DeleteFile]] · [[/BUTIL#DirectoryDialog|DirectoryDialog]] · [[/BUTIL#GetDirectory|GetDirectory]] · [[/BUTIL#Directory|Directory]] · [[/BUTIL#GetSwitch|GetSwitch]] · [[/BUTIL#GetKeyWord|GetKeyWord]] · [[/BUTIL#GetKeyIndex|GetKeyIndex]] · [[/BUTIL#SelectTable|SelectTable]] | |[[/BUTIL#MsgBox|MsgBox]] · [[/BUTIL#EditBox|EditBox]] · [[/BUTIL#FileDialog|FileDialog]] · [[/BUTIL#FileCommands|Copy/Move/DeleteFile]] · [[/BUTIL#DirectoryDialog|DirectoryDialog]] · [[/BUTIL#GetDirectory|GetDirectory]] · [[/BUTIL#Directory|Directory]] · [[/BUTIL#GetSwitch|GetSwitch]] · [[/BUTIL#GetKeyWord|GetKeyWord]] · [[/BUTIL#GetKeyIndex|GetKeyIndex]] · [[/BUTIL#SelectTable|SelectTable]] | ||
|- | |- | ||
![[/BXMLDoc|BXMLDoc.stx]] | ![[/BXMLDoc|BXMLDoc.stx]] | ||
|- | |- | ||
|'''class BXMLDoc<BR>xml document''' | |'''class [[/BXMLDoc|BXMLDoc]]<BR>xml document''' | ||
|[[/BXMLDoc#...|...]] · ... | |[[/BXMLDoc#...|...]] · ... | ||
|- | |- | ||
![[/CAppSetup|CAppSetup.stx]] | ![[/CAppSetup|CAppSetup.stx]] | ||
|- | |- | ||
|'''class CAppSetup<BR>viewer setup and control''' | |'''class [[/CAppSetup|CAppSetup]]<BR>viewer setup and control''' | ||
|[[/CAppSetup#...|...]] · ... | |[[/CAppSetup#...|...]] · ... | ||
|- | |- | ||
![[/CGraphSetup|CGraphSetup.stx]] | ![[/CGraphSetup|CGraphSetup.stx]] | ||
|- | |- | ||
|'''class CGraphSetup<BR>graphics profile''' | |'''class [[/CGraphSetup|CGraphSetup]]<BR>graphics profile''' | ||
|[[/CGraphSetup#...|...]] · ... | |[[/CGraphSetup#...|...]] · ... | ||
|- | |- | ||
|'''class SGraphColors<BR>graph settings''' | |'''class [[/SGraphColors|SGraphColors]]<BR>graph settings''' | ||
|[[/SGraphColors#...|...]] · ... | |[[/SGraphColors#...|...]] · ... | ||
|- | |- | ||
! | !Classes.stx<BR>basic class library | ||
|- | |- | ||
|'''class CObj<BR>the base class''' | |'''class [[/CObj|CObj]]<BR>the base class''' | ||
|[[/CObj#...|...]] · ... | |[[/CObj#...|...]] · ... | ||
|- | |- | ||
|'''class CObjEx<BR>extension class for scripts''' | |'''class [[/CObjEx|CObjEx]]<BR>extension class for scripts''' | ||
|[[/CObjEx#...|...]] · ... | |[[/CObjEx#...|...]] · ... | ||
|- | |- | ||
|'''class ModalDialog<BR>a modal dialog''' | |'''class [[/ModalDialog|ModalDialog]]<BR>a modal dialog''' | ||
|[[/ModalDialog#...|...]] · ... | |[[/ModalDialog#...|...]] · ... | ||
|- | |- | ||
|'''class SetupSheet<BR>property sheets''' | |'''class [[/SetupSheet|SetupSheet]]<BR>property sheets''' | ||
|[[/SetupSheet#...|...]] · ... | |[[/SetupSheet#...|...]] · ... | ||
|- | |- | ||
|'''class PlayWave<BR>general play class''' | |'''class [[/PlayWave|PlayWave]]<BR>general play class''' | ||
|[[/PlayWave#...|...]] · ... | |[[/PlayWave#...|...]] · ... | ||
|- | |- | ||
|'''class SetWaveIO<BR>wave device setup''' | |'''class [[/SetWaveIO|SetWaveIO]]<BR>wave device setup''' | ||
|[[/SetWaveIO#...|...]] · ... | |[[/SetWaveIO#...|...]] · ... | ||
|- | |- | ||
|'''class CalibSig<BR>signal calibration''' | |'''class [[/CalibSig|CalibSig]]<BR>signal calibration''' | ||
|[[/CalibSig#...|...]] · ... | |[[/CalibSig#...|...]] · ... | ||
|- | |- | ||
|'''class CAppQueue<BR>application queue for batch processing''' | |'''class [[/CAppQueue|CAppQueue]]<BR>application queue for batch processing''' | ||
|[[/CAppQueue#...|...]] · ... | |[[/CAppQueue#...|...]] · ... | ||
|- | |- | ||
|'''class BSignal<BR>signal processing controller''' | |'''class [[/BSignal|BSignal]]<BR>signal processing controller''' | ||
|[[/BSignal#...|...]] · ... | |[[/BSignal#...|...]] · ... | ||
|- | |- | ||
|'''class CDlgMap<BR>enhanced modal dialog''' | |'''class [[/CDlgMap|CDlgMap]]<BR>enhanced modal dialog''' | ||
|[[/CDlgMap#...|...]] · ... | |[[/CDlgMap#...|...]] · ... | ||
|- | |- | ||
|'''class CMenu<BR>menu handling class''' | |'''class [[/CMenu|CMenu]]<BR>menu handling class''' | ||
|[[/CMenu#...|...]] · ... | |[[/CMenu#...|...]] · ... | ||
|- | |- | ||
|'''class XWave<BR>enhanced wave object''' | |'''class [[/XWave|XWave]]<BR>enhanced wave object''' | ||
|[[/XWave#...|...]] · ... | |[[/XWave#...|...]] · ... | ||
|- | |- | ||
|'''class XPlot<BR>general function plot''' | |'''class [[/XPlot|XPlot]]<BR>general function plot''' | ||
|[[/XPlot#...|...]] · ... | |[[/XPlot#...|...]] · ... | ||
|- | |- | ||
|'''class XGraph<BR>a graph in a XPlot display''' | |'''class [[/XGraph|XGraph]]<BR>a graph in a XPlot display''' | ||
|[[/XGraph#...|...]] · ... | |[[/XGraph#...|...]] · ... | ||
|- | |- | ||
|'''class CTemplates<BR>manage XML templates''' | |'''class [[/CTemplates|CTemplates]]<BR>manage XML templates''' | ||
|[[/CTemplates#...|...]] · ... | |[[/CTemplates#...|...]] · ... | ||
|- | |- | ||
|'''class NDLib<BR>signal processing, audio descriptors, ...''' | |'''class [[/NDLib|NDLib]]<BR>signal processing, audio descriptors, ...''' | ||
|[[/NDLib#...|...]] · ... | |[[/NDLib#...|...]] · ... | ||
|- | |- | ||
|'''class TBMGR<BR>toolbox manager and base class''' | |'''class [[/TBMGR|TBMGR]]<BR>toolbox manager and base class''' | ||
|[[/TBMGR#...|...]] · ... | |[[/TBMGR#...|...]] · ... | ||
|- | |- | ||
|'''class KlattSyn<BR>formant speech synthesis''' | |'''class [[/KlattSyn|KlattSyn]]<BR>formant speech synthesis''' | ||
|[[/KlattSyn#...|...]] · ... | |[[/KlattSyn#...|...]] · ... | ||
|- | |- | ||
![[/DataSetCmd|DataSet.stx]] | ![[/DataSetCmd|DataSet.stx]] | ||
|- | |- | ||
|'''macro DataSetCmd<BR>execute dataset command''' | |'''macro [[/DataSetCmd|DataSetCmd]]<BR>execute dataset command''' | ||
|[[/DataSetCmd#...|...]] · ... | |[[/DataSetCmd#...|...]] · ... | ||
|- | |- | ||
! | !Parameter | ||
|- | |- | ||
|'''class APar<BR>parameter data management''' | |'''class [[/APar|APar]]<BR>parameter data management''' | ||
|[[/APar#...|...]] · ... | |[[/APar#...|...]] · ... | ||
|- | |- | ||
Revision as of 17:33, 12 May 2011
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.
ADesc.stx class ADesc
general audio descriptor management... · ... BDataSet.stx class BDataSet
project document... · ... BSeq.stx class BSeq
signal sequence... · ... BSF.stx macro BSF
soundfile handlingNewDialog · OpenDialog · Open · Close · CloseAll · Select · Truncate BSTXIni.stx class BSTXIni
workspace document... · ... BUTIL.stx macro BUTIL
misc. utility functionsMsgBox · EditBox · FileDialog · Copy/Move/DeleteFile · DirectoryDialog · GetDirectory · Directory · GetSwitch · GetKeyWord · GetKeyIndex · SelectTable BXMLDoc.stx class BXMLDoc
xml document... · ... CAppSetup.stx class CAppSetup
viewer setup and control... · ... CGraphSetup.stx class CGraphSetup
graphics profile... · ... class SGraphColors
graph settings... · ... Classes.stx
basic class libraryclass 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... · ... class CalibSig
signal calibration... · ... class CAppQueue
application queue for batch processing... · ... class BSignal
signal processing controller... · ... 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... · ... 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 libraryapplication management AppLoad · AppMain · AppCleanup · AppHelp message handling PostMessage · SetMsgHandler · DispatchMsg · MsgQueue · MsgFilter · GetMessage utilities for standard
STx applicationsExtSetup · 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.
