Class SidecarsApi

Inheritance

System.Object

SidecarsApi

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.Sidecars

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class SidecarsApi

Constructors

SidecarsApi(IBitmovinApiClientFactory)

Declaration

public SidecarsApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of SidecarsApi

Declaration

public static BitmovinApiBuilder<SidecarsApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<SidecarsApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Webvtt

Declaration

public WebvttApi Webvtt { get; }

Property Value

Type	Description
WebvttApi

Methods

CreateAsync(String, SidecarFile)

Add Sidecar

Declaration

public Task<SidecarFile> CreateAsync(string encodingId, SidecarFile sidecarFile)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
SidecarFile	sidecarFile	The Sidecar to be added

Returns

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

DeleteAsync(String, String)

Delete Sidecar

Declaration

public Task<BitmovinResponse> DeleteAsync(string encodingId, string sidecarId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	sidecarId	Id of the sidecar. (required)

Returns

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

GetAsync(String, String)

Sidecar Details

Declaration

public Task<SidecarFile> GetAsync(string encodingId, string sidecarId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	sidecarId	Id of the sidecar. (required)

Returns

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

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

List Sidecars

Declaration

public Task<PaginationResponse<SidecarFile>> ListAsync(string encodingId, params Func<SidecarsApi.ListQueryParams, SidecarsApi.ListQueryParams>[] queryParams)

Parameters

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

Returns

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