API reference guide

This reference documentation is designed for people familiar with JavaScript programming and object-oriented programming concepts.

If you are not comfortable with Javascript, there are many JavaScript tutorials available on the Web to help you.

If this is your first contact with the Apideo API, we strongly advise you to start by reading the tutorials, which are organized by topics.

The reference is organized by objects:

The Apideo object

The Apideo object is the main object instance used by Apideo. You use this object solely to connect to the Apideo service. See more details here.

The ApideoConnection object

The ApideoConnection object is an object bound to your Apideo account. You will use this object to create rooms. See more details here.

The ApideoRoom object

The ApideoRoom object is the main object you will be using. From this object, you can start streaming your video, viewing other's streams, send and receive events, track users and much more. See more details here.

The ApideoCamera object

The ApideoCamera object represents the webcam that will be filming you. See more details here.

The ApideoViewer object

The ApideoViewer object represents the video stream from another user that is streamed on your browser. See more details here.