Package com.kaltura.client.services
Class MediaService
- java.lang.Object
-
- com.kaltura.client.services.MediaService
-
public class MediaService extends Object
Media service lets you upload and manage media files (images / videos & audio)
-
-
Nested Class Summary
-
Constructor Summary
Constructors Constructor Description MediaService()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static MediaService.AddMediaBuilderadd(MediaEntry entry)Add entrystatic MediaService.AddContentMediaBuilderaddContent(String entryId)static MediaService.AddContentMediaBuilderaddContent(String entryId, Resource resource)Add content to media entry which is not yet associated with content (therefore is in status NO_CONTENT).static MediaService.AddFromBulkMediaBuilderaddFromBulk(MediaEntry mediaEntry, String url, int bulkUploadId)Adds new media entry by importing an HTTP or FTP URL.static MediaService.AddFromEntryMediaBuilderaddFromEntry(String sourceEntryId)static MediaService.AddFromEntryMediaBuilderaddFromEntry(String sourceEntryId, MediaEntry mediaEntry)static MediaService.AddFromEntryMediaBuilderaddFromEntry(String sourceEntryId, MediaEntry mediaEntry, int sourceFlavorParamsId)Copy entry into new entrystatic MediaService.AddFromFlavorAssetMediaBuilderaddFromFlavorAsset(String sourceFlavorAssetId)static MediaService.AddFromFlavorAssetMediaBuilderaddFromFlavorAsset(String sourceFlavorAssetId, MediaEntry mediaEntry)Copy flavor asset into new entrystatic MediaService.AddFromRecordedWebcamMediaBuilderaddFromRecordedWebcam(MediaEntry mediaEntry, String webcamTokenId)Add new entry after the file was recorded on the server and the token id existsstatic MediaService.AddFromSearchResultMediaBuilderaddFromSearchResult()static MediaService.AddFromSearchResultMediaBuilderaddFromSearchResult(MediaEntry mediaEntry)static MediaService.AddFromSearchResultMediaBuilderaddFromSearchResult(MediaEntry mediaEntry, SearchResult searchResult)Adds new media entry by importing the media file from a search provider.static MediaService.AddFromUploadedFileMediaBuilderaddFromUploadedFile(MediaEntry mediaEntry, String uploadTokenId)Add new entry after the specific media file was uploaded and the upload token id existsstatic MediaService.AddFromUrlMediaBuilderaddFromUrl(MediaEntry mediaEntry, String url)Adds new media entry by importing an HTTP or FTP URL.static MediaService.AnonymousRankMediaBuilderanonymousRank(String entryId, int rank)Anonymously rank a media entry, no validation is done on duplicate rankingsstatic MediaService.ApproveMediaBuilderapprove(String entryId)Approve the media entry and mark the pending flags (if any) as moderated (this will make the entry playable)static MediaService.ApproveReplaceMediaBuilderapproveReplace(String entryId)Approves media replacementstatic MediaService.BulkUploadAddMediaBuilderbulkUploadAdd(FileHolder fileData)static MediaService.BulkUploadAddMediaBuilderbulkUploadAdd(FileHolder fileData, BulkUploadJobData bulkUploadData)static MediaService.BulkUploadAddMediaBuilderbulkUploadAdd(FileHolder fileData, BulkUploadJobData bulkUploadData, BulkUploadEntryData bulkUploadEntryData)Add new bulk upload batch job Conversion profile id can be specified in the API or in the CSV file, the one in the CSV file will be stronger.static MediaService.BulkUploadAddMediaBuilderbulkUploadAdd(File fileData)static MediaService.BulkUploadAddMediaBuilderbulkUploadAdd(FileInputStream fileData, String fileDataMimeType, String fileDataName)static MediaService.BulkUploadAddMediaBuilderbulkUploadAdd(FileInputStream fileData, String fileDataMimeType, String fileDataName, BulkUploadJobData bulkUploadData)static MediaService.BulkUploadAddMediaBuilderbulkUploadAdd(FileInputStream fileData, String fileDataMimeType, String fileDataName, BulkUploadJobData bulkUploadData, BulkUploadEntryData bulkUploadEntryData)static MediaService.BulkUploadAddMediaBuilderbulkUploadAdd(File fileData, BulkUploadJobData bulkUploadData)static MediaService.BulkUploadAddMediaBuilderbulkUploadAdd(File fileData, BulkUploadJobData bulkUploadData, BulkUploadEntryData bulkUploadEntryData)static MediaService.BulkUploadAddMediaBuilderbulkUploadAdd(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)static MediaService.BulkUploadAddMediaBuilderbulkUploadAdd(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize, BulkUploadJobData bulkUploadData)static MediaService.BulkUploadAddMediaBuilderbulkUploadAdd(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize, BulkUploadJobData bulkUploadData, BulkUploadEntryData bulkUploadEntryData)static MediaService.CancelReplaceMediaBuildercancelReplace(String entryId)Cancels media replacementstatic MediaService.ConvertMediaBuilderconvert(String entryId)static MediaService.ConvertMediaBuilderconvert(String entryId, int conversionProfileId)static MediaService.ConvertMediaBuilderconvert(String entryId, int conversionProfileId, List<ConversionAttribute> dynamicConversionAttributes)Convert entrystatic MediaService.CountMediaBuildercount()static MediaService.CountMediaBuildercount(MediaEntryFilter filter)Count media entries by filter.static MediaService.DeleteMediaBuilderdelete(String entryId)Delete a media entry.static MediaService.ExportToCsvMediaBuilderexportToCsv(MediaEsearchExportToCsvJobData data)Creates a batch job that sends an email with a link to download a CSV containing a list of entriesstatic MediaService.FlagMediaBuilderflag(ModerationFlag moderationFlag)Flag inappropriate media entry for moderationstatic MediaService.GetMediaBuilderget(String entryId)static MediaService.GetMediaBuilderget(String entryId, int version)Get media entry by ID.static MediaService.GetMrssMediaBuildergetMrss(String entryId)static MediaService.GetMrssMediaBuildergetMrss(String entryId, List<ExtendingItemMrssParameter> extendingItemsArray)static MediaService.GetMrssMediaBuildergetMrss(String entryId, List<ExtendingItemMrssParameter> extendingItemsArray, String features)Get MRSS by entry id XML will return as an escaped stringstatic MediaService.GetVolumeMapMediaBuildergetVolumeMap(String entryId)Get volume map by entry idstatic MediaService.ListMediaBuilderlist()static MediaService.ListMediaBuilderlist(MediaEntryFilter filter)static MediaService.ListMediaBuilderlist(MediaEntryFilter filter, FilterPager pager)List media entries by filter with paging support.static MediaService.ListFlagsMediaBuilderlistFlags(String entryId)static MediaService.ListFlagsMediaBuilderlistFlags(String entryId, FilterPager pager)List all pending flags for the media entrystatic MediaService.RejectMediaBuilderreject(String entryId)Reject the media entry and mark the pending flags (if any) as moderated (this will make the entry non playable)static MediaService.RequestConversionMediaBuilderrequestConversion(String entryId, String fileFormat)Request a new conversion job, this can be used to convert the media entry to a different formatstatic MediaService.UpdateMediaBuilderupdate(String entryId, MediaEntry mediaEntry)Update media entry.static MediaService.UpdateContentMediaBuilderupdateContent(String entryId, Resource resource)static MediaService.UpdateContentMediaBuilderupdateContent(String entryId, Resource resource, int conversionProfileId)static MediaService.UpdateContentMediaBuilderupdateContent(String entryId, Resource resource, int conversionProfileId, EntryReplacementOptions advancedOptions)Replace content associated with the media entry.static MediaService.UpdateThumbnailMediaBuilderupdateThumbnail(String entryId, int timeOffset)static MediaService.UpdateThumbnailMediaBuilderupdateThumbnail(String entryId, int timeOffset, int flavorParamsId)Update media entry thumbnail by a specified time offset (In seconds) If flavor params id not specified, source flavor will be used by defaultstatic MediaService.UpdateThumbnailFromSourceEntryMediaBuilderupdateThumbnailFromSourceEntry(String entryId, String sourceEntryId, int timeOffset)static MediaService.UpdateThumbnailFromSourceEntryMediaBuilderupdateThumbnailFromSourceEntry(String entryId, String sourceEntryId, int timeOffset, int flavorParamsId)Update media entry thumbnail from a different entry by a specified time offset (In seconds) If flavor params id not specified, source flavor will be used by defaultstatic MediaService.UpdateThumbnailFromUrlMediaBuilderupdateThumbnailFromUrl(String entryId, String url)Update entry thumbnail using URLstatic MediaService.UpdateThumbnailJpegMediaBuilderupdateThumbnailJpeg(String entryId, FileHolder fileData)Update media entry thumbnail using a raw jpeg filestatic MediaService.UpdateThumbnailJpegMediaBuilderupdateThumbnailJpeg(String entryId, File fileData)static MediaService.UpdateThumbnailJpegMediaBuilderupdateThumbnailJpeg(String entryId, FileInputStream fileData, String fileDataMimeType, String fileDataName)static MediaService.UpdateThumbnailJpegMediaBuilderupdateThumbnailJpeg(String entryId, InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)static MediaService.UploadMediaBuilderupload(FileHolder fileData)Upload a media file to Kaltura, then the file can be used to create a media entry.static MediaService.UploadMediaBuilderupload(File fileData)static MediaService.UploadMediaBuilderupload(FileInputStream fileData, String fileDataMimeType, String fileDataName)static MediaService.UploadMediaBuilderupload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)
-
-
-
Method Detail
-
add
public static MediaService.AddMediaBuilder add(MediaEntry entry)
Add entry- Parameters:
entry-
-
addContent
public static MediaService.AddContentMediaBuilder addContent(String entryId)
-
addContent
public static MediaService.AddContentMediaBuilder addContent(String entryId, Resource resource)
Add content to media entry which is not yet associated with content (therefore is in status NO_CONTENT). If the requirement is to replace the entry's associated content, use action updateContent.- Parameters:
entryId-resource-
-
addFromBulk
public static MediaService.AddFromBulkMediaBuilder addFromBulk(MediaEntry mediaEntry, String url, int bulkUploadId)
Adds new media entry by importing an HTTP or FTP URL. The entry will be queued for import and then for conversion. This action should be exposed only to the batches- Parameters:
mediaEntry- Media entry metadataurl- An HTTP or FTP URLbulkUploadId- The id of the bulk upload job
-
addFromEntry
public static MediaService.AddFromEntryMediaBuilder addFromEntry(String sourceEntryId)
-
addFromEntry
public static MediaService.AddFromEntryMediaBuilder addFromEntry(String sourceEntryId, MediaEntry mediaEntry)
-
addFromEntry
public static MediaService.AddFromEntryMediaBuilder addFromEntry(String sourceEntryId, MediaEntry mediaEntry, int sourceFlavorParamsId)
Copy entry into new entry- Parameters:
sourceEntryId- Media entry id to copy frommediaEntry- Media entry metadatasourceFlavorParamsId- The flavor to be used as the new entry source, source flavor will be used if not specified
-
addFromFlavorAsset
public static MediaService.AddFromFlavorAssetMediaBuilder addFromFlavorAsset(String sourceFlavorAssetId)
-
addFromFlavorAsset
public static MediaService.AddFromFlavorAssetMediaBuilder addFromFlavorAsset(String sourceFlavorAssetId, MediaEntry mediaEntry)
Copy flavor asset into new entry- Parameters:
sourceFlavorAssetId- Flavor asset id to be used as the new entry sourcemediaEntry- Media entry metadata
-
addFromRecordedWebcam
public static MediaService.AddFromRecordedWebcamMediaBuilder addFromRecordedWebcam(MediaEntry mediaEntry, String webcamTokenId)
Add new entry after the file was recorded on the server and the token id exists- Parameters:
mediaEntry- Media entry metadatawebcamTokenId- Token id for the recorded webcam file
-
addFromSearchResult
public static MediaService.AddFromSearchResultMediaBuilder addFromSearchResult()
-
addFromSearchResult
public static MediaService.AddFromSearchResultMediaBuilder addFromSearchResult(MediaEntry mediaEntry)
-
addFromSearchResult
public static MediaService.AddFromSearchResultMediaBuilder addFromSearchResult(MediaEntry mediaEntry, SearchResult searchResult)
Adds new media entry by importing the media file from a search provider. This action should be used with the search service result.- Parameters:
mediaEntry- Media entry metadatasearchResult- Result object from search service
-
addFromUploadedFile
public static MediaService.AddFromUploadedFileMediaBuilder addFromUploadedFile(MediaEntry mediaEntry, String uploadTokenId)
Add new entry after the specific media file was uploaded and the upload token id exists- Parameters:
mediaEntry- Media entry metadatauploadTokenId- Upload token id
-
addFromUrl
public static MediaService.AddFromUrlMediaBuilder addFromUrl(MediaEntry mediaEntry, String url)
Adds new media entry by importing an HTTP or FTP URL. The entry will be queued for import and then for conversion.- Parameters:
mediaEntry- Media entry metadataurl- An HTTP or FTP URL
-
anonymousRank
public static MediaService.AnonymousRankMediaBuilder anonymousRank(String entryId, int rank)
Anonymously rank a media entry, no validation is done on duplicate rankings- Parameters:
entryId-rank-
-
approve
public static MediaService.ApproveMediaBuilder approve(String entryId)
Approve the media entry and mark the pending flags (if any) as moderated (this will make the entry playable)- Parameters:
entryId-
-
approveReplace
public static MediaService.ApproveReplaceMediaBuilder approveReplace(String entryId)
Approves media replacement- Parameters:
entryId- Media entry id to replace
-
bulkUploadAdd
public static MediaService.BulkUploadAddMediaBuilder bulkUploadAdd(FileHolder fileData)
-
bulkUploadAdd
public static MediaService.BulkUploadAddMediaBuilder bulkUploadAdd(File fileData)
-
bulkUploadAdd
public static MediaService.BulkUploadAddMediaBuilder bulkUploadAdd(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)
-
bulkUploadAdd
public static MediaService.BulkUploadAddMediaBuilder bulkUploadAdd(FileInputStream fileData, String fileDataMimeType, String fileDataName)
-
bulkUploadAdd
public static MediaService.BulkUploadAddMediaBuilder bulkUploadAdd(FileHolder fileData, BulkUploadJobData bulkUploadData)
-
bulkUploadAdd
public static MediaService.BulkUploadAddMediaBuilder bulkUploadAdd(File fileData, BulkUploadJobData bulkUploadData)
-
bulkUploadAdd
public static MediaService.BulkUploadAddMediaBuilder bulkUploadAdd(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize, BulkUploadJobData bulkUploadData)
-
bulkUploadAdd
public static MediaService.BulkUploadAddMediaBuilder bulkUploadAdd(FileInputStream fileData, String fileDataMimeType, String fileDataName, BulkUploadJobData bulkUploadData)
-
bulkUploadAdd
public static MediaService.BulkUploadAddMediaBuilder bulkUploadAdd(File fileData, BulkUploadJobData bulkUploadData, BulkUploadEntryData bulkUploadEntryData)
-
bulkUploadAdd
public static MediaService.BulkUploadAddMediaBuilder bulkUploadAdd(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize, BulkUploadJobData bulkUploadData, BulkUploadEntryData bulkUploadEntryData)
-
bulkUploadAdd
public static MediaService.BulkUploadAddMediaBuilder bulkUploadAdd(FileInputStream fileData, String fileDataMimeType, String fileDataName, BulkUploadJobData bulkUploadData, BulkUploadEntryData bulkUploadEntryData)
-
bulkUploadAdd
public static MediaService.BulkUploadAddMediaBuilder bulkUploadAdd(FileHolder fileData, BulkUploadJobData bulkUploadData, BulkUploadEntryData bulkUploadEntryData)
Add new bulk upload batch job Conversion profile id can be specified in the API or in the CSV file, the one in the CSV file will be stronger. If no conversion profile was specified, partner's default will be used- Parameters:
fileData-bulkUploadData-bulkUploadEntryData-
-
cancelReplace
public static MediaService.CancelReplaceMediaBuilder cancelReplace(String entryId)
Cancels media replacement- Parameters:
entryId- Media entry id to cancel
-
convert
public static MediaService.ConvertMediaBuilder convert(String entryId)
-
convert
public static MediaService.ConvertMediaBuilder convert(String entryId, int conversionProfileId)
-
convert
public static MediaService.ConvertMediaBuilder convert(String entryId, int conversionProfileId, List<ConversionAttribute> dynamicConversionAttributes)
Convert entry- Parameters:
entryId- Media entry idconversionProfileId-dynamicConversionAttributes-
-
count
public static MediaService.CountMediaBuilder count()
-
count
public static MediaService.CountMediaBuilder count(MediaEntryFilter filter)
Count media entries by filter.- Parameters:
filter- Media entry filter
-
delete
public static MediaService.DeleteMediaBuilder delete(String entryId)
Delete a media entry.- Parameters:
entryId- Media entry id to delete
-
exportToCsv
public static MediaService.ExportToCsvMediaBuilder exportToCsv(MediaEsearchExportToCsvJobData data)
Creates a batch job that sends an email with a link to download a CSV containing a list of entries- Parameters:
data- job data indicating filter to pass to the job
-
flag
public static MediaService.FlagMediaBuilder flag(ModerationFlag moderationFlag)
Flag inappropriate media entry for moderation- Parameters:
moderationFlag-
-
get
public static MediaService.GetMediaBuilder get(String entryId)
-
get
public static MediaService.GetMediaBuilder get(String entryId, int version)
Get media entry by ID.- Parameters:
entryId- Media entry idversion- Desired version of the data
-
getMrss
public static MediaService.GetMrssMediaBuilder getMrss(String entryId)
-
getMrss
public static MediaService.GetMrssMediaBuilder getMrss(String entryId, List<ExtendingItemMrssParameter> extendingItemsArray)
-
getMrss
public static MediaService.GetMrssMediaBuilder getMrss(String entryId, List<ExtendingItemMrssParameter> extendingItemsArray, String features)
Get MRSS by entry id XML will return as an escaped string- Parameters:
entryId- Entry idextendingItemsArray-features-
-
getVolumeMap
public static MediaService.GetVolumeMapMediaBuilder getVolumeMap(String entryId)
Get volume map by entry id- Parameters:
entryId- Entry id
-
list
public static MediaService.ListMediaBuilder list()
-
list
public static MediaService.ListMediaBuilder list(MediaEntryFilter filter)
-
list
public static MediaService.ListMediaBuilder list(MediaEntryFilter filter, FilterPager pager)
List media entries by filter with paging support.- Parameters:
filter- Media entry filterpager- Pager
-
listFlags
public static MediaService.ListFlagsMediaBuilder listFlags(String entryId)
-
listFlags
public static MediaService.ListFlagsMediaBuilder listFlags(String entryId, FilterPager pager)
List all pending flags for the media entry- Parameters:
entryId-pager-
-
reject
public static MediaService.RejectMediaBuilder reject(String entryId)
Reject the media entry and mark the pending flags (if any) as moderated (this will make the entry non playable)- Parameters:
entryId-
-
requestConversion
public static MediaService.RequestConversionMediaBuilder requestConversion(String entryId, String fileFormat)
Request a new conversion job, this can be used to convert the media entry to a different format- Parameters:
entryId- Media entry idfileFormat- Format to convert
-
update
public static MediaService.UpdateMediaBuilder update(String entryId, MediaEntry mediaEntry)
Update media entry. Only the properties that were set will be updated.- Parameters:
entryId- Media entry id to updatemediaEntry- Media entry metadata to update
-
updateContent
public static MediaService.UpdateContentMediaBuilder updateContent(String entryId, Resource resource)
-
updateContent
public static MediaService.UpdateContentMediaBuilder updateContent(String entryId, Resource resource, int conversionProfileId)
-
updateContent
public static MediaService.UpdateContentMediaBuilder updateContent(String entryId, Resource resource, int conversionProfileId, EntryReplacementOptions advancedOptions)
Replace content associated with the media entry.- Parameters:
entryId- Media entry id to updateresource- Resource to be used to replace entry media contentconversionProfileId- The conversion profile id to be used on the entryadvancedOptions- Additional update content options
-
updateThumbnail
public static MediaService.UpdateThumbnailMediaBuilder updateThumbnail(String entryId, int timeOffset)
-
updateThumbnail
public static MediaService.UpdateThumbnailMediaBuilder updateThumbnail(String entryId, int timeOffset, int flavorParamsId)
Update media entry thumbnail by a specified time offset (In seconds) If flavor params id not specified, source flavor will be used by default- Parameters:
entryId- Media entry idtimeOffset- Time offset (in seconds)flavorParamsId- The flavor params id to be used
-
updateThumbnailFromSourceEntry
public static MediaService.UpdateThumbnailFromSourceEntryMediaBuilder updateThumbnailFromSourceEntry(String entryId, String sourceEntryId, int timeOffset)
-
updateThumbnailFromSourceEntry
public static MediaService.UpdateThumbnailFromSourceEntryMediaBuilder updateThumbnailFromSourceEntry(String entryId, String sourceEntryId, int timeOffset, int flavorParamsId)
Update media entry thumbnail from a different entry by a specified time offset (In seconds) If flavor params id not specified, source flavor will be used by default- Parameters:
entryId- Media entry idsourceEntryId- Media entry idtimeOffset- Time offset (in seconds)flavorParamsId- The flavor params id to be used
-
updateThumbnailFromUrl
public static MediaService.UpdateThumbnailFromUrlMediaBuilder updateThumbnailFromUrl(String entryId, String url)
Update entry thumbnail using URL- Parameters:
entryId- Media entry idurl- file url
-
updateThumbnailJpeg
public static MediaService.UpdateThumbnailJpegMediaBuilder updateThumbnailJpeg(String entryId, File fileData)
-
updateThumbnailJpeg
public static MediaService.UpdateThumbnailJpegMediaBuilder updateThumbnailJpeg(String entryId, InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)
-
updateThumbnailJpeg
public static MediaService.UpdateThumbnailJpegMediaBuilder updateThumbnailJpeg(String entryId, FileInputStream fileData, String fileDataMimeType, String fileDataName)
-
updateThumbnailJpeg
public static MediaService.UpdateThumbnailJpegMediaBuilder updateThumbnailJpeg(String entryId, FileHolder fileData)
Update media entry thumbnail using a raw jpeg file- Parameters:
entryId- Media entry idfileData- Jpeg file data
-
upload
public static MediaService.UploadMediaBuilder upload(File fileData)
-
upload
public static MediaService.UploadMediaBuilder upload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)
-
upload
public static MediaService.UploadMediaBuilder upload(FileInputStream fileData, String fileDataMimeType, String fileDataName)
-
upload
public static MediaService.UploadMediaBuilder upload(FileHolder fileData)
Upload a media file to Kaltura, then the file can be used to create a media entry.- Parameters:
fileData- The file data
-
-