org.red5.server.stream

Class SingleItemSubscriberStream

java.lang.Object

org.red5.server.stream.AbstractStream

org.red5.server.stream.AbstractClientStream

org.red5.server.stream.SingleItemSubscriberStream

All Implemented Interfaces:

IClientStream, ISingleItemSubscriberStream, IStream, ISubscriberStream

public class SingleItemSubscriberStream
extends AbstractClientStream
implements ISingleItemSubscriberStream

Stream of a single play item for a subscriber

Author:

Paul Gregoire (mondain@gmail.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SingleItemSubscriberStream.Notifier Handles notifications in a separate thread.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	bufferCheckInterval Interval in ms to check for buffer underruns in VOD streams.
protected long	creationTime Timestamp this stream was created.
protected PlayEngine	engine Plays items back
protected Set<String>	jobs Scheduled job names
protected ISchedulingService	schedulingService Service used to provide notifications, keep client buffer filled, clean up, etc...
protected int	underrunTrigger Number of pending messages at which a

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

lock, startTime, state

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

MODE_APPEND, MODE_LIVE, MODE_PUBLISH, MODE_READ, MODE_RECORD

Constructor Summary

Constructors

Constructor and Description
SingleItemSubscriberStream()

Method Summary

Modifier and Type	Method and Description
void	cancelJob(String jobName) Cancels a scheduled job by name.
void	close() Close this stream.
boolean	isPaused() Check if the stream is currently paused.
void	onChange(StreamState state, Object... changed) Notification of state change and associated parameters.
void	pause(int position) Pause at a position for current playing item.
void	play() Start playing.
void	receiveAudio(boolean receive) Should the stream send audio to the client?
void	receiveVideo(boolean receive) Should the stream send video to the client?
void	resume(int position) Resume from a position for current playing item.
String	scheduleOnceJob(IScheduledJob job) Schedule a job to be executed only once after a 10ms delay.
String	scheduleWithFixedDelay(IScheduledJob job, int interval) Schedule a job to be executed regularly at the given interval.
void	seek(int position) Seek into a position for current playing item.
void	setBufferCheckInterval(int bufferCheckInterval) Set interval to check for buffer underruns.
void	setPlayItem(IPlayItem item) Setter for property 'playItem'.
void	setUnderrunTrigger(int underrunTrigger) Set maximum number of pending messages at which a
void	start() Start this stream.
void	stop() Stop playing.

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

getBroadcastStreamPublishName, getClientBufferDuration, getConnection, getStreamId, setBroadcastStreamPublishName, setClientBufferDuration, setConnection, 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.ISubscriberStream

getState, setState

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

getBroadcastStreamPublishName, getClientBufferDuration, getConnection, getStreamId, setBroadcastStreamPublishName, setClientBufferDuration

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

getCodecInfo, getCreationTime, getName, getScope, getStartTime

Field Detail

schedulingService

protected ISchedulingService schedulingService

Service used to provide notifications, keep client buffer filled, clean up, etc...

jobs

protected Set<String> jobs

Scheduled job names

bufferCheckInterval

protected int bufferCheckInterval

Interval in ms to check for buffer underruns in VOD streams.

underrunTrigger

protected int underrunTrigger

Number of pending messages at which a

 NetStream.Play.InsufficientBW
 

message is generated for VOD streams.

creationTime

protected long creationTime

Timestamp this stream was created.

engine

protected PlayEngine engine

Plays items back

Constructor Detail

SingleItemSubscriberStream

public SingleItemSubscriberStream()

Method Detail

setPlayItem

public void setPlayItem(IPlayItem item)

Description copied from interface: ISingleItemSubscriberStream

Setter for property 'playItem'.

Specified by:

setPlayItem in interface ISingleItemSubscriberStream

Parameters:

item - Value to set for property 'playItem'.

play

public void play()
          throws IOException

Description copied from interface: ISubscriberStream

Start playing.

Specified by:

play in interface ISubscriberStream

Throws:

IOException - if an IO error occurred while starting to play the stream

pause

public void pause(int position)

Pause at a position for current playing item.

Specified by:

pause in interface ISubscriberStream

Parameters:

position - Position for pause in millisecond.

resume

public void resume(int position)

Resume from a position for current playing item.

Specified by:

resume in interface ISubscriberStream

Parameters:

position - Position for resume in millisecond.

stop

public void stop()

Stop playing.

Specified by:

stop in interface IStream

Specified by:

stop in interface ISubscriberStream

seek

public void seek(int position)
          throws OperationNotSupportedException

Seek into a position for current playing item.

Specified by:

seek in interface ISubscriberStream

Parameters:

position - Position for seek in millisecond.

Throws:

OperationNotSupportedException - if the stream doesn't support seeking.

isPaused

public boolean isPaused()

Description copied from interface: ISubscriberStream

Check if the stream is currently paused.

Specified by:

isPaused in interface ISubscriberStream

Returns:

stream is paused

receiveVideo

public void receiveVideo(boolean receive)

Should the stream send video to the client?

Specified by:

receiveVideo in interface ISubscriberStream

Parameters:

receive - toggle

receiveAudio

public void receiveAudio(boolean receive)

Should the stream send audio to the client?

Specified by:

receiveAudio in interface ISubscriberStream

Parameters:

receive - toggle

setBufferCheckInterval

public void setBufferCheckInterval(int bufferCheckInterval)

Set interval to check for buffer underruns. Set to

 0
 

to disable.

Parameters:

bufferCheckInterval - interval in ms

setUnderrunTrigger

public void setUnderrunTrigger(int underrunTrigger)

Set maximum number of pending messages at which a

 NetStream.Play.InsufficientBW
 

message will be generated for VOD streams

Parameters:

underrunTrigger - the maximum number of pending messages

start

public void start()

Description copied from interface: IStream

Start this stream.

Specified by:

start in interface IStream

close

public void close()

Description copied from interface: IStream

Close this stream.

Specified by:

close in interface IStream

onChange

public void onChange(StreamState state,
                     Object... changed)

Notification of state change and associated parameters.

Specified by:

onChange in interface ISubscriberStream

Parameters:

state - new state

changed - parameters associated with the change

scheduleOnceJob

public String scheduleOnceJob(IScheduledJob job)

Schedule a job to be executed only once after a 10ms delay.

Specified by:

scheduleOnceJob in interface ISubscriberStream

Parameters:

job - scheduled job

Returns:

jobName

scheduleWithFixedDelay

public String scheduleWithFixedDelay(IScheduledJob job,
                                     int interval)

Schedule a job to be executed regularly at the given interval.

Specified by:

scheduleWithFixedDelay in interface ISubscriberStream

Parameters:

job - scheduled job

interval - interval

Returns:

jobName

cancelJob

public void cancelJob(String jobName)

Cancels a scheduled job by name.

Specified by:

cancelJob in interface ISubscriberStream

Parameters:

jobName - job name