APutSBucketData(3X)

NAME

APutSBucketData − copy audio data from buffer to sound bucket

SYNOPSIS

unsigned long
APutSBucketData (

Audio ∗ audio,

SBucket ∗ sb,

unsigned long start_offset,

char ∗ buffer,

unsigned long length,

long ∗ status_return);

DESCRIPTION

APutSBucketData() copies the data from a buffer to a sound bucket.

audio specifies the Audio structure associated with this connection.

sb specifies the sound bucket to receive the data.

start_offset specifies where to start writing the copied data, given as the byte offset from the beginning of the sound bucket.

buffer specifies the buffer containing the data to copy.

length specifies the length of the data in the buffer, in bytes.

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

RETURN VALUE

Upon successful completion, APutSBucketData() 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 from the buffer buff to the sound bucket sb and returns the number of bytes that were copied. The data is placed starting at the beginning of the sound bucket (offset 0). In this example, we assume that we are returning data from the buffer at bufp that was written there by AGetSBucketData(). We use the datalen_g value returned by AGetSBucketData() as the length of the data.

unsigned long datalen_p; /∗ copied data length ∗/

Audio ∗ audio; /∗ audio connection ∗/

SBucket ∗ sb; /∗ sound bucket∗/

unsigned long startoff; /∗ start offset ∗/

char ∗ bufp; /∗ ptr to buffer ∗/

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

/∗ copy data from buffer to sb ∗/

startoff = 0;

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

APutSBucketData() was developed by HP.

Museum

Related Articles