Package org.kurento.client

Interface SdpEndpoint

    • Method Detail

      • getMaxAudioRecvBandwidth

        int getMaxAudioRecvBandwidth()
        Get Maximum inbound bitrate requested by this endpoint. Signaled to compatible WebRTC and RTP senders as part of Kurento's REMB bandwidth estimations, and also as an SDP bitrate attribute (b=AS:{value}, see RFC 8866 Section 5.8. Bandwidth Information) in sendrecv and recvonly SDP Offers.
        • Unit: kbps (kilobits per second).
        • Default: 0 (unlimited).

      • getMaxAudioRecvBandwidth

        void getMaxAudioRecvBandwidth​(Continuation<Integer> cont)
        Get Maximum inbound bitrate requested by this endpoint. Signaled to compatible WebRTC and RTP senders as part of Kurento's REMB bandwidth estimations, and also as an SDP bitrate attribute (b=AS:{value}, see RFC 8866 Section 5.8. Bandwidth Information) in sendrecv and recvonly SDP Offers.
        • Unit: kbps (kilobits per second).
        • Default: 0 (unlimited).

      • getMaxAudioRecvBandwidth

        TFuture<Integer> getMaxAudioRecvBandwidth​(Transaction tx)
        Get Maximum inbound bitrate requested by this endpoint. Signaled to compatible WebRTC and RTP senders as part of Kurento's REMB bandwidth estimations, and also as an SDP bitrate attribute (b=AS:{value}, see RFC 8866 Section 5.8. Bandwidth Information) in sendrecv and recvonly SDP Offers.
        • Unit: kbps (kilobits per second).
        • Default: 0 (unlimited).

      • setMaxAudioRecvBandwidth

        void setMaxAudioRecvBandwidth​(int maxAudioRecvBandwidth)
        Set Maximum inbound bitrate requested by this endpoint. Signaled to compatible WebRTC and RTP senders as part of Kurento's REMB bandwidth estimations, and also as an SDP bitrate attribute (b=AS:{value}, see RFC 8866 Section 5.8. Bandwidth Information) in sendrecv and recvonly SDP Offers.
        • Unit: kbps (kilobits per second).
        • Default: 0 (unlimited).

      • setMaxAudioRecvBandwidth

        void setMaxAudioRecvBandwidth​(int maxAudioRecvBandwidth,
                              Continuation<Void> cont)
        Set Maximum inbound bitrate requested by this endpoint. Signaled to compatible WebRTC and RTP senders as part of Kurento's REMB bandwidth estimations, and also as an SDP bitrate attribute (b=AS:{value}, see RFC 8866 Section 5.8. Bandwidth Information) in sendrecv and recvonly SDP Offers.
        • Unit: kbps (kilobits per second).
        • Default: 0 (unlimited).

      • setMaxAudioRecvBandwidth

        void setMaxAudioRecvBandwidth​(int maxAudioRecvBandwidth,
                              Transaction tx)
        Set Maximum inbound bitrate requested by this endpoint. Signaled to compatible WebRTC and RTP senders as part of Kurento's REMB bandwidth estimations, and also as an SDP bitrate attribute (b=AS:{value}, see RFC 8866 Section 5.8. Bandwidth Information) in sendrecv and recvonly SDP Offers.
        • Unit: kbps (kilobits per second).
        • Default: 0 (unlimited).

      • getMaxVideoRecvBandwidth

        int getMaxVideoRecvBandwidth()
        Get Maximum inbound bitrate requested by this endpoint. Signaled to compatible WebRTC and RTP senders as part of Kurento's REMB bandwidth estimations, and also as an SDP bitrate attribute (b=AS:{value}, see RFC 8866 Section 5.8. Bandwidth Information) in sendrecv and recvonly SDP Offers.
        • Unit: kbps (kilobits per second).
        • Default: 0 (unlimited).

      • getMaxVideoRecvBandwidth

        void getMaxVideoRecvBandwidth​(Continuation<Integer> cont)
        Get Maximum inbound bitrate requested by this endpoint. Signaled to compatible WebRTC and RTP senders as part of Kurento's REMB bandwidth estimations, and also as an SDP bitrate attribute (b=AS:{value}, see RFC 8866 Section 5.8. Bandwidth Information) in sendrecv and recvonly SDP Offers.
        • Unit: kbps (kilobits per second).
        • Default: 0 (unlimited).

      • getMaxVideoRecvBandwidth

        TFuture<Integer> getMaxVideoRecvBandwidth​(Transaction tx)
        Get Maximum inbound bitrate requested by this endpoint. Signaled to compatible WebRTC and RTP senders as part of Kurento's REMB bandwidth estimations, and also as an SDP bitrate attribute (b=AS:{value}, see RFC 8866 Section 5.8. Bandwidth Information) in sendrecv and recvonly SDP Offers.
        • Unit: kbps (kilobits per second).
        • Default: 0 (unlimited).

      • setMaxVideoRecvBandwidth

        void setMaxVideoRecvBandwidth​(int maxVideoRecvBandwidth)
        Set Maximum inbound bitrate requested by this endpoint. Signaled to compatible WebRTC and RTP senders as part of Kurento's REMB bandwidth estimations, and also as an SDP bitrate attribute (b=AS:{value}, see RFC 8866 Section 5.8. Bandwidth Information) in sendrecv and recvonly SDP Offers.
        • Unit: kbps (kilobits per second).
        • Default: 0 (unlimited).

      • setMaxVideoRecvBandwidth

        void setMaxVideoRecvBandwidth​(int maxVideoRecvBandwidth,
                              Continuation<Void> cont)
        Set Maximum inbound bitrate requested by this endpoint. Signaled to compatible WebRTC and RTP senders as part of Kurento's REMB bandwidth estimations, and also as an SDP bitrate attribute (b=AS:{value}, see RFC 8866 Section 5.8. Bandwidth Information) in sendrecv and recvonly SDP Offers.
        • Unit: kbps (kilobits per second).
        • Default: 0 (unlimited).

      • setMaxVideoRecvBandwidth

        void setMaxVideoRecvBandwidth​(int maxVideoRecvBandwidth,
                              Transaction tx)
        Set Maximum inbound bitrate requested by this endpoint. Signaled to compatible WebRTC and RTP senders as part of Kurento's REMB bandwidth estimations, and also as an SDP bitrate attribute (b=AS:{value}, see RFC 8866 Section 5.8. Bandwidth Information) in sendrecv and recvonly SDP Offers.
        • Unit: kbps (kilobits per second).
        • Default: 0 (unlimited).

      • generateOffer

        String generateOffer​(OfferOptions options)
        Generates an SDP offer with media capabilities of the Endpoint. Throws:
        • SDP_END_POINT_ALREADY_NEGOTIATED If the endpoint is already negotiated.
        • SDP_END_POINT_GENERATE_OFFER_ERROR if the generated offer is empty. This is most likely due to an internal error.
        Parameters:
        options - An OfferOptions providing options requested for the offer.
        Returns:
        The SDP offer. *

      • generateOffer

        TFuture<String> generateOffer​(Transaction tx,
                              OfferOptions options)
        Generates an SDP offer with media capabilities of the Endpoint. Throws:
        • SDP_END_POINT_ALREADY_NEGOTIATED If the endpoint is already negotiated.
        • SDP_END_POINT_GENERATE_OFFER_ERROR if the generated offer is empty. This is most likely due to an internal error.
        Parameters:
        options - An OfferOptions providing options requested for the offer.
        Returns:
        The SDP offer. *

      • processOffer

        String processOffer​(String offer)
        Processes SDP offer of the remote peer, and generates an SDP answer based on the endpoint's capabilities.

        If no matching capabilities are found, the SDP will contain no codecs.

        Throws:
        • SDP_PARSE_ERROR If the offer is empty or has errors.
        • SDP_END_POINT_ALREADY_NEGOTIATED If the endpoint is already negotiated.
        • SDP_END_POINT_PROCESS_OFFER_ERROR if the generated offer is empty. This is most likely due to an internal error.
        Parameters:
        offer - SessionSpec offer from the remote User Agent
        Returns:
        The chosen configuration from the ones stated in the SDP offer. *

      • processOffer

        TFuture<String> processOffer​(Transaction tx,
                             String offer)
        Processes SDP offer of the remote peer, and generates an SDP answer based on the endpoint's capabilities.

        If no matching capabilities are found, the SDP will contain no codecs.

        Throws:
        • SDP_PARSE_ERROR If the offer is empty or has errors.
        • SDP_END_POINT_ALREADY_NEGOTIATED If the endpoint is already negotiated.
        • SDP_END_POINT_PROCESS_OFFER_ERROR if the generated offer is empty. This is most likely due to an internal error.
        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)
        Generates an SDP offer with media capabilities of the Endpoint. Throws:
        • SDP_PARSE_ERROR If the offer is empty or has errors.
        • SDP_END_POINT_ALREADY_NEGOTIATED If the endpoint is already negotiated.
        • SDP_END_POINT_PROCESS_ANSWER_ERROR if the result of processing the answer is an empty string. This is most likely due to an internal error.
        • SDP_END_POINT_NOT_OFFER_GENERATED If the method is invoked before the generateOffer method.
        Parameters:
        answer - SessionSpec answer from the remote User Agent
        Returns:
        Updated SDP offer, based on the answer received. *

      • processAnswer

        TFuture<String> processAnswer​(Transaction tx,
                              String answer)
        Generates an SDP offer with media capabilities of the Endpoint. Throws:
        • SDP_PARSE_ERROR If the offer is empty or has errors.
        • SDP_END_POINT_ALREADY_NEGOTIATED If the endpoint is already negotiated.
        • SDP_END_POINT_PROCESS_ANSWER_ERROR if the result of processing the answer is an empty string. This is most likely due to an internal error.
        • SDP_END_POINT_NOT_OFFER_GENERATED If the method is invoked before the generateOffer method.
        Parameters:
        answer - SessionSpec answer from the remote User Agent
        Returns:
        Updated SDP offer, based on the answer received. *

      • getLocalSessionDescriptor

        String getLocalSessionDescriptor()
        Returns the local SDP.
        • No offer has been generated: returns null.
        • Offer has been generated: returns the SDP offer.
        • Offer has been generated and answer processed: returns the agreed SDP.
        Returns:
        The last agreed SessionSpec. *

      • getLocalSessionDescriptor

        TFuture<String> getLocalSessionDescriptor​(Transaction tx)
        Returns the local SDP.
        • No offer has been generated: returns null.
        • Offer has been generated: returns the SDP offer.
        • Offer has been generated and answer processed: returns the agreed SDP.
        Returns:
        The last agreed SessionSpec. *

      • getRemoteSessionDescriptor

        String getRemoteSessionDescriptor()
        This method returns the remote SDP. If the negotiation process is not complete, it will return NULL.
        Returns:
        The last agreed User Agent session description. *

      • getRemoteSessionDescriptor

        TFuture<String> getRemoteSessionDescriptor​(Transaction tx)
        This method returns the remote SDP. If the negotiation process is not complete, it will return NULL.
        Returns:
        The last agreed User Agent session description. *

      • generateOffer

        String generateOffer()
        Generates an SDP offer with media capabilities of the Endpoint. Throws:
        • SDP_END_POINT_ALREADY_NEGOTIATED If the endpoint is already negotiated.
        • SDP_END_POINT_GENERATE_OFFER_ERROR if the generated offer is empty. This is most likely due to an internal error.
        Returns:
        The SDP offer. *

      • generateOffer

        TFuture<String> generateOffer​(Transaction tx)
        Generates an SDP offer with media capabilities of the Endpoint. Throws:
        • SDP_END_POINT_ALREADY_NEGOTIATED If the endpoint is already negotiated.
        • SDP_END_POINT_GENERATE_OFFER_ERROR if the generated offer is empty. This is most likely due to an internal error.
        Returns:
        The SDP offer. *