kaltura-ruby-client 1.0

data/lib/kaltura_plugins/kaltura_ad_cue_point_client_plugin.rb

@@ -0,0 +1,108 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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-2011  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'
+require File.dirname(__FILE__) + '/kaltura_cue_point_client_plugin.rb'
+
+module Kaltura
+
+	class KalturaAdCuePointOrderBy
+		CREATED_AT_ASC = "+createdAt"
+		DURATION_ASC = "+duration"
+		END_TIME_ASC = "+endTime"
+		PARTNER_SORT_VALUE_ASC = "+partnerSortValue"
+		START_TIME_ASC = "+startTime"
+		UPDATED_AT_ASC = "+updatedAt"
+		CREATED_AT_DESC = "-createdAt"
+		DURATION_DESC = "-duration"
+		END_TIME_DESC = "-endTime"
+		PARTNER_SORT_VALUE_DESC = "-partnerSortValue"
+		START_TIME_DESC = "-startTime"
+		UPDATED_AT_DESC = "-updatedAt"
+	end
+
+	class KalturaAdProtocolType
+		CUSTOM = "0"
+		VAST = "1"
+		VAST_2_0 = "2"
+		VPAID = "3"
+	end
+
+	class KalturaAdType
+		VIDEO = "1"
+		OVERLAY = "2"
+	end
+
+	class KalturaAdCuePoint < KalturaCuePoint
+		attr_accessor :protocol_type
+		attr_accessor :source_url
+		attr_accessor :ad_type
+		attr_accessor :title
+		attr_accessor :end_time
+		# Duration in milliseconds
+		# 	 
+		attr_accessor :duration
+
+		def end_time=(val)
+			@end_time = val.to_i
+		end
+		def duration=(val)
+			@duration = val.to_i
+		end
+	end
+
+	class KalturaAdCuePointBaseFilter < KalturaCuePointFilter
+		attr_accessor :protocol_type_equal
+		attr_accessor :protocol_type_in
+		attr_accessor :title_like
+		attr_accessor :title_multi_like_or
+		attr_accessor :title_multi_like_and
+		attr_accessor :end_time_greater_than_or_equal
+		attr_accessor :end_time_less_than_or_equal
+		attr_accessor :duration_greater_than_or_equal
+		attr_accessor :duration_less_than_or_equal
+
+		def end_time_greater_than_or_equal=(val)
+			@end_time_greater_than_or_equal = val.to_i
+		end
+		def end_time_less_than_or_equal=(val)
+			@end_time_less_than_or_equal = val.to_i
+		end
+		def duration_greater_than_or_equal=(val)
+			@duration_greater_than_or_equal = val.to_i
+		end
+		def duration_less_than_or_equal=(val)
+			@duration_less_than_or_equal = val.to_i
+		end
+	end
+
+	class KalturaAdCuePointFilter < KalturaAdCuePointBaseFilter
+
+	end
+
+
+end

data/lib/kaltura_plugins/kaltura_annotation_client_plugin.rb

@@ -0,0 +1,237 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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-2011  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'
+require File.dirname(__FILE__) + '/kaltura_cue_point_client_plugin.rb'
+
+module Kaltura
+
+	class KalturaAnnotationOrderBy
+		CREATED_AT_ASC = "+createdAt"
+		DURATION_ASC = "+duration"
+		END_TIME_ASC = "+endTime"
+		PARTNER_SORT_VALUE_ASC = "+partnerSortValue"
+		START_TIME_ASC = "+startTime"
+		UPDATED_AT_ASC = "+updatedAt"
+		CREATED_AT_DESC = "-createdAt"
+		DURATION_DESC = "-duration"
+		END_TIME_DESC = "-endTime"
+		PARTNER_SORT_VALUE_DESC = "-partnerSortValue"
+		START_TIME_DESC = "-startTime"
+		UPDATED_AT_DESC = "-updatedAt"
+	end
+
+	class KalturaAnnotation < KalturaCuePoint
+		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
+
+		def end_time=(val)
+			@end_time = val.to_i
+		end
+		def duration=(val)
+			@duration = val.to_i
+		end
+		def depth=(val)
+			@depth = val.to_i
+		end
+		def children_count=(val)
+			@children_count = val.to_i
+		end
+		def direct_children_count=(val)
+			@direct_children_count = val.to_i
+		end
+	end
+
+	class KalturaAnnotationListResponse < KalturaObjectBase
+		attr_accessor :objects
+		attr_accessor :total_count
+
+		def total_count=(val)
+			@total_count = val.to_i
+		end
+	end
+
+	class KalturaAnnotationBaseFilter < KalturaCuePointFilter
+		attr_accessor :parent_id_equal
+		attr_accessor :parent_id_in
+		attr_accessor :text_like
+		attr_accessor :text_multi_like_or
+		attr_accessor :text_multi_like_and
+		attr_accessor :end_time_greater_than_or_equal
+		attr_accessor :end_time_less_than_or_equal
+		attr_accessor :duration_greater_than_or_equal
+		attr_accessor :duration_less_than_or_equal
+
+		def end_time_greater_than_or_equal=(val)
+			@end_time_greater_than_or_equal = val.to_i
+		end
+		def end_time_less_than_or_equal=(val)
+			@end_time_less_than_or_equal = val.to_i
+		end
+		def duration_greater_than_or_equal=(val)
+			@duration_greater_than_or_equal = val.to_i
+		end
+		def duration_less_than_or_equal=(val)
+			@duration_less_than_or_equal = val.to_i
+		end
+	end
+
+	class KalturaAnnotationFilter < KalturaAnnotationBaseFilter
+
+	end
+
+
+	# Annotation service - Video Annotation
+	#  
+	class KalturaAnnotationService < KalturaServiceBase
+		def initialize(client)
+			super(client)
+		end
+
+		# Allows you to add an annotation object associated with an entry
+		# 	 
+		def add(annotation)
+			kparams = {}
+			client.add_param(kparams, 'annotation', annotation);
+			client.queue_service_action_call('annotation_annotation', 'add', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Update annotation by id
+		# 	 
+		def update(id, annotation)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.add_param(kparams, 'annotation', annotation);
+			client.queue_service_action_call('annotation_annotation', 'update', 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)
+			kparams = {}
+			client.add_param(kparams, 'filter', filter);
+			client.add_param(kparams, 'pager', pager);
+			client.queue_service_action_call('annotation_annotation', 'list', 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)
+			kparams = {}
+			client.add_param(kparams, 'fileData', file_data);
+			client.queue_service_action_call('annotation_annotation', 'addFromBulk', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Download multiple cue points objects as XML definitions
+		# 	 
+		def serve_bulk(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'filter', filter);
+			client.add_param(kparams, 'pager', pager);
+			client.queue_service_action_call('annotation_annotation', 'serveBulk', kparams);
+			return client.get_serve_url();
+		end
+
+		# Retrieve an CuePoint object by id
+		# 	 
+		def get(id)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.queue_service_action_call('annotation_annotation', 'get', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# count cue point objects by filter
+		# 	 
+		def count(filter=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'filter', filter);
+			client.queue_service_action_call('annotation_annotation', 'count', 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)
+			kparams = {}
+			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
+	end
+
+	class KalturaClient < KalturaClientBase
+		attr_reader :annotation_service
+		def annotation_service
+			if (@annotation_service == nil)
+				@annotation_service = KalturaAnnotationService.new(self)
+			end
+			return @annotation_service
+		end
+	end
+
+end

data/lib/kaltura_plugins/kaltura_aspera_client_plugin.rb

@@ -0,0 +1,61 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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-2011  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
+
+		def get_fasp_url(flavor_asset_id)
+			kparams = {}
+			client.add_param(kparams, 'flavorAssetId', flavor_asset_id);
+			client.queue_service_action_call('aspera_aspera', 'getFaspUrl', 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

@@ -0,0 +1,227 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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-2011  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
+
+	class KalturaAttachmentAssetStatus
+		ERROR = -1
+		QUEUED = 0
+		READY = 2
+		DELETED = 3
+		IMPORTING = 7
+		EXPORTING = 9
+	end
+
+	class KalturaAttachmentAssetOrderBy
+		CREATED_AT_ASC = "+createdAt"
+		DELETED_AT_ASC = "+deletedAt"
+		SIZE_ASC = "+size"
+		UPDATED_AT_ASC = "+updatedAt"
+		CREATED_AT_DESC = "-createdAt"
+		DELETED_AT_DESC = "-deletedAt"
+		SIZE_DESC = "-size"
+		UPDATED_AT_DESC = "-updatedAt"
+	end
+
+	class KalturaAttachmentType
+		TEXT = "1"
+		MEDIA = "2"
+		DOCUMENT = "3"
+	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)
+			@status = val.to_i
+		end
+	end
+
+	class KalturaAttachmentAssetListResponse < KalturaObjectBase
+		attr_accessor :objects
+		attr_accessor :total_count
+
+		def total_count=(val)
+			@total_count = val.to_i
+		end
+	end
+
+	class KalturaAttachmentAssetBaseFilter < KalturaAssetFilter
+		attr_accessor :format_equal
+		attr_accessor :format_in
+		attr_accessor :status_equal
+		attr_accessor :status_in
+		attr_accessor :status_not_in
+
+		def status_equal=(val)
+			@status_equal = val.to_i
+		end
+	end
+
+	class KalturaAttachmentAssetFilter < KalturaAttachmentAssetBaseFilter
+
+	end
+
+
+	# Retrieve information and invoke actions on attachment Asset
+	#  
+	class KalturaAttachmentAssetService < KalturaServiceBase
+		def initialize(client)
+			super(client)
+		end
+
+		# Add attachment asset
+		#      
+		def add(entry_id, attachment_asset)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id);
+			client.add_param(kparams, 'attachmentAsset', attachment_asset);
+			client.queue_service_action_call('attachment_attachmentasset', 'add', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Update content of attachment asset
+		#      
+		def set_content(id, content_resource)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.add_param(kparams, 'contentResource', content_resource);
+			client.queue_service_action_call('attachment_attachmentasset', 'setContent', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Update attachment asset
+		#      
+		def update(id, attachment_asset)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.add_param(kparams, 'attachmentAsset', attachment_asset);
+			client.queue_service_action_call('attachment_attachmentasset', 'update', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Get download URL for the asset
+		# 	 
+		def get_url(id, storage_id=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.add_param(kparams, 'storageId', storage_id);
+			client.queue_service_action_call('attachment_attachmentasset', 'getUrl', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Get remote storage existing paths for the asset
+		# 	 
+		def get_remote_paths(id)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.queue_service_action_call('attachment_attachmentasset', 'getRemotePaths', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Serves attachment by its id
+		# 	 
+		def serve(attachment_asset_id)
+			kparams = {}
+			client.add_param(kparams, 'attachmentAssetId', attachment_asset_id);
+			client.queue_service_action_call('attachment_attachmentasset', 'serve', 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', 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)
+			kparams = {}
+			client.add_param(kparams, 'filter', filter);
+			client.add_param(kparams, 'pager', pager);
+			client.queue_service_action_call('attachment_attachmentasset', 'list', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		def delete(attachment_asset_id)
+			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
+	end
+
+	class KalturaClient < KalturaClientBase
+		attr_reader :attachment_asset_service
+		def attachment_asset_service
+			if (@attachment_asset_service == nil)
+				@attachment_asset_service = KalturaAttachmentAssetService.new(self)
+			end
+			return @attachment_asset_service
+		end
+	end
+
+end