Predefined messages

Messages can be as flexible as you want. You can specify your own message types.

Text

• text: This message is used to send simple text.

const message = {
  type: 'text',
  value: 'A simple message'
};

Image

• image: This message is used to send images.

const message = {
  type: 'image',
  value: '<image url>'
};

Screenshot request

• screenshot-request: This message is used to request a user to send a screenshot of what is displaying in their glasses at that moment. Normally this message is sent from a teacher to a user.

const message = {
  type: 'screenshot-request',
  value: {
    from: <your ID>
  }
};

Screenshot

• screenshot: This message is used to send screenshots encoded in base64. This is what users will send when teachers request to them a screenshot. The destination will be the user id that’s in from field in screenshot-request.

const message = {
  type: 'screenshot',
  value: '<base64>'
};

Video

• video: This message is used to send videos.

const message = {
  type: 'video',
  value: '<video url>'
};

Play request

• play-request: This message is used to request to a user to play their video.

const message = {
  type: 'play-request',
  value: {}
};

Pause request

• pause-request: This message is used to request to a user to pause their video.

const message = {
  type: 'pause-request',
  value: {}
};

Set video time request

• set-time-request: This message is used to request to a user to set their playing video to a specific time.

const message = {
  type: 'set-time-request',
  value: 0 // number in seconds
};