
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 ...
04/08/2026
Dalet, a leading technology and service provider for media-rich organizations, t...
04/07/2026
April 7 2026, 19:00 (PDT) Detective Conan: Fallen Angel of the Highway Opens in...
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 ...
09/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
09/04/2026
Yospace exceeded 10 billion dynamically stitched ads in a single month, reaching 11.6 billion as ad-supported streaming surged. Driven by a packed global sports...
09/04/2026
Bitmovin has expanded its Live Encoding and Observability solutions to provide true end to end, real time insights across live streaming workflows, from encodin...
09/04/2026
Leyra has announced the launch of Icelandic public broadcaster R V's streaming service on Samsung and LG Smart TVs. R V is the first public broadcaster to d...
09/04/2026
3Play Media, a global leader in video accessibility and localization, today announced an AI Dubbing solution purpose-built for YouTube creators. The company, wh...
09/04/2026
Big Blue Marble, a provider of broadcast-grade, cloud-native video solutions, has been recognized as an Amazon Web Services (AWS) Managed Services Provider (MSP...
09/04/2026
The Professional Darts Corporation (PDC) has officially launched its revamped global streaming service, PDC TV, in collaboration with Cleeng and sports technolo...
09/04/2026
Cleeng, the Subscriber Retention Management (SRM ) pioneer, today announced a raft of new AI agents for its AI Assistant to accelerate decision-making and autom...
09/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
09/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
09/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
09/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
09/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
09/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
09/04/2026
New Charging, Connectivity, and Mounting Solutions Now Available
LAS VEGAS, APRIL 8, 2026 Pliant Technologies will highlight a range of new accessories at th...
09/04/2026
As live production continues its shift to IP, the challenge is no longer adoption it's reliability. At NAB Show 2026 (Booth W2033), Media Links will demon...
09/04/2026
QuickLink, a leading provider of award-winning video production and remote guest contribution solutions, launches its new AI-powered add-on for its StudioPro p...
09/04/2026
The Hive Group has published a new white paper, No Safe Harbor: Why the FCC's Upper C-Band Auction Demands Early Action from Broadcasters ahead of NAB Sho...
09/04/2026
Saranyu Technologies today announced the renewal of its Optimizer VoD subscription with VisualOn. The announcement coincides with NAB Show 2026, taking place Ap...
09/04/2026
Doireann N Ghlac in returns as presenter, with the first episode airing this Friday at 8.30pm on RT One and RT Player
The beloved walking series Tracks & T...
09/04/2026
A timeless story of grit, faith and rebellion takes center stage as Samson: A Ty...
09/04/2026
New technique for synthesizing branched molecules could accelerate the development of future medicines Scripps Research chemists solve a longstanding problem in...
08/04/2026
The deadline to enter the 18th Annual SVG College Sports Media Awards in association with NACDA is rapidly approaching! Submit your entries to this year's c...
08/04/2026
The Pittsburgh product helps lead more than 100 annual ESPN broadcasts as part o...
08/04/2026
Dynamic ad insertion, AI-based technologies, programmatic advertising are some o...
08/04/2026
Seven Fellows Selected for Second Year of Residency in Honor of Social Justice L...
08/04/2026
On March 7, Bad Bunny made history with his first-ever performance in Asia, taki...
08/04/2026
El 7 de marzo, Bad Bunny hizo historia con su primera presentaci n en Asia, subi...
08/04/2026
New channel strip plug-in revealed
The latest plug-in to be added to the Fuse Audio Labs line-up emulates a selection of vintage hardware units, combining c...
08/04/2026
Guitar & bass multi-effects software overhauled
Blue Cat Audio's flagship guitar and bass multi-effects software has recently received a significant upd...
08/04/2026
PanNoir mixer integration, Dolby Atmos Renderer & more
Merging Technologies have just launched Pyramix 16, the latest major update to their renowned DAW sof...
08/04/2026
Applicable Products Part number Description
QUARTZ-22-LTE (EU) Dual Port Dual SIM LTE Router (EU)
QUARTZ-COMPACT-11-LTE (EU) Single Port Compact LTE ...
08/04/2026
The September 19, 2025 YEP Newsletter highlights a group visit to the Academy Museum of Motion Pictures, where participants explored exhibits showcasing the art...
08/04/2026
The L3Harris HBTSS satellite is proven on orbit, successfully demonstrating trac...
08/04/2026
Image Credit: NASA. Artist rendering of a space communications satellite in orbit, representative of the resilient, multiband infrastructure supporting mission ...
08/04/2026
Latest evaluation validates image quality, Inertial Navigation System performance and long-range tracking in operational flight conditions....
08/04/2026
New Gracenote study finds behavioral change well underway, but trust in AI-gener...
08/04/2026
Share
Copy link
Facebook
X
Linkedin
Bluesky
Email...
08/04/2026
Integration eliminates ingest bottlenecks by ensuring content is immediately usable across cloud and hybrid editorial workflows. See it at NAB 2026.
Nevada Cit...
08/04/2026
Dalet, a leading technology and service provider for media-rich organizations, today announced the commercial availability of Dalia, its media-aware, agentic AI...
08/04/2026
Leading video software provider Synamedia today announced Senza Ignite, a cloud-based platform that transforms existing connected devices through a single firmw...
08/04/2026
Modernised architecture increases operational control and agility, while reducing cost and simplifying nationwide media transport across affiliates and news bur...
08/04/2026
Company to Feature DMX Dual Relay, High-Density 48-Channel Relay Panels, and New Private Label Power Program
LynTec, a leading manufacturer of innovative ele...
08/04/2026
Broadcasting Center Europe (BCE), a European media technology and services partner, today announces a technology partnership with BCNEXXT, a Netherlands-based c...