org.kurento.client.SdpEndpoint Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kurento-client Show documentation
Kurento Client The Kurento Client project allows server applications to control media server resources.
There is a newer version: 7.1.0
/**
 * This file is generated with Kurento-maven-plugin.
 * Please don't edit.
 */
package org.kurento.client;


/**
 *
 * Implements an SDP negotiation endpoint able to generate and process offers/responses and that configures resources according to negotiated Session Description
 *
 **/
@org.kurento.client.internal.RemoteClass
public interface SdpEndpoint extends SessionEndpoint {

     int getMaxVideoRecvBandwidth();

     void getMaxVideoRecvBandwidth(Continuation cont);

     TFuture getMaxVideoRecvBandwidth(Transaction tx);

     void setMaxVideoRecvBandwidth(@org.kurento.client.internal.server.Param("maxVideoRecvBandwidth") int maxVideoRecvBandwidth);

     void setMaxVideoRecvBandwidth(@org.kurento.client.internal.server.Param("maxVideoRecvBandwidth") int maxVideoRecvBandwidth, Continuation cont);

     void setMaxVideoRecvBandwidth(@org.kurento.client.internal.server.Param("maxVideoRecvBandwidth") int maxVideoRecvBandwidth, Transaction tx);
     int getMaxAudioRecvBandwidth();

     void getMaxAudioRecvBandwidth(Continuation cont);

     TFuture getMaxAudioRecvBandwidth(Transaction tx);

     void setMaxAudioRecvBandwidth(@org.kurento.client.internal.server.Param("maxAudioRecvBandwidth") int maxAudioRecvBandwidth);

     void setMaxAudioRecvBandwidth(@org.kurento.client.internal.server.Param("maxAudioRecvBandwidth") int maxAudioRecvBandwidth, Continuation cont);

     void setMaxAudioRecvBandwidth(@org.kurento.client.internal.server.Param("maxAudioRecvBandwidth") int maxAudioRecvBandwidth, Transaction tx);


/**
 *
 * Request a SessionSpec offer.
 *    This can be used to initiate a connection.
 * @return The SDP offer. *
 **/
  String generateOffer();

/**
 *
 * Asynchronous version of generateOffer:
 * {@link Continuation#onSuccess} is called when the action is
 * done. If an error occurs, {@link Continuation#onError} is called.
 * @see SdpEndpoint#generateOffer
 *
 **/
    void generateOffer(Continuation cont);

/**
 *
 * Request a SessionSpec offer.
 *    This can be used to initiate a connection.
 * @return The SDP offer. *
 **/
    TFuture generateOffer(Transaction tx);


/**
 *
 * Request the NetworkConnection to process the given SessionSpec offer (from the remote User Agent)
 *
 * @param offer
 *       SessionSpec offer from the remote User Agent
 * @return The chosen configuration from the ones stated in the SDP offer *
 **/
  String processOffer(@org.kurento.client.internal.server.Param("offer") String offer);

/**
 *
 * Asynchronous version of processOffer:
 * {@link Continuation#onSuccess} is called when the action is
 * done. If an error occurs, {@link Continuation#onError} is called.
 * @see SdpEndpoint#processOffer
 *
 * @param offer
 *       SessionSpec offer from the remote User Agent
 *
 **/
    void processOffer(@org.kurento.client.internal.server.Param("offer") String offer, Continuation cont);

/**
 *
 * Request the NetworkConnection to process the given SessionSpec offer (from the remote User Agent)
 *
 * @param offer
 *       SessionSpec offer from the remote User Agent
 * @return The chosen configuration from the ones stated in the SDP offer *
 **/
    TFuture processOffer(Transaction tx, @org.kurento.client.internal.server.Param("offer") String offer);


/**
 *
 * Request the NetworkConnection to process the given SessionSpec answer (from the remote User Agent).
 *
 * @param answer
 *       SessionSpec answer from the remote User Agent
 * @return Updated SDP offer, based on the answer received. *
 **/
  String processAnswer(@org.kurento.client.internal.server.Param("answer") String answer);

/**
 *
 * Asynchronous version of processAnswer:
 * {@link Continuation#onSuccess} is called when the action is
 * done. If an error occurs, {@link Continuation#onError} is called.
 * @see SdpEndpoint#processAnswer
 *
 * @param answer
 *       SessionSpec answer from the remote User Agent
 *
 **/
    void processAnswer(@org.kurento.client.internal.server.Param("answer") String answer, Continuation cont);

/**
 *
 * Request the NetworkConnection to process the given SessionSpec answer (from the remote User Agent).
 *
 * @param answer
 *       SessionSpec answer from the remote User Agent
 * @return Updated SDP offer, based on the answer received. *
 **/
    TFuture processAnswer(Transaction tx, @org.kurento.client.internal.server.Param("answer") String answer);


/**
 *
 * 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.
 * @return The last agreed SessionSpec *
 **/
  String getLocalSessionDescriptor();

/**
 *
 * Asynchronous version of getLocalSessionDescriptor:
 * {@link Continuation#onSuccess} is called when the action is
 * done. If an error occurs, {@link Continuation#onError} is called.
 * @see SdpEndpoint#getLocalSessionDescriptor
 *
 **/
    void getLocalSessionDescriptor(Continuation cont);

/**
 *
 * 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.
 * @return The last agreed SessionSpec *
 **/
    TFuture getLocalSessionDescriptor(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.
 * @return The last agreed User Agent session description *
 **/
  String getRemoteSessionDescriptor();

/**
 *
 * Asynchronous version of getRemoteSessionDescriptor:
 * {@link Continuation#onSuccess} is called when the action is
 * done. If an error occurs, {@link Continuation#onError} is called.
 * @see SdpEndpoint#getRemoteSessionDescriptor
 *
 **/
    void getRemoteSessionDescriptor(Continuation cont);

/**
 *
 * 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.
 * @return The last agreed User Agent session description *
 **/
    TFuture getRemoteSessionDescriptor(Transaction tx);

    




}