org.jivesoftware.smackx.jingle.media

Class MediaNegotiator

java.lang.Object

org.jivesoftware.smackx.jingle.JingleNegotiator

org.jivesoftware.smackx.jingle.media.MediaNegotiator

public class MediaNegotiator
extends JingleNegotiator

Manager for jmf descriptor negotiation.

This class is responsible for managing the descriptor negotiation process, handling all the xmpp packets interchange and the stage control. handling all the xmpp packets interchange and the stage control.

Field Summary

Fields inherited from class org.jivesoftware.smackx.jingle.JingleNegotiator

session

Constructor Summary

Constructors

Constructor and Description
MediaNegotiator(JingleSession session, JingleMediaManager mediaManager, List<PayloadType> pts, ContentNegotiator parentNegotiator) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRemoteAudioPayloadType(PayloadType.Audio pt) Adds a payload type to the list of remote payloads.
void	close() Terminate the jmf negotiator
List<IQ>	dispatchIncomingPacket(IQ iq, String id) Dispatch an incoming packet.
protected void	doStart() Called from above when starting a new session.
PayloadType	getBestCommonAudioPt() Get the best common codec between both parts.
JingleDescription	getJingleDescription() Create a JingleDescription that matches this negotiator.
JingleMediaManager	getMediaManager() Return The media manager for this negotiator.
boolean	isEstablished() Return true if the content is negotiated.
boolean	isFullyEstablished() Return true if the content is fully negotiated.
protected void	triggerMediaClosed(PayloadType currPt) Trigger a jmf closed event.
protected void	triggerMediaEstablished(PayloadType bestPt) Trigger a session established event.

Methods inherited from class org.jivesoftware.smackx.jingle.JingleNegotiator

addExpectedId, addListener, getConnection, getListenersList, getNegotiatorState, getSession, isExpectedId, isStarted, removeExpectedId, removeListener, setNegotiatorState, setSession, start

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaNegotiator

public MediaNegotiator(JingleSession session,
               JingleMediaManager mediaManager,
               List<PayloadType> pts,
               ContentNegotiator parentNegotiator)

Default constructor. The constructor establishes some basic parameters, but it does not start the negotiation. For starting the negotiation, call startNegotiation.

Parameters:

session - The jingle session.

Method Detail

getMediaManager

public JingleMediaManager getMediaManager()

Return The media manager for this negotiator.

dispatchIncomingPacket

public List<IQ> dispatchIncomingPacket(IQ iq,
                              String id)
                                throws XMPPException,
                                       SmackException.NotConnectedException

Dispatch an incoming packet. The method is responsible for recognizing the packet type and, depending on the current state, delivering the packet to the right event handler and wait for a response.

Specified by:

dispatchIncomingPacket in class JingleNegotiator

Parameters:

iq - the packet received

id - the ID of the response that will be sent

Returns:

the new Jingle packet to send.

Throws:

XMPPException

SmackException.NotConnectedException

isEstablished

public boolean isEstablished()

Return true if the content is negotiated.

Returns:

true if the content is negotiated.

isFullyEstablished

public boolean isFullyEstablished()

Return true if the content is fully negotiated.

Returns:

true if the content is fully negotiated.

addRemoteAudioPayloadType

public void addRemoteAudioPayloadType(PayloadType.Audio pt)

Adds a payload type to the list of remote payloads.

Parameters:

pt - the remote payload type

getBestCommonAudioPt

public PayloadType getBestCommonAudioPt()

Get the best common codec between both parts.

Returns:

The best common PayloadType codec.

triggerMediaEstablished

protected void triggerMediaEstablished(PayloadType bestPt)
                                throws SmackException.NotConnectedException

Trigger a session established event.

Parameters:

bestPt - payload type that has been agreed.

Throws:

SmackException.NotConnectedException

triggerMediaClosed

protected void triggerMediaClosed(PayloadType currPt)

Trigger a jmf closed event.

Parameters:

currPt - current payload type that is cancelled.

doStart

protected void doStart()

Called from above when starting a new session.

Specified by:

doStart in class JingleNegotiator

close

public void close()

Terminate the jmf negotiator

Overrides:

close in class JingleNegotiator

getJingleDescription

public JingleDescription getJingleDescription()

Create a JingleDescription that matches this negotiator.