TraceAudio
Turns specific audio diagnostics on or off (OBSOLETE)
Synopsis
uint32 TraceAudio (uint32 traceMask)
Description
This function is obsolete.
Development versions of the Audio folio have diagnostic information available which can be turned on or off with this function. To help 3DO Technical Support diagnose a bug, you may be asked to turn on certain TRACE _ flags and send the result for interpretation.
This function has no effect in production versions of the Audio folio.
Note that this is a system-wide setting. It affects all clients of the Audio folio, not just the task that calls TraceAudio().
Arguments
- traceMask
- Set of flags indicating which information should be on. A set flag turns on the corresponding trace feature, a cleared flag turns off the corresponding trace feature. 0 turns off all tracing. See Flags section for complete description of each trace flag.
Flags
- TRACE_ATTACHMENT
- Trace an attachment.
- TRACE_DSP
- Trace DSP specific calls such as
AllocAmplitude().
- TRACE_ENVELOPE
- Trace an envelope.
- TRACE_INT
- Trace internal information.
- TRACE_ITEM
- Trace item creation and deletion.
- TRACE_KNOB
- Trace a knob.
- TRACE_NOTE
- Trace note playing.
- TRACE_OFX
- Trace parsing of DSP instrument files, DSP resource allocation, and so on.
- TRACE_SAMPLE
- Trace AIFF sample loading, and so on.
- TRACE_TIMER
- Trace a timer.
- TRACE_TOP
- Trace the parameters passed to, and returned from, most Audio folio calls.
- TRACE_TUNING
- Trace a tuning.
Return Value
The function returns the previous trace mask setting.
Implementation
SWI implemented in Audio folio V20.
Examples
// Turn on a few interesting things
TraceAudio (TRACE_TOP | TRACE_INT | TRACE_KNOB);
// Turn off all tracing
TraceAudio (0);
Caveats
Given that this is a system-wide setting that any task can set at any time, it really isn't possible to use the return value of this function to create a stack of previous settings. As soon as more than one task starts setting TraceAudio(), the stack would be invalid.
As of V24, this function has no longer has any effect. The messages were removed to reduce code size.
Associated Files
audio.h