NAME

APlaySBucket − play specified sound bucket and return transaction ID

SYNOPSIS

#include <audio/Alib.h>

ATransID APlaySBucket (

Audio *audio,

SBucket *sb,

SBPlayParams *pp,

long *status_return

);

DESCRIPTION

APlaySBucket() plays the audio data in the specified sound bucket on the specified server connection and returns a transaction ID. 

audio specifies the Audio structure associated with this connection. 

sb specifies the sound bucket to be played. 

pp specifies the play parameters associated with the play operation. 

status_return receives the returned status of the operation, unless it is set to NULL. 

RETURN VALUE

Upon successful completion, APlaySBucket() returns the transaction ID. 

ERRORS

If status_return is not set to NULL, one of the following is returned in status_return:

 0 AENoError

 2 AEBadAudio

10 AEBadGainMatrix

20 AEBadSoundBucket

EXAMPLES

The following example plays the audio data contained in the sound bucket specified by sb and returns a transaction ID. 

ATransID xid;           /* transaction ID */
Audio *audio;           /* audio connection */
SBucket *sb;            /* sound bucket*/
SBPlayParams *pparams;  /* play parameters */
long status;            /* error status */
.
.
.
/* play sound bucket */
xid = APlaySBucket(audio, sb, pparams, &status);

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 the hardware manual that accompanies your system. 

AUTHOR

APlaySBucket() was developed by HP. 

SEE ALSO

ACreateSBucket(3X), ADestroySBucket(3X), AGetSBucketData(3X), ALoadAFile(3X), APutSBucketData(3X), ARecordAData(3X), ASaveSBucket(3X). 

Using the Audio Application Program Interface.

Hewlett-Packard Company  —  HP-UX Release 9.03: April 1994