net.majorkernelpanic.streaming

Class MediaStream

java.lang.Object

net.majorkernelpanic.streaming.MediaStream

All Implemented Interfaces:

Stream

Direct Known Subclasses:

AudioStream, VideoStream

public abstract class MediaStream
extends java.lang.Object
implements Stream

A MediaRecorder that streams what it records using a packetizer from the RTP package. You can't use this class directly !

Field Summary

Fields

Modifier and Type	Field and Description
static byte	MODE_MEDIACODEC_API Raw audio/video will be encoded using the MediaCodec API with buffers.
static byte	MODE_MEDIACODEC_API_2 Raw audio/video will be encoded using the MediaCode API with a surface.
static byte	MODE_MEDIARECORDER_API Raw audio/video will be encoded using the MediaRecorder API.
static byte	PIPE_API_LS A LocalSocket will be used to feed the MediaRecorder object
static byte	PIPE_API_PFD A ParcelFileDescriptor will be used to feed the MediaRecorder object

Constructor Summary

Constructors

Constructor and Description
MediaStream()

Method Summary

Modifier and Type	Method and Description
void	configure() Configures the stream with the settings supplied with VideoStream.setVideoQuality(net.majorkernelpanic.streaming.video.VideoQuality) for a VideoStream and AudioStream.setAudioQuality(net.majorkernelpanic.streaming.audio.AudioQuality) for a AudioStream.
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.
AbstractPacketizer	getPacketizer() Returns the packetizer associated with the MediaStream.
abstract java.lang.String	getSessionDescription() Returns a description of the stream using SDP.
int	getSSRC() Returns the SSRC of the underlying RtpSocket.
byte	getStreamingMethod() Returns the streaming method in use, call this after configure() to get an accurate response.
boolean	isStreaming() Indicates if the MediaStream is streaming.
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	setStreamingMethod(byte mode) Sets the streaming method that will be used.
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.

Methods inherited from class java.lang.Object

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

Field Detail

MODE_MEDIARECORDER_API

public static final byte MODE_MEDIARECORDER_API

Raw audio/video will be encoded using the MediaRecorder API.

See Also:

Constant Field Values

MODE_MEDIACODEC_API

public static final byte MODE_MEDIACODEC_API

Raw audio/video will be encoded using the MediaCodec API with buffers.

See Also:

Constant Field Values

MODE_MEDIACODEC_API_2

public static final byte MODE_MEDIACODEC_API_2

Raw audio/video will be encoded using the MediaCode API with a surface.

See Also:

Constant Field Values

PIPE_API_LS

public static final byte PIPE_API_LS

A LocalSocket will be used to feed the MediaRecorder object

See Also:

Constant Field Values

PIPE_API_PFD

public static final byte PIPE_API_PFD

A ParcelFileDescriptor will be used to feed the MediaRecorder object

See Also:

Constant Field Values

Constructor Detail

MediaStream

public MediaStream()

Method Detail

setDestinationAddress

public void setDestinationAddress(java.net.InetAddress dest)

Sets the destination IP address of the stream.

Specified by:

setDestinationAddress in interface Stream

Parameters:

dest - The destination address of the stream

setDestinationPorts

public 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.

Specified by:

setDestinationPorts in interface Stream

Parameters:

dport - The destination port

setDestinationPorts

public void setDestinationPorts(int rtpPort,
                                int rtcpPort)

Sets the destination ports of the stream.

Specified by:

setDestinationPorts in interface Stream

Parameters:

rtpPort - Destination port that will be used for RTP

rtcpPort - Destination port that will be used for RTCP

setOutputStream

public 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.

Specified by:

setOutputStream in interface Stream

setTimeToLive

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

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

Specified by:

setTimeToLive in interface Stream

Parameters:

ttl - The time to live

Throws:

java.io.IOException

getDestinationPorts

public 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.

Specified by:

getDestinationPorts in interface Stream

getLocalPorts

public 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.

Specified by:

getLocalPorts in interface Stream

setStreamingMethod

public void setStreamingMethod(byte mode)

Sets the streaming method that will be used. If the mode is set to MODE_MEDIARECORDER_API, raw audio/video will be encoded using the MediaRecorder API.
If the mode is set to MODE_MEDIACODEC_API or to MODE_MEDIACODEC_API_2, audio/video will be encoded with using the MediaCodec.
The MODE_MEDIACODEC_API_2 mode only concerns VideoStream, it makes use of the createInputSurface() method of the MediaCodec API (Android 4.3 is needed there).

Parameters:

mode - Can be MODE_MEDIARECORDER_API, MODE_MEDIACODEC_API or MODE_MEDIACODEC_API_2

getStreamingMethod

public byte getStreamingMethod()

Returns the streaming method in use, call this after configure() to get an accurate response.

getPacketizer

public AbstractPacketizer getPacketizer()

Returns the packetizer associated with the MediaStream.

Returns:

The packetizer

getBitrate

public long getBitrate()

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

Specified by:

getBitrate in interface Stream

isStreaming

public boolean isStreaming()

Indicates if the MediaStream is streaming.

Specified by:

isStreaming in interface Stream

Returns:

A boolean indicating if the MediaStream is streaming

configure

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

Configures the stream with the settings supplied with VideoStream.setVideoQuality(net.majorkernelpanic.streaming.video.VideoQuality) for a VideoStream and AudioStream.setAudioQuality(net.majorkernelpanic.streaming.audio.AudioQuality) for a AudioStream.

Specified by:

configure in interface Stream

Throws:

java.lang.IllegalStateException

java.io.IOException

start

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

Starts the stream.

Specified by:

start in interface Stream

Throws:

java.lang.IllegalStateException

java.io.IOException

stop

public void stop()

Stops the stream.

Specified by:

stop in interface Stream

getSessionDescription

public abstract java.lang.String getSessionDescription()

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

Specified by:

getSessionDescription in interface Stream

Throws:

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

getSSRC

public int getSSRC()

Returns the SSRC of the underlying RtpSocket.

Specified by:

getSSRC in interface Stream

Returns:

the SSRC of the stream