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 ...
09/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
09/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
09/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
09/10/2026
September 10 2026, 06:00 (PDT) Dolby Expands Dolby OptiView Platform with New Capabilities at IBC 2026
New Sports Intelligence helps providers better unders...
08/10/2026
Modern venues have come a long way since the tinny, echoing audio of the mid 20t...
08/10/2026
ESPN's first Super Bowl production will stream in English and Spanish on Disney+, while the ESPN App carries the full slate of game, ManningCast, studio, an...
08/10/2026
From high-school videoboards to War Eagle Productions, the Opelika native is learning how to lead shows and capture big moments
The future of live sports produ...
08/10/2026
The Television Academy and Prime Video have announced a six-year agreement making Prime Video the exclusive global home of the Emmy Awards beginning with the 20...
08/10/2026
Techex will exhibit at NAB Show New York 2026 (Booth 623, Javits Center, October...
08/10/2026
X Games has announced the appointment of Steve Rogers as Chief Operating Officer. Rogers previously served as COO of World Supercross and spent nearly a decade ...
08/10/2026
Fonn Group has appointed Trevor Spielmann as Sales Director for Germany, Austria, and Switzerland. Spielmann joins from EVS, where he held sales and business de...
08/10/2026
The flagship program will originate from major PG events with a four-camera production, live distribution across PGTV, social platforms
Perfect Game is bringin...
08/10/2026
Innovation rarely happens in a vacuum. More often, it happens at the point of collision: when worlds that have run on separate tracks begin to converge. That is...
08/10/2026
For decades, the production and broadcast services business has run on a familia...
08/10/2026
Uplynk, Zixi, BroadView Software, and Grass Valley have published The IP Converg...
08/10/2026
The NFL has announced the return of the Big Data Bowl, the league's analytics competition, now in its ninth year and again powered by AWS. Registration is o...
08/10/2026
Eutelsat has renewed its partnership with T l diffusion d'Alg rie (TDA), Algeria's national broadcasting network operator, for continued distribution of...
08/10/2026
Disney will livestream Super Bowl LXI on February 14, 2027, alongside the game's broadcast on ESPN and ABC. All Disney subscribers in the United States wi...
08/10/2026
RHStv and Red House Streaming have announced an expansion of their partnership w...
08/10/2026
Gray Media has announced a distribution agreement with TEGNA and DAZN to simulca...
08/10/2026
SVG readers can save 10% on registration and receive a complimentary Solutions H...
08/10/2026
PROTON Camera Innovations GmbH has been named a recipient of a 2026 Technology a...
08/10/2026
Industry leaders discuss real-world cloud workflows for live game production, pl...
08/10/2026
The next-gen audio technology joins Dolby Vision as part of Apple TV's immersive F1 experience...
08/10/2026
David France, Jesse Short Bull, Mato Wayuhi, N. Bird Runningwater, Jodi Archambau, Jhane Myers, Paul McGuire, Amber Morning Star Byars, Holly Macarro, Nick Tils...
08/10/2026
Dynamic panning plug-ins get an upgrade
Sound Particles have just announced major updates for two of their popular dynamic panning plug-ins. Energy Panner 2...
08/10/2026
New expandable instrument boasts full DMNO engine
UDO Audio have just announced the upcoming release of a new, expandable synth that packs the power of the ...
08/10/2026
Two new subwoofers added to monitoring line-up
ADAM Audio's monitoring range has just been expanded with two new DSP-equipped subwoofers, the Sub8 PRO a...
08/10/2026
eds3_5_jq(document).ready(function($) { $(#eds_sliderM519).chameleonSlider_2_1({ content_source:......
08/10/2026
Calrec gives broadcasters freedom of choice at NAB Show New York We're looking forward to meeting up with you all at NAB New York on 21st-22nd October.
Cal...
08/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
08/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
08/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
08/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
08/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
08/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
08/10/2026
Globecast, a leading provider of broadcast, media and entertainment managed services, will showcase its next generation of media orchestration services at NAB S...
08/10/2026
Clear-Com played a critical role in the production communications infrastructure for Rock in Rio 2026, one of the world's largest and most recognized music...
08/10/2026
Sohonet Launches ClearView Rush: A Leap Forward in Studio Review, Built for Crea...
08/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
08/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
08/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
08/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
08/10/2026
Ikegami announces a major expansion to its range of broadcast-quality live production cameras. Scheduled for introduction on Ikegami booth 708 at NAB New York, ...
08/10/2026
Calrec will be located at Booth 444.
Freedom to choose
The media landscape is evolving quickly, and the broadcasters best placed for what comes next will be...
08/10/2026
LiveU has announced that CRD Audiovisuel relied on LiveUs LU900Q intelligent production unit, with built-in native LiveU IQ (LIQ ) connectivity, to deliver live...
08/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
08/10/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
Three Simple Methods to Invoke the Vidispine API From .NET Code by Vidispine June 15, 2016 Howto 
