Skip to main content

FM WebSocket 4.0

Description​

Minimal setup guide for Internet Live Stream via FMWebsocketManager.

Basic Setup​

FM WebSocket 4.0 supports “Room System” with customised room name. All the data are streaming through the self-host node.js server. (server script included in the package)

This package includes example script of a very light-weight node.js server, which you may host it on any Cloud Virtual Machine(linux, windows or mac)

There are two parts in this tutorial setup.​

Part A: node.js server

Part B: Unity3D FMWebSocketManager

Part A: Node.js server​

Our example server is located in our plugin root folder

/FMWebSocket/TestServer_v6.x.x/Resources/FMWebSocket
  1. Install npm + node.js Download and install necessary items
https://nodejs.org/en/download/
  1. Install express https://expressjs.com/en/starter/installing.html
cmd/terminal: npm init
cmd/terminal: Enter…
cmd/terminal: npm install express –save
  1. Install ws module
cmd/terminal: npm install ws
  1. Finish & Test on localhost

You may follow this step-by-step tutorial, the commands are compatible in Mac/Windows/Linux https://youtu.be/Zjm5KGHyceU​

Part B: Unity3D FMWebSocketManager Setup​

Setup for Sender Scene(Sender)​

  1. Create new Game Object and Add Component FMWebSocketManager

  2. Choose NetworkType as Room, IP address should be your node.js server’s IP, default 127.0.0.1 is just for testing on local machine. fmetp-stream-fmwebsocket4-s1

  3. Create a Camera Object and rename as “RenderCam” fmetp-stream-fmwebsocket4-s2

  4. Create new Game Object and Add Component GameViewEncoder

  5. Assign “RenderCam” into GameViewEncoder Settings->RenderCam fmetp-stream-fmwebsocket4-s3

  • MainCam mode is recommended for good performance, you may assign “Main Camera” instead adding extra RenderCam
  • RenderCam mode is only recommended for older WebGL Build, to prevent any flickering bug on Web Browser.
  • Output Format FMVPX(VP8) is recommended for compatibility
  1. Add Event “+”, and assign FMWebSocketManager into OnDataByteReadyEvent
  2. Change “No Function” to FMWebSocketManger -> SendToOthers(Dynamic Byte[]) fmetp-stream-fmwebsocket4-s4

Setup for Receiver Scene(Receiver)​

  1. Create new Game Object and Add Component GameViewDecoder, Assign the preview type Raw Image for quick preview. fmetp-stream-fmwebsocket4-c1
  2. Create new Game Object and Add Component FMWebSocketManager
  3. Choose NetworkType as Room, IP address should be your node.js server’s IP, default 127.0.0.1 is just for testing on local machine.
  4. Add GameViewDecoder to FMWebSocketManager -> OnReceivedByteDataEvent
  5. Change “No Function” to GameViewDecoder -> Action_ProcessImageData(Dynamic Byte[]) fmetp-stream-fmwebsocket4-c2