audio_capture_trigger :: Quanser C Functions

navigation bar

audio_capture_trigger

Triggers another sequence of reads from a seekable file or URL.

Description

The audio_capture_trigger function triggers another read from the seekable file or URL. In other words, it causes the audio stream to be rewound and audio samples to be provided from the audio stream again. This function is useful for asynchronous events that have an associated sound.

Prototype

t_error
audio_capture_trigger(t_audio_capture capture);

Parameters

t_audio_capture capture

A handle to the audio capture session, as returned by audio_capture_open.

Return value

The return value is 0 if the trigger is successful. Otherwise a negative error code is returned. Error codes are defined in quanser_errors.h. A suitable error message may be retrieved using msg_get_error_message.

Error codes

QERR_INVALID_ARGUMENT

An invalid capture session was passed as an argument. Once a capture session has been closed using audio_capture_trigger the session handle is invalid.

Requirements

Include Files	Libraries
quanser_audio.h	quanser_media.lib;quanser_runtime.lib;quanser_common.lib

Examples

result = audio_capture_trigger(capture);