com.kaltura.client.services.KalturaCaptionAssetService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kalturaClient Show documentation
KalturaClient is a library of Java classes that can be used to interact with the Kaltura REST API. More information about the REST API can be found at http://corp.kaltura.com/Products/Kaltura-API Many of the Java classes in this library are auto-generated from a schema that defines the objects that are used to interect with the API. The current schema can be found at http://www.kaltura.com/api_v3/api_schema.php
The newest version!
// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.KalturaClient;
import com.kaltura.client.KalturaServiceBase;
import com.kaltura.client.types.*;
import org.w3c.dom.Element;
import com.kaltura.client.utils.ParseUtils;
import com.kaltura.client.KalturaParams;
import com.kaltura.client.KalturaApiException;

/**
 * This class was generated using generate.php
 * against an XML schema provided by Kaltura.
 * 
 * MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
 */

/**  Retrieve information and invoke actions on caption Asset    */
@SuppressWarnings("serial")
public class KalturaCaptionAssetService extends KalturaServiceBase {
    public KalturaCaptionAssetService(KalturaClient client) {
        this.kalturaClient = client;
    }

	/**  Add caption asset        */
    public KalturaCaptionAsset add(String entryId, KalturaCaptionAsset captionAsset) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("entryId", entryId);
        kparams.add("captionAsset", captionAsset);
        this.kalturaClient.queueServiceCall("caption_captionasset", "add", kparams, KalturaCaptionAsset.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaCaptionAsset.class, resultXmlElement);
    }

	/**  Update content of caption asset        */
    public KalturaCaptionAsset setContent(String id, KalturaContentResource contentResource) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("contentResource", contentResource);
        this.kalturaClient.queueServiceCall("caption_captionasset", "setContent", kparams, KalturaCaptionAsset.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaCaptionAsset.class, resultXmlElement);
    }

	/**  Update caption asset        */
    public KalturaCaptionAsset update(String id, KalturaCaptionAsset captionAsset) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("captionAsset", captionAsset);
        this.kalturaClient.queueServiceCall("caption_captionasset", "update", kparams, KalturaCaptionAsset.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaCaptionAsset.class, resultXmlElement);
    }

    public String serveByEntryId(String entryId) throws KalturaApiException {
        return this.serveByEntryId(entryId, Integer.MIN_VALUE);
    }

	/**  Serves caption by entry id and thumnail params id     */
    public String serveByEntryId(String entryId, int captionParamId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("entryId", entryId);
        kparams.add("captionParamId", captionParamId);
        this.kalturaClient.queueServiceCall("caption_captionasset", "serveByEntryId", kparams);
        return this.kalturaClient.serve();
    }

    public String getUrl(String id) throws KalturaApiException {
        return this.getUrl(id, Integer.MIN_VALUE);
    }

	/**  Get download URL for the asset     */
    public String getUrl(String id, int storageId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("storageId", storageId);
        this.kalturaClient.queueServiceCall("caption_captionasset", "getUrl", kparams);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        String resultText = resultXmlElement.getTextContent();
        return ParseUtils.parseString(resultText);
    }

	/**  Get remote storage existing paths for the asset     */
    public KalturaRemotePathListResponse getRemotePaths(String id) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        this.kalturaClient.queueServiceCall("caption_captionasset", "getRemotePaths", kparams, KalturaRemotePathListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaRemotePathListResponse.class, resultXmlElement);
    }

	/**  Serves caption by its id     */
    public String serve(String captionAssetId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("captionAssetId", captionAssetId);
        this.kalturaClient.queueServiceCall("caption_captionasset", "serve", kparams);
        return this.kalturaClient.serve();
    }

    public String serveWebVTT(String captionAssetId) throws KalturaApiException {
        return this.serveWebVTT(captionAssetId, 30);
    }

    public String serveWebVTT(String captionAssetId, int segmentDuration) throws KalturaApiException {
        return this.serveWebVTT(captionAssetId, segmentDuration, Integer.MIN_VALUE);
    }

    public String serveWebVTT(String captionAssetId, int segmentDuration, int segmentIndex) throws KalturaApiException {
        return this.serveWebVTT(captionAssetId, segmentDuration, segmentIndex, 10000);
    }

	/**  Serves caption by its id converting it to segmented WebVTT     */
    public String serveWebVTT(String captionAssetId, int segmentDuration, int segmentIndex, int localTimestamp) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("captionAssetId", captionAssetId);
        kparams.add("segmentDuration", segmentDuration);
        kparams.add("segmentIndex", segmentIndex);
        kparams.add("localTimestamp", localTimestamp);
        this.kalturaClient.queueServiceCall("caption_captionasset", "serveWebVTT", kparams);
        return this.kalturaClient.serve();
    }

	/**  Markss the caption as default and removes that mark from all other caption
	  assets of the entry.     */
    public void setAsDefault(String captionAssetId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("captionAssetId", captionAssetId);
        this.kalturaClient.queueServiceCall("caption_captionasset", "setAsDefault", kparams);
        if (this.kalturaClient.isMultiRequest())
            return ;
        this.kalturaClient.doQueue();
    }

    public KalturaCaptionAsset get(String captionAssetId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("captionAssetId", captionAssetId);
        this.kalturaClient.queueServiceCall("caption_captionasset", "get", kparams, KalturaCaptionAsset.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaCaptionAsset.class, resultXmlElement);
    }

    public KalturaCaptionAssetListResponse list() throws KalturaApiException {
        return this.list(null);
    }

    public KalturaCaptionAssetListResponse list(KalturaAssetFilter filter) throws KalturaApiException {
        return this.list(filter, null);
    }

	/**  List caption Assets by filter and pager     */
    public KalturaCaptionAssetListResponse list(KalturaAssetFilter filter, KalturaFilterPager pager) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("filter", filter);
        kparams.add("pager", pager);
        this.kalturaClient.queueServiceCall("caption_captionasset", "list", kparams, KalturaCaptionAssetListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaCaptionAssetListResponse.class, resultXmlElement);
    }

    public void delete(String captionAssetId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("captionAssetId", captionAssetId);
        this.kalturaClient.queueServiceCall("caption_captionasset", "delete", kparams);
        if (this.kalturaClient.isMultiRequest())
            return ;
        this.kalturaClient.doQueue();
    }
}