Stream Methods

Real-time data streaming between the game and the backend.

StreamEmitter

When a stream starts, a StreamEmitter is returned. Use it to subscribe to events and stop the stream.

emitter.on(eventName, handler)   // subscribe, returns unsubscribe fn
emitter.off(eventName, handler)  // unsubscribe
emitter.stop(reason)             // stop the stream
emitter.id                       // stream ID
emitter.stream                   // stream name

Event	Description
data	New data arrived
stream.accepted	Stream accepted by server
stream.started	Stream started
stream.end	Stream ended

---

sendData

Sends data over the active game stream.

JavaScript

gametegra.sendData({ action: 'move', x: 10, y: 20 })

Unity

await gametegra.sendData(gametegra.@params("action","move","x",10,"y",20));

Godot

var result = await gametegra.sendData({ 'action': 'move', 'x': 10, 'y': 20 })

Parameters:

Name	Type	Required	Description
params	object	Yes	Data payload to send.

Response:

{
  "onClientSuccess": true,
  "onHostSuccess": true,
  "data": {
    "success": true
  },
  "errorMessage": null
}

---

listenData

Starts listening to incoming game stream data. Returns an Emitter.

JavaScript

const emitter = await gametegra.listenData()
emitter.on('data', (payload) => { console.log(payload) })

Unity

var emitter = await gametegra.listenData(true);
emitter.OnData += (payload) => Debug.Log(payload);

Godot

var emitter = await gametegra.listenData()
emitter.on('data', func(payload): print(payload))

Parameters:

Name	Type	Required	Description
params	object	No	Optional filter/options for the stream.

Response:

{
  "eventType": "data",
  "payload": {
    "action": "move",
    "x": 10,
    "y": 20
  }
}

---

connectGame

Connects to a named game stream and returns an Emitter for real-time events.

JavaScript

const emitter = await gametegra.connectGame('game-events')
emitter.on('data', (e) => handleEvent(e))

Unity

var emitter = await gametegra.connectGame("game-events");
emitter.OnData += HandleEvent;

Godot

var emitter = await gametegra.connectGame('game-events')
emitter.on('data', func(e): handle_event(e))

Parameters:

Name	Type	Required	Description
streamName	string	Yes	Name of the game stream to connect to.
options	object	No	Optional stream configuration.

Response:

{
  "eventType": "data",
  "payload": {
    "type": "player_joined",
    "userId": "d2f2e862-7db2-46ce-9bc7-469739fcb618"
  }
}

---

stopStream

Stops an active stream by its channel key.

JavaScript

await gametegra.stopStream('room-chat-lobby')

Unity

await gametegra.stopStream();

Godot

await gametegra.stopStream('room-chat-lobby')

Parameters:

Name	Type	Required	Description
channelKey	string	Yes	The channel key returned when the stream was started.

Response:

{
  "onClientSuccess": true,
  "onHostSuccess": true,
  "data": {
    "success": true
  },
  "errorMessage": null
}

---

getGyroscope

Starts streaming gyroscope sensor data from the device.

JavaScript

const gyro = await gametegra.getGyroscope({ normalize: true })
gyro.on('data', (d) => { console.log(d.x, d.y, d.z) })

Unity

var gyro = await gametegra.getGyroscope();
gyro.OnData += (d) => UpdateRotation(d);

Godot

var gyro = await gametegra.getGyroscope({ 'normalize': true })
gyro.on('data', func(d): update_rotation(d))

Parameters:

Name	Type	Required	Description
normalize	boolean	No	When true, returns values in degrees instead of radians.

Response:

{
  "eventType": "data",
  "payload": {
    "x": 0.012,
    "y": -0.004,
    "z": 0.003
  }
}

---

getAccelerometer

Starts streaming accelerometer sensor data from the device.

JavaScript

const accel = await gametegra.getAccelerometer()
accel.on('data', (d) => { console.log(d.x, d.y, d.z) })

Unity

var accel = await gametegra.getAccelerometer();
accel.OnData += (d) => UpdateAccel(d);

Godot

var accel = await gametegra.getAccelerometer()
accel.on('data', func(d): update_accel(d))

Response:

{
  "eventType": "data",
  "payload": {
    "x": 0.01,
    "y": 0.98,
    "z": 0.05
  }
}

---