Class KeyframesApi

Hierarchy

BaseAPI
- KeyframesApi

Index

Constructors

constructor

Properties

restClient

Methods

Constructors

constructor

new KeyframesApi(configuration: Configuration): KeyframesApi

Overrides BaseAPI.constructor
- Defined in encoding/encodings/keyframes/KeyframesApi.ts:15
Parameters
- configuration: Configuration
Returns KeyframesApi

Properties

Protected restClient

restClient: RestClient

Methods

create

create(encodingId: string, keyframe: Keyframe): Promise<Keyframe>

- Defined in encoding/encodings/keyframes/KeyframesApi.ts:28
Parameters
- encodingId: string
- Optional keyframe: Keyframe
Returns Promise<Keyframe>

delete

delete(encodingId: string, keyframeId: string): Promise<BitmovinResponse>

- Defined in encoding/encodings/keyframes/KeyframesApi.ts:44
Parameters
- encodingId: string
- keyframeId: string
Returns Promise<BitmovinResponse>

get

get(encodingId: string, keyframeId: string): Promise<Keyframe>

- Defined in encoding/encodings/keyframes/KeyframesApi.ts:61
Parameters
- encodingId: string
- keyframeId: string
Returns Promise<Keyframe>

list

list(encodingId: string, queryParameters: KeyframeListQueryParams | function): Promise<PaginationResponse<Keyframe>>

- Defined in encoding/encodings/keyframes/KeyframesApi.ts:78
Parameters
- encodingId: string
- Optional queryParameters: KeyframeListQueryParams | function
Returns Promise<PaginationResponse<Keyframe>>

Generated using TypeDoc