Show / Hide Table of Contents

Class VodApi

Inheritance
System.Object
VodApi
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Bitmovin.Api.Sdk.Encoding.Simple.Jobs.Vod
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class VodApi

Constructors

VodApi(IBitmovinApiClientFactory)

Declaration
public VodApi(IBitmovinApiClientFactory apiClientFactory)
Parameters
Type Name Description
IBitmovinApiClientFactory apiClientFactory

Properties

Builder

Fluent builder for creating an instance of VodApi

Declaration
public static BitmovinApiBuilder<VodApi> Builder { get; }
Property Value
Type Description
BitmovinApiBuilder<VodApi>

Methods

CreateAsync(SimpleEncodingVodJobRequest)

Create a Simple Encoding VOD Job

Declaration
public Task<SimpleEncodingVodJobResponse> CreateAsync(SimpleEncodingVodJobRequest simpleEncodingVodJobRequest)
Parameters
Type Name Description
SimpleEncodingVodJobRequest simpleEncodingVodJobRequest

The Simple Encoding VOD Job to be created. Check out our Simple Encoding API Documentation for additional information about the Simple Encoding API.

Returns
Type Description
System.Threading.Tasks.Task<SimpleEncodingVodJobResponse>

GetAsync(String)

Simple Encoding VOD Job details

Declaration
public Task<SimpleEncodingVodJobResponse> GetAsync(string simpleEncodingJobId)
Parameters
Type Name Description
System.String simpleEncodingJobId

Id of the Simple Encoding VOD Job (required)

Returns
Type Description
System.Threading.Tasks.Task<SimpleEncodingVodJobResponse>

ListAsync(Func<VodApi.ListQueryParams, VodApi.ListQueryParams>[])

List all Simple Encoding VOD Jobs

Declaration
public Task<PaginationResponse<SimpleEncodingVodJobResponse>> ListAsync(params Func<VodApi.ListQueryParams, VodApi.ListQueryParams>[] queryParams)
Parameters
Type Name Description
System.Func<VodApi.ListQueryParams, VodApi.ListQueryParams>[] queryParams

The query parameters for sorting, filtering and paging options (optional)

Returns
Type Description
System.Threading.Tasks.Task<PaginationResponse<SimpleEncodingVodJobResponse>>
Back to top Generated by DocFX