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.Configurations.Subtitles.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>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(ImscConfiguration)

Create IMSC subtitle configuration

Declaration

public Task<ImscConfiguration> CreateAsync(ImscConfiguration imscConfiguration)

Parameters

Type	Name	Description
ImscConfiguration	imscConfiguration	The IMSC subtitle configuration to be created

Returns

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

DeleteAsync(String)

Delete IMSC subtitle configuration

Declaration

public Task<BitmovinResponse> DeleteAsync(string configurationId)

Parameters

Type	Name	Description
System.String	configurationId	Id of the subtitle configuration (required)

Returns

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

GetAsync(String)

IMSC subtitle configuration details

Declaration

public Task<ImscConfiguration> GetAsync(string configurationId)

Parameters

Type	Name	Description
System.String	configurationId	Id of the codec configuration (required)

Returns

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

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

List IMSC subtitle configurations

Declaration

public Task<PaginationResponse<ImscConfiguration>> ListAsync(params Func<ImscApi.ListQueryParams, ImscApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
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<ImscConfiguration>>