AGetSBucketData(3X)

NAME

AGetSBucketData − copy audio data in sound bucket to buffer; return number of bytes

SYNOPSIS

unsigned long
AGetSBucketData (

Audio ∗ audio,

SBucket ∗ sb,

unsigned long start_offset,

char ∗ buffer,

unsigned long buf_len,

long ∗ status_return);

DESCRIPTION

AGetSBucketData() copies the audio data in the specified sound bucket to the specified buffer and returns the number of bytes copied.

audio specifies the Audio structure associated with this connection.

sb specifies the sound bucket containing the data to be copied.

start_offset specifies the starting point of the copy, given as the byte offset from the beginning of the data.

buffer specifies the buffer to receive the copied data.

buf_len specifies the maximum length of the buffer, in bytes.

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

This call is used only when the application needs to manipulate the sound bucket data directly.

RETURN VALUE

Upon successful completion, AGetSBucket() returns the byte count of the copied data.

ERRORS

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

0 AENoError

2 AEBadAudio

20 AEBadSoundBucket

EXAMPLES

The following example copies the audio data contained in sb to the buffer at bufp and returns the number of bytes that were copied. In this example, we allocate 80000 bytes for the buffer, and pass this size value in buflen.

unsigned long datalen_g; /∗ copied get_data length ∗/

Audio ∗ audio; /∗ audio connection ∗/

SBucket ∗ sb; /∗ sound bucket∗/

unsigned long startoff; /∗ start offset ∗/

char ∗ bufp; /∗ ptr to buffer ∗/

unsigned long buflen; /∗ length of buffer ∗/

long status; /∗ error status ∗/

.
.
.

/∗ copy sound bucket data to buffer ∗/

startoff = 0;

bufp = malloc(80000);

buflen = 80000;

datalen_g = AGetSBucketData(audio, sb, startoff, bufp, buflen, &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

AGetSBucketData() was developed by HP.

Museum

Related Articles