• English
  • Français
Warning! You are currently looking at an old release of the Apideo documentation. Check the latest version of the documentation here.

Class ApideoConnection

public class ApideoConnection
The ApideoConnection object represents a connection to your Apideo account. You use the Apideo connection object to access instances of the ApideoRoom class. ApideoConnection objects are created using the Apideo.connect function.
Defined in apideo.js

Function Summary
public ApideoRoom joinRoom (string room_name, JsonObject user_obj, [string debug_div_id])
Connects to the specified room.
public void quitRoom (ApideoRoom room)
Quits the room.

Function Details

function joinRoom

public ApideoRoom joinRoom(string room_name, JsonObject user_obj, [string debug_div_id])
Connects to the specified room. Returns an ApideoRoom object.
Parameters:
room_name - The name of the room to join
user_obj - An object describing the current user, that could be retrieved by other members of the room using ApideoRoom.onNewUser
[debug_div_id] - If specified, debug information will be displayed inside the <div> element whose id is "debug_div_id".
Returns:
{ApideoRoom} an ApideoRoom object

function quitRoom

public void quitRoom(ApideoRoom room)
Quits the room. Any camera or stream started in the room will be automatically closed.
Parameters:
room - The ApideoRoom object to quit.