Class: ServerManager

core/abstracts.ServerManager

This is a standalone object for managing the MediaServer

Constructor

(abstract) new ServerManager()

Source:
Fires:

Extends

Members

(static) constructorParams

Source:

(static) events

Source:

Methods

(static) getKmd(moduleName, callbackopt) → {external:Promise}

Returns the kmd associated to a module
Parameters:
Name Type Attributes Description
moduleName external:String Name of the module to get its kmd file
callback module:core/abstracts.ServerManager~getKmdCallback <optional>
Source:
Returns:
Type
external:Promise

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

Returns the amount of memory that the server is using in KiB
Parameters:
Name Type Attributes Description
callback module:core/abstracts.ServerManager~getUsedMemoryCallback <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>
Inherited From:
Source:
Returns:
Type
external:Promise

getChilds(callbackopt) → {external:Promise}

Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getChildsCallback <optional>
Inherited From:
Deprecated:
  • (Use children instead) children of this MediaObject.
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>
Inherited From:
Source:
Returns:
Type
external:Promise

getInfo(callbackopt) → {external:Promise}

Server information, version, modules, factories, etc
Parameters:
Name Type Attributes Description
callback module:core/abstracts.ServerManager~getInfoCallback <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>
Inherited From:
Source:
Returns:
Type
external:Promise

getMetadata(callbackopt) → {external:Promise}

Metadata stored in the server
Parameters:
Name Type Attributes Description
callback module:core/abstracts.ServerManager~getMetadataCallback <optional>
Source:
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>
Inherited From:
Source:
Returns:
Type
external:Promise

getParent(callbackopt) → {external:Promise}

parent of this MediaObject. The parent of a Hub or a
Parameters:
Name Type Attributes Description
callback module:core/abstracts.MediaObject~getParentCallback <optional>
Inherited From:
Source:
Returns:
Type
external:Promise

getPipelines(callbackopt) → {external:Promise

All the pipelines available in the server
Parameters:
Name Type Attributes Description
callback module:core/abstracts.ServerManager~getPipelinesCallback <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>
Inherited From:
Source:
Returns:
Type
external:Promise

getSessions(callbackopt) → {external:Promise}

All active sessions in the server
Parameters:
Name Type Attributes Description
callback module:core/abstracts.ServerManager~getSessionsCallback <optional>
Source:
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>
Inherited From:
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>
Inherited From:
Source:
Returns:
Type
external:Promise

Type Definitions

getInfoCallback(error, result)

Parameters:
Name Type Description
error external:Error
result module:core/complexTypes.ServerInfo
Source:

getKmdCallback(error, result)

Parameters:
Name Type Description
error external:Error
result external:String The kmd file
Source:

getMetadataCallback(error, result)

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

getPipelinesCallback(error, result)

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

getSessionsCallback(error, result)

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

getUsedMemoryCallback(error, result)

Parameters:
Name Type Description
error external:Error
result external:int64 The amount of KiB of memory being used
Source: