org.jivesoftware.smackx.jingle.packet

Class JingleDescription

java.lang.Object

org.jivesoftware.smackx.jingle.packet.JingleDescription

All Implemented Interfaces:

PacketExtension

Direct Known Subclasses:

JingleDescription.Audio

public abstract class JingleDescription
extends Object
implements PacketExtension

Jingle content description.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JingleDescription.Audio Jingle audio description

Field Summary

Fields

Modifier and Type	Field and Description
static String	NODENAME

Constructor Summary

Constructors

Constructor and Description
JingleDescription() Creates a content description..

Method Summary

Methods

Modifier and Type	Method and Description
void	addAudioPayloadTypes(List<PayloadType> pts) Adds a list of payloads to the packet.
void	addPayloadType(PayloadType pt) Adds a audio payload type to the packet.
List<PayloadType>	getAudioPayloadTypesList() Return the list of Payload types contained in the description.
String	getElementName() Returns the XML element name of the element.
abstract String	getNamespace() Return the namespace.
Iterator<PayloadType>	getPayloadTypes() Returns an Iterator for the audio payloads in the packet.
int	getPayloadTypesCount() Returns a count of the audio payloads in the Jingle packet.
List<PayloadType>	getPayloadTypesList() Returns a list for the audio payloads in the packet.
String	toXML() Convert a Jingle description to XML.

Methods inherited from class java.lang.Object

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

Field Detail

NODENAME

public static final String NODENAME

See Also:

Constant Field Values

Constructor Detail

JingleDescription

public JingleDescription()

Creates a content description..

Method Detail

getElementName

public String getElementName()

Returns the XML element name of the element.

Specified by:

getElementName in interface PacketExtension

Returns:

the XML element name of the element.

getNamespace

public abstract String getNamespace()

Return the namespace.

Specified by:

getNamespace in interface PacketExtension

Returns:

The namespace

addPayloadType

public void addPayloadType(PayloadType pt)

Adds a audio payload type to the packet.

Parameters:

pt - the audio payload type to add.

addAudioPayloadTypes

public void addAudioPayloadTypes(List<PayloadType> pts)

Adds a list of payloads to the packet.

Parameters:

pts - the payloads to add.

getPayloadTypes

public Iterator<PayloadType> getPayloadTypes()

Returns an Iterator for the audio payloads in the packet.

Returns:

an Iterator for the audio payloads in the packet.

getPayloadTypesList

public List<PayloadType> getPayloadTypesList()

Returns a list for the audio payloads in the packet.

Returns:

a list for the audio payloads in the packet.

getAudioPayloadTypesList

public List<PayloadType> getAudioPayloadTypesList()

Return the list of Payload types contained in the description.

Returns:

a list of PayloadType.Audio

getPayloadTypesCount

public int getPayloadTypesCount()

Returns a count of the audio payloads in the Jingle packet.

Returns:

the number of audio payloads in the Jingle packet.

toXML

public String toXML()

Convert a Jingle description to XML.

Specified by:

toXML in interface PacketExtension

Returns:

a string with the XML representation