ADestroySBucket(3X)

NAME

ADestroySBucket − destroy specified sound bucket

SYNOPSIS

#include <Alib.h> void
ADestroySBucket (

Audio ∗ audio,

SBucket ∗ sb,

long ∗ status_return );

DESCRIPTION

ADestroySBucket() destroys the specified sound bucket and frees the space allocated for the sound bucket and its audio data.

Once it has been destroyed, a sound bucket cannot be used to play or record.

audio specifies the Audio structure associated with this connection.

sb specifies the sound bucket to be destroyed.

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.

STRUCTURES

The following is defined in /opt/audio/include/Alib.h.

typedef struct _SBucket {
    AudioAttributes audio_attr; /* Attributes of the audio data
                                    in the sound bucket.          */
    long             max_length; /* The maximum length, in bytes,
                                    of the audio_data buffer. This
                                    is the number of bytes that were
                                    malloc’ed for the audio data. */
    char           * audio_data; /* A pointer to the buffer that
                                    contains the audio data
                                    for this sound bucket.        */
} SBucket;

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).

20 AEBadSoundBucket The sound bucket parameter does not point to a valid sound bucket.

EXAMPLE

The following example destroys the sound bucket sb and frees its allocated space.

Audio ∗ audio; /∗ audio connection ∗/

SBucket ∗ sb; /∗ sound bucket ∗/

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

/∗ destroy sound bucket ∗/

ADestroySBucket(audio, sb, &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

ADestroySBucket() was developed by HP.

Museum

Related Articles