Skip to content

Latest commit

 

History

History
35 lines (19 loc) · 1.1 KB

File metadata and controls

35 lines (19 loc) · 1.1 KB

@epicgames-ps/lib-pixelstreamingcommon-ue5.5


@epicgames-ps/lib-pixelstreamingcommon-ue5.5 / Messages/message_helpers / createMessage

Function: createMessage()

createMessage(messageType, params?): BaseMessage

Defined in: Messages/message_helpers.ts:14

A helper for creating signalling messages. Takes in optional given parameters and includes them in a message object with the 'type' field set properly for the message type supplied.

Parameters

messageType

IMessageType<BaseMessage>

A message type from MessageRegistry that indicates the type of message to create.

params?

object

An optional object whose fields are added to the newly created message.

Returns

BaseMessage

The resulting message object.