org.glassfish.cafe.api
Interface Recorder

All Superinterfaces:

MediaParticipant, Participant

All Known Subinterfaces:

MSRPRecorder

public interface Recorder
extends MediaParticipant

Represents a Recorder object. It can be added to the Communication Application can record the conversation using ths class.

Author:

binod

See Also:

Communication

Method Summary

URI	getStream() A method to retrieve the stream currently being recorded by the recorder.
void	start(String stream) Start recording to the specified location.
void	start(URI stream) Start recording to the specified URI.
void	stop() Stop recording the communication.

Methods inherited from interface org.glassfish.cafe.api.Participant

addAgent, getAgent, getAgents, getJoinable, getName, getNickName, removeAgent, setName, setNickName

Method Detail

start

void start(URI stream)

Start recording to the specified URI.

Parameters:

stream - A URI object.

start

void start(String stream)

Start recording to the specified location. This is equivalent to calling start(URI.create(stream)); The location should be a form acceptable to URI.create. For example, to record to a file, the invocation shall be. Communication c = ...; Recorder r = c.getMediaParticipant(Recorder.class, "recorder-1"); r.start("file:///tmp/recorded.au");

Parameters:

stream - The location of stream for recording.

stop

void stop()

Stop recording the communication.

getStream

URI getStream()

A method to retrieve the stream currently being recorded by the recorder. If the start() hasn't been called, then this method will return null.

Returns:

List of streams currently being played.