@epicgames-ps/lib-pixelstreamingsignalling-ue5.8 0.1.0

package/docs/PlayerRegistry/classes/PlayerRegistry.md

@@ -0,0 +1,423 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [PlayerRegistry](../README.md) / PlayerRegistry
+
+# Class: PlayerRegistry
+
+Defined in: [Signalling/src/PlayerRegistry.ts:37](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L37)
+
+Handles all the player connections of a signalling server and
+can be used to lookup connections by id etc.
+Fires events when players are added or removed.
+Events:
+  'added': (playerId: string) Player was added.
+  'removed': (playerId: string) Player was removed.
+
+## Extends
+
+- `EventEmitter`
+
+## Constructors
+
+### new PlayerRegistry()
+
+> **new PlayerRegistry**(): [`PlayerRegistry`](PlayerRegistry.md)
+
+Defined in: [Signalling/src/PlayerRegistry.ts:42](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L42)
+
+#### Returns
+
+[`PlayerRegistry`](PlayerRegistry.md)
+
+#### Overrides
+
+`EventEmitter.constructor`
+
+## Methods
+
+### add()
+
+> **add**(`player`): `void`
+
+Defined in: [Signalling/src/PlayerRegistry.ts:52](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L52)
+
+Assigns a unique id to the player and adds it to the registry
+
+#### Parameters
+
+##### player
+
+[`IPlayer`](../interfaces/IPlayer.md)
+
+#### Returns
+
+`void`
+
+***
+
+### addListener()
+
+> **addListener**(`eventName`, `listener`): `this`
+
+Defined in: Common/dist/types/Event/EventEmitter.d.ts:39
+
+Alias for `emitter.on(eventName, listener)`.
+
+#### Parameters
+
+##### eventName
+
+`string`
+
+##### listener
+
+(...`args`) => `void`
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+`EventEmitter.addListener`
+
+***
+
+### count()
+
+> **count**(): `number`
+
+Defined in: [Signalling/src/PlayerRegistry.ts:105](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L105)
+
+Gets the total number of connected players.
+
+#### Returns
+
+`number`
+
+***
+
+### emit()
+
+> **emit**(`eventName`, ...`args`): `boolean`
+
+Defined in: Common/dist/types/Event/EventEmitter.d.ts:133
+
+Synchronously calls each of the listeners registered for the event named `eventName`, in the order they were registered, passing the supplied arguments
+to each.
+
+Returns `true` if the event had listeners, `false` otherwise.
+
+```js
+import { EventEmitter } from 'node:events';
+const myEmitter = new EventEmitter();
+
+// First listener
+myEmitter.on('event', function firstListener() {
+  console.log('Helloooo! first listener');
+});
+// Second listener
+myEmitter.on('event', function secondListener(arg1, arg2) {
+  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
+});
+// Third listener
+myEmitter.on('event', function thirdListener(...args) {
+  const parameters = args.join(', ');
+  console.log(`event with parameters ${parameters} in third listener`);
+});
+
+console.log(myEmitter.listeners('event'));
+
+myEmitter.emit('event', 1, 2, 3, 4, 5);
+
+// Prints:
+// [
+//   [Function: firstListener],
+//   [Function: secondListener],
+//   [Function: thirdListener]
+// ]
+// Helloooo! first listener
+// event with parameters 1, 2 in second listener
+// event with parameters 1, 2, 3, 4, 5 in third listener
+```
+
+#### Parameters
+
+##### eventName
+
+`string`
+
+##### args
+
+...`any`[]
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+`EventEmitter.emit`
+
+***
+
+### empty()
+
+> **empty**(): `boolean`
+
+Defined in: [Signalling/src/PlayerRegistry.ts:98](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L98)
+
+Returns true when the registry is empty.
+
+#### Returns
+
+`boolean`
+
+***
+
+### get()
+
+> **get**(`playerId`): `undefined` \| [`IPlayer`](../interfaces/IPlayer.md)
+
+Defined in: [Signalling/src/PlayerRegistry.ts:87](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L87)
+
+Gets a player from the registry using the player id.
+Returns undefined if the player doesn't exist.
+
+#### Parameters
+
+##### playerId
+
+`string`
+
+#### Returns
+
+`undefined` \| [`IPlayer`](../interfaces/IPlayer.md)
+
+***
+
+### has()
+
+> **has**(`playerId`): `boolean`
+
+Defined in: [Signalling/src/PlayerRegistry.ts:79](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L79)
+
+Tests if a player id exists in the registry.
+
+#### Parameters
+
+##### playerId
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### listPlayers()
+
+> **listPlayers**(): [`IPlayer`](../interfaces/IPlayer.md)[]
+
+Defined in: [Signalling/src/PlayerRegistry.ts:91](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L91)
+
+#### Returns
+
+[`IPlayer`](../interfaces/IPlayer.md)[]
+
+***
+
+### off()
+
+> **off**(`eventName`, `listener`): `this`
+
+Defined in: Common/dist/types/Event/EventEmitter.d.ts:88
+
+Alias for `emitter.removeListener()`.
+
+#### Parameters
+
+##### eventName
+
+`string`
+
+##### listener
+
+(...`args`) => `void`
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+`EventEmitter.off`
+
+***
+
+### on()
+
+> **on**(`eventName`, `listener`): `this`
+
+Defined in: Common/dist/types/Event/EventEmitter.d.ts:55
+
+Adds the `listener` function to the end of the listeners array for the event
+named `eventName`.
+
+```js
+server.on('connection', (stream) => {
+  console.log('someone connected!');
+});
+```
+
+Returns a reference to the `EventEmitter`, so that calls can be chained.
+
+#### Parameters
+
+##### eventName
+
+`string`
+
+The name of the event.
+
+##### listener
+
+(...`args`) => `void`
+
+The callback function
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+`EventEmitter.on`
+
+***
+
+### once()
+
+> **once**(`eventName`, `listener`): `this`
+
+Defined in: Common/dist/types/Event/EventEmitter.d.ts:70
+
+Adds a **one-time** `listener` function for the event named `eventName`. The
+next time `eventName` is triggered, this listener is removed and then invoked.
+
+```js
+server.once('connection', (stream) => {
+  console.log('Ah, we have our first user!');
+});
+```
+
+Returns a reference to the `EventEmitter`, so that calls can be chained.
+
+#### Parameters
+
+##### eventName
+
+`string`
+
+The name of the event.
+
+##### listener
+
+(...`args`) => `void`
+
+The callback function
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+`EventEmitter.once`
+
+***
+
+### remove()
+
+> **remove**(`player`): `void`
+
+Defined in: [Signalling/src/PlayerRegistry.ts:64](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L64)
+
+Removes a player from the registry. Does nothing if the id
+does not exist.
+
+#### Parameters
+
+##### player
+
+[`IPlayer`](../interfaces/IPlayer.md)
+
+#### Returns
+
+`void`
+
+***
+
+### removeAllListeners()
+
+> **removeAllListeners**(`eventName`): `this`
+
+Defined in: Common/dist/types/Event/EventEmitter.d.ts:93
+
+Removes all listeners, or those of the specified `eventName`.
+Returns a reference to the `EventEmitter`, so that calls can be chained.
+
+#### Parameters
+
+##### eventName
+
+`string`
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+`EventEmitter.removeAllListeners`
+
+***
+
+### removeListener()
+
+> **removeListener**(`eventName`, `listener`): `this`
+
+Defined in: Common/dist/types/Event/EventEmitter.d.ts:84
+
+Removes the specified `listener` from this EventEmitter.
+
+```js
+const callback = (stream) => {
+  console.log('someone connected!');
+};
+server.on('connection', callback);
+// ...
+server.removeListener('connection', callback);
+```
+Returns a reference to the `EventEmitter`, so that calls can be chained.
+
+#### Parameters
+
+##### eventName
+
+`string`
+
+##### listener
+
+(...`args`) => `void`
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+`EventEmitter.removeListener`

package/docs/PlayerRegistry/interfaces/IPlayer.md

@@ -0,0 +1,86 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [PlayerRegistry](../README.md) / IPlayer
+
+# Interface: IPlayer
+
+Defined in: [Signalling/src/PlayerRegistry.ts:10](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L10)
+
+An interface that describes a player that can be added to the
+player registry.
+
+## Extends
+
+- [`IMessageLogger`](../../LoggingUtils/interfaces/IMessageLogger.md)
+
+## Properties
+
+### playerId
+
+> **playerId**: `string`
+
+Defined in: [Signalling/src/PlayerRegistry.ts:11](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L11)
+
+***
+
+### protocol
+
+> **protocol**: `SignallingProtocol`
+
+Defined in: [Signalling/src/PlayerRegistry.ts:12](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L12)
+
+***
+
+### subscribedStreamer
+
+> **subscribedStreamer**: `null` \| [`IStreamer`](../../StreamerRegistry/interfaces/IStreamer.md)
+
+Defined in: [Signalling/src/PlayerRegistry.ts:13](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L13)
+
+## Methods
+
+### getPlayerInfo()
+
+> **getPlayerInfo**(): [`IPlayerInfo`](IPlayerInfo.md)
+
+Defined in: [Signalling/src/PlayerRegistry.ts:16](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L16)
+
+#### Returns
+
+[`IPlayerInfo`](IPlayerInfo.md)
+
+***
+
+### getReadableIdentifier()
+
+> **getReadableIdentifier**(): `string`
+
+Defined in: [Signalling/src/LoggingUtils.ts:18](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/LoggingUtils.ts#L18)
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[`IMessageLogger`](../../LoggingUtils/interfaces/IMessageLogger.md).[`getReadableIdentifier`](../../LoggingUtils/interfaces/IMessageLogger.md#getreadableidentifier)
+
+***
+
+### sendMessage()
+
+> **sendMessage**(`message`): `void`
+
+Defined in: [Signalling/src/PlayerRegistry.ts:15](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L15)
+
+#### Parameters
+
+##### message
+
+`BaseMessage`
+
+#### Returns
+
+`void`

package/docs/PlayerRegistry/interfaces/IPlayerInfo.md

@@ -0,0 +1,43 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [PlayerRegistry](../README.md) / IPlayerInfo
+
+# Interface: IPlayerInfo
+
+Defined in: [Signalling/src/PlayerRegistry.ts:22](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L22)
+
+Used by the API to describe the current state of the player.
+
+## Properties
+
+### playerId
+
+> **playerId**: `string`
+
+Defined in: [Signalling/src/PlayerRegistry.ts:23](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L23)
+
+***
+
+### remoteAddress
+
+> **remoteAddress**: `undefined` \| `string`
+
+Defined in: [Signalling/src/PlayerRegistry.ts:26](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L26)
+
+***
+
+### subscribedTo
+
+> **subscribedTo**: `undefined` \| `string`
+
+Defined in: [Signalling/src/PlayerRegistry.ts:25](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L25)
+
+***
+
+### type
+
+> **type**: `string`
+
+Defined in: [Signalling/src/PlayerRegistry.ts:24](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerRegistry.ts#L24)

package/docs/README.md

@@ -0,0 +1,19 @@
+**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**
+
+***
+
+# @epicgames-ps/lib-pixelstreamingsignalling-ue5.5
+
+## Modules
+
+- [Logger](Logger/README.md)
+- [LoggingUtils](LoggingUtils/README.md)
+- [pixelstreamingsignalling](pixelstreamingsignalling/README.md)
+- [PlayerConnection](PlayerConnection/README.md)
+- [PlayerRegistry](PlayerRegistry/README.md)
+- [SFUConnection](SFUConnection/README.md)
+- [SignallingServer](SignallingServer/README.md)
+- [StreamerConnection](StreamerConnection/README.md)
+- [StreamerRegistry](StreamerRegistry/README.md)
+- [Utils](Utils/README.md)
+- [WebServer](WebServer/README.md)

package/docs/SFUConnection/README.md

@@ -0,0 +1,11 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../README.md) / SFUConnection
+
+# SFUConnection
+
+## Classes
+
+- [SFUConnection](classes/SFUConnection.md)