Class ImageApi

Inheritance

System.Object

ImageApi

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.Periods.Adaptationsets.Image

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class ImageApi

Constructors

ImageApi(IBitmovinApiClientFactory)

Declaration

public ImageApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of ImageApi

Declaration

public static BitmovinApiBuilder<ImageApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<ImageApi>

Methods

CreateAsync(String, String, ImageAdaptationSet)

Add Image AdaptationSet

Declaration

public Task<ImageAdaptationSet> CreateAsync(string manifestId, string periodId, ImageAdaptationSet imageAdaptationSet)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
ImageAdaptationSet	imageAdaptationSet	The image adaptation set to be added to the period

Returns

Type	Description
System.Threading.Tasks.Task<ImageAdaptationSet>

DeleteAsync(String, String, String)

Delete Image AdaptationSet

Declaration

public Task<BitmovinResponse> DeleteAsync(string manifestId, string periodId, string adaptationsetId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
System.String	adaptationsetId	Id of the audio adaptation set to be deleted (required)

Returns

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

GetAsync(String, String, String)

Image AdaptationSet Details

Declaration

public Task<ImageAdaptationSet> GetAsync(string manifestId, string periodId, string adaptationsetId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
System.String	adaptationsetId	Id of the Image adaptation set (required)

Returns

Type	Description
System.Threading.Tasks.Task<ImageAdaptationSet>

ListAsync(String, String, Func<ImageApi.ListQueryParams, ImageApi.ListQueryParams>[])

List all Image AdaptationSets

Declaration

public Task<PaginationResponse<ImageAdaptationSet>> ListAsync(string manifestId, string periodId, params Func<ImageApi.ListQueryParams, ImageApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
System.Func<ImageApi.ListQueryParams, ImageApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

Type	Description
System.Threading.Tasks.Task<PaginationResponse<ImageAdaptationSet>>