com.kaltura.client.services.PlaylistService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kalturaApiClient Show documentation
Show all versions of kalturaApiClient 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
// ===================================================================================================
// _ __ _ _
// | |/ /__ _| | |_ _ _ _ _ __ _
// | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;
import com.kaltura.client.enums.PlaylistType;
import com.kaltura.client.types.BaseEntry;
import com.kaltura.client.types.Context;
import com.kaltura.client.types.FilterPager;
import com.kaltura.client.types.MediaEntryFilterForPlaylist;
import com.kaltura.client.types.Playlist;
import com.kaltura.client.types.PlaylistFilter;
import com.kaltura.client.utils.request.ArrayRequestBuilder;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.NullRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;
import java.util.List;
/**
* This class was generated using generate.php
* against an XML schema provided by Kaltura.
*
* MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
*/
/**
* Playlist service lets you create,manage and play your playlists Playlists could
be static (containing a fixed list of entries) or dynamic (based on a filter)
*
* @param playlist
* @param updateStats indicates that the playlist statistics attributes should be updated
* synchronously now
* @param id Id of the playlist to clone
* @param newPlaylist Parameters defined here will override the ones in the cloned playlist
* @param id
* @param id
* @param detailed
* @param playlistContext
* @param filter
* @param pager
* @param playlistType
* @param playlistContent
* @param detailed
* @param pager
* @param filters
* @param totalResults
* @param detailed
* @param pager
* @param id
* @param version Desired version of the data
* @param playlistType
* @param playlistContent
* @param filter
* @param pager
* @param id
* @param playlist
* @param updateStats
*/
public class PlaylistService {
public static class AddPlaylistBuilder extends RequestBuilder {
public AddPlaylistBuilder(Playlist playlist, boolean updateStats) {
super(Playlist.class, "playlist", "add");
params.add("playlist", playlist);
params.add("updateStats", updateStats);
}
public void updateStats(String multirequestToken) {
params.add("updateStats", multirequestToken);
}
}
public static AddPlaylistBuilder add(Playlist playlist) {
return add(playlist, false);
}
/**
* Add new playlist Note that all entries used in a playlist will become public
and may appear in KalturaNetwork
*
* @param playlist
* @param updateStats indicates that the playlist statistics attributes should be updated
* synchronously now
*/
public static AddPlaylistBuilder add(Playlist playlist, boolean updateStats) {
return new AddPlaylistBuilder(playlist, updateStats);
}
public static class ClonePlaylistBuilder extends RequestBuilder {
public ClonePlaylistBuilder(String id, Playlist newPlaylist) {
super(Playlist.class, "playlist", "clone");
params.add("id", id);
params.add("newPlaylist", newPlaylist);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
}
public static ClonePlaylistBuilder clone(String id) {
return clone(id, null);
}
/**
* Clone an existing playlist
*
* @param id Id of the playlist to clone
* @param newPlaylist Parameters defined here will override the ones in the cloned playlist
*/
public static ClonePlaylistBuilder clone(String id, Playlist newPlaylist) {
return new ClonePlaylistBuilder(id, newPlaylist);
}
public static class DeletePlaylistBuilder extends NullRequestBuilder {
public DeletePlaylistBuilder(String id) {
super("playlist", "delete");
params.add("id", id);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
}
/**
* Delete existing playlist
*
* @param id
*/
public static DeletePlaylistBuilder delete(String id) {
return new DeletePlaylistBuilder(id);
}
public static class ExecutePlaylistBuilder extends ArrayRequestBuilder {
public ExecutePlaylistBuilder(String id, String detailed, Context playlistContext, MediaEntryFilterForPlaylist filter, FilterPager pager) {
super(BaseEntry.class, "playlist", "execute");
params.add("id", id);
params.add("detailed", detailed);
params.add("playlistContext", playlistContext);
params.add("filter", filter);
params.add("pager", pager);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
public void detailed(String multirequestToken) {
params.add("detailed", multirequestToken);
}
}
public static ExecutePlaylistBuilder execute(String id) {
return execute(id, "");
}
public static ExecutePlaylistBuilder execute(String id, String detailed) {
return execute(id, detailed, null);
}
public static ExecutePlaylistBuilder execute(String id, String detailed, Context playlistContext) {
return execute(id, detailed, playlistContext, null);
}
public static ExecutePlaylistBuilder execute(String id, String detailed, Context playlistContext, MediaEntryFilterForPlaylist filter) {
return execute(id, detailed, playlistContext, filter, null);
}
/**
* Retrieve playlist for playing purpose
*
* @param id
* @param detailed
* @param playlistContext
* @param filter
* @param pager
*/
public static ExecutePlaylistBuilder execute(String id, String detailed, Context playlistContext, MediaEntryFilterForPlaylist filter, FilterPager pager) {
return new ExecutePlaylistBuilder(id, detailed, playlistContext, filter, pager);
}
public static class ExecuteFromContentPlaylistBuilder extends ArrayRequestBuilder {
public ExecuteFromContentPlaylistBuilder(PlaylistType playlistType, String playlistContent, String detailed, FilterPager pager) {
super(BaseEntry.class, "playlist", "executeFromContent");
params.add("playlistType", playlistType);
params.add("playlistContent", playlistContent);
params.add("detailed", detailed);
params.add("pager", pager);
}
public void playlistType(String multirequestToken) {
params.add("playlistType", multirequestToken);
}
public void playlistContent(String multirequestToken) {
params.add("playlistContent", multirequestToken);
}
public void detailed(String multirequestToken) {
params.add("detailed", multirequestToken);
}
}
public static ExecuteFromContentPlaylistBuilder executeFromContent(PlaylistType playlistType, String playlistContent) {
return executeFromContent(playlistType, playlistContent, "");
}
public static ExecuteFromContentPlaylistBuilder executeFromContent(PlaylistType playlistType, String playlistContent, String detailed) {
return executeFromContent(playlistType, playlistContent, detailed, null);
}
/**
* Retrieve playlist for playing purpose, based on content
*
* @param playlistType
* @param playlistContent
* @param detailed
* @param pager
*/
public static ExecuteFromContentPlaylistBuilder executeFromContent(PlaylistType playlistType, String playlistContent, String detailed, FilterPager pager) {
return new ExecuteFromContentPlaylistBuilder(playlistType, playlistContent, detailed, pager);
}
public static class ExecuteFromFiltersPlaylistBuilder extends ArrayRequestBuilder {
public ExecuteFromFiltersPlaylistBuilder(List filters, int totalResults, String detailed, FilterPager pager) {
super(BaseEntry.class, "playlist", "executeFromFilters");
params.add("filters", filters);
params.add("totalResults", totalResults);
params.add("detailed", detailed);
params.add("pager", pager);
}
public void totalResults(String multirequestToken) {
params.add("totalResults", multirequestToken);
}
public void detailed(String multirequestToken) {
params.add("detailed", multirequestToken);
}
}
public static ExecuteFromFiltersPlaylistBuilder executeFromFilters(List filters, int totalResults) {
return executeFromFilters(filters, totalResults, "1");
}
public static ExecuteFromFiltersPlaylistBuilder executeFromFilters(List filters, int totalResults, String detailed) {
return executeFromFilters(filters, totalResults, detailed, null);
}
/**
* Retrieve playlist for playing purpose, based on media entry filters
*
* @param filters
* @param totalResults
* @param detailed
* @param pager
*/
public static ExecuteFromFiltersPlaylistBuilder executeFromFilters(List filters, int totalResults, String detailed, FilterPager pager) {
return new ExecuteFromFiltersPlaylistBuilder(filters, totalResults, detailed, pager);
}
public static class GetPlaylistBuilder extends RequestBuilder {
public GetPlaylistBuilder(String id, int version) {
super(Playlist.class, "playlist", "get");
params.add("id", id);
params.add("version", version);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
public void version(String multirequestToken) {
params.add("version", multirequestToken);
}
}
public static GetPlaylistBuilder get(String id) {
return get(id, -1);
}
/**
* Retrieve a playlist
*
* @param id
* @param version Desired version of the data
*/
public static GetPlaylistBuilder get(String id, int version) {
return new GetPlaylistBuilder(id, version);
}
public static class GetStatsFromContentPlaylistBuilder extends RequestBuilder {
public GetStatsFromContentPlaylistBuilder(PlaylistType playlistType, String playlistContent) {
super(Playlist.class, "playlist", "getStatsFromContent");
params.add("playlistType", playlistType);
params.add("playlistContent", playlistContent);
}
public void playlistType(String multirequestToken) {
params.add("playlistType", multirequestToken);
}
public void playlistContent(String multirequestToken) {
params.add("playlistContent", multirequestToken);
}
}
/**
* Retrieve playlist statistics
*
* @param playlistType
* @param playlistContent
*/
public static GetStatsFromContentPlaylistBuilder getStatsFromContent(PlaylistType playlistType, String playlistContent) {
return new GetStatsFromContentPlaylistBuilder(playlistType, playlistContent);
}
public static class ListPlaylistBuilder extends ListResponseRequestBuilder {
public ListPlaylistBuilder(PlaylistFilter filter, FilterPager pager) {
super(Playlist.class, "playlist", "list");
params.add("filter", filter);
params.add("pager", pager);
}
}
public static ListPlaylistBuilder list() {
return list(null);
}
public static ListPlaylistBuilder list(PlaylistFilter filter) {
return list(filter, null);
}
/**
* List available playlists
*
* @param filter
* @param pager
*/
public static ListPlaylistBuilder list(PlaylistFilter filter, FilterPager pager) {
return new ListPlaylistBuilder(filter, pager);
}
public static class UpdatePlaylistBuilder extends RequestBuilder {
public UpdatePlaylistBuilder(String id, Playlist playlist, boolean updateStats) {
super(Playlist.class, "playlist", "update");
params.add("id", id);
params.add("playlist", playlist);
params.add("updateStats", updateStats);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
public void updateStats(String multirequestToken) {
params.add("updateStats", multirequestToken);
}
}
public static UpdatePlaylistBuilder update(String id, Playlist playlist) {
return update(id, playlist, false);
}
/**
* Update existing playlist Note - you cannot change playlist type. Updated
playlist must be of the same type.
*
* @param id
* @param playlist
* @param updateStats
*/
public static UpdatePlaylistBuilder update(String id, Playlist playlist, boolean updateStats) {
return new UpdatePlaylistBuilder(id, playlist, updateStats);
}
}