net.majorkernelpanic.streaming.rtsp

Class RtspClient

java.lang.Object

net.majorkernelpanic.streaming.rtsp.RtspClient

public class RtspClient
extends java.lang.Object

RFC 2326. A basic and asynchronous RTSP client. The original purpose of this class was to implement a small RTSP client compatible with Wowza. It implements Digest Access Authentication according to RFC 2069.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RtspClient.Callback The callback interface you need to implement to know what's going on with the RTSP server (for example your Wowza Media Server).

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_CONNECTION_FAILED Message sent when the connection to the RTSP server failed.
static int	ERROR_CONNECTION_LOST Message sent when the connection with the RTSP server has been lost for some reason (for example, the user is going under a bridge).
static int	ERROR_WRONG_CREDENTIALS Message sent when the credentials are wrong.
static int	MESSAGE_CONNECTION_RECOVERED Message sent when the connection with the RTSP server has been reestablished.
static java.lang.String	TAG
static int	TRANSPORT_TCP Use this to use TCP for the transport protocol.
static int	TRANSPORT_UDP Use this to use UDP for the transport protocol.

Constructor Summary

Constructors

Constructor and Description
RtspClient()

Method Summary

Modifier and Type	Method and Description
Session	getSession()
boolean	isStreaming()
void	release()
void	setCallback(RtspClient.Callback cb) Sets the callback interface that will be called on status updates of the connection with the RTSP server.
void	setCredentials(java.lang.String username, java.lang.String password) If authentication is enabled on the server, you need to call this with a valid login/password pair.
void	setServerAddress(java.lang.String host, int port) Sets the destination address of the RTSP server.
void	setSession(Session session) The Session that will be used to stream to the server.
void	setStreamPath(java.lang.String path) The path to which the stream will be sent to.
void	setTransportMode(int mode) Call this with TRANSPORT_TCP or 0 to choose the transport protocol that will be used to send RTP/RTCP packets.
void	startStream() Connects to the RTSP server to publish the stream, and the effectively starts streaming.
void	stopStream() Stops the stream, and informs the RTSP server.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

ERROR_CONNECTION_FAILED

public static final int ERROR_CONNECTION_FAILED

Message sent when the connection to the RTSP server failed.

See Also:

Constant Field Values

ERROR_WRONG_CREDENTIALS

public static final int ERROR_WRONG_CREDENTIALS

Message sent when the credentials are wrong.

See Also:

Constant Field Values

TRANSPORT_UDP

public static final int TRANSPORT_UDP

Use this to use UDP for the transport protocol.

See Also:

Constant Field Values

TRANSPORT_TCP

public static final int TRANSPORT_TCP

Use this to use TCP for the transport protocol.

See Also:

Constant Field Values

ERROR_CONNECTION_LOST

public static final int ERROR_CONNECTION_LOST

Message sent when the connection with the RTSP server has been lost for some reason (for example, the user is going under a bridge). When the connection with the server is lost, the client will automatically try to reconnect as long as stopStream() is not called.

See Also:

Constant Field Values

MESSAGE_CONNECTION_RECOVERED

public static final int MESSAGE_CONNECTION_RECOVERED

Message sent when the connection with the RTSP server has been reestablished. When the connection with the server is lost, the client will automatically try to reconnect as long as stopStream() is not called.

See Also:

Constant Field Values

Constructor Detail

RtspClient

public RtspClient()

Method Detail

setCallback

public void setCallback(RtspClient.Callback cb)

Sets the callback interface that will be called on status updates of the connection with the RTSP server.

Parameters:

cb - The implementation of the RtspClient.Callback interface

setSession

public void setSession(Session session)

The Session that will be used to stream to the server. If not called before startStream(), a it will be created.

getSession

public Session getSession()

setServerAddress

public void setServerAddress(java.lang.String host,
                             int port)

Sets the destination address of the RTSP server.

Parameters:

host - The destination address

port - The destination port

setCredentials

public void setCredentials(java.lang.String username,
                           java.lang.String password)

If authentication is enabled on the server, you need to call this with a valid login/password pair. Only implements Digest Access Authentication according to RFC 2069.

Parameters:

username - The login

password - The password

setStreamPath

public void setStreamPath(java.lang.String path)

The path to which the stream will be sent to.

Parameters:

path - The path

setTransportMode

public void setTransportMode(int mode)

Call this with TRANSPORT_TCP or 0 to choose the transport protocol that will be used to send RTP/RTCP packets. Not ready yet !

isStreaming

public boolean isStreaming()

startStream

public void startStream()

Connects to the RTSP server to publish the stream, and the effectively starts streaming. You need to call setServerAddress(String, int) and optionally setSession(Session) and setCredentials(String, String) before calling this. Should be called of the main thread !

stopStream

public void stopStream()

Stops the stream, and informs the RTSP server.

release

public void release()