AuSoundRecordToBucket (3)

Leading comments

$NCDId: @(#)AuSRecTB.man,v 1.2 1995/05/23 23:53:05 greg Exp $
copyright 1994 Steven King

portions are
* Copyright 1993 Network Computing Devices, Inc.
*
* Permission to use, copy, modify, distribute, and sell this software and its
* documentation for any purpose is hereby granted without fee, provided that
* the above copyright notice appear in all copies and that both that
* copyright notice and this permission notice appear in supporting
* documentation, and that the name Network Computing...

(The comments found at the beginning of the groff file "man3/AuSoundRecordToBucket.3nas".)

Name

AuSoundRecordToBucket - create a flow to record to a bucket.

Synopsis

#include <audio/audiolib.h>
#include <audio/soundlib.h>

AuEventHandlerRec *AuSoundRecordToBucket(server, destination, source, gain, callback, callback_data, mode, flow, volume_mult_elem, status)

    AuServer *server;

    AuBucketID destination;

    AuDeviceID source;

    AuFixedPoint gain;

    void (*callback) (AuServer *, AuEventHandlerRec *, AuEvent *, AuPointer);

    AuPointer callback_data;

    int mode;

    AuFlowID *flow; /* RETURN */

    int *volume_mult_elem; /* RETURN */

    AuStatus *status; /* RETURN */

Arguments

server

Specifies the connection to the audio server.

destination

Specifies the bucket to record to.

source

Specifies the input device to record from.

gain

Specifies the gain for the input device.

callback

Specifies the procedure to be called for additional event processing.

callback_data

Specifies any additional arguments to be passed to the callback.

mode

Specifies the line mode for the input device. Currently the following line modes are defined: AuDeviceInputModeNone, AuDeviceInputModeLineIn, AuDeviceInputModeMicrophone.

flow

If non-NULL, returns the flow ID.

volume_mult_elem

According to the comment in the source, not implemented.

status

If non-NULL, flush the output buffer and return the status from the server.

Description

AuSoundRecordToBucket creates a flow to record from source into destination and returns a pointer to the event handler created or NULL if there was an error.

Errors

AuBadBucket, AuBadDevice.

See Also

AuSoundRecord, AuSoundRecordToData, AuSoundRecordToFile, AuSoundRecordToFileN.

audiolib - Network Audio System C Language Interface