Client

Getting Started

1. Get the Huddle01 JS SDK

   $ npm install --save huddle01-client

   OR

   $ yarn add huddle01-client

2. Get your API Key: You can get your access keys in the Developer section of the Huddle01 Dashboard

3. Importing into your application: Import modules & instantiate Huddle01 Client. Import HuddleTypes to access the types.

import HuddleClient, { emitter, HuddleTypes } from "huddle01-client";

The infrastructure mandates a schema on the URL of the type https://domain.com/room?roomId=C132

Thus, on component mount, we add:

history.push(`?roomId=${config.roomId}`);

Initialise a new huddle client instance

const huddle: HuddleClient = new HuddleClient(config);

where config is of type HuddleTypes.HuddleClientConfig which is exported from the npm package. Along with this, HuddleTypes containing types for Producer, Consumer and Peer are also exported from the npm package.

An example config object can be given as

//write this as it is -- used to check for the recorder
const isRecorderBot = localStorage.getItem("bot_password") === "huddle01";

const config: HuddleTypes.HuddleClientConfig = {
  apiKey: "<API Key>",          // API KEY (issued on the dashboard)
  roomId: "C132",               // Room ID
  peerId: "rick254",            // Peer ID (needs to be unique for every peer)
  displayName: "Rick Sanchez",  // Display Name
  window,                       // Your browser's window object
  isBot,                        // bot flag
};

By this step, you should be connected to the Huddle servers.

To allow recordings, make sure to add:

huddle && isRecorderBot && joinRoomBtn.click();

where: huddle: the huddle-client object of type HuddleClient isRecorderBot: the boolean that checks if the user is a recorder bot or not joinRoomBtn: the button

Setting up event listeners

The emitter that we imported in the 1st step is used to emit events by Huddle about your application. Please refer to the demo app for application references

The various types of events are:

roomState

Trigger: on room status changes Return value: room status of the type string

emitter.on("roomState", (state: string) => {
    //do whatever (ideally switch-case between all state types)
    //for example
    switch (state) {
        case "connected":
          //code for roomState == "connected"
          break;
        case "failed":
          //code for roomState == "failed"
          break;
        case "disconnected":
          //code for roomState == "disconnected"
          break;
        default:
          setRoomState(state);
        
          break;
      }
      setRoomState(state);
});

Please refer to the demo app for application references

Different state types:

connected	failed	disconnected
successfully connected to the room	failure in connection to the room	successfully disconnected from the room

error

Trigger: an error event on client/server side Return value: the error object

emitter.on("error", (error: any) => {
    //code for error handling
    // example : alert(error)
});

Please refer to the demo app for application references

addPeer

Trigger: new peer joins the room Return value: an entire peer object with all the details about the peer of the type HuddleTypes.IPeer

emitter.on("addPeer", (peer: HuddleTypes.IPeer) => {
    //do whatever
});

Please refer to the demo app for application references

addProducer

Trigger: you have a new producer producing to the Huddle servers Return value: an producer object with details like your production media track (eg. webcam/mic/screenshare) of the type HuddleTypes.IProducer.

emitter.on("addProducer", (producer: HuddleTypes.IProducer) => {
    //do whatever (ideally switch-case between all state types)
});

Please refer to the demo app for application references

Different state types:

producer.type:

webcam	mic	screenshare
a webcam stream producer	a mic stream producer	a screenshare stream producer

addConsumer

Trigger: you have a new consumer consuming from the Huddle servers Return value: a consumer object with details like your consumption media track (eg. webcam/mic/screenshare) of the type HuddleTypes.IConsumer

emitter.on("addConsumer", (consumer: HuddleTypes.IConsumer) => {
    //do whatever (ideally switch-case between all state types)
});

Please refer to the demo app for application references

Different state types:

consumer.type:

webcam	mic	screenshare
a webcam stream consumer	a mic stream consumer	a screenshare stream consumer

removePeer

Trigger: one of the existing peers disconnects from the room Return value: an entire peer object with all the details about the peer of the type HuddleTypes.IPeer(same as the object received on the "add" event)

emitter.on("removePeer", (peer: HuddleTypes.IPeer) => {
    //do whatever
});

Please refer to the demo app for application references

removeProducer

Trigger: you have closed the production of your existing producer to the Huddle servers Return value: a producer object with details like your production media track (eg. webcam/mic/screenshare) peer of the type HuddleTypes.IProducer (same as the object received on the "add" event)

emitter.on("removeProducer", (producer: HuddleTypes.IProducer) => {
    //do whatever (ideally switch-case between all state types)
});

Please refer to the demo app for application references

Different state types:

producer.type:

webcam	mic	screenshare
a webcam stream producer	a mic stream producer	a screenshare stream producer

removeConsumer

Trigger: you have closed the production of your existing producer to the Huddle servers Return value: a consumer object with details like your consumption media track (eg. webcam/mic/screenshare) peer of the type HuddleTypes.IConsumer (same as the object received on the "add" event)

emitter.on("removeConsumer", (consumer: HuddleTypes.IConsumer) => {
    //do whatever (ideally switch-case between all state types)
});

Please refer to the demo app for application references

Different state types:

consumer.type:

webcam	mic	screenshare
a webcam stream consumer	a mic stream consumer	a screenshare stream consumer

All the data/states received by events need to be maintained by you in your app. Can be achieved using React states/redux or any similar implementations.

Please refer to the demo app where we use local React states to handle these data.

Methods Available:

• huddle.join()

• huddle.close()

joinRoom()

const joinRoom = async () => {
    if (!huddle) return;
    try {
      setupEventListeners();
      await huddle.join();
    } catch (error) {
      alert(error);
    }
  };

leaveRoom()

const leaveRoom = async () => {
  if (!huddle) return;
  try {
    await huddle.close();
    setRoomState(false);
  } catch (error) {
    alert(error);
  }
};

close() can only be called after join() is successful

• huddle.enableWebcam()

• huddle.enableMic()

• huddle.enableShare()

enableWebcam()

  const enableWebcam = async () => {
    if (!huddle) return;
    try {
      await huddle.enableWebcam();
      setWebcamState(true);
    } catch (error) {
      alert(error);
    }
  };

enableMic()

 const enableMic = async () => {
    if (!huddle) return;
    try {
      huddle.enableMic();
      setMicState(true);
    } catch (error: any) {
      setMicState(false);
      alert(error);
    }
  };

enableShare()

 const startScreenshare = async () => {
    if (!huddle) return;
    try {
      await huddle.enableShare();
      setScreenshareState(true);
    } catch (error: any) {
      alert(error);
      setScreenshareState(false);
    }
  };

• huddle.disableWebcam()

• huddle.disableShare()

• huddle.disableMic()

disableWebcam()

  const disableWebcam = async () => {
    if (!huddle) return;
    try {
      await huddle.disableWebcam();
      setWebcamState(false);
    } catch (error) {
      alert(error);
    }
  };

disableShare()

  const stopScreenshare = async () => {
    if (!huddle) return;
    try {
      await huddle.disableShare();
      setScreenshareState(false);
    } catch (error: any) {
      alert(error);
    }
  };

disableMic()

const disableMic = async () => {
    if (!huddle) return;
    try {
      huddle.disableMic();
      setMicState(false);
    } catch (error: any) {
      alert(error);
      setMicState(true);
    }
  };

enable() functions need to be called and have returned success first before calling any of the disable()counterparts

• huddle.startRecording()

• huddle.stopRecording()

startRecording()

  const startRecording = async () => {
    if (!huddle) return;
    try {
      const status: boolean = await huddle.startRecording();
      if (status) console.log("recording successfully initiated");
    } catch (error: any) {
      console.error(error);
    }
  };

stopRecording()

const stopRecorder = async () => {
    if (!huddle) return;
    try {
      const status: boolean = await huddle.stopRecording();
      if (status) console.log("recording successfully stopped");
    } catch (error: any) {
      console.error(error);
    }
  };