com.bitmovin.api.sdk.encoding.encodings.inputStreams.trimming.timeBased

Class TimeBasedApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.inputStreams.trimming.timeBased.TimeBasedApi

public class TimeBasedApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TimeBasedApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<TimeBasedApi>	builder() Fluent builder for creating an instance of TimeBasedApi
TimeBasedTrimmingInputStream	create(String encodingId, TimeBasedTrimmingInputStream timeBasedTrimmingInputStream) Add Time-Based Trimming Input Stream
BitmovinResponse	delete(String encodingId, String inputStreamId) Delete Time-Based Trimming Input Stream
TimeBasedTrimmingInputStream	get(String encodingId, String inputStreamId) Time-Based Trimming Input Stream Details
PaginationResponse<TimeBasedTrimmingInputStream>	list(String encodingId) List Time-Based Trimming Input Streams
PaginationResponse<TimeBasedTrimmingInputStream>	list(String encodingId, TimeBasedTrimmingInputStreamListQueryParams queryParams) List Time-Based Trimming Input Streams

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeBasedApi

public TimeBasedApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<TimeBasedApi> builder()

Fluent builder for creating an instance of TimeBasedApi

create

public TimeBasedTrimmingInputStream create(String encodingId,
                                           TimeBasedTrimmingInputStream timeBasedTrimmingInputStream)
                                    throws BitmovinException

Add Time-Based Trimming Input Stream

Parameters:

encodingId - Id of the encoding. (required)

timeBasedTrimmingInputStream - The Time-Based Trimming Input Stream to be created (required)

Returns:

TimeBasedTrimmingInputStream

Throws:

BitmovinException - if fails to make API call

delete

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

Delete Time-Based Trimming Input Stream

Parameters:

encodingId - Id of the encoding. (required)

inputStreamId - Id of the Time-Based Trimming Input Stream. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public TimeBasedTrimmingInputStream get(String encodingId,
                                        String inputStreamId)
                                 throws BitmovinException

Time-Based Trimming Input Stream Details

Parameters:

encodingId - Id of the encoding. (required)

inputStreamId - Id of the Time-Based Trimming Input Stream. (required)

Returns:

TimeBasedTrimmingInputStream

Throws:

BitmovinException - if fails to make API call

list

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

List Time-Based Trimming Input Streams

Parameters:

encodingId - Id of the encoding. (required)

Returns:

List<TimeBasedTrimmingInputStream>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<TimeBasedTrimmingInputStream> list(String encodingId,
                                                             TimeBasedTrimmingInputStreamListQueryParams queryParams)
                                                      throws BitmovinException

List Time-Based Trimming Input Streams

Parameters:

encodingId - Id of the encoding. (required)

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

Returns:

List<TimeBasedTrimmingInputStream>

Throws:

BitmovinException - if fails to make API call