net.majorkernelpanic.streaming

Interface Stream

All Known Implementing Classes:

AACStream, AMRNBStream, AudioStream, H263Stream, H264Stream, MediaStream, VideoStream

public interface Stream

An interface that represents a Stream.

Method Summary

Modifier and Type	Method and Description
void	configure() Configures the stream.
long	getBitrate() Returns an approximation of the bit rate consumed by the stream in bit per seconde.
int[]	getDestinationPorts() Returns a pair of destination ports, the first one is the one used for RTP and the second one is used for RTCP.
int[]	getLocalPorts() Returns a pair of source ports, the first one is the one used for RTP and the second one is used for RTCP.
java.lang.String	getSessionDescription() Returns a description of the stream using SDP.
int	getSSRC() Returns the SSRC of the underlying RtpSocket.
boolean	isStreaming()
void	setDestinationAddress(java.net.InetAddress dest) Sets the destination ip address of the stream.
void	setDestinationPorts(int dport) Sets the destination ports of the stream.
void	setDestinationPorts(int rtpPort, int rtcpPort) Sets the destination ports of the stream.
void	setOutputStream(java.io.OutputStream stream, byte channelIdentifier) If a TCP is used as the transport protocol for the RTP session, the output stream to which RTP packets will be written to must be specified with this method.
void	setTimeToLive(int ttl) Sets the Time To Live of packets sent over the network.
void	start() Starts the stream.
void	stop() Stops the stream.

Method Detail

configure

void configure()
        throws java.lang.IllegalStateException,
               java.io.IOException

Configures the stream. You need to call this before calling getSessionDescription() to apply your configuration of the stream.

Throws:

java.lang.IllegalStateException

java.io.IOException

start

void start()
    throws java.lang.IllegalStateException,
           java.io.IOException

Starts the stream. This method can only be called after configure().

Throws:

java.lang.IllegalStateException

java.io.IOException

stop

void stop()

Stops the stream.

setTimeToLive

void setTimeToLive(int ttl)
            throws java.io.IOException

Sets the Time To Live of packets sent over the network.

Parameters:

ttl - The time to live

Throws:

java.io.IOException

setDestinationAddress

void setDestinationAddress(java.net.InetAddress dest)

Sets the destination ip address of the stream.

Parameters:

dest - The destination address of the stream

setDestinationPorts

void setDestinationPorts(int dport)

Sets the destination ports of the stream. If an odd number is supplied for the destination port then the next lower even number will be used for RTP and it will be used for RTCP. If an even number is supplied, it will be used for RTP and the next odd number will be used for RTCP.

Parameters:

dport - The destination port

setDestinationPorts

void setDestinationPorts(int rtpPort,
                         int rtcpPort)

Sets the destination ports of the stream.

Parameters:

rtpPort - Destination port that will be used for RTP

rtcpPort - Destination port that will be used for RTCP

setOutputStream

void setOutputStream(java.io.OutputStream stream,
                     byte channelIdentifier)

If a TCP is used as the transport protocol for the RTP session, the output stream to which RTP packets will be written to must be specified with this method.

getLocalPorts

int[] getLocalPorts()

Returns a pair of source ports, the first one is the one used for RTP and the second one is used for RTCP.

getDestinationPorts

int[] getDestinationPorts()

Returns a pair of destination ports, the first one is the one used for RTP and the second one is used for RTCP.

getSSRC

int getSSRC()

Returns the SSRC of the underlying RtpSocket.

Returns:

the SSRC of the stream.

getBitrate

long getBitrate()

Returns an approximation of the bit rate consumed by the stream in bit per seconde.

getSessionDescription

java.lang.String getSessionDescription()
                                throws java.lang.IllegalStateException

Returns a description of the stream using SDP. This method can only be called after configure().

Throws:

java.lang.IllegalStateException - Thrown when configure() wa not called.

isStreaming

boolean isStreaming()