net.java.sip.communicator.service.neomedia
Interface Recorder

All Known Implementing Classes:

RecorderImpl

public interface Recorder

The call recording interface. Provides the capability to start and stop call recording.

Author:

Dmitri Melnikov, Lubomir Marinov

Nested Class Summary

static interface

Recorder.Listener Represents a listener interested in notifications from a Recorder.

Field Summary

static String	FORMAT The name of the configuration property the value of which specifies the format in which media is to be recorded by Recorder (e.g.
static String	SAVED_CALLS_PATH The name of the configuration property the value of which specifies the full path to the directory with media recorded by Recorder (e.g.

Method Summary

void	addListener(Recorder.Listener listener) Adds a new Listener to the list of listeners interested in notifications from this Recorder.
String	getFilename() Returns the filename we are last started or stopped recording to, null if not started.
List<String>	getSupportedFormats() Gets a list of the formats in which this Recorder supports recording media.
void	removeListener(Recorder.Listener listener) Removes an existing Listener from the list of listeners interested in notifications from this Recorder.
void	setMute(boolean mute) Put the recorder in mute state.
void	start(String format, String filename) Starts the recording of the media associated with this Recorder (e.g.
void	stop() Stops the recording of the media associated with this Recorder (e.g.

Field Detail

SAVED_CALLS_PATH

static final String SAVED_CALLS_PATH

The name of the configuration property the value of which specifies the full path to the directory with media recorded by Recorder (e.g. the media being sent and received in a Call).

See Also:

Constant Field Values

FORMAT

static final String FORMAT

The name of the configuration property the value of which specifies the format in which media is to be recorded by Recorder (e.g. the media being sent and received in a Call).

See Also:

Constant Field Values

Method Detail

addListener

void addListener(Recorder.Listener listener)

Adds a new Listener to the list of listeners interested in notifications from this Recorder.

Parameters:

listener - the new Listener to be added to the list of listeners interested in notifications from this Recorder

getSupportedFormats

List<String> getSupportedFormats()

Gets a list of the formats in which this Recorder supports recording media.

Returns:

a List of the formats in which this Recorder supports recording media

removeListener

void removeListener(Recorder.Listener listener)

Removes an existing Listener from the list of listeners interested in notifications from this Recorder.

Parameters:

listener - the existing Listener to be removed from the list of listeners interested in notifications from this Recorder

start

void start(String format,
           String filename)
           throws IOException,
                  MediaException

Starts the recording of the media associated with this Recorder (e.g. the media being sent and received in a Call) into a file with a specific name.

Parameters:

format - the format into which the media associated with this Recorder is to be recorded into the specified file

filename - the name of the file into which the media associated with this Recorder is to be recorded

Throws:

IOException - if anything goes wrong with the input and/or output performed by this Recorder

MediaException - if anything else goes wrong while starting the recording of media performed by this Recorder

stop

void stop()

Stops the recording of the media associated with this Recorder (e.g. the media being sent and received in a Call) if it has been started and prepares this Recorder for garbage collection.

setMute

void setMute(boolean mute)

Put the recorder in mute state. It won't record the local input. This is used when the local call is muted and we don't won't to record the local input.

Parameters:

mute - the new value of the mute property

getFilename

String getFilename()

Returns the filename we are last started or stopped recording to, null if not started.

Returns:

the filename we are last started or stopped recording to, null if not started.