6.0.0 • Published 5 years ago

@datafire/kaltura v6.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/kaltura

Client library for Kaltura VPaaS

Installation and Usage

npm install --save @datafire/kaltura
let kaltura = require('@datafire/kaltura').create({
  ks: ""
});

.then(data => {
  console.log(data);
});

Description

The Kaltura VPaaS API

Actions

accessControl.add

Add new Access Control Profile

kaltura.accessControl.add({}, context)

Input

  • input object

Output

accessControl.delete

Delete Access Control Profile by id

kaltura.accessControl.delete({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required integer

Output

Output schema unknown

accessControl.get

Get Access Control Profile by id

kaltura.accessControl.get({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required integer

Output

accessControl.list

List Access Control Profiles by filter and pager

kaltura.accessControl.list({}, context)

Input

Output

accessControl.update

Update Access Control Profile by id

kaltura.accessControl.update({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

accessControlProfile.add

Add new access control profile

kaltura.accessControlProfile.add({}, context)

Input

Output

accessControlProfile.delete

Delete access control profile by id

kaltura.accessControlProfile.delete({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required integer

Output

Output schema unknown

accessControlProfile.get

Get access control profile by id

kaltura.accessControlProfile.get({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required integer

Output

accessControlProfile.list

List access control profiles by filter and pager

kaltura.accessControlProfile.list({}, context)

Input

Output

accessControlProfile.update

Update access control profile by id

kaltura.accessControlProfile.update({}, context)

Input

  • input object

Output

adminUser.login

Get an admin session using admin email and password (Used for login to the KMC application)

kaltura.adminUser.login({}, context)

Input

  • input object
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • email required string
      • partnerId integer
      • password required string

Output

  • output string

adminUser.resetPassword

Reset admin user password and send it to the users email address

kaltura.adminUser.resetPassword({}, context)

Input

  • input object
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • email required string

Output

Output schema unknown

adminUser.setInitialPassword

Set initial users password

kaltura.adminUser.setInitialPassword({}, context)

Input

  • input object
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • hashKey required string
      • newPassword required string

Output

Output schema unknown

adminUser.updatePassword

Update admin user password and email

kaltura.adminUser.updatePassword({}, context)

Input

  • input object
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • email required string
      • newEmail string
      • newPassword string
      • password required string

Output

analytics.query

report query action allows to get a analytics data for specific query dimensions, metrics and filters.

kaltura.analytics.query({}, context)

Input

Output

annotation.add

Allows you to add an annotation object associated with an entry

kaltura.annotation.add({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

annotation.addFromBulk

Allows you to add multiple cue points objects by uploading XML that contains multiple cue point definitions

kaltura.annotation.addFromBulk({
  "fileData": ""
}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • fileData required string, object
      • content string
      • encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
      • contentType string
      • filename string

Output

annotation.clone

Clone cuePoint with id to given entry

kaltura.annotation.clone({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entryId required string
      • id required string

Output

annotation.count

count cue point objects by filter

kaltura.annotation.count({}, context)

Input

Output

  • output integer

annotation.delete

delete cue point by id, and delete all children cue points

kaltura.annotation.delete({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required string

Output

Output schema unknown

annotation.get

Retrieve an CuePoint object by id

kaltura.annotation.get({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required string

Output

annotation.list

List annotation objects by filter and pager

kaltura.annotation.list({}, context)

Input

Output

annotation.serveBulk

Download multiple cue points objects as XML definitions

kaltura.annotation.serveBulk({}, context)

Input

Output

  • output string

annotation.update

Update annotation by id

kaltura.annotation.update({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

annotation.updateCuePointsTimes

kaltura.annotation.updateCuePointsTimes({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • endTime integer
      • id required string
      • startTime required integer

Output

annotation.updateStatus

Update cuePoint status by id

kaltura.annotation.updateStatus({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required string
      • status required integer (values: 1, 2, 3, 4)

Output

Output schema unknown

appToken.add

Add new application authentication token

kaltura.appToken.add({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

appToken.delete

Delete application authentication token by ID

kaltura.appToken.delete({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required string

Output

Output schema unknown

appToken.get

Get application authentication token by ID

kaltura.appToken.get({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required string

Output

appToken.list

List application authentication tokens by filter and pager

kaltura.appToken.list({}, context)

Input

Output

appToken.startSession

Starts a new KS (kaltura Session) based on an application authentication token ID

kaltura.appToken.startSession({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • expiry integer
      • id required string
      • sessionPrivileges string
      • tokenHash required string
      • type integer (values: 0, 2)
      • userId string

Output

appToken.update

Update application authentication token by ID

kaltura.appToken.update({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

aspera.getFaspUrl

kaltura.aspera.getFaspUrl({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • flavorAssetId required string

Output

  • output string

attachmentAsset.add

Add attachment asset

kaltura.attachmentAsset.add({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

attachmentAsset.delete

kaltura.attachmentAsset.delete({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • attachmentAssetId required string

Output

Output schema unknown

attachmentAsset.get

kaltura.attachmentAsset.get({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • attachmentAssetId required string

Output

attachmentAsset.getRemotePaths

Get remote storage existing paths for the asset

kaltura.attachmentAsset.getRemotePaths({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required string

Output

attachmentAsset.getUrl

Get download URL for the asset

kaltura.attachmentAsset.getUrl({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required string
      • storageId integer

Output

  • output string

attachmentAsset.list

List attachment Assets by filter and pager

kaltura.attachmentAsset.list({}, context)

Input

Output

attachmentAsset.serve

Serves attachment by its id

kaltura.attachmentAsset.serve({}, context)

Input

Output

  • output string

attachmentAsset.setContent

Update content of attachment asset

kaltura.attachmentAsset.setContent({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

attachmentAsset.update

Update attachment asset

kaltura.attachmentAsset.update({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

attUverse.getFeed

kaltura.attUverse.getFeed({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • distributionProfileId required integer
      • hash required string

Output

  • output string

auditTrail.add

Allows you to add an audit trail object and audit trail content associated with Kaltura object

kaltura.auditTrail.add({}, context)

Input

  • input object

Output

auditTrail.get

Retrieve an audit trail object by id

kaltura.auditTrail.get({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required integer

Output

auditTrail.list

List audit trail objects by filter and pager

kaltura.auditTrail.list({}, context)

Input

Output

avn.getFeed

kaltura.avn.getFeed({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • distributionProfileId required integer
      • hash required string

Output

Output schema unknown

baseEntry.add

Generic add entry, should be used when the uploaded entry type is not known.

kaltura.baseEntry.add({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entry required KalturaBaseEntry
      • type string (values: -1, conference.CONFERENCE_ENTRY_SERVER, externalMedia.externalMedia, 1, 2, 5, 6, 7, 8, 10)

Output

baseEntry.addContent

Attach content resource to entry in status NO_MEDIA

kaltura.baseEntry.addContent({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

baseEntry.addFromUploadedFile

Generic add entry using an uploaded file, should be used when the uploaded entry type is not known.

kaltura.baseEntry.addFromUploadedFile({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entry required KalturaBaseEntry
      • type string (values: -1, conference.CONFERENCE_ENTRY_SERVER, externalMedia.externalMedia, 1, 2, 5, 6, 7, 8, 10)
      • uploadTokenId required string

Output

baseEntry.anonymousRank

Anonymously rank an entry, no validation is done on duplicate rankings.

kaltura.baseEntry.anonymousRank({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entryId required string
      • rank required integer

Output

Output schema unknown

baseEntry.approve

Approve the entry and mark the pending flags (if any) as moderated (this will make the entry playable).

kaltura.baseEntry.approve({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entryId required string

Output

Output schema unknown

baseEntry.clone

Clone an entry with optional attributes to apply to the clone

kaltura.baseEntry.clone({}, context)

Input

Output

baseEntry.count

Count base entries by filter.

kaltura.baseEntry.count({}, context)

Input

Output

  • output integer

baseEntry.delete

Delete an entry.

kaltura.baseEntry.delete({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entryId required string

Output

Output schema unknown

baseEntry.export

kaltura.baseEntry.export({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entryId required string
      • storageProfileId required integer

Output

baseEntry.flag

Flag inappropriate entry for moderation.

kaltura.baseEntry.flag({}, context)

Input

Output

Output schema unknown

baseEntry.get

Get base entry by ID.

kaltura.baseEntry.get({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entryId required string
      • version integer

Output

baseEntry.getByIds

Get an array of KalturaBaseEntry objects by a comma-separated list of ids.

kaltura.baseEntry.getByIds({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entryIds required string

Output

baseEntry.getContextData

This action delivers entry-related data, based on the user's context: access control, restriction, playback format and storage information.

kaltura.baseEntry.getContextData({}, context)

Input

Output

baseEntry.getPlaybackContext

This action delivers all data relevant for player

kaltura.baseEntry.getPlaybackContext({}, context)

Input

Output

baseEntry.getRemotePaths

Get remote storage existing paths for the asset.

kaltura.baseEntry.getRemotePaths({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entryId required string

Output

baseEntry.index

Index an entry by id.

kaltura.baseEntry.index({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required string
      • shouldUpdate boolean

Output

  • output integer

baseEntry.list

List base entries by filter with paging support.

kaltura.baseEntry.list({}, context)

Input

Output

baseEntry.listByReferenceId

List base entries by filter according to reference id

kaltura.baseEntry.listByReferenceId({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

baseEntry.listFlags

List all pending flags for the entry.

kaltura.baseEntry.listFlags({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

baseEntry.reject

Reject the entry and mark the pending flags (if any) as moderated (this will make the entry non-playable).

kaltura.baseEntry.reject({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entryId required string

Output

Output schema unknown

baseEntry.update

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

kaltura.baseEntry.update({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

baseEntry.updateContent

Update the content resource associated with the entry.

kaltura.baseEntry.updateContent({}, context)

Input

Output

baseEntry.updateThumbnailFromSourceEntry

Update entry thumbnail from a different entry by a specified time offset (in seconds).

kaltura.baseEntry.updateThumbnailFromSourceEntry({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entryId required string
      • sourceEntryId required string
      • timeOffset required integer

Output

baseEntry.updateThumbnailFromUrl

Update entry thumbnail using URL.

kaltura.baseEntry.updateThumbnailFromUrl({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • entryId required string
      • url required string

Output

baseEntry.updateThumbnailJpeg

Update entry thumbnail using a raw jpeg file.

kaltura.baseEntry.updateThumbnailJpeg({
  "entryId": "",
  "fileData": ""
}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • entryId required string: Media entry id
    • fileData required string, object: Jpeg file data
      • content string
      • encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
      • contentType string
      • filename string

Output

baseEntry.upload

Upload a file to Kaltura, that can be used to create an entry.

kaltura.baseEntry.upload({
  "fileData": ""
}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • fileData required string, object: The file data
      • content string
      • encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
      • contentType string
      • filename string

Output

  • output string

batch.addBulkUploadResult

batch addBulkUploadResultAction action adds KalturaBulkUploadResult to the DB

kaltura.batch.addBulkUploadResult({}, context)

Input

Output

batch.addMediaInfo

batch addMediaInfoAction action saves a media info object

kaltura.batch.addMediaInfo({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object

Output

batch.checkEntryIsDone

batch checkEntryIsDone Check weather a specified entry is done converting and changes it to ready.

kaltura.batch.checkEntryIsDone({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • batchJobId required string

Output

  • output boolean

batch.checkFileExists

batch checkFileExists action check if the file exists

kaltura.batch.checkFileExists({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • localPath required string
      • size required number

Output

batch.cleanExclusiveJobs

batch cleanExclusiveJobs action mark as fatal error all expired jobs

kaltura.batch.cleanExclusiveJobs({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object

Output

  • output integer

batch.countBulkUploadEntries

Returns total created entries count and total error entries count

kaltura.batch.countBulkUploadEntries({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • bulkUploadJobId required integer
      • bulkUploadObjectType string (values: scheduleBulkUpload.SCHEDULE_EVENT, scheduleBulkUpload.SCHEDULE_RESOURCE, 1, 2, 3, 4, 5)

Output

batch.freeExclusiveJob

batch freeExclusiveJobAction action allows to get a generic BatchJob

kaltura.batch.freeExclusiveJob({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required integer
      • jobType required string (values: caption.parsemultilanguagecaptionasset, captionSearch.parseCaptionAsset, contentDistribution.DistributionDelete, contentDistribution.DistributionDisable, contentDistribution.DistributionEnable, contentDistribution.DistributionFetchReport, contentDistribution.DistributionSubmit, contentDistribution.DistributionSync, contentDistribution.DistributionUpdate, dropFolder.DropFolderContentProcessor, dropFolder.DropFolderWatcher, 0, eventNotification.EventNotificationHandler, integration.Integration, reach.EntryVendorTasksCsv, reach.SyncReachCreditTask, scheduledTask.ScheduledTask, tagSearch.IndexTagsByPrivacyContext, tagSearch.TagResolve, virusScan.VirusScan, widevine.WidevineRepositorySync, 1, 2, 3, 4, 5, 6, 7, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48)
      • lockKey required KalturaExclusiveLockKey
      • resetExecutionAttempts boolean

Output

batch.getBulkUploadLastResult

batch getBulkUploadLastResultAction action returns the last result of the bulk upload

kaltura.batch.getBulkUploadLastResult({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • bulkUploadJobId required integer

Output

batch.getExclusiveAlmostDone

batch getExclusiveAlmostDone action allows to get a BatchJob that wait for remote closure

kaltura.batch.getExclusiveAlmostDone({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • filter KalturaBatchJobFilter
      • jobType string (values: caption.parsemultilanguagecaptionasset, captionSearch.parseCaptionAsset, contentDistribution.DistributionDelete, contentDistribution.DistributionDisable, contentDistribution.DistributionEnable, contentDistribution.DistributionFetchReport, contentDistribution.DistributionSubmit, contentDistribution.DistributionSync, contentDistribution.DistributionUpdate, dropFolder.DropFolderContentProcessor, dropFolder.DropFolderWatcher, 0, eventNotification.EventNotificationHandler, integration.Integration, reach.EntryVendorTasksCsv, reach.SyncReachCreditTask, scheduledTask.ScheduledTask, tagSearch.IndexTagsByPrivacyContext, tagSearch.TagResolve, virusScan.VirusScan, widevine.WidevineRepositorySync, 1, 2, 3, 4, 5, 6, 7, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48)
      • lockKey required KalturaExclusiveLockKey
      • maxExecutionTime required integer
      • numberOfJobs required integer

Output

batch.getExclusiveJobs

batch getExclusiveJobsAction action allows to get a BatchJob

kaltura.batch.getExclusiveJobs({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • filter KalturaBatchJobFilter
      • jobType string (values: caption.parsemultilanguagecaptionasset, captionSearch.parseCaptionAsset, contentDistribution.DistributionDelete, contentDistribution.DistributionDisable, contentDistribution.DistributionEnable, contentDistribution.DistributionFetchReport, contentDistribution.DistributionSubmit, contentDistribution.DistributionSync, contentDistribution.DistributionUpdate, dropFolder.DropFolderContentProcessor, dropFolder.DropFolderWatcher, 0, eventNotification.EventNotificationHandler, integration.Integration, reach.EntryVendorTasksCsv, reach.SyncReachCreditTask, scheduledTask.ScheduledTask, tagSearch.IndexTagsByPrivacyContext, tagSearch.TagResolve, virusScan.VirusScan, widevine.WidevineRepositorySync, 1, 2, 3, 4, 5, 6, 7, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48)
      • lockKey required KalturaExclusiveLockKey
      • maxExecutionTime required integer
      • maxJobToPullForCache integer
      • numberOfJobs required integer

Output

batch.getExclusiveNotificationJobs

batch getExclusiveNotificationJob action allows to get a BatchJob of type NOTIFICATION

kaltura.batch.getExclusiveNotificationJobs({}, context)

Input

Output

batch.getQueueSize

batch getQueueSize action get the queue size for job type

kaltura.batch.getQueueSize({}, context)

Input

Output

  • output integer

batch.logConversion

Add the data to the flavor asset conversion log, creates it if doesn't exists

kaltura.batch.logConversion({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • data required string
      • flavorAssetId required string

Output

Output schema unknown

batch.resetJobExecutionAttempts

batch resetJobExecutionAttempts action resets the execution attempts of the job

kaltura.batch.resetJobExecutionAttempts({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • id required integer
      • jobType required string (values: caption.parsemultilanguagecaptionasset, captionSearch.parseCaptionAsset, contentDistribution.DistributionDelete, contentDistribution.DistributionDisable, contentDistribution.DistributionEnable, contentDistribution.DistributionFetchReport, contentDistribution.DistributionSubmit, contentDistribution.DistributionSync, contentDistribution.DistributionUpdate, dropFolder.DropFolderContentProcessor, dropFolder.DropFolderWatcher, 0, eventNotification.EventNotificationHandler, integration.Integration, reach.EntryVendorTasksCsv, reach.SyncReachCreditTask, scheduledTask.ScheduledTask, tagSearch.IndexTagsByPrivacyContext, tagSearch.TagResolve, virusScan.VirusScan, widevine.WidevineRepositorySync, 1, 2, 3, 4, 5, 6, 7, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48)
      • lockKey required KalturaExclusiveLockKey

Output

Output schema unknown

batch.suspendJobs

batch suspendJobs action suspends jobs from running.

kaltura.batch.suspendJobs({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object

Output

Output schema unknown

batch.updateBulkUploadResults

batch updateBulkUploadResults action adds KalturaBulkUploadResult to the DB

kaltura.batch.updateBulkUploadResults({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • bulkUploadJobId required integer

Output

  • output integer

batch.updateExclusiveConvertCollectionJob

batch updateExclusiveConvertCollectionJobAction action updates a BatchJob of type CONVERT_PROFILE that was claimed using the getExclusiveConvertJobs

kaltura.batch.updateExclusiveConvertCollectionJob({}, context)

Input

Output

batch.updateExclusiveJob

batch updateExclusiveJobAction action updates a BatchJob of extended type that was claimed using the getExclusiveJobs

kaltura.batch.updateExclusiveJob({}, context)

Input

Output

batch.updatePartnerLoadTable

batch updatePartnerLoadTable action cleans the partner load table

kaltura.batch.updatePartnerLoadTable({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object

Output

Output schema unknown

batchcontrol.configLoaded

batch configLoaded action saves the configuration as loaded by a remote scheduler

kaltura.batchcontrol.configLoaded({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • configParam required string
      • configParamPart string
      • configValue required string
      • scheduler required KalturaScheduler
      • workerConfigId integer
      • workerName string

Output

batchcontrol.getCommand

batch getCommand action returns the command with its current status

kaltura.batchcontrol.getCommand({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • commandId required integer

Output

batchcontrol.getFullStatus

batch getFullStatus action returns the status of all schedulers and queues

kaltura.batchcontrol.getFullStatus({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object

Output

batchcontrol.kill

batch kill action forces stop of a batch on a remote scheduler

kaltura.batchcontrol.kill({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • adminId required integer
      • batchIndex required integer
      • cause required string
      • workerId required integer

Output

batchcontrol.listCommands

list batch control commands

kaltura.batchcontrol.listCommands({}, context)

Input

Output

batchcontrol.listSchedulers

list all Schedulers

kaltura.batchcontrol.listSchedulers({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object

Output

batchcontrol.listWorkers

list all Workers

kaltura.batchcontrol.listWorkers({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object

Output

batchcontrol.reportStatus

batch reportStatus action saves the status attribute from a remote scheduler and returns pending commands for the scheduler

kaltura.batchcontrol.reportStatus({}, context)

Input

Output

batchcontrol.setCommandResult

batch setCommandResult action saves the results of a command as received from a remote scheduler

kaltura.batchcontrol.setCommandResult({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • commandId required integer
      • errorDescription string
      • status required integer (values: 1, 2, 3, 4)

Output

batchcontrol.setSchedulerConfig

batch sets a configuration parameter to be loaded by a scheduler

kaltura.batchcontrol.setSchedulerConfig({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • adminId required integer
      • cause string
      • configParam required string
      • configParamPart string
      • configValue required string
      • schedulerId required integer

Output

batchcontrol.setWorkerConfig

batch sets a configuration parameter to be loaded by a worker

kaltura.batchcontrol.setWorkerConfig({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • adminId required integer
      • cause string
      • configParam required string
      • configParamPart string
      • configValue required string
      • workerId required integer

Output

batchcontrol.startWorker

batch start action starts a job

kaltura.batchcontrol.startWorker({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • adminId required integer
      • cause string
      • workerId required integer

Output

batchcontrol.stopScheduler

batch stop action stops a scheduler

kaltura.batchcontrol.stopScheduler({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • adminId required integer
      • cause required string
      • schedulerId required integer

Output

batchcontrol.stopWorker

batch stop action stops a worker

kaltura.batchcontrol.stopWorker({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1, 2, 3): The format of the response
    • clientTag string
    • partnerId integer
    • responseProfile object
    • body object
      • adminId required integer
      • cause required string
      • workerId required integer

Output

beacon.add

kaltura.beacon.add({}, context)

Input

  • input object
    • ks string
    • format integer (values: 1
datafire
@infinitebrahmanuniverse/nolb-_datafire_k@everything-registry/sub-chunk-222@zalastax/nolb-_datafire_k
6.0.0

5 years ago

5.0.0

6 years ago

4.0.0

7 years ago

3.0.0

7 years ago

2.0.3

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

0.0.3

9 years ago

0.0.1

9 years ago