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...
04/03/2026
Lega Basket Serie A (LBA), the governing body for Italy's premier basketball...
04/03/2026
Wrexham AFC co-chairmen Rob Mac and Ryan Reynolds will host a first-of-its-kind ...
04/03/2026
The countdown is underway and with just 100 days to go until the world's greatest sporting event begins on Thurs., June 11, FOX Sports, America's Englis...
04/03/2026
No matter where they are in the world, service members and veterans can stream N...
04/03/2026
Telemundo officially releases Somos M s, the anthem for the network's cove...
04/03/2026
The Hollywood Professional Association (HPA) concluded the 2026 HPA Tech Retreat, convening more than 800 industry leaders, technologists, creatives, and execut...
04/03/2026
Smith Entertainment Group transformed how local sports are consumed by creating ...
04/03/2026
The production method, which spans a distance of 36.2 miles, was designed and im...
04/03/2026
Haivision, a global provider of mission-critical, real-time video networking and...
04/03/2026
When Hugues Meyrath came out of retirement to take the helm as CEO of Quantum, i...
04/03/2026
Last week's launch of Banana Ball Championship League has spurred a significant upgrade of production facilities
The Savannah Bananas, arguably the hottest...
04/03/2026
sldkfjsdlfkjsldkfjsldkjfslkdjfslkdjfsl
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus...
04/03/2026
For many fans, a song's backstory can be just as compelling as the final pro...
04/03/2026
In 2006, Spotify was founded on the belief that technology could bring artists a...
04/03/2026
Spotify is back on the ground for the Houston Livestock Show and Rodeo, and we&#...
04/03/2026
Spotify had an energizing week in Sydney, Australia, filled with powerful conver...
04/03/2026
Earlier this year, we launched Directed By, a documentary-style series that pull...
04/03/2026
100 Days to Go: SBS Unveils World Class Team for The Greatest Show on Earth -The...
04/03/2026
KT and Rohde & Schwarz to showcase AI-enhanced radio transmission performance In a joint 6G AI proof-of-concept demonstration, the CMX500 one-box tester from ...
04/03/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
04/03/2026
Luxembourg, 3 March 2026 - SES S.A. has today published its 2025 Annual Report, following the announcement of the company's full year financial results for ...
04/03/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
04/03/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
04/03/2026
Luxembourg, March 3, 2026 - SES, a leading space solutions company, along with I...
04/03/2026
04 Mar 2026
VEON Partners with GSMA Innovation Fund to Accelerate Digital Innov...
04/03/2026
04 Mar 2026
VEON's Beeline Uzbekistan and Rakuten Symphony Partner for Open...
04/03/2026
Wednesday 4 March 2026
Sky Sports unveils plans for 2026 Formula 1 coverage
Sky Sports is preparing for one of the most highly anticipated F1 seasons in recen...
04/03/2026
Back to All News
Bloodhounds' Season 2 Gears Up for April 3 Premiere with ...
04/03/2026
Back to All News
Netflix Ads Suite Expands Capabilities
Business
04 March 2026
GlobalUnited States
Link copied to clipboard
After launching the Netflix Ad...
04/03/2026
Scripps Research welcomes healthcare innovator Joe Kiani to the Board of Directors Kiani brings decades of experience in patient safety and public service.
Mar...
04/03/2026
Nanoparticle vaccine approach takes on a new target: Hepatitis C virus Scripps Research scientists reengineer critical proteins on the surface of HCV, paving th...
03/03/2026
Beyond Sports, a Sony group company, and LIV Golf, the world's golf league, ...
03/03/2026
Ilitch Sports + Entertainment announces the launch of Detroit SportsNet (DSN), a year-round broadcast home for two of Detroit's franchises. With flexible op...
03/03/2026
Advanced Systems Group, LLC (ASG), a technology and services provider for media ...
03/03/2026
The PGA of America, NBC Sports and USA Sports extend their media rights agreemen...
03/03/2026
AI device ecosystem company HONOR enters into a strategic technical collaboratio...
03/03/2026
Cleveland's Telos Alliance, pioneers in broadcast technology for 30 years, l...
03/03/2026
The MD 9235 microphone head for wireless handhelds has been a firm favorite with many engineers and artists for its ability to cut through high on-stage levels ...
03/03/2026
Haivision Systems Inc. (Haivision), a global provider of mission-critical, real-...
03/03/2026
Broadcast Management Group (BMG) announces the expansion of its 62,000-square-fo...
03/03/2026
Maroon 5's musical tour in 2025 marked a leap forward in live audio as Monitor Engineer Dave Rupsch utilized Sennheiser's all-digital Spectera wireless ...
03/03/2026
Designed specifically for pro basketball, the renovated space at Gainbridge Fiel...
03/03/2026
As part of the move, former CEO Phillipp Lawo joins the broadcast-tech provider's Supervisory Board
Lawo has announced appointment of Jamie Dunn as chief e...
03/03/2026
A team of legendary announcers and analysts and a classic graphics look will bring the past to life
NBC Sports and Peacock will return to yesteryear for tonigh...
Three Simple Methods to Invoke the Vidispine API From .NET Code by Vidispine June 15, 2016 Howto 
