NAME

AGrabServer − acquire exclusive use of audio server

SYNOPSIS

#include <Alib.h> Bool
AGrabServer (

Audio ∗  audio,

long ∗  status_return );

DESCRIPTION

AGrabServer() acquires exclusive use of the audio server for this connection and returns TRUE.  If the server has already been grabbed it returns FALSE.  When the server is grabbed, it will not start playing or recording any new transactions from other connections. 

audio specifies the Audio structure associated with this connection. 

status_return receives the returned status of the operation, unless this parameter is passed in as a NULL pointer.  If status_return is set to NULL, Alib will do the error handling. 

RETURN VALUE

Upon successful completion, AGrabServer() returns TRUE; if the server is already grabbed, the return is FALSE. 

ERRORS

If status_return is not set to NULL, it can return one of the following values:

0  AENoError No error - the call completed successfully. 

2  AEBadAudio The audio structure is invalid.  A pointer to a valid audio structure may be missing (use AOpenAudio() to get a valid pointer). 

EXAMPLE

The following example grabs the server for the connection associated with audio and sets up status to receive an error status. 

Boolean grab;  /∗ server acquired ∗/

Audio ∗ audio;  /∗ audio connection ∗/

long status;  /∗ error status ∗/
.
.
.

/∗ grab server for audio connection ∗/

grab = AGrabServer(audio, &status);

NOTE

In order to ensure that the compiler finds the Audio Library (libAlib.sl) and the Alib.h header file, you must add the following switches:

-L /opt/audio/lib
-I/opt/audio/include

DEPENDENCIES

This function belongs to the Audio Library of functions that manage connections to an audio server.  The audio server must run on a system that has audio hardware. To find out whether or not your system has audio hardware, refer to Using the Audio Developer’s Kit or the online help for the Audio control panel.  For information about the audio capabilities of a particular system use the online example audioinfo.c. 

AUTHOR

AGrabServer() was developed by HP. 

SEE ALSO

AUngrabServer(3X). 

Hewlett-Packard Company  —  Audio Library: February, 1995