com.bitmovin.api.sdk.encoding.encodings.keyframes

Class KeyframesApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.keyframes.KeyframesApi

public class KeyframesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
KeyframesApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<KeyframesApi>	builder() Fluent builder for creating an instance of KeyframesApi
Keyframe	create(String encodingId, Keyframe keyframe) Create Keyframes
BitmovinResponse	delete(String encodingId, String keyframeId) Delete Keyframe
Keyframe	get(String encodingId, String keyframeId) Keyframe Details
PaginationResponse<Keyframe>	list(String encodingId) List all Keyframes
PaginationResponse<Keyframe>	list(String encodingId, KeyframeListQueryParams queryParams) List all Keyframes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyframesApi

public KeyframesApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<KeyframesApi> builder()

Fluent builder for creating an instance of KeyframesApi

create

public Keyframe create(String encodingId,
                       Keyframe keyframe)
                throws BitmovinException

Create Keyframes

Parameters:

encodingId - Id of the encoding. (required)

keyframe - The Keyframes to be created (required)

Returns:

Keyframe

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String encodingId,
                               String keyframeId)
                        throws BitmovinException

Delete Keyframe

Parameters:

encodingId - Id of the encoding. (required)

keyframeId - Id of the keyframe. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public Keyframe get(String encodingId,
                    String keyframeId)
             throws BitmovinException

Keyframe Details

Parameters:

encodingId - Id of the encoding. (required)

keyframeId - Id of the keyframe. (required)

Returns:

Keyframe

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Keyframe> list(String encodingId)
                                  throws BitmovinException

List all Keyframes

Parameters:

encodingId - Id of the encoding. (required)

Returns:

List<Keyframe>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Keyframe> list(String encodingId,
                                         KeyframeListQueryParams queryParams)
                                  throws BitmovinException

List all Keyframes

Parameters:

encodingId - Id of the encoding. (required)

queryParams - The query parameters for sorting, filtering and paging options (optional)

Returns:

List<Keyframe>

Throws:

BitmovinException - if fails to make API call