Package org.red5.server.stream

Class ClientBroadcastStream

java.lang.Object

org.red5.server.stream.AbstractStream

org.red5.server.stream.AbstractClientStream

org.red5.server.stream.ClientBroadcastStream

All Implemented Interfaces:

IEventDispatcher, IClientBroadcastStreamStatistics, IStatisticsBase, IStreamStatistics, IBroadcastStream, IClientBroadcastStream, IClientStream, IStream, ClientBroadcastStreamMXBean, IConsumer, IFilter, IMessageComponent, IPipeConnectionListener, IProvider, IPushableConsumer

@ManagedResource(objectName="org.red5.server:type=ClientBroadcastStream",
                 description="ClientBroadcastStream")
public class ClientBroadcastStream
extends AbstractClientStream
implements IClientBroadcastStream, IFilter, IPushableConsumer, IPipeConnectionListener, IEventDispatcher, IClientBroadcastStreamStatistics, ClientBroadcastStreamMXBean

Represents live stream broadcasted from client. As Flash Media Server, Red5 supports recording mode for live streams, that is, broadcasted stream has broadcast mode. It can be either "live" or "record" and latter causes server-side application to record broadcasted stream. Note that recorded streams are recorded as FLV files. This type of stream uses two different pipes for live streaming and recording.

Author:

The Red5 Project, Steven Gong, Paul Gregoire (mondain@gmail.com), Vladimir Hmelyoff (vlhm@splitmedialabs.com)

Field Summary

Fields

Modifier and Type	Field	Description
protected CopyOnWriteArraySet<String>	aliases	Subscribe aliases for this instance.
protected boolean	automaticRecording	Whether or not to automatically record the associated stream.
protected long	bytesReceived	Total number of bytes received.
protected boolean	checkAudioCodec	Is there need to check audio codec?
protected boolean	checkVideoCodec	Is there need to check video codec?
protected int	chunkSize	Data is sent by chunks, each of them has size
protected AtomicBoolean	closed	Is this stream still active?
protected IMessageOutput	connMsgOut	Output endpoint that providers use
protected long	firstPacketTime	Stores timestamp of first packet
protected long	latestTimeStamp
protected Set<IStreamListener>	listeners	Listeners to get notified about received packets.
protected IPipe	livePipe	Pipe for live streaming
protected static CopyOnWriteArraySet<String>	localAliases	Stream name aliases for the entire server instance.
protected String	nameAlias	Publish alias for the stream name.
protected Map<String,String>	parameters	Streaming parameters
protected String	publishedName	Stream published name
protected WeakReference<IRecordingListener>	recordingListener	Recording listener
protected boolean	registerJMX	Whether or not to register with JMX.
protected boolean	sendStartNotification	Is there need to send start notification?

Fields inherited from class org.red5.server.stream.AbstractStream

codecInfo, creationTime, metaData, startTime, state, stateListeners

Fields inherited from interface org.red5.server.api.stream.IClientStream

MODE_APPEND, MODE_LIVE, MODE_PUBLISH, MODE_READ, MODE_RECORD

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

KEY

Constructor Summary

Constructors

Constructor	Description
ClientBroadcastStream()

Method Summary

Modifier and Type	Method	Description
boolean	addAlias(String alias)	Adds a stream name subscribe-side alias.
void	addStreamListener(IStreamListener listener)	Add a listener to be notified about received packets.
boolean	aliasRegistered(String alias)	Returns whether or not an alias is in-use / registered already; this includes both publish and subscribe aliases within a server instance.
protected void	checkSendNotifications(IEvent event)	Check and send notification if necessary
void	close()	Closes stream, unsubscribes provides, sends stoppage notifications and broadcast close notification.
boolean	containsAlias(String alias)	Returns whether or not a given subscribe-side alias exists.
void	dispatchEvent(IEvent event)	Dispatches event
int	getActiveSubscribers()	Return current number of subscribers.
String	getAlias()	Returns an subscribe-side alias.
Set<String>	getAliases()	Returns all the subscribe-side aliases.
long	getBytesReceived()	Return total number of bytes received from client for this stream.
int	getCurrentTimestamp()	Return the currently active timestamp inside the stream.
int	getMaxSubscribers()	Return maximum number of concurrent subscribers.
String	getNameAlias()	Returns the publish-side alias, if configured.
Map<String,String>	getParameters()	Returns streaming parameters.
IProvider	getProvider()	Getter for provider
String	getPublishedName()	Getter for published name
protected File	getRecordFile(IScope scope, String name)	Get the file we'd be recording to based on scope and given name.
String	getSaveFilename()	Get the filename the stream is being saved as.
IClientBroadcastStreamStatistics	getStatistics()	Return statistics about the stream.
Collection<IStreamListener>	getStreamListeners()	Return registered stream listeners.
int	getTotalSubscribers()	Return total number of subscribers.
boolean	hasAlias()	Returns whether or not an subscribe-side alias for this stream exists.
boolean	isAutomaticRecording()
boolean	isRecording()
protected void	notifyBroadcastClose()	Notifies handler on stream broadcast close
protected void	notifyBroadcastStart()	Notifies handler on stream broadcast start
protected void	notifyChunkSize()	Send OOB control message with chunk size
protected void	notifyRecordingStop()	Notifies handler on stream recording stop
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)	Currently not implemented
protected void	pushMessage(StatusMessage msg)	Pushes a message out to a consumer.
protected void	registerJMX()
void	removeStreamListener(IStreamListener listener)	Remove a listener from being notified about received packets.
void	saveAs(String name, boolean isAppend)	Save broadcasted stream.
protected void	sendPublishStartNotify()	Sends publish start notifications
protected void	sendPublishStopNotify()	Sends publish stop notifications
protected void	sendRecordFailedNotify(String reason)	Sends record failed notifications
protected void	sendRecordStartNotify()	Sends record start notifications
protected void	sendRecordStopNotify()	Sends record stop notifications
protected void	sendStartNotifications(IEventListener source)
void	setAutomaticRecording(boolean automaticRecording)
void	setNameAlias(String nameAlias)	Sets the publish-side alias for the streams name.
void	setParameters(Map<String,String> params)	Sets streaming parameters as supplied by the publishing application.
void	setPublishedName(String name)	Setter for stream published name
void	setRegisterJMX(boolean registerJMX)
void	start()	Starts stream, creates pipes, connects
void	startPublishing()	Notify client that stream is ready for publishing.
void	stop()	Stop this stream.
void	stopRecording()	Stops any currently active recording.
protected void	unregisterJMX()

Methods inherited from class org.red5.server.stream.AbstractClientStream

getBroadcastStreamPublishName, getClientBufferDuration, getConnection, getStreamId, setBroadcastStreamPublishName, setClientBufferDuration, setConnection, setStreamId, setStreamId

Methods inherited from class org.red5.server.stream.AbstractStream

addStateChangeListener, fireStateChange, getCodecInfo, getCreationTime, getMetaData, getName, getScope, getStartTime, getState, getStreamAwareHandler, removeStateChangeListener, setCodecInfo, setMetaData, setName, setScope, setState

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.red5.server.api.stream.IBroadcastStream

getMetaData

Methods inherited from interface org.red5.server.api.stream.IClientStream

getBroadcastStreamPublishName, getClientBufferDuration, getConnection, getStreamId, setBroadcastStreamPublishName, setClientBufferDuration

Methods inherited from interface org.red5.server.api.statistics.IStatisticsBase

getCreationTime

Methods inherited from interface org.red5.server.api.stream.IStream

getCodecInfo, getCreationTime, getName, getScope, getStartTime

Field Details

automaticRecording

protected boolean automaticRecording

Whether or not to automatically record the associated stream.

bytesReceived

protected volatile long bytesReceived

Total number of bytes received.

checkVideoCodec

protected volatile boolean checkVideoCodec

Is there need to check video codec?

checkAudioCodec

protected volatile boolean checkAudioCodec

Is there need to check audio codec?

chunkSize

protected int chunkSize

Data is sent by chunks, each of them has size

closed

protected AtomicBoolean closed

Is this stream still active?

connMsgOut

protected transient IMessageOutput connMsgOut

Output endpoint that providers use

firstPacketTime

protected long firstPacketTime

Stores timestamp of first packet

livePipe

protected transient IPipe livePipe

Pipe for live streaming

publishedName

protected String publishedName

Stream published name

parameters

protected Map<String,String> parameters

Streaming parameters

sendStartNotification

protected boolean sendStartNotification

Is there need to send start notification?

listeners

protected transient Set<IStreamListener> listeners

Listeners to get notified about received packets.

recordingListener

protected transient WeakReference<IRecordingListener> recordingListener

Recording listener

latestTimeStamp

protected volatile long latestTimeStamp

registerJMX

protected boolean registerJMX

Whether or not to register with JMX.

localAliases

protected static CopyOnWriteArraySet<String> localAliases

Stream name aliases for the entire server instance.

nameAlias

protected String nameAlias

Publish alias for the stream name.

aliases

protected CopyOnWriteArraySet<String> aliases

Subscribe aliases for this instance.

Constructor Details

ClientBroadcastStream

public ClientBroadcastStream()

Method Details

checkSendNotifications

protected void checkSendNotifications(IEvent event)

Check and send notification if necessary

Parameters:

event - Event

close

public void close()

Closes stream, unsubscribes provides, sends stoppage notifications and broadcast close notification.

Specified by:

close in interface ClientBroadcastStreamMXBean

Specified by:

close in interface IStream

dispatchEvent

public void dispatchEvent(IEvent event)

Dispatches event

Specified by:

dispatchEvent in interface IEventDispatcher

Parameters:

event - Event to dispatch

getActiveSubscribers

public int getActiveSubscribers()

Return current number of subscribers.

Specified by:

getActiveSubscribers in interface IClientBroadcastStreamStatistics

Returns:

number of subscribers

getBytesReceived

public long getBytesReceived()

Return total number of bytes received from client for this stream.

Specified by:

getBytesReceived in interface IClientBroadcastStreamStatistics

Returns:

number of bytes

getCurrentTimestamp

public int getCurrentTimestamp()

Return the currently active timestamp inside the stream.

Specified by:

getCurrentTimestamp in interface IStreamStatistics

Returns:

the timestamp in milliseconds

getMaxSubscribers

public int getMaxSubscribers()

Return maximum number of concurrent subscribers.

Specified by:

getMaxSubscribers in interface IClientBroadcastStreamStatistics

Returns:

number of subscribers

getProvider

public IProvider getProvider()

Getter for provider

Specified by:

getProvider in interface IBroadcastStream

Returns:

Provider

setPublishedName

public void setPublishedName(String name)

Setter for stream published name

Specified by:

setPublishedName in interface ClientBroadcastStreamMXBean

Specified by:

setPublishedName in interface IBroadcastStream

Parameters:

name - Name that used for publishing. Set at client side when begin to broadcast with NetStream#publish.

getPublishedName

public String getPublishedName()

Getter for published name

Specified by:

getPublishedName in interface ClientBroadcastStreamMXBean

Specified by:

getPublishedName in interface IBroadcastStream

Specified by:

getPublishedName in interface IClientBroadcastStreamStatistics

Returns:

Stream published name

setParameters

public void setParameters(Map<String,String> params)

Sets streaming parameters as supplied by the publishing application.

Specified by:

setParameters in interface IClientBroadcastStream

Parameters:

params - parameter map

getParameters

public Map<String,String> getParameters()

Returns streaming parameters.

Specified by:

getParameters in interface IClientBroadcastStream

Returns:

parameters

getSaveFilename

public String getSaveFilename()

Get the filename the stream is being saved as.

Specified by:

getSaveFilename in interface ClientBroadcastStreamMXBean

Specified by:

getSaveFilename in interface IBroadcastStream

Specified by:

getSaveFilename in interface IClientBroadcastStreamStatistics

Returns:

The filename relative to the scope or

 null
 

if the stream is not being saved.

getStatistics

public IClientBroadcastStreamStatistics getStatistics()

Return statistics about the stream.

Specified by:

getStatistics in interface IClientBroadcastStream

Returns:

statistics

getTotalSubscribers

public int getTotalSubscribers()

Return total number of subscribers.

Specified by:

getTotalSubscribers in interface IClientBroadcastStreamStatistics

Returns:

number of subscribers

isAutomaticRecording

public boolean isAutomaticRecording()

Returns:

the automaticRecording

setAutomaticRecording

public void setAutomaticRecording(boolean automaticRecording)

Parameters:

automaticRecording - the automaticRecording to set

setRegisterJMX

public void setRegisterJMX(boolean registerJMX)

Parameters:

registerJMX - the registerJMX to set

notifyBroadcastClose

protected void notifyBroadcastClose()

Notifies handler on stream broadcast close

notifyRecordingStop

protected void notifyRecordingStop()

Notifies handler on stream recording stop

notifyBroadcastStart

protected void notifyBroadcastStart()

Notifies handler on stream broadcast start

notifyChunkSize

protected void notifyChunkSize()

Send OOB control message with chunk size

onOOBControlMessage

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

Out-of-band control message handler

Specified by:

onOOBControlMessage in interface IMessageComponent

Parameters:

source - OOB message source

pipe - Pipe that used to send OOB message

oobCtrlMsg - Out-of-band control message

onPipeConnectionEvent

public void onPipeConnectionEvent(PipeConnectionEvent event)

Pipe connection event handler

Specified by:

onPipeConnectionEvent in interface IPipeConnectionListener

Parameters:

event - Pipe connection event

pushMessage

public void pushMessage(IPipe pipe,
 IMessage message)

Currently not implemented

Specified by:

pushMessage in interface IPushableConsumer

Parameters:

pipe - Pipe

message - Message

saveAs

public void saveAs(String name,
 boolean isAppend)
            throws IOException

Save broadcasted stream.

Specified by:

saveAs in interface ClientBroadcastStreamMXBean

Specified by:

saveAs in interface IBroadcastStream

Parameters:

name - Stream name

isAppend - Append mode

Throws:

IOException - File could not be created/written to

sendPublishStartNotify

protected void sendPublishStartNotify()

Sends publish start notifications

sendPublishStopNotify

protected void sendPublishStopNotify()

Sends publish stop notifications

sendRecordFailedNotify

protected void sendRecordFailedNotify(String reason)

Sends record failed notifications

sendRecordStartNotify

protected void sendRecordStartNotify()

Sends record start notifications

sendRecordStopNotify

protected void sendRecordStopNotify()

Sends record stop notifications

pushMessage

protected void pushMessage(StatusMessage msg)

Pushes a message out to a consumer.

Parameters:

msg - StatusMessage

sendStartNotifications

protected void sendStartNotifications(IEventListener source)

start

public void start()

Starts stream, creates pipes, connects

Specified by:

start in interface ClientBroadcastStreamMXBean

Specified by:

start in interface IStream

startPublishing

public void startPublishing()

Notify client that stream is ready for publishing.

Specified by:

startPublishing in interface ClientBroadcastStreamMXBean

Specified by:

startPublishing in interface IClientBroadcastStream

stop

public void stop()

Stop this stream.

Specified by:

stop in interface ClientBroadcastStreamMXBean

Specified by:

stop in interface IStream

stopRecording

public void stopRecording()

Stops any currently active recording.

isRecording

public boolean isRecording()

addStreamListener

public void addStreamListener(IStreamListener listener)

Add a listener to be notified about received packets.

Specified by:

addStreamListener in interface IBroadcastStream

Parameters:

listener - the listener to add

getStreamListeners

public Collection<IStreamListener> getStreamListeners()

Return registered stream listeners.

Specified by:

getStreamListeners in interface IBroadcastStream

Returns:

the registered listeners

removeStreamListener

public void removeStreamListener(IStreamListener listener)

Remove a listener from being notified about received packets.

Specified by:

removeStreamListener in interface IBroadcastStream

Parameters:

listener - the listener to remove

getRecordFile

protected File getRecordFile(IScope scope,
 String name)

Get the file we'd be recording to based on scope and given name.

Parameters:

scope - scope

name - record name

Returns:

file

registerJMX

protected void registerJMX()

unregisterJMX

protected void unregisterJMX()

addAlias

public boolean addAlias(String alias)

Description copied from interface: IClientBroadcastStream

Adds a stream name subscribe-side alias.

Specified by:

addAlias in interface IClientBroadcastStream

Parameters:

alias -

Returns:

true if added to the aliases, false otherwise

hasAlias

public boolean hasAlias()

Description copied from interface: IClientBroadcastStream

Returns whether or not an subscribe-side alias for this stream exists.

Specified by:

hasAlias in interface IClientBroadcastStream

Returns:

true if an alias has been added and false otherwise

getAlias

public String getAlias()

Description copied from interface: IClientBroadcastStream

Returns an subscribe-side alias.

Specified by:

getAlias in interface IClientBroadcastStream

Returns:

alias if at least one exists or null when there are none

containsAlias

public boolean containsAlias(String alias)

Description copied from interface: IClientBroadcastStream

Returns whether or not a given subscribe-side alias exists.

Specified by:

containsAlias in interface IClientBroadcastStream

Parameters:

alias -

Returns:

true if found and false otherwise

getAliases

public Set<String> getAliases()

Description copied from interface: IClientBroadcastStream

Returns all the subscribe-side aliases.

Specified by:

getAliases in interface IClientBroadcastStream

Returns:

all aliases for this instance or an empty set

setNameAlias

public void setNameAlias(String nameAlias)

Description copied from interface: IClientBroadcastStream

Sets the publish-side alias for the streams name. Subsequent calls will replace an existing alias if already set.

Specified by:

setNameAlias in interface IClientBroadcastStream

Parameters:

nameAlias - alias to set for the streams name or null to clear it

getNameAlias

public String getNameAlias()

Description copied from interface: IClientBroadcastStream

Returns the publish-side alias, if configured.

Specified by:

getNameAlias in interface IClientBroadcastStream

Returns:

alias for the streams name or null if not set

aliasRegistered

public boolean aliasRegistered(String alias)

Description copied from interface: IClientBroadcastStream

Returns whether or not an alias is in-use / registered already; this includes both publish and subscribe aliases within a server instance.

Specified by:

aliasRegistered in interface IClientBroadcastStream

Parameters:

alias - the name to check against publish and subscribe aliases

Returns:

true if registered and false otherwise