Skip to content

Commit 2420d78

Browse files
Merge pull request #438 from mcottontensor/backport/UE5.5/pr-429
[UE5.5] Merge pull request #429 from mcottontensor/esm_fix
2 parents e068a67 + 2084bcd commit 2420d78

File tree

65 files changed

+1983
-382
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+1983
-382
lines changed

Common/docs/Event/EventEmitter/classes/EventEmitter.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ myEmitter.emit('event');
6363

6464
#### Defined in
6565

66-
[Event/EventEmitter.ts:67](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Event/EventEmitter.ts#L67)
66+
[Event/EventEmitter.ts:67](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Event/EventEmitter.ts#L67)
6767

6868
## Methods
6969

@@ -89,7 +89,7 @@ Alias for `emitter.on(eventName, listener)`.
8989

9090
#### Defined in
9191

92-
[Event/EventEmitter.ts:97](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Event/EventEmitter.ts#L97)
92+
[Event/EventEmitter.ts:97](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Event/EventEmitter.ts#L97)
9393

9494
***
9595

@@ -151,7 +151,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
151151

152152
#### Defined in
153153

154-
[Event/EventEmitter.ts:263](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Event/EventEmitter.ts#L263)
154+
[Event/EventEmitter.ts:263](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Event/EventEmitter.ts#L263)
155155

156156
***
157157

@@ -177,7 +177,7 @@ Alias for `emitter.removeListener()`.
177177

178178
#### Defined in
179179

180-
[Event/EventEmitter.ts:197](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Event/EventEmitter.ts#L197)
180+
[Event/EventEmitter.ts:197](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Event/EventEmitter.ts#L197)
181181

182182
***
183183

@@ -216,7 +216,7 @@ The callback function
216216

217217
#### Defined in
218218

219-
[Event/EventEmitter.ts:116](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Event/EventEmitter.ts#L116)
219+
[Event/EventEmitter.ts:116](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Event/EventEmitter.ts#L116)
220220

221221
***
222222

@@ -255,7 +255,7 @@ The callback function
255255

256256
#### Defined in
257257

258-
[Event/EventEmitter.ts:149](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Event/EventEmitter.ts#L149)
258+
[Event/EventEmitter.ts:149](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Event/EventEmitter.ts#L149)
259259

260260
***
261261

@@ -278,7 +278,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
278278

279279
#### Defined in
280280

281-
[Event/EventEmitter.ts:205](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Event/EventEmitter.ts#L205)
281+
[Event/EventEmitter.ts:205](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Event/EventEmitter.ts#L205)
282282

283283
***
284284

@@ -314,4 +314,4 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
314314

315315
#### Defined in
316316

317-
[Event/EventEmitter.ts:189](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Event/EventEmitter.ts#L189)
317+
[Event/EventEmitter.ts:189](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Event/EventEmitter.ts#L189)

Common/docs/Logger/Logger/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@
1717
- [LoggerContext](classes/LoggerContext.md)
1818
- [LoggerType](classes/LoggerType.md)
1919

20+
### Interfaces
21+
22+
- [ILogger](interfaces/ILogger.md)
23+
2024
### Variables
2125

2226
- [Logger](variables/Logger.md)
27+
28+
### Functions
29+
30+
- [overrideLogger](functions/overrideLogger.md)

Common/docs/Logger/Logger/classes/LoggerContext.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ to be shared with any Logger instances.
2929
3030
#### Defined in
3131

32-
[Logger/Logger.ts:25](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L25)
32+
[Logger/Logger.ts:25](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L25)
3333

3434
***
3535

@@ -39,4 +39,4 @@ to be shared with any Logger instances.
3939
4040
#### Defined in
4141

42-
[Logger/Logger.ts:24](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L24)
42+
[Logger/Logger.ts:24](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L24)

Common/docs/Logger/Logger/classes/LoggerType.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
A basic console logger utilized by the Pixel Streaming frontend to allow
1010
logging to the browser console.
1111

12+
## Implements
13+
14+
- [`ILogger`](../interfaces/ILogger.md)
15+
1216
## Constructors
1317

1418
### new LoggerType()
@@ -27,7 +31,7 @@ logging to the browser console.
2731
2832
#### Defined in
2933

30-
[Logger/Logger.ts:33](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L33)
34+
[Logger/Logger.ts:45](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L45)
3135

3236
## Methods
3337

@@ -49,9 +53,13 @@ the message to be logged
4953

5054
`void`
5155

56+
#### Implementation of
57+
58+
[`ILogger`](../interfaces/ILogger.md).[`Debug`](../interfaces/ILogger.md#debug)
59+
5260
#### Defined in
5361

54-
[Logger/Logger.ts:48](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L48)
62+
[Logger/Logger.ts:60](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L60)
5563

5664
***
5765

@@ -73,9 +81,13 @@ the message to be logged
7381

7482
`void`
7583

84+
#### Implementation of
85+
86+
[`ILogger`](../interfaces/ILogger.md).[`Error`](../interfaces/ILogger.md#error)
87+
7688
#### Defined in
7789

78-
[Logger/Logger.ts:81](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L81)
90+
[Logger/Logger.ts:93](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L93)
7991

8092
***
8193

@@ -97,9 +109,13 @@ the message to be logged
97109

98110
`void`
99111

112+
#### Implementation of
113+
114+
[`ILogger`](../interfaces/ILogger.md).[`Info`](../interfaces/ILogger.md#info)
115+
100116
#### Defined in
101117

102-
[Logger/Logger.ts:59](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L59)
118+
[Logger/Logger.ts:71](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L71)
103119

104120
***
105121

@@ -123,9 +139,13 @@ Set the log verbosity level
123139

124140
`void`
125141

142+
#### Implementation of
143+
144+
[`ILogger`](../interfaces/ILogger.md).[`InitLogging`](../interfaces/ILogger.md#initlogging)
145+
126146
#### Defined in
127147

128-
[Logger/Logger.ts:38](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L38)
148+
[Logger/Logger.ts:50](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L50)
129149

130150
***
131151

@@ -147,6 +167,10 @@ the message to be logged
147167

148168
`void`
149169

170+
#### Implementation of
171+
172+
[`ILogger`](../interfaces/ILogger.md).[`Warning`](../interfaces/ILogger.md#warning)
173+
150174
#### Defined in
151175

152-
[Logger/Logger.ts:70](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L70)
176+
[Logger/Logger.ts:82](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L82)

Common/docs/Logger/Logger/enumerations/LogLevel.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
1515
#### Defined in
1616

17-
[Logger/Logger.ts:14](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L14)
17+
[Logger/Logger.ts:14](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L14)
1818

1919
***
2020

@@ -24,7 +24,7 @@
2424
2525
#### Defined in
2626

27-
[Logger/Logger.ts:10](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L10)
27+
[Logger/Logger.ts:10](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L10)
2828

2929
***
3030

@@ -34,7 +34,7 @@
3434
3535
#### Defined in
3636

37-
[Logger/Logger.ts:11](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L11)
37+
[Logger/Logger.ts:11](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L11)
3838

3939
***
4040

@@ -44,7 +44,7 @@
4444
4545
#### Defined in
4646

47-
[Logger/Logger.ts:13](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L13)
47+
[Logger/Logger.ts:13](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L13)
4848

4949
***
5050

@@ -54,4 +54,4 @@
5454
5555
#### Defined in
5656

57-
[Logger/Logger.ts:12](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L12)
57+
[Logger/Logger.ts:12](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L12)
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
[**@epicgames-ps/lib-pixelstreamingcommon-ue5.5**](../../../README.md)
2+
3+
***
4+
5+
[@epicgames-ps/lib-pixelstreamingcommon-ue5.5](../../../README.md) / [Logger/Logger](../README.md) / overrideLogger
6+
7+
# Function: overrideLogger()
8+
9+
> **overrideLogger**(`logger`): `void`
10+
11+
## Parameters
12+
13+
### logger
14+
15+
[`ILogger`](../interfaces/ILogger.md)
16+
17+
## Returns
18+
19+
`void`
20+
21+
## Defined in
22+
23+
[Logger/Logger.ts:36](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L36)
Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
[**@epicgames-ps/lib-pixelstreamingcommon-ue5.5**](../../../README.md)
2+
3+
***
4+
5+
[@epicgames-ps/lib-pixelstreamingcommon-ue5.5](../../../README.md) / [Logger/Logger](../README.md) / ILogger
6+
7+
# Interface: ILogger
8+
9+
## Methods
10+
11+
### Debug()
12+
13+
> **Debug**(`message`): `void`
14+
15+
#### Parameters
16+
17+
##### message
18+
19+
`string`
20+
21+
#### Returns
22+
23+
`void`
24+
25+
#### Defined in
26+
27+
[Logger/Logger.ts:30](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L30)
28+
29+
***
30+
31+
### Error()
32+
33+
> **Error**(`message`): `void`
34+
35+
#### Parameters
36+
37+
##### message
38+
39+
`string`
40+
41+
#### Returns
42+
43+
`void`
44+
45+
#### Defined in
46+
47+
[Logger/Logger.ts:33](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L33)
48+
49+
***
50+
51+
### Info()
52+
53+
> **Info**(`message`): `void`
54+
55+
#### Parameters
56+
57+
##### message
58+
59+
`string`
60+
61+
#### Returns
62+
63+
`void`
64+
65+
#### Defined in
66+
67+
[Logger/Logger.ts:31](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L31)
68+
69+
***
70+
71+
### InitLogging()
72+
73+
> **InitLogging**(`logLevel`, `includeStack`): `void`
74+
75+
#### Parameters
76+
77+
##### logLevel
78+
79+
`number`
80+
81+
##### includeStack
82+
83+
`boolean`
84+
85+
#### Returns
86+
87+
`void`
88+
89+
#### Defined in
90+
91+
[Logger/Logger.ts:29](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L29)
92+
93+
***
94+
95+
### Warning()
96+
97+
> **Warning**(`message`): `void`
98+
99+
#### Parameters
100+
101+
##### message
102+
103+
`string`
104+
105+
#### Returns
106+
107+
`void`
108+
109+
#### Defined in
110+
111+
[Logger/Logger.ts:32](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L32)

Common/docs/Logger/Logger/variables/Logger.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
# Variable: Logger
88

9-
> `const` **Logger**: [`LoggerType`](../classes/LoggerType.md)
9+
> **Logger**: [`ILogger`](../interfaces/ILogger.md)
1010
1111
## Defined in
1212

13-
[Logger/Logger.ts:144](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Logger/Logger.ts#L144)
13+
[Logger/Logger.ts:156](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Logger/Logger.ts#L156)

Common/docs/Messages/base_message/interfaces/BaseMessage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ All Pixel Streaming messages should adhere to this interface.
1616
1717
#### Defined in
1818

19-
[Messages/base\_message.ts:8](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Messages/base_message.ts#L8)
19+
[Messages/base\_message.ts:8](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Messages/base_message.ts#L8)
2020

2121
***
2222

@@ -26,4 +26,4 @@ All Pixel Streaming messages should adhere to this interface.
2626
2727
#### Defined in
2828

29-
[Messages/base\_message.ts:6](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/457a0dc3b3c9a47385d92ffbc69496977cee683b/Common/src/Messages/base_message.ts#L6)
29+
[Messages/base\_message.ts:6](https://github.com/mcottontensor/PixelStreamingInfrastructure/blob/80aa060d880a8c194a04b83f18bd1ee360ab20e1/Common/src/Messages/base_message.ts#L6)

0 commit comments

Comments
 (0)