Package nas-devel

Development and doc files for the NAS

http://radscan.com/nas.html

Development files and the documentation for Network Audio System.

Library Functions (Section 3)
AuAnyEvent.3x
AuAnyEvent is a generic event structure containing members common to all event types.
AuBucketAttributes.3x
The AuBucketAttributes structure describes the server-local storage of audio data.
AuCloseServer.3x
AuCloseServer closes the connection to the audio server. If the client's close-down-mode is AuCloseDownDestroy, all resources associated with the client will be...
AuConvertDataToShort.3x
AuConvertDataToShort converts num_bytes of data from format to signed short integer, returning 0 if successful, or -1 if format isn't valid.
AuConvertShortToData.3x
AuConvertShortToData converts num_bytes of data from signed short integer to format, returning 0 if successful, or -1 if format isn't valid.
AuCreateBucket.3x
AuCreateBucket creates a bucket with the specified attributes, and returns the bucket ID, or AuNone if there was an error. The initial contents of the bucket...
AuCreateFlow.3x
AuCreateFlow creates a flow and returns the flow ID, or AuNone if there was an error.
AuDataFormats.3x
AuDataFormats - audio data formats.
AuDataTypes.3x
AuDataTypes - data types
AuDefineToFormat.3x
AuDefineToFormat returns the format specified by define or -1 if define isnt valid.
AuDestroyBucket.3x
AuDestroyBucket destroys the specified bucket, releasing the resources used by the bucket. If the bucket is currently in use, the resources will not be released...
AuDestroyFlow.3x
AuDestroyFlow destroys the specified flow, releasing the resources used by the flow. The flow is destroyed immediately.
AuDeviceAttributes.3x
The AuDeviceAttributes structure describes the physical hardware interface.
AuDispatchEvent.3x
AuDispatchEvent sends event to the registered event handlers and returns AuTrue if any of the event handlers returned AuTrue.
AuElement.3x
Elements are instructions to the server on how to handle the audio data in a flow.
AuElementNotifyEvent.3x
ElementNotify events are sent to client applications to notify them of a watermark condition or state change. If kind is AuElementNotifyKindLowWater, the...
AuElementParameters.3x
The AuElementParameters structure is used to access those element parameters that can be changed dynamically.
AuElementState.3x
The AuElementState structure is used to access the state of elements in a flow. Only flows and component elements (ExportBucket, ExportClient, ExportDevice...
AuErrorEvent.3x
Error events are sent to clients to alert them of non-fatal errors encountered while processing requests.
AuEvent.3x
Events are the principal mechanism for the server to communicate with a client application.
AuEventsQueued.3x
Not implemented.
AuFileFormats.3x
AuFileFormats - audio file formats.
AuFixedPointFractionalAddend.3x
AuFixedPointFractionalAddend returns the integer portion of fp. AuFixedPointFractionalAddend is implemented as a macro.
AuFixedPointFromFraction.3x
AuFixedPointFromFraction constructs a fixed point value by dividing nnn by ddd. AuFixedPointFromFraction is implemented as a macro.
AuFixedPointFromSum.3x
AuFixedPointFromSum constructs a fixed point from the two arguments. AuFixedPointFromSum is implemented as a macro.
AuFixedPointIntegralAddend.3x
AuFixedPointIntegralAddend returns the integral portion of the fixed point value. AuFixedPointIntegralAddend is implemented as a macro.
AuFixedPointRoundDown.3x
AuFixedPointRoundDown returns the rounded down integer portion of fp. AuFixedPointRoundDown is implemented as a macro.
AuFixedPointRoundUp.3x
AuFixedPointRoundUp returns the rounded up integral portion of fp. AuFixedPointRoundUp is implemented as a macro.
AuFlush.3x
AuFlush flushes the output buffer. Not necessary when calling any of the audiolib routines.
AuFormatToDefine.3x
AuFormatToDefine returns the C-preprocessor define for format or "unknown" if format isn't valid.
AuFormatToString.3x
AuFormatToString returns the name of format or "Unknown" if format is not recognized.
AuFreeBucketAttributes.3x
AuFreeBucketAttributes frees the memory allocated by AuGetBucketAttributes or AuListBuckets. audiolib - Network Audio System C Language Interface
AuFreeDeviceAttributes.3x
AuFreeDeviceAttributes frees the memory allocated by AuGetDeviceAttributes or AuListDevices. audiolib - Network Audio System C Language Interface
AuFreeElements.3x
AuFreeElements frees the memory allocated by AuGetElements. audiolib - Network Audio System C Language Interface
AuFreeElementStates.3x
AuFreeElements frees the memory allocated by AuGetElementStates. audiolib - Network Audio System C Language Interface
AuGetBucketAttributes.3x
AuGetBucketAttributes returns the current attributes for the specified bucket, or NULL if there was an error. Use AuFreeBucketAttributes to free this structure...
AuGetCloseDownMode.3x
AuGetCloseDownMode returns the value of the client's close down mode.
AuGetDeviceAttributes.3x
AuGetDeviceAttributes returns the current attributes for the specified device, or NULL if there was an error. Use AuFreeDeviceAttributes to free this structure...
AuGetElementParameters.3x
Not implemented.
AuGetElements.3x
AuGetElements returns the list of elements comprising flow or NULL, with num_elements set to 0, if there was an error. Use AuFreeElements to free this list when...
AuGetElementStates.3x
AuGetElementStates returns a list of element states, or NULL, with num_states set to 0, if there was an error. Use AuFreeElementStates to free this list when...
AuGetErrorDatabaseText.3x
The AuGetErrorDatabaseText function copies the default_string and returns it in buffer_return. The name and message arguments are ignored.
AuGetErrorText.3x
AuGetErrorText copies a NUL-terminated string describing code into buffer_return.
AuGetScratchFlow.3x
AuGetScratchFlow gets one of the pre-allocated flow ID's if availible or creates a new flow if not and returns the flow ID or AuNone if there was an error.
AuGetScratchFlowFromBucket.3x
AuGetScratchFlowFromBucket uses a scratch flow to create an import from bucket and returns the flow ID or AuNone if there was an error.
AuGetScratchFlowToBucket.3x
AuGetScratchFlowToBucket uses a scratch flow to create an export to bucket.
AuGetServerTime.3x
AuGetServerTime returns the current time from the audio server. audiolib - Network Audio System C Language Interface
AuGrabNotifyEvent.3x
GrabNotify events are sent to client applications to notify them that a component has been grabbed or released.
AuHandleEvents.3x
AuHandleEvents dispatches events to the event handlers.
AuIDOfEvent.3x
AuIDOfEvent returns the ID of the source of the event. audiolib - Network Audio System C Language Interface
AuInputTrack.3x
AuInputTrack is used by bundle elements to define what tracks from what elements to access. Use AuMakeInputTrack to initialize an AuInputTrack structure...
AuKillClient.3x
AuKillClient forces a close-down of the client that created resource. If the client has already terminated in either AuCloseDownRetainPermanent or...
AuListBuckets.3x
AuListBuckets returns a list of buckets whose attributes match those values in attributes specified by valuemask, or NULL, with nbuckets set to 0, if there was...
AuListDevices.3x
AuListDevices returns a list of devices whose attributes match those values in attributes specified by valuemask, or NULL, with ndevices set to 0, if there was...
AuLookupEventHandler.3x
AuLookupEventHandler searches the list of registered event handlers starting with startwith, and returns the next event handler or NULL if there isnt one.
AuMakeChangeStateAction.3x
AuMakeChangeStateAction sets the action field of action to AuElementActionChangeState and initializes the other fields with the remaining arguments...
AuMakeElementAddConstant.3x
AuMakeElementAddConstant sets the type member of element to AuElementTypeAddConstant and initializes the addconstant member of element with the remaining...
AuMakeElementBundle.3x
AuMakeElementBundle sets the type member of element to AuElementTypeBundle and initializes the bundle member of element with the remaining arguments...
AuMakeElementExportBucket.3x
AuMakeElementExportBucket sets the type member of element to AuElementTypeExportBucket and initializes the exportbucket member of element with the remaining...
AuMakeElementExportClient.3x
AuMakeElementExportClient sets the type member of element to AuElementTypeExportClient and initializes the exportclient member of element with the remaining...
AuMakeElementExportDevice.3x
AuMakeElementExportDevice sets the type member of element to AuElementTypeExportDevice and initializes the exportdevice member of element with the remaining...
AuMakeElementExportMonitor.3x
AuMakeElementExportMonitor sets the type member of element to AuElementTypeExportMonitor and initializes the exportmonitor member of element with the remaining...
AuMakeElementImportBucket.3x
AuMakeElementImportBucket sets the type member of element to AuElementTypeImportBucket and initializes the importbucket member of element with the remaining...
AuMakeElementImportClient.3x
AuMakeElementImportClient sets the type of element to AuElementTypeImportClient and initializes the importclient member of element with the remaining arguments...
AuMakeElementImportDevice.3x
AuMakeElementImportDevice sets the type member of element to AuElementTypeImportDevice and initializes the importdevice member of element with the remaining...
AuMakeElementImportWaveForm.3x
AuMakeElementImportWaveForm sets the type member of element to AuElementTypeImportWaveForm and initializes the importwaveform member of element with the...
AuMakeElementMultiplyConstant.3x
AuMakeElementMultiplyConstant sets the type of element to AuElementTypeMultiplyConstant and initializes the multiplyconstant member of element with the...
AuMakeElementState.3x
AuMakeElementState initializes an AuElementState structure for use in a subsequent call to AuGetElementStates or AuSetElementStates. AuMakeElementState is...
AuMakeElementSum.3x
AuMakeElementSum sets the type member of element to AuElementTypeSum and initializes the sum member of element with the remaining arguments. AuMakeElementSum is...
AuMakeInputTrack.3x
AuMakeInputTrack is used to initialize an AuInputTrack structure. AuMakeImportTrack is implemented as a macro. audiolib - Network Audio System C Language...
AuMakeNoopAction.3x
AuMakeNoopAction sets the action field of action to AuElementActionNoop and initializes the other fields with the remaining arguments. AuMakeNoopAction is...
AuMakeSendNotifyAction.3x
AuMakeSendNotifyAction sets the action field of action to AuElementActionSendNotify and initializes the other fields with the remaining arguments...
AuMonitorDevice.3x
AuMonitorDevice
AuMonitorNotifyEvent.3x
MonitorNotify events will be sent to clients with flows containing ExportMonitor elements.
AuNextEvent.3x
AuNextEvent copies the next availible event into event. If dequeue is AuTrue the event is removed from the queue. If the event queue is empty, AuNextEvent...
AuOpenServer.3x
AuOpenServer creates a connection to the specified audio server and returns a pointer to an AuServer structure or NULL, with return_status (if non-NULL)...
AuPauseFlow.3x
AuPauseFlow pauses flow. All of the elements in flow will have their state set to AuStatePause.
AuReadElement.3x
AuReadElement transfers audio data from the server to the client application, reading num_bytes from the ExportClient specified by element in audio flow flow...
AuRegisterEventHandler.3x
AuRegisterEventHandler registers an event handler for future use by AuDispatchEvent.
AuReleaseScratchFlow.3x
AuReleaseScratchFlow releases flow. If flow is not one of the pre-allocated flows, it will be destroyed.
AuRequeueEvent.3x
AuRequeueEvent puts the specified event on the event queue. The event can be placed at any position in the queue, skip determines how from the front of the...
AuScanEvents.3x
AuScanEvents scans the event queue looking for the first event that satisfies the caller-supplied predicate. If mode is AuEventsQueuedAlready, AuScanEvents only...
AuScanForTypedEvent.3x
AuScanForTypedEvent scans the event queue looking for the first event that matches type. If mode is AuEventsQueuedAlready, AuScanForTypedEvent only checks for...
AuServer.3x
The AuServer structure describes the connection to the audio server.
AuServerName.3x
AuServerName returns the name of the server to use or an empty string if it can not determine the proper value. If string isn't NULL or a pointer to NUL...
AuSetBucketAttributes.3x
AuSetBucketAttributes sets the attributes of bucket using only those values in attributes specified by valuemask.
AuSetCloseDownMode.3x
AuSetCloseDownMode sets the close-down-mode for client to mode. The close-down-mode determines what happens to the resources created by client when the...
AuSetDeviceAttributes.3x
AuSetDeviceAttributes sets the attributes of device using only those values in attributes specified by valuemask. Attempting to change attributes not marked as...
AuSetElementParameters.3x
AuSetElementParameters changes those element parameters that can be changed dynamically. Changes in element types is not allowed. There isn't any way to specify...
AuSetElements.3x
AuSetElements is used to set the elements in flow.
AuSetElementStates.3x
AuSetElementStates changes the states of those elements in those flows specified in states.
AuSetErrorHandler.3x
AuSetErrorHandler sets the non-fatal error handler and returns the previous handler. This error handler will be invoked whenever a non-fatal error (error event)...
AuSetIOErrorHandler.3x
AuSetIOErrorHandler sets the fatal I/O error handler and returns the previous error handler. The error handler will be invoked if a system call error occurs...
AuSetString.3x
AuSetString initializes an AuString structure.
AuSoundCreateBucketFromData.3x
AuSoundCreateBucketFromData creates a bucket, initializing the contents with the audio data from data, and returns the bucket ID or AuNone if there was error.
AuSoundCreateBucketFromFile.3x
AuSoundCreateBucketFromFile creates a bucket, initializing the contents with the audio data from filename, and returns the bucket ID or AuNone if there was...
AuSoundCreateDataFromBucket.3x
AuSoundCreateDataFromBucket reads the audio data from bucket and returns a pointer to data or NULL if there was an error.
AuSoundCreateFileFromBucket.3x
AuSoundCreateFileFromBucket creates a file using the audio data from bucket and returns AuTrue if successfull or AuFalse if there was an error.
AuSoundPlay.3x
AuSoundPlay creates a flow to play audio from any source on device and returns a pointer to the event handler created or NULL if there was an error. The...
AuSoundPlayFromBucket.3x
AuSoundPlayFromBucket creates a flow to play bucket on device and returns a pointer to the event handler created or NULL if there was an error.
AuSoundPlayFromData.3x
AuSoundPlayFromData creates a flow to play data on device and returns a pointer to the event handler created or NULL if there was an error.
AuSoundPlayFromFile.3x
AuSoundPlayFromFile creates a flow to play filename on device and returns a pointer to the event handler created or NULL if there was an error.
AuSoundPlaySynchronousFromFile.3x
AuSoundPlaySynchronousFromFile plays filename and returns AuTrue when done or AuFalse if there was an error.
AuSoundRecord.3x
AuSoundRecord creates a flow to record audio from source to any destination and returns a pointer to the event handler created or NULL if there was an error...
AuSoundRecordToBucket.3x
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.
AuSoundRecordToData.3x
AuSoundRecordToData creates a flow to record from source to data and returns the event handler created or NULL if there was an error.
AuSoundRecordToFile.3x
AuSoundRecordToFile creates a flow to record from source to filename and returns a pointer to the event handler created or NULL if there was an error.
AuSoundRecordToFileN.3x
AuSoundRecordToFileN creates a flow to record from source into filename and returns a pointer to the event handler created or NULL if there was an error.
AuStartFlow.3x
AuStartFlow starts flow. All of the elements in flow will have their state set to AuStateStart.
AuStopFlow.3x
AuStopFlow stops flow. All of the elements in flow will their state set to AuStateStop.
AuStringToFormat.3x
AuStringToFormat returns the numeric value of the audio data format described by string or -1 if string is not recognized.
AuStringToWaveForm.3x
AuStringToWaveForm returns the numeric value of string or -1 if it isn't recognized.
AuSync.3x
AySync flushes the output buffer, then waits until all pending requests have been received and processed by the server. If discard is AuTrue, all events on the...
AuSynchronize.3x
Not implemented. audiolib - Network Audio System C Language Interface
AuUnregisterEventHandler.3x
AuUnregisterEventHandler removes handler for use by AuDispatchEvent.
AuWaveFormToString.3x
AuWaveFormToString returns a string description of waveform or "unknown" if it isnt recognized.
AuWriteElement.3x
AuWriteElement transfers audio data from the client application to the server, writing num_bytes from data to the ImportClient specified by element in the audio...
Sound.3x
The SoundRec structure describes an audio file.
SoundAbbrevToFileFormat.3x
SoundAbbrevToFileFormat returns the file format named by string or -1 if string is not recognized.
SoundCloseFile.3x
SoundCloseFile closes the audio file described by sound and returns 0 if successfull or -1 if there was an error. Any unwritten data is written and the storage...
SoundCreate.3x
SoundCreate creates a SoundRec structure, initializes it with the specified values and returns a Sound (a pointer to the SoundRec structure) or NULL if there...
SoundFlushFile.3x
SoundFlushFile flushes an audio file.
SoundOpenFileForReading.3x
SoundOpenFileForReading opens filename for reading and returns a Sound, a pointer to the SoundRec structure describing the file or NULL if there was an error.
SoundOpenFileForWriting.3x
SoundOpenFileForWriting opens filename for writing and returns sound or NULL if there was an error.
SoundReadFile.3x
SoundReadFile reads num_bytes into buffer from the audio file described by sound.
SoundRewindFile.3x
SoundRewindFile resets the position of read/write of the audio file to the beginning.
SoundSeekFile.3x
SoundSeekFile sets the position of the next read to a specific offset. It can only be used on files open for reading.
SoundStringToFileFormat.3x
SoundStringToFileFormat returns the file format named by string or -1 if string is not recognized.
SoundTellFile.3x
SoundTellFile returns the offset (in bytes) of the next byte to be read, relative to the beginning of the audio. It can only be used on files open for reading.
SoundWriteFile.3x
SoundWriteFile writes num_bytes from buffer to the audio file described by sound and returns the number of bytes written.