com.threerings.openal.config
Class SounderConfig

java.lang.Object
  com.threerings.util.DeepObject
      com.threerings.config.ManagedConfig
          com.threerings.config.ParameterizedConfig
              com.threerings.openal.config.SounderConfig

All Implemented Interfaces:

ConfigUpdateListener<ManagedConfig>, Exportable, com.threerings.resource.ResourceManager.ModificationObserver, Copyable, Cloneable

public class SounderConfig
extends ParameterizedConfig

The configuration of a sounder.

Nested Class Summary

static class	SounderConfig.BaseClip Base class for SounderConfig.BaseClip and SounderConfig.MetaClip.
static class	SounderConfig.BaseStream Base class for SounderConfig.BaseStream and SounderConfig.MetaStream.
static class	SounderConfig.Case A case within a conditional sounder
static class	SounderConfig.Clip Plays a sound clip.
static class	SounderConfig.ComponentSounder A component sounder within a compound.
static class	SounderConfig.Compound Plays multiple sounders simultaneously.
static class	SounderConfig.Conditional Plays the first sounder whose condition evaluates to true.
static class	SounderConfig.Derived A derived implementation.
static class	SounderConfig.Fixed An original config with fixed fields.
static class	SounderConfig.Implementation Contains the actual implementation of the sounder.
static class	SounderConfig.MetaClip Plays a randomly selected clip.
static class	SounderConfig.MetaStream Selects between a number of substreams.
static class	SounderConfig.Original The superclass of the implementations describing an original sounder, as opposed to one derived from another configuration.
static class	SounderConfig.PitchWeightedFile A weighted file with a pitch multiplier.
static class	SounderConfig.QueuedFile Represents a file to enqueue in the stream.
static class	SounderConfig.Random Plays a randomly selected sub-sounder.
static class	SounderConfig.Scripted Plays a scripted sequence of sounders.
static class	SounderConfig.Sequential Plays multiple sounders in sequence.
static class	SounderConfig.Stream Plays a sound stream.
static class	SounderConfig.TimedSounder A sounder to play at a specific time.
static class	SounderConfig.Variable An original config with variable fields.
static class	SounderConfig.VariableClip Plays a clip with variable parameters.
static class	SounderConfig.WeightedFile Combines a file to enqueue .
static class	SounderConfig.WeightedSounder A component sounder within a compound.

Field Summary

SounderConfig.Implementation

implementation The actual sound implementation.

Fields inherited from class com.threerings.config.ParameterizedConfig

parameters

Constructor Summary

SounderConfig()

Method Summary

Sounder.Implementation

getSounderImplementation(AlContext ctx, Scope scope, Sounder.Implementation impl) Creates or updates sounder implementation for this configuration.

Methods inherited from class com.threerings.config.ParameterizedConfig

getInstance, getParameter, getReference, validateOuters, validateReferences, wasUpdated

Methods inherited from class com.threerings.config.ManagedConfig

addListener, configUpdated, getConfigManager, getInstance, getInstance, getInstance, getInstance, getName, init, removeListener, resourceModified, setName, updateFromSource

Methods inherited from class com.threerings.util.DeepObject

clone, copy, copy, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

implementation

@Editable
public SounderConfig.Implementation implementation

The actual sound implementation.

Constructor Detail

SounderConfig

public SounderConfig()

Method Detail

getSounderImplementation

public Sounder.Implementation getSounderImplementation(AlContext ctx,
                                                       Scope scope,
                                                       Sounder.Implementation impl)

Creates or updates sounder implementation for this configuration.

Parameters:

scope - the sounder's expression scope.

impl - an existing implementation to reuse, if possible.

Returns:

either a reference to the existing implementation (if reused), a new implementation, or null if no implementation could be created.