Module: elements

Media API for the Kurento Web SDK
License:
  • ALv2
Source:

Classes

AlphaBlending
Composite
Dispatcher
DispatcherOneToMany
HttpPostEndpoint
Mixer
PlayerEndpoint
RecorderEndpoint
RtpEndpoint
WebRtcEndpoint

Methods

(static) checkAlphaBlending(key, value)

Parameters:
Name Type Description
key external:String
value module:elements.AlphaBlending
Source:

(static) checkComposite(key, value)

Parameters:
Name Type Description
key external:String
value module:elements.Composite
Source:

(static) checkDispatcher(key, value)

Parameters:
Name Type Description
key external:String
value module:elements.Dispatcher
Source:

(static) checkDispatcherOneToMany(key, value)

Parameters:
Name Type Description
key external:String
value module:elements.DispatcherOneToMany
Source:

(static) checkHttpPostEndpoint(key, value)

Parameters:
Name Type Description
key external:String
value module:elements.HttpPostEndpoint
Source:

(static) checkMixer(key, value)

Checker for module:elements.Mixer
Parameters:
Name Type Description
key external:String
value module:elements.Mixer
Source:

(static) checkPlayerEndpoint(key, value)

Parameters:
Name Type Description
key external:String
value module:elements.PlayerEndpoint
Source:

(static) checkRecorderEndpoint(key, value)

Parameters:
Name Type Description
key external:String
value module:elements.RecorderEndpoint
Source:

(static) checkRtpEndpoint(key, value)

Parameters:
Name Type Description
key external:String
value module:elements.RtpEndpoint
Source:

(static) checkWebRtcEndpoint(key, value)

Parameters:
Name Type Description
key external:String
value module:elements.WebRtcEndpoint
Source:

Events

DataChannelClose

Event fired when a data channel is closed.
Type:
  • module:elements#event:Media
Properties:
Name Type Description
channelId external:Integer The channel identifier
Source:

DataChannelOpen

Event fired when a new data channel is created.
Type:
  • module:elements#event:Media
Properties:
Name Type Description
channelId external:Integer The channel identifier
Source:

EndOfStream

Event raised when the stream that the element sends out is finished.
Source:

IceCandidateFound

Notifies a new local candidate. These candidates should be sent to the remote peer, to complete the ICE negotiation process.
Type:
  • module:elements#event:Media
Properties:
Name Type Description
candidate module:elements/complexTypes.IceCandidate New local candidate
Source:

IceComponentStateChange

Event fired when and ICE component state changes. See :rom:cls:`IceComponentState` for a list of possible states.
Type:
  • module:elements#event:Media
Properties:
Name Type Description
streamId external:Integer The ID of the stream
componentId external:Integer The ID of the component
state module:elements/complexTypes.IceComponentState The state of the component
Source:

IceGatheringDone

Event fired when al ICE candidates have been gathered.
Source:

NewCandidatePairSelected

Event fired when a new pair of ICE candidates is used by the ICE library. This could also happen in the middle of a session, though not likely.
Type:
  • module:elements#event:Media
Properties:
Name Type Description
candidatePair module:elements/complexTypes.IceCandidatePair The new pair of candidates
Source:

OnDataChannelClosed

Event fired when a data channel is closed.
Type:
  • module:elements#event:Media
Properties:
Name Type Description
channelId external:Integer The channel identifier
Deprecated:
  • Use DataChannelClose instead.
Source:

OnDataChannelOpened

Event fired when a new data channel is created.
Type:
  • module:elements#event:Media
Properties:
Name Type Description
channelId external:Integer The channel identifier
Deprecated:
  • Use DataChannelOpen instead.
Source:

OnIceCandidate

Notifies a new local candidate. These candidates should be sent to the remote peer, to complete the ICE negotiation process.
Type:
  • module:elements#event:Media
Properties:
Name Type Description
candidate module:elements/complexTypes.IceCandidate New local candidate
Deprecated:
  • Use IceCandidateFound instead.
Source:

OnIceComponentStateChanged

Event fired when and ICE component state changes. See :rom:cls:`IceComponentState` for a list of possible states.
Type:
  • module:elements#event:Media
Properties:
Name Type Description
streamId external:Integer The ID of the stream
componentId external:Integer The ID of the component
state module:elements/complexTypes.IceComponentState The state of the component
Deprecated:
  • Use IceComponentStateChange instead.
Source:

OnIceGatheringDone

Event fired when al ICE candidates have been gathered.
Deprecated:
  • Use IceGatheringDone instead.
Source:

OnKeySoftLimit

Fired when encryption is used and any stream reached the soft key usage limit, which means it will expire soon.
Type:
  • module:elements#event:Media
Properties:
Name Type Description
mediaType external:MediaType The media stream
Source:

Paused

Source:

Recording

Fired when the recoding effectively starts. ie: Media is received by the recorder and record method has been called.
Source:

Stopped

Source: