UNPKG

kaltura-client

Version:
2,973 lines (2,569 loc) 1.62 MB
// =================================================================================================== // _ __ _ _ // | |/ /__ _| | |_ _ _ _ _ __ _ // | ' </ _` | | _| || | '_/ _` | // |_|\_\__,_|_|\__|\_,_|_| \__,_| // // This file is part of the Kaltura Collaborative Media Suite which allows users // to do with audio, video, and animation what Wiki platforms allow them to do with // text. // // Copyright (C) 2006-2023 Kaltura Inc. // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as // published by the Free Software Foundation, either version 3 of the // License, or (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. // // @ignore // =================================================================================================== const kaltura = require('./KalturaClientBase'); /** * */ class ListResponse extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaListResponse'; } /** * * @return int */ getTotalCount() { return this.totalCount; } } module.exports.ListResponse = ListResponse; /** * */ class BaseRestriction extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaBaseRestriction'; } } module.exports.BaseRestriction = BaseRestriction; /** * */ class AccessControl extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAccessControl'; } /** * The id of the Access Control Profile * @return int */ getId() { return this.id; } /** * * @return int */ getPartnerId() { return this.partnerId; } /** * The name of the Access Control Profile * @return string */ getName() { return this.name; } /** * @param name string The name of the Access Control Profile */ setName(name) { this.name = name; } /** * System name of the Access Control Profile * @return string */ getSystemName() { return this.systemName; } /** * @param systemName string System name of the Access Control Profile */ setSystemName(systemName) { this.systemName = systemName; } /** * The description of the Access Control Profile * @return string */ getDescription() { return this.description; } /** * @param description string The description of the Access Control Profile */ setDescription(description) { this.description = description; } /** * Creation date as Unix timestamp (In seconds) * @return int */ getCreatedAt() { return this.createdAt; } /** * True if this Conversion Profile is the default * @return int */ getIsDefault() { return this.isDefault; } /** * @param isDefault int True if this Conversion Profile is the default */ setIsDefault(isDefault) { this.isDefault = isDefault; } /** * Array of Access Control Restrictions * @return array */ getRestrictions() { return this.restrictions; } /** * @param restrictions array Array of Access Control Restrictions */ setRestrictions(restrictions) { this.restrictions = restrictions; } /** * Indicates that the access control profile is new and should be handled using KalturaAccessControlProfile object and accessControlProfile service * @return bool */ getContainsUnsuportedRestrictions() { return this.containsUnsuportedRestrictions; } } module.exports.AccessControl = AccessControl; /** * */ class ContextTypeHolder extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaContextTypeHolder'; } /** * The type of the condition context * @return string */ getType() { return this.type; } /** * @param type string The type of the condition context */ setType(type) { this.type = type; } } module.exports.ContextTypeHolder = ContextTypeHolder; /** * */ class AccessControlContextTypeHolder extends ContextTypeHolder{ constructor(object = null) { super(object); this.objectType = 'KalturaAccessControlContextTypeHolder'; } } module.exports.AccessControlContextTypeHolder = AccessControlContextTypeHolder; /** * */ class AccessControlMessage extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAccessControlMessage'; } /** * * @return string */ getMessage() { return this.message; } /** * @param message string */ setMessage(message) { this.message = message; } /** * * @return string */ getCode() { return this.code; } /** * @param code string */ setCode(code) { this.code = code; } } module.exports.AccessControlMessage = AccessControlMessage; /** * */ class RuleAction extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaRuleAction'; } /** * The type of the action * @return string */ getType() { return this.type; } } module.exports.RuleAction = RuleAction; /** * */ class Condition extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaCondition'; } /** * The type of the access control condition * @return string */ getType() { return this.type; } /** * * @return string */ getDescription() { return this.description; } /** * @param description string */ setDescription(description) { this.description = description; } /** * * @return bool */ getNot() { return this.not; } /** * @param not bool */ setNot(not) { this.not = not; } } module.exports.Condition = Condition; /** * */ class Rule extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaRule'; } /** * Short Rule Description * @return string */ getDescription() { return this.description; } /** * @param description string Short Rule Description */ setDescription(description) { this.description = description; } /** * Rule Custom Data to allow saving rule specific information * @return string */ getRuleData() { return this.ruleData; } /** * @param ruleData string Rule Custom Data to allow saving rule specific information */ setRuleData(ruleData) { this.ruleData = ruleData; } /** * Message to be thrown to the player in case the rule is fulfilled * @return string */ getMessage() { return this.message; } /** * @param message string Message to be thrown to the player in case the rule is fulfilled */ setMessage(message) { this.message = message; } /** * Code to be thrown to the player in case the rule is fulfilled * @return string */ getCode() { return this.code; } /** * @param code string Code to be thrown to the player in case the rule is fulfilled */ setCode(code) { this.code = code; } /** * Actions to be performed by the player in case the rule is fulfilled * @return array */ getActions() { return this.actions; } /** * @param actions array Actions to be performed by the player in case the rule is fulfilled */ setActions(actions) { this.actions = actions; } /** * Conditions to validate the rule * @return array */ getConditions() { return this.conditions; } /** * @param conditions array Conditions to validate the rule */ setConditions(conditions) { this.conditions = conditions; } /** * Indicates what contexts should be tested by this rule * @return array */ getContexts() { return this.contexts; } /** * @param contexts array Indicates what contexts should be tested by this rule */ setContexts(contexts) { this.contexts = contexts; } /** * Indicates that this rule is enough and no need to continue checking the rest of the rules * @return bool */ getStopProcessing() { return this.stopProcessing; } /** * @param stopProcessing bool Indicates that this rule is enough and no need to continue checking the rest of the rules */ setStopProcessing(stopProcessing) { this.stopProcessing = stopProcessing; } /** * Indicates if we should force ks validation for admin ks users as well * @return int */ getForceAdminValidation() { return this.forceAdminValidation; } /** * @param forceAdminValidation int Indicates if we should force ks validation for admin ks users as well */ setForceAdminValidation(forceAdminValidation) { this.forceAdminValidation = forceAdminValidation; } } module.exports.Rule = Rule; /** * */ class AccessControlProfile extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAccessControlProfile'; } /** * The id of the Access Control Profile * @return int */ getId() { return this.id; } /** * * @return int */ getPartnerId() { return this.partnerId; } /** * The name of the Access Control Profile * @return string */ getName() { return this.name; } /** * @param name string The name of the Access Control Profile */ setName(name) { this.name = name; } /** * System name of the Access Control Profile * @return string */ getSystemName() { return this.systemName; } /** * @param systemName string System name of the Access Control Profile */ setSystemName(systemName) { this.systemName = systemName; } /** * The description of the Access Control Profile * @return string */ getDescription() { return this.description; } /** * @param description string The description of the Access Control Profile */ setDescription(description) { this.description = description; } /** * Creation time as Unix timestamp (In seconds) * @return int */ getCreatedAt() { return this.createdAt; } /** * Update time as Unix timestamp (In seconds) * @return int */ getUpdatedAt() { return this.updatedAt; } /** * True if this access control profile is the partner default * @return int */ getIsDefault() { return this.isDefault; } /** * @param isDefault int True if this access control profile is the partner default */ setIsDefault(isDefault) { this.isDefault = isDefault; } /** * Array of access control rules * @return array */ getRules() { return this.rules; } /** * @param rules array Array of access control rules */ setRules(rules) { this.rules = rules; } } module.exports.AccessControlProfile = AccessControlProfile; /** * */ class KeyValue extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaKeyValue'; } /** * * @return string */ getKey() { return this.key; } /** * @param key string */ setKey(key) { this.key = key; } /** * * @return string */ getValue() { return this.value; } /** * @param value string */ setValue(value) { this.value = value; } } module.exports.KeyValue = KeyValue; /** * */ class AccessControlScope extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAccessControlScope'; } /** * URL to be used to test domain conditions * @return string */ getReferrer() { return this.referrer; } /** * @param referrer string URL to be used to test domain conditions */ setReferrer(referrer) { this.referrer = referrer; } /** * IP to be used to test geographic location conditions * @return string */ getIp() { return this.ip; } /** * @param ip string IP to be used to test geographic location conditions */ setIp(ip) { this.ip = ip; } /** * Kaltura session to be used to test session and user conditions * @return string */ getKs() { return this.ks; } /** * @param ks string Kaltura session to be used to test session and user conditions */ setKs(ks) { this.ks = ks; } /** * Browser or client application to be used to test agent conditions * @return string */ getUserAgent() { return this.userAgent; } /** * @param userAgent string Browser or client application to be used to test agent conditions */ setUserAgent(userAgent) { this.userAgent = userAgent; } /** * Unix timestamp (In seconds) to be used to test entry scheduling, keep null to use now * @return int */ getTime() { return this.time; } /** * @param time int Unix timestamp (In seconds) to be used to test entry scheduling, keep null to use now */ setTime(time) { this.time = time; } /** * Indicates what contexts should be tested. No contexts means any context * @return array */ getContexts() { return this.contexts; } /** * @param contexts array Indicates what contexts should be tested. No contexts means any context */ setContexts(contexts) { this.contexts = contexts; } /** * Array of hashes to pass to the access control profile scope * @return array */ getHashes() { return this.hashes; } /** * @param hashes array Array of hashes to pass to the access control profile scope */ setHashes(hashes) { this.hashes = hashes; } } module.exports.AccessControlScope = AccessControlScope; /** * */ class ActiveLiveStreamTime extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaActiveLiveStreamTime'; } /** * The start time of the live stream (unix timestamp in seconds) * @return int */ getStartTime() { return this.startTime; } /** * @param startTime int The start time of the live stream (unix timestamp in seconds) */ setStartTime(startTime) { this.startTime = startTime; } /** * The end time of the live stream (unix timestamp in seconds) * @return int */ getEndTime() { return this.endTime; } /** * @param endTime int The end time of the live stream (unix timestamp in seconds) */ setEndTime(endTime) { this.endTime = endTime; } } module.exports.ActiveLiveStreamTime = ActiveLiveStreamTime; /** * */ class ReportFilter extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaReportFilter'; } /** * The dimension whose values should be filtered * @return string */ getDimension() { return this.dimension; } /** * @param dimension string The dimension whose values should be filtered */ setDimension(dimension) { this.dimension = dimension; } /** * The (comma separated) values to include in the filter * @return string */ getValues() { return this.values; } /** * @param values string The (comma separated) values to include in the filter */ setValues(values) { this.values = values; } } module.exports.ReportFilter = ReportFilter; /** * */ class AnalyticsFilter extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAnalyticsFilter'; } /** * Query start time (in local time) MM/dd/yyyy HH:mi * @return string */ getFrom_time() { return this.from_time; } /** * @param from_time string Query start time (in local time) MM/dd/yyyy HH:mi */ setFrom_time(from_time) { this.from_time = from_time; } /** * Query end time (in local time) MM/dd/yyyy HH:mi * @return string */ getTo_time() { return this.to_time; } /** * @param to_time string Query end time (in local time) MM/dd/yyyy HH:mi */ setTo_time(to_time) { this.to_time = to_time; } /** * Comma separated metrics list * @return string */ getMetrics() { return this.metrics; } /** * @param metrics string Comma separated metrics list */ setMetrics(metrics) { this.metrics = metrics; } /** * Timezone offset from UTC (in minutes) * @return float */ getUtcOffset() { return this.utcOffset; } /** * @param utcOffset float Timezone offset from UTC (in minutes) */ setUtcOffset(utcOffset) { this.utcOffset = utcOffset; } /** * Comma separated dimensions list * @return string */ getDimensions() { return this.dimensions; } /** * @param dimensions string Comma separated dimensions list */ setDimensions(dimensions) { this.dimensions = dimensions; } /** * Array of filters * @return array */ getFilters() { return this.filters; } /** * @param filters array Array of filters */ setFilters(filters) { this.filters = filters; } /** * Query order by metric/dimension * @return string */ getOrderBy() { return this.orderBy; } /** * @param orderBy string Query order by metric/dimension */ setOrderBy(orderBy) { this.orderBy = orderBy; } } module.exports.AnalyticsFilter = AnalyticsFilter; /** * */ class CuePoint extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaCuePoint'; } /** * * @return string */ getId() { return this.id; } /** * * @return int */ getIntId() { return this.intId; } /** * * @return string */ getCuePointType() { return this.cuePointType; } /** * * @return int */ getStatus() { return this.status; } /** * * @return string */ getEntryId() { return this.entryId; } /** * @param entryId string */ setEntryId(entryId) { this.entryId = entryId; } /** * * @return int */ getPartnerId() { return this.partnerId; } /** * * @return int */ getCreatedAt() { return this.createdAt; } /** * * @return int */ getUpdatedAt() { return this.updatedAt; } /** * * @return int */ getTriggeredAt() { return this.triggeredAt; } /** * @param triggeredAt int */ setTriggeredAt(triggeredAt) { this.triggeredAt = triggeredAt; } /** * * @return string */ getTags() { return this.tags; } /** * @param tags string */ setTags(tags) { this.tags = tags; } /** * Start time in milliseconds * @return int */ getStartTime() { return this.startTime; } /** * @param startTime int Start time in milliseconds */ setStartTime(startTime) { this.startTime = startTime; } /** * * @return string */ getUserId() { return this.userId; } /** * @param userId string */ setUserId(userId) { this.userId = userId; } /** * * @return string */ getPartnerData() { return this.partnerData; } /** * @param partnerData string */ setPartnerData(partnerData) { this.partnerData = partnerData; } /** * * @return int */ getPartnerSortValue() { return this.partnerSortValue; } /** * @param partnerSortValue int */ setPartnerSortValue(partnerSortValue) { this.partnerSortValue = partnerSortValue; } /** * * @return int */ getForceStop() { return this.forceStop; } /** * @param forceStop int */ setForceStop(forceStop) { this.forceStop = forceStop; } /** * * @return int */ getThumbOffset() { return this.thumbOffset; } /** * @param thumbOffset int */ setThumbOffset(thumbOffset) { this.thumbOffset = thumbOffset; } /** * * @return string */ getSystemName() { return this.systemName; } /** * @param systemName string */ setSystemName(systemName) { this.systemName = systemName; } /** * * @return bool */ getIsMomentary() { return this.isMomentary; } /** * * @return string */ getCopiedFrom() { return this.copiedFrom; } } module.exports.CuePoint = CuePoint; /** * */ class Annotation extends CuePoint{ constructor(object = null) { super(object); this.objectType = 'KalturaAnnotation'; } /** * * @return string */ getParentId() { return this.parentId; } /** * @param parentId string */ setParentId(parentId) { this.parentId = parentId; } /** * * @return string */ getText() { return this.text; } /** * @param text string */ setText(text) { this.text = text; } /** * End time in milliseconds * @return int */ getEndTime() { return this.endTime; } /** * @param endTime int End time in milliseconds */ setEndTime(endTime) { this.endTime = endTime; } /** * Duration in milliseconds * @return int */ getDuration() { return this.duration; } /** * Depth in the tree * @return int */ getDepth() { return this.depth; } /** * Number of all descendants * @return int */ getChildrenCount() { return this.childrenCount; } /** * Number of children, first generation only * @return int */ getDirectChildrenCount() { return this.directChildrenCount; } /** * Is the annotation public * @return int */ getIsPublic() { return this.isPublic; } /** * @param isPublic int Is the annotation public */ setIsPublic(isPublic) { this.isPublic = isPublic; } /** * Should the cue point get indexed on the entry * @return int */ getSearchableOnEntry() { return this.searchableOnEntry; } /** * @param searchableOnEntry int Should the cue point get indexed on the entry */ setSearchableOnEntry(searchableOnEntry) { this.searchableOnEntry = searchableOnEntry; } } module.exports.Annotation = Annotation; /** * */ class ApiExceptionArg extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaApiExceptionArg'; } /** * * @return string */ getName() { return this.name; } /** * @param name string */ setName(name) { this.name = name; } /** * * @return string */ getValue() { return this.value; } /** * @param value string */ setValue(value) { this.value = value; } } module.exports.ApiExceptionArg = ApiExceptionArg; /** * */ class AppRole extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAppRole'; } /** * * @return string */ getAppGuid() { return this.appGuid; } /** * @param appGuid string */ setAppGuid(appGuid) { this.appGuid = appGuid; } /** * * @return int */ getUserRoleId() { return this.userRoleId; } /** * @param userRoleId int */ setUserRoleId(userRoleId) { this.userRoleId = userRoleId; } /** * Entry creation date as Unix timestamp (In seconds) * @return int */ getCreatedAt() { return this.createdAt; } /** * Entry updated date as Unix timestamp (In seconds) * @return int */ getUpdatedAt() { return this.updatedAt; } } module.exports.AppRole = AppRole; /** * */ class AppToken extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAppToken'; } /** * The id of the application token * @return string */ getId() { return this.id; } /** * The application token * @return string */ getToken() { return this.token; } /** * * @return int */ getPartnerId() { return this.partnerId; } /** * Creation time as Unix timestamp (In seconds) * @return int */ getCreatedAt() { return this.createdAt; } /** * Update time as Unix timestamp (In seconds) * @return int */ getUpdatedAt() { return this.updatedAt; } /** * Application token status * @return int */ getStatus() { return this.status; } /** * Expiry time of current token (unix timestamp in seconds) * @return int */ getExpiry() { return this.expiry; } /** * @param expiry int Expiry time of current token (unix timestamp in seconds) */ setExpiry(expiry) { this.expiry = expiry; } /** * Type of KS (Kaltura Session) that created using the current token * @return int */ getSessionType() { return this.sessionType; } /** * @param sessionType int Type of KS (Kaltura Session) that created using the current token */ setSessionType(sessionType) { this.sessionType = sessionType; } /** * User id of KS (Kaltura Session) that created using the current token * @return string */ getSessionUserId() { return this.sessionUserId; } /** * @param sessionUserId string User id of KS (Kaltura Session) that created using the current token */ setSessionUserId(sessionUserId) { this.sessionUserId = sessionUserId; } /** * Expiry duration of KS (Kaltura Session) that created using the current token (in seconds) * @return int */ getSessionDuration() { return this.sessionDuration; } /** * @param sessionDuration int Expiry duration of KS (Kaltura Session) that created using the current token (in seconds) */ setSessionDuration(sessionDuration) { this.sessionDuration = sessionDuration; } /** * Comma separated privileges to be applied on KS (Kaltura Session) that created using the current token * @return string */ getSessionPrivileges() { return this.sessionPrivileges; } /** * @param sessionPrivileges string Comma separated privileges to be applied on KS (Kaltura Session) that created using the current token */ setSessionPrivileges(sessionPrivileges) { this.sessionPrivileges = sessionPrivileges; } /** * * @return string */ getHashType() { return this.hashType; } /** * @param hashType string */ setHashType(hashType) { this.hashType = hashType; } /** * * @return string */ getDescription() { return this.description; } /** * @param description string */ setDescription(description) { this.description = description; } } module.exports.AppToken = AppToken; /** * */ class Asset extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAsset'; } /** * The ID of the Flavor Asset * @return string */ getId() { return this.id; } /** * The entry ID of the Flavor Asset * @return string */ getEntryId() { return this.entryId; } /** * * @return int */ getPartnerId() { return this.partnerId; } /** * The version of the Flavor Asset * @return int */ getVersion() { return this.version; } /** * The size (in KBytes) of the Flavor Asset * @return int */ getSize() { return this.size; } /** * Tags used to identify the Flavor Asset in various scenarios * @return string */ getTags() { return this.tags; } /** * @param tags string Tags used to identify the Flavor Asset in various scenarios */ setTags(tags) { this.tags = tags; } /** * The file extension * @return string */ getFileExt() { return this.fileExt; } /** * @param fileExt string The file extension */ setFileExt(fileExt) { this.fileExt = fileExt; } /** * * @return int */ getCreatedAt() { return this.createdAt; } /** * * @return int */ getUpdatedAt() { return this.updatedAt; } /** * * @return int */ getDeletedAt() { return this.deletedAt; } /** * System description, error message, warnings and failure cause * @return string */ getDescription() { return this.description; } /** * Partner private data * @return string */ getPartnerData() { return this.partnerData; } /** * @param partnerData string Partner private data */ setPartnerData(partnerData) { this.partnerData = partnerData; } /** * Partner friendly description * @return string */ getPartnerDescription() { return this.partnerDescription; } /** * @param partnerDescription string Partner friendly description */ setPartnerDescription(partnerDescription) { this.partnerDescription = partnerDescription; } /** * Comma separated list of source flavor params ids * @return string */ getActualSourceAssetParamsIds() { return this.actualSourceAssetParamsIds; } /** * @param actualSourceAssetParamsIds string Comma separated list of source flavor params ids */ setActualSourceAssetParamsIds(actualSourceAssetParamsIds) { this.actualSourceAssetParamsIds = actualSourceAssetParamsIds; } /** * The size (in Bytes) of the asset * @return int */ getSizeInBytes() { return this.sizeInBytes; } } module.exports.Asset = Asset; /** * */ class AssetDistributionCondition extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAssetDistributionCondition'; } } module.exports.AssetDistributionCondition = AssetDistributionCondition; /** * */ class AssetDistributionRule extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAssetDistributionRule'; } /** * The validation error description that will be set on the "data" property on KalturaDistributionValidationErrorMissingAsset if rule was not fulfilled * @return string */ getValidationError() { return this.validationError; } /** * @param validationError string The validation error description that will be set on the "data" property on KalturaDistributionValidationErrorMissingAsset if rule was not fulfilled */ setValidationError(validationError) { this.validationError = validationError; } /** * An array of asset distribution conditions * @return array */ getAssetDistributionConditions() { return this.assetDistributionConditions; } /** * @param assetDistributionConditions array An array of asset distribution conditions */ setAssetDistributionConditions(assetDistributionConditions) { this.assetDistributionConditions = assetDistributionConditions; } } module.exports.AssetDistributionRule = AssetDistributionRule; /** * */ class String extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaString'; } /** * * @return string */ getValue() { return this.value; } /** * @param value string */ setValue(value) { this.value = value; } } module.exports.String = String; /** * */ class AssetParams extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAssetParams'; } /** * The id of the Flavor Params * @return int */ getId() { return this.id; } /** * * @return int */ getPartnerId() { return this.partnerId; } /** * @param partnerId int */ setPartnerId(partnerId) { this.partnerId = partnerId; } /** * The name of the Flavor Params * @return string */ getName() { return this.name; } /** * @param name string The name of the Flavor Params */ setName(name) { this.name = name; } /** * System name of the Flavor Params * @return string */ getSystemName() { return this.systemName; } /** * @param systemName string System name of the Flavor Params */ setSystemName(systemName) { this.systemName = systemName; } /** * The description of the Flavor Params * @return string */ getDescription() { return this.description; } /** * @param description string The description of the Flavor Params */ setDescription(description) { this.description = description; } /** * Creation date as Unix timestamp (In seconds) * @return int */ getCreatedAt() { return this.createdAt; } /** * True if those Flavor Params are part of system defaults * @return int */ getIsSystemDefault() { return this.isSystemDefault; } /** * The Flavor Params tags are used to identify the flavor for different usage (e.g. web, hd, mobile) * @return string */ getTags() { return this.tags; } /** * @param tags string The Flavor Params tags are used to identify the flavor for different usage (e.g. web, hd, mobile) */ setTags(tags) { this.tags = tags; } /** * Array of partner permisison names that required for using this asset params * @return array */ getRequiredPermissions() { return this.requiredPermissions; } /** * @param requiredPermissions array Array of partner permisison names that required for using this asset params */ setRequiredPermissions(requiredPermissions) { this.requiredPermissions = requiredPermissions; } /** * Id of remote storage profile that used to get the source, zero indicates Kaltura data center * @return int */ getSourceRemoteStorageProfileId() { return this.sourceRemoteStorageProfileId; } /** * @param sourceRemoteStorageProfileId int Id of remote storage profile that used to get the source, zero indicates Kaltura data center */ setSourceRemoteStorageProfileId(sourceRemoteStorageProfileId) { this.sourceRemoteStorageProfileId = sourceRemoteStorageProfileId; } /** * Comma seperated ids of remote storage profiles that the flavor distributed to, the distribution done by the conversion engine * @return int */ getRemoteStorageProfileIds() { return this.remoteStorageProfileIds; } /** * @param remoteStorageProfileIds int Comma seperated ids of remote storage profiles that the flavor distributed to, the distribution done by the conversion engine */ setRemoteStorageProfileIds(remoteStorageProfileIds) { this.remoteStorageProfileIds = remoteStorageProfileIds; } /** * Media parser type to be used for post-conversion validation * @return string */ getMediaParserType() { return this.mediaParserType; } /** * @param mediaParserType string Media parser type to be used for post-conversion validation */ setMediaParserType(mediaParserType) { this.mediaParserType = mediaParserType; } /** * Comma seperated ids of source flavor params this flavor is created from * @return string */ getSourceAssetParamsIds() { return this.sourceAssetParamsIds; } /** * @param sourceAssetParamsIds string Comma seperated ids of source flavor params this flavor is created from */ setSourceAssetParamsIds(sourceAssetParamsIds) { this.sourceAssetParamsIds = sourceAssetParamsIds; } } module.exports.AssetParams = AssetParams; /** * */ class Resource extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaResource'; } } module.exports.Resource = Resource; /** * */ class ContentResource extends Resource{ constructor(object = null) { super(object); this.objectType = 'KalturaContentResource'; } } module.exports.ContentResource = ContentResource; /** * */ class AssetParamsResourceContainer extends Resource{ constructor(object = null) { super(object); this.objectType = 'KalturaAssetParamsResourceContainer'; } /** * The content resource to associate with asset params * @return ContentResource */ getResource() { return this.resource; } /** * @param resource ContentResource The content resource to associate with asset params */ setResource(resource) { this.resource = resource; } /** * The asset params to associate with the reaource * @return int */ getAssetParamsId() { return this.assetParamsId; } /** * @param assetParamsId int The asset params to associate with the reaource */ setAssetParamsId(assetParamsId) { this.assetParamsId = assetParamsId; } } module.exports.AssetParamsResourceContainer = AssetParamsResourceContainer; /** * */ class AssetServeOptions extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAssetServeOptions'; } /** * * @return bool */ getDownload() { return this.download; } /** * @param download bool */ setDownload(download) { this.download = download; } /** * * @return string */ getReferrer() { return this.referrer; } /** * @param referrer string */ setReferrer(referrer) { this.referrer = referrer; } } module.exports.AssetServeOptions = AssetServeOptions; /** * */ class AttUverseDistributionFile extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAttUverseDistributionFile'; } /** * * @return string */ getRemoteFilename() { return this.remoteFilename; } /** * @param remoteFilename string */ setRemoteFilename(remoteFilename) { this.remoteFilename = remoteFilename; } /** * * @return string */ getLocalFilePath() { return this.localFilePath; } /** * @param localFilePath string */ setLocalFilePath(localFilePath) { this.localFilePath = localFilePath; } /** * * @return string */ getAssetType() { return this.assetType; } /** * @param assetType string */ setAssetType(assetType) { this.assetType = assetType; } /** * * @return string */ getAssetId() { return this.assetId; } /** * @param assetId string */ setAssetId(assetId) { this.assetId = assetId; } } module.exports.AttUverseDistributionFile = AttUverseDistributionFile; /** * */ class AttachmentAsset extends Asset{ constructor(object = null) { super(object); this.objectType = 'KalturaAttachmentAsset'; } /** * The filename of the attachment asset content * @return string */ getFilename() { return this.filename; } /** * @param filename string The filename of the attachment asset content */ setFilename(filename) { this.filename = filename; } /** * Attachment asset title * @return string */ getTitle() { return this.title; } /** * @param title string Attachment asset title */ setTitle(title) { this.title = title; } /** * The attachment format * @return string */ getFormat() { return this.format; } /** * @param format string The attachment format */ setFormat(format) { this.format = format; } /** * The status of the asset * @return int */ getStatus() { return this.status; } } module.exports.AttachmentAsset = AttachmentAsset; /** * */ class AuditTrailInfo extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAuditTrailInfo'; } } module.exports.AuditTrailInfo = AuditTrailInfo; /** * */ class AuditTrail extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAuditTrail'; } /** * * @return int */ getId() { return this.id; } /** * * @return int */ getCreatedAt() { return this.createdAt; } /** * Indicates when the data was parsed * @return int */ getParsedAt() { return this.parsedAt; } /** * * @return int */ getStatus() { return this.status; } /** * * @return string */ getAuditObjectType() { return this.auditObjectType; } /** * @param auditObjectType string */ setAuditObjectType(auditObjectType) { this.auditObjectType = auditObjectType; } /** * * @return string */ getObjectId() { return this.objectId; } /** * @param objectId string */ setObjectId(objectId) { this.objectId = objectId; } /** * * @return string */ getRelatedObjectId() { return this.relatedObjectId; } /** * @param relatedObjectId string */ setRelatedObjectId(relatedObjectId) { this.relatedObjectId = relatedObjectId; } /** * * @return string */ getRelatedObjectType() { return this.relatedObjectType; } /** * @param relatedObjectType string */ setRelatedObjectType(relatedObjectType) { this.relatedObjectType = relatedObjectType; } /** * * @return string */ getEntryId() { return this.entryId; } /** * @param entryId string */ setEntryId(entryId) { this.entryId = entryId; } /** * * @return int */ getMasterPartnerId() { return this.masterPartnerId; } /** * * @return int */ getPartnerId() { return this.partnerId; } /** * * @return string */ getRequestId() { return this.requestId; } /** * * @return string */ getUserId() { return this.userId; } /** * @param userId string */ setUserId(userId) { this.userId = userId; } /** * * @return string */ getAction() { return this.action; } /** * @param action string */ setAction(action) { this.action = action; } /** * * @return AuditTrailInfo */ getData() { return this.data; } /** * @param data AuditTrailInfo */ setData(data) { this.data = data; } /** * * @return string */ getKs() { return this.ks; } /** * * @return int */ getContext() { return this.context; } /** * The API service and action that called and caused this audit * @return string */ getEntryPoint() { return this.entryPoint; } /** * * @return string */ getServerName() { return this.serverName; } /** * * @return string */ getIpAddress() { return this.ipAddress; } /** * * @return string */ getUserAgent() { return this.userAgent; } /** * * @return string */ getClientTag() { return this.clientTag; } /** * @param clientTag string */ setClientTag(clientTag) { this.clientTag = clientTag; } /** * * @return string */ getDescription() { return this.description; } /** * @param description string */ setDescription(description) { this.description = description; } /** * * @return string */ getErrorDescription() { return this.errorDescription; } } module.exports.AuditTrail = AuditTrail; /** * */ class AuditTrailChangeItem extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAuditTrailChangeItem'; } /** * * @return string */ getDescriptor() { return this.descriptor; } /** * @param descriptor string */ setDescriptor(descriptor) { this.descriptor = descriptor; } /** * * @return string */ getOldValue() { return this.oldValue; } /** * @param oldValue string */ setOldValue(oldValue) { this.oldValue = oldValue; } /** * * @return string */ getNewValue() { return this.newValue; } /** * @param newValue string */ setNewValue(newValue) { this.newValue = newValue; } } module.exports.AuditTrailChangeItem = AuditTrailChangeItem; /** * */ class Authentication extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaAuthentication'; } /** * * @return string */ getQrCode() { return this.qrCode; } /** * @param qrCode string */ setQrCode(qrCode) { this.qrCode = qrCode; } } module.exports.Authentication = Authentication; /** * */ class MultiLingualString extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaMultiLingualString'; } /** * The language of the value * @return string */ getLanguage() { return this.language; } /** * @param language string The language of the value */ setLanguage(language) { this.language = language; } /** * Value * @return string */ getValue() { return this.value; } /** * @param value string Value */ setValue(value) { this.value = value; } } module.exports.MultiLingualString = MultiLingualString; /** * */ class OperationAttributes extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaOperationAttributes'; } } module.exports.OperationAttributes = OperationAttributes; /** * */ class BaseEntry extends kaltura.BaseObject{ constructor(object = null) { super(object); this.objectType = 'KalturaBaseEntry'; } /** * Auto generated 10 characters alphanumeric string * @return string */ getId() { return this.id; } /** * Entry name (Min 1 chars) * @return string */ getName() { return this.name; } /** * @param name string Entry name (Min 1 chars) */ setName(name) { this.name = name; } /** * Entry name (Min 1 chars) * @return array */ getMultiLingual_name() { return this.multiLingual_name; } /** * @param multiLingual_name array Entry name (Min 1 chars) */ setMultiLingual_name(multiLingual_name) { this.multiLingual_name = multiLingual_name; } /** * Entry description * @return string */ getDescription() { return this.description; } /** * @param description string Entry description */ setDescription(description) { this.description = description; } /** * Entry description * @return array */ getMultiLingual_description() { return this.multiLingual_description; } /** * @param multiLingual_description array Entry description */ setMultiLingual_description(multiLingual_description) { this.multiLingual_description = multiLingual_description; } /** * * @return int */ getPartnerId() { return this.partnerId; } /** * The ID of the user who is the owner of this entry * @return string */ getUserId() { return this.userId; } /** * @param userId string The ID of the user who is the owner of this entry */ setUserId(userId) { this.userId = userId; } /** * The ID of the user who created this entry * @return string */ getCreatorId() { return this.creatorId; } /** * @param creatorId string The ID of the user who created this entry */ setCreatorId(creatorId) { this.creatorId = creatorId; } /** * Entry tags * @return string */ getTags() { return this.tags; } /** * @param tags string Entry tags */ setTags(tags) { this.tags = tags; } /** * Entry tags * @return array */ getMultiLingual_tags() { return this.multiLingual_tags; } /** * @param multiLingual_tags array Entry tags */ setMultiLingual_tags(multiLingual_tags) { this.multiLingual_tags = multiLingual_tags; } /** * Entry admin tags can be updated only by administrators * @return string */ getAdminTags() { return this.adminTags; } /** * @param adminTags string Entry admin tags can be updated only by administrators */ setAdminTags(adminTags) { this.adminTags = adminTags; } /** * Comma separated list of full names of categories to which this entry belongs. Only categories that don't have entitlement (privacy context) are listed, to retrieve the full list of categories, use the categoryEntry.list action * @return string */ getCategories() { return this.categories; } /** * @param categories string Comma separated list of full names of categories to which this entry belongs. Only categories that don't have entitlement (privacy context) are listed, to retrieve the full list of categories, use the categoryEntry.list action */ setCategories(categories) { this.categories = categories; } /** * Comma separated list of ids of categories to which this entry belongs. Only categories that don't have entitlement (privacy context) are listed, to retrieve the full list of categories, use the categoryEntry.list action * @return string */ getCategoriesIds() { return this.categoriesIds; } /** * @param categoriesIds string Comma separated list of ids of categories to which this entry belongs. Only categories that don't have entitlement (privacy context) are listed, to retrieve the full list of categories, use the categoryEntry.list action */ setCategoriesIds(categoriesIds) { this.categoriesIds = categoriesIds; } /** * * @return string */ getStatus() { return this.status; } /** * Entry moderation status * @return int */ getModerationStatus() { return this.moderationStatus; } /** * Number of moderation requests waiting for this entry * @return int */ getModerationCount() { return this.moderationCount; } /** * The type of the entry, this is auto filled by the derived entry object * @return string */ getType() { return this.type; } /** * @param type string The type of the entry, this is auto filled by the derived entry object */ setType(type) { this.type = type; } /** * Entry creation date as Unix timestamp (In seconds) * @return int */ getCreatedAt() { return this.createdAt; } /** * Entry update date as Unix timestamp (In seconds) * @return int */ getUpdatedAt() { return this.updatedAt; } /** * The calculated average rank. rank = totalRank / votes * @return float */ getRank() { return this.rank; } /** * The sum of all rank values submitted to the baseEntry.anonymousRank action * @return int */ getTotalRank() { return this.totalRank; } /** * A count of all requests made to the baseEntry.anonymousRank action * @return int */ getVotes() { return this.votes; } /** * * @return int */ getGroupId() { return this.groupId; } /** * @param groupId int */ setGroupId(groupId) { this.groupId = groupId; } /** * Can be used to store various partner related data as a string * @return string */ getPartnerData() { return this.partnerData; } /** * @param partnerData string Can be used to store various partner related data as a st