SessionManager

java.lang.Object
- ipsk.apps.speechrecorder.session.SessionManager

All Implemented Interfaces:

AnnotationManager, PromptViewerListener, ProgressManagerListener, AudioController2.AudioController2Listener, SpeechFinalSilenceDetectorListener, PlayerListener, ProgressListener, UpdateListener<PlayerEvent>, java.awt.event.ActionListener, java.util.EventListener
```
public class SessionManager
extends java.lang.Object
implements java.awt.event.ActionListener, AudioController2.AudioController2Listener, ProgressManagerListener, PromptViewerListener, ProgressListener, PlayerListener, SpeechFinalSilenceDetectorListener, AnnotationManager
```
Author:

klausj

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class SessionManager.RepeatRequest
Indicates request to repeat the recording item.

Nested Classes
Modifier and Type	Class	Description
`class`	`SessionManager.RepeatRequest`	Indicates request to repeat the recording item.

Field Summary

Fields
Modifier and Type Field Description

javax.swing.Action[] actions

static boolean DEBUG

boolean USE_MAX_REC_TIMER

boolean useMaxRecTimer

Fields
Modifier and Type	Field	Description
`javax.swing.Action[]`	`actions`
`static boolean`	`DEBUG`
`boolean`	`USE_MAX_REC_TIMER`
`boolean`	`useMaxRecTimer`

Constructor Summary

Constructors
Constructor Description

SessionManager()

Constructors
Constructor	Description
`SessionManager()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`actionPerformed(java.awt.event.ActionEvent e)`
`void`	`advanceToNextRecording()`
`void`	`annotate(java.lang.Object annotatedObject, java.lang.String annotationName, java.lang.String propertyName, java.lang.Object annotation)`
`void`	`applyItem()`
`void`	`close()`
`void`	`continuePlayback()`	Continues playback after pause.
`void`	`continueSession()`	When all recordings of a session have been performed, the user is informed that the session is over.
`void`	`decrementIndex()`
`javax.swing.Action[]`	`getActions()`
`ips.annot.model.AnnotatedAudioClip`	`getAudioClip()`
`AudioController4`	`getAudioController()`
`java.util.List<ips.annot.autoannotator.AutoAnnotator>`	`getAutoAnnotators()`
`Player`	`getBeepPlayer()`
`java.net.URL`	`getBeepURL()`
`java.lang.Double`	`getBeepVolume()`
`java.util.List<ips.annot.BundleAnnotationPersistor>`	`getBundleAnnotationPersistorList()`
`RecordingConfiguration.CaptureScope`	`getCaptureScope()`
`Section.Mode`	`getDefaultSectionMode()`
`java.util.List<ips.annot.autoannotator.AutoAnnotator>`	`getEnabledAutoAnnotators()`
`SessionManagerListener`	`getListener()`
`ProgressManager`	`getProgressManager()`
`boolean`	`getProgressPaused()`
`RecTransporterActions`	`getRecTransporterActions()`
`Script`	`getScript()`
`SetIndexAction`	`getSetIndexAction()`
`SpeechRecorderUI`	`getSpeechRecorderUI()`
`StartPlaybackAction`	`getStartPlaybackAction()`
`ActiveSessionStorageManager`	`getStorageManager()`
`void`	`incrementIndex()`
`void`	`init()`	Initialize the recorder.
`boolean`	`isAudioEnabled()`
`boolean`	`isAutoProgress()`
`boolean`	`isAutoRecording()`
`boolean`	`isDefaultShowSpeakerWindow()`
`boolean`	`isForcePostRecPhase()`
`boolean`	`isItemPlayable()`	Returns whether the current selected recording can be played.
`boolean`	`isOverwrite()`
`boolean`	`isOverwriteWarning()`
`boolean`	`isProgressToNextUnrecorded()`
`boolean`	`isRecManualPlay()`
`boolean`	`isResetPeakOnRecording()`
`boolean`	`isSeamlessAutoRecording()`
`boolean`	`isSpeakerWindowShowing()`	returns true if the speaker window is shown
`boolean`	`isUseUploadCache()`
`void`	`open()`
`void`	`pausePlayback()`	Pauses playback.
`void`	`setAudioClip(ips.annot.model.AnnotatedAudioClip audioClip)`
`void`	`setAudioController(AudioController4 audioController)`
`void`	`setAudioEnabled(boolean audioEnabled)`
`void`	`setBeepPlayer(Player beepPlayer)`
`void`	`setBeepURL(java.net.URL beepURL)`
`void`	`setBeepVolume(java.lang.Double beepVolume)`
`void`	`setBundleAnnotationPersistorList(java.util.List<ips.annot.BundleAnnotationPersistor> bundleAnnotationPersistorList)`
`void`	`setCaptureScope(RecordingConfiguration.CaptureScope captureScope)`
`void`	`setDefaultSectionMode(Section.Mode defaultSectionMode)`
`void`	`setDefaultShowSpeakerWindow(boolean defaultShowSpeakerWindow)`
`void`	`setEnabledAutoAnnotators(java.util.List<ips.annot.autoannotator.AutoAnnotator> enabledAutoAnnotators)`
`void`	`setForcePostRecPhase(boolean forcePostRecPhase)`
`void`	`setIdle()`
`void`	`setListener(SessionManagerListener listener)`
`void`	`setOverwrite(boolean overwrite)`
`void`	`setOverwriteWarning(boolean overwriteWarning)`
`void`	`setProgressPaused(boolean progressPaused)`
`void`	`setProgressToNextUnrecorded(boolean progressToNextUnrecorded)`
`void`	`setPromptErrorState()`
`void`	`setRecIndex(int skipTo)`
`void`	`setRecManualPlay(boolean recManualPlay)`
`void`	`setResetPeakOnRecording(boolean resetPeakOnRecording)`
`void`	`setScript(Script script)`
`void`	`setSeamlessAutoRecording(boolean seamlessAutoRecording)`
`void`	`setSpeakerWindowShowing(boolean v)`	if true, a separate window is shown for the speaker prompts
`void`	`setSpeechRecorderUI(SpeechRecorderUI ui)`
`void`	`setStorageManager(ActiveSessionStorageManager storageManager)`
`void`	`setUseUploadCache(boolean useUploadCache)`
`void`	`start(int sessionId, java.lang.String speakerCode)`	Start a recording session.
`void`	`startAnnotation()`
`void`	`startBeep()`
`void`	`startItem()`
`void`	`startPlayback()`
`void`	`startPlayback(long start, long stop)`
`void`	`startPostRecordingPhase()`
`void`	`startPreRecWaiting()`
`void`	`startRecording()`
`void`	`startRecordingPhase()`
`void`	`stop()`
`void`	`stopNonrecording()`
`void`	`stopPlayback()`	Stops playback.
`void`	`stopRecording()`
`void`	`update(PromptViewerEvent promptViewerEvent)`
`void`	`update(RecscriptManagerEvent e)`	Close a session.
`void`	`update(ProgressManagerEvent e)`
`void`	`update(AudioController2.AudioControllerEvent ace)`
`void`	`update(SpeechFinalSilenceDetectorEvent event)`
`void`	`update(PlayerEvent playerEvent)`
`void`	`update(ProgressEvent progressEvent)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG
```
public static final boolean DEBUG
```
See Also:

Constant Field Values

USE_MAX_REC_TIMER
```
public final boolean USE_MAX_REC_TIMER
```
See Also:

Constant Field Values

actions
```
public javax.swing.Action[] actions
```

useMaxRecTimer
```
public boolean useMaxRecTimer
```

Constructor Detail
- SessionManager
```
public SessionManager()
```

Method Detail

getStartPlaybackAction

public StartPlaybackAction getStartPlaybackAction()

getSetIndexAction

public SetIndexAction getSetIndexAction()

getActions

public javax.swing.Action[] getActions()

getListener

public SessionManagerListener getListener()

setListener

public void setListener(SessionManagerListener listener)

getSpeechRecorderUI

public SpeechRecorderUI getSpeechRecorderUI()

setSpeechRecorderUI

public void setSpeechRecorderUI(SpeechRecorderUI ui)

isUseUploadCache
```
public boolean isUseUploadCache()
```

setUseUploadCache

public void setUseUploadCache(boolean useUploadCache)

getRecTransporterActions

public RecTransporterActions getRecTransporterActions()

getAudioController

public AudioController4 getAudioController()

isAudioEnabled
```
public boolean isAudioEnabled()
```

setAudioEnabled

public void setAudioEnabled(boolean audioEnabled)

getBeepURL
```
public java.net.URL getBeepURL()
```

setBeepURL

public void setBeepURL(java.net.URL beepURL)

getBeepPlayer
```
public Player getBeepPlayer()
```

setBeepPlayer

public void setBeepPlayer(Player beepPlayer)

setAudioController

public void setAudioController(AudioController4 audioController)

getStorageManager

public ActiveSessionStorageManager getStorageManager()

setStorageManager

public void setStorageManager(ActiveSessionStorageManager storageManager)

isOverwrite
```
public boolean isOverwrite()
```

setOverwrite

public void setOverwrite(boolean overwrite)

isOverwriteWarning
```
public boolean isOverwriteWarning()
```

setOverwriteWarning

public void setOverwriteWarning(boolean overwriteWarning)

isDefaultShowSpeakerWindow

public boolean isDefaultShowSpeakerWindow()

setDefaultShowSpeakerWindow

public void setDefaultShowSpeakerWindow(boolean defaultShowSpeakerWindow)

getProgressManager

public ProgressManager getProgressManager()

Returns:: the progressManager

getAudioClip

public ips.annot.model.AnnotatedAudioClip getAudioClip()

setAudioClip

public void setAudioClip(ips.annot.model.AnnotatedAudioClip audioClip)

getCaptureScope

public RecordingConfiguration.CaptureScope getCaptureScope()

setCaptureScope

public void setCaptureScope(RecordingConfiguration.CaptureScope captureScope)

isSeamlessAutoRecording

public boolean isSeamlessAutoRecording()

setSeamlessAutoRecording

public void setSeamlessAutoRecording(boolean seamlessAutoRecording)

getDefaultSectionMode

public Section.Mode getDefaultSectionMode()

setDefaultSectionMode

public void setDefaultSectionMode(Section.Mode defaultSectionMode)

isResetPeakOnRecording

public boolean isResetPeakOnRecording()

setResetPeakOnRecording

public void setResetPeakOnRecording(boolean resetPeakOnRecording)

isProgressToNextUnrecorded

public boolean isProgressToNextUnrecorded()

setProgressToNextUnrecorded

public void setProgressToNextUnrecorded(boolean progressToNextUnrecorded)

getEnabledAutoAnnotators

public java.util.List<ips.annot.autoannotator.AutoAnnotator> getEnabledAutoAnnotators()

setEnabledAutoAnnotators

public void setEnabledAutoAnnotators(java.util.List<ips.annot.autoannotator.AutoAnnotator> enabledAutoAnnotators)

getBundleAnnotationPersistorList

public java.util.List<ips.annot.BundleAnnotationPersistor> getBundleAnnotationPersistorList()

setBundleAnnotationPersistorList

public void setBundleAnnotationPersistorList(java.util.List<ips.annot.BundleAnnotationPersistor> bundleAnnotationPersistorList)

isSpeakerWindowShowing
```
public boolean isSpeakerWindowShowing()
```
returns true if the speaker window is shown

Returns:

true if the speaker window is shown

getScript
```
public Script getScript()
```

getAutoAnnotators

public java.util.List<ips.annot.autoannotator.AutoAnnotator> getAutoAnnotators()

isRecManualPlay
```
public boolean isRecManualPlay()
```

setRecManualPlay

public void setRecManualPlay(boolean recManualPlay)

isItemPlayable
```
public boolean isItemPlayable()
```
Returns whether the current selected recording can be played.

Returns:

true if the recording is available

actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent e)
```
Specified by:

actionPerformed in interface java.awt.event.ActionListener

isAutoRecording
```
public boolean isAutoRecording()
```

isAutoProgress
```
public boolean isAutoProgress()
```

setProgressPaused

public void setProgressPaused(boolean progressPaused)

getProgressPaused
```
public boolean getProgressPaused()
```

isForcePostRecPhase
```
public boolean isForcePostRecPhase()
```

setForcePostRecPhase

public void setForcePostRecPhase(boolean forcePostRecPhase)

open
```
public void open()
```

start
```
public void start(int sessionId,
                  java.lang.String speakerCode)
           throws AudioControllerException
```
Start a recording session. The application must be configured, initialized and a speaker must be chosen to start a session.

Throws:

AudioControllerException

getBeepVolume

public java.lang.Double getBeepVolume()

setBeepVolume

public void setBeepVolume(java.lang.Double beepVolume)

startItem
```
public void startItem()
```

startBeep

public void startBeep()
               throws SpeechRecorderException

Throws:: SpeechRecorderException

startPreRecWaiting
```
public void startPreRecWaiting()
```

startRecordingPhase
```
public void startRecordingPhase()
```

startPostRecordingPhase
```
public void startPostRecordingPhase()
```

startRecording

public void startRecording()
                    throws AudioControllerException,
                           StorageManagerException

Throws:: AudioControllerException; StorageManagerException

stopRecording

public void stopRecording()
                   throws AudioControllerException

Throws:: AudioControllerException

stopNonrecording
```
public void stopNonrecording()
```

startAnnotation
```
public void startAnnotation()
```

continueSession
```
public void continueSession()
```
When all recordings of a session have been performed, the user is informed that the session is over. Otherwise, if the automatic_recording mode is on, then the next recording is started. If automatic_recording is off, the application waits for the user to continue the recording session.

init
```
public void init()
```
Initialize the recorder. All components get ready, but are still disabled.

applyItem

public void applyItem()
               throws PromptPresenterException

Throws:: PromptPresenterException

setPromptErrorState
```
public void setPromptErrorState()
```

setIdle
```
public void setIdle()
```

update
```
public void update(AudioController2.AudioControllerEvent ace)
```
Specified by:

update in interface AudioController2.AudioController2Listener

annotate

public void annotate(java.lang.Object annotatedObject,
                     java.lang.String annotationName,
                     java.lang.String propertyName,
                     java.lang.Object annotation)

Specified by:: annotate in interface AnnotationManager

setScript

public void setScript(Script script)

Parameters:: script -

setRecIndex

public void setRecIndex(int skipTo)

advanceToNextRecording
```
public void advanceToNextRecording()
```

decrementIndex
```
public void decrementIndex()
```

incrementIndex
```
public void incrementIndex()
```

startPlayback

public void startPlayback()
                   throws AudioControllerException,
                          StorageManagerException

Throws:: AudioControllerException; StorageManagerException

startPlayback

public void startPlayback(long start,
                          long stop)
                   throws AudioControllerException,
                          StorageManagerException

Throws:: AudioControllerException; StorageManagerException

stopPlayback

public void stopPlayback()
                  throws AudioControllerException

Stops playback.

Throws:: AudioControllerException

pausePlayback

public void pausePlayback()
                   throws AudioControllerException

Pauses playback.

Throws:: AudioControllerException

continuePlayback
```
public void continuePlayback()
```
Continues playback after pause.

setSpeakerWindowShowing
```
public void setSpeakerWindowShowing(boolean v)
```
if true, a separate window is shown for the speaker prompts

Parameters:

v -

stop

public void stop()
          throws SpeechRecorderException

Throws:: SpeechRecorderException

close

public void close()
           throws SpeechRecorderException

Throws:: SpeechRecorderException

update
```
public void update(RecscriptManagerEvent e)
```
Close a session. Prompts the user if files are modified and/or the upload cache has not completely transferred the data.

Throws:

AudioControllerException - if the controller cannot be closed

WorkspaceException

SpeechRecorderException

update

public void update(PromptViewerEvent promptViewerEvent)

Specified by:: update in interface PromptViewerListener

update
```
public void update(PlayerEvent playerEvent)
```
Specified by:

update in interface PlayerListener

Specified by:

update in interface UpdateListener<PlayerEvent>

update
```
public void update(ProgressManagerEvent e)
```
Specified by:

update in interface ProgressManagerListener

update

public void update(ProgressEvent progressEvent)

Specified by:: update in interface ProgressListener

update
```
public void update(SpeechFinalSilenceDetectorEvent event)
```
Specified by:

update in interface SpeechFinalSilenceDetectorListener

Class SessionManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEBUG

USE_MAX_REC_TIMER

actions

useMaxRecTimer

Constructor Detail

SessionManager

Method Detail

getStartPlaybackAction

getSetIndexAction

getActions

getListener

setListener

getSpeechRecorderUI

setSpeechRecorderUI

isUseUploadCache

setUseUploadCache

getRecTransporterActions

getAudioController

isAudioEnabled

setAudioEnabled

getBeepURL

setBeepURL

getBeepPlayer

setBeepPlayer

setAudioController

getStorageManager

setStorageManager

isOverwrite

setOverwrite

isOverwriteWarning

setOverwriteWarning

isDefaultShowSpeakerWindow

setDefaultShowSpeakerWindow

getProgressManager

getAudioClip

setAudioClip

getCaptureScope

setCaptureScope

isSeamlessAutoRecording

setSeamlessAutoRecording

getDefaultSectionMode

setDefaultSectionMode

isResetPeakOnRecording

setResetPeakOnRecording

isProgressToNextUnrecorded

setProgressToNextUnrecorded

getEnabledAutoAnnotators

setEnabledAutoAnnotators

getBundleAnnotationPersistorList

setBundleAnnotationPersistorList

isSpeakerWindowShowing

getScript

getAutoAnnotators

isRecManualPlay

setRecManualPlay

isItemPlayable

actionPerformed

isAutoRecording

isAutoProgress

setProgressPaused

getProgressPaused

isForcePostRecPhase

setForcePostRecPhase

open

start

getBeepVolume

setBeepVolume

startItem

startBeep

startPreRecWaiting

startRecordingPhase

startPostRecordingPhase

startRecording