Constructor
(abstract) new SdpEndpoint()
- Source:
Extends
Members
(static) constructorParams
- Source:
(static) events
- Source:
Methods
(static) generateOffer(optionsopt, callbackopt) → {external:Promise}
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:
- Source:
Returns:
-
Type
-
external:Promise
(static) getLocalSessionDescriptor(callbackopt) → {external:Promise}
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.
Parameters:
- Source:
Returns:
-
Type
-
external:Promise
(static) getRemoteSessionDescriptor(callbackopt) → {external:Promise}
This method returns the remote SDP.
If the negotiation process is not complete, it will return NULL.
Parameters:
- Source:
Returns:
-
Type
-
external:Promise
(static) processAnswer(answer, callbackopt) → {external:Promise}
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
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:
- Source:
Returns:
-
Type
-
external:Promise
(static) processOffer(offer, callbackopt) → {external:Promise}
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:
- Source:
Returns:
-
Type
-
external:Promise
Children of this MediaObject
.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
Children of this MediaObject
.
Parameters:
- Inherited From:
- Deprecated:
- Source:
Returns:
-
Type
-
external:Promise
getCreationTime(callbackopt) → {external:Promise}
MediaObject
creation time in seconds since Epoch.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
getMaxAudioRecvBandwidth(callbackopt) → {external:Promise}
Maximum bitrate expected for the received audio stream.
This is used to put a limit on the bitrate that the remote peer will send
to
this endpoint. The net effect of setting this parameter is that
when Kurento generates an SDP Offer, an 'Application Specific' (AS)
maximum bandwidth attribute will be added to the SDP media section:
b=AS:{value}
.
Note: This parameter has to be set before the SDP is generated.
- Unit: kbps (kilobits per second).
- Default: 0.
- 0 = unconstrained.
Parameters:
- Source:
Returns:
-
Type
-
external:Promise
getMaxOuputBitrate(callbackopt) → {external:Promise}
Maximum video bandwidth for transcoding.
Parameters:
- Inherited From:
- Deprecated:
- Deprecated due to a typo. Use module:core/abstracts.MediaElement#maxOutputBitrate instead of this
function.
- Source:
Returns:
-
Type
-
external:Promise
getMaxOutputBitrate(callbackopt) → {external:Promise}
Maximum video bitrate for transcoding.
- Unit: bps (bits per second).
- Default: MAXINT.
- 0 = unlimited.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
getMaxVideoRecvBandwidth(callbackopt) → {external:Promise}
Maximum bitrate expected for the received video stream.
This is used to put a limit on the bitrate that the remote peer will send
to
this endpoint. The net effect of setting this parameter is that
when Kurento generates an SDP Offer, an 'Application Specific' (AS)
maximum bandwidth attribute will be added to the SDP media section:
b=AS:{value}
.
Note: This parameter has to be set before the SDP is generated.
- Unit: kbps (kilobits per second).
- Default: 0.
- 0 = unconstrained.
Parameters:
- Source:
Returns:
-
Type
-
external:Promise
MediaPipeline to which this
MediaObject
belongs. It returns itself when invoked for a
pipeline object.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
getMinOuputBitrate(callbackopt) → {external:Promise}
Minimum video bandwidth for transcoding.
Parameters:
- Inherited From:
- Deprecated:
- Deprecated due to a typo. Use module:core/abstracts.MediaElement#minOutputBitrate instead of this
function.
- Source:
Returns:
-
Type
-
external:Promise
getMinOutputBitrate(callbackopt) → {external:Promise}
Minimum video bitrate for transcoding.
- Unit: bps (bits per second).
- Default: 0.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
This
MediaObject
's name.
This is just sugar to simplify developers' life debugging, it is not used
internally for indexing nor identifying the objects. By default, it's the
object's ID.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
Flag activating or deactivating sending the element's tags in fired events.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
setMaxAudioRecvBandwidth(maxAudioRecvBandwidth, callbackopt) → {external:Promise}
Maximum bitrate expected for the received audio stream.
This is used to put a limit on the bitrate that the remote peer will send
to
this endpoint. The net effect of setting this parameter is that
when Kurento generates an SDP Offer, an 'Application Specific' (AS)
maximum bandwidth attribute will be added to the SDP media section:
b=AS:{value}
.
Note: This parameter has to be set before the SDP is generated.
- Unit: kbps (kilobits per second).
- Default: 0.
- 0 = unconstrained.
Parameters:
- Source:
Returns:
-
Type
-
external:Promise
setMaxOuputBitrate(maxOuputBitrate, callbackopt) → {external:Promise}
Maximum video bandwidth for transcoding.
Parameters:
- Inherited From:
- Deprecated:
- Deprecated due to a typo. Use module:core/abstracts.MediaElement#maxOutputBitrate instead of this
function.
- Source:
Returns:
-
Type
-
external:Promise
setMaxOutputBitrate(maxOutputBitrate, callbackopt) → {external:Promise}
Maximum video bitrate for transcoding.
- Unit: bps (bits per second).
- Default: MAXINT.
- 0 = unlimited.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
setMaxVideoRecvBandwidth(maxVideoRecvBandwidth, callbackopt) → {external:Promise}
Maximum bitrate expected for the received video stream.
This is used to put a limit on the bitrate that the remote peer will send
to
this endpoint. The net effect of setting this parameter is that
when Kurento generates an SDP Offer, an 'Application Specific' (AS)
maximum bandwidth attribute will be added to the SDP media section:
b=AS:{value}
.
Note: This parameter has to be set before the SDP is generated.
- Unit: kbps (kilobits per second).
- Default: 0.
- 0 = unconstrained.
Parameters:
- Source:
Returns:
-
Type
-
external:Promise
setMinOuputBitrate(minOuputBitrate, callbackopt) → {external:Promise}
Minimum video bandwidth for transcoding.
Parameters:
- Inherited From:
- Deprecated:
- Deprecated due to a typo. Use module:core/abstracts.MediaElement#minOutputBitrate instead of this
function.
- Source:
Returns:
-
Type
-
external:Promise
setMinOutputBitrate(minOutputBitrate, callbackopt) → {external:Promise}
Minimum video bitrate for transcoding.
- Unit: bps (bits per second).
- Default: 0.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
This
MediaObject
's name.
This is just sugar to simplify developers' life debugging, it is not used
internally for indexing nor identifying the objects. By default, it's the
object's ID.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
Flag activating or deactivating sending the element's tags in fired events.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
Type Definitions
generateOfferCallback(error, result)
Parameters:
- Source:
getLocalSessionDescriptorCallback(error, result)
Parameters:
- Source:
getMaxAudioRecvBandwidthCallback(error, result)
Parameters:
- Source:
getMaxVideoRecvBandwidthCallback(error, result)
Parameters:
- Source:
getRemoteSessionDescriptorCallback(error, result)
Parameters:
- Source:
processAnswerCallback(error, result)
Parameters:
- Source:
processOfferCallback(error, result)
Parameters:
- Source:
setMaxAudioRecvBandwidthCallback(error)
Parameters:
- Source:
setMaxVideoRecvBandwidthCallback(error)
Parameters:
- Source: