Class BifsApi

Inheritance

System.Object

BifsApi

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.Encodings.Streams.Bifs

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class BifsApi

Constructors

BifsApi(IBitmovinApiClientFactory)

Declaration

public BifsApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of BifsApi

Declaration

public static BitmovinApiBuilder<BifsApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<BifsApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(String, String, Bif)

Add a Roku Bif file

Declaration

public Task<Bif> CreateAsync(string encodingId, string streamId, Bif bif)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
Bif	bif	The Roku Bif file to be added

Returns

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

DeleteAsync(String, String, String)

Delete Bif

Declaration

public Task<BitmovinResponse> DeleteAsync(string encodingId, string streamId, string bifId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.String	bifId	Id of the Bif. (required)

Returns

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

GetAsync(String, String, String)

Bif Details

Declaration

public Task<Bif> GetAsync(string encodingId, string streamId, string bifId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.String	bifId	Id of the Bif configuration. (required)

Returns

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

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

List Bifs

Declaration

public Task<PaginationResponse<Bif>> ListAsync(string encodingId, string streamId, params Func<BifsApi.ListQueryParams, BifsApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.Func<BifsApi.ListQueryParams, BifsApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

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