Three Simple Methods to Invoke the Vidispine API From .NET Code by Vidispine June 15, 2016 Howto
Binagora is on fire and returns with another guest post. We know we have a bunch of developers on .NET, therefore we created a .NET SDK. This post shows how you can invoke the Vidispine API from .NET, using the SDK or using standard .NET classes. All with example code.
The following article describe three simple ways to invoke the Vidispine API from .NET code. Two of them use standard .NET classes, while the last one uses the Vidispine .NET SDK. Code snippets were written using C# but you can of course use another language, such as VB.NET, if you want to.
We'll use the simplest test case possible, and let us retrieve the id of the first available item in the Vidispine library.
First of all, let's see how it's done in Postman. As you may already know, it's just a simple http GET request to the Vidispine API to retrieve an item id.
Notice that we're using two Postman variables for a specific environment:
{{vs}}: this is the Vidispine base address (url + port)
{{credentials}}: this is the username and password in basic http format (:) encoded in base64.
Ok, that was the principle of how to query the Vidispine API for an item id. Now let's do the same thing from code.
Given the following constants:
C#
private const string address = http://xxx.xxx.xxx.xxx:8080/API; private const string userName = admin; private const string password = admin;
1
2
3
private const string address = http://xxx.xxx.xxx.xxx:8080/API;
private const string userName = admin;
private const string password = admin;
Option 1: Using WebRequest class
C#
private static string GetUsingWebRequest(string requestUri) { var request = (HttpWebRequest)WebRequest.Create(requestUri); request.Credentials = new NetworkCredential(userName, password); using(var response = (HttpWebResponse)request.GetResponse()) { var stream = response.GetResponseStream(); var reader = new StreamReader(stream); string result = reader.ReadToEnd(); return result; } }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
private static string GetUsingWebRequest(string requestUri)
{
var request = (HttpWebRequest)WebRequest.Create(requestUri);
request.Credentials = new NetworkCredential(userName, password);
using(var response = (HttpWebResponse)request.GetResponse())
{
var stream = response.GetResponseStream();
var reader = new StreamReader(stream);
string result = reader.ReadToEnd();
return result;
}
}
Create a WebRequest, set the credentials and execute the request. Remember to release the request calling the Dispose() method or wrapping the instance into a using statement as we did in the sample.
Notice that in this case, we know the response contains a plain text with an item id. That's why we read the stream, and converts it into a string instead of a specific type.
Option 2: Using HttpClient class
C#
private static string GetUsingHttpClient(string requestUri) { var handler = new HttpClientHandler() { Credentials = new NetworkCredential(userName, password) }; var client = new HttpClient(handler); client.BaseAddress = new Uri(address); string message = client.GetStringAsync(requestUri).Result; return message; }
1
2
3
4
5
6
7
8
9
10
11
12
13
private static string GetUsingHttpClient(string requestUri)
{
var handler = new HttpClientHandler()
{
Credentials = new NetworkCredential(userName, password)
};
var client = new HttpClient(handler);
client.BaseAddress = new Uri(address);
string message = client.GetStringAsync(requestUri).Result;
return message;
}
Similar to previous option, it is just a matter of using another http client from the .NET framework.
In this case, credentials are specified on a client handler, then the http client is created using that handler.
The request is executed asynchronously, which is powerful and could be needed in a real situation.
In this case we're just reading the Result property immediately, but it's important to understand that the request is fired in an independent thread. Once thread is completed, you can execute your own callback.
Option 3: Using Vidispine .NET SDK
C#
private static string GetUsingVidispineSdk() { var rootResource = new VidispineResource(address).Authenticate(userName, password); var itemResource = rootResource.Item; string result = itemResource.SearchPlainGET.Number(1).CallText(); return result; }
1
2
3
4
5
6
7
8
private static string GetUsingVidispineSdk()
{
var rootResource = new VidispineResource(address).Authenticate(userName, password);
var itemResource = rootResource.Item;
string result = itemResource.SearchPlainGET.Number(1).CallText();
return result;
}
Finally the easiest way to do it, just call the SDK. Notice that in this case, the action to be executed is not part of the address. You specify the object and action based on the properties. We may say this is the strongly typed option to do it.
You can find more information about how to download and use the Vidispine .NET SDK in the post Getting Started With the Vidispine .NET SDK. If you want to try out the SDK, you can find the latest versions of the SDK here:
64-bit version of the Vidispine .NET SDK v4.5
32-bit version of the Vidispine .NET SDK v4.5
Running the app will show you the result 3 times, once for each option. In this case first item available is #525 but of course that will depend on your environment.
You can download the full console app code from the following GitHub Gist.
Hope you like it.
This blog post was written by our friends at Binagora. Check them out and see how they can help you with your next Media&Entertainment project.
Most recent headlines
05/01/2027
Worlds first 802.15.4ab-UWB chip verified by Calterah and Rohde & Schwarz to be ...
01/06/2026
January 6 2026, 05:30 (PST) Dolby Sets the New Standard for Premium Entertainment at CES 2026
Throughout the week, Dolby brings to life the latest innovatio...
02/05/2026
Dalet, a leading technology and service provider for media-rich organizations, t...
01/05/2026
January 5 2026, 18:30 (PST) NBCUniversal's Peacock to Be First Streamer to ...
06/04/2026
Michigan legends bring a new voice to the broadcast as TNT Sports and CBS Sports...
06/04/2026
From high school sports all the way up to the major leagues, building high-quali...
06/04/2026
Quickplay, an AI company for the media and entertainment industry, has been accepted into the Advanced tier of the TwelveLabs Ecosystem Partner Program. Quickpl...
06/04/2026
Grass Valley has announced the Future Playmakers Program, a global initiative to...
06/04/2026
El l der de operaciones impulsa la producci n en estudio mientras encuentra insp...
06/04/2026
The ops leader helps lead the charge in studio for the Spanish-language broadcas...
06/04/2026
Behind The Mic provides a roundup of recent news regarding on-air talent, includ...
06/04/2026
The National Hockey League (NHL), in partnership with Verizon and the New Jersey Devils, today announced the opening of the NHL Innovation Lab powered by Verizo...
06/04/2026
Rock League, a new professional curling league, has announced that ESPN+ will stream its inaugural 2026 season for fans in the United States. The first Rock Lea...
06/04/2026
Advanced Systems Group has announced the appointment of Andrea (Andy) Cummis as Vice President of Systems Design and Engineering. In this role, she will lead de...
06/04/2026
Backed by Bolt Ventures, the venture brings Bryson DeChambeau, Grant Horvat, and...
06/04/2026
With this environment we can start that collaboration even earlier because we ca...
06/04/2026
Like the immortal lives of vampires, some stories never really end. That's t...
06/04/2026
As podcasting continues to evolve, growth increasingly means building beyond aud...
06/04/2026
Multiband dynamics plug-in enhanced
California-based developer FSK Audio have released a significant update for their innovative multiband dynamics processo...
06/04/2026
Share official & user-created full-rig presets
IK Multimedia's latest TONEX update makes it possible for users of the popular amp and effects modelling ...
06/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
06/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
06/04/2026
Dalet Showcases Dalia Agentic AI and End-to-End Media Workflows at NAB Show 2026
Brie Clayton April 6, 2026
0 Comments
Dalet, a leading technology and...
06/04/2026
OpenDrives Shows Off Sports Expertise in Sports Business Hub located in NAB Show...
06/04/2026
Proton to Demonstrate 3D Application at NAB 2026
Brie Clayton April 6, 2026
0 Comments
Yet further creative potential unleashed through innovation in ...
06/04/2026
Autoscript Highlights Voice-Driven Prompting and PTZ Solutions at NAB 2026
Brie Clayton April 6, 2026
0 Comments
Experience Autoscript Voice, PTZ prom...
06/04/2026
Mediaproxy Highlights Significant Enhancements to its LogServer suite at NAB Sho...
06/04/2026
Wayne, N.J., April 6th, 2026 Phantom High-Speed announces the release of PCC 4...
06/04/2026
April 6th, 2026
TRIBECA STUDIOS AND LILLY ANNOUNCE WINNERS OF INAUGURAL VITAL...
06/04/2026
Back to All News
Netflix Expands Kids Entertainment Lineup With Playground App ...
05/04/2026
Tackles all reported bugs!
SoundBridge have just announced the launch of a new update that introduces a couple of minor changes to their remote collaboratio...
04/04/2026
The University of Arizona's Men's Basketball team has only loss twice th...
04/04/2026
1080p HDR arrives, a new generation of storytelling tools takes center stage, an...
04/04/2026
Michigan legends bring a new voice to the broadcast as TNT Sports and CBS Sports...
04/04/2026
Faster, cleaner and more intuitive than ever
The control software for Flock Audio's digitally controlled patchbay systems has just been treated to an up...
04/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
04/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
04/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
04/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
04/04/2026
DHD Introduces AI-Based Audio Noise Reduction to XD3 IP Core
Brie Clayton April 3, 2026
0 Comments
The accompanying image shows the rear panel of the ...
04/04/2026
Macnica Redefines ST 2110 Flexibility with Two Speeds on One Card
Brie Clayton April 3, 2026
0 Comments
New for NAB Show 2026, MEP100 SmartNIC now sup...
04/04/2026
Unified Media Workflows for Story-Centric Production
Brie Clayton April 3, 2026
0 Comments
Framelight X unifies field capture, editing and publishing ...
03/04/2026
Michigan's Fab Five will reunite for an alternate presentation of the Mich...
03/04/2026
Avid will exhibit at NAB Show 2026 (April 18-22, Booth N2226, Las Vegas Convention Center), demonstrating its Content Core platform and new AI-driven workflow c...
03/04/2026
Mark Roberts Motion Control (MRMC) has announced the appointment of Nick Barthee as Chief Operating Officer.
The announcement follows MRMC's transition fro...
03/04/2026
Interra Systems has announced that Elite Media Technologies has selected its BATON file-based QC solution for media workflows. Elite Media Technologies speciali...
03/04/2026
Ateme has announced that Moldtelecom has deployed Ateme technologies across its streaming workflow, covering encoding, delivery, operations, and analytics.
Mol...
03/04/2026
Grass Valley will demonstrate Framelight X, its content management platform, at NAB Show 2026. The platform connects capture, ingest, editing, and publishing in...
03/04/2026
Encompass Digital Media and Techex have announced a cloud-native Master Control ...
Three Simple Methods to Invoke the Vidispine API From .NET Code by Vidispine June 15, 2016 Howto 
