Sound (3)

Leading comments

$NCDId: @(#)Sound.man,v 1.2 1995/05/23 23:53:14 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 De...

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

Name

Sound - audio file description.

Structures

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

typedef struct
{

    . . .
}SoundRec, *Sound;

Members

Do not dereference the members of the SoundRec structure directly. Instead use the access macros.

sound is a Sound, a pointer to a SoundRec structure.

SoundFileFormat(sound)

Accesses the int value giving the format of the sound file.

SoundFileFormatString(sound)

Accesses the string description of the format of the sound file.

SoundDataFormat(sound)

Accesses the int value giving the data format of the sound file.

SoundDataFormatString(sound)

Accesses the string description of the data format of the sound file.

SoundNumTracks(sound)

Accesses the int value giving the number of tracks in the audio data in the sound file.

SoundSampleRate(sound)

Accesses the int value giving the samples rate of the audio data in the sound file.

SoundNumSamples(sound)

Accesses the int value giving the total number of samples.

SoundComment(sound)

Accesses the string comment.

SoundBytesPerSample(sound)

Returns the bytes per sample of audio data.

SoundNumBytes(sound)

Returns the total number of bytes of audio data in the sound file.

SoundValidateDataFormat(sound)

Returns true if the sound file format is a valid format.

Description

The SoundRec structure describes an audio file.

See Also

SoundCloseFile, SoundCreate, SoundFlushFile, SoundOpenFileForReading, SoundOpenFileWriting, SoundReadFile, SoundRewindFile, SoundSeekFile, SoundTellFile, SoundWriteFile.

audiolib - Network Audio System C Language Interface