Quick Start Guide

Create your account

Sign up for a vidi account and login to your account page.

Meet your account page

In the Overview page you can see your API key and vidi server address. These are needed to communicate with the vidi server. You should keep your API key secret, vidi uses it to authenticate your application.

In the Settings page you should add your domains to start using vidi on your site. Postback URL can be set later, when you need to use Postbacks.

Using the vidi REST API

An example of making a two person video chat. You can read more about the vidi WebServicesAPI and RestAPI.

You can use our ClientLibraries to use vidi easily in your application without the need of making API requests directly.

1. Create a room

Room is a container that holds clients and also helps seperating clients.

1.1. Python Client Library

vidi = Vidi(YOURAPIKEY)
room = vidi.create_room()

1.2. HTTP Request

• Method: POST

• URL: http://api.vidi.zeitin.com/vidi/rest/rooms/create/

1.2.1. Request Parameters

• apikey => YOURAPIKEY

1.2.2. Response Data

• roomid => r123456

2. Create two clients

Client represents a user in your application. You must make this request two times to create two clients.

2.1. Python Client Library

client = room.create_client()

2.2. HTTP Request

• Method: POST

• URL: http://api.vidi.zeitin.com/vidi/rest/clients/create/

2.2.1. Request Parameters

• apikey => YOURAPIKEY

• roomid => r123456

2.2.2. Response Data

• clientid => c123456

3. Create inputs and outputs

Inputs are used to stream video from clients to the vidi server.
Outputs are used to stream video from the vidi server to clients.
You need to make this requests for each two clients.

INPUT

3.1. Python Client Library

input = client.create_input()

3.2. HTTP Request

• Method: POST

• URL: http://api.vidi.zeitin.com/vidi/rest/inputs/create/

3.2.1. Request Parameters

• apikey => YOURAPIKEY

• clientid => c123456

3.2.2. Response Data

• inputid => i123456

OUTPUT

3.3. Python Client Library

output = client.create_output()

3.4. HTTP Request

• Method: POST

• URL: http://api.vidi.zeitin.com/vidi/rest/outputs/create/

3.4.1. Request Parameters

• apikey => YOURAPIKEY

• clientid => c123456

3.4.2. Response Data

• inputid => o123456

4. Bind the inputs and outputs

Bindings are used to bind two objects (most commonly inputs and outputs) to stream video in one direction (from an input to an output).

You must make this request two times to make a cross connection. First client's input to second client's output. Second client's input to first client's output.

4.1. Python Client Library

binding = room.bind(input, output)

4.2. HTTP Request

• Method: POST

• URL: http://api.vidi.zeitin.com/vidi/rest/bindings/create/

4.3. Request Parameters

• apikey => YOURAPIKEY

• inputid => i123456

• outputid => o123456

4.4. Response Data

• bindingid => b123456

Using the vidi JavaScript API

TODO