@epicgames-ps/lib-pixelstreamingsignalling-ue5.5 / StreamerConnection / StreamerConnection
StreamerConnection.StreamerConnection
A connection between the signalling server and a streamer connection. This is where messages expected to be handled by the streamer come in and where messages are sent to the streamer.
Interesting internals: streamerId: The unique id string of this streamer. transport: The ITransport where transport events can be subscribed to protocol: The SignallingProtocol where signalling messages can be subscribed to. streaming: True when the streamer is ready to accept subscriptions.
-
EventEmitter↳
StreamerConnection
• new StreamerConnection(server, ws, remoteAddress?): StreamerConnection
Initializes a new connection with given and sane values. Adds listeners for the websocket close and error and will emit a disconnected event when disconneted.
| Name | Type | Description |
|---|---|---|
server |
SignallingServer |
The signalling server object that spawned this streamer. |
ws |
WebSocket |
The websocket coupled to this streamer connection. |
remoteAddress? |
string |
The remote address of this connection. Only used as display. |
EventEmitter.constructor
• protocol: SignallingProtocol
• Optional remoteAddress: string
• streamerId: string
• streaming: boolean
• transport: ITransport
▸ getReadableIdentifier(): string
Returns an identifier that is displayed in logs.
string
A string describing this connection.
IMessageLogger.getReadableIdentifier
▸ getStreamerInfo(): IStreamerInfo
Returns a descriptive object for the REST API inspection operations.
An IStreamerInfo object containing viewable information about this connection.
▸ sendMessage(message): void
Sends a signalling message to the player.
| Name | Type | Description |
|---|---|---|
message |
BaseMessage |
The message to send. |
void