org.red5.server.api.stream

Interface IStreamCapableConnection

All Superinterfaces:

AttributeStoreMXBean, IAttributeStore, ICastingAttributeStore, IConnection, ICoreObject, IEventDispatcher, IEventHandler, IEventListener

All Known Implementing Classes:

RTMPConnection, RTMPMinaConnection

public interface IStreamCapableConnection
extends IConnection

A connection that supports streaming.

Author:

The Red5 Project, Luke Hubbard (luke@codegent.com), Steven Gong (steven.gong@gmail.com)

Nested Class Summary

Nested classes/interfaces inherited from interface org.red5.server.api.IConnection

IConnection.Duty, IConnection.Encoding, IConnection.Type

Method Summary

Modifier and Type	Method and Description
void	deleteStreamById(Number streamId) Deletes the stream with the given id.
long	getPendingVideoMessages(Number streamId) Total number of video messages that are pending to be sent to a stream.
IClientStream	getStreamById(Number streamId) Get a stream by its id.
Map<Number,IClientStream>	getStreamsMap()
IClientBroadcastStream	newBroadcastStream(Number streamId) Create a broadcast stream.
IPlaylistSubscriberStream	newPlaylistSubscriberStream(Number streamId) Create a stream that can play a list.
ISingleItemSubscriberStream	newSingleItemSubscriberStream(Number streamId) Create a stream that can play only one item.
Number	reserveStreamId() Return a reserved stream id for use.
Number	reserveStreamId(Number streamId) Return a reserved stream id for use with a preference for the one supplied.
void	unreserveStreamId(Number streamId) Unreserve this id for future use.

Methods inherited from interface org.red5.server.api.IConnection

addListener, close, connect, connect, getBasicScopes, getClient, getClientBytesRead, getConnectParams, getDroppedMessages, getDuty, getEncoding, getHost, getLastPingTime, getPath, getPendingMessages, getProtocol, getReadBytes, getReadMessages, getRemoteAddress, getRemoteAddresses, getRemotePort, getScope, getSessionId, getStreamId, getType, getWrittenBytes, getWrittenMessages, initialize, isConnected, ping, removeListener, setBandwidth, setClient, setStreamId

Methods inherited from interface org.red5.server.api.event.IEventDispatcher

dispatchEvent

Methods inherited from interface org.red5.server.api.event.IEventHandler

handleEvent

Methods inherited from interface org.red5.server.api.event.IEventListener

notifyEvent

Methods inherited from interface org.red5.server.api.ICastingAttributeStore

getBoolAttribute, getByteAttribute, getDoubleAttribute, getIntAttribute, getListAttribute, getLongAttribute, getMapAttribute, getSetAttribute, getShortAttribute, getStringAttribute

Methods inherited from interface org.red5.server.api.IAttributeStore

getAttribute, getAttribute, getAttributeNames, getAttributes, hasAttribute, removeAttribute, removeAttributes, setAttribute, setAttributes, setAttributes, size

Method Detail

reserveStreamId

Number reserveStreamId()
                throws IndexOutOfBoundsException

Return a reserved stream id for use. According to FCS/FMS regulation, the base is 1.

Returns:

Reserved stream id

Throws:

IndexOutOfBoundsException - when it is impossible to reserve new stream

reserveStreamId

Number reserveStreamId(Number streamId)
                throws IndexOutOfBoundsException

Return a reserved stream id for use with a preference for the one supplied.

Parameters:

streamId - supplied stream id

Returns:

Reserved stream id

Throws:

IndexOutOfBoundsException - when it is impossible to reserve new stream

unreserveStreamId

void unreserveStreamId(Number streamId)

Unreserve this id for future use.

Parameters:

streamId - ID of stream to unreserve

deleteStreamById

void deleteStreamById(Number streamId)

Deletes the stream with the given id.

Parameters:

streamId - ID of stream to delete

getStreamById

IClientStream getStreamById(Number streamId)

Get a stream by its id.

Parameters:

streamId - Stream id

Returns:

Stream with given id

newSingleItemSubscriberStream

ISingleItemSubscriberStream newSingleItemSubscriberStream(Number streamId)

Create a stream that can play only one item.

Parameters:

streamId - Stream id

Returns:

New subscriber stream that can play only one item

newPlaylistSubscriberStream

IPlaylistSubscriberStream newPlaylistSubscriberStream(Number streamId)

Create a stream that can play a list.

Parameters:

streamId - Stream id

Returns:

New stream that can play sequence of items

newBroadcastStream

IClientBroadcastStream newBroadcastStream(Number streamId)

Create a broadcast stream.

Parameters:

streamId - Stream id

Returns:

New broadcast stream

getPendingVideoMessages

long getPendingVideoMessages(Number streamId)

Total number of video messages that are pending to be sent to a stream.

Parameters:

streamId - Stream id

Returns:

Number of pending video messages

getStreamsMap

Map<Number,IClientStream> getStreamsMap()