javax.media.rtp.rtcp
Class SourceDescription

java.lang.Object
  |
  +--javax.media.rtp.rtcp.SourceDescription

public class SourceDescription

extends java.lang.Object

implements java.io.Serializable

Class to encapsulate a source description item used in RTCP SDES reports.

See Also:

Serialized Form

Field Summary

static int	SOURCE_DESC_CNAME
static int	SOURCE_DESC_EMAIL
static int	SOURCE_DESC_LOC
static int	SOURCE_DESC_NAME
static int	SOURCE_DESC_NOTE
static int	SOURCE_DESC_PHONE
static int	SOURCE_DESC_PRIV
static int	SOURCE_DESC_TOOL

Constructor Summary

SourceDescription(int type, java.lang.String description, int frequency, boolean encrypted)
Constructor.

Method Summary

static java.lang.String	generateCNAME() This function can be used to generate a CNAME using the scheme described in RFC1889.
java.lang.String	getDescription() Get the actual source description string.
boolean	getEncrypted() Should this source description be encrypted?.
int	getFrequency() Get the frequency at which RTCP sends this source description.
int	getType() Get the type of source description this is.
void	setDescription(java.lang.String desc)

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_DESC_CNAME

public static final int SOURCE_DESC_CNAME

SOURCE_DESC_NAME

public static final int SOURCE_DESC_NAME

SOURCE_DESC_EMAIL

public static final int SOURCE_DESC_EMAIL

SOURCE_DESC_PHONE

public static final int SOURCE_DESC_PHONE

SOURCE_DESC_LOC

public static final int SOURCE_DESC_LOC

SOURCE_DESC_TOOL

public static final int SOURCE_DESC_TOOL

SOURCE_DESC_NOTE

public static final int SOURCE_DESC_NOTE

SOURCE_DESC_PRIV

public static final int SOURCE_DESC_PRIV

Constructor Detail

SourceDescription

public SourceDescription(int type,
                         java.lang.String description,
                         int frequency,
                         boolean encrypted)

Constructor.

the type of source description this is description the actual source description string frequency the frequency at which RTCP sends this source description encrypted set to true if this SDES item is to be encrypted. Please see individual variable description for current implementation status

Method Detail

getType

public int getType()

Get the type of source description this is.

getDescription

public java.lang.String getDescription()

Get the actual source description string.

setDescription

public void setDescription(java.lang.String desc)

getFrequency

public int getFrequency()

Get the frequency at which RTCP sends this source description.

Currently, this frequency parameter will be ignored by the implementation and SDES items are sent according to the following algorithm... The CNAME is sent every RTCP reporting interval. All other SDES items are sent once every 3 RTCP report intervals.

getEncrypted

public boolean getEncrypted()

Should this source description be encrypted?. Currently, we do not support any encryption schemes

generateCNAME

public static java.lang.String generateCNAME()

This function can be used to generate a CNAME using the scheme described in RFC1889. This function is provided in order to facilitate CNAME generation prior to actual stream creation.

Returns:

The generated CNAME.