Class HlsApi

Inheritance

System.Object

HlsApi

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

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class HlsApi

Constructors

HlsApi(IBitmovinApiClientFactory)

Declaration

public HlsApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of HlsApi

Declaration

public static BitmovinApiBuilder<HlsApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<HlsApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Default

Declaration

public DefaultApi Default { get; }

Property Value

Type	Description
DefaultApi

Media

Declaration

public MediaApi Media { get; }

Property Value

Type	Description
MediaApi

Streams

Declaration

public StreamsApi Streams { get; }

Property Value

Type	Description
StreamsApi

Methods

CreateAsync(HlsManifest)

Create HLS Manifest

Declaration

public Task<HlsManifest> CreateAsync(HlsManifest hlsManifest)

Parameters

Type	Name	Description
HlsManifest	hlsManifest	The HLS Manifest to be created

Returns

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

DeleteAsync(String)

Delete HLS Manifest

Declaration

public Task<BitmovinResponse> DeleteAsync(string manifestId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)

Returns

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

GetAsync(String)

HLS Manifest Details

Declaration

public Task<HlsManifest> GetAsync(string manifestId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)

Returns

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

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

List HLS Manifests

Declaration

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

Parameters

Type	Name	Description
System.Func<HlsApi.ListQueryParams, HlsApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

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

StartAsync(String, StartManifestRequest)

Start HLS Manifest Creation

Declaration

public Task<BitmovinResponse> StartAsync(string manifestId, StartManifestRequest startManifestRequest = null)

Parameters

Type	Name	Description
System.String	manifestId	Id of the HLS manifest. (required)
StartManifestRequest	startManifestRequest	Manifest Startup Options

Returns

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

StatusAsync(String)

HLS Manifest Creation Status

Declaration

public Task<ServiceTaskStatus> StatusAsync(string manifestId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the HLS manifest. (required)

Returns

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

StopAsync(String)

Stop HLS Manifest Creation

Declaration

public Task<BitmovinResponse> StopAsync(string manifestId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the HLS manifest. (required)

Returns

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