Abruptly stops an instrument.
Err StopInstrument (Item Instrument, TagArg *tagList) Err StopInstrumentVA (Item Instrument, uint32 tag1, ...)
This function, which abruptly stops an instrument, is called when you want to abort the execution of an instrument immediately. This can cause a click because of its suddenness. You should use ReleaseInstrument()
to gently release an instrument according to its release characteristics.
Affects only instruments in the AF_STARTED or AF_RELEASED states: sets them to the AF_STOPPED state, or, if the Instrument has the AF_INSF_AUTOABANDON flag set, the AF_ABANDONED state.
This function supersedes a call to PauseInstrument()
.
The function returns a non-negative value if successful or an error code (a negative value) if an error occurs.
SWI implemented in Audio folio V20.
audio.h
StartInstrument
(), ReleaseInstrument(), PauseInstrument(), ResumeInstrument(), Instrument