net.sourceforge.nite.meta
Interface NSignal

All Known Implementing Classes:

NiteSignal

public interface NSignal

Information about the location and type of a signal.

Author:

jonathan

Field Summary

static int	AGENT_SIGNAL
static int	AUDIO_SIGNAL
static int	INTERACTION_SIGNAL
static int	VIDEO_SIGNAL

Method Summary

java.lang.String	getExtension() returns the extension of the signal, without the "."
java.lang.String	getFilename(java.lang.String obsname, java.lang.String agentname) returns the full path and filename of the signal, given the current observation and agent names
java.lang.String	getFormat() returns the format of the signal.
int	getMediaType() getMediaType returns either VIDEO_SIGNAL or AUDIO_SIGNAL.
java.lang.String	getName() returns the name of the signal - used in file name
java.lang.String	getSignalPathModifier(java.lang.String observation) returns the path modifier, replacing 'observation' with the given observation name
int	getType() getType returns either INTERACTION_SIGNAL or AGENT_SIGNAL.

Field Detail

VIDEO_SIGNAL

static final int VIDEO_SIGNAL

See Also:

Constant Field Values

AUDIO_SIGNAL

static final int AUDIO_SIGNAL

See Also:

Constant Field Values

AGENT_SIGNAL

static final int AGENT_SIGNAL

See Also:

Constant Field Values

INTERACTION_SIGNAL

static final int INTERACTION_SIGNAL

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

returns the name of the signal - used in file name

getType

int getType()

getType returns either INTERACTION_SIGNAL or AGENT_SIGNAL.

getMediaType

int getMediaType()

getMediaType returns either VIDEO_SIGNAL or AUDIO_SIGNAL.

getFormat

java.lang.String getFormat()

returns the format of the signal. Returns an arbitrary string (whatever appears in the format attribute of the signal in the metadata file).

getExtension

java.lang.String getExtension()

returns the extension of the signal, without the "."

getFilename

java.lang.String getFilename(java.lang.String obsname,
                             java.lang.String agentname)

returns the full path and filename of the signal, given the current observation and agent names

getSignalPathModifier

java.lang.String getSignalPathModifier(java.lang.String observation)

returns the path modifier, replacing 'observation' with the given observation name