ResumeInstrument

Resumes playback of a paused instrument.

Synopsis

Err ResumeInstrument (Item Instrument)

Description

This function resumes playback of an instrument paused using PauseInstrument(). A resumed instrument continues playback from the point where it was paused. It does not restart from the beginning of a note.

This function is intended primarily for sampled sound instruments, where a paused instrument retains its playback position within a sampled sound. PauseInstrument() and ResumeInstrument() used with sound synthesis instruments may not have effects any different than StartInstrument() and StopInstrument().

This function has no effect on an instrument that has been stopped or restarted after being paused.

Arguments

Instrument: The item number for the instrument.

Return Value

The function returns a non-negative value if successful or an error code (a negative value) if an error occurs.

Implementation

SWI implemented in Audio folio V20.

Associated Files

audio.h