Class LabelsApi

Inheritance

System.Object

LabelsApi

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.Statistics.Labels

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class LabelsApi

Constructors

LabelsApi(IBitmovinApiClientFactory)

Declaration

public LabelsApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of LabelsApi

Declaration

public static BitmovinApiBuilder<LabelsApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<LabelsApi>

Daily

Declaration

public DailyApi Daily { get; }

Property Value

Type	Description
DailyApi

Methods

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

Get Statistics per Label

Declaration

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

Parameters

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

Returns

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

ListByDateRangeAsync(Nullable<DateTime>, Nullable<DateTime>, Func<LabelsApi.ListByDateRangeQueryParams, LabelsApi.ListByDateRangeQueryParams>[])

Get statistics per label within specific dates

Declaration

public Task<PaginationResponse<StatisticsPerLabel>> ListByDateRangeAsync(DateTime? from, DateTime? to, params Func<LabelsApi.ListByDateRangeQueryParams, LabelsApi.ListByDateRangeQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.Nullable<System.DateTime>	from	Start date. Format: yyyy-MM-dd (required)
System.Nullable<System.DateTime>	to	End date. Format: yyyy-MM-dd (required)
System.Func<LabelsApi.ListByDateRangeQueryParams, LabelsApi.ListByDateRangeQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

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