org.jactr.modules.pm.aural
Interface IAuralModule

All Superinterfaces:
IAsynchronousModule, IInitializable, IInstallable, IModule, IPerceptualMemoryModule, IPerceptualModule
All Known Implementing Classes:
AbstractAuralModule, DefaultAuralModule6

public interface IAuralModule
extends IPerceptualMemoryModule

Author:
developer

Field Summary
static java.lang.String ATTENDED_STATUS_SLOT
           
static java.lang.String AUDIO_EVENT_CHUNK_TYPE
           
static java.lang.String AURAL_BUFFER
           
static java.lang.String AURAL_LOCATION_BUFFER
           
static java.lang.String AZIMUTH_SLOT
           
static java.lang.String CLEAR_CHUNK_TYPE
           
static java.lang.String CONTENT_SLOT
           
static java.lang.String DIGIT_CHUNK_TYPE
           
static java.lang.String DURATION_SLOT
           
static java.lang.String ELEVATION_SLOT
           
static java.lang.String EVENT_SLOT
           
static java.lang.String EXTERNAL_CHUNK
           
static java.lang.String INTERNAL_CHUNK
           
static java.lang.String KIND_SLOT
           
static java.lang.String LOCATION_SLOT
           
static java.lang.String OFFSET_SLOT
           
static java.lang.String ONSET_SLOT
           
static java.lang.String PITCH_SLOT
           
static java.lang.String SOUND_CHUNK_TYPE
           
static java.lang.String SPEECH_CHUNK_TYPE
           
static java.lang.String TONE_CHUNK_TYPE
           
static java.lang.String WORD_CHUNK_TYPE
           
 
Fields inherited from interface org.jactr.modules.pm.IPerceptualModule
GREATER_THAN_CURRENT_CHUNK, HIGHEST_CHUNK, LESS_THAN_CURRENT_CHUNK, LOWEST_CHUNK
 
Fields inherited from interface org.jactr.core.module.asynch.IAsynchronousModule
STRICT_SYNCHRONIZATION_PARAM
 
Method Summary
 void addListener(IAuralModuleListener listener, java.util.concurrent.Executor executor)
           
 void dispatch(AuralModuleEvent event)
           
 IChunkType getAudioEventChunkType()
           
 IAuralActivationBuffer getAuralActivationBuffer()
           
 double getAuralDecayTime()
          how long does a sound take to decay out of the audicon
 IAuralLocationBuffer getAuralLocationBuffer()
           
 IAuralMemory getAuralMemory()
          return the backing aural memory.
 IChunkType getClearChunkType()
           
 IAuralEncodingTimeEquation getEncodingTimeEquation()
           
 IChunk getExternalChunk()
           
 IChunk getHighestChunk()
           
 IChunk getInternalChunk()
           
 IChunk getLowestChunk()
           
 IChunkType getSoundChunkType()
           
 boolean hasListeners()
           
 void removeListener(IAuralModuleListener listener)
           
 void reset(boolean resetFINSTs)
           
 void setAuralDecayTime(double time)
           
 
Methods inherited from interface org.jactr.modules.pm.IPerceptualMemoryModule
attendTo, getPerceptualMemory, search
 
Methods inherited from interface org.jactr.modules.pm.IPerceptualModule
getCommonRealityExecutor, getSymbolGrounder
 
Methods inherited from interface org.jactr.core.module.asynch.IAsynchronousModule
getExecutor, isStrictSynchronizationEnabled, setStrictSynchronizationEnabled, synchronizedTimedEvent
 
Methods inherited from interface org.jactr.core.module.IModule
dispose, getModel, getName, initialize, install, reset
 
Methods inherited from interface org.jactr.core.utils.IInstallable
uninstall
 

Field Detail

CLEAR_CHUNK_TYPE

static final java.lang.String CLEAR_CHUNK_TYPE
See Also:
Constant Field Values

AUDIO_EVENT_CHUNK_TYPE

static final java.lang.String AUDIO_EVENT_CHUNK_TYPE
See Also:
Constant Field Values

SOUND_CHUNK_TYPE

static final java.lang.String SOUND_CHUNK_TYPE
See Also:
Constant Field Values

DIGIT_CHUNK_TYPE

static final java.lang.String DIGIT_CHUNK_TYPE
See Also:
Constant Field Values

WORD_CHUNK_TYPE

static final java.lang.String WORD_CHUNK_TYPE
See Also:
Constant Field Values

SPEECH_CHUNK_TYPE

static final java.lang.String SPEECH_CHUNK_TYPE
See Also:
Constant Field Values

TONE_CHUNK_TYPE

static final java.lang.String TONE_CHUNK_TYPE
See Also:
Constant Field Values

EXTERNAL_CHUNK

static final java.lang.String EXTERNAL_CHUNK
See Also:
Constant Field Values

INTERNAL_CHUNK

static final java.lang.String INTERNAL_CHUNK
See Also:
Constant Field Values

DURATION_SLOT

static final java.lang.String DURATION_SLOT
See Also:
Constant Field Values

KIND_SLOT

static final java.lang.String KIND_SLOT
See Also:
Constant Field Values

LOCATION_SLOT

static final java.lang.String LOCATION_SLOT
See Also:
Constant Field Values

ONSET_SLOT

static final java.lang.String ONSET_SLOT
See Also:
Constant Field Values

OFFSET_SLOT

static final java.lang.String OFFSET_SLOT
See Also:
Constant Field Values

PITCH_SLOT

static final java.lang.String PITCH_SLOT
See Also:
Constant Field Values

AZIMUTH_SLOT

static final java.lang.String AZIMUTH_SLOT
See Also:
Constant Field Values

ELEVATION_SLOT

static final java.lang.String ELEVATION_SLOT
See Also:
Constant Field Values

CONTENT_SLOT

static final java.lang.String CONTENT_SLOT
See Also:
Constant Field Values

EVENT_SLOT

static final java.lang.String EVENT_SLOT
See Also:
Constant Field Values

ATTENDED_STATUS_SLOT

static final java.lang.String ATTENDED_STATUS_SLOT
See Also:
Constant Field Values

AURAL_LOCATION_BUFFER

static final java.lang.String AURAL_LOCATION_BUFFER
See Also:
Constant Field Values

AURAL_BUFFER

static final java.lang.String AURAL_BUFFER
See Also:
Constant Field Values
Method Detail

getAuralLocationBuffer

IAuralLocationBuffer getAuralLocationBuffer()

getAuralActivationBuffer

IAuralActivationBuffer getAuralActivationBuffer()

getEncodingTimeEquation

IAuralEncodingTimeEquation getEncodingTimeEquation()

getAuralMemory

IAuralMemory getAuralMemory()
return the backing aural memory. this is only valid after the module has been connected to CR.

Returns:

getAuralDecayTime

double getAuralDecayTime()
how long does a sound take to decay out of the audicon

Returns:

setAuralDecayTime

void setAuralDecayTime(double time)

addListener

void addListener(IAuralModuleListener listener,
                 java.util.concurrent.Executor executor)

removeListener

void removeListener(IAuralModuleListener listener)

hasListeners

boolean hasListeners()

dispatch

void dispatch(AuralModuleEvent event)

getClearChunkType

IChunkType getClearChunkType()

getSoundChunkType

IChunkType getSoundChunkType()

getAudioEventChunkType

IChunkType getAudioEventChunkType()

getLowestChunk

IChunk getLowestChunk()

getHighestChunk

IChunk getHighestChunk()

getInternalChunk

IChunk getInternalChunk()

getExternalChunk

IChunk getExternalChunk()

reset

void reset(boolean resetFINSTs)