Use the OpenTok .NET SDK to work with OpenTok applications. You can create OpenTok sessions and to generate tokens, and work with OpenTok 2.0 archives.
Download the .NET SDK:
https://github.com/opentok/Opentok-.NET-SDK/archive/master.zip
-
Visual Studio. The OpenTok archiving API does not require Visual Studio. However, this sample was developed using Visual Studio to create a solution with the different projects.
-
An OpenTok API key and secret (see https://dashboard.tokbox.com)
-
Open Visual Studio, "File -> Open -> Project/Solution" and open the Opentok-DotNet-SDK.sln file in this directory.
-
Visual Studio will load the four projects that are part of this solution.
- Sdk contains the actual OpenTok .NET SDK
- SimpleSample contains a very sample app to show the most basic functionality the OpenTok platform offers
- ArchivingSample contains a sample app showing off the OpenTok 2.0 archiving feature.
-
In order to run one of the sample apps, see the README.md the samples subdirectory.
Reference documentation is available at http://www.tokbox.com/opentok/libraries/server/dot-net/reference/index.html and in the docs directory of the SDK.
See the sample subdirectory of the SDK.
Use the CreateSession() method of the OpenTok object to create a session and a session ID.
The following code creates a session that uses the OpenTok Media Router:
namespace Example
{
class Program
{
static void Main(string[] args)
{
int apiKey = 0; // Replace with your OpenTok API key.
string apiSecret = ""; // Replace with your OpenTok API secret.
// Creating opentok object to access the opentok API
OpenTok opentok = new OpenTok(apiKey, apiSecret);
// Create a session that uses the OpenTok Media Router
Session session = opentok.CreateSession();
// The ID of the session we just created
Console.Out.WriteLine("SessionId: {0}", session.Id);
}
}
}
The following code creates a peer-to-peer session:
namespace Example
{
class Program
{
static void Main(string[] args)
{
int apiKey = 0; // Replace with your OpenTok API key.
string apiSecret = ""; // Replace with your OpenTok API secret.
// Creating opentok object to access the opentok API
OpenTok opentok = new OpenTok(apiKey, apiSecret);
// Create a session that uses the OpenTok Media Router
Session session = opentok.CreateSession(mediaMode: MediaMode.RELAY);
// The ID of the session we just created
Console.Out.WriteLine("SessionId: {0}", session.Id);
}
}
}
Use the GenerateToken() method of the OpenTokSDK object to create an OpenTok token:
The following example shows how to obtain a token:
using OpenTokSDK;
namespace Example
{
class Program
{
static void Main(string[] args)
{
int apiKey = 0; // Replace with your OpenTok API key.
string apiSecret = ""; // Replace with your OpenTok API secret.
// Creating opentok object to access the opentok API
OpenTok opentok = new OpenTok(apiKey, apiSecret);
// Create a session that uses the OpenTok Media Router
Session session = opentok.CreateSession();
// Generate a token from the session we just created
string token = opentok.GenerateToken(session.Id);
// We finally print out the id of the session with the new token created
Console.Out.WriteLine("SessionId: {0} \ntoken: {1}", session.Id, token);
}
}
}
The following C# code example shows how to obtain a token that has a role of "subscriber" and that has a connection metadata string:
using OpenTokSDK;
namespace Example
{
class Program
{
static void Main(string[] args)
{
int apiKey = 0; // Replace with your OpenTok API key.
string apiSecret = ""; // Replace with your OpenTok API secret.
string connectionData = "username=Bob,userLevel=4";
// Creating opentok object to access the opentok API
OpenTok opentok = new OpenTok(apiKey, apiSecret);
// Create a session that uses the OpenTok Media Router
Session session = opentok.CreateSession();
// Generate a token from the session we just created
string token = opentok.GenerateToken(session.Id, role: Role.SUBSCRIBER, data: connectionData);
// We finally print out the id of the session with the new token created
Console.Out.WriteLine("SessionId: {0} \ntoken: {1}", session.Id, token);
}
}
}
The following method starts recording an archive of an OpenTok 2.0 session (given a session ID) and returns the archive ID (on success).
Guid StartArchive(OpenTok opentok, string sessionId, string name)
{
try
{
Archive archive = opentok.StartArchive(sessionId, name);
return archive.Id;
}
catch (OpenTokException)
{
return Guid.Empty;
}
}
The following method stops the recording of an archive (given an archive ID), returning true on success, and false on failure.
bool StopArchive(OpenTok opentok, string archiveId)
{
try
{
Archive archive = opentok.StopArchive(archiveId);
return true;
}
catch (OpenTokException)
{
return false;
}
}
The following method logs information on a given archive.
void LogArchiveInfo(OpenTok opentok, string archiveId)
{
try
{
Archive archive = opentok.GetArchive(archiveId);
Console.Out.WriteLine("ArchiveId: {0}", archive.Id.ToString());
}
catch (OpenTokException exception)
{
Console.Out.WriteLine(exception.ToString());
}
}
The following method logs information on all archives (up to 50) for your API key:
void ListArchives(OpenTok opentok)
{
try
{
ArchiveList archives = opentok.ListArchives();
for (int i = 0; i < archives.Count(); i++)
{
Archive archive = archives.ElementAt(i);
Console.Out.WriteLine("ArchiveId: {0}", archive.Id.ToString());
}
} catch (OpenTokException exception)
{
Console.Out.WriteLine(exception.ToString());
}
}
See http://tokbox.com/opentok/support/ for all our support options.
Find a bug? File it on the Issues page. Hint: test cases are really helpful!