Class JingleDescription

  • All Implemented Interfaces:
    org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.ExtensionElement, org.jivesoftware.smack.packet.FullyQualifiedElement, org.jivesoftware.smack.packet.NamedElement, org.jivesoftware.smack.packet.XmlLangElement
    Direct Known Subclasses:
    JingleDescription.Audio

    public abstract class JingleDescription
    extends java.lang.Object
    implements org.jivesoftware.smack.packet.ExtensionElement
    Jingle content description.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  JingleDescription.Audio
      Jingle audio description.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String NODENAME  
    • Constructor Summary

      Constructors 
      Constructor Description
      JingleDescription()
      Creates a content description..
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void addAudioPayloadTypes​(java.util.List<PayloadType> pts)
      Adds a list of payloads to the packet.
      void addPayloadType​(PayloadType pt)
      Adds a audio payload type to the packet.
      java.util.List<PayloadType> getAudioPayloadTypesList()
      Return the list of Payload types contained in the description.
      java.lang.String getElementName()
      Returns the XML element name of the element.
      abstract java.lang.String getNamespace()
      Return the namespace.
      java.util.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.
      java.util.List<PayloadType> getPayloadTypesList()
      Returns a list for the audio payloads in the packet.
      java.lang.String toXML​(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
      Convert a Jingle description to XML.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface org.jivesoftware.smack.packet.Element

        toXML, toXML
      • Methods inherited from interface org.jivesoftware.smack.packet.FullyQualifiedElement

        getLanguage, getQName
    • Constructor Detail

      • JingleDescription

        public JingleDescription()
        Creates a content description..
    • Method Detail

      • getElementName

        public java.lang.String getElementName()
        Returns the XML element name of the element.
        Specified by:
        getElementName in interface org.jivesoftware.smack.packet.NamedElement
        Returns:
        the XML element name of the element.
      • getNamespace

        public abstract java.lang.String getNamespace()
        Return the namespace.
        Specified by:
        getNamespace in interface org.jivesoftware.smack.packet.FullyQualifiedElement
        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​(java.util.List<PayloadType> pts)
        Adds a list of payloads to the packet.
        Parameters:
        pts - the payloads to add.
      • getPayloadTypes

        public java.util.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 java.util.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 java.util.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 java.lang.String toXML​(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
        Convert a Jingle description to XML.
        Specified by:
        toXML in interface org.jivesoftware.smack.packet.Element
        Returns:
        a string with the XML representation