Class: MediaObject

(abstract) core/abstracts.MediaObject()

Base interface used to manage capabilities common to all Kurento elements.

Properties

  • id: unique identifier assigned to this MediaObject at instantiation time. MediaPipeline IDs are generated with a GUID followed by suffix _kurento.MediaPipeline. MediaElement IDs are also a GUID with suffix _kurento.{ElementType} and prefixed by parent's ID.
    MediaPipeline ID example
    907cac3a-809a-4bbe-a93e-ae7e944c5cae_kurento.MediaPipeline
    MediaElement ID example
    907cac3a-809a-4bbe-a93e-ae7e944c5cae_kurento.MediaPipeline/403da25a-805b-4cf1-8c55-f190588e6c9b_kurento.WebRtcEndpoint
  • name: free text intended to provide a friendly name for this MediaObject. Its default value is the same as the ID.
  • tags: key-value pairs intended for applications to associate metadata to this MediaObject instance.

Events

  • ErrorEvent: reports asynchronous error events. It is recommended to always subscribe a listener to this event, as regular error from the pipeline will be notified through it, instead of through an exception when invoking a method.

Constructor

(abstract) new MediaObject()

Source:
Fires:

Extends

Members

(static) constructorParams

Source:

(static) events

Source:

Methods

(static) addTag(key, value, callbackopt) → {external:Promise}

Adds a new tag to this MediaObject. If the tag is already present, it changes the value.
Parameters:
Name Type Attributes Description
key external:String Tag name.
value external:String Value associated to this tag.
callback module:core/abstracts.MediaObject~addTagCallback <optional>
Source:
Returns:
Type
external:Promise

(static) getTag(key, callbackopt) → {external:Promise}

Returns the value of given tag, or MEDIA_OBJECT_TAG_KEY_NOT_FOUND if tag is not defined.
Parameters:
Name Type Attributes Description
key external:String Tag key.
callback module:core/abstracts.MediaObject~getTagCallback <optional>
Source:
Returns:
Type
external:Promise

(static) getTags(callbackopt) → {external:Promise}

Returns all tags attached to this MediaObject.
Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getTagsCallback <optional>
Source:
Returns:
Type
external:Promise

(static) removeTag(key, callbackopt) → {external:Promise}

Removes an existing tag. Exists silently with no error if tag is not defined.
Parameters:
Name Type Attributes Description
key external:String Tag name to be removed
callback module:core/abstracts.MediaObject~removeTagCallback <optional>
Source:
Returns:
Type
external:Promise

getChildren(callbackopt) → {external:Promise}

Children of this MediaObject.
Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getChildrenCallback <optional>
Source:
Returns:
Type
external:Promise

getChilds(callbackopt) → {external:Promise}

Children of this MediaObject.
Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getChildsCallback <optional>
Deprecated:
  • Use children instead.
Source:
Returns:
Type
external:Promise

getCreationTime(callbackopt) → {external:Promise}

MediaObject creation time in seconds since Epoch.
Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getCreationTimeCallback <optional>
Source:
Returns:
Type
external:Promise

getMediaPipeline(callbackopt) → {external:Promise}

MediaPipeline to which this MediaObject belongs. It returns itself when invoked for a pipeline object.
Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getMediaPipelineCallback <optional>
Source:
Returns:
Type
external:Promise

getName(callbackopt) → {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:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getNameCallback <optional>
Source:
Returns:
Type
external:Promise

getParent(callbackopt) → {external:Promise}

Parent of this MediaObject.

The parent of a Hub or a MediaElement is its MediaPipeline. A MediaPipeline has no parent, so this property will be null.

Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getParentCallback <optional>
Source:
Returns:
Type
external:Promise

getSendTagsInEvents(callbackopt) → {external:Promise}

Flag activating or deactivating sending the element's tags in fired events.
Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getSendTagsInEventsCallback <optional>
Source:
Returns:
Type
external:Promise

setName(name, callbackopt) → {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:
Name Type Attributes Description
name external:String
callback module:core/abstracts.MediaObject~setNameCallback <optional>
Source:
Returns:
Type
external:Promise

setSendTagsInEvents(sendTagsInEvents, callbackopt) → {external:Promise}

Flag activating or deactivating sending the element's tags in fired events.
Parameters:
Name Type Attributes Description
sendTagsInEvents external:Boolean
callback module:core/abstracts.MediaObject~setSendTagsInEventsCallback <optional>
Source:
Returns:
Type
external:Promise

Type Definitions

addTagCallback(error)

Parameters:
Name Type Description
error external:Error
Source:

getChildrenCallback(error, result)

Parameters:
Name Type Description
error external:Error
result module:core/abstracts.MediaObject
Source:

getChildsCallback(error, result)

Parameters:
Name Type Description
error external:Error
result module:core/abstracts.MediaObject
Source:

getCreationTimeCallback(error, result)

Parameters:
Name Type Description
error external:Error
result external:Integer
Source:

getMediaPipelineCallback(error, result)

Parameters:
Name Type Description
error external:Error
result module:core.MediaPipeline
Source:

getNameCallback(error, result)

Parameters:
Name Type Description
error external:Error
result external:String
Source:

getParentCallback(error, result)

Parameters:
Name Type Description
error external:Error
result module:core/abstracts.MediaObject
Source:

getSendTagsInEventsCallback(error, result)

Parameters:
Name Type Description
error external:Error
result external:Boolean
Source:

getTagCallback(error, result)

Parameters:
Name Type Description
error external:Error
result external:String The value associated to the given key.
Source:

getTagsCallback(error, result)

Parameters:
Name Type Description
error external:Error
result module:core/complexTypes.Tag An array containing all key-value pairs associated with this MediaObject.
Source:

removeTagCallback(error)

Parameters:
Name Type Description
error external:Error
Source:

setNameCallback(error)

Parameters:
Name Type Description
error external:Error
Source:

setSendTagsInEventsCallback(error)

Parameters:
Name Type Description
error external:Error
Source: