buzz.getcoco.media

Class Stream

java.lang.Object

buzz.getcoco.media.Stream

Direct Known Subclasses:

RxStream, TxStream

public abstract class Stream
extends java.lang.Object

A construct indicating audio/video stream. Even though it's not limited by type. NOTE: State management MUST be handled in application layer. This class is inherently unmanaged.

   State management include, but not limited to:
   - Calling internalStop() only after  0 != streamHandle
   - Calling sendData(Frame) only after  0 != streamHandle
   - Calling internalStart(StreamStatusListener) only after  0 == streamHandle
 

NOTE:

   - An ideal TXStream's lifecycle would be:
     STARTED -> DESTROYED
   - An ideal RXStream's lifecycle would be:
     CREATED -> STARTED -> STOPPED -> DESTROYED
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stream.State An enum indicating the state of this stream.
static class	Stream.StateException Constructs an illegal state exception with the specified detail message and cause.
static interface	Stream.StreamStatusListener A listener which is used for updating the stream status and passing back the stream data.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Stream(java.lang.String sdp, java.lang.String networkId, int channelId, long streamId)

Method Summary

Modifier and Type	Method and Description
int	getChannelId()
long	getId()
java.lang.String	getNetworkId()
java.lang.String	getSdp()
long	getSourceNodeId() Get the source nodeId of this stream.
Stream.State	getStatus()
protected void	internalSetSourceNodeId(long nodeId)
protected void	internalSetStatus(Stream.State status)
protected void	internalStart(Stream.StreamStatusListener listener) Starts the stream.
protected void	internalStop() Stop listening and sending to the stream.
protected abstract boolean	isTxStream()
protected void	sendData(Frame frame) Send data to other nodes subscribed to this stream.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Stream

protected Stream(java.lang.String sdp,
                 java.lang.String networkId,
                 int channelId,
                 long streamId)

Method Detail

isTxStream

protected abstract boolean isTxStream()

getStatus

public Stream.State getStatus()

getNetworkId

public java.lang.String getNetworkId()

getChannelId

public int getChannelId()

getId

public long getId()

getSdp

public java.lang.String getSdp()

getSourceNodeId

public long getSourceNodeId()

Get the source nodeId of this stream.

Returns:

The id of the originator of the stream.

internalSetSourceNodeId

protected void internalSetSourceNodeId(long nodeId)

internalSetStatus

protected void internalSetStatus(Stream.State status)

internalStart

protected final void internalStart(Stream.StreamStatusListener listener)

Starts the stream. If this is a stream object created by SDK then this will probably be a rx stream for listening from other nodes using Stream.StreamStatusListener.onStreamDataReceived(Frame) else this stream object will be for sending data to other nodes using sendData(Frame)

NOTE: If the stream id is not set. Then a new stream will be created.

Parameters:

listener - The listener for getting the status updates

sendData

protected void sendData(Frame frame)

Send data to other nodes subscribed to this stream.

Parameters:

frame - The audio/video frame which has to be transmitted

Throws:

Stream.StateException - If this is a listening RX stream

internalStop

protected final void internalStop()

Stop listening and sending to the stream. If other nodes are subscribed to this stream They will be notified with Stream.State.STOPPED.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object