com.kaltura.client.services.KalturaExternalMediaService 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.
 */

/**  External media service lets you upload and manage embed codes and external
  playable content    */
@SuppressWarnings("serial")
public class KalturaExternalMediaService extends KalturaServiceBase {
    public KalturaExternalMediaService(KalturaClient client) {
        this.kalturaClient = client;
    }

	/**  Add external media entry     */
    public KalturaExternalMediaEntry add(KalturaExternalMediaEntry entry) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("entry", entry);
        this.kalturaClient.queueServiceCall("externalmedia_externalmedia", "add", kparams, KalturaExternalMediaEntry.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaExternalMediaEntry.class, resultXmlElement);
    }

	/**  Get external media entry by ID.     */
    public KalturaExternalMediaEntry get(String id) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        this.kalturaClient.queueServiceCall("externalmedia_externalmedia", "get", kparams, KalturaExternalMediaEntry.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaExternalMediaEntry.class, resultXmlElement);
    }

	/**  Update external media entry. Only the properties that were set will be updated. 
	     */
    public KalturaExternalMediaEntry update(String id, KalturaExternalMediaEntry entry) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("entry", entry);
        this.kalturaClient.queueServiceCall("externalmedia_externalmedia", "update", kparams, KalturaExternalMediaEntry.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaExternalMediaEntry.class, resultXmlElement);
    }

	/**  Delete a external media entry.     */
    public void delete(String id) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        this.kalturaClient.queueServiceCall("externalmedia_externalmedia", "delete", kparams);
        if (this.kalturaClient.isMultiRequest())
            return ;
        this.kalturaClient.doQueue();
    }

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

    public KalturaExternalMediaEntryListResponse list(KalturaExternalMediaEntryFilter filter) throws KalturaApiException {
        return this.list(filter, null);
    }

	/**  List media entries by filter with paging support.     */
    public KalturaExternalMediaEntryListResponse list(KalturaExternalMediaEntryFilter filter, KalturaFilterPager pager) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("filter", filter);
        kparams.add("pager", pager);
        this.kalturaClient.queueServiceCall("externalmedia_externalmedia", "list", kparams, KalturaExternalMediaEntryListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaExternalMediaEntryListResponse.class, resultXmlElement);
    }

    public int count() throws KalturaApiException {
        return this.count(null);
    }

	/**  Count media entries by filter.     */
    public int count(KalturaExternalMediaEntryFilter filter) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("filter", filter);
        this.kalturaClient.queueServiceCall("externalmedia_externalmedia", "count", kparams);
        if (this.kalturaClient.isMultiRequest())
            return 0;
        Element resultXmlElement = this.kalturaClient.doQueue();
        String resultText = resultXmlElement.getTextContent();
        return ParseUtils.parseInt(resultText);
    }
}