Show / Hide Table of Contents

Class DashApi

Inheritance
System.Object
DashApi
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.Manifests.Dash
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class DashApi

Constructors

DashApi(IBitmovinApiClientFactory)

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

Properties

Builder

Fluent builder for creating an instance of DashApi

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

Customdata

Declaration
public CustomdataApi Customdata { get; }
Property Value
Type Description
CustomdataApi

Default

Declaration
public DefaultApi Default { get; }
Property Value
Type Description
DefaultApi

Periods

Declaration
public PeriodsApi Periods { get; }
Property Value
Type Description
PeriodsApi

Methods

CreateAsync(DashManifest)

Create DASH Manifest

Declaration
public Task<DashManifest> CreateAsync(DashManifest dashManifest)
Parameters
Type Name Description
DashManifest dashManifest

The DASH manifest to be created

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

DeleteAsync(String)

Delete DASH Manifest

Declaration
public Task<BitmovinResponse> DeleteAsync(string manifestId)
Parameters
Type Name Description
System.String manifestId

UUID of the DASH manifest to be deleted (required)

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

GetAsync(String)

DASH Manifest Details

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

UUID of the dash manifest (required)

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

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

List DASH Manifests

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

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

Returns
Type Description
System.Threading.Tasks.Task<PaginationResponse<DashManifest>>

StartAsync(String, StartManifestRequest)

Start DASH Manifest Creation

Declaration
public Task<BitmovinResponse> StartAsync(string manifestId, StartManifestRequest startManifestRequest = null)
Parameters
Type Name Description
System.String manifestId

Id of the DASH manifest. (required)

StartManifestRequest startManifestRequest

Manifest Startup Options

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

StatusAsync(String)

DASH Manifest Creation Status

Declaration
public Task<ServiceTaskStatus> StatusAsync(string manifestId)
Parameters
Type Name Description
System.String manifestId

Id of the DASH manifest. (required)

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

StopAsync(String)

Stop DASH Manifest Creation

Declaration
public Task<BitmovinResponse> StopAsync(string manifestId)
Parameters
Type Name Description
System.String manifestId

Id of the DASH manifest. (required)

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