com.kaltura.client.services.KalturaLiveStreamService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kalturaClient Show documentation
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 com.kaltura.client.enums.*;
import org.w3c.dom.Element;
import com.kaltura.client.utils.ParseUtils;
import com.kaltura.client.KalturaParams;
import com.kaltura.client.KalturaApiException;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import com.kaltura.client.KalturaFiles;
import com.kaltura.client.KalturaFile;
/**
* This class was generated using generate.php
* against an XML schema provided by Kaltura.
*
* MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
*/
/** Live Stream service lets you manage live stream entries */
@SuppressWarnings("serial")
public class KalturaLiveStreamService extends KalturaServiceBase {
public KalturaLiveStreamService(KalturaClient client) {
this.kalturaClient = client;
}
public KalturaLiveStreamEntry add(KalturaLiveStreamEntry liveStreamEntry) throws KalturaApiException {
return this.add(liveStreamEntry, null);
}
/** Adds new live stream entry. The entry will be queued for provision. */
public KalturaLiveStreamEntry add(KalturaLiveStreamEntry liveStreamEntry, KalturaSourceType sourceType) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("liveStreamEntry", liveStreamEntry);
kparams.add("sourceType", sourceType);
this.kalturaClient.queueServiceCall("livestream", "add", kparams, KalturaLiveStreamEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaLiveStreamEntry.class, resultXmlElement);
}
public KalturaLiveStreamEntry get(String entryId) throws KalturaApiException {
return this.get(entryId, -1);
}
/** Get live stream entry by ID. */
public KalturaLiveStreamEntry get(String entryId, int version) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("version", version);
this.kalturaClient.queueServiceCall("livestream", "get", kparams, KalturaLiveStreamEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaLiveStreamEntry.class, resultXmlElement);
}
/** Authenticate live-stream entry against stream token and partner limitations */
public KalturaLiveStreamEntry authenticate(String entryId, String token) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("token", token);
this.kalturaClient.queueServiceCall("livestream", "authenticate", kparams, KalturaLiveStreamEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaLiveStreamEntry.class, resultXmlElement);
}
/** Update live stream entry. Only the properties that were set will be updated. */
public KalturaLiveStreamEntry update(String entryId, KalturaLiveStreamEntry liveStreamEntry) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("liveStreamEntry", liveStreamEntry);
this.kalturaClient.queueServiceCall("livestream", "update", kparams, KalturaLiveStreamEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaLiveStreamEntry.class, resultXmlElement);
}
/** Delete a live stream entry. */
public void delete(String entryId) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
this.kalturaClient.queueServiceCall("livestream", "delete", kparams);
if (this.kalturaClient.isMultiRequest())
return ;
this.kalturaClient.doQueue();
}
public KalturaLiveStreamListResponse list() throws KalturaApiException {
return this.list(null);
}
public KalturaLiveStreamListResponse list(KalturaLiveStreamEntryFilter filter) throws KalturaApiException {
return this.list(filter, null);
}
/** List live stream entries by filter with paging support. */
public KalturaLiveStreamListResponse list(KalturaLiveStreamEntryFilter filter, KalturaFilterPager pager) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("filter", filter);
kparams.add("pager", pager);
this.kalturaClient.queueServiceCall("livestream", "list", kparams, KalturaLiveStreamListResponse.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaLiveStreamListResponse.class, resultXmlElement);
}
public KalturaLiveStreamEntry updateOfflineThumbnailJpeg(String entryId, File fileData) throws KalturaApiException {
return this.updateOfflineThumbnailJpeg(entryId, new KalturaFile(fileData));
}
public KalturaLiveStreamEntry updateOfflineThumbnailJpeg(String entryId, InputStream fileData, String fileDataName, long fileDataSize) throws KalturaApiException {
return this.updateOfflineThumbnailJpeg(entryId, new KalturaFile(fileData, fileDataName, fileDataSize));
}
public KalturaLiveStreamEntry updateOfflineThumbnailJpeg(String entryId, FileInputStream fileData, String fileDataName) throws KalturaApiException {
return this.updateOfflineThumbnailJpeg(entryId, new KalturaFile(fileData, fileDataName));
}
/** Update live stream entry thumbnail using a raw jpeg file */
public KalturaLiveStreamEntry updateOfflineThumbnailJpeg(String entryId, KalturaFile fileData) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
KalturaFiles kfiles = new KalturaFiles();
kfiles.add("fileData", fileData);
this.kalturaClient.queueServiceCall("livestream", "updateOfflineThumbnailJpeg", kparams, kfiles, KalturaLiveStreamEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaLiveStreamEntry.class, resultXmlElement);
}
/** Update entry thumbnail using url */
public KalturaLiveStreamEntry updateOfflineThumbnailFromUrl(String entryId, String url) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("url", url);
this.kalturaClient.queueServiceCall("livestream", "updateOfflineThumbnailFromUrl", kparams, KalturaLiveStreamEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaLiveStreamEntry.class, resultXmlElement);
}
/** Delivering the status of a live stream (on-air/offline) if it is possible */
public boolean isLive(String id, KalturaPlaybackProtocol protocol) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("id", id);
kparams.add("protocol", protocol);
this.kalturaClient.queueServiceCall("livestream", "isLive", kparams);
if (this.kalturaClient.isMultiRequest())
return false;
Element resultXmlElement = this.kalturaClient.doQueue();
String resultText = resultXmlElement.getTextContent();
return ParseUtils.parseBool(resultText);
}
public KalturaLiveStreamEntry addLiveStreamPushPublishConfiguration(String entryId, KalturaPlaybackProtocol protocol) throws KalturaApiException {
return this.addLiveStreamPushPublishConfiguration(entryId, protocol, null);
}
public KalturaLiveStreamEntry addLiveStreamPushPublishConfiguration(String entryId, KalturaPlaybackProtocol protocol, String url) throws KalturaApiException {
return this.addLiveStreamPushPublishConfiguration(entryId, protocol, url, null);
}
/** Add new pushPublish configuration to entry */
public KalturaLiveStreamEntry addLiveStreamPushPublishConfiguration(String entryId, KalturaPlaybackProtocol protocol, String url, KalturaLiveStreamConfiguration liveStreamConfiguration) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("protocol", protocol);
kparams.add("url", url);
kparams.add("liveStreamConfiguration", liveStreamConfiguration);
this.kalturaClient.queueServiceCall("livestream", "addLiveStreamPushPublishConfiguration", kparams, KalturaLiveStreamEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaLiveStreamEntry.class, resultXmlElement);
}
/** Remove push publish configuration from entry */
public KalturaLiveStreamEntry removeLiveStreamPushPublishConfiguration(String entryId, KalturaPlaybackProtocol protocol) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("protocol", protocol);
this.kalturaClient.queueServiceCall("livestream", "removeLiveStreamPushPublishConfiguration", kparams, KalturaLiveStreamEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaLiveStreamEntry.class, resultXmlElement);
}
public KalturaLiveEntry appendRecording(String entryId, String assetId, KalturaMediaServerIndex mediaServerIndex, KalturaDataCenterContentResource resource, double duration) throws KalturaApiException {
return this.appendRecording(entryId, assetId, mediaServerIndex, resource, duration, false);
}
/** Append recorded video to live entry */
public KalturaLiveEntry appendRecording(String entryId, String assetId, KalturaMediaServerIndex mediaServerIndex, KalturaDataCenterContentResource resource, double duration, boolean isLastChunk) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("assetId", assetId);
kparams.add("mediaServerIndex", mediaServerIndex);
kparams.add("resource", resource);
kparams.add("duration", duration);
kparams.add("isLastChunk", isLastChunk);
this.kalturaClient.queueServiceCall("livestream", "appendRecording", kparams, KalturaLiveEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaLiveEntry.class, resultXmlElement);
}
public KalturaLiveEntry registerMediaServer(String entryId, String hostname, KalturaMediaServerIndex mediaServerIndex) throws KalturaApiException {
return this.registerMediaServer(entryId, hostname, mediaServerIndex, null);
}
/** Register media server to live entry */
public KalturaLiveEntry registerMediaServer(String entryId, String hostname, KalturaMediaServerIndex mediaServerIndex, String applicationName) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("hostname", hostname);
kparams.add("mediaServerIndex", mediaServerIndex);
kparams.add("applicationName", applicationName);
this.kalturaClient.queueServiceCall("livestream", "registerMediaServer", kparams, KalturaLiveEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaLiveEntry.class, resultXmlElement);
}
/** Unregister media server from live entry */
public KalturaLiveEntry unregisterMediaServer(String entryId, String hostname, KalturaMediaServerIndex mediaServerIndex) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("hostname", hostname);
kparams.add("mediaServerIndex", mediaServerIndex);
this.kalturaClient.queueServiceCall("livestream", "unregisterMediaServer", kparams, KalturaLiveEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaLiveEntry.class, resultXmlElement);
}
/** Validates all registered media servers */
public void validateRegisteredMediaServers(String entryId) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
this.kalturaClient.queueServiceCall("livestream", "validateRegisteredMediaServers", kparams);
if (this.kalturaClient.isMultiRequest())
return ;
this.kalturaClient.doQueue();
}
/** Creates perioding metadata sync-point events on a live stream */
public void createPeriodicSyncPoints(String entryId, int interval, int duration) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("interval", interval);
kparams.add("duration", duration);
this.kalturaClient.queueServiceCall("livestream", "createPeriodicSyncPoints", kparams);
if (this.kalturaClient.isMultiRequest())
return ;
this.kalturaClient.doQueue();
}
}