
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 ...
01/04/2026
January 4 2026, 18:00 (PST) DOLBY AND DOUYIN EMPOWER THE NEXT GENERATON OF CREATORS WITH DOLBY VISION
Douyin Users Can Now Create And Share Videos With Stun...
12/03/2026
Staines-upon-Thames, UK, 11th March, 2026 - Yospace, the trusted leader in Dyna...
12/03/2026
Utah Scientific Expands Technology Partner Program With Integrations From Audina...
12/03/2026
Techex, a global expert in live video solutions over IP and cloud, announces the appointment of Matt McKee as Senior Director, Sales, Americas, further strength...
12/03/2026
KOKUSAI DENKI Electric America has appointed Mondae Hott as Regional Sales Manag...
12/03/2026
At the 2026 NAB Show, Interra Systems will showcase its latest advancements in a...
12/03/2026
The 15th National Games of China concluded after a two-week celebration of athletic excellence and regional collaboration. Held from Nov. 9-21 across Guangdong,...
12/03/2026
Live-production academic program Butler Sports Live produced a total of 40 fall-...
12/03/2026
The University of Nebraska's HuskerVision has completed the second phase of ...
12/03/2026
Grass Valley and integration partner Tab M Solutions have completed Phase 1 of a...
12/03/2026
The broadcaster expands its campus-production model as the university handles tw...
12/03/2026
Disney has announced the addition of March Madness - the NCAA Division I Men...
12/03/2026
Apple TV's Friday Night Baseball MLB doubleheader series returns for its f...
12/03/2026
The senior from New Jersey is making his mark in South Bend, both on the mic and behind it...
12/03/2026
After a relatively quiet January, the month of February was jammed packed with l...
12/03/2026
Long-time production partner Echo Entertainment is producing the broadcast, while Cosm played a vital role in the collaboration...
12/03/2026
By Jessica Herndon
We love kicking off each year by introducing the world to po...
12/03/2026
Samrat Chakrabarti, George Basil, Kiran Deol, Katie McCuen and Vishal Vijayakumar attend the 2025 Sundance Film Festival premiere of Didn't Die at the Lib...
12/03/2026
In Latin America, women are shaping music and defining its future. To kick off t...
12/03/2026
En Am rica Latina, las mujeres est n moldeando la m sica y definiendo su futuro....
12/03/2026
Let's turn back the clock 20 years: The music landscape was a world away fro...
12/03/2026
Bad Bunny is no stranger to Spotify's Billions Club. In fact, he has a whopp...
12/03/2026
Spotify was at the London Book Fair this week, joining conversations across the publishing industry about how people can make reading part of their daily lives....
12/03/2026
Mastering tool improves mono compatibility
Tokyo Dawn Labs' Ohlhorst Digital range is a series of mastering-focused plug-ins developed by Jan Ohlhorst, ...
12/03/2026
Wave FX processor integrated into four products
Lewitt have teamed up with Elgato to create a new processor for the company's Wave Next product range, i...
12/03/2026
Free tool for annotating audio files
Mix Notes is a new, free iOS App that provides users with a simple way to annotate their audio files. It's been cre...
12/03/2026
Side-chain ducking tool gets an upgrade
Devious Machines' popular side-chaining and envelope-shaping tool has just been kitted out with an improved enve...
12/03/2026
Ceremony to take place on 16 April 2026
The MPG (Music Producers Guild) have revealed the full shortlist for this year's MPG Awards, which will be takin...
12/03/2026
Emulates three classic dbx 160 variants
The latest arrival to Overloud's Gem Series plug-in range faithfully recreates not one, but three versions of th...
12/03/2026
New granular soft synth announced
Said to be their most advanced software synthesizer to date, Baby Audio's latest release has been built on a new granu...
12/03/2026
Latest version now live!
Edit 11 March 2026 - Bitwig Studio 6 is now live, and available for all to download!
The latest version of Bitwig's DAW softwa...
12/03/2026
Latest free eBook now available!
Designed for recording engineers, audio-technology students and technically minded musicians, our latest free eBook deliver...
12/03/2026
AFL and NITV partner to launch new First Nations led program Inside the Huddle&...
12/03/2026
Rohde & Schwarz Cybersecurity expands SITLine network encryptor portfolio - more...
12/03/2026
Rohde & Schwarz to showcase future-proof EMC testing solutions at EMV 2026 Rohde & Schwarz will participate in EMV 2026, Europe's premier trade fair and c...
12/03/2026
Johannesburg, 11 March 2026 - The 19th Annual South African Film and Television ...
12/03/2026
MELBOURNE, Fla., March 11, 2026 - L3Harris Technologies (NYSE: LHX) and Shield AI have successfully demonstrated a first-of-its-kind integration combining L3Har...
12/03/2026
The incorporation of Artificial Intelligence and Machine Learning into modern, converged all-domain systems is enabling true Joint Electromagnetic Spectrum Oper...
12/03/2026
MELBOURNE, Fla., March 12, 2026 - L3Harris Technologies (NYSE: LHX) today announ...
12/03/2026
Modern media operations demand a platform that unites automation, orchestration, and human oversight without compromise. In this post, we explore the six key te...
12/03/2026
A deep dive into the platform
Architecture The Blue Lucy platform follows a distributed microservices architecture, meaning the overall operational capability...
12/03/2026
Orchestration platform enables broadcasters to deploy multiple AI models safely with full auditability, rights protection, and regulatory oversight.
LONDON, En...
12/03/2026
Cost pressures, switching intent and demand for savings and credit products are ...
12/03/2026
For the first time, Nielsen breaks out demographic information about FAST and AV...
12/03/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
12/03/2026
Appear's high-performance, ultra-low latency encoding platform augments LTN's fully managed global IP network and orchestration platform
LTN, a leader ...