clickDetector

Class ClickRecorderTrigger

java.lang.Object

SoundRecorder.trigger.RecorderTrigger

clickDetector.ClickRecorderTrigger

public class ClickRecorderTrigger
extends RecorderTrigger

Constructor Summary

Constructors

Constructor and Description
ClickRecorderTrigger(ClickControl clickControl)

Method Summary

Methods

Modifier and Type	Method and Description
RecorderTriggerData	getDefaultTriggerData() Get default data for this trigger.
boolean	hasOptions() This trigger has additional options available.
boolean	showOptionsDialog(java.awt.Window frame, RecorderTriggerData triggerData) Show a dialog of additional options for the recorder trigger.
boolean	triggerDataUnit(PamDataUnit dataUnit, RecorderTriggerData rtData) Called as each data unit is considered for triggering.

Methods inherited from class SoundRecorder.trigger.RecorderTrigger

getName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClickRecorderTrigger

public ClickRecorderTrigger(ClickControl clickControl)

Parameters:

clickControl -

Method Detail

getDefaultTriggerData

public RecorderTriggerData getDefaultTriggerData()

Description copied from class: RecorderTrigger

Get default data for this trigger. This will be cloned and used locally in each individual recorder from where it can be modified from the recorders control panel.

Specified by:

getDefaultTriggerData in class RecorderTrigger

Returns:

default settings for a recorder.

hasOptions

public boolean hasOptions()

Description copied from class: RecorderTrigger

This trigger has additional options available.

Overrides:

hasOptions in class RecorderTrigger

Returns:

true if additional options are available.

showOptionsDialog

public boolean showOptionsDialog(java.awt.Window frame,
                        RecorderTriggerData triggerData)

Description copied from class: RecorderTrigger

Show a dialog of additional options for the recorder trigger.

Developers should probably put parameters controlling any options into a class extending the defaultTriggerData, so that these get stored on a recorder by recorder basis.

Overrides:

showOptionsDialog in class RecorderTrigger

Returns:

triggerDataUnit

public boolean triggerDataUnit(PamDataUnit dataUnit,
                      RecorderTriggerData rtData)

Description copied from class: RecorderTrigger

Called as each data unit is considered for triggering. Individual modules should override this in order to provide additional functionality, e.g. the click detector may give options to only trigger on certain click types, the whistle detector only on whsitles in a given frequency band or of a minimum length, etc.

Overrides:

triggerDataUnit in class RecorderTrigger

Parameters:

dataUnit - data unit to consider for recording triggering

Returns:

true if unit should be used.