Package com.kaltura.client.services

Class MixingService

java.lang.Object

com.kaltura.client.services.MixingService

public class MixingService
extends Object

A Mix is an XML unique format invented by Kaltura, it allows the user to create a mix of videos and images, in and out points, transitions, text overlays, soundtrack, effects and much more... Mixing service lets you create a new mix, manage its metadata and make basic manipulations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MixingService.AddMixingBuilder
static class	MixingService.AnonymousRankMixingBuilder
static class	MixingService.AppendMediaEntryMixingBuilder
static class	MixingService.CloneMixingBuilder
static class	MixingService.CountMixingBuilder
static class	MixingService.DeleteMixingBuilder
static class	MixingService.GetMixesByMediaIdMixingBuilder
static class	MixingService.GetMixingBuilder
static class	MixingService.GetReadyMediaEntriesMixingBuilder
static class	MixingService.ListMixingBuilder
static class	MixingService.UpdateMixingBuilder

Constructor Summary

Constructors

Constructor	Description
MixingService()

Method Summary

Modifier and Type	Method	Description
static MixingService.AddMixingBuilder	add(MixEntry mixEntry)	Adds a new mix.
static MixingService.AnonymousRankMixingBuilder	anonymousRank(String entryId, int rank)	Anonymously rank a mix entry, no validation is done on duplicate rankings
static MixingService.AppendMediaEntryMixingBuilder	appendMediaEntry(String mixEntryId, String mediaEntryId)	Appends a media entry to the end of the mix timeline, this will save the mix timeline as a new version.
static MixingService.CloneMixingBuilder	clone(String entryId)	Clones an existing mix.
static MixingService.CountMixingBuilder	count()
static MixingService.CountMixingBuilder	count(MediaEntryFilter filter)	Count mix entries by filter.
static MixingService.DeleteMixingBuilder	delete(String entryId)	Delete a mix entry.
static MixingService.GetMixingBuilder	get(String entryId)
static MixingService.GetMixingBuilder	get(String entryId, int version)	Get mix entry by id.
static MixingService.GetMixesByMediaIdMixingBuilder	getMixesByMediaId(String mediaEntryId)	Get the mixes in which the media entry is included
static MixingService.GetReadyMediaEntriesMixingBuilder	getReadyMediaEntries(String mixId)
static MixingService.GetReadyMediaEntriesMixingBuilder	getReadyMediaEntries(String mixId, int version)	Get all ready media entries that exist in the given mix id
static MixingService.ListMixingBuilder	list()
static MixingService.ListMixingBuilder	list(MixEntryFilter filter)
static MixingService.ListMixingBuilder	list(MixEntryFilter filter, FilterPager pager)	List entries by filter with paging support.
static MixingService.UpdateMixingBuilder	update(String entryId, MixEntry mixEntry)	Update mix entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

MixingService

public MixingService()

Method Detail

add

public static MixingService.AddMixingBuilder add(MixEntry mixEntry)

Adds a new mix. If the dataContent is null, a default timeline will be created.

Parameters:

mixEntry - Mix entry metadata

anonymousRank

public static MixingService.AnonymousRankMixingBuilder anonymousRank(String entryId,
                                                                     int rank)

Anonymously rank a mix entry, no validation is done on duplicate rankings

Parameters:

entryId -

rank -

appendMediaEntry

public static MixingService.AppendMediaEntryMixingBuilder appendMediaEntry(String mixEntryId,
                                                                           String mediaEntryId)

Appends a media entry to the end of the mix timeline, this will save the mix timeline as a new version.

Parameters:

mixEntryId - Mix entry to append to its timeline

mediaEntryId - Media entry to append to the timeline

clone

public static MixingService.CloneMixingBuilder clone(String entryId)

Clones an existing mix.

Parameters:

entryId - Mix entry id to clone

count

public static MixingService.CountMixingBuilder count()

count

public static MixingService.CountMixingBuilder count(MediaEntryFilter filter)

Count mix entries by filter.

Parameters:

filter - Media entry filter

delete

public static MixingService.DeleteMixingBuilder delete(String entryId)

Delete a mix entry.

Parameters:

entryId - Mix entry id to delete

get

public static MixingService.GetMixingBuilder get(String entryId)

get

public static MixingService.GetMixingBuilder get(String entryId,
                                                 int version)

Get mix entry by id.

Parameters:

entryId - Mix entry id

version - Desired version of the data

getMixesByMediaId

public static MixingService.GetMixesByMediaIdMixingBuilder getMixesByMediaId(String mediaEntryId)

Get the mixes in which the media entry is included

Parameters:

mediaEntryId -

getReadyMediaEntries

public static MixingService.GetReadyMediaEntriesMixingBuilder getReadyMediaEntries(String mixId)

getReadyMediaEntries

public static MixingService.GetReadyMediaEntriesMixingBuilder getReadyMediaEntries(String mixId,
                                                                                   int version)

Get all ready media entries that exist in the given mix id

Parameters:

mixId -

version - Desired version to get the data from

list

public static MixingService.ListMixingBuilder list()

list

public static MixingService.ListMixingBuilder list(MixEntryFilter filter)

list

public static MixingService.ListMixingBuilder list(MixEntryFilter filter,
                                                   FilterPager pager)

List entries by filter with paging support. Return parameter is an array of mix entries.

Parameters:

filter - Mix entry filter

pager - Pager

update

public static MixingService.UpdateMixingBuilder update(String entryId,
                                                       MixEntry mixEntry)

Update mix entry. Only the properties that were set will be updated.

Parameters:

entryId - Mix entry id to update

mixEntry - Mix entry metadata to update