Go to main content

man pages section 9: DDI and DKI Driver Entry Points

Exit Print View

Updated: Thursday, June 13, 2019
 
 

audio_engine_start(9E)

Name

audio_engine_start, audio_engine_stop - start or stop an audio engine

Synopsis

#include <sys/audio/audio_driver.h>

int prefix_start(void *state);
void prefix_stop(void *state);

Parameters

state

pointer to driver supplied soft state

Interface Level

Solaris DDI specific (Solaris DDI)

Description

The audio_engine_start() function starts an audio engine that has been initialized with audio_engine_open(9E). This initiates actual playback or recording of audio. The data transfer must start at the first frame in the engine's buffer.

The audio_engine_stop() function stops an audio engine that was previously started with audio_engine_start() and resets the frame index back to 0. The master frame counter for the engine is not reset.

Once audio_engine_stop() returns, the engine must not perform any further data transfers to or from the audio buffer. Furthermore, actual play back or capture of audio associated with the engine shall have ceased.

Return Values

The audio_engine_start() function returns 0 on success or an error number on failure.

Context

These functions may be called from user, kernel, or interrupt context.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed

See Also

audio(4D), attributes(7), audio_engine_open(9E), audio_engine_ops(9S)