Package com.kaltura.client.services

Class PlaylistService

java.lang.Object

com.kaltura.client.services.PlaylistService

public class PlaylistService
extends Object

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)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlaylistService.AddPlaylistBuilder
static class	PlaylistService.ClonePlaylistBuilder
static class	PlaylistService.DeletePlaylistBuilder
static class	PlaylistService.ExecuteFromContentPlaylistBuilder
static class	PlaylistService.ExecuteFromFiltersPlaylistBuilder
static class	PlaylistService.ExecutePlaylistBuilder
static class	PlaylistService.GetPlaylistBuilder
static class	PlaylistService.GetStatsFromContentPlaylistBuilder
static class	PlaylistService.ListPlaylistBuilder
static class	PlaylistService.UpdatePlaylistBuilder

Constructor Summary

Constructors

Constructor	Description
PlaylistService()

Method Summary

Modifier and Type	Method	Description
static PlaylistService.AddPlaylistBuilder	add(Playlist playlist)
static PlaylistService.AddPlaylistBuilder	add(Playlist playlist, boolean updateStats)	Add new playlist Note that all entries used in a playlist will become public and may appear in KalturaNetwork
static PlaylistService.ClonePlaylistBuilder	clone(String id)
static PlaylistService.ClonePlaylistBuilder	clone(String id, Playlist newPlaylist)	Clone an existing playlist
static PlaylistService.DeletePlaylistBuilder	delete(String id)	Delete existing playlist
static PlaylistService.ExecutePlaylistBuilder	execute(String id)
static PlaylistService.ExecutePlaylistBuilder	execute(String id, String detailed)
static PlaylistService.ExecutePlaylistBuilder	execute(String id, String detailed, Context playlistContext)
static PlaylistService.ExecutePlaylistBuilder	execute(String id, String detailed, Context playlistContext, MediaEntryFilterForPlaylist filter)
static PlaylistService.ExecutePlaylistBuilder	execute(String id, String detailed, Context playlistContext, MediaEntryFilterForPlaylist filter, FilterPager pager)	Retrieve playlist for playing purpose
static PlaylistService.ExecuteFromContentPlaylistBuilder	executeFromContent(PlaylistType playlistType, String playlistContent)
static PlaylistService.ExecuteFromContentPlaylistBuilder	executeFromContent(PlaylistType playlistType, String playlistContent, String detailed)
static PlaylistService.ExecuteFromContentPlaylistBuilder	executeFromContent(PlaylistType playlistType, String playlistContent, String detailed, FilterPager pager)	Retrieve playlist for playing purpose, based on content
static PlaylistService.ExecuteFromFiltersPlaylistBuilder	executeFromFilters(List<MediaEntryFilterForPlaylist> filters, int totalResults)
static PlaylistService.ExecuteFromFiltersPlaylistBuilder	executeFromFilters(List<MediaEntryFilterForPlaylist> filters, int totalResults, String detailed)
static PlaylistService.ExecuteFromFiltersPlaylistBuilder	executeFromFilters(List<MediaEntryFilterForPlaylist> filters, int totalResults, String detailed, FilterPager pager)	Retrieve playlist for playing purpose, based on media entry filters
static PlaylistService.GetPlaylistBuilder	get(String id)
static PlaylistService.GetPlaylistBuilder	get(String id, int version)	Retrieve a playlist
static PlaylistService.GetStatsFromContentPlaylistBuilder	getStatsFromContent(PlaylistType playlistType, String playlistContent)	Retrieve playlist statistics
static PlaylistService.ListPlaylistBuilder	list()
static PlaylistService.ListPlaylistBuilder	list(PlaylistFilter filter)
static PlaylistService.ListPlaylistBuilder	list(PlaylistFilter filter, FilterPager pager)	List available playlists
static PlaylistService.UpdatePlaylistBuilder	update(String id, Playlist playlist)
static PlaylistService.UpdatePlaylistBuilder	update(String id, Playlist playlist, boolean updateStats)	Update existing playlist Note - you cannot change playlist type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlaylistService

public PlaylistService()

Method Detail

add

public static PlaylistService.AddPlaylistBuilder add(Playlist playlist)

add

public static PlaylistService.AddPlaylistBuilder add(Playlist playlist,
                                                     boolean updateStats)

Add new playlist Note that all entries used in a playlist will become public and may appear in KalturaNetwork

Parameters:

playlist -

updateStats - indicates that the playlist statistics attributes should be updated synchronously now

clone

public static PlaylistService.ClonePlaylistBuilder clone(String id)

clone

public static PlaylistService.ClonePlaylistBuilder clone(String id,
                                                         Playlist newPlaylist)

Clone an existing playlist

Parameters:

id - Id of the playlist to clone

newPlaylist - Parameters defined here will override the ones in the cloned playlist

delete

public static PlaylistService.DeletePlaylistBuilder delete(String id)

Delete existing playlist

Parameters:

id -

execute

public static PlaylistService.ExecutePlaylistBuilder execute(String id)

execute

public static PlaylistService.ExecutePlaylistBuilder execute(String id,
                                                             String detailed)

execute

public static PlaylistService.ExecutePlaylistBuilder execute(String id,
                                                             String detailed,
                                                             Context playlistContext)

execute

public static PlaylistService.ExecutePlaylistBuilder execute(String id,
                                                             String detailed,
                                                             Context playlistContext,
                                                             MediaEntryFilterForPlaylist filter)

execute

public static PlaylistService.ExecutePlaylistBuilder execute(String id,
                                                             String detailed,
                                                             Context playlistContext,
                                                             MediaEntryFilterForPlaylist filter,
                                                             FilterPager pager)

Retrieve playlist for playing purpose

Parameters:

id -

detailed -

playlistContext -

filter -

pager -

executeFromContent

public static PlaylistService.ExecuteFromContentPlaylistBuilder executeFromContent(PlaylistType playlistType,
                                                                                   String playlistContent)

executeFromContent

public static PlaylistService.ExecuteFromContentPlaylistBuilder executeFromContent(PlaylistType playlistType,
                                                                                   String playlistContent,
                                                                                   String detailed)

executeFromContent

public static PlaylistService.ExecuteFromContentPlaylistBuilder executeFromContent(PlaylistType playlistType,
                                                                                   String playlistContent,
                                                                                   String detailed,
                                                                                   FilterPager pager)

Retrieve playlist for playing purpose, based on content

Parameters:

playlistType -

playlistContent -

detailed -

pager -

executeFromFilters

public static PlaylistService.ExecuteFromFiltersPlaylistBuilder executeFromFilters(List<MediaEntryFilterForPlaylist> filters,
                                                                                   int totalResults)

executeFromFilters

public static PlaylistService.ExecuteFromFiltersPlaylistBuilder executeFromFilters(List<MediaEntryFilterForPlaylist> filters,
                                                                                   int totalResults,
                                                                                   String detailed)

executeFromFilters

public static PlaylistService.ExecuteFromFiltersPlaylistBuilder executeFromFilters(List<MediaEntryFilterForPlaylist> filters,
                                                                                   int totalResults,
                                                                                   String detailed,
                                                                                   FilterPager pager)

Retrieve playlist for playing purpose, based on media entry filters

Parameters:

filters -

totalResults -

detailed -

pager -

get

public static PlaylistService.GetPlaylistBuilder get(String id)

get

public static PlaylistService.GetPlaylistBuilder get(String id,
                                                     int version)

Retrieve a playlist

Parameters:

id -

version - Desired version of the data

getStatsFromContent

public static PlaylistService.GetStatsFromContentPlaylistBuilder getStatsFromContent(PlaylistType playlistType,
                                                                                     String playlistContent)

Retrieve playlist statistics

Parameters:

playlistType -

playlistContent -

list

public static PlaylistService.ListPlaylistBuilder list()

list

public static PlaylistService.ListPlaylistBuilder list(PlaylistFilter filter)

list

public static PlaylistService.ListPlaylistBuilder list(PlaylistFilter filter,
                                                       FilterPager pager)

List available playlists

Parameters:

filter -

pager -

update

public static PlaylistService.UpdatePlaylistBuilder update(String id,
                                                           Playlist playlist)

update

public static PlaylistService.UpdatePlaylistBuilder update(String id,
                                                           Playlist playlist,
                                                           boolean updateStats)

Update existing playlist Note - you cannot change playlist type. Updated playlist must be of the same type.

Parameters:

id -

playlist -

updateStats -