Class CustomTagsApi

Inheritance

System.Object

CustomTagsApi

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.Hls.Media.CustomTags

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class CustomTagsApi

Constructors

CustomTagsApi(IBitmovinApiClientFactory)

Declaration

public CustomTagsApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of CustomTagsApi

Declaration

public static BitmovinApiBuilder<CustomTagsApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<CustomTagsApi>

Methods

CreateAsync(String, String, CustomTag)

Add Custom Tag to a Audio Media or a Subtitle media

Declaration

public Task<CustomTag> CreateAsync(string manifestId, string mediaId, CustomTag customTag)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
System.String	mediaId	Id of the media. (required)
CustomTag	customTag	The Custom Tag to be added

Returns

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

DeleteAsync(String, String, String)

Delete Custom Tag

Declaration

public Task<BitmovinResponse> DeleteAsync(string manifestId, string mediaId, string customTagId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
System.String	mediaId	Id of the media. (required)
System.String	customTagId	Id of the custom tag. (required)

Returns

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

GetAsync(String, String, String)

Custom Tag Details

Declaration

public Task<CustomTag> GetAsync(string manifestId, string mediaId, string customTagId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
System.String	mediaId	Id of the media (required)
System.String	customTagId	Id of the custom tag. (required)

Returns

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

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

List all Custom Tags of a Audio media or a Subtitle media

Declaration

public Task<PaginationResponse<CustomTag>> ListAsync(string manifestId, string mediaId, params Func<CustomTagsApi.ListQueryParams, CustomTagsApi.ListQueryParams>[] queryParams)

Parameters

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

Returns

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