XDev.ApiVideo 1.6.7-alpha003

    <h1 align="center">api.video C# client</h1>

api.video is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

Table of contents

• Project description
• Getting started
  • Requirements
    • Frameworks supported
    • Dependencies
  • Installation
    • Using Nuget
    • Generating the DLL yourself
  • Code sample
• Documentation
  • API Endpoints
    • AnalyticsApi
    • CaptionsApi
    • ChaptersApi
    • LiveStreamsApi
    • PlayerThemesApi
    • SummariesApi
    • TagsApi
    • UploadTokensApi
    • VideosApi
    • WatermarksApi
    • WebhooksApi
  • Models
  • Authorization
    • API key
    • Public endpoints
  • Recommendation
• Have you gotten use from this API client?
• Contribution

Project description

api.video's C# API client streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens.

Getting started

Requirements

Frameworks supported

• .NET 5.0 or later

Dependencies

• RestSharp - 111.2.0
• Json.NET - 13.0.3
• JsonSubTypes - 1.8.0

We recommend using NuGet to obtain the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Using Nuget

Install-Package ApiVideo

Generating the DLL yourself

Generate the DLL using your preferred tool

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using ApiVideo.Api;
using ApiVideo.Client;
using ApiVideo.Model;

Code sample

using System.Collections.Generic;
using System.Diagnostics;
using System;
using System.IO;
using ApiVideo.Api;
using ApiVideo.Client;
using ApiVideo.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {
            var apiKey = "YOUR_API_KEY";

            var apiVideoClient = new ApiVideoClient(apiKey);
            // if you rather like to use the sandbox environment:
            // var apiVideoClient = new ApiVideoClient(apiKey, ApiVideo.Client.Environment.SANDBOX);

            var videoPayload = new VideoCreationPayload()
            {
                title = "Example video title",
                description = "Example video description",
                mp4support = true,
                tags = new List<string>()
                {
                    "first","video","test","c#","client"
                }
            };

            var myVideoFile = File.OpenRead("my-video.mp4");

            try {
                var newVideo = apiVideoClient.Videos().create(videoPayload);
                var video = apiVideoClient.Videos().upload(newVideo.videoid,myVideoFile);
                Console.WriteLine(video);
            } catch (ApiException e) {
                Console.WriteLine(e.ErrorCode);
                Console.WriteLine(e.Message);
                Console.WriteLine(e.StackTrace);
            }
        }
    }
}

Documentation

API Endpoints

All URIs are relative to https://ws.api.video

AnalyticsApi

Retrieve an instance of AnalyticsApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
AnalyticsApi analytics = client.Analytics()

Endpoints

CaptionsApi

Retrieve an instance of CaptionsApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
CaptionsApi captions = client.Captions()

Endpoints

ChaptersApi

Retrieve an instance of ChaptersApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
ChaptersApi chapters = client.Chapters()

Endpoints

LiveStreamsApi

Retrieve an instance of LiveStreamsApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
LiveStreamsApi liveStreams = client.LiveStreams()

Endpoints

PlayerThemesApi

Retrieve an instance of PlayerThemesApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
PlayerThemesApi playerThemes = client.PlayerThemes()

Endpoints

SummariesApi

Retrieve an instance of SummariesApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
SummariesApi summaries = client.Summaries()

Endpoints

TagsApi

Retrieve an instance of TagsApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
TagsApi tags = client.Tags()

Endpoints

UploadTokensApi

Retrieve an instance of UploadTokensApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
UploadTokensApi uploadTokens = client.UploadTokens()

Endpoints

VideosApi

Retrieve an instance of VideosApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
VideosApi videos = client.Videos()

Endpoints

WatermarksApi

Retrieve an instance of WatermarksApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
WatermarksApi watermarks = client.Watermarks()

Endpoints

WebhooksApi

Retrieve an instance of WebhooksApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
WebhooksApi webhooks = client.Webhooks()

Endpoints

Models

• AccessToken
• AdditionalBadRequestErrors
• AnalyticsAggregatedMetricsResponse
• AnalyticsAggregatedMetricsResponseContext
• AnalyticsAggregatedMetricsResponseContextTimeframe
• AnalyticsData
• AnalyticsMetricsBreakdownResponse
• AnalyticsMetricsBreakdownResponseContext
• AnalyticsMetricsBreakdownResponseData
• AnalyticsMetricsOverTimeResponse
• AnalyticsMetricsOverTimeResponseContext
• AnalyticsMetricsOverTimeResponseData
• AnalyticsPlays400Error
• AnalyticsPlaysResponse
• AuthenticatePayload
• BadRequest
• BytesRange
• Caption
• CaptionsListResponse
• CaptionsUpdatePayload
• Chapter
• ChaptersListResponse
• ConflictError
• DiscardedVideoUpdatePayload
• FilterBy
• FilterBy1
• FilterBy2
• Link
• ListTagsResponse
• ListTagsResponseData
• LiveStream
• LiveStreamAssets
• LiveStreamCreationPayload
• LiveStreamListResponse
• LiveStreamUpdatePayload
• Metadata
• Model403ErrorSchema
• NotFound
• Pagination
• PaginationLink
• PlayerSessionEvent
• PlayerTheme
• PlayerThemeAssets
• PlayerThemeCreationPayload
• PlayerThemeUpdatePayload
• PlayerThemesListResponse
• Quality
• RefreshTokenPayload
• RestreamsRequestObject
• RestreamsResponseObject
• SummariesListResponse
• Summary
• SummaryCreationPayload
• SummarySource
• SummaryUpdatePayload
• TokenCreationPayload
• TokenListResponse
• TooManyRequests
• UnrecognizedRequestUrl
• UploadToken
• Video
• VideoAssets
• VideoClip
• VideoCreationPayload
• VideoSource
• VideoSourceLiveStream
• VideoSourceLiveStreamLink
• VideoStatus
• VideoStatusEncoding
• VideoStatusEncodingMetadata
• VideoStatusIngest
• VideoStatusIngestReceivedParts
• VideoThumbnailPickPayload
• VideoUpdatePayload
• VideoWatermark
• VideosListResponse
• Watermark
• WatermarksListResponse
• Webhook
• WebhooksCreationPayload
• WebhooksListResponse

Authorization

API key

Most endpoints required to be authenticated using the API key mechanism described in our documentation. The access token generation mechanism is automatically handled by the client. All you have to do is provide an API key when instantiating the ApiVideoClient:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");

Public endpoints

Some endpoints don't require authentication. These one can be called with an ApiVideoClient instantiated without API key:

ApiVideoClient apiVideoClient = new ApiVideoClient();

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Have you gotten use from this API client?

Please take a moment to leave a star on the client ⭐

This helps other users to find the clients and also helps us understand which clients are most popular. Thank you!

Contribution

Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our client generator. Otherwise, you can also simply open an issue detailing your need on this repository.