org.jivesoftware.smackx.jingle.media
Class PayloadType

java.lang.Object
  org.jivesoftware.smackx.jingle.media.PayloadType

Direct Known Subclasses:

PayloadType.Audio

public class PayloadType
extends java.lang.Object

Represents a payload type.

Author:

Alvaro Saurin

Nested Class Summary

static class

PayloadType.Audio Audio payload type.

Field Summary

static int	INVALID_PT
static int	MAX_FIXED_PT
static java.lang.String	NODENAME

Constructor Summary

PayloadType()
Default constructor.

PayloadType(int id, java.lang.String name)
Constructor with Id and name

PayloadType(int id, java.lang.String name, int channels)
Constructor with Id, name and number of channels

PayloadType(PayloadType pt)
Copy constructor

Method Summary

boolean	equals(java.lang.Object obj)
int	getChannels() Get the number of channels used by this payload type.
static java.lang.String	getElementName() Returns the XML element name of the element.
int	getId() Get the ID.
java.lang.String	getName() Get the printable name.
int	hashCode()
boolean	isNull() Return true if the Payload type is not valid
void	setChannels(int channels) Set the numer of channels for a payload type.
void	setId(int id) Set the ID.
void	setName(java.lang.String name) Set the printable name.
java.lang.String	toXML()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

NODENAME

public static final java.lang.String NODENAME

See Also:

Constant Field Values

MAX_FIXED_PT

public static int MAX_FIXED_PT

INVALID_PT

public static int INVALID_PT

Constructor Detail

PayloadType

public PayloadType(int id,
                   java.lang.String name,
                   int channels)

Constructor with Id, name and number of channels

Parameters:

id - The identifier

name - A name

channels - The number of channels

PayloadType

public PayloadType()

Default constructor.

PayloadType

public PayloadType(int id,
                   java.lang.String name)

Constructor with Id and name

Parameters:

id - The identification

name - A name

PayloadType

public PayloadType(PayloadType pt)

Copy constructor

Parameters:

pt - The other payload type.

Method Detail

getId

public int getId()

Get the ID.

Returns:

the ID

setId

public void setId(int id)

Set the ID.

Parameters:

id - ID

getName

public java.lang.String getName()

Get the printable name.

Returns:

printable name for the payload type

setName

public void setName(java.lang.String name)

Set the printable name.

Parameters:

name - the printable name

getChannels

public int getChannels()

Get the number of channels used by this payload type.

Returns:

the number of channels

setChannels

public void setChannels(int channels)

Set the numer of channels for a payload type.

Parameters:

channels - The number of channels

isNull

public boolean isNull()

Return true if the Payload type is not valid

Returns:

true if the payload type is invalid

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getElementName

public static java.lang.String getElementName()

Returns the XML element name of the element.

Returns:

the XML element name of the element.

toXML

public java.lang.String toXML()