Class: Kaltura::KalturaThumbAssetService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

Retrieve information and invoke actions on Thumb Asset

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaThumbAssetService

Returns a new instance of KalturaThumbAssetService.



4811
4812
4813
 
# File 'lib/kaltura_client.rb', line 4811

def initialize(client)
  super(client)
end

Instance Method Details

#add(entry_id, thumb_asset) ⇒ KalturaThumbAsset

Add thumbnail asset

Returns:



4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
 
# File 'lib/kaltura_client.rb', line 4817

def add(entry_id, thumb_asset)
  kparams = {}
  client.add_param(kparams, 'entryId', entry_id)
  client.add_param(kparams, 'thumbAsset', thumb_asset)
  client.queue_service_action_call('thumbasset', 'add', 'KalturaThumbAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#add_from_image(entry_id, file_data) ⇒ KalturaThumbAsset

Returns:



4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
 
# File 'lib/kaltura_client.rb', line 4829

def add_from_image(entry_id, file_data)
  kparams = {}
  kfiles = {}
  client.add_param(kparams, 'entryId', entry_id)
  client.add_param(kfiles, 'fileData', file_data)
  client.queue_service_action_call('thumbasset', 'addFromImage', 'KalturaThumbAsset', kparams, kfiles)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#add_from_url(entry_id, url) ⇒ KalturaThumbAsset

Returns:



4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
 
# File 'lib/kaltura_client.rb', line 4842

def add_from_url(entry_id, url)
  kparams = {}
  client.add_param(kparams, 'entryId', entry_id)
  client.add_param(kparams, 'url', url)
  client.queue_service_action_call('thumbasset', 'addFromUrl', 'KalturaThumbAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#delete(thumb_asset_id) ⇒ Object

Returns [].

Returns:



4854
4855
4856
4857
4858
4859
4860
4861
4862
 
# File 'lib/kaltura_client.rb', line 4854

def delete(thumb_asset_id)
  kparams = {}
  client.add_param(kparams, 'thumbAssetId', thumb_asset_id)
  client.queue_service_action_call('thumbasset', 'delete', '', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#export(asset_id, storage_profile_id) ⇒ KalturaFlavorAsset

manually export an asset

Returns:



4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
 
# File 'lib/kaltura_client.rb', line 4866

def export(asset_id, storage_profile_id)
  kparams = {}
  client.add_param(kparams, 'assetId', asset_id)
  client.add_param(kparams, 'storageProfileId', storage_profile_id)
  client.queue_service_action_call('thumbasset', 'export', 'KalturaFlavorAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#generate(entry_id, thumb_params, source_asset_id = KalturaNotImplemented) ⇒ KalturaThumbAsset

Returns:



4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
 
# File 'lib/kaltura_client.rb', line 4878

def generate(entry_id, thumb_params, source_asset_id=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'entryId', entry_id)
  client.add_param(kparams, 'thumbParams', thumb_params)
  client.add_param(kparams, 'sourceAssetId', source_asset_id)
  client.queue_service_action_call('thumbasset', 'generate', 'KalturaThumbAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#generate_by_entry_id(entry_id, dest_thumb_params_id) ⇒ KalturaThumbAsset

Returns:



4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
 
# File 'lib/kaltura_client.rb', line 4891

def generate_by_entry_id(entry_id, dest_thumb_params_id)
  kparams = {}
  client.add_param(kparams, 'entryId', entry_id)
  client.add_param(kparams, 'destThumbParamsId', dest_thumb_params_id)
  client.queue_service_action_call('thumbasset', 'generateByEntryId', 'KalturaThumbAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get(thumb_asset_id) ⇒ KalturaThumbAsset

Returns:



4903
4904
4905
4906
4907
4908
4909
4910
4911
 
# File 'lib/kaltura_client.rb', line 4903

def get(thumb_asset_id)
  kparams = {}
  client.add_param(kparams, 'thumbAssetId', thumb_asset_id)
  client.queue_service_action_call('thumbasset', 'get', 'KalturaThumbAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get_by_entry_id(entry_id) ⇒ array

Returns:

  • (array) 


4914
4915
4916
4917
4918
4919
4920
4921
4922
 
# File 'lib/kaltura_client.rb', line 4914

def get_by_entry_id(entry_id)
  kparams = {}
  client.add_param(kparams, 'entryId', entry_id)
  client.queue_service_action_call('thumbasset', 'getByEntryId', 'KalturaThumbAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get_remote_paths(id) ⇒ KalturaRemotePathListResponse

Get remote storage existing paths for the asset

Returns:



4926
4927
4928
4929
4930
4931
4932
4933
4934
 
# File 'lib/kaltura_client.rb', line 4926

def get_remote_paths(id)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.queue_service_action_call('thumbasset', 'getRemotePaths', 'KalturaRemotePathListResponse', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get_url(id, storage_id = KalturaNotImplemented, thumb_params = KalturaNotImplemented) ⇒ string

Get download URL for the asset

Returns:

  • (string) 


4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
 
# File 'lib/kaltura_client.rb', line 4938

def get_url(id, storage_id=KalturaNotImplemented, thumb_params=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.add_param(kparams, 'storageId', storage_id)
  client.add_param(kparams, 'thumbParams', thumb_params)
  client.queue_service_action_call('thumbasset', 'getUrl', 'string', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaThumbAssetListResponse

List Thumbnail Assets by filter and pager

Returns:



4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
 
# File 'lib/kaltura_client.rb', line 4952

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'filter', filter)
  client.add_param(kparams, 'pager', pager)
  client.queue_service_action_call('thumbasset', 'list', 'KalturaThumbAssetListResponse', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#regenerate(thumb_asset_id) ⇒ KalturaThumbAsset

Returns:



4964
4965
4966
4967
4968
4969
4970
4971
4972
 
# File 'lib/kaltura_client.rb', line 4964

def regenerate(thumb_asset_id)
  kparams = {}
  client.add_param(kparams, 'thumbAssetId', thumb_asset_id)
  client.queue_service_action_call('thumbasset', 'regenerate', 'KalturaThumbAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#serve(thumb_asset_id, version = KalturaNotImplemented, thumb_params = KalturaNotImplemented, options = KalturaNotImplemented) ⇒ file

Serves thumbnail by its id

Returns:

  • (file) 


4976
4977
4978
4979
4980
4981
4982
4983
4984
 
# File 'lib/kaltura_client.rb', line 4976

def serve(thumb_asset_id, version=KalturaNotImplemented, thumb_params=KalturaNotImplemented, options=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'thumbAssetId', thumb_asset_id)
  client.add_param(kparams, 'version', version)
  client.add_param(kparams, 'thumbParams', thumb_params)
  client.add_param(kparams, 'options', options)
  client.queue_service_action_call('thumbasset', 'serve', 'file', kparams)
  return client.get_serve_url()
end

#serve_by_entry_id(entry_id, thumb_param_id = KalturaNotImplemented) ⇒ file

Serves thumbnail by entry id and thumbnail params id

Returns:

  • (file) 


4988
4989
4990
4991
4992
4993
4994
 
# File 'lib/kaltura_client.rb', line 4988

def serve_by_entry_id(entry_id, thumb_param_id=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'entryId', entry_id)
  client.add_param(kparams, 'thumbParamId', thumb_param_id)
  client.queue_service_action_call('thumbasset', 'serveByEntryId', 'file', kparams)
  return client.get_serve_url()
end

#set_as_default(thumb_asset_id) ⇒ Object

Tags the thumbnail as DEFAULT_THUMB and removes that tag from all other thumbnail assets of the entry. Create a new file sync link on the entry thumbnail that points to the thumbnail asset file sync.

Returns:



4999
5000
5001
5002
5003
5004
5005
5006
5007
 
# File 'lib/kaltura_client.rb', line 4999

def set_as_default(thumb_asset_id)
  kparams = {}
  client.add_param(kparams, 'thumbAssetId', thumb_asset_id)
  client.queue_service_action_call('thumbasset', 'setAsDefault', '', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#set_content(id, content_resource) ⇒ KalturaThumbAsset

Update content of thumbnail asset

Returns:



5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
 
# File 'lib/kaltura_client.rb', line 5011

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('thumbasset', 'setContent', 'KalturaThumbAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#update(id, thumb_asset) ⇒ KalturaThumbAsset

Update thumbnail asset

Returns:



5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
 
# File 'lib/kaltura_client.rb', line 5024

def update(id, thumb_asset)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.add_param(kparams, 'thumbAsset', thumb_asset)
  client.queue_service_action_call('thumbasset', 'update', 'KalturaThumbAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end