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 ...
04/08/2026
Dalet, a leading technology and service provider for media-rich organizations, t...
04/07/2026
April 7 2026, 19:00 (PDT) Detective Conan: Fallen Angel of the Highway Opens in...
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...
30/05/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
30/05/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
30/05/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
30/05/2026
Zero in on one that says yes (and no)
Andy Marken May 29, 2026
0 Comments
Hero image courtesy of Deposit Photos
For content creators the most difficu...
29/05/2026
With InfoComm 2026 just weeks away, NDI is giving attendees plenty of reasons to...
29/05/2026
Reaffirming a partnership that has defined Canadian sports broadcasting since 19...
29/05/2026
Mobile/tablet is No. 2 device for watching TV, suggesting that the sports-production industry needs to take another look at the format
Ring Digital's Sprin...
29/05/2026
Berliner Ensemble, one of Berlin's five major theater companies, has expande...
29/05/2026
Solid State Logic will showcase its new compact, fly-away TCA Tour audio product...
29/05/2026
Gerald (Jerry) Pierce, a pioneering technologist who helped shape the digital transformation of the motion picture industry, passed away last month on April 12 ...
29/05/2026
Paramount+ will be the English-language U.S. home for Barclays Women's Super...
29/05/2026
Further strengthening its virtualisation strategy to fully support broadcasters ...
29/05/2026
Swiss broadcaster Canal Alpha has deployed Harmonic's award-winning, software-based XOS Advanced Media Processor to modernize playout operations across cant...
29/05/2026
PTZOptics will showcase a new generation of intelligent video workflows at InfoComm 2026, June 17-19, Las Vegas. Visitors to booth N8227 will see how PTZOptics ...
29/05/2026
Arizona's Family has launched the Arizona's Family Sports (AZFS) streaming app, a new direct-to-consumer destination for live, local sports. The app is ...
29/05/2026
Starting in 2027, DAZN will be the exclusive home of The Canadian Football Leagu...
29/05/2026
Comcast Business has detailed the advanced network infrastructure it has deploye...
29/05/2026
In two-day event, leaders from academia and industry explored solutions to chall...
29/05/2026
The Basketball Tournament (TBT), now entering their 13th year of competition, ha...
29/05/2026
Roku has launched FOX One as a Premium Subscription on The Roku Channel in the U.S. Roku customers can now subscribe to FOX One using their Roku account for liv...
29/05/2026
In its sixth year, the broadcaster's coverage has become a global brand and ...
29/05/2026
Ratings Roundup is a rundown of recent ratings news and is derived from press re...
29/05/2026
The days are getting longer, the temperatures are rising, and playlists are filling up for the season. With summer around the corner, Spotify's global edito...
29/05/2026
New retro-inspired MPC announced
There are few devices that have gained the status held by Akai Pro's MPC range, and in recent years, the company have s...
29/05/2026
Save up to 30 on acclaimed titles
Following a successful launch at Superbooth 2026, Bjooks have revealed that they will be continuing the Kickstarter campa...
29/05/2026
Binaural monitoring application improved
Genelec have just released an update that brings some powerful new features to their HRTF-based binaural headphone ...
29/05/2026
6 June 2026 at SAE Institute, London, UK
IMSTA FESTA 2026 is almost upon us, with some of the biggest names in pro-audio set to descend upon SAE Institute i...
29/05/2026
Gerald (Jerry) Pierce, a pioneering technologist who helped shape the digital transformation of the motion picture industry, died April 12, 2026, at his home in...
29/05/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
29/05/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
29/05/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
29/05/2026
Comparing 5 AI Video Enhancers for Restoring Old Video Quality
Kate Luvis May 29, 2026
0 Comments
Digitizing VHS, MiniDV, and other legacy formats doe...
29/05/2026
Studio Hamburg Builds New Post Pipeline with DaVinci Resolve Studio
Brie Clayton May 29, 2026
0 Comments
Workflow replaces a patchwork of legacy tools...
29/05/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
29/05/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
29/05/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
29/05/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
29/05/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
29/05/2026
At the Intersection of Music and Dance, an Epic Collaboration Boston Conservatory musicians and dancers found creative parallels in their recent performance o...
29/05/2026
Back to All News
Latino Film Institute Fellows Screen Their Short Films at the Egyptian Theatre
The Inclusion Fellowship and Spark Animation Grant uplifts 15 ...
29/05/2026
GLOOKAST LAUNCHES CINNAFILM TACHYON PLUGIN FOR MEDIA PRODUCER AND MEDIA SERVICES
This release first appeared here.
Visit our Tachyon product page or contact...
29/05/2026
May 29 2026, 09:00 (PDT) Dolby and rednote Bring More Immersive Storytelling to...
29/05/2026
Something fundamental has shifted in how people consume media. Audiences aren't abandoning television or radio content; they're just expanding how, wher...
29/05/2026
Youtube exclusive special drops today
Watch now
UKTV today announces another e...
29/05/2026
Back to All News
The Official Trailer of Physical 100 Italy, on Netflix From Se...
Three Simple Methods to Invoke the Vidispine API From .NET Code by Vidispine June 15, 2016 Howto 
