org.red5.server.stream.consumer

Class FileConsumer

java.lang.Object

org.red5.server.stream.consumer.FileConsumer

All Implemented Interfaces:

IFileConsumer, IConsumer, IMessageComponent, IPipeConnectionListener, IPushableConsumer, Constants, org.springframework.beans.factory.DisposableBean

public class FileConsumer
extends Object
implements Constants, IPushableConsumer, IPipeConnectionListener, org.springframework.beans.factory.DisposableBean, IFileConsumer

Consumer that pushes messages to a writer using priority / comparison.

Author:

The Red5 Project, Paul Gregoire ([email protected])

Field Summary

Fields inherited from interface org.red5.server.net.rtmp.message.Constants

HANDSHAKE_SIZE, HEADER_CONTINUE, HEADER_NEW, HEADER_SAME_SOURCE, HEADER_TIMER_CHANGE, MEDIUM_INT_MAX, SO_CLIENT_CLEAR_DATA, SO_CLIENT_DELETE_DATA, SO_CLIENT_INITIAL_DATA, SO_CLIENT_SEND_MESSAGE, SO_CLIENT_STATUS, SO_CLIENT_UPDATE_ATTRIBUTE, SO_CLIENT_UPDATE_DATA, SO_CONNECT, SO_DELETE_ATTRIBUTE, SO_DISCONNECT, SO_SEND_MESSAGE, SO_SET_ATTRIBUTE, SOURCE_TYPE_LIVE, SOURCE_TYPE_VOD, TYPE_ABORT, TYPE_AGGREGATE, TYPE_AUDIO_DATA, TYPE_BYTES_READ, TYPE_CHUNK_SIZE, TYPE_CLIENT_BANDWIDTH, TYPE_EDGE_ORIGIN, TYPE_FLEX_MESSAGE, TYPE_FLEX_SHARED_OBJECT, TYPE_FLEX_STREAM_SEND, TYPE_INVOKE, TYPE_NOTIFY, TYPE_PING, TYPE_SERVER_BANDWIDTH, TYPE_SHARED_OBJECT, TYPE_STREAM_METADATA, TYPE_VIDEO_DATA

Fields inherited from interface org.red5.server.messaging.IPushableConsumer

KEY

Constructor Summary

Constructors

Constructor and Description
FileConsumer() Default ctor
FileConsumer(IScope scope, File file) Creates file consumer
FileConsumer(IScope scope, String fileName, String mode) Creates file consumer

Method Summary

Modifier and Type	Method and Description
void	destroy()
File	getFile() Returns the file.
void	onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControlMessage oobCtrlMsg) Out-of-band control message handler
void	onPipeConnectionEvent(PipeConnectionEvent event) Pipe connection event handler
void	pushMessage(IPipe pipe, IMessage message) Push message through pipe
void	setAudioDecoderConfiguration(IRTMPEvent audioConfig)
void	setDelayWrite(boolean delayWrite) Deprecated.
void	setFile(File file) Sets the file we're writing to.
void	setMode(String mode) Sets the recording mode.
void	setOfferTimeout(long offerTimeout) Amount of time in milliseconds to wait for an offer to be accepted.
void	setQueueThreshold(int queueThreshold) Sets the threshold for the queue.
void	setScope(IScope scope) Sets the scope for this consumer.
void	setupOutputPath(String name) Sets up the output file path for writing.
void	setUsePriority(boolean usePriority) Whether or not to use a PriorityBlockingQueue or LinkedBlockingQueue for data queue.
void	setVideoDecoderConfiguration(IRTMPEvent videoConfig)
void	setWaitForVideoKeyframe(boolean waitForVideoKeyframe) Whether or not to wait for the first keyframe before processing video frames.
void	uninit() Reset or uninitialize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileConsumer

public FileConsumer()

Default ctor

FileConsumer

public FileConsumer(IScope scope,
                    File file)

Creates file consumer

Parameters:

scope - Scope of consumer

file - File

FileConsumer

public FileConsumer(IScope scope,
                    String fileName,
                    String mode)

Creates file consumer

Parameters:

scope - Scope of consumer

fileName - The file name without the extension

mode - The recording mode

Method Detail

pushMessage

public void pushMessage(IPipe pipe,
                        IMessage message)
                 throws IOException

Push message through pipe

Specified by:

pushMessage in interface IPushableConsumer

Parameters:

pipe - Pipe

message - Message to push

Throws:

IOException - if message could not be written

onOOBControlMessage

public void onOOBControlMessage(IMessageComponent source,
                                IPipe pipe,
                                OOBControlMessage oobCtrlMsg)

Out-of-band control message handler

Specified by:

onOOBControlMessage in interface IMessageComponent

Parameters:

source - Source of message

pipe - Pipe that is used to transmit OOB message

oobCtrlMsg - OOB control message

onPipeConnectionEvent

public void onPipeConnectionEvent(PipeConnectionEvent event)

Pipe connection event handler

Specified by:

onPipeConnectionEvent in interface IPipeConnectionListener

Parameters:

event - Pipe connection event

uninit

public void uninit()

Reset or uninitialize

setupOutputPath

public void setupOutputPath(String name)

Sets up the output file path for writing.

Parameters:

name - output filename to use

setScope

public void setScope(IScope scope)

Sets the scope for this consumer.

Parameters:

scope - scope

setFile

public void setFile(File file)

Sets the file we're writing to.

Parameters:

file - file

getFile

public File getFile()

Returns the file.

Returns:

file

setQueueThreshold

public void setQueueThreshold(int queueThreshold)

Sets the threshold for the queue. When the threshold is met a worker is spawned to empty the sorted queue to the writer.

Parameters:

queueThreshold - number of items to queue before spawning worker

setDelayWrite

@Deprecated
public void setDelayWrite(boolean delayWrite)

Deprecated.

Sets whether or not to use the queue.

Parameters:

delayWrite - true to use the queue, false if not

setWaitForVideoKeyframe

public void setWaitForVideoKeyframe(boolean waitForVideoKeyframe)

Whether or not to wait for the first keyframe before processing video frames.

Parameters:

waitForVideoKeyframe -

setUsePriority

public void setUsePriority(boolean usePriority)

Whether or not to use a PriorityBlockingQueue or LinkedBlockingQueue for data queue.

Parameters:

usePriority -

setOfferTimeout

public void setOfferTimeout(long offerTimeout)

Amount of time in milliseconds to wait for an offer to be accepted.

Parameters:

offerTimeout -

setMode

public void setMode(String mode)

Sets the recording mode.

Parameters:

mode - either "record" or "append" depending on the type of action to perform

setAudioDecoderConfiguration

public void setAudioDecoderConfiguration(IRTMPEvent audioConfig)

Specified by:

setAudioDecoderConfiguration in interface IFileConsumer

setVideoDecoderConfiguration

public void setVideoDecoderConfiguration(IRTMPEvent videoConfig)

Specified by:

setVideoDecoderConfiguration in interface IFileConsumer

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception