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

package/docs/StreamerRegistry/interfaces/IStreamer.md

@@ -0,0 +1,375 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [StreamerRegistry](../README.md) / IStreamer
+
+# Interface: IStreamer
+
+Defined in: [Signalling/src/StreamerRegistry.ts:17](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L17)
+
+An interface that describes a streamer that can be added to the
+streamer registry.
+
+## Extends
+
+- `EventEmitter`.[`IMessageLogger`](../../LoggingUtils/interfaces/IMessageLogger.md)
+
+## Properties
+
+### maxSubscribers
+
+> **maxSubscribers**: `number`
+
+Defined in: [Signalling/src/StreamerRegistry.ts:22](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L22)
+
+***
+
+### protocol
+
+> **protocol**: `SignallingProtocol`
+
+Defined in: [Signalling/src/StreamerRegistry.ts:20](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L20)
+
+***
+
+### streamerId
+
+> **streamerId**: `string`
+
+Defined in: [Signalling/src/StreamerRegistry.ts:18](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L18)
+
+***
+
+### streaming
+
+> **streaming**: `boolean`
+
+Defined in: [Signalling/src/StreamerRegistry.ts:21](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L21)
+
+***
+
+### subscribers
+
+> **subscribers**: `Set`\<`string`\>
+
+Defined in: [Signalling/src/StreamerRegistry.ts:23](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L23)
+
+***
+
+### transport
+
+> **transport**: `ITransport`
+
+Defined in: [Signalling/src/StreamerRegistry.ts:19](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L19)
+
+## Methods
+
+### 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`
+
+***
+
+### 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`
+
+***
+
+### 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)
+
+***
+
+### getStreamerInfo()
+
+> **getStreamerInfo**(): [`IStreamerInfo`](IStreamerInfo.md)
+
+Defined in: [Signalling/src/StreamerRegistry.ts:26](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L26)
+
+#### Returns
+
+[`IStreamerInfo`](IStreamerInfo.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`
+
+***
+
+### 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`
+
+***
+
+### sendMessage()
+
+> **sendMessage**(`message`): `void`
+
+Defined in: [Signalling/src/StreamerRegistry.ts:25](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L25)
+
+#### Parameters
+
+##### message
+
+`BaseMessage`
+
+#### Returns
+
+`void`

package/docs/StreamerRegistry/interfaces/IStreamerInfo.md

@@ -0,0 +1,51 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [StreamerRegistry](../README.md) / IStreamerInfo
+
+# Interface: IStreamerInfo
+
+Defined in: [Signalling/src/StreamerRegistry.ts:32](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L32)
+
+Used by the API to describe a streamer.
+
+## Properties
+
+### remoteAddress
+
+> **remoteAddress**: `undefined` \| `string`
+
+Defined in: [Signalling/src/StreamerRegistry.ts:36](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L36)
+
+***
+
+### streamerId
+
+> **streamerId**: `string`
+
+Defined in: [Signalling/src/StreamerRegistry.ts:33](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L33)
+
+***
+
+### streaming
+
+> **streaming**: `boolean`
+
+Defined in: [Signalling/src/StreamerRegistry.ts:35](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L35)
+
+***
+
+### subscribers
+
+> **subscribers**: [`IPlayerInfo`](../../PlayerRegistry/interfaces/IPlayerInfo.md)[]
+
+Defined in: [Signalling/src/StreamerRegistry.ts:37](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L37)
+
+***
+
+### type
+
+> **type**: `string`
+
+Defined in: [Signalling/src/StreamerRegistry.ts:34](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/StreamerRegistry.ts#L34)

package/docs/Utils/README.md

@@ -0,0 +1,12 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../README.md) / Utils
+
+# Utils
+
+## Functions
+
+- [beautify](functions/beautify.md)
+- [stringify](functions/stringify.md)

package/docs/Utils/functions/beautify.md

@@ -0,0 +1,23 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [Utils](../README.md) / beautify
+
+# Function: beautify()
+
+> **beautify**(`obj`): `string`
+
+Defined in: [Signalling/src/Utils.ts:13](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/Utils.ts#L13)
+
+Circular reference save version of JSON.stringify with extra formatting.
+
+## Parameters
+
+### obj
+
+`any`
+
+## Returns
+
+`string`

package/docs/Utils/functions/stringify.md

@@ -0,0 +1,23 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [Utils](../README.md) / stringify
+
+# Function: stringify()
+
+> **stringify**(`obj`): `string`
+
+Defined in: [Signalling/src/Utils.ts:6](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/Utils.ts#L6)
+
+Cirular reference safe version of JSON.stringify
+
+## Parameters
+
+### obj
+
+`any`
+
+## Returns
+
+`string`

package/docs/WebServer/README.md

@@ -0,0 +1,15 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../README.md) / WebServer
+
+# WebServer
+
+## Classes
+
+- [WebServer](classes/WebServer.md)
+
+## Interfaces
+
+- [IWebServerConfig](interfaces/IWebServerConfig.md)

package/docs/WebServer/classes/WebServer.md

@@ -0,0 +1,50 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [WebServer](../README.md) / WebServer
+
+# Class: WebServer
+
+Defined in: [Signalling/src/WebServer.ts:47](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L47)
+
+An object to manage the initialization of a web server. Used to serve the
+pixel streaming frontend.
+
+## Constructors
+
+### new WebServer()
+
+> **new WebServer**(`app`, `config`): [`WebServer`](WebServer.md)
+
+Defined in: [Signalling/src/WebServer.ts:51](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L51)
+
+#### Parameters
+
+##### app
+
+`Express`
+
+##### config
+
+[`IWebServerConfig`](../interfaces/IWebServerConfig.md)
+
+#### Returns
+
+[`WebServer`](WebServer.md)
+
+## Properties
+
+### httpServer
+
+> **httpServer**: `undefined` \| `Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>
+
+Defined in: [Signalling/src/WebServer.ts:48](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L48)
+
+***
+
+### httpsServer
+
+> **httpsServer**: `undefined` \| `Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>
+
+Defined in: [Signalling/src/WebServer.ts:49](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L49)

package/docs/WebServer/interfaces/IWebServerConfig.md

@@ -0,0 +1,76 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [WebServer](../README.md) / IWebServerConfig
+
+# Interface: IWebServerConfig
+
+Defined in: [Signalling/src/WebServer.ts:17](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L17)
+
+An interface that describes the possible options to pass to
+WebServer.
+
+## Properties
+
+### homepageFile
+
+> **homepageFile**: `string`
+
+Defined in: [Signalling/src/WebServer.ts:25](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L25)
+
+***
+
+### httpPort
+
+> **httpPort**: `number`
+
+Defined in: [Signalling/src/WebServer.ts:19](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L19)
+
+***
+
+### https\_redirect?
+
+> `optional` **https\_redirect**: `boolean`
+
+Defined in: [Signalling/src/WebServer.ts:40](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L40)
+
+***
+
+### httpsPort?
+
+> `optional` **httpsPort**: `number`
+
+Defined in: [Signalling/src/WebServer.ts:31](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L31)
+
+***
+
+### perMinuteRateLimit?
+
+> `optional` **perMinuteRateLimit**: `number`
+
+Defined in: [Signalling/src/WebServer.ts:28](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L28)
+
+***
+
+### root
+
+> **root**: `string`
+
+Defined in: [Signalling/src/WebServer.ts:22](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L22)
+
+***
+
+### ssl\_cert?
+
+> `optional` **ssl\_cert**: `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [Signalling/src/WebServer.ts:37](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L37)
+
+***
+
+### ssl\_key?
+
+> `optional` **ssl\_key**: `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [Signalling/src/WebServer.ts:34](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/WebServer.ts#L34)