Programmer Guide/Macro Library: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
:{|class="einrahmen" | :{|class="einrahmen" | ||
![[/StdLib|StdLib.stx]] | ![[/StdLib|StdLib.stx]] | ||
|- | |- | ||
|'''application management''' | |'''application management''' | ||
| Line 18: | Line 18: | ||
|[[/StdLib#stxFileTypeList|stxFileTypeList]] · [[/StdLib#stxFileType|stxFileType]] · [[/StdLib#SectionFile|SectionFile]] · [[/StdLib#FileToolBox|FileToolBox]] | |[[/StdLib#stxFileTypeList|stxFileTypeList]] · [[/StdLib#stxFileType|stxFileType]] · [[/StdLib#SectionFile|SectionFile]] · [[/StdLib#FileToolBox|FileToolBox]] | ||
|- | |- | ||
|'''display functions''' | |'''display functions''' | ||
|[[/StdLib#LogWindow|LogWindow]] · [[/StdLib#ConLog|ConLog]] · [[/StdLib#UM and EM|UM and EM]] · [[/StdLib#ShowItem|ShowItem]] | |[[/StdLib#LogWindow|LogWindow]] · [[/StdLib#ConLog|ConLog]] · [[/StdLib#UM and EM|UM and EM]] · [[/StdLib#ShowItem|ShowItem]] | ||
|- | |- | ||
|'''dialog and window functions''' | |||
|[[/StdLib#CreateMenu|CreateMenu]] · [[/StdLib#DoModalDialog|DoModalDialog]] · [[/StdLib#SetModalWindow|SetModalWindow]] · [[/StdLib#GetWindowPos|GetWindowPos]] · [[/StdLib#SetWindowPos|SetWindowPos]] · [[/StdLib#WindowSizeDlg|WindowSizeDlg]] · [[/StdLib#GetMonitor|GetMonitor]] · [[/StdLib#GetDesktop|GetDesktop]] · [[/StdLib#ProgressBox|ProgressBox]] · [[/StdLib#InitDialogItem|InitDialogItem]] · [[/StdLib#SetControlMode|SetControlMode]] | |[[/StdLib#CreateMenu|CreateMenu]] · [[/StdLib#DoModalDialog|DoModalDialog]] · [[/StdLib#SetModalWindow|SetModalWindow]] · [[/StdLib#GetWindowPos|GetWindowPos]] · [[/StdLib#SetWindowPos|SetWindowPos]] · [[/StdLib#WindowSizeDlg|WindowSizeDlg]] · [[/StdLib#GetMonitor|GetMonitor]] · [[/StdLib#GetDesktop|GetDesktop]] · [[/StdLib#ProgressBox|ProgressBox]] · [[/StdLib#InitDialogItem|InitDialogItem]] · [[/StdLib#SetControlMode|SetControlMode]] | ||
|- | |- | ||
|'''[[Programmer_Guide/Shell_Items/SPU|SPU]] and [[Programmer_Guide/Shell_Items/Graph|graph]] functions''' | |||
|[[/StdLib#SetGraphXScale|SetGraphXScale]] · [[/StdLib#GetOutputValue|GetOutputValue]] | |[[/StdLib#SetGraphXScale|SetGraphXScale]] · [[/StdLib#GetOutputValue|GetOutputValue]] | ||
|- | |- | ||
|'''[[Programmer_Guide/Shell_Items/SPU|SPUs]]''' | |||
|[[/StdLib#XScaleLinear|XScaleLinear]] · [[/StdLib#XScaleBark|XScaleBark]] · [[/StdLib#Table2Output|Table2Output]] · [[/StdLib#Wave2output|Wave2output]] | |[[/StdLib#XScaleLinear|XScaleLinear]] · [[/StdLib#XScaleBark|XScaleBark]] · [[/StdLib#Table2Output|Table2Output]] · [[/StdLib#Wave2output|Wave2output]] | ||
|- | |- | ||
![[/BSF|BSF.stx]] | |||
|- | |- | ||
| ||'''macro BSF<BR>soundfile handling | | ||'''macro 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]] | ||
|- | |- | ||
![[/BUTIL|BUTIL.stx]] | |||
|- | |- | ||
| '''macro 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]] | ||
|- | |- | ||
![[/Classes|Classes.stx]] | |||
|- | |- | ||
|'''class CObj<BR>the base class''' | |||
|[[/CObj#...|...]] · ... | |[[/CObj#...|...]] · ... | ||
|- | |- | ||
|'''class CObjEx<BR>extension class for scripts''' | |||
|[[/CObjEx#...|...]] · ... | |[[/CObjEx#...|...]] · ... | ||
|- | |- | ||
|'''class ModalDialog<BR>a modal dialog''' | |||
|[[/ModalDialog#...|...]] · ... | |[[/ModalDialog#...|...]] · ... | ||
|- | |- | ||
|'''class SetupSheet<BR>property sheets''' | |||
|[[/SetupSheet#...|...]] · ... | |[[/SetupSheet#...|...]] · ... | ||
|- | |- | ||
|'''class PlayWave<BR>general play class''' | |||
|[[/PlayWave#...|...]] · ... | |[[/PlayWave#...|...]] · ... | ||
|- | |- | ||
|'''class SetWaveIO<BR>wave device setup''' | |||
|[[/SetWaveIO#...|...]] · ... | |[[/SetWaveIO#...|...]] · ... | ||
|- | |- | ||
|'''class CalibSig<BR>signal calibration''' | |||
|[[/CalibSig#...|...]] · ... | |[[/CalibSig#...|...]] · ... | ||
|- | |- | ||
|'''class CAppQueue<BR>application queue for batch processing''' | |||
|[[/CAppQueue#...|...]] · ... | |[[/CAppQueue#...|...]] · ... | ||
|- | |- | ||
|'''class BSignal<BR>signal processing controller''' | |||
|[[/BSignal#...|...]] · ... | |[[/BSignal#...|...]] · ... | ||
|- | |- | ||
|'''class CDlgMap<BR>enhanced modal dialog''' | |||
|[[/CDlgMap#...|...]] · ... | |[[/CDlgMap#...|...]] · ... | ||
|- | |- | ||
|'''class CMenu<BR>menu handling class''' | |||
|[[/CMenu#...|...]] · ... | |[[/CMenu#...|...]] · ... | ||
|- | |- | ||
|'''class XWave<BR>enhanced wave object''' | |||
|[[/XWave#...|...]] · ... | |[[/XWave#...|...]] · ... | ||
|- | |- | ||
|'''class XPlot<BR>general function plot''' | |||
|[[/XPlot#...|...]] · ... | |[[/XPlot#...|...]] · ... | ||
|- | |- | ||
|'''class XGraph<BR>a graph in a XPlot display''' | |||
|[[/XGraph#...|...]] · ... | |[[/XGraph#...|...]] · ... | ||
|- | |- | ||
| ||& | |'''class CTemplates<BR>manage XML templates''' | ||
|[[/CTemplates#...|...]] · ... | |||
|- | |- | ||
|'''class NDLib<BR>signal processing, audio descriptors, ...''' | |||
|[[/NDLib#...|...]] · ... | |[[/NDLib#...|...]] · ... | ||
|- | |- | ||
|'''class TBMGR<BR>toolbox manager and base class''' | |||
|[[/TBMGR#...|...]] · ... | |[[/TBMGR#...|...]] · ... | ||
|- | |- | ||
|'''class KlattSyn<BR>formant speech synthesis''' | |||
|[[/KlattSyn#...|...]] · ... | |[[/KlattSyn#...|...]] · ... | ||
|- | |- | ||
![[/BXMLDoc|BXMLDoc.stx]] | |||
|- | |- | ||
|'''class BXMLDoc<BR>xml document''' | |||
|[[/BXMLDoc#...|...]] · ... | |[[/BXMLDoc#...|...]] · ... | ||
|- | |- | ||
![[/BSTXIni|BSTXIni.stx]] | |||
|- | |- | ||
|'''class BSTXIni<BR>workspace document''' | |||
|[[/BSTXIni#...|...]] · ... | |[[/BSTXIni#...|...]] · ... | ||
|- | |- | ||
![[/BDataSet|BDataSet.stx]] | |||
|- | |- | ||
|'''class BDataSet<BR>project document''' | |||
|[[/BDataSet#...|...]] · ... | |[[/BDataSet#...|...]] · ... | ||
|- | |- | ||
![[/DataSetCmd|DataSet.stx]] | |||
|- | |- | ||
|'''macro DataSetCmd<BR>execute dataset command''' | |||
|[[/DataSetCmd#...|...]] · ... | |[[/DataSetCmd#...|...]] · ... | ||
|- | |- | ||
![[/CGraphSetup|CGraphSetup.stx]] | |||
|- | |- | ||
|'''class CGraphSetup<BR>graphics profile''' | |||
|[[/CGraphSetup#...|...]] · ... | |[[/CGraphSetup#...|...]] · ... | ||
|- | |- | ||
|'''class SGraphColors<BR>graph settings''' | |||
|[[/SGraphColors#...|...]] · ... | |[[/SGraphColors#...|...]] · ... | ||
|- | |- | ||
![[/CAppSetup|CAppSetup.stx]] | |||
|- | |- | ||
|'''class CAppSetup<BR>viewer setup and control''' | |||
|[[/CAppSetup#...|...]] · ... | |[[/CAppSetup#...|...]] · ... | ||
|- | |- | ||
![[/BSeq|BSeq.stx]] | |||
|- | |- | ||
|'''class BSeq<BR>signal sequence''' | |||
|[[/CAppSetup#...|...]] · ... | |[[/CAppSetup#...|...]] · ... | ||
|- | |- | ||
![[/Parameter|Parameter.stx]] | |||
|- | |- | ||
|'''class APar<BR>parameter data management''' | |||
|[[/APar#...|...]] · ... | |[[/APar#...|...]] · ... | ||
|- | |- | ||
![[/ADesc|ADesc.stx]] | |||
|- | |- | ||
|'''class ADesc<BR>general audio descriptor management''' | |||
|[[/ADesc#...|...]] · ... | |[[/ADesc#...|...]] · ... | ||
|- | |- | ||
Revision as of 16:16, 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.
StdLib.stx application 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 BSF.stx macro BSF
soundfile handlingNewDialog · OpenDialog · Open · Close · CloseAll · Select · Truncate BUTIL.stx macro BUTIL
misc. utility functionsMsgBox · EditBox · FileDialog · Copy/Move/DeleteFile · DirectoryDialog · GetDirectory · Directory · GetSwitch · GetKeyWord · GetKeyIndex · SelectTable Classes.stx 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... · ... 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... · ... BXMLDoc.stx class BXMLDoc
xml document... · ... BSTXIni.stx class BSTXIni
workspace document... · ... BDataSet.stx class BDataSet
project document... · ... DataSet.stx macro DataSetCmd
execute dataset command... · ... CGraphSetup.stx class CGraphSetup
graphics profile... · ... class SGraphColors
graph settings... · ... CAppSetup.stx class CAppSetup
viewer setup and control... · ... BSeq.stx class BSeq
signal sequence... · ... Parameter.stx class APar
parameter data management... · ... ADesc.stx class ADesc
general audio descriptor management... · ...
alphabetical list of macros
sort=asc has no subpages to list.
