Module: core

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

Classes

HubPort
MediaPipeline
PassThrough

Methods

(static) checkHubPort(key, value)

Checker for module:core.HubPort
Parameters:
Name Type Description
key external:String
value module:core.HubPort
Source:

(static) checkMediaPipeline(key, value)

Parameters:
Name Type Description
key external:String
value module:core.MediaPipeline
Source:

(static) checkPassThrough(key, value)

Parameters:
Name Type Description
key external:String
value module:core.PassThrough
Source:

Events

ConnectionStateChanged

This event is raised when the connection between two peers changes. It contains the old and the new state. Possible values are
  • CONNECTED
  • DISCONNECTED
Type:
Properties:
Name Type Description
oldState module:core/complexTypes.ConnectionState The previous state
newState module:core/complexTypes.ConnectionState The new state
Source:

ElementConnected

Indicates that an element has been connected to another
Type:
Properties:
Name Type Description
sink module:core/abstracts.MediaElement sink element in new connection
mediaType module:core/complexTypes.MediaType Media type of the connection
sourceMediaDescription external:String Description of the source media
sinkMediaDescription external:String Description of the sink media
Source:

ElementDisconnected

Indicates that an element has been disconnected from another
Type:
Properties:
Name Type Description
sink module:core/abstracts.MediaElement sink element in previous connection
mediaType module:core/complexTypes.MediaType Media type of the previous connection
sourceMediaDescription external:String Description of the source media
sinkMediaDescription external:String Description of the sink media
Source:

Error

Fired whenever an undefined error related to the MediaObject has occurred
Type:
Properties:
Name Type Description
description external:String Textual description of the error
errorCode external:Integer Server side integer error code
type external:String Integer code as a String
Source:

Media

Base for all events raised by elements in the Kurento media server.
Type:
Properties:
Name Type Description
type external:String Type of event that was raised
Source:

MediaFlowInStateChange

Fired when the incoming media flow begins or ends. The event contains:
  • State: whether the endpoint is receiving media (FLOWING) or not (NOT_FLOWING).
  • padName. The name of the pad that changed state.
  • MediaType: The type of media flowing.
Type:
Properties:
Name Type Description
state module:core/complexTypes.MediaFlowState Current media state
padName external:String Name of the pad which has media
mediaType module:core/complexTypes.MediaType Type of media that is flowing
Source:

MediaFlowOutStateChange

Fired when the outgoing media flow begins or ends. The event contains:
  • State: whether the endpoint is sending media (FLOWING) or not (NOT_FLOWING).
  • padName. The name of the pad that changed state.
  • MediaType: The type of media flowing.
Type:
Properties:
Name Type Description
state module:core/complexTypes.MediaFlowState Current media state
padName external:String Name of the pad which has media
mediaType module:core/complexTypes.MediaType Type of media that is flowing
Source:

MediaSessionStarted

Event raised when a session starts. This event has no data.
Source:

MediaSessionTerminated

Event raised when a session is terminated. This event has no data.
Source:

MediaStateChanged

This event is fired when the media connection between two peers changes, based on the RTCP packet flow. It contains the old and the new state. Possible values are
  • CONNECTED
  • DISCONNECTED
Type:
Properties:
Name Type Description
oldState module:core/complexTypes.MediaState The previous state
newState module:core/complexTypes.MediaState The new state
Source:

MediaTranscodingStateChange

Event fired when an incoming media begins and codec transcoding is either required or not.
Type:
Properties:
Name Type Description
state module:core/complexTypes.MediaTranscodingState Current transcoding state; either enabled or disabled.
binName external:String Name of the GStreamer bin which is processing the media.
mediaType module:core/complexTypes.MediaType Type of media that is being processed; either audio or video.
Source:

ObjectCreated

Indicates that an object has been created on the mediaserver
Type:
Properties:
Name Type Description
object module:core/abstracts.MediaObject The object that has been created
Source:

ObjectDestroyed

Indicates that an object has been destroyed on the mediaserver
Type:
Properties:
Name Type Description
objectId external:String The id of the object that has been destroyed
Source:

RaiseBase

Properties:
Name Type Description
source module:core/abstracts.MediaObject Object that raised the event
timestamp external:String [DEPRECATED: Use timestampMillis] The timestamp associated with this object:
timestampMillis external:String The timestamp associated with this event: Milliseconds elapsed since the UNIX Epoch (Jan 1, 1970, UTC).
tags module:core/complexTypes.Tag
Source:

UriEndpointStateChanged

Indicates the new state of the endpoint
Type:
Properties:
Name Type Description
state module:core/complexTypes.UriEndpointState the new state
Source: