Constructor
new SourceManagerClient()
Attributes
(readonly) list :Array.<String>
- Description:
List of current source ids.
- Source:
- Overrides:
(readonly) sources :SharedStateCollection
- Description:
Lightweight collection of all the sources on the network. The collection only contains information that allows to monitor or control the sources, but does not contain the actual stream of data.
If a node is interested in a particular motion stream source, it should explicity retrieve to the "full" source using SourceManager#getSource.
- Source:
- Overrides:
Methods
(async) createSource(config, nodeIdopt) → {String}
- Description:
Create a new como source.
- Source:
- Overrides:
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
config |
Object | The configuration object for the source. |
||
nodeId |
String |
<optional> |
this.como.nodeId
|
If given, creates the source on given como node. |
Returns:
The id of the created source
- Type
- String
(async) deleteRecording(Filename)
- Description:
Delete a given recording.
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
Filename |
Filename | Filename of the recording |
(async) deleteSource()
- Description:
NOT IMPLEMENTED YET
Delete an existing source.
- Source:
- Overrides:
(async) getSource(sourceId) → {SharedState|null}
- Description:
Retrieve the full version of a source (i.e. with its stream) from its id.
If the node is the owner of the source, the retrieved source will be the owned original instance of the shared state.
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
sourceId |
String |
Returns:
- Type
- SharedState | null
getSourceFiltered(sourceId) → {SharedState|undefined}
- Description:
Return the lightweight version of a source (i.e. without its stream) from its id.
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
sourceId |
String |
Returns:
- Type
- SharedState | undefined
listRecordings() → {Object}
- Description:
Returns the list of the existing recordings.
- Source:
- Overrides:
Returns:
The file tree of the projects's recordings directory
- Type
- Object
(async) readRecording(Filename) → {Blob}
- Description:
Retrieve the content of a given recording.
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
Filename |
Filename | Filename of the recording |
Returns:
- Type
- Blob
sourceExists(sourceId) → {Boolean}
- Description:
Check whether the given source id correspond to an existing source
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
sourceId |
String |
Returns:
- Type
- Boolean