org.kurento.client

Interface RtpEndpoint

All Superinterfaces:

BaseRtpEndpoint, Endpoint, KurentoObject, MediaElement, MediaObject, SdpEndpoint, SessionEndpoint

public interface RtpEndpoint
extends BaseRtpEndpoint

Endpoint that provides bidirectional content delivery capabilities with remote networked peers through RTP or SRTP protocol. An RtpEndpoint contains paired sink and source :rom:cls:`MediaPad` for audio and video. This endpoint inherits from BaseRtpEndpoint.

In order to establish an RTP/SRTP communication, peers engage in an SDP negotiation process, where one of the peers (the offerer) sends an offer, while the other peer (the offeree) responds with an answer. This endpoint can function in both situations

• As offerer: The negotiation process is initiated by the media server
  • KMS generates the SDP offer through the generateOffer method. This offer must then be sent to the remote peer (the offeree) through the signaling channel, for processing.
  • The remote peer process the Offer, and generates an Answer to this offer. The Answer is sent back to the media server.
  • Upon receiving the Answer, the endpoint must invoke the processAnswer method.
• As offeree: The negotiation process is initiated by the remote peer
  • The remote peer, acting as offerer, generates an SDP offer and sends it to the WebRTC endpoint in Kurento.
  • The endpoint will process the Offer invoking the processOffer method. The result of this method will be a string, containing an SDP Answer.
  • The SDP Answer must be sent back to the offerer, so it can be processed.

In case of unidirectional connections (i.e. only one peer is going to send media), the process is more simple, as only the emitter needs to process an SDP. On top of the information about media codecs and types, the SDP must contain the IP of the remote peer, and the port where it will be listening. This way, the SDP can be mangled without needing to go through the exchange process, as the receiving peer does not need to process any answer.

The user can set some bandwidth limits that will be used during the negotiation process. The default bandwidth range of the endpoint is 100kbps-500kbps, but it can be changed separately for input/output directions and for audio/video streams.

• Input bandwidth control mechanism: Configuration interval used to inform remote peer the range of bitrates that can be pushed into this RtpEndpoint object. These values are announced in the SDP.
  • setMaxVideoRecvBandwidth: sets Max bitrate limits expected for received video stream.
  • setMaxAudioRecvBandwidth: sets Max bitrate limits expected for received audio stream.
• Output bandwidth control mechanism: Configuration interval used to control bitrate of the output video stream sent to remote peer. Remote peers can also announce bandwidth limitation in their SDPs (through the b=: tag). Kurento will always enforce bitrate limitations specified by the remote peer over internal configurations.
  • setMaxVideoSendBandwidth: sets Max bitrate limits for video sent to remote peer.
  • setMinVideoSendBandwidth: sets Min bitrate limits for audio sent to remote peer.

All bandwidth control parameters must be changed before the SDP negotiation takes place, and can't be modified afterwards. TODO: What happens if the b=as tag form the SDP has a lower value than the one set in setMinVideoSendBandwidth?

Take into consideration that setting a too high upper limit for the output bandwidth can be a reason for the local network connection to be overflooded.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RtpEndpoint.Builder

Method Summary

Modifier and Type	Method and Description
ListenerSubscription	addOnKeySoftLimitListener(EventListener<OnKeySoftLimitEvent> listener) Add a EventListener for event OnKeySoftLimitEvent.
void	addOnKeySoftLimitListener(EventListener<OnKeySoftLimitEvent> listener, Continuation<ListenerSubscription> cont) Add a EventListener for event OnKeySoftLimitEvent.
void	removeOnKeySoftLimitListener(ListenerSubscription listenerSubscription) Remove a ListenerSubscription for event OnKeySoftLimitEvent.
void	removeOnKeySoftLimitListener(ListenerSubscription listenerSubscription, Continuation<Void> cont) Remove a ListenerSubscription for event OnKeySoftLimitEvent.

Methods inherited from interface org.kurento.client.BaseRtpEndpoint

addConnectionStateChangedListener, addConnectionStateChangedListener, addMediaStateChangedListener, addMediaStateChangedListener, getConnectionState, getConnectionState, getConnectionState, getMaxVideoSendBandwidth, getMaxVideoSendBandwidth, getMaxVideoSendBandwidth, getMediaState, getMediaState, getMediaState, getMinVideoRecvBandwidth, getMinVideoRecvBandwidth, getMinVideoRecvBandwidth, getMinVideoSendBandwidth, getMinVideoSendBandwidth, getMinVideoSendBandwidth, getMtu, getMtu, getMtu, getRembParams, getRembParams, getRembParams, removeConnectionStateChangedListener, removeConnectionStateChangedListener, removeMediaStateChangedListener, removeMediaStateChangedListener, setMaxVideoSendBandwidth, setMaxVideoSendBandwidth, setMaxVideoSendBandwidth, setMinVideoRecvBandwidth, setMinVideoRecvBandwidth, setMinVideoRecvBandwidth, setMinVideoSendBandwidth, setMinVideoSendBandwidth, setMinVideoSendBandwidth, setMtu, setMtu, setMtu, setRembParams, setRembParams, setRembParams

Methods inherited from interface org.kurento.client.SdpEndpoint

generateOffer, generateOffer, generateOffer, generateOffer, generateOffer, generateOffer, getLocalSessionDescriptor, getLocalSessionDescriptor, getLocalSessionDescriptor, getMaxAudioRecvBandwidth, getMaxAudioRecvBandwidth, getMaxAudioRecvBandwidth, getMaxVideoRecvBandwidth, getMaxVideoRecvBandwidth, getMaxVideoRecvBandwidth, getRemoteSessionDescriptor, getRemoteSessionDescriptor, getRemoteSessionDescriptor, processAnswer, processAnswer, processAnswer, processOffer, processOffer, processOffer, setMaxAudioRecvBandwidth, setMaxAudioRecvBandwidth, setMaxAudioRecvBandwidth, setMaxVideoRecvBandwidth, setMaxVideoRecvBandwidth, setMaxVideoRecvBandwidth

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, addMediaFlowInStateChangeListener, addMediaFlowInStateChangeListener, addMediaFlowOutStateChangeListener, addMediaFlowOutStateChangeListener, addMediaTranscodingStateChangeListener, addMediaTranscodingStateChangeListener, 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, getMaxOutputBitrate, getMaxOutputBitrate, getMaxOutputBitrate, getMinOuputBitrate, getMinOuputBitrate, getMinOuputBitrate, getMinOutputBitrate, getMinOutputBitrate, getMinOutputBitrate, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getStats, getStats, getStats, getStats, getStats, getStats, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingOut, isMediaFlowingOut, isMediaFlowingOut, isMediaFlowingOut, isMediaFlowingOut, isMediaFlowingOut, isMediaTranscoding, isMediaTranscoding, isMediaTranscoding, isMediaTranscoding, isMediaTranscoding, isMediaTranscoding, removeElementConnectedListener, removeElementConnectedListener, removeElementDisconnectedListener, removeElementDisconnectedListener, removeMediaFlowInStateChangeListener, removeMediaFlowInStateChangeListener, removeMediaFlowOutStateChangeListener, removeMediaFlowOutStateChangeListener, removeMediaTranscodingStateChangeListener, removeMediaTranscodingStateChangeListener, setAudioFormat, setAudioFormat, setAudioFormat, setMaxOuputBitrate, setMaxOuputBitrate, setMaxOuputBitrate, setMaxOutputBitrate, setMaxOutputBitrate, setMaxOutputBitrate, setMinOuputBitrate, setMinOuputBitrate, setMinOuputBitrate, setMinOutputBitrate, setMinOutputBitrate, setMinOutputBitrate, setOutputBitrate, setOutputBitrate, setOutputBitrate, setVideoFormat, setVideoFormat, setVideoFormat

Methods inherited from interface org.kurento.client.MediaObject

addErrorListener, addErrorListener, addTag, addTag, addTag, getChildren, getChildren, getChildren, 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

addOnKeySoftLimitListener

ListenerSubscription addOnKeySoftLimitListener(EventListener<OnKeySoftLimitEvent> listener)

Add a EventListener for event OnKeySoftLimitEvent. Synchronous call.

Parameters:

listener - Listener to be called on OnKeySoftLimitEvent

Returns:

ListenerSubscription for the given Listener

addOnKeySoftLimitListener

void addOnKeySoftLimitListener(EventListener<OnKeySoftLimitEvent> listener,
                               Continuation<ListenerSubscription> cont)

Add a EventListener for event OnKeySoftLimitEvent. Asynchronous call. Calls Continuation<ListenerSubscription> when it has been added.

Parameters:

listener - Listener to be called on OnKeySoftLimitEvent

cont - Continuation to be called when the listener is registered

removeOnKeySoftLimitListener

void removeOnKeySoftLimitListener(ListenerSubscription listenerSubscription)

Remove a ListenerSubscription for event OnKeySoftLimitEvent. Synchronous call.

Parameters:

listenerSubscription - Listener subscription to be removed

removeOnKeySoftLimitListener

void removeOnKeySoftLimitListener(ListenerSubscription listenerSubscription,
                                  Continuation<Void> cont)

Remove a ListenerSubscription for event OnKeySoftLimitEvent. Asynchronous call. Calls Continuation<Void> when it has been removed.

Parameters:

listenerSubscription - Listener subscription to be removed

cont - Continuation to be called when the listener is removed