Interface ICluster

The cluster interface.

interface ICluster {
    on: ClusterOnFunction;
    getKeyValueDatabases(strategy?): IKeyValueDatabase[];
    getLocalMediaStreams(strategy?): ILocalMediaStream[];
    getLocalNode(): LocalNode;
    getObjectStoreBuckets(strategy?): IObjectStoreBucket[];
    getPubSubTopics(strategy?): IPubSubTopic<unknown>[];
    getRemoteMediaStreams(strategy?): IRemoteMediaStream[];
    getRemoteNodes(strategy?): Node[];
    leave(): void;
    off(): void;
    off(event): void;
    off(events): void;
    openKeyValueDatabase(name, layout): Promise<IKeyValueDatabase>;
    openObjectStoreBucket(name): Promise<IObjectStoreBucket>;
    openPubSubTopic<T>(name): IPubSubTopic<T>;
    publishLocalDynamicMediaStream(label, mediaSource): ILocalDynamicMediaStream;
    publishLocalMediaStream(label, mediaSource): ILocalMediaStream;
}

Hierarchy (view full)

IClusterEventEmitter
- ICluster

Index

Properties

Methods

getKeyValueDatabases getLocalMediaStreams getLocalNode getObjectStoreBuckets getPubSubTopics getRemoteMediaStreams getRemoteNodes leave off openKeyValueDatabase openObjectStoreBucket openPubSubTopic publishLocalDynamicMediaStream publishLocalMediaStream

Properties

on

on: ClusterOnFunction

Allows listening to events published on the cluster.

Type Param: U

Any of the events defined in IClusterEvents.

Param: event

One of the events defined in IClusterEvents.

Param: listener

The callback when the event is received. Listeners' payload are defined in IClusterEvents.

Methods

getKeyValueDatabases

getKeyValueDatabases(strategy?): IKeyValueDatabase[]
Get an array of opened key-value databases.
Parameters
- Optional strategy: ((item) => boolean)
  The strategy to use to filter the key-value databases.
  - - (item): boolean
    - Parameters
      item: IKeyValueDatabase
      Returns boolean
Returns IKeyValueDatabase[]

getLocalMediaStreams

getLocalMediaStreams(strategy?): ILocalMediaStream[]
Get an array of published local media streams.
Parameters
- Optional strategy: ((item) => boolean)
  The strategy to use to filter the media streams.
  - - (item): boolean
    - Parameters
      item: ILocalMediaStream
      Returns boolean
Returns ILocalMediaStream[]

getLocalNode

getLocalNode(): LocalNode
Get the local node for this cluster.

Returns LocalNode

getObjectStoreBuckets

getObjectStoreBuckets(strategy?): IObjectStoreBucket[]
Get an array of opened object store buckets.
Parameters
- Optional strategy: ((item) => boolean)
  The strategy to use to filter the data streams.
  - - (item): boolean
    - Parameters
      item: IObjectStoreBucket
      Returns boolean
Returns IObjectStoreBucket[]

getPubSubTopics

getPubSubTopics(strategy?): IPubSubTopic<unknown>[]
Get an array of opened pub/sub topics.
Parameters
- Optional strategy: ((item) => boolean)
  The strategy to use to filter the topics.
  - - (item): boolean
    - Parameters
      item: IPubSubTopic<unknown>
      Returns boolean
Returns IPubSubTopic<unknown>[]

getRemoteMediaStreams

getRemoteMediaStreams(strategy?): IRemoteMediaStream[]
Get an array of published remote media streams.
Parameters
- Optional strategy: ((item) => boolean)
  The strategy to use to filter the media streams.
  - - (item): boolean
    - Parameters
      item: IRemoteMediaStream
      Returns boolean
Returns IRemoteMediaStream[]

getRemoteNodes

getRemoteNodes(strategy?): Node[]
Get an array of all connected remote nodes.
Parameters
- Optional strategy: ((item) => boolean)
  The strategy to use to filter the nodes.
  - - (item): boolean
    - Parameters
      item: Node
      Returns boolean
Returns Node[]

leave

leave(): void
Leave the cluster.

Returns void

off

off(): void
Unsubscribe from all events on the cluster

Returns void
Inherited from IClusterEventEmitter.off
off(event): void
Unsubscribe to an event.
Parameters
- event: string
  The event to unsubscribe from.
Returns void
Inherited from IClusterEventEmitter.off
off(events): void
Unsubscribe from all events, or a specific list of events.
Parameters
- events: string[]
  The list of events to unsubscribe from.
Returns void
Inherited from IClusterEventEmitter.off

openKeyValueDatabase

openKeyValueDatabase(name, layout): Promise<IKeyValueDatabase>
Open a key-value database.
Parameters
- name: string
  The name of the key-value database.
- layout: IDatabaseLayout | ILayoutBuilder
  The layout of the key-value database.
Returns Promise<IKeyValueDatabase>
A promise that resolves with the key-value database.

Throws
SDKClientErrorCodes.KeyValueDatabaseAlreadyExists if the key-value database is already open.

Throws
SDKClientErrorCodes.KeyValueDatabaseInvalidLayout if the layout is invalid.

Throws
SDKClientErrorCodes.KeyValueDatabaseNameNotString if the name is not a string.

openObjectStoreBucket

openObjectStoreBucket(name): Promise<IObjectStoreBucket>
Open a object store bucket.
Parameters
- name: string
  The name of the Object Store bucket.
Returns Promise<IObjectStoreBucket>
A promise that resolves with the data stream.

Throws
SDKClientErrorCodes.ObjectStoreAlreadyExists if the data stream is already open.

Throws
SDKClientErrorCodes.ObjectStoreNameNotString if the name is not a string.

openPubSubTopic

openPubSubTopic<T>(name): IPubSubTopic<T>
Open a pub/sub topic.
Type Parameters
- T
Parameters
- name: string
  The name of the PubSub Topic.
Returns IPubSubTopic<T>
The pub/sub topic.

Throws
SDKClientErrorCodes.PubSubTopicAlreadyExists if the topic already exists

Throws
SDKClientErrorCodes.PubSubTopicNameNotString if the name is not a string.

publishLocalDynamicMediaStream

publishLocalDynamicMediaStream(label, mediaSource): ILocalDynamicMediaStream
Publish a local dynamic media stream. Like a local media stream but can be modified after creation.
Parameters
- label: string
  The label of the media stream.
- mediaSource: MediaStreamSource
  The media source to publish.
Returns ILocalDynamicMediaStream
The local dynamic media stream.

Throws
SDKClientErrorCodes.LocalMediaStreamAlreadyExists if the media stream is already published.

publishLocalMediaStream

publishLocalMediaStream(label, mediaSource): ILocalMediaStream
Publish a local media stream.
Parameters
- label: string
  The label of the media stream.
- mediaSource: MediaStreamSource
  The media source to publish.
Returns ILocalMediaStream
The local media stream.

Throws
SDKClientErrorCodes.LocalMediaStreamAlreadyExists if the media stream is already published.

Interface ICluster

Hierarchy (view full)

Index

Properties

Methods

Properties

on

Type Param: U

Param: event

Param: listener

Methods

getKeyValueDatabases

Parameters

Parameters

Returns boolean

Returns IKeyValueDatabase[]

getLocalMediaStreams

Parameters

Parameters

Returns boolean

Returns ILocalMediaStream[]

getLocalNode

Returns LocalNode

getObjectStoreBuckets

Parameters

Parameters

Returns boolean

Returns IObjectStoreBucket[]

getPubSubTopics

Parameters

Parameters

Returns boolean

Returns IPubSubTopic<unknown>[]

getRemoteMediaStreams

Parameters

Parameters

Returns boolean

Returns IRemoteMediaStream[]

getRemoteNodes

Parameters

Parameters

Returns boolean

Returns Node[]

leave

Returns void

off

Returns void

Parameters

Returns void

Parameters

Returns void

openKeyValueDatabase

Parameters

Returns Promise<IKeyValueDatabase>

Throws

Throws

Throws

openObjectStoreBucket

Parameters

Returns Promise<IObjectStoreBucket>

Throws

Throws

openPubSubTopic

Type Parameters

Parameters

Returns IPubSubTopic<T>

Throws

Throws

publishLocalDynamicMediaStream

Parameters

Returns ILocalDynamicMediaStream

Throws

publishLocalMediaStream

Parameters

Returns ILocalMediaStream

Throws

Settings

Member Visibility

Theme

On This Page