kaltura-client 3.3.0 → 14.15.0

data/lib/kaltura_plugins/kaltura_caption_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
@@ -56,36 +56,30 @@ module Kaltura
 		SRT = "1"
 		DFXP = "2"
 		WEBVTT = "3"
+		CAP = "4"
 	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
 		# The parent id of the asset
-		# 	 
 		attr_accessor :parent_id
 		# The Accuracy of the caption content
-		# 	 
 		attr_accessor :accuracy
+		# The Accuracy of the caption content
+		attr_accessor :display_on_player
 
 		def caption_params_id=(val)
 			@caption_params_id = val.to_i
@@ -99,37 +93,56 @@ module Kaltura
 		def accuracy=(val)
 			@accuracy = val.to_i
 		end
+		def display_on_player=(val)
+			@display_on_player = to_b(val)
+		end
 
 		def from_xml(xml_element)
 			super
-			self.caption_params_id = xml_element.elements['captionParamsId'].text
-			self.language = xml_element.elements['language'].text
-			self.language_code = xml_element.elements['languageCode'].text
-			self.is_default = xml_element.elements['isDefault'].text
-			self.label = xml_element.elements['label'].text
-			self.format = xml_element.elements['format'].text
-			self.status = xml_element.elements['status'].text
-			self.parent_id = xml_element.elements['parentId'].text
-			self.accuracy = xml_element.elements['accuracy'].text
+			if xml_element.elements['captionParamsId'] != nil
+				self.caption_params_id = xml_element.elements['captionParamsId'].text
+			end
+			if xml_element.elements['language'] != nil
+				self.language = xml_element.elements['language'].text
+			end
+			if xml_element.elements['languageCode'] != nil
+				self.language_code = xml_element.elements['languageCode'].text
+			end
+			if xml_element.elements['isDefault'] != nil
+				self.is_default = xml_element.elements['isDefault'].text
+			end
+			if xml_element.elements['label'] != nil
+				self.label = xml_element.elements['label'].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
+			if xml_element.elements['parentId'] != nil
+				self.parent_id = xml_element.elements['parentId'].text
+			end
+			if xml_element.elements['accuracy'] != nil
+				self.accuracy = xml_element.elements['accuracy'].text
+			end
+			if xml_element.elements['displayOnPlayer'] != nil
+				self.display_on_player = xml_element.elements['displayOnPlayer'].text
+			end
 		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)
@@ -141,11 +154,61 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.language = xml_element.elements['language'].text
-			self.is_default = xml_element.elements['isDefault'].text
-			self.label = xml_element.elements['label'].text
-			self.format = xml_element.elements['format'].text
-			self.source_params_id = xml_element.elements['sourceParamsId'].text
+			if xml_element.elements['language'] != nil
+				self.language = xml_element.elements['language'].text
+			end
+			if xml_element.elements['isDefault'] != nil
+				self.is_default = xml_element.elements['isDefault'].text
+			end
+			if xml_element.elements['label'] != nil
+				self.label = xml_element.elements['label'].text
+			end
+			if xml_element.elements['format'] != nil
+				self.format = xml_element.elements['format'].text
+			end
+			if xml_element.elements['sourceParamsId'] != nil
+				self.source_params_id = xml_element.elements['sourceParamsId'].text
+			end
+		end
+
+	end
+
+	class KalturaCaptionPlaybackPluginData < KalturaObjectBase
+		attr_accessor :label
+		attr_accessor :format
+		attr_accessor :language
+		attr_accessor :web_vtt_url
+		attr_accessor :url
+		attr_accessor :is_default
+		attr_accessor :language_code
+
+		def is_default=(val)
+			@is_default = to_b(val)
+		end
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['label'] != nil
+				self.label = xml_element.elements['label'].text
+			end
+			if xml_element.elements['format'] != nil
+				self.format = xml_element.elements['format'].text
+			end
+			if xml_element.elements['language'] != nil
+				self.language = xml_element.elements['language'].text
+			end
+			if xml_element.elements['webVttUrl'] != nil
+				self.web_vtt_url = xml_element.elements['webVttUrl'].text
+			end
+			if xml_element.elements['url'] != nil
+				self.url = xml_element.elements['url'].text
+			end
+			if xml_element.elements['isDefault'] != nil
+				self.is_default = xml_element.elements['isDefault'].text
+			end
+			if xml_element.elements['languageCode'] != nil
+				self.language_code = xml_element.elements['languageCode'].text
+			end
 		end
 
 	end
@@ -156,7 +219,9 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaCaptionAsset')
+			if xml_element.elements['objects'] != nil
+				self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaCaptionAsset')
+			end
 		end
 
 	end
@@ -167,7 +232,35 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaCaptionParams')
+			if xml_element.elements['objects'] != nil
+				self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaCaptionParams')
+			end
+		end
+
+	end
+
+	class KalturaCopyCaptionsJobData < KalturaJobData
+		# entry Id
+		attr_accessor :entry_id
+		# an array of source start time and duration
+		attr_accessor :clips_description_array
+		attr_accessor :full_copy
+
+		def full_copy=(val)
+			@full_copy = to_b(val)
+		end
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['entryId'] != nil
+				self.entry_id = xml_element.elements['entryId'].text
+			end
+			if xml_element.elements['clipsDescriptionArray'] != nil
+				self.clips_description_array = KalturaClientBase.object_from_xml(xml_element.elements['clipsDescriptionArray'], 'KalturaClipDescription')
+			end
+			if xml_element.elements['fullCopy'] != nil
+				self.full_copy = xml_element.elements['fullCopy'].text
+			end
 		end
 
 	end
@@ -176,13 +269,23 @@ module Kaltura
 		attr_accessor :multi_lanaguage_caption_asset_id
 		attr_accessor :entry_id
 		attr_accessor :file_location
+		attr_accessor :file_encryption_key
 
 
 		def from_xml(xml_element)
 			super
-			self.multi_lanaguage_caption_asset_id = xml_element.elements['multiLanaguageCaptionAssetId'].text
-			self.entry_id = xml_element.elements['entryId'].text
-			self.file_location = xml_element.elements['fileLocation'].text
+			if xml_element.elements['multiLanaguageCaptionAssetId'] != nil
+				self.multi_lanaguage_caption_asset_id = xml_element.elements['multiLanaguageCaptionAssetId'].text
+			end
+			if xml_element.elements['entryId'] != nil
+				self.entry_id = xml_element.elements['entryId'].text
+			end
+			if xml_element.elements['fileLocation'] != nil
+				self.file_location = xml_element.elements['fileLocation'].text
+			end
+			if xml_element.elements['fileEncryptionKey'] != nil
+				self.file_encryption_key = xml_element.elements['fileEncryptionKey'].text
+			end
 		end
 
 	end
@@ -205,13 +308,27 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.caption_params_id_equal = xml_element.elements['captionParamsIdEqual'].text
-			self.caption_params_id_in = xml_element.elements['captionParamsIdIn'].text
-			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['captionParamsIdEqual'] != nil
+				self.caption_params_id_equal = xml_element.elements['captionParamsIdEqual'].text
+			end
+			if xml_element.elements['captionParamsIdIn'] != nil
+				self.caption_params_id_in = xml_element.elements['captionParamsIdIn'].text
+			end
+			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
@@ -223,8 +340,12 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.format_equal = xml_element.elements['formatEqual'].text
-			self.format_in = xml_element.elements['formatIn'].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
 		end
 
 	end
@@ -249,14 +370,13 @@ module Kaltura
 
 
 	# Retrieve information and invoke actions on caption Asset
-	#  
 	class KalturaCaptionAssetService < KalturaServiceBase
 		def initialize(client)
 			super(client)
 		end
 
 		# Add caption asset
-		#      
+		# @return [KalturaCaptionAsset]
 		def add(entry_id, caption_asset)
 			kparams = {}
 			client.add_param(kparams, 'entryId', entry_id)
@@ -268,44 +388,42 @@ module Kaltura
 			return client.do_queue()
 		end
 
-		# Update content of caption asset
-		#      
-		def set_content(id, content_resource)
+		# @return []
+		def delete(caption_asset_id)
 			kparams = {}
-			client.add_param(kparams, 'id', id)
-			client.add_param(kparams, 'contentResource', content_resource)
-			client.queue_service_action_call('caption_captionasset', 'setContent', 'KalturaCaptionAsset', 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
 
-		# Update caption asset
-		#      
-		def update(id, caption_asset)
+		# @return [KalturaCaptionAsset]
+		def get(caption_asset_id)
 			kparams = {}
-			client.add_param(kparams, 'id', id)
-			client.add_param(kparams, 'captionAsset', caption_asset)
-			client.queue_service_action_call('caption_captionasset', 'update', 'KalturaCaptionAsset', kparams)
+			client.add_param(kparams, 'captionAssetId', caption_asset_id)
+			client.queue_service_action_call('caption_captionasset', 'get', 'KalturaCaptionAsset', 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)
+		# Get remote storage existing paths for the asset
+		# @return [KalturaRemotePathListResponse]
+		def get_remote_paths(id)
 			kparams = {}
-			client.add_param(kparams, 'entryId', entry_id)
-			client.add_param(kparams, 'captionParamId', caption_param_id)
-			client.queue_service_action_call('caption_captionasset', 'serveByEntryId', 'file', kparams)
-			return client.get_serve_url()
+			client.add_param(kparams, 'id', id)
+			client.queue_service_action_call('caption_captionasset', 'getRemotePaths', 'KalturaRemotePathListResponse', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
 		end
 
 		# Get download URL for the asset
-		# 	 
+		# @return [string]
 		def get_url(id, storage_id=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'id', id)
@@ -317,12 +435,13 @@ module Kaltura
 			return client.do_queue()
 		end
 
-		# Get remote storage existing paths for the asset
-		# 	 
-		def get_remote_paths(id)
+		# List caption Assets by filter and pager
+		# @return [KalturaCaptionAssetListResponse]
+		def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
 			kparams = {}
-			client.add_param(kparams, 'id', id)
-			client.queue_service_action_call('caption_captionasset', 'getRemotePaths', 'KalturaRemotePathListResponse', kparams)
+			client.add_param(kparams, 'filter', filter)
+			client.add_param(kparams, 'pager', pager)
+			client.queue_service_action_call('caption_captionasset', 'list', 'KalturaCaptionAssetListResponse', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
@@ -330,7 +449,7 @@ module Kaltura
 		end
 
 		# Serves caption by its id
-		# 	 
+		# @return [file]
 		def serve(caption_asset_id)
 			kparams = {}
 			client.add_param(kparams, 'captionAssetId', caption_asset_id)
@@ -338,8 +457,18 @@ module Kaltura
 			return client.get_serve_url()
 		end
 
+		# Serves caption by entry id and thumnail params id
+		# @return [file]
+		def serve_by_entry_id(entry_id, caption_param_id=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.add_param(kparams, 'captionParamId', caption_param_id)
+			client.queue_service_action_call('caption_captionasset', 'serveByEntryId', 'file', kparams)
+			return client.get_serve_url()
+		end
+
 		# Serves caption by its id converting it to segmented WebVTT
-		# 	 
+		# @return [file]
 		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)
@@ -351,7 +480,7 @@ module Kaltura
 		end
 
 		# Markss the caption as default and removes that mark from all other caption assets of the entry.
-		# 	 
+		# @return []
 		def set_as_default(caption_asset_id)
 			kparams = {}
 			client.add_param(kparams, 'captionAssetId', caption_asset_id)
@@ -362,33 +491,26 @@ module Kaltura
 			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', 'KalturaCaptionAsset', 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)
+		# Update content of caption asset
+		# @return [KalturaCaptionAsset]
+		def set_content(id, content_resource)
 			kparams = {}
-			client.add_param(kparams, 'filter', filter)
-			client.add_param(kparams, 'pager', pager)
-			client.queue_service_action_call('caption_captionasset', 'list', 'KalturaCaptionAssetListResponse', kparams)
+			client.add_param(kparams, 'id', id)
+			client.add_param(kparams, 'contentResource', content_resource)
+			client.queue_service_action_call('caption_captionasset', 'setContent', 'KalturaCaptionAsset', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		def delete(caption_asset_id)
+		# Update caption asset
+		# @return [KalturaCaptionAsset]
+		def update(id, caption_asset)
 			kparams = {}
-			client.add_param(kparams, 'captionAssetId', caption_asset_id)
-			client.queue_service_action_call('caption_captionasset', 'delete', '', kparams)
+			client.add_param(kparams, 'id', id)
+			client.add_param(kparams, 'captionAsset', caption_asset)
+			client.queue_service_action_call('caption_captionasset', 'update', 'KalturaCaptionAsset', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
@@ -397,14 +519,13 @@ module Kaltura
 	end
 
 	# Add & Manage Caption Params
-	#  
 	class KalturaCaptionParamsService < KalturaServiceBase
 		def initialize(client)
 			super(client)
 		end
 
 		# Add new Caption Params
-		# 	 
+		# @return [KalturaCaptionParams]
 		def add(caption_params)
 			kparams = {}
 			client.add_param(kparams, 'captionParams', caption_params)
@@ -415,50 +536,50 @@ module Kaltura
 			return client.do_queue()
 		end
 
-		# Get Caption Params by ID
-		# 	 
-		def get(id)
+		# Delete Caption Params by ID
+		# @return []
+		def delete(id)
 			kparams = {}
 			client.add_param(kparams, 'id', id)
-			client.queue_service_action_call('caption_captionparams', 'get', 'KalturaCaptionParams', kparams)
+			client.queue_service_action_call('caption_captionparams', 'delete', '', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# Update Caption Params by ID
-		# 	 
-		def update(id, caption_params)
+		# Get Caption Params by ID
+		# @return [KalturaCaptionParams]
+		def get(id)
 			kparams = {}
 			client.add_param(kparams, 'id', id)
-			client.add_param(kparams, 'captionParams', caption_params)
-			client.queue_service_action_call('caption_captionparams', 'update', 'KalturaCaptionParams', kparams)
+			client.queue_service_action_call('caption_captionparams', 'get', 'KalturaCaptionParams', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# Delete Caption Params by ID
-		# 	 
-		def delete(id)
+		# List Caption Params by filter with paging support (By default - all system default params will be listed too)
+		# @return [KalturaCaptionParamsListResponse]
+		def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
 			kparams = {}
-			client.add_param(kparams, 'id', id)
-			client.queue_service_action_call('caption_captionparams', 'delete', '', kparams)
+			client.add_param(kparams, 'filter', filter)
+			client.add_param(kparams, 'pager', pager)
+			client.queue_service_action_call('caption_captionparams', 'list', 'KalturaCaptionParamsListResponse', 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)
+		# Update Caption Params by ID
+		# @return [KalturaCaptionParams]
+		def update(id, caption_params)
 			kparams = {}
-			client.add_param(kparams, 'filter', filter)
-			client.add_param(kparams, 'pager', pager)
-			client.queue_service_action_call('caption_captionparams', 'list', 'KalturaCaptionParamsListResponse', kparams)
+			client.add_param(kparams, 'id', id)
+			client.add_param(kparams, 'captionParams', caption_params)
+			client.queue_service_action_call('caption_captionparams', 'update', 'KalturaCaptionParams', kparams)
 			if (client.is_multirequest)
 				return nil
 			end