kaltura-ruby-client 1.0

data/lib/kaltura_plugins/kaltura_bulk_upload_csv_client_plugin.rb

@@ -0,0 +1,55 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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_bulk_upload_client_plugin.rb'
+
+module Kaltura
+
+	class KalturaBulkUploadCsvVersion
+		V1 = 1
+		V2 = 2
+		V3 = 3
+	end
+
+	# Represents the Bulk upload job data for xml bulk upload
+	#  
+	class KalturaBulkUploadCsvJobData < KalturaBulkUploadJobData
+		# The version of the csv file
+		# 	 
+		attr_accessor :csv_version
+		# Array containing CSV headers
+		# 	 
+		attr_accessor :columns
+
+		def csv_version=(val)
+			@csv_version = val.to_i
+		end
+	end
+
+
+end

data/lib/kaltura_plugins/kaltura_bulk_upload_filter_client_plugin.rb

@@ -0,0 +1,46 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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_bulk_upload_client_plugin.rb'
+
+module Kaltura
+
+	# Represents the Bulk upload job data for filter bulk upload
+	#  
+	class KalturaBulkUploadFilterJobData < KalturaBulkUploadJobData
+		# Filter for extracting the objects list to upload 
+		# 	 
+		attr_accessor :filter
+		# Template object for new object creation
+		# 	 
+		attr_accessor :template_object
+
+	end
+
+
+end

data/lib/kaltura_plugins/kaltura_bulk_upload_xml_client_plugin.rb

@@ -0,0 +1,40 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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_bulk_upload_client_plugin.rb'
+
+module Kaltura
+
+	# Represents the Bulk upload job data for xml bulk upload
+	#  
+	class KalturaBulkUploadXmlJobData < KalturaBulkUploadJobData
+
+	end
+
+
+end

data/lib/kaltura_plugins/kaltura_caption_client_plugin.rb

@@ -0,0 +1,406 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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 KalturaCaptionAssetStatus
+		ERROR = -1
+		QUEUED = 0
+		READY = 2
+		DELETED = 3
+		IMPORTING = 7
+		EXPORTING = 9
+	end
+
+	class KalturaCaptionAssetOrderBy
+		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 KalturaCaptionParamsOrderBy
+	end
+
+	class KalturaCaptionType
+		SRT = "1"
+		DFXP = "2"
+		WEBVTT = "3"
+	end
+
+	class KalturaCaptionAsset < KalturaAsset
+		# The Caption Params used to create this Caption Asset
+		# 	 
+		attr_accessor :caption_params_id
+		# The language of the caption asset content
+		# 	 
+		attr_accessor :language
+		# The language of the caption asset content
+		# 	 
+		attr_accessor :language_code
+		# Is default caption asset of the entry
+		# 	 
+		attr_accessor :is_default
+		# Friendly label
+		# 	 
+		attr_accessor :label
+		# The caption format
+		# 	 
+		attr_accessor :format
+		# The status of the asset
+		# 	 
+		attr_accessor :status
+
+		def caption_params_id=(val)
+			@caption_params_id = val.to_i
+		end
+		def is_default=(val)
+			@is_default = val.to_i
+		end
+		def status=(val)
+			@status = val.to_i
+		end
+	end
+
+	class KalturaCaptionAssetListResponse < KalturaObjectBase
+		attr_accessor :objects
+		attr_accessor :total_count
+
+		def total_count=(val)
+			@total_count = val.to_i
+		end
+	end
+
+	class KalturaCaptionParams < KalturaAssetParams
+		# The language of the caption content
+		# 	 
+		attr_accessor :language
+		# Is default caption asset of the entry
+		# 	 
+		attr_accessor :is_default
+		# Friendly label
+		# 	 
+		attr_accessor :label
+		# The caption format
+		# 	 
+		attr_accessor :format
+		# Id of the caption params or the flavor params to be used as source for the caption creation
+		# 	 
+		attr_accessor :source_params_id
+
+		def is_default=(val)
+			@is_default = val.to_i
+		end
+		def source_params_id=(val)
+			@source_params_id = val.to_i
+		end
+	end
+
+	class KalturaCaptionParamsListResponse < KalturaObjectBase
+		attr_accessor :objects
+		attr_accessor :total_count
+
+		def total_count=(val)
+			@total_count = val.to_i
+		end
+	end
+
+	class KalturaCaptionAssetBaseFilter < KalturaAssetFilter
+		attr_accessor :caption_params_id_equal
+		attr_accessor :caption_params_id_in
+		attr_accessor :format_equal
+		attr_accessor :format_in
+		attr_accessor :status_equal
+		attr_accessor :status_in
+		attr_accessor :status_not_in
+
+		def caption_params_id_equal=(val)
+			@caption_params_id_equal = val.to_i
+		end
+		def status_equal=(val)
+			@status_equal = val.to_i
+		end
+	end
+
+	class KalturaCaptionParamsBaseFilter < KalturaAssetParamsFilter
+		attr_accessor :format_equal
+		attr_accessor :format_in
+
+	end
+
+	class KalturaCaptionAssetFilter < KalturaCaptionAssetBaseFilter
+
+	end
+
+	class KalturaCaptionParamsFilter < KalturaCaptionParamsBaseFilter
+
+	end
+
+
+	# Retrieve information and invoke actions on caption Asset
+	#  
+	class KalturaCaptionAssetService < KalturaServiceBase
+		def initialize(client)
+			super(client)
+		end
+
+		# Add caption asset
+		#      
+		def add(entry_id, caption_asset)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id);
+			client.add_param(kparams, 'captionAsset', caption_asset);
+			client.queue_service_action_call('caption_captionasset', 'add', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Update content of caption 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('caption_captionasset', 'setContent', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Update caption asset
+		#      
+		def update(id, caption_asset)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.add_param(kparams, 'captionAsset', caption_asset);
+			client.queue_service_action_call('caption_captionasset', 'update', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Serves caption by entry id and thumnail params id
+		# 	 
+		def serve_by_entry_id(entry_id, caption_param_id=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id);
+			# if not set, default caption will be used.
+			client.add_param(kparams, 'captionParamId', caption_param_id);
+			client.queue_service_action_call('caption_captionasset', 'serveByEntryId', kparams);
+			return client.get_serve_url();
+		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('caption_captionasset', '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('caption_captionasset', 'getRemotePaths', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Serves caption by its id
+		# 	 
+		def serve(caption_asset_id)
+			kparams = {}
+			client.add_param(kparams, 'captionAssetId', caption_asset_id);
+			client.queue_service_action_call('caption_captionasset', 'serve', kparams);
+			return client.get_serve_url();
+		end
+
+		# Serves caption by its id converting it to segmented WebVTT
+		# 	 
+		def serve_web_vtt(caption_asset_id, segment_duration=30, segment_index=KalturaNotImplemented, local_timestamp=10000)
+			kparams = {}
+			client.add_param(kparams, 'captionAssetId', caption_asset_id);
+			client.add_param(kparams, 'segmentDuration', segment_duration);
+			client.add_param(kparams, 'segmentIndex', segment_index);
+			client.add_param(kparams, 'localTimestamp', local_timestamp);
+			client.queue_service_action_call('caption_captionasset', 'serveWebVTT', kparams);
+			return client.get_serve_url();
+		end
+
+		# Markss the caption as default and removes that mark from all other caption assets of the entry.
+		# 	 
+		def set_as_default(caption_asset_id)
+			kparams = {}
+			client.add_param(kparams, 'captionAssetId', caption_asset_id);
+			client.queue_service_action_call('caption_captionasset', 'setAsDefault', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		def get(caption_asset_id)
+			kparams = {}
+			client.add_param(kparams, 'captionAssetId', caption_asset_id);
+			client.queue_service_action_call('caption_captionasset', 'get', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# List caption 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('caption_captionasset', 'list', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		def delete(caption_asset_id)
+			kparams = {}
+			client.add_param(kparams, 'captionAssetId', caption_asset_id);
+			client.queue_service_action_call('caption_captionasset', 'delete', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+	end
+
+	# Add & Manage Caption Params
+	#  
+	class KalturaCaptionParamsService < KalturaServiceBase
+		def initialize(client)
+			super(client)
+		end
+
+		# Add new Caption Params
+		# 	 
+		def add(caption_params)
+			kparams = {}
+			client.add_param(kparams, 'captionParams', caption_params);
+			client.queue_service_action_call('caption_captionparams', 'add', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Get Caption Params by ID
+		# 	 
+		def get(id)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.queue_service_action_call('caption_captionparams', 'get', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Update Caption Params by ID
+		# 	 
+		def update(id, caption_params)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.add_param(kparams, 'captionParams', caption_params);
+			client.queue_service_action_call('caption_captionparams', 'update', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Delete Caption Params by ID
+		# 	 
+		def delete(id)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.queue_service_action_call('caption_captionparams', 'delete', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# List Caption Params by filter with paging support (By default - all system default params will be listed too)
+		# 	 
+		def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'filter', filter);
+			client.add_param(kparams, 'pager', pager);
+			client.queue_service_action_call('caption_captionparams', 'list', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+	end
+
+	class KalturaClient < KalturaClientBase
+		attr_reader :caption_asset_service
+		def caption_asset_service
+			if (@caption_asset_service == nil)
+				@caption_asset_service = KalturaCaptionAssetService.new(self)
+			end
+			return @caption_asset_service
+		end
+		attr_reader :caption_params_service
+		def caption_params_service
+			if (@caption_params_service == nil)
+				@caption_params_service = KalturaCaptionParamsService.new(self)
+			end
+			return @caption_params_service
+		end
+	end
+
+end