carb/audio/AudioTypes.h

↰ Parent directory: carb/audio/

Data types used by the audio interfaces.

Source: carb/audio/AudioTypes.h

Included By

• carb/audio/AudioUtils.h: Inline utility functions for audio processing.

• carb/audio/IAudioData.h: The audio data management interface.

• carb/audio/IAudioPlayback.h: The audio playback interface.

• carb/audio/IAudioUtils.h: General audio utilities.

• carb/audio/IAudioCapture.h: The audio capture interface.

• carb/audio/IAudioDevice.h: The audio device enumeration interface.

• carb/audio/IAudioGroup.h: The audio group interface.

Namespaces

• carb: The main Carbonite namespace.

• carb::audio: Audio playback and capture.

Classes

• carb::audio::Context: represents a single audio context object.

• carb::audio::DeviceCaps: contains information about a single audio input or output device.

• carb::audio::SoundFormat: provides information about the format of a sound.

• carb::audio::UserData: an opaque user data object that can be attached to some objects (ie: sound data objects, sound groups, etc).

• carb::audio::Voice: represents a single instance of a playing sound.

Enums

• carb::audio::AudioResult: possible return values from various audio APIs.

• carb::audio::SampleFormat: the data type for a single sample of raw audio data.

• carb::audio::Speaker: speaker names.

• carb::audio::UnitType: description of how a size or offset value is defined.

Functions

• carb::audio::makeSpeakerFlag: a conversion function from a Speaker enum to bitflags.

• carb::audio::makeSpeakerFlag: a conversion function from a Speaker enum to bitflags.

Typedefs

• carb::audio::DeviceFlags: flags to indicate the current state of a device in the system.

• carb::audio::SpeakerMode: the base type for a set of speaker flag masks.

• carb::audio::UserDataDestructor: prototype for the optional destructor function for a user data object.

Variables

• carb::audio::fDeviceFlagConnected: the device is currently connected to the system.

• carb::audio::fDeviceFlagDefault: the device is the system default or preferred device.

• carb::audio::fDeviceFlagNotOpen: flags to indicate the current state of a device.

• carb::audio::fDeviceFlagStreamer: a streamer is being used as an output.

• carb::audio::fSpeakerFlagBackCenter: Back center speaker. Usually located at 180 degrees.

• carb::audio::fSpeakerFlagBackLeft: Back left speaker. Usually located at -135 degrees.

• carb::audio::fSpeakerFlagBackRight: Back right speaker. Usually located at 135 degrees.

• carb::audio::fSpeakerFlagFrontCenter: Front center speaker. Usually located at 0 degrees.

• carb::audio::fSpeakerFlagFrontLeft: Speaker bitflags that can be used to create speaker modes.

• carb::audio::fSpeakerFlagFrontLeftWide: Front left wide speaker. Usually located at -60 degrees.

• carb::audio::fSpeakerFlagFrontRight: Front right speaker. Usually located at 45 degrees. Also used for right headphone.

• carb::audio::fSpeakerFlagFrontRightWide: Front left wide speaker. Usually located at 60 degrees.

• carb::audio::fSpeakerFlagLowFrequencyEffect: Low frequency effect speaker (subwoofer). Usually treated as if it is located at the listener.

• carb::audio::fSpeakerFlagSideLeft: Side left speaker. Usually located at -90 degrees.

• carb::audio::fSpeakerFlagSideRight: Side right speaker. Usually located at 90 degrees.

• carb::audio::fSpeakerFlagTopBackLeft: Top back left speaker. Usually located at -135 degrees and raised vertically.

• carb::audio::fSpeakerFlagTopBackRight: Top back right speaker. Usually located at 135 degrees and raised vertically.

• carb::audio::fSpeakerFlagTopFrontLeft: Top front left speaker. Usually located at -45 degrees and raised vertically.

• carb::audio::fSpeakerFlagTopFrontRight: Top front right speaker. Usually located at 45 degrees and raised vertically.

• carb::audio::fSpeakerFlagTopLeft: Top left speaker. Usually located at -90 degrees and raised vertically.

• carb::audio::fSpeakerFlagTopRight: Top right speaker. Usually located at 90 degrees and raised vertically.

• carb::audio::fSpeakerModeValidBits: All valid speaker mode bits.

• carb::audio::kDefaultChannelCount: default channel count.

• carb::audio::kDefaultFormat: default sample format.

• carb::audio::kDefaultFrameRate: various default values for the audio system.

• carb::audio::kInvalidDeviceIndex: special value for DeviceCaps::index to indicate that a real audio device is not currently selected for output.

• carb::audio::kInvalidSpeakerName: the special name for an invalid speaker.

• carb::audio::kMaxChannels: maximum number of channels supported for output.

• carb::audio::kMaxFrameRate: maximum frame rate of audio that can be processed.

• carb::audio::kMaxNameLength: various limits values for the audio system.

• carb::audio::kMinChannels: minimum number of channels supported for capture or output.

• carb::audio::kMinFrameRate: minimum frame rate of audio that can be processed.

• carb::audio::kSpeakerModeCount: the total number of ‘standard’ speaker modes represented here.

• carb::audio::kSpeakerModeDefault: common speaker layout modes.

• carb::audio::kSpeakerModeFivePointOne: a six speaker mode.

• carb::audio::kSpeakerModeFivePointZero: carb::audio::kSpeakerModeFivePointOne without the low frequency effect speaker.

• carb::audio::kSpeakerModeFourPointOne: a five speaker mode.

• carb::audio::kSpeakerModeMono: a mono speaker mode.

• carb::audio::kSpeakerModeNinePointOne: a ten speaker mode.

• carb::audio::kSpeakerModeNinePointOnePointFour: a fourteen speaker mode.

• carb::audio::kSpeakerModeNinePointOnePointSix: a sixteen speaker mode.

• carb::audio::kSpeakerModeQuad: a four speaker mode.

• carb::audio::kSpeakerModeSevenPointOne: an eight speaker mode.

• carb::audio::kSpeakerModeSevenPointOnePointFour: a twelve speaker mode.

• carb::audio::kSpeakerModeSixPointOne: a seven speaker mode.

• carb::audio::kSpeakerModeStereo: a stereo speaker mode.

• carb::audio::kSpeakerModeThreePointZero: A linear surround setup.

• carb::audio::kSpeakerModeTwoPointOne: A three speaker mode.