Copyright ©1995 by NeXT Computer, Inc. All Rights Reserved.
Defined Types
NXSoundDeviceError |
DECLARED IN soundkit/NXSoundDevice.h |
![]() |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() } NXSoundDeviceError |
DESCRIPTION Error codes returned by Sound Kit methods that access the sound driver. |
NXSoundParameterTag (Sound Device Keys) |
DECLARED IN soundkit/NXSoundParameterTags.h |
![]() |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() } NXSoundParameterTag |
DESCRIPTION Sound parameter key tags that apply to NXSoundDevice objects. |
NXSoundParameterTag (Sound Device Values) |
DECLARED IN soundkit/NXSoundParameterTags.h |
![]() |
![]() ![]() ![]() ![]() } NXSoundParameterTag |
DESCRIPTION Sound parameter value tags that apply to NXSoundDevice objects. These are acceptable values for the NX_SoundDeviceAnalogInputSource parameter. |
NXSoundParameterTag (Sound Stream Keys) |
DECLARED IN soundkit/NXSoundParameterTags.h |
![]() |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() } NXSoundParameterTag |
DESCRIPTION Sound parameter key tags that apply to NXSoundStream objects. |
NXSoundParameterTag (Sound Stream Values) |
DECLARED IN soundkit/NXSoundParameterTags.h |
![]() |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() } NXSoundParameterTag |
DESCRIPTION Sound parameter value tags that apply to NXSoundStream objects. The first five are values for the NX_SoundStreamDataEncoding parameter; the next two are for the NX_SoundStreamSource parameter; the last two are for the NX_SoundStreamSink parameter. |
NXSoundStatus |
DECLARED IN soundkit/Sound.h |
![]() |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() } NXSoundStatus; |
DESCRIPTION These represent the activities of a Sound object, as returned by Sound's status method. |
SNDCompressionSubheader |
DECLARED IN sound/soundstruct.h |
![]() |
![]() ![]() ![]() ![]() } SNDCompressionSubheader; |
DESCRIPTION This structure describes the attributes of a compressed sound. It immediately follows the general SNDSoundStruct header. If the sound data isn't compressed, this subheader is absent. The structure's fields are |
originalSize | The size of the uncompressed data, in bytes | |
method | The compression format (see "Compression Formats," below) | |
numDropped | The number of dropped bits, if applicable | |
encodeLength | The number of samples represented by an encoded block |
SNDError |
DECLARED IN sound/sounderror.h |
![]() |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() } SNDError; |
DESCRIPTION These are the sound error codes returned by many sound functions. The SNDSoundError() function returns a pointer to a string that describes the error given one of these codes as an argument. |
SNDNotificationFun |
DECLARED IN sound/performsound.h |
![]() |
![]() ![]() ![]() |
DESCRIPTION This is the notification function required as an argument to methods such as SNDStartPlaying() and SNDStartRecording(). |
SNDSoundStruct |
DECLARED IN sound/performsound.h |
![]() |
![]() ![]() ![]() ![]() ![]() ![]() ![]() } SNDSoundStruct; |
DESCRIPTION This structure defines the header for sound data. It's thoroughly explained in the description of the SNDAlloc() function. |
snddriver_handlers |
DECLARED IN sound/sounddriver.h |
![]() |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() } snddriver_handlers_t; |
DESCRIPTION This structure is required as an argument by the snddriver_reply_handler() function. It declares, primarily, a series of call-back functions that are used by the sound driver to communicate with your program. |
sndreply_dsp_cond_true_t |
DECLARED IN sound/sounddriver.h |
![]() |
![]() ![]() ![]() ![]() |
DESCRIPTION Function type used by the sound driver's reply handler. |
sndreply_dsp_msg_t |
DECLARED IN sound/sounddriver.h |
![]() |
![]() ![]() ![]() |
DESCRIPTION Function type used by the sound driver's reply handler. |
sndreply_recorded_data_t |
DECLARED IN sound/sounddriver.h |
![]() |
![]() ![]() ![]() ![]() |
DESCRIPTION Function type used by the sound driver's reply handler. |
sndreply_tagged_t |
DECLARED IN sound/sounddriver.h |
![]() |
![]() ![]() |
DESCRIPTION Function type used by the sound driver's reply handler. |
Symbolic Constants
ATC Frame Size |
DECLARED IN sound/soundstruct.h |
![]() |
DESCRIPTION This constant represents the size of a single ATC (Audio Transform Compression) frame. |
Compression Formats |
DECLARED IN sound/soundstruct.h |
![]() |
SND_CFORMAT_BIT_FAITHFUL SND_CFORMAT_ATC |
DESCRIPTION These constants represent the three types of sound data compression. |
DSP Host Commands |
DECLARED IN sound/sounddriver.h |
![]() |
SNDDRIVER_DSP_HC_HOST_WD SNDDRIVER_DSP_HC_SYS_CALL |
DESCRIPTION These constants represent the DSP host commands that can be passed as an argument to snddriver_dsp_host_cmd(). |
DSP Protocol Options |
DECLARED IN sound/sounddriver.h |
![]() |
SNDDRIVER_DSP_PROTO_C_DMA SNDDRIVER_DSP_PROTO_S_DMA SNDDRIVER_DSP_PROTO_HFABORT SNDDRIVER_DSP_PROTO_DSPMSG SNDDRIVER_DSP_PROTO_RAW |
DESCRIPTION These constants represent the DSP protocols that can be passed as an argument to snddriver_dsp_protocol(). |
Executable File Segment Name |
DECLARED IN soundkit/Sound.h |
![]() |
DESCRIPTION This represents the segment of an executable file in which sounds are stored. |
Null Notification Function |
DECLARED IN sound/performsound.h |
![]() |
DESCRIPTION Used to pass a null SNDNotificationFun() function as an argument to functions such as SNDStartPlaying() and SNDStartRecording(). |
Sampling Rates |
DECLARED IN sound/soundstruct.h |
![]() |
SND_RATE_CODEC | 8012.8210513 Hz | |
SND_RATE_LOW | 22050.0 Hz | |
SND_RATE_HIGH | 44100.0 Hz |
DESCRIPTION These constants represent the three sampling rates that are directly supported by the sound software and hardware. |
Sound Device Access Codes |
DECLARED IN sound/accesssound.h |
![]() |
SND_ACCESS_IN | Sound-in | |
SND_ACCESS_DSP | DSP | |
SND_ACCESS_OUT | Sound-out |
DESCRIPTION Used by the sound device access methods, such as SNDAcquire() and SNDReserve(), to represent specific devices. |
Sound Device Timeout Limit |
DECLARED IN soundkit/NXSoundDevice.h |
![]() |
DESCRIPTION The default timeout limit for communication with the sound driver. The value is, essentially, infinity. You can reset the timeout limit through NXSoundDriver's setTimeout: method. |
Sound Device Error Code Limits |
DECLARED IN soundkit/NXSoundDevice.h |
![]() |
NX_SOUNDDEVICE_ERROR_MAX |
DESCRIPTION The minimum and maximum NXSoundDeviceError values. |
Sound Parameter Tag Bases |
DECLARED IN soundkit/NXSoundParameterTags.h |
![]() |
NX_SoundDeviceParameterValueBase NX_SoundStreamParameterKeyBase NX_SoundStreamParameterValueBase NX_SoundParameterTagMax |
DESCRIPTION Lowest tag values for the four sets of parameter tags. The parameter tag values start at 0; NX_SoundParmaeterTagMax is the highest parameter tag value reserved by the Sound Kit. |
Sound Stream Control Codes |
DECLARED IN sound/sounddriver.h |
![]() |
SNDDRIVER_ABORT_STREAM SNDDRIVER_PAUSE_STREAM SNDDRIVER_RESUME_STREAM |
DESCRIPTION These constants represent the controlling operations that are specified as an argument to snddriver_stream_control(). |
Sound Stream Null Time |
DECLARED IN soundkit/NXSoundStream.h |
![]() |
DESCRIPTION Provides a timeval value (as defined in sys/time.h) that indicates the present time. |
Sound Stream Path Codes |
DECLARED IN sound/sounddriver.h |
![]() |
SNDDRIVER_STREAM_TO_SNDOUT_22 SNDDRIVER_STREAM_TO_SNDOUT_44 SNDDRIVER_STREAM_FROM_DSP SNDDRIVER_STREAM_TO_DSP SNDDRIVER_STREAM_DSP_TO_SNDOUT_22 SNDDRIVER_STREAM_DSP_TO_SNDOUT_44 SNDDRIVER_STREAM_THROUGH_DSP_TO_SNDOUT_22 SNDDRIVER_STREAM_THROUGH_DSP_TO_SNDOUT_44 SNDDRIVER_DMA_STREAM_TO_DSP SNDDRIVER_DMA_STREAM_FROM_DSP SNDDRIVER_DMA_STREAM_THROUGH_DSP_TO_SNDOUT_22 SNDDRIVER_DMA_STREAM_THROUGH_DSP_TO_SNDOUT_44 |
DESCRIPTION These constants represent the sound stream paths that can be specified as an argument to the snddriver_stream_setup() function. |
Sound Structure Formats |
DECLARED IN sound/soundstruct.h |
![]() |
SND_FORMAT_MULAW_8 SND_FORMAT_LINEAR_8 SND_FORMAT_LINEAR_16 SND_FORMAT_LINEAR_24 SND_FORMAT_LINEAR_32 SND_FORMAT_FLOAT SND_FORMAT_DOUBLE SND_FORMAT_INDIRECT SND_FORMAT_DSP_CORE SND_FORMAT_DSP_DATA_8 SND_FORMAT_DSP_DATA_16 SND_FORMAT_DSP_DATA_24 SND_FORMAT_DSP_DATA_32 SND_FORMAT_DISPLAY SND_FORMAT_MULAW_SQUELCH SND_FORMAT_EMPHASIZED SND_FORMAT_COMPRESSED SND_FORMAT_COMPRESSED_EMPHASIZED SND_FORMAT_DSP_COMMANDS |
DESCRIPTION These constants represent the various sound formats in which sound data can be stored. Note that not all formats are playable without conversion. |
Sound Structure Magic Number |
DECLARED IN sound/soundstruct.h |
![]() |
DESCRIPTION This constant is used to identify a sound structure. It's the value of the magic field of all valid SNDSoundStruct structures. |
SoundView Display Modes |
DECLARED IN soundkit/SoundView.h |
![]() |
NX_SOUNDVIEW_WAVE |
DESCRIPTION These constants represent the two display modes offered by the SoundView class. See the SoundView class specification for details. |
Global Variables
NXSoundPboardType |
DECLARED IN soundkit/Sound.h |
![]() |
DESCRIPTION This is the sound pasteboard type. |