
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 ...
20/11/2026
The sports broadcaster's chairman sees the upcoming game as an opportunity t...
20/11/2026
In-venue and creative video staffers at the professional and collegiate level have one major thing in common: the intensity and attention to detail ramps up dur...
20/11/2026
A variety of LED displays, integrated broadcast infrastructure covers every angl...
20/11/2026
Real American Freestyle (RAF) has announced a distribution partnership with Migu Video, a Chinese digital sports platform, to carry the RAF15 main event between...
20/11/2026
Apple and F1 Academy have announced that the all-female racing series will stream on Apple TV in the U.S. beginning in 2027. Fans will be able to watch every qu...
20/11/2026
Regional broadcaster m nchen.tv has modernized its production infrastructure at a new location in northern Munich. Riedel MediorNet provides decentralized signa...
20/11/2026
Eutelsat has announced three appointments to its Executive Committee, effective November 2026, under CEO Jean-Fran ois Fallacher.
Jean-Hubert Lenotte is appoin...
20/11/2026
After more than two decades at Harbour Esplanade in Docklands, the Seven Network has relocated its Melbourne headquarters to a new, custom-built ST 2110 facilit...
20/11/2026
Brazil is among the first markets deploying Versatile Video Coding (VVC) as part...
20/11/2026
The Soccer Tournament (TST), the $1 million winner-take-all 7v7 world championsh...
20/11/2026
Enhancements include a larger compound, an elevated camera count, and a whole lo...
20/11/2026
Leaders from ESPN, iHeartMedia, and Just Women's Sports explore creating new...
20/11/2026
New EQ plug-in aimed at mastering duties
Lemur Audio's latest plug-in has just arrived, delivering a characterful EQ that's aimed primarily at maste...
20/11/2026
Discounts of up to 75% now available
Soundtoys' annual Black Friday sale is now live, with discounts of up to 75% applied across the company's range...
20/11/2026
New creative looping tool revealed
Described as a cycling audio fragmenter , the latest addition to the SoundGhost range draws its inspiration from tape ph...
20/11/2026
Fairchild recreation gets plug-in counterpart
Heritage Audio's Herchild 670 offers a meticulous hardware recreations of the much-loved Fairchild 670 and...
20/11/2026
BONDI: 7 Minutes That Changed Australia
16 November, 2026
Media releases
A landmark documentary chronicling the worst terror attack in modern Australian hi...
20/11/2026
Statement regarding SBS non-Executive Director Aaron Fa'Aoso
20 November, 2026
Media releases
Aaron Fa'Aoso has advised that he is stepping down a...
20/11/2026
INVITATION FOR PUBLIC COMMENTS AND OBJECTIONS ON NOMINEES FOR APPOINTMENT TO THE COUNCIL OF THE NATIONAL FILM AND VIDEO FOUNDATION (NFVF) The Department of Spor...
20/11/2026
UEFA Nations League football and autumn premieres propel TVP to number one as YouTube grows its TV screen share
Warsaw, Poland, November 19, 2026 - Nielsen, a...
20/11/2026
October's autumn weather clearly encouraged Poles to spend more time in front of their screens, resulting in both longer viewing times and a higher overall ...
20/11/2026
Share
{alert(Link copied)}).catch(err => {console.error(Failed to copy: , err)}) data-platform=copy_link data-action= class=font-ui-heading py-2 text-sm tex...
20/11/2026
DigitalGlue releases creative.space Pulse, a free Mac app that shows creatives w...
20/11/2026
How NBCUniversal Telemundo Used Virtual Production for its FIFA World Cup 2026 C...
20/11/2026
What Film School Pays and What it Costs: The Federal Numbers
Mark Santos November 20, 2026
0 Comments
Every editor has had the argument about film sch...
20/11/2026
Share
{alert(Link copied)}).catch(err => {console.error(Failed to copy: , err)}) data-platform=copy_link data-action= class=font-ui-heading py-2 text-sm tex...
20/11/2026
Share
{alert(Link copied)}).catch(err => {console.error(Failed to copy: , err)}) data-platform=copy_link data-action= class=font-ui-heading py-2 text-sm tex...
20/11/2026
Share
{alert(Link copied)}).catch(err => {console.error(Failed to copy: , err)}) data-platform=copy_link data-action= class=font-ui-heading py-2 text-sm tex...
20/11/2026
Share
{alert(Link copied)}).catch(err => {console.error(Failed to copy: , err)}) data-platform=copy_link data-action= class=font-ui-heading py-2 text-sm tex...
20/11/2026
Share
{alert(Link copied)}).catch(err => {console.error(Failed to copy: , err)}) data-platform=copy_link data-action= class=font-ui-heading py-2 text-sm tex...
20/11/2026
Share
{alert(Link copied)}).catch(err => {console.error(Failed to copy: , err)}) data-platform=copy_link data-action= class=font-ui-heading py-2 text-sm tex...
20/11/2026
Share
{alert(Link copied)}).catch(err => {console.error(Failed to copy: , err)}) data-platform=copy_link data-action= class=font-ui-heading py-2 text-sm tex...
20/11/2026
Beam Dynamics has introduced new Model Context Protocol (MCP) support, expanding how customers can work with the live operational data held in Beam. The new cap...
20/11/2026
Re:Vision Effects Cyber Week Sale Nov 24 to Nov 30
Pierre Jasmin November 19, 2026
0 Comments
Long time friends of the COW are up with a big sale!
Us...
20/11/2026
Avid is offering up to 33% off annual subscriptions!
Brie Clayton November 19, 2026
0 Comments
Hero image courtesy Deposit Photos
Pro Tools
Pro To...
19/11/2026
With a sports-bar vibe and all the teams onsite in a huge atrium in Ballpark Vil...
19/11/2026
The senior from Phoenix and England is balancing life as a Division I tennis player with a growing career behind the microphone
The future of live sports produ...
19/11/2026
RED Digital Cinema and Colorfront have partnered to integrate native Colorfront color management into RED Connect, letting productions apply Colorfront's co...
19/11/2026
SMPTE has published an engineering report summarizing an industry survey by its Study Group on Content Provenance and Authenticity in Media. The findings point ...
19/11/2026
CTech and Skyline Communications have announced a partnership to deliver integra...
19/11/2026
Euskal Irrati Telebista (EITB), the Basque Country's public media group, has completed Phase 1 of a five-studio renewal with the commissioning of a Lawo IP ...
19/11/2026
The Esports Foundation (EF) has announced an expanded Road to ENC 2027 for the E...
19/11/2026
All Women's Sports Network (AWSN) held its first awards show, VEON: Women W...
19/11/2026
Gracenote, the content intelligence business unit of Nielsen, has extended its relationship with DIRECTV. Gracenote will continue to supply visual imagery and p...
19/11/2026
The Audio Engineering Society (AES) Technical Committee on Broadcast and Online ...
19/11/2026
NDI has released NDI 6.4, which adds Recording and Playback APIs, support for HEVC 4:4:4 and a configurable receiver buffer for Wi-Fi. The update also includes ...
19/11/2026
Lemonlight, the video production company behind more than 50,000 brand videos, has announced Hero, an AI production operating system, along with a new AI agent ...
19/11/2026
In a first-of-its-kind deployment at XFINITY Center, the digital signage/display...
19/11/2026
For the first time on a US streaming service, real-time player identification, contextual stats, and visual insights appear right in the live stream, available ...