org.red5.server.stream

Interface IRecordingListener

All Superinterfaces:

IStreamListener

All Known Implementing Classes:

RecordingListener

public interface IRecordingListener
extends IStreamListener

Recording listener interface.

Author:

Paul Gregoire (mondain@gmail.com)

Method Summary

Modifier and Type	Method and Description
FileConsumer	getFileConsumer()
String	getFileName()
boolean	init(IConnection conn, String name, boolean isAppend) Initialize the listener.
boolean	init(IScope scope, String name, boolean isAppend) Initialize the listener.
boolean	isAppending()
boolean	isRecording()
void	packetReceived(IBroadcastStream stream, IStreamPacket packet) A packet has been received from a stream.
void	setFileConsumer(FileConsumer recordingConsumer)
void	setFileName(String fileName)
void	start() Start the recording.
void	stop() Stop the recording.

Method Detail

init

boolean init(IConnection conn,
             String name,
             boolean isAppend)

Initialize the listener.

Parameters:

conn - Stream source connection

name - Stream name

isAppend - Append mode

Returns:

true if initialization completes and false otherwise

init

boolean init(IScope scope,
             String name,
             boolean isAppend)

Initialize the listener.

Parameters:

scope - Stream source scope

name - Stream name

isAppend - Append mode

Returns:

true if initialization completes and false otherwise

start

void start()

Start the recording.

stop

void stop()

Stop the recording.

packetReceived

void packetReceived(IBroadcastStream stream,
                    IStreamPacket packet)

A packet has been received from a stream.

Specified by:

packetReceived in interface IStreamListener

Parameters:

stream - the stream the packet has been received for

packet - the packet received

isRecording

boolean isRecording()

Returns:

recording state, true if recording and false otherwise

isAppending

boolean isAppending()

Returns:

appending state, true if appending and false otherwise

getFileConsumer

FileConsumer getFileConsumer()

Returns:

the recordingConsumer

setFileConsumer

void setFileConsumer(FileConsumer recordingConsumer)

Parameters:

recordingConsumer - the recordingConsumer to set

getFileName

String getFileName()

Returns:

the fileName

setFileName

void setFileName(String fileName)

Parameters:

fileName - the fileName to set