Skip navigation links

com.oracle.sft.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.

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.

Methods inherited from interface com.oracle.sft.api.MediaParticipant

stop

Methods inherited from interface com.oracle.sft.api.Participant

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

Method Detail

start

void start(URI stream)

Start recording to the specified URI. See comments for its overload function.

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"); In this way, r.start(uri) can be used only when involved media resource is reserved, such as, bean can call it in CommunicationEvent.ESTABLISHED or MEDIA_RESERVED or EARLY_MEDIA_RESERVED. Another simpler way is as like: Communication c = ...; UserParticipant party = c.getInitiator(); //All UserParticipant support this way, not limited to initiator. initiator.getRecorder().start(uri); By this way, application can record media not only when involved media resource is reserved, but also when no media resource is prepared, such as in CommunicationEvent.Type.INITIALIZATION. In later situation, SFT will first reserve media resource then record media once resource is ready.

Parameters:

stream - The location of stream for recording.

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.

Skip navigation links