com.bitmovin.api.sdk.encoding.encodings.streams.bifs.BifsApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bitmovin-api-sdk Show documentation
Bitmovin Java API SDK
There is a newer version: 1.205.0
package com.bitmovin.api.sdk.encoding.encodings.streams.bifs;

import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.HashMap;

import feign.Param;
import feign.QueryMap;
import feign.RequestLine;
import feign.Body;
import feign.Headers;

import com.bitmovin.api.sdk.model.*;
import com.bitmovin.api.sdk.common.BitmovinException;
import static com.bitmovin.api.sdk.common.BitmovinExceptionFactory.buildBitmovinException;
import com.bitmovin.api.sdk.common.BitmovinDateExpander;
import com.bitmovin.api.sdk.common.QueryMapWrapper;
import com.bitmovin.api.sdk.common.BitmovinApiBuilder;
import com.bitmovin.api.sdk.common.BitmovinApiClientFactory;
import com.bitmovin.api.sdk.encoding.encodings.streams.bifs.customdata.CustomdataApi;

public class BifsApi {
    public final CustomdataApi customdata;

    private final BifsApiClient apiClient;

    public BifsApi(BitmovinApiClientFactory clientFactory) {
        if (clientFactory == null)
        {
            throw new IllegalArgumentException("Parameter 'clientFactory' may not be null.");
        }

        this.apiClient = clientFactory.createApiClient(BifsApiClient.class);

        this.customdata = new CustomdataApi(clientFactory);
    }

    /**
     * Fluent builder for creating an instance of BifsApi
     */
    public static BitmovinApiBuilder builder() {
        return new BitmovinApiBuilder<>(BifsApi.class);
    }

    /**
     * Add a Roku Bif file
     * 
     * @param encodingId Id of the encoding. (required)
     * @param streamId Id of the stream. (required)
     * @param bif The Roku Bif file to be added (required)
     * @return Bif
     * @throws BitmovinException if fails to make API call
     */
    public Bif create(String encodingId, String streamId, Bif bif) throws BitmovinException {
        try {
            return this.apiClient.create(encodingId, streamId, bif).getData().getResult();
        } catch (Exception ex) {
            throw buildBitmovinException(ex);
        }
    }

    /**
     * Delete Bif
     * 
     * @param encodingId Id of the encoding. (required)
     * @param streamId Id of the stream. (required)
     * @param bifId Id of the Bif. (required)
     * @return BitmovinResponse
     * @throws BitmovinException if fails to make API call
     */
    public BitmovinResponse delete(String encodingId, String streamId, String bifId) throws BitmovinException {
        try {
            return this.apiClient.delete(encodingId, streamId, bifId).getData().getResult();
        } catch (Exception ex) {
            throw buildBitmovinException(ex);
        }
    }

    /**
     * Bif Details
     * 
     * @param encodingId Id of the encoding. (required)
     * @param streamId Id of the stream. (required)
     * @param bifId Id of the Bif configuration. (required)
     * @return Bif
     * @throws BitmovinException if fails to make API call
     */
    public Bif get(String encodingId, String streamId, String bifId) throws BitmovinException {
        try {
            return this.apiClient.get(encodingId, streamId, bifId).getData().getResult();
        } catch (Exception ex) {
            throw buildBitmovinException(ex);
        }
    }

    /**
     * List Bifs
     * 
     * @param encodingId Id of the encoding. (required)
     * @param streamId Id of the stream. (required)
     * @return List<Bif>
     * @throws BitmovinException if fails to make API call
     */
    public PaginationResponse list(String encodingId, String streamId) throws BitmovinException {
        try {
            return this.apiClient.list(encodingId, streamId, new QueryMapWrapper()).getData().getResult();
        } catch (Exception ex) {
            throw buildBitmovinException(ex);
        }
    }

    /**
     * List Bifs
     * 
     * @param encodingId Id of the encoding. (required)
     * @param streamId Id of the stream. (required)
     * @param queryParams The query parameters for sorting, filtering and paging options (optional)
     * @return List<Bif>
     * @throws BitmovinException if fails to make API call
     */
    public PaginationResponse list(String encodingId, String streamId, BifListQueryParams queryParams) throws BitmovinException {
        try {
            return this.apiClient.list(encodingId, streamId, new QueryMapWrapper(queryParams)).getData().getResult();
        } catch (Exception ex) {
            throw buildBitmovinException(ex);
        }
    }

    interface BifsApiClient {

        @RequestLine("POST /encoding/encodings/{encoding_id}/streams/{stream_id}/bifs")
        ResponseEnvelope create(@Param(value = "encoding_id") String encodingId, @Param(value = "stream_id") String streamId, Bif bif) throws BitmovinException;
    
        @RequestLine("DELETE /encoding/encodings/{encoding_id}/streams/{stream_id}/bifs/{bif_id}")
        ResponseEnvelope delete(@Param(value = "encoding_id") String encodingId, @Param(value = "stream_id") String streamId, @Param(value = "bif_id") String bifId) throws BitmovinException;
    
        @RequestLine("GET /encoding/encodings/{encoding_id}/streams/{stream_id}/bifs/{bif_id}")
        ResponseEnvelope get(@Param(value = "encoding_id") String encodingId, @Param(value = "stream_id") String streamId, @Param(value = "bif_id") String bifId) throws BitmovinException;
    
        @RequestLine("GET /encoding/encodings/{encoding_id}/streams/{stream_id}/bifs")
        ResponseEnvelope> list(@Param(value = "encoding_id") String encodingId, @Param(value = "stream_id") String streamId, @QueryMap QueryMapWrapper queryParams) throws BitmovinException;
    }
}