@smarterservices/vps-student-socket-toolkit

toolkit of functions for students using smarterservices vps

Usage no npm install needed!

<script type="module">
  import smarterservicesVpsStudentSocketToolkit from 'https://cdn.skypack.dev/@smarterservices/vps-student-socket-toolkit';
</script>

README

toolkit

A toolkit containing functions that help with standard smartersockets tasks

Getting Started

npm install @smarterservices/vps-student-socket-toolkit

Constructor:

var toolkit = require('@smarterservices/vps-student-socket-toolkit');
var kit = new toolkit({socket:socket}};

Note socket in config is where you pass your entire smarterservices socket

Methods

requestHelp

description: Request help from proctor

Arguments

  • topic: topic of the listener
  • message: message the proctor will receive

Example

kit.requestHelp(topic,message);

###s3Speed

description: Send video upload metadata over socket

Arguments

  • topic: topic of the listener
  • userId: the users id
  • sessionId: the session id for that video
  • videoType: the video type. I.e webcam,screen
  • videoTimestamp: the timestamp from the video
  • videoId: the video id
  • speed: the speed of the upload
  • size: the size of the upload
  • time: the time the upload took

Example

kit.s3Speed(topic,userId,sessionId,videoType,videoTimestamp,videoId,speed,size,time);