Streams Unreal Engine SDK
Last updated
Last updated
You have to establish a WebSocket connection between your Unreal Engine application and your client-side to let them communicate with each other.
If you will send/receive messages from the client side, you have to embed your project into your platform with the iFrame and also integrate the Streams JS SDK as well.
You have to set the Web Socket address as a constant URL like this:
and, you have to send Header parameters while initializing the Web Socket connection like this:
First of all, you have to set up the plugin and integrate it into your application by following the plugin integration guidelines. Also, you can directly use their Blueprint template and configure it according to the unique flow of your application.
After integrating the plugin according to their guidelines, you have to replace Create WebSocket connection with Create WebSocket with Headers connection to an additional header to your Blueprint.
Then, you have to set the Server URL as ws://127.0.0.1:7788
and set the Header parameters as below,
Key: HOST
Value: 127.0.0.1:7788
First of all, you have to set up the plugin and integrate it into your application by following the plugin integration guidelines, and configure it according to the unique flow of your application.
While integrating the Blueprint flow you have to Set Header and attach this header while creating Web Socket Connection.
You have to set the Server URL as ws://127.0.0.1:7788
and set the Header parameters as,
Key: HOST
Value: 127.0.0.1:7788
You can initiate action to open a specific URL from the default browser of your visitor from inside your application. You should send a Websocket message by following the format below, message should be JSON formatted plain text message.
When your build is working with Vagon Streams, there is a prebuilt Web Socket server to send/receive your messages, so you don't need to create a separate Web Socket server in your application.
However, if you are testing your build locally you might need to change the URLs shared below to your local Web Socket server to send/receive your messages.
If your visitors are using your Applications on mobile/tablet devices, you can also allow them to type with the on-screen keyboard inside Vagon Streams. The good part is, you can manage the visibility of the on-screen keyboard button directly from your application, and trigger actions to show the keyboard button when the visitor focuses on an input inside the application. To show the On Screen Keyboard Button, you should send a Websocket message by following the format below, message should be JSON formatted plain text message.
When the focus changes from the input, you can hide the on-screen keyboard button from the screen as well. Again, you should send a Websocket message by following the format below, message should be JSON formatted plain text message.
Independently from Application Configurations, you can enable 360 View Mode inside your application by sending the following message via Websocket.
After sending this message, 360 View Mode will be activated with the first mouse click on Stream.
Independently from Application Configurations, you can disable 360 View Mode inside your application by sending the following message via Websocket.
When the Idle Duration Limit is active, you can reset the Idle Timer by sending the message below via Websocket.
You can send the following message via Websocket to turn off the Stream Machine which is running the related application.
Updates the streaming resolution and matches the iframe height and width when initiated.
Quality parameters can be set as "standard", "moderate" or "high". Session will be refreshed automatically after the quality is set.
Triggers the Session Information
event, data must be collected via Session Information
event.
Triggers the Machine ID Information
event, data must be collected via Machine ID Information
event.
Message responses will be returned as JSON-formatted string to WebSocket onMessage events. Additional parsing operation may be required.
isConnected
returns true
when user joins to the Session, returns false
when leaves the session.