Sony Pixel Power calrec Sony

ree Simple Meods to Invoke the Vidispine API From .NET Code

15/06/2016

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.
LINK: http://howto.vidispine.com/insight/three-simple-methods-to-invoke-the-...
See more stories from vidispine

Most recent headlines

05/01/2027

Worlds first 802.15.4ab-UWB chip verified by Calterah and Rohde & Schwarz to be demoed at CES 2026

Worlds first 802.15.4ab-UWB chip verified by Calterah and Rohde & Schwarz to be ...

01/06/2026

Dolby Sets the New Standard for Premium Entertainment at CES 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...

01/05/2026

NBCUniversal's Peacock to Be First Streamer to Integrate Dolby's Full Suite of Premium Picture and Sound Innovations

January 5 2026, 18:30 (PST) NBCUniversal's Peacock to Be First Streamer to ...

01/04/2026

DOLBY AND DOUYIN EMPOWER THE NEXT GENERATON OF CREATORS WITH DOLBY VISION

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...

30/01/2026

2026 Sundance Film Festival Announces Award Winners

Top L-R: The Friend's House is Here, Josephine, The Lake, Bedford Park, Who Killed Alex Odeh? Second Row L-R: Take Me Home, American Pachuco: The Legend of...

30/01/2026

Dnyada her 14 kiiden biri Trk mzii dinliyor

Spotify, Haziran ay sonunda kadar stanbul'da yeni bir ofis a aca n ve T rkiye pazar n y netmek zere yeni bir atama ger ekle tirdi ini duyurdu. Bu kaps...

30/01/2026

Artemis II Wet Dress Rehearsal: Taking Things Into the Home Stretch

The Artemis II wet dress rehearsal will simulate the launch countdown, fully loading fuel and verifying systems ahead of the first SLS and Orion crewed flight....

30/01/2026

Copper Leaf Media Merges With Dimension PR

Share Share by: Copy link Facebook X Linkedin Bluesky Email...

30/01/2026

MXL: Aligning Broadcast Production With Software

Share Share by: Copy link Facebook X Linkedin Bluesky Email...

30/01/2026

Grass Valley and NETGEAR Partner to Accelerate Enterprise...

Grass Valley , the leading technology provider for live production solutions, and NETGEAR Inc. (NASDAQ: NTGR), a global leader in network solutions, today anno...

30/01/2026

tvONE Appoints Amit Singh as Regional Sales Manager for I...

tvONE, a leading video processor, signal distribution technology and media server developer, announces the expansion of Amit Singh's role to Regional Sales ...

30/01/2026

Mike Aiton Brings Stories to Life with NUGEN Audio

With a career that spans four decades across television, film and post-production, Freelance Sound Designer and Post-production Sound Mixer Mike Aiton has built...

30/01/2026

DPA Showcases its Complete Wireless Microphone Ecosystem...

DPA Microphones will feature its new, fully integrated wireless microphone ecosystem, designed to let audio professionals work faster, cleaner and with total co...

30/01/2026

Ventum Tech and Emergent Announce a Strategic Partnership...

As the Middle East continues to accelerate investment in next-generation media, broadcast, and immersive content technologies, Ventum Tech today announced a str...

30/01/2026

MRMC Broadcast to Highlight High-Precision Motion Control...

Mark Roberts Motion Control (MRMC), a Nikon company and global leader in robotic camera systems, today announced its participation at Integrated Systems Europe ...

30/01/2026

Peacock Hits 44 Million Subs, Lost $552 Million in Q4

Share Share by: Copy link Facebook X Linkedin Bluesky Email...

30/01/2026

ATSC Board Leadership Re-Elected For 2026

Share Share by: Copy link Facebook X Linkedin Bluesky Email...

30/01/2026

MRC Issues Final Digital Advertising Auction Transparency Standards

Share Share by: Copy link Facebook X Linkedin Bluesky Email...

30/01/2026

CBS Atlanta Launches New Weekday Morning News Show with AR/VR Set

Share Share by: Copy link Facebook X Linkedin Bluesky Email...

30/01/2026

Boston Conservatory at Berklee Hosts the National Opera Association's 2026 Conference

Boston Conservatory at Berklee Hosts the National Opera Association's 2026 C...

30/01/2026

Student Spotlight: Sriram Narayanan

Student Spotlight: Sriram Narayanan The classical pianist shares his experience growing up with a language disability and finding his voice through music. Ja...

30/01/2026

2026 Media Industry Trends to Watch: Change is Your Competitive Advantage

Heading into 2026, the pace of change across radio, TV, and digital media is reaching an inflection point. Audience behaviors continue to evolve, measurement mo...

30/01/2026

VEON Partners with MindBridge to Enhance Financial Analytics, Audit and Internal Controls with Augmented Intelligence Capabilities

30 Jan 2026 VEON Partners with MindBridge to Enhance Financial Analytics, Audit...

30/01/2026

Introducing the NEW Techtel.tv! | FEB 5% OFF Offer

Introducing the NEW Techtel.tv! | FEB 5% OFF Offer 30 Jan Written By Suzanne Costello Our Website & Online Store: Now Unified for a Seamless Experience.We&#...

30/01/2026

Easels at the ready! All new judging line up for series 13 of Portrait Artist of the Year

Friday 30 January 2026 Easels at the ready! All new judging line up for series ...

30/01/2026

Britain can switch off terrestrial TV in the 2030s, with targeted support to close the digital divide

Friday 30 January 2026 Britain can switch off terrestrial TV in the 2030s, with...

30/01/2026

The Danish Crime Series The Asset' Returns for a Second Season

Back to All News The Danish Crime Series The Asset' Returns for a Second Season Entertainment 30 January 2026 GlobalDenmark Link copied to clipboard ...

30/01/2026

Building Trust in Retail Media: Lessons from the IAB Europe Agency Breakfast

Two key themes came through strongly: Inconsistent measurement remains a major barrier to comparing performance across Retail Media Networks Independent cer...

29/01/2026

Extension of Invitation to Submit Proposals for Micro-Budget Film Projects 2026 Deadline to 2 February 2026

The National Film and Video Foundation (NFVF), in collaboration with a distribut...

29/01/2026

Hitachi Europe Appoints Michele Fracchiolla as President

Michele Fracchiolla Succeeds Andrew Barr as President of EMEA region from April 1, 2026 London, January 29, 2026 Hitachi Europe Ltd. today announces the appoi...

29/01/2026

L3Harris Technologies Reports Strong Full Year and Fourth Quarter 2025 Results, Initiates 2026 Guidance

MELBOURNE, Fla., January 29, 2026 - L3Harris Technologies (NYSE: LHX) reports fu...

29/01/2026

Nielsen Announces 2025 ARTEY Award Winners Following Record-Breaking Year of Streaming

Bluey' Wins Second Consecutive Top Streaming Title of the Year with 45 Billi...

29/01/2026

Report: Performance TV Ties With Social Media in Driving Ad Results

Share Share by: Copy link Facebook X Linkedin Bluesky Email...

29/01/2026

ISE: NDI and OBSBOT Expand Partnership

Share Share by: Copy link Facebook X Linkedin Bluesky Email...

29/01/2026

NTCA Asks FCC to Block Nexstar, Tegna Deal

Share Share by: Copy link Facebook X Linkedin Bluesky Email...

29/01/2026

FCC Announces Tentative Agenda for February Open Meeting

Share Share by: Copy link Facebook X Linkedin Bluesky Email...

29/01/2026

CBS Sports AFC Championship Game Attracts 48.6 Million Viewers

Share Share by: Copy link Facebook X Linkedin Bluesky Email...

29/01/2026

Boston Conservatory Orchestra Presents East Coast Premiere of Peter and Leonardo Dugan Piano Concerto

Boston Conservatory Orchestra Presents East Coast Premiere of Peter and Leonardo...

29/01/2026

Kyivstar Announces Pricing of Secondary Offering of Common Shares Held by VEON

29 Jan 2026 Kyivstar Announces Pricing of Secondary Offering of Common Shares Held by VEON NEW YORK, New York, January 29, 2026 -- VEON Ltd. (Nasdaq: VEON), a ...

29/01/2026

Mercedes-Benz Unveils New S-Class Built on NVIDIA DRIVE AV, Which Enables an L4-Ready Architecture

Mercedes-Benz is marking 140 years of automotive innovation with a new S-Class b...

29/01/2026

X-Rite Pantone Appoints Cindy Cooperman as Vice President and General Manager of Pantone

X-Rite Pantone Appoints Cindy Cooperman as Vice President and General Manager of...

29/01/2026

Outback Terror: The Falconio Murder

New two-part true crime documentary, OUTBACK TERROR: THE FALCONIO MURDER, aims to shed new light on a case that continues to intrigue on both sides of the world...

29/01/2026

'Love is Blind: Sweden' Returns for a Third Season - Premiering on March 12

Back to All News Love is Blind: Sweden Returns for a Third Season - Premiering ...

29/01/2026

Unmask Bridgerton' Season 4 With Our Complete Coverage Guide

Back to All News Unmask Bridgerton' Season 4 With Our Complete Coverage Guide Yerin Ha as Sophie Baek and Luke Thompson as Benedict Bridgerton in Season ...

29/01/2026

Extraordinary Crime Mysteries, Mythical Worlds and High-Stakes Psychological Thrillers: Inside Netflix's 2026 Chinese-Language Slate

Back to All News Extraordinary Crime Mysteries, Mythical Worlds and High-Stakes...

29/01/2026

FOX Sports Unveils Historic FIFA World Cup 2026 Broadcast Schedule

FOX Sports Unveils Historic FIFA World Cup 2026 Broadcast Schedule Monumental Slate Features 340 Hours of Live First-Run Programming Across FOX Sports Platfo...

29/01/2026

AI Assistants Head into 2026 on a High Note: Comscore Reports Triple-Digit Growth on Mobile

AI Assistants Head into 2026 on a High Note: Comscore Reports Triple-Digit Growt...

29/01/2026

Broadcom confirms Arvato Systems status as a VCSP partner

Broadcom Confirms Arvato Systems' Status as a VCSP Partner Broadcom Partner Program Update Arvato Systems confirmed as authorized VMware Cloud Service Pr...

29/01/2026

Into the Omniverse: Physical AI Open Models and Frameworks Advance Robots and Autonomous Systems

Editor's note: This post is part of Into the Omniverse, a series focused on ...

29/01/2026

Annette Malone appointed as Chief People Officer RT

RT has today announced that Annette Malone has been appointed to the role of Chief People Officer, RT following a public competition. As Chief People Officer...