com.smaxe.uv.client.rtsp

Class RtspClient

java.lang.Object

com.smaxe.uv.client.rtsp.RtspClient

public final class RtspClient
extends java.lang.Object

RtspClient - JUV RTSP/RTP Client.

Note:
- RtspClient.Configuration#SOCKET defines RTSP TCP/IP socket configuration.
- RtspClient.Configuration#DATAGRAM defines RTP UDP/IP datagram socket configuration.
- RTCP UDP/IP datagram socket uses default configuration.

Version:

1.3.0

Author:

Andrei Sochirca

See Also:

JUV RTSP/RTP Client

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RtspClient.Configuration Configuration - RtspClient configuration constants.
static interface	RtspClient.IListener IListener - RTSP Client listener.
static interface	RtspClient.IRtcpHandler IRtcpHandler - RTCP handler.
static class	RtspClient.ListenerAdapter ListenerAdapter - RtspClient.IListener adapter.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_JITTER_BUFFER_MARGIN DEFAULT_JITTER_BUFFER_MARGIN - default jitter buffer margin = 8.
static int	STATE_DISCONNECTED STATE_DISCONNECTED - 0
static int	STATE_INIT STATE_INIT - 1
static int	STATE_PLAYING STATE_PLAYING - 3
static int	STATE_READY STATE_READY - 2
static int	STATE_RECORDING STATE_RECORDING - 4

Constructor Summary

Constructors

Constructor and Description
RtspClient() Constructor.
RtspClient(java.util.concurrent.ExecutorService dispatcher, java.util.concurrent.ScheduledExecutorService scheduler) Constructor.
RtspClient(java.util.Map<java.lang.String,java.lang.Object> configuration) Constructor.
RtspClient(java.util.Map<java.lang.String,java.lang.Object> configuration, java.util.concurrent.ExecutorService dispatcher, java.util.concurrent.ScheduledExecutorService scheduler) Constructor.
RtspClient(java.util.Map<java.lang.String,java.lang.Object> configuration, java.util.concurrent.ExecutorService dispatcher, java.util.concurrent.ScheduledExecutorService scheduler, RtpUdpSessionManager sessionManager) Constructor.
RtspClient(RtspClient client) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(RtspClient.IListener listener) Adds a new listener.
RtspRecordSession	announce(IPresentation presentation) Announces presentation record.
void	close() Closes the connection.
void	close(java.lang.String reason) Closes the connection.
java.util.Map<java.lang.String,java.lang.Object>	configuration() Returns configuration.
void	connect(java.lang.String url) Connects to the server and requests supported options.
static IPresentation	createPartOfPresentation(IPresentation presentation, int[] media) Creates part of presentation that contains only media indices of the presentation.
static IPresentation	createPartOfPresentationAudioOnly(IPresentation presentation) Creates audio only presentation part.
static IPresentation	createPartOfPresentationVideoOnly(IPresentation presentation) Creates video only presentation part.
RtspPlaySession	createPlaySession(IPresentation presentation) Creates a RTSP session for the presentation playback.
static java.lang.String	createRangeNpt(int start) Creates 'Range' header.
static java.lang.String	createRangeNpt(int start, int duration) Creates 'Range' header.
RtpMulticastPlaySession	createRtpMulticastPlaySession(IPresentation presentation) Creates RTP multicast session for the presentation playback.
static IPresentation	createSdpPresentation(byte[] sdp) Creates SDP IPresentation from sdp bytes.
static IPresentation	createSdpPresentation(java.lang.String sdp) Creates SDP IPresentation from sdp string.
static IPresentation	createSdpPresentation(java.lang.String contentBase, byte[] sdp) Creates SDP IPresentation from sdp bytes.
static IPresentation	createSdpPresentation(java.lang.String contentBase, MediaTrackInfo[] tracks) Creates SDP IPresentation from tracks.
IPresentation	describe(java.lang.String url) Retrieves url presentation description.
java.lang.String	getParameter(java.lang.String parameter) Retrieves server parameter value.
static long	getPresentationDuration(IPresentation presentation) Returns presentation duration (in milliseconds).
static MediaTrackInfo[]	getPresentationTracks(IPresentation presentation) Returns presentation media tracks.
ProtocolLayerInfo	getRtspInfo() Returns RTSP connection info (read/written bytes/packets).
int	getState() Returns client state (one of STATE_* constants).
static java.lang.String	getStateDescription(int state) Returns state description by state id.
java.lang.String[]	getSupportedOptions() Returns options supported by server.
static boolean	isLivePresentation(IPresentation presentation) Checks presentation status ("live" or "recorded").
static boolean	isOK(int[] status) Checks status codes.
UnicastUdpTransport	prepareUnicastUdpTransport() Prepares unicast UDP transport.
UnicastUdpTransport	prepareUnicastUdpTransport(int ports) Prepares unicast UDP transport.
void	release() Releases the resources.
void	removeListener(RtspClient.IListener listener) Removes the listener.
static void	setLicenseKey(byte[] key) Sets license key.
void	setParameter(java.lang.String parameter, java.lang.String value) Sets server parameter value.
void	setReleaseOnDisconnection(boolean release) Sets flag to release resources on disconnection.

Methods inherited from class java.lang.Object

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

Field Detail

STATE_DISCONNECTED

public static final int STATE_DISCONNECTED

STATE_DISCONNECTED - 0

STATE_INIT

public static final int STATE_INIT

STATE_INIT - 1

STATE_READY

public static final int STATE_READY

STATE_READY - 2

STATE_PLAYING

public static final int STATE_PLAYING

STATE_PLAYING - 3

STATE_RECORDING

public static final int STATE_RECORDING

STATE_RECORDING - 4

DEFAULT_JITTER_BUFFER_MARGIN

public static final int DEFAULT_JITTER_BUFFER_MARGIN

DEFAULT_JITTER_BUFFER_MARGIN - default jitter buffer margin = 8.

See Also:

Constant Field Values

Constructor Detail

RtspClient

public RtspClient()

Constructor.

RtspClient

public RtspClient(RtspClient client)

Constructor.

Parameters:

client -

RtspClient

public RtspClient(java.util.Map<java.lang.String,java.lang.Object> configuration)

Constructor.

Parameters:

configuration -

RtspClient

public RtspClient(java.util.concurrent.ExecutorService dispatcher,
          java.util.concurrent.ScheduledExecutorService scheduler)

Constructor.

Parameters:

dispatcher - dispatcher

scheduler - scheduler

RtspClient

public RtspClient(java.util.Map<java.lang.String,java.lang.Object> configuration,
          java.util.concurrent.ExecutorService dispatcher,
          java.util.concurrent.ScheduledExecutorService scheduler)

Constructor.

Parameters:

configuration -

dispatcher - dispatcher

scheduler - scheduler

RtspClient

public RtspClient(java.util.Map<java.lang.String,java.lang.Object> configuration,
          java.util.concurrent.ExecutorService dispatcher,
          java.util.concurrent.ScheduledExecutorService scheduler,
          RtpUdpSessionManager sessionManager)

Constructor.

Parameters:

configuration -

dispatcher - dispatcher

scheduler - scheduler

sessionManager -

Method Detail

getStateDescription

public static java.lang.String getStateDescription(int state)

Returns state description by state id.

Parameters:

state - state id

Returns:

state description

createPartOfPresentation

public static IPresentation createPartOfPresentation(IPresentation presentation,
                                     int[] media)

Creates part of presentation that contains only media indices of the presentation.

Parameters:

presentation -

media - media indices of the presentation to use

Returns:

presentation

createPartOfPresentationAudioOnly

public static IPresentation createPartOfPresentationAudioOnly(IPresentation presentation)

Creates audio only presentation part.

Parameters:

presentation -

Returns:

audio only presentation

createPartOfPresentationVideoOnly

public static IPresentation createPartOfPresentationVideoOnly(IPresentation presentation)

Creates video only presentation part.

Parameters:

presentation -

Returns:

video only presentation

createSdpPresentation

public static IPresentation createSdpPresentation(java.lang.String sdp)

Creates SDP IPresentation from sdp string.

Parameters:

sdp -

Returns:

presentation

createSdpPresentation

public static IPresentation createSdpPresentation(byte[] sdp)

Creates SDP IPresentation from sdp bytes.

Parameters:

sdp -

Returns:

presentation

createSdpPresentation

public static IPresentation createSdpPresentation(java.lang.String contentBase,
                                  byte[] sdp)

Creates SDP IPresentation from sdp bytes.

Parameters:

contentBase -

sdp -

Returns:

presentation

createSdpPresentation

public static IPresentation createSdpPresentation(java.lang.String contentBase,
                                  MediaTrackInfo[] tracks)

Creates SDP IPresentation from tracks.

Parameters:

contentBase -

tracks -

Returns:

presentation

getPresentationDuration

public static long getPresentationDuration(IPresentation presentation)

Returns presentation duration (in milliseconds).

Parameters:

presentation -

Returns:

presentation duration (in milliseconds), negative for live presentation

getPresentationTracks

public static MediaTrackInfo[] getPresentationTracks(IPresentation presentation)

Returns presentation media tracks.

Parameters:

presentation -

Returns:

presentation media tracks

isLivePresentation

public static boolean isLivePresentation(IPresentation presentation)

Checks presentation status ("live" or "recorded").

Parameters:

presentation -

Returns:

true for live presentation; false for recorded presentation

isOK

public static boolean isOK(int[] status)

Checks status codes.

Parameters:

status -

Returns:

true if all status codes are 200; otherwise false

createRangeNpt

public static java.lang.String createRangeNpt(int start)

Creates 'Range' header.

Parameters:

start - start timestamp (in milliseconds)

Returns:

"npt=" + start

createRangeNpt

public static java.lang.String createRangeNpt(int start,
                              int duration)

Creates 'Range' header.

Parameters:

start - start timestamp (in milliseconds)

duration - duration (in milliseconds)

Returns:

"npt=" + start + "-" + duration

prepareUnicastUdpTransport

public UnicastUdpTransport prepareUnicastUdpTransport()

Prepares unicast UDP transport.

Returns:

UnicastUdpTransport instance

prepareUnicastUdpTransport

public UnicastUdpTransport prepareUnicastUdpTransport(int ports)

Prepares unicast UDP transport.

Parameters:

ports - number of UDP ports to open

Returns:

UnicastUdpTransport instance

getRtspInfo

public final ProtocolLayerInfo getRtspInfo()

Returns RTSP connection info (read/written bytes/packets).

Returns:

overall RTSP connection info

getState

public final int getState()

Returns client state (one of STATE_* constants).

Returns:

client state

getSupportedOptions

public final java.lang.String[] getSupportedOptions()

Returns options supported by server.

Returns:

options supported by server

configuration

public java.util.Map<java.lang.String,java.lang.Object> configuration()

Returns configuration. Check RtspClient.Configuration class constants for configuration properties.

Returns:

configuration

addListener

public void addListener(RtspClient.IListener listener)

Adds a new listener.

Parameters:

listener -

removeListener

public void removeListener(RtspClient.IListener listener)

Removes the listener.

Parameters:

listener -

setReleaseOnDisconnection

public void setReleaseOnDisconnection(boolean release)

Sets flag to release resources on disconnection.

Parameters:

release - true to invoke on release() on disconnection; otherwise false

createRtpMulticastPlaySession

public RtpMulticastPlaySession createRtpMulticastPlaySession(IPresentation presentation)

Creates RTP multicast session for the presentation playback.

Parameters:

presentation -

Returns:

play session

connect

public void connect(java.lang.String url)
             throws java.lang.Exception

Connects to the server and requests supported options.

Note:
- Method blocks until 'OPTIONS' response is received.

Parameters:

url - server url

Throws:

java.lang.Exception - if an exception occurred

getParameter

public java.lang.String getParameter(java.lang.String parameter)
                              throws java.lang.IllegalStateException,
                                     RtspMethodException

Retrieves server parameter value.

Note:
- Method blocks until 'GET_PARAMETER' response is received.

Parameters:

parameter - parameter name

Returns:

parameter value

Throws:

java.lang.IllegalStateException - if connection is not established or closed

RtspMethodException - if response status code is different from 2xx.

setParameter

public void setParameter(java.lang.String parameter,
                java.lang.String value)
                  throws java.lang.IllegalStateException,
                         RtspMethodException

Sets server parameter value.

Note:
- Method blocks until 'SET_PARAMETER' response is received.

Parameters:

parameter - parameter name

value - parameter value

Throws:

java.lang.IllegalStateException - if connection is not established or closed

RtspMethodException - if response status code is different from 2xx.

describe

public IPresentation describe(java.lang.String url)
                       throws java.lang.IllegalStateException,
                              RtspMethodException

Retrieves url presentation description.

Note:
- Method blocks until 'DESCRIBE' response is received.

Parameters:

url -

Returns:

presentation

Throws:

java.lang.IllegalStateException - if connection is not established or closed

RtspMethodException - if response status code is different from 2xx.

createPlaySession

public RtspPlaySession createPlaySession(IPresentation presentation)
                                  throws java.lang.IllegalArgumentException

Creates a RTSP session for the presentation playback.

Parameters:

presentation -

Returns:

play session

Throws:

java.lang.IllegalArgumentException - if presentation parameter is illegal

announce

public RtspRecordSession announce(IPresentation presentation)
                           throws java.lang.IllegalStateException,
                                  RtspMethodException

Announces presentation record.

Parameters:

presentation -

Returns:

record session

Throws:

java.lang.IllegalStateException - if connection is not established or closed

RtspMethodException - if response status code is different from 2xx.

close

public void close()

Closes the connection.

close

public void close(java.lang.String reason)

Closes the connection.

Parameters:

reason -

release

public void release()

Releases the resources.

setLicenseKey

public static void setLicenseKey(byte[] key)

Sets license key.

Parameters:

key - license key