carb/audio/IAudioPlayback.h¶
↰ Parent directory: carb/audio/
The audio playback interface.
Source: carb/audio/IAudioPlayback.h
Included By¶
carb/audio/AudioUtils.h: Inline utility functions for audio processing.
carb/audio/AudioStreamerUtils.h: Helper classes for streaming data from carb::audio::IAudioPlayback.
carb/audio/IAudioGroup.h: The audio group interface.
Namespaces¶
carb: The main Carbonite namespace.
carb::audio: Audio playback and capture.
Classes¶
carb::audio::ContextCaps: the capabilities of the context object.
carb::audio::ContextParams: context parameters block.
carb::audio::ContextParams2: Extended context parameters descriptor object.
carb::audio::DspValuePair: specifies a pair of values that define a DSP value range to be interpolated between based on an emitter-listener angle that is between a cone’s inner and outer angles.
carb::audio::EmitterAttributes: spatial attributes of an emitter entity.
carb::audio::EntityAttributes: base spatial attributes of the entity.
carb::audio::EntityCone: defines a sound cone relative to an entity’s front vector.
carb::audio::IAudioPlayback: Low-Level Audio Playback Plugin Interface.
carb::audio::ListenerAttributes: spatial attributes for a listener entity.
carb::audio::LoopPointDesc: descriptor of a loop point to set on a voice.
carb::audio::OutputDesc: descriptor of the audio output target to use for an audio context.
carb::audio::PlaybackContextDesc: descriptor used to indicate the options passed to the createContext() function.
carb::audio::PlaySoundDesc: descriptor of how to play a single sound.
carb::audio::PlaySoundDesc2: Extended descriptor to allow for further control over how a new voice plays its sound.
carb::audio::RolloffCurve: defines the point-wise curve that is used for specifying custom rolloff curves.
carb::audio::RolloffDesc: descriptor of the rolloff mode, range, and curves to use for an emitter.
carb::audio::SpeakerDirection: specifies the relative direction to a single speaker.
carb::audio::SpeakerDirectionDesc: a descriptor of the direction from the [real biological] user to all speakers in the user’s sound setup.
carb::audio::Streamer: interface for a streamer object.
carb::audio::VoiceParams: voice parameters block.
Enums¶
carb::audio::ContextCallbackEvent: names for events that get passed to a context callback function.
carb::audio::RolloffType: distance based DSP value rolloff curve types.
carb::audio::StreamState: names for the state of a stream used in the carb::audio::Streamer object.
carb::audio::VoiceCallbackType: voice callback reason names.
Typedefs¶
carb::audio::ContextCallback: prototype for a context callback event function.
carb::audio::ContextParamFlags: base type for the context parameter flags.
carb::audio::EntityAttributeFlags: flags that indicate how listener and voice entity objects should be treated and which values in the carb::audio::EntityAttributes object are valid.
carb::audio::OutputFlags: base type for the flags that control the output of an audio context.
carb::audio::PlaybackContextFlags: flags to control the behaviour of context creation.
carb::audio::PlaybackModeFlags: base type for the various playback mode flags.
carb::audio::PlayFlags: base type for the play descriptor flags.
carb::audio::SpeakerDirectionFlags: flags to affect the behaviour of a speaker direction descriptor when it is passed to setSpeakerDirections().
carb::audio::VoiceCallback: prototype for a voice event callback function.
carb::audio::VoiceParamFlags: base type for the voice parameter flags.
Variables¶
carb::audio::fContextFlagBaking: flag to indicate that the audio processing engine should be run in ‘baking’ mode.
carb::audio::fContextFlagCycleCallbacks: flag to indicate that the audio processing cycle start and end callback events should be performed.
carb::audio::fContextFlagDeviceChangeCallbacks: flag to enable callbacks of type
carb::audio::eDeviceChange
.carb::audio::fContextFlagManualStop: flag to indicate that the audio processing engine will be manually stopped when a baking task is complete instead of stopping it when all of the input voices run out of data to process.
carb::audio::fContextParamAll: all parameters are valid.
carb::audio::fContextParamDefaultPlaybackMode: when set, this flag indicates that the ContextParams::defaultPlaybackMode value is valid.
carb::audio::fContextParamDopplerLimit: when set, this flag indicates that the ContextParams::dopplerLimit value is valid.
carb::audio::fContextParamDopplerScale: when set, this flag indicates that the ContextParams::dopplerScale value is valid.
carb::audio::fContextParamFlags: when set, this flag indicates that the ContextParams::flags value is valid.
carb::audio::fContextParamFlagValidateVoiceTable: flag to indicate that voice table validation should be performed any time a voice is allocated or recycled.
carb::audio::fContextParamListener: when set, this flag indicates that the ContextParams::listener values are valid.
carb::audio::fContextParamMasterVolume: when set, this flag indicates that the ContextParams::masterVolume value is valid.
carb::audio::fContextParamNonSpatialFrequencyRatio: when set, this flag indicates that the ContextParams::nonSpatialFrequencyRatio value is valid.
carb::audio::fContextParamNonSpatialVolume: when set, this flag indicates that the ContextParams::nonSpatialVolume value is valid.
carb::audio::fContextParamSpatialFrequencyRatio: when set, this flag indicates that the ContextParams::spatialFrequencyRatio value is valid.
carb::audio::fContextParamSpatialVolume: when set, this flag indicates that the ContextParams::spatialVolume value is valid.
carb::audio::fContextParamSpeedOfSound: when set, this flag indicates that the ContextParams::speedOfSound value is valid.
carb::audio::fContextParamVideoLatency: When set, this flag indicates that the ContextParams2::videoLatency and ContextParams2::videoLatencyTrim values are valid.
carb::audio::fContextParamVirtualizationThreshold: when set, this flag indicates that the ContextParams::virtualizationThreshold value is valid.
carb::audio::fContextParamWorldUnitScale: when set, this flag indicates that the ContextParams::unitsPerMeter value is valid.
carb::audio::fEntityFlagAll: all vectors in the entity information block are valid.
carb::audio::fEntityFlagCone: the EntityAttributes::cone values are valid.
carb::audio::fEntityFlagForward: the EntityAttributes::forward vector is valid.
carb::audio::fEntityFlagMakePerp: when set, this flag indicates that setListenerAttributes() or setEmitterAttributes() should make the forward and up vectors perpendicular and normalized before setting them as active.
carb::audio::fEntityFlagNormalize: when set, this flag indicates that setListenerAttributes() or setEmitterAttributes() should normalize the forward and up vectors before setting them as active.
carb::audio::fEntityFlagPosition: flags for listener and voice entity attributes.
carb::audio::fEntityFlagRolloff: the EmitterAttributes::rolloff values are valid.
carb::audio::fEntityFlagUp: the EntityAttributes::up vector is valid.
carb::audio::fEntityFlagVelocity: the EntityAttributes::velocity vector is valid.
carb::audio::fOutputFlagAllowNoStreamers: flag to indicate that an empty streamer table is allowed.
carb::audio::fOutputFlagAvailableMask: mask of output flag bits that are available for public use.
carb::audio::fOutputFlagDevice: flag to indicate that the output should target a real audio device.
carb::audio::fOutputFlagStreamer: flag to indicate that the output should target one or more generic streamer objects.
carb::audio::fPlaybackModeAvailableMask: mask of playback mode bits that are available for public use.
carb::audio::fPlaybackModeDefaultDistanceDelay: when used in a voice parameters playback mode flag set, this indicates that new voices will always use the context’s current default distance delay playback mode flag and ignore any specific flag set on the voice parameters.
carb::audio::fPlaybackModeDefaultInterauralDelay: when used in a voice parameters playback mode flag set, this indicates that new voices will always use the context’s current default interaural time delay playback mode flag and ignore any specific flag set on the voice parameters.
carb::audio::fPlaybackModeDefaultMask: the mask of all ‘default’ state playback mode flags.
carb::audio::fPlaybackModeDefaultUseDoppler: default playback mode flag states.
carb::audio::fPlaybackModeDefaultUseFilters: when used in a voice parameters playback mode flag set, this indicates that new voices will always use the context’s current default filters playback mode flag and ignore any specific flag set on the voice parameters.
carb::audio::fPlaybackModeDefaultUseReverb: when used in a voice parameters playback mode flag set, this indicates that new voices will always use the context’s current default reverb playback mode flag and ignore any specific flag set on the voice parameters.
carb::audio::fPlaybackModeDistanceDelay: flag to indicate whether triggering this sound should be delayed to simulate its travel time to reach the listener.
carb::audio::fPlaybackModeFadeIn: Flag to indicate that the sound should fade in when being initially played.
carb::audio::fPlaybackModeInterauralDelay: flag to indicate whether interaural time delay calculations should occur on this voice.
carb::audio::fPlaybackModeListenerRelative: flag to indicate how the spatial attributes of an emitter are to be interpreted.
carb::audio::fPlaybackModeMuted: flag to indicate the current mute state for a voice.
carb::audio::fPlaybackModeNoPositionSimulation: Flags to indicate the behavior that is used when a simulated voice gets assigned to a bus.
carb::audio::fPlaybackModeNoSpatialLowFrequencyEffect: flag to disable the low frequency effect channel (
carb::audio::eLowFrequencyEffect
) for a spatial voice.carb::audio::fPlaybackModePaused: flag to indicate the current pause state of a sound.
carb::audio::fPlaybackModeSimulatePosition: Flags to indicate the behavior that is used when a simulated voice gets assigned to a bus.
carb::audio::fPlaybackModeSpatial: flag to indicate whether a sound should be played back as a spatial or non-spatial sound.
carb::audio::fPlaybackModeSpatialMixLevelMatrix: flag to indicate that a multi-channel spatial voice should treat a specific matrix as its non-spatial output, when using the ‘spatial mix level’ parameter, rather than blending all channels evenly into the output.
carb::audio::fPlaybackModeStopOnSimulation: flag to indicate that a voice should be immediately stopped if it ever gets unassigned from its bus and put on the simulation path.
carb::audio::fPlaybackModeUseDoppler: flag to indicate whether doppler calculations should be performed on this sound.
carb::audio::fPlaybackModeUseFilters: flag to indicate whether filter parameters should be automatically calculated and applied for the sound playing on this voice.
carb::audio::fPlaybackModeUseReverb: flag to indicate whether this sound is eligible to be sent to a reverb effect.
carb::audio::fPlayFlagAvailableMask: mask of playback flag bits that are available for public use.
carb::audio::fPlayFlagMaxInstancesSimulate: when set, this indicates that if a voice is started with a sound that is already over its max play instances count, it should still be started but immediately put into simulation mode instead of taking a bus.
carb::audio::fPlayFlagRealtimeCallbacks: when set, this indicates that voice event callbacks will be performed on the engine thread immediately when the event occurs instead of queuing it to be performed in a later call to update() on the host app thread.
carb::audio::fPlayFlagUseEventPoints: when set, this indicates that the event points from the sound data object PlaySoundDesc::sound should be used to trigger callbacks.
carb::audio::fVoiceParamAll: all parameters are valid.
carb::audio::fVoiceParamBalance: when set, this flag indicates that the VoiceParams::balance values are valid.
carb::audio::fVoiceParamDopplerScale: when set, this flag indicates that the VoiceParams::dopplerScale value is valid.
carb::audio::fVoiceParamEmitter: when set, this flag indicates that the VoiceParams::emitter values are valid.
carb::audio::fVoiceParamFrequencyRatio: when set, this flag indicates that the VoiceParams::frequencyRatio value is valid.
carb::audio::fVoiceParamMatrix: when set, this flag indicates that the VoiceParams::matrix values are valid.
carb::audio::fVoiceParamMute: when set, this flag indicates that the state of the carb::audio::fPlaybackModeMuted flag is valid in the VoiceParams::playbackMode flag set.
carb::audio::fVoiceParamOcclusionFactor: when set, this flag indicates that the VoiceParams::occlusion values are valid.
carb::audio::fVoiceParamPause: when set, this flag indicates that the state of the carb::audio::fPlaybackModePaused flag is valid in the VoiceParams::playbackMode flag set.
carb::audio::fVoiceParamPlaybackMode: when set, this flag indicates that the VoiceParams::playbackMode value is valid.
carb::audio::fVoiceParamPriority: when set, this flag indicates that the VoiceParams::priority value is valid.
carb::audio::fVoiceParamSpatialMixLevel: when set, this flag indicates that the VoiceParams::spatialMixLevel value is valid.
carb::audio::fVoiceParamVolume: when set, this flag indicates that the VoiceParams::volume value is valid.
carb::audio::kConeAngleOmnidirectional: the angle to specify for EntityCone::insideAngle and EntityCone::outsideAngle in order to mark the cone as disabled.
carb::audio::kDefaultSpeedOfSound: The default speed of sound parameter for a carb::audio::Context.
carb::audio::kLoopDescNoLoop: special value for LoopPointDesc::loopPointIndex that indicates no loop point will be used.
carb::audio::kPlaybackModeDefaultFlagCount: the maximum number of ‘default’ state playback mode flags.