kaltura-client 3.3.0 → 14.15.0

data/lib/kaltura_plugins/kaltura_annotation_client_plugin.rb

@@ -8,7 +8,7 @@
 # to do with audio, video, and animation what Wiki platfroms allow them to do with
 # text.
 #
-# Copyright (C) 2006-2015  Kaltura Inc.
+# Copyright (C) 2006-2019  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
@@ -51,25 +51,18 @@ module Kaltura
 		attr_accessor :parent_id
 		attr_accessor :text
 		# End time in milliseconds
-		# 	 
 		attr_accessor :end_time
 		# Duration in milliseconds
-		# 	 
 		attr_accessor :duration
 		# Depth in the tree
-		# 	 
 		attr_accessor :depth
 		# Number of all descendants
-		# 	 
 		attr_accessor :children_count
 		# Number of children, first generation only.
-		# 	 
 		attr_accessor :direct_children_count
 		# Is the annotation public.
-		# 	 
 		attr_accessor :is_public
 		# Should the cue point get indexed on the entry.
-		# 	 
 		attr_accessor :searchable_on_entry
 
 		def end_time=(val)
@@ -96,15 +89,33 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.parent_id = xml_element.elements['parentId'].text
-			self.text = xml_element.elements['text'].text
-			self.end_time = xml_element.elements['endTime'].text
-			self.duration = xml_element.elements['duration'].text
-			self.depth = xml_element.elements['depth'].text
-			self.children_count = xml_element.elements['childrenCount'].text
-			self.direct_children_count = xml_element.elements['directChildrenCount'].text
-			self.is_public = xml_element.elements['isPublic'].text
-			self.searchable_on_entry = xml_element.elements['searchableOnEntry'].text
+			if xml_element.elements['parentId'] != nil
+				self.parent_id = xml_element.elements['parentId'].text
+			end
+			if xml_element.elements['text'] != nil
+				self.text = xml_element.elements['text'].text
+			end
+			if xml_element.elements['endTime'] != nil
+				self.end_time = xml_element.elements['endTime'].text
+			end
+			if xml_element.elements['duration'] != nil
+				self.duration = xml_element.elements['duration'].text
+			end
+			if xml_element.elements['depth'] != nil
+				self.depth = xml_element.elements['depth'].text
+			end
+			if xml_element.elements['childrenCount'] != nil
+				self.children_count = xml_element.elements['childrenCount'].text
+			end
+			if xml_element.elements['directChildrenCount'] != nil
+				self.direct_children_count = xml_element.elements['directChildrenCount'].text
+			end
+			if xml_element.elements['isPublic'] != nil
+				self.is_public = xml_element.elements['isPublic'].text
+			end
+			if xml_element.elements['searchableOnEntry'] != nil
+				self.searchable_on_entry = xml_element.elements['searchableOnEntry'].text
+			end
 		end
 
 	end
@@ -115,7 +126,9 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaAnnotation')
+			if xml_element.elements['objects'] != nil
+				self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaAnnotation')
+			end
 		end
 
 	end
@@ -150,16 +163,36 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.parent_id_equal = xml_element.elements['parentIdEqual'].text
-			self.parent_id_in = xml_element.elements['parentIdIn'].text
-			self.text_like = xml_element.elements['textLike'].text
-			self.text_multi_like_or = xml_element.elements['textMultiLikeOr'].text
-			self.text_multi_like_and = xml_element.elements['textMultiLikeAnd'].text
-			self.end_time_greater_than_or_equal = xml_element.elements['endTimeGreaterThanOrEqual'].text
-			self.end_time_less_than_or_equal = xml_element.elements['endTimeLessThanOrEqual'].text
-			self.duration_greater_than_or_equal = xml_element.elements['durationGreaterThanOrEqual'].text
-			self.duration_less_than_or_equal = xml_element.elements['durationLessThanOrEqual'].text
-			self.is_public_equal = xml_element.elements['isPublicEqual'].text
+			if xml_element.elements['parentIdEqual'] != nil
+				self.parent_id_equal = xml_element.elements['parentIdEqual'].text
+			end
+			if xml_element.elements['parentIdIn'] != nil
+				self.parent_id_in = xml_element.elements['parentIdIn'].text
+			end
+			if xml_element.elements['textLike'] != nil
+				self.text_like = xml_element.elements['textLike'].text
+			end
+			if xml_element.elements['textMultiLikeOr'] != nil
+				self.text_multi_like_or = xml_element.elements['textMultiLikeOr'].text
+			end
+			if xml_element.elements['textMultiLikeAnd'] != nil
+				self.text_multi_like_and = xml_element.elements['textMultiLikeAnd'].text
+			end
+			if xml_element.elements['endTimeGreaterThanOrEqual'] != nil
+				self.end_time_greater_than_or_equal = xml_element.elements['endTimeGreaterThanOrEqual'].text
+			end
+			if xml_element.elements['endTimeLessThanOrEqual'] != nil
+				self.end_time_less_than_or_equal = xml_element.elements['endTimeLessThanOrEqual'].text
+			end
+			if xml_element.elements['durationGreaterThanOrEqual'] != nil
+				self.duration_greater_than_or_equal = xml_element.elements['durationGreaterThanOrEqual'].text
+			end
+			if xml_element.elements['durationLessThanOrEqual'] != nil
+				self.duration_less_than_or_equal = xml_element.elements['durationLessThanOrEqual'].text
+			end
+			if xml_element.elements['isPublicEqual'] != nil
+				self.is_public_equal = xml_element.elements['isPublicEqual'].text
+			end
 		end
 
 	end
@@ -175,14 +208,13 @@ module Kaltura
 
 
 	# Annotation service - Video Annotation
-	#  
 	class KalturaAnnotationService < KalturaServiceBase
 		def initialize(client)
 			super(client)
 		end
 
 		# Allows you to add an annotation object associated with an entry
-		# 	 
+		# @return [KalturaAnnotation]
 		def add(annotation)
 			kparams = {}
 			client.add_param(kparams, 'annotation', annotation)
@@ -193,39 +225,75 @@ module Kaltura
 			return client.do_queue()
 		end
 
-		# Update annotation by id
-		# 	 
-		def update(id, annotation)
+		# Allows you to add multiple cue points objects by uploading XML that contains multiple cue point definitions
+		# @return [KalturaCuePointListResponse]
+		def add_from_bulk(file_data)
+			kparams = {}
+			kfiles = {}
+			client.add_param(kfiles, 'fileData', file_data)
+			client.queue_service_action_call('annotation_annotation', 'addFromBulk', 'KalturaCuePointListResponse', kparams, kfiles)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# Clone cuePoint with id to given entry
+		# @return [KalturaCuePoint]
+		def clone(id, entry_id)
 			kparams = {}
 			client.add_param(kparams, 'id', id)
-			client.add_param(kparams, 'annotation', annotation)
-			client.queue_service_action_call('annotation_annotation', 'update', 'KalturaAnnotation', kparams)
+			client.add_param(kparams, 'entryId', entry_id)
+			client.queue_service_action_call('annotation_annotation', 'clone', 'KalturaCuePoint', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# List annotation objects by filter and pager
-		# 	
-		def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
+		# count cue point objects by filter
+		# @return [int]
+		def count(filter=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'filter', filter)
-			client.add_param(kparams, 'pager', pager)
-			client.queue_service_action_call('annotation_annotation', 'list', 'KalturaAnnotationListResponse', kparams)
+			client.queue_service_action_call('annotation_annotation', 'count', 'int', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# Allows you to add multiple cue points objects by uploading XML that contains multiple cue point definitions
-		# 	 
-		def add_from_bulk(file_data)
+		# delete cue point by id, and delete all children cue points
+		# @return []
+		def delete(id)
 			kparams = {}
-			kfiles = {}
-			client.add_param(kfiles, 'fileData', file_data)
-			client.queue_service_action_call('annotation_annotation', 'addFromBulk', 'KalturaCuePointListResponse', kparams, kfiles)
+			client.add_param(kparams, 'id', id)
+			client.queue_service_action_call('annotation_annotation', 'delete', '', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# Retrieve an CuePoint object by id
+		# @return [KalturaCuePoint]
+		def get(id)
+			kparams = {}
+			client.add_param(kparams, 'id', id)
+			client.queue_service_action_call('annotation_annotation', 'get', 'KalturaCuePoint', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# List annotation objects by filter and pager
+		# @return [KalturaAnnotationListResponse]
+		def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'filter', filter)
+			client.add_param(kparams, 'pager', pager)
+			client.queue_service_action_call('annotation_annotation', 'list', 'KalturaAnnotationListResponse', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
@@ -233,7 +301,7 @@ module Kaltura
 		end
 
 		# Download multiple cue points objects as XML definitions
-		# 	 
+		# @return [file]
 		def serve_bulk(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'filter', filter)
@@ -242,36 +310,39 @@ module Kaltura
 			return client.get_serve_url()
 		end
 
-		# Retrieve an CuePoint object by id
-		# 	 
-		def get(id)
+		# Update annotation by id
+		# @return [KalturaAnnotation]
+		def update(id, annotation)
 			kparams = {}
 			client.add_param(kparams, 'id', id)
-			client.queue_service_action_call('annotation_annotation', 'get', 'KalturaCuePoint', kparams)
+			client.add_param(kparams, 'annotation', annotation)
+			client.queue_service_action_call('annotation_annotation', 'update', 'KalturaAnnotation', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# count cue point objects by filter
-		# 	 
-		def count(filter=KalturaNotImplemented)
+		# @return [KalturaCuePoint]
+		def update_cue_points_times(id, start_time, end_time=KalturaNotImplemented)
 			kparams = {}
-			client.add_param(kparams, 'filter', filter)
-			client.queue_service_action_call('annotation_annotation', 'count', 'int', kparams)
+			client.add_param(kparams, 'id', id)
+			client.add_param(kparams, 'startTime', start_time)
+			client.add_param(kparams, 'endTime', end_time)
+			client.queue_service_action_call('annotation_annotation', 'updateCuePointsTimes', 'KalturaCuePoint', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# delete cue point by id, and delete all children cue points
-		# 	 
-		def delete(id)
+		# Update cuePoint status by id
+		# @return []
+		def update_status(id, status)
 			kparams = {}
 			client.add_param(kparams, 'id', id)
-			client.queue_service_action_call('annotation_annotation', 'delete', '', kparams)
+			client.add_param(kparams, 'status', status)
+			client.queue_service_action_call('annotation_annotation', 'updateStatus', '', kparams)
 			if (client.is_multirequest)
 				return nil
 			end

data/lib/kaltura_plugins/kaltura_aspera_client_plugin.rb

@@ -0,0 +1,62 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# This file is part of the Kaltura Collaborative Media Suite which allows users
+# to do with audio, video, and animation what Wiki platfroms allow them to do with
+# text.
+#
+# Copyright (C) 2006-2019  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
+# ===================================================================================================
+require 'kaltura_client.rb'
+
+module Kaltura
+
+
+	# Aspera service
+	class KalturaAsperaService < KalturaServiceBase
+		def initialize(client)
+			super(client)
+		end
+
+		# @return [string]
+		def get_fasp_url(flavor_asset_id)
+			kparams = {}
+			client.add_param(kparams, 'flavorAssetId', flavor_asset_id)
+			client.queue_service_action_call('aspera_aspera', 'getFaspUrl', 'string', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+	end
+
+	class KalturaClient < KalturaClientBase
+		attr_reader :aspera_service
+		def aspera_service
+			if (@aspera_service == nil)
+				@aspera_service = KalturaAsperaService.new(self)
+			end
+			return @aspera_service
+		end
+		
+	end
+
+end

data/lib/kaltura_plugins/kaltura_attachment_client_plugin.rb

@@ -8,7 +8,7 @@
 # to do with audio, video, and animation what Wiki platfroms allow them to do with
 # text.
 #
-# Copyright (C) 2006-2015  Kaltura Inc.
+# Copyright (C) 2006-2019  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
@@ -53,20 +53,17 @@ module Kaltura
 		TEXT = "1"
 		MEDIA = "2"
 		DOCUMENT = "3"
+		JSON = "4"
 	end
 
 	class KalturaAttachmentAsset < KalturaAsset
 		# The filename of the attachment asset content
-		# 	 
 		attr_accessor :filename
 		# Attachment asset title
-		# 	 
 		attr_accessor :title
 		# The attachment format
-		# 	 
 		attr_accessor :format
 		# The status of the asset
-		# 	 
 		attr_accessor :status
 
 		def status=(val)
@@ -75,10 +72,18 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.filename = xml_element.elements['filename'].text
-			self.title = xml_element.elements['title'].text
-			self.format = xml_element.elements['format'].text
-			self.status = xml_element.elements['status'].text
+			if xml_element.elements['filename'] != nil
+				self.filename = xml_element.elements['filename'].text
+			end
+			if xml_element.elements['title'] != nil
+				self.title = xml_element.elements['title'].text
+			end
+			if xml_element.elements['format'] != nil
+				self.format = xml_element.elements['format'].text
+			end
+			if xml_element.elements['status'] != nil
+				self.status = xml_element.elements['status'].text
+			end
 		end
 
 	end
@@ -89,7 +94,18 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaAttachmentAsset')
+			if xml_element.elements['objects'] != nil
+				self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaAttachmentAsset')
+			end
+		end
+
+	end
+
+	class KalturaAttachmentServeOptions < KalturaAssetServeOptions
+
+
+		def from_xml(xml_element)
+			super
 		end
 
 	end
@@ -107,11 +123,21 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.format_equal = xml_element.elements['formatEqual'].text
-			self.format_in = xml_element.elements['formatIn'].text
-			self.status_equal = xml_element.elements['statusEqual'].text
-			self.status_in = xml_element.elements['statusIn'].text
-			self.status_not_in = xml_element.elements['statusNotIn'].text
+			if xml_element.elements['formatEqual'] != nil
+				self.format_equal = xml_element.elements['formatEqual'].text
+			end
+			if xml_element.elements['formatIn'] != nil
+				self.format_in = xml_element.elements['formatIn'].text
+			end
+			if xml_element.elements['statusEqual'] != nil
+				self.status_equal = xml_element.elements['statusEqual'].text
+			end
+			if xml_element.elements['statusIn'] != nil
+				self.status_in = xml_element.elements['statusIn'].text
+			end
+			if xml_element.elements['statusNotIn'] != nil
+				self.status_not_in = xml_element.elements['statusNotIn'].text
+			end
 		end
 
 	end
@@ -127,14 +153,13 @@ module Kaltura
 
 
 	# Retrieve information and invoke actions on attachment Asset
-	#  
 	class KalturaAttachmentAssetService < KalturaServiceBase
 		def initialize(client)
 			super(client)
 		end
 
 		# Add attachment asset
-		#      
+		# @return [KalturaAttachmentAsset]
 		def add(entry_id, attachment_asset)
 			kparams = {}
 			client.add_param(kparams, 'entryId', entry_id)
@@ -146,26 +171,34 @@ module Kaltura
 			return client.do_queue()
 		end
 
-		# Update content of attachment asset
-		#      
-		def set_content(id, content_resource)
+		# @return []
+		def delete(attachment_asset_id)
 			kparams = {}
-			client.add_param(kparams, 'id', id)
-			client.add_param(kparams, 'contentResource', content_resource)
-			client.queue_service_action_call('attachment_attachmentasset', 'setContent', 'KalturaAttachmentAsset', kparams)
+			client.add_param(kparams, 'attachmentAssetId', attachment_asset_id)
+			client.queue_service_action_call('attachment_attachmentasset', 'delete', '', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# Update attachment asset
-		#      
-		def update(id, attachment_asset)
+		# @return [KalturaAttachmentAsset]
+		def get(attachment_asset_id)
+			kparams = {}
+			client.add_param(kparams, 'attachmentAssetId', attachment_asset_id)
+			client.queue_service_action_call('attachment_attachmentasset', 'get', 'KalturaAttachmentAsset', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# Get remote storage existing paths for the asset
+		# @return [KalturaRemotePathListResponse]
+		def get_remote_paths(id)
 			kparams = {}
 			client.add_param(kparams, 'id', id)
-			client.add_param(kparams, 'attachmentAsset', attachment_asset)
-			client.queue_service_action_call('attachment_attachmentasset', 'update', 'KalturaAttachmentAsset', kparams)
+			client.queue_service_action_call('attachment_attachmentasset', 'getRemotePaths', 'KalturaRemotePathListResponse', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
@@ -173,7 +206,7 @@ module Kaltura
 		end
 
 		# Get download URL for the asset
-		# 	 
+		# @return [string]
 		def get_url(id, storage_id=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'id', id)
@@ -185,12 +218,13 @@ module Kaltura
 			return client.do_queue()
 		end
 
-		# Get remote storage existing paths for the asset
-		# 	 
-		def get_remote_paths(id)
+		# List attachment Assets by filter and pager
+		# @return [KalturaAttachmentAssetListResponse]
+		def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
 			kparams = {}
-			client.add_param(kparams, 'id', id)
-			client.queue_service_action_call('attachment_attachmentasset', 'getRemotePaths', 'KalturaRemotePathListResponse', kparams)
+			client.add_param(kparams, 'filter', filter)
+			client.add_param(kparams, 'pager', pager)
+			client.queue_service_action_call('attachment_attachmentasset', 'list', 'KalturaAttachmentAssetListResponse', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
@@ -198,41 +232,35 @@ module Kaltura
 		end
 
 		# Serves attachment by its id
-		# 	 
-		def serve(attachment_asset_id)
+		# @return [file]
+		def serve(attachment_asset_id, serve_options=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'attachmentAssetId', attachment_asset_id)
+			client.add_param(kparams, 'serveOptions', serve_options)
 			client.queue_service_action_call('attachment_attachmentasset', 'serve', 'file', kparams)
 			return client.get_serve_url()
 		end
 
-		def get(attachment_asset_id)
-			kparams = {}
-			client.add_param(kparams, 'attachmentAssetId', attachment_asset_id)
-			client.queue_service_action_call('attachment_attachmentasset', 'get', 'KalturaAttachmentAsset', kparams)
-			if (client.is_multirequest)
-				return nil
-			end
-			return client.do_queue()
-		end
-
-		# List attachment Assets by filter and pager
-		# 	 
-		def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
+		# Update content of attachment asset
+		# @return [KalturaAttachmentAsset]
+		def set_content(id, content_resource)
 			kparams = {}
-			client.add_param(kparams, 'filter', filter)
-			client.add_param(kparams, 'pager', pager)
-			client.queue_service_action_call('attachment_attachmentasset', 'list', 'KalturaAttachmentAssetListResponse', kparams)
+			client.add_param(kparams, 'id', id)
+			client.add_param(kparams, 'contentResource', content_resource)
+			client.queue_service_action_call('attachment_attachmentasset', 'setContent', 'KalturaAttachmentAsset', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		def delete(attachment_asset_id)
+		# Update attachment asset
+		# @return [KalturaAttachmentAsset]
+		def update(id, attachment_asset)
 			kparams = {}
-			client.add_param(kparams, 'attachmentAssetId', attachment_asset_id)
-			client.queue_service_action_call('attachment_attachmentasset', 'delete', '', kparams)
+			client.add_param(kparams, 'id', id)
+			client.add_param(kparams, 'attachmentAsset', attachment_asset)
+			client.queue_service_action_call('attachment_attachmentasset', 'update', 'KalturaAttachmentAsset', kparams)
 			if (client.is_multirequest)
 				return nil
 			end