Class KeyframesApi

Inheritance

System.Object

KeyframesApi

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

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class KeyframesApi

Constructors

KeyframesApi(IBitmovinApiClientFactory)

Declaration

public KeyframesApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of KeyframesApi

Declaration

public static BitmovinApiBuilder<KeyframesApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<KeyframesApi>

Methods

CreateAsync(String, Keyframe)

Create Keyframes

Declaration

public Task<Keyframe> CreateAsync(string encodingId, Keyframe keyframe)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
Keyframe	keyframe	The Keyframes to be created

Returns

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

DeleteAsync(String, String)

Delete Keyframe

Declaration

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

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	keyframeId	Id of the keyframe. (required)

Returns

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

GetAsync(String, String)

Keyframe Details

Declaration

public Task<Keyframe> GetAsync(string encodingId, string keyframeId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	keyframeId	Id of the keyframe. (required)

Returns

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

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

List all Keyframes

Declaration

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

Parameters

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

Returns

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