Class DvbSubtitleApi
Inheritance
System.Object
DvbSubtitleApi
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.DvbSubtitle
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class DvbSubtitleApi
Constructors
DvbSubtitleApi(IBitmovinApiClientFactory)
Declaration
public DvbSubtitleApi(IBitmovinApiClientFactory apiClientFactory)
Parameters
Type | Name | Description |
---|---|---|
IBitmovinApiClientFactory | apiClientFactory |
Properties
Builder
Fluent builder for creating an instance of DvbSubtitleApi
Declaration
public static BitmovinApiBuilder<DvbSubtitleApi> Builder { get; }
Property Value
Type | Description |
---|---|
BitmovinApiBuilder<DvbSubtitleApi> |
Customdata
Declaration
public CustomdataApi Customdata { get; }
Property Value
Type | Description |
---|---|
CustomdataApi |
Methods
CreateAsync(DvbSubtitleConfiguration)
Create DVB-SUB subtitle configuration
Declaration
public Task<DvbSubtitleConfiguration> CreateAsync(DvbSubtitleConfiguration dvbSubtitleConfiguration)
Parameters
Type | Name | Description |
---|---|---|
DvbSubtitleConfiguration | dvbSubtitleConfiguration | The DVB-SUB subtitle configuration to be created |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DvbSubtitleConfiguration> |
DeleteAsync(String)
Delete DVB-SUB 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)
DVB-SUB subtitle configuration details
Declaration
public Task<DvbSubtitleConfiguration> GetAsync(string configurationId)
Parameters
Type | Name | Description |
---|---|---|
System.String | configurationId | Id of the codec configuration (required) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DvbSubtitleConfiguration> |
ListAsync(Func<DvbSubtitleApi.ListQueryParams, DvbSubtitleApi.ListQueryParams>[])
List DVB-SUB subtitle configurations
Declaration
public Task<PaginationResponse<DvbSubtitleConfiguration>> ListAsync(params Func<DvbSubtitleApi.ListQueryParams, DvbSubtitleApi.ListQueryParams>[] queryParams)
Parameters
Type | Name | Description |
---|---|---|
System.Func<DvbSubtitleApi.ListQueryParams, DvbSubtitleApi.ListQueryParams>[] | queryParams | The query parameters for sorting, filtering and paging options (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<PaginationResponse<DvbSubtitleConfiguration>> |