
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 ...
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 ...
19/11/2026
His career runs from the 2-in. videotape era to Canada's first HD and UHD live-production facilities...
19/11/2026
The popular sports-graphics event features a new Chairperson and new venue...
19/11/2026
Beth de Ara jo, Gemma Chan, Channing Tatum and Mason Reeves attend the premiere of Josephine at Eccles Theatre on January 23, 2026, in Park City, UT. (Photo b...
19/11/2026
New performance-focused brass library announced
Expressive E's latest release brings together four meticulously sampled brass instruments: sousaphone, b...
19/11/2026
Acoustic synthesizer gains free web editor
The phase8 acoustic synthesizer has been an ongoing project for Korg Berlin. It was unveiled as an early prototyp...
19/11/2026
MIDI controller keyboards upgraded
Designed for users who want a full-size keyboard and hands-on DAW control but in a relatively compact footprint, Nektar...
19/11/2026
Hugely popular compact monitor overhauled
IK Multimedia's ultra-compact monitors have proven to be incredibly popular, and the company say that they'...
19/11/2026
Rohde & Schwarz brings company-wide technology and service expertise to critical...
19/11/2026
On October 8, 2026, Nielsen employees came together around the world to celebrate our fourteenth company-wide day of service, Nielsen Global Impact Day (NGID). ...
19/11/2026
Integrating Gracenote's content intelligence with Nexxen's unique CTV supply allows advertisers to more closely align campaigns with audience viewing ha...
19/11/2026
Enhancement Mirrors Local TV's Recent Move to 1-Minute Qualifier (1MQ)
Upda...
19/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...
19/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...
19/11/2026
Share
{alert(Link copied)}).catch(err => {console.error(Failed to copy: , er...
19/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...
19/11/2026
As Founder and Creative Director of Future Phonic Studios, the Netherlands' first Dolby Atmos music studio, Richard Burki has spent more than a decade pushi...
19/11/2026
Boris FX Black Friday Sale - 25% Off Everything
Brie Clayton November 19, 2026
0 Comments
Check out the Boris FX Black Friday sale on Monday, November...
19/11/2026
Virtual Production Finds Its Middle Ground with Blackmagic Design
Brie Clayton November 19, 2026
0 Comments
How Neon Vision is using PYXIS 12K and Ult...
19/11/2026
FL Studio Announces Black Friday Discounts of Up to 50% Across Its Software Line...
19/11/2026
TBS Drama Series Tagusari Brothers Uses DaVinci Resolve Studio
Brie Clayton November 19, 2026
0 Comments
TBS ACT streamlines post production for broad...
19/11/2026
Beeble launches SwitchX 3.0 with dynamic environments and greater creative contr...
19/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...
19/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...
19/11/2026
Share
{alert(Link copied)}).catch(err => {console.error(Failed to copy: , er...
19/11/2026
Five-year deployment has automated APL's media supply chain from fixture to archive, managing over 200,000 assets
Blue Lucy, the workflow orchestration and...
19/11/2026
Riding the Australian wave through co-pros 11 November 2026
L-R: The Surfer, We Bury the Dead
Australian stories are captivating global audiences and attracti...
19/11/2026
Screen Australia and Australian Film Television and Radio School announce the Fi...
19/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...
19/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...
19/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...
19/11/2026
iStreamU LLC, a rapidly growing production and systems integration company founded by longtime Producer/Director Ivan Gonzalez, has standardized its audio workf...
19/11/2026
LA JOLLA, CA-Clarivate, a global information and analytics company, named seven ...
19/11/2026
Frank Skinner, Judi Love and Richard Ayoade join Kerry Godliman for three outdoor adventures across Dorset, Wales and Norfolk.
Kerry Godliman is swapping comed...
19/11/2026
Thursday 19 November 2026
The Day of the Jackal: Eddie Redmayne returns in firs...
19/11/2026
When I first started my career in lighting engineering, it felt cutting edge and rewarding to be designing solutions that affect all of us every day, whether at...