Constructor
(abstract) new MediaObject()
Fires:
Extends
Members
(static) constructorParams
(static) events
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> |
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> |
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> |
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> |
Returns:
- Type
- external:Promise
getChildren(callbackopt) → {external:Promise}
children of this
MediaObject
.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getChildrenCallback |
<optional> |
Returns:
- Type
- external:Promise
getChilds(callbackopt) → {external:Promise}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getChildsCallback |
<optional> |
- Deprecated:
- (Use children instead) children of this
MediaObject
.
- (Use children instead) children of this
- 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> |
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> |
Returns:
- Type
- external:Promise
getName(callbackopt) → {external:Promise}
this
MediaObject
's name. This is just a comodity to simplify
developers' life debugging, it is not used internally for indexing nor
idenfiying the objects. By default, it's the object's ID.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getNameCallback |
<optional> |
Returns:
- Type
- external:Promise
getParent(callbackopt) → {external:Promise}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getParentCallback |
<optional> |
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> |
Returns:
- Type
- external:Promise
setName(name, callbackopt) → {external:Promise}
this
MediaObject
's name. This is just a comodity to simplify
developers' life debugging, it is not used internally for indexing nor
idenfiying 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> |
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> |
Returns:
- Type
- external:Promise
Type Definitions
addTagCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |
getChildrenCallback(error, result)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error | |
result |
module:core/abstracts.MediaObject |
getChildsCallback(error, result)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error | |
result |
module:core/abstracts.MediaObject |
getCreationTimeCallback(error, result)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error | |
result |
external:Integer |
getMediaPipelineCallback(error, result)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error | |
result |
module:core.MediaPipeline |
getNameCallback(error, result)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error | |
result |
external:String |
getParentCallback(error, result)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error | |
result |
module:core/abstracts.MediaObject |
getSendTagsInEventsCallback(error, result)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error | |
result |
external:Boolean |
getTagCallback(error, result)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error | |
result |
external:String | The value associated to the given key. |
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 . |
removeTagCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |
setNameCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |
setSendTagsInEventsCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |