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...
18/03/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
18/03/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
18/03/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
18/03/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
18/03/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
18/03/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
18/03/2026
SMPTE , the home of media professionals, technologists, and engineers, today unveiled its educational presentations for the 2026 NAB Show. This year SMPTE will ...
18/03/2026
Maxon, maker of powerful, approachable software solutions for creators working in 2D and 3D design, motion graphics, visual effects, gaming, and more, today ann...
18/03/2026
Digital Alert Systems
Preview
2026 NAB Show
April 19 - 22
Booth C3452
At the 2026 NAB Show, Digital Alert Systems will showcase Version 6.0 of its DASDEC ...
18/03/2026
Setplex today announced that it will showcase its complete, fully integrated Zapflex platform for the first time at the 2026 NAB Show, introducing powerful new ...
18/03/2026
THIS ANNOUNCEMENT RELATES TO THE DISCLOSURE OF INFORMATION THAT QUALIFIED OR MAY HAVE QUALIFIED AS INSIDE INFORMATION WITHIN THE MEANING OF ARTICLE 7(1) OF THE ...
18/03/2026
COW Jobs: Seeking DP for Low Budget Dramedy - Chicago
Brie Clayton March 17, 2026
0 Comments
Seeking Director of Photography for Low Budget Dramedy Fe...
18/03/2026
COW Jobs: Seeking Gaffer for Low Budget Dramedy - Chicago
Brie Clayton March 17, 2026
0 Comments
Seeking Gaffer for Low Budget Dramedy Feature Film- I...
18/03/2026
COW Jobs: Seeking Location, Sound for Low Budget Dramedy - Chicago
Brie Clayton March 17, 2026
0 Comments
Seeking Location/Sound for Low Budget Dramed...
18/03/2026
COW Jobs: Seeking Child Wrangler for Low Budget Film - Chicago
Brie Clayton March 17, 2026
0 Comments
Seeking Child Wrangler for Low Budget Dramedy Fe...
18/03/2026
Calrec Redefines Broadcast Workflows at NAB 2026 with its Most Powerful Hardware...
18/03/2026
Oscar Nominated Two People Exchanging Saliva Posted with DaVinci Resolve Studio
Brie Clayton March 17, 2026
0 Comments
DaVinci Resolve Studio handle...
18/03/2026
Boston Conservatory Presents Celebrated Musical Satire Urinetown Performances for this Center Stage production will take place at Boston Conservatory Theater ...
18/03/2026
Charlie Puth Joins Switched On Pop at Berklee NYC The Berklee alum spoke with host and Berklee NYC professor Charlie Harding for a live taping, answering audi...
17/03/2026
NASA+'s Rebecca Sirmons and Brittany Brown offer unique look at live streami...
17/03/2026
The transition to IP has fundamentally reshaped professional media infrastructures. Video, audio, and increasingly metadata now circulate as independent, precis...
17/03/2026
Live sports streaming can push every element in your video delivery chain to its limit, exposing every potential weakness in seconds. When the Super Bowl, the O...
17/03/2026
Texas Athletics sought to modernize its media production, enhance fan experience...
17/03/2026
Ikegami USA will demonstrate the latest additions to its wide range of broadcast...
17/03/2026
TNA Wrestling and iHeartMedia announces a new multi-platform collaboration that will integrate iHeartMedia across TNA's premium live events, weekly televisi...
17/03/2026
The goal was to transform Hard Rock Stadium into a global leader in sports and e...
17/03/2026
Spectrum has announced the launch of its new Multiview feature in the Spectrum TV App, giving customers the ability to watch up to four NCAA men's or women&...
17/03/2026
Genius Sports deal also covers data technology, AI, fan engagement, and performance analysis....
17/03/2026
Net Insight is supporting the rollout of a new state-wide centralized operation with Rede Massa, which is an SBT affiliate, the Brazilian regional television ne...
17/03/2026
Featuring audio from practice sessions, qualifying races, and Grand Prix races, the film represents Apple's sports-media ambitions
At Sunday night's Ac...
17/03/2026
Live broadcast has always been one of the most demanding environments in media a...
17/03/2026
DirecTV is introducing several new viewing features, including a multi-screen March Madness Mix channel and an updated Sports Central mobile app hub, ahead of...
17/03/2026
Deltatre has announced a multi-year partnership with ATP Media, the media arm of the ATP Tour, covering broadcast graphics, data, and production across the 2026...
17/03/2026
The Detroit Pistons have announced a third consecutive season partnering with Sc...
17/03/2026
Fresh Finds Africa spotlights emerging artists and movements across the continent and its global diaspora, with listeners tuning in to discover new Afro-forward...
17/03/2026
Last month, more than 60,000 fans piled into Bangkok's Rajamangala National ...
17/03/2026
Vintage-inspired channel strip joins line-up
Black Rooster Audio's latest plug-in provides an all-in-one mixing tool inspired by classic analogue consol...
17/03/2026
Level and EQ voice, reverb and noise independently
The latest plug-in to join Accentize's collection is said to take a new approach to dialogue processi...
17/03/2026
UHF radio mic & IEM bandwidth at risk
Once again, the UHF bandwidth that is currently allocated to RF audio gear is at risk of being reassigned to high-spee...
17/03/2026
Last Friday, the first Plant Fire Department Training Week in Bavaria successf...
17/03/2026
New campaign from NAATI and SBS CulturalConnnect highlights how we all deserve ...
17/03/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
17/03/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
17/03/2026
3D streaming infrastructure provider Miris today announced the launch of a public beta for its new 3D asset streaming platform. Miris is building the infrastruc...
Three Simple Methods to Invoke the Vidispine API From .NET Code by Vidispine June 15, 2016 Howto 
