Show / Hide Table of Contents

Class ImscApi

Inheritance
System.Object
ImscApi
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.Representations.Imsc
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class ImscApi

Constructors

ImscApi(IBitmovinApiClientFactory)

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

Properties

Builder

Fluent builder for creating an instance of ImscApi

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

Methods

CreateAsync(String, String, String, DashImscRepresentation)

Add IMSC Representation

Declaration
public Task<DashImscRepresentation> CreateAsync(string manifestId, string periodId, string adaptationsetId, DashImscRepresentation dashImscRepresentation)
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 subtitle adaptation set (required)

DashImscRepresentation dashImscRepresentation

The IMSC representation to be added to the adaptation set. Note that the adaptation set has to be a subtitle adaptation set.

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

DeleteAsync(String, String, String, String)

Delete IMSC Representation

Declaration
public Task<BitmovinResponse> DeleteAsync(string manifestId, string periodId, string adaptationsetId, string representationId)
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 adaptation set (required)

System.String representationId

Id of the IMSC representation to be deleted (required)

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

GetAsync(String, String, String, String)

IMSC Representation Details

Declaration
public Task<DashImscRepresentation> GetAsync(string manifestId, string periodId, string adaptationsetId, string representationId)
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 adaptation set (required)

System.String representationId

Id of the IMSC representation (required)

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

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

List all IMSC Representations

Declaration
public Task<PaginationResponse<DashImscRepresentation>> ListAsync(string manifestId, string periodId, string adaptationsetId, params Func<ImscApi.ListQueryParams, ImscApi.ListQueryParams>[] queryParams)
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 adaptation set (required)

System.Func<ImscApi.ListQueryParams, ImscApi.ListQueryParams>[] queryParams

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

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