Module: elements

Media API for the Kurento Web SDK
Copyright:
  • 2013-2015 Kurento (https://kurento.openvidu.io/)
License:
  • ALv2
Source:

Classes

AlphaBlending
Composite
Dispatcher
DispatcherOneToMany
HttpPostEndpoint
Mixer
PlayerEndpoint
RecorderEndpoint
RtpEndpoint
WebRtcEndpoint

Methods

(static) checkAlphaBlending(key, value)

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

(static) checkComposite(key, value)

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

(static) checkDispatcher(key, value)

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

(static) checkDispatcherOneToMany(key, value)

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

(static) checkHttpPostEndpoint(key, value)

Checker for module:elements.HttpPostEndpoint
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)

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

(static) checkRecorderEndpoint(key, value)

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

(static) checkRtpEndpoint(key, value)

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

(static) checkWebRtcEndpoint(key, value)

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

Events

DataChannelClosed

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

DataChannelOpened

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:

DtlsConnectionStateChange

Event fired when and ICE component DTLS connection state changes. See :rom:cls:`DtlsComponentState` for a list of possible states.
Type:
  • module:elements#event:Media
Properties:
Name Type Description
streamId external:String The ID of the stream
componentId external:String The ID of the component
connectionId external:String ID of the underlying DTLS connection
state module:elements/complexTypes.DtlsConnectionState The state of the component
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:

IceComponentStateChanged

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:

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

Fired when the recorder goes to pause state
Source:

Recording

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

Stopped

Fired when the recorder has been stopped and all the media has been written to storage.
Source: