org.kurento.client

Interface SdpEndpoint

All Superinterfaces:

Endpoint, KurentoObject, MediaElement, MediaObject, SessionEndpoint

All Known Subinterfaces:

BaseRtpEndpoint, RtpEndpoint, WebRtcEndpoint

public interface SdpEndpoint
extends SessionEndpoint

Implements an SDP negotiation endpoint able to generate and process offers/responses and that configures resources according to negotiated Session Description

Method Summary

Methods

Modifier and Type	Method and Description
String	generateOffer() Request a SessionSpec offer.
void	generateOffer(Continuation<String> cont) Asynchronous version of generateOffer: Continuation.onSuccess(F) is called when the action is done.
TFuture<String>	generateOffer(Transaction tx) Request a SessionSpec offer.
String	getLocalSessionDescriptor() This method gives access to the SessionSpec offered by this NetworkConnection.
void	getLocalSessionDescriptor(Continuation<String> cont) Asynchronous version of getLocalSessionDescriptor: Continuation.onSuccess(F) is called when the action is done.
TFuture<String>	getLocalSessionDescriptor(Transaction tx) This method gives access to the SessionSpec offered by this NetworkConnection.
int	getMaxAudioRecvBandwidth()
void	getMaxAudioRecvBandwidth(Continuation<Integer> cont)
TFuture<Integer>	getMaxAudioRecvBandwidth(Transaction tx)
int	getMaxVideoRecvBandwidth()
void	getMaxVideoRecvBandwidth(Continuation<Integer> cont)
TFuture<Integer>	getMaxVideoRecvBandwidth(Transaction tx)
String	getRemoteSessionDescriptor() This method gives access to the remote session description.
void	getRemoteSessionDescriptor(Continuation<String> cont) Asynchronous version of getRemoteSessionDescriptor: Continuation.onSuccess(F) is called when the action is done.
TFuture<String>	getRemoteSessionDescriptor(Transaction tx) This method gives access to the remote session description.
String	processAnswer(String answer) Request the NetworkConnection to process the given SessionSpec answer (from the remote User Agent).
void	processAnswer(String answer, Continuation<String> cont) Asynchronous version of processAnswer: Continuation.onSuccess(F) is called when the action is done.
TFuture<String>	processAnswer(Transaction tx, String answer) Request the NetworkConnection to process the given SessionSpec answer (from the remote User Agent).
String	processOffer(String offer) Request the NetworkConnection to process the given SessionSpec offer (from the remote User Agent)
void	processOffer(String offer, Continuation<String> cont) Asynchronous version of processOffer: Continuation.onSuccess(F) is called when the action is done.
TFuture<String>	processOffer(Transaction tx, String offer) Request the NetworkConnection to process the given SessionSpec offer (from the remote User Agent)
void	setMaxAudioRecvBandwidth(int maxAudioRecvBandwidth)
void	setMaxAudioRecvBandwidth(int maxAudioRecvBandwidth, Continuation<Void> cont)
void	setMaxAudioRecvBandwidth(int maxAudioRecvBandwidth, Transaction tx)
void	setMaxVideoRecvBandwidth(int maxVideoRecvBandwidth)
void	setMaxVideoRecvBandwidth(int maxVideoRecvBandwidth, Continuation<Void> cont)
void	setMaxVideoRecvBandwidth(int maxVideoRecvBandwidth, Transaction tx)

Methods inherited from interface org.kurento.client.SessionEndpoint

addMediaSessionStartedListener, addMediaSessionStartedListener, addMediaSessionTerminatedListener, addMediaSessionTerminatedListener, removeMediaSessionStartedListener, removeMediaSessionStartedListener, removeMediaSessionTerminatedListener, removeMediaSessionTerminatedListener

Methods inherited from interface org.kurento.client.MediaElement

addElementConnectedListener, addElementConnectedListener, addElementDisconnectedListener, addElementDisconnectedListener, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getMaxOuputBitrate, getMaxOuputBitrate, getMaxOuputBitrate, getMinOuputBitrate, getMinOuputBitrate, getMinOuputBitrate, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getStats, getStats, getStats, getStats, getStats, getStats, removeElementConnectedListener, removeElementConnectedListener, removeElementDisconnectedListener, removeElementDisconnectedListener, setAudioFormat, setAudioFormat, setAudioFormat, setMaxOuputBitrate, setMaxOuputBitrate, setMaxOuputBitrate, setMinOuputBitrate, setMinOuputBitrate, setMinOuputBitrate, setOutputBitrate, setOutputBitrate, setOutputBitrate, setVideoFormat, setVideoFormat, setVideoFormat

Methods inherited from interface org.kurento.client.MediaObject

addErrorListener, addErrorListener, addTag, addTag, addTag, getChilds, getChilds, getChilds, getCreationTime, getCreationTime, getCreationTime, getId, getId, getId, getMediaPipeline, getMediaPipeline, getMediaPipeline, getName, getName, getName, getParent, getParent, getParent, getSendTagsInEvents, getSendTagsInEvents, getSendTagsInEvents, getTag, getTag, getTag, getTags, getTags, getTags, removeErrorListener, removeErrorListener, removeTag, removeTag, removeTag, setName, setName, setName, setSendTagsInEvents, setSendTagsInEvents, setSendTagsInEvents

Methods inherited from interface org.kurento.client.KurentoObject

isCommited, release, release, release, waitCommited, whenCommited, whenCommited

Method Detail

getMaxVideoRecvBandwidth

int getMaxVideoRecvBandwidth()

getMaxVideoRecvBandwidth

void getMaxVideoRecvBandwidth(Continuation<Integer> cont)

getMaxVideoRecvBandwidth

TFuture<Integer> getMaxVideoRecvBandwidth(Transaction tx)

setMaxVideoRecvBandwidth

void setMaxVideoRecvBandwidth(int maxVideoRecvBandwidth)

setMaxVideoRecvBandwidth

void setMaxVideoRecvBandwidth(int maxVideoRecvBandwidth,
                            Continuation<Void> cont)

setMaxVideoRecvBandwidth

void setMaxVideoRecvBandwidth(int maxVideoRecvBandwidth,
                            Transaction tx)

getMaxAudioRecvBandwidth

int getMaxAudioRecvBandwidth()

getMaxAudioRecvBandwidth

void getMaxAudioRecvBandwidth(Continuation<Integer> cont)

getMaxAudioRecvBandwidth

TFuture<Integer> getMaxAudioRecvBandwidth(Transaction tx)

setMaxAudioRecvBandwidth

void setMaxAudioRecvBandwidth(int maxAudioRecvBandwidth)

setMaxAudioRecvBandwidth

void setMaxAudioRecvBandwidth(int maxAudioRecvBandwidth,
                            Continuation<Void> cont)

setMaxAudioRecvBandwidth

void setMaxAudioRecvBandwidth(int maxAudioRecvBandwidth,
                            Transaction tx)

generateOffer

String generateOffer()

Request a SessionSpec offer. This can be used to initiate a connection.

Returns:

The SDP offer. *

generateOffer

void generateOffer(Continuation<String> cont)

Asynchronous version of generateOffer: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.

See Also:

generateOffer()

generateOffer

TFuture<String> generateOffer(Transaction tx)

Request a SessionSpec offer. This can be used to initiate a connection.

Returns:

The SDP offer. *

processOffer

String processOffer(String offer)

Request the NetworkConnection to process the given SessionSpec offer (from the remote User Agent)

Parameters:

offer - SessionSpec offer from the remote User Agent

Returns:

The chosen configuration from the ones stated in the SDP offer *

processOffer

void processOffer(String offer,
                Continuation<String> cont)

Asynchronous version of processOffer: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.

Parameters:

offer - SessionSpec offer from the remote User Agent

See Also:

processOffer(java.lang.String)

processOffer

TFuture<String> processOffer(Transaction tx,
                           String offer)

Request the NetworkConnection to process the given SessionSpec offer (from the remote User Agent)

Parameters:

offer - SessionSpec offer from the remote User Agent

Returns:

The chosen configuration from the ones stated in the SDP offer *

processAnswer

String processAnswer(String answer)

Request the NetworkConnection to process the given SessionSpec answer (from the remote User Agent).

Parameters:

answer - SessionSpec answer from the remote User Agent

Returns:

Updated SDP offer, based on the answer received. *

processAnswer

void processAnswer(String answer,
                 Continuation<String> cont)

Asynchronous version of processAnswer: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.

Parameters:

answer - SessionSpec answer from the remote User Agent

See Also:

processAnswer(java.lang.String)

processAnswer

TFuture<String> processAnswer(Transaction tx,
                            String answer)

Request the NetworkConnection to process the given SessionSpec answer (from the remote User Agent).

Parameters:

answer - SessionSpec answer from the remote User Agent

Returns:

Updated SDP offer, based on the answer received. *

getLocalSessionDescriptor

String getLocalSessionDescriptor()

This method gives access to the SessionSpec offered by this NetworkConnection. Note This method returns the local MediaSpec, negotiated or not. If no offer has been generated yet, it returns null. It an offer has been generated it returns the offer and if an answer has been processed it returns the negotiated local SessionSpec.

Returns:

The last agreed SessionSpec *

getLocalSessionDescriptor

void getLocalSessionDescriptor(Continuation<String> cont)

Asynchronous version of getLocalSessionDescriptor: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.

See Also:

getLocalSessionDescriptor()

getLocalSessionDescriptor

TFuture<String> getLocalSessionDescriptor(Transaction tx)

This method gives access to the SessionSpec offered by this NetworkConnection. Note This method returns the local MediaSpec, negotiated or not. If no offer has been generated yet, it returns null. It an offer has been generated it returns the offer and if an answer has been processed it returns the negotiated local SessionSpec.

Returns:

The last agreed SessionSpec *

getRemoteSessionDescriptor

String getRemoteSessionDescriptor()

This method gives access to the remote session description. Note This method returns the media previously agreed after a complete offer-answer exchange. If no media has been agreed yet, it returns null.

Returns:

The last agreed User Agent session description *

getRemoteSessionDescriptor

void getRemoteSessionDescriptor(Continuation<String> cont)

Asynchronous version of getRemoteSessionDescriptor: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.

See Also:

getRemoteSessionDescriptor()

getRemoteSessionDescriptor

TFuture<String> getRemoteSessionDescriptor(Transaction tx)

This method gives access to the remote session description. Note This method returns the media previously agreed after a complete offer-answer exchange. If no media has been agreed yet, it returns null.

Returns:

The last agreed User Agent session description *