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.



4681
4682
4683
 
# File 'lib/kaltura_client.rb', line 4681

def initialize(client)
  super(client)
end

Instance Method Details

#add(entry_id, thumb_asset) ⇒ KalturaThumbAsset

Add thumbnail asset

Returns:



4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
 
# File 'lib/kaltura_client.rb', line 4687

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:



4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
 
# File 'lib/kaltura_client.rb', line 4699

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:



4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
 
# File 'lib/kaltura_client.rb', line 4712

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:



4724
4725
4726
4727
4728
4729
4730
4731
4732
 
# File 'lib/kaltura_client.rb', line 4724

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:



4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
 
# File 'lib/kaltura_client.rb', line 4736

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:



4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
 
# File 'lib/kaltura_client.rb', line 4748

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:



4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
 
# File 'lib/kaltura_client.rb', line 4761

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:



4773
4774
4775
4776
4777
4778
4779
4780
4781
 
# File 'lib/kaltura_client.rb', line 4773

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) 


4784
4785
4786
4787
4788
4789
4790
4791
4792
 
# File 'lib/kaltura_client.rb', line 4784

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:



4796
4797
4798
4799
4800
4801
4802
4803
4804
 
# File 'lib/kaltura_client.rb', line 4796

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) 


4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
 
# File 'lib/kaltura_client.rb', line 4808

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:



4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
 
# File 'lib/kaltura_client.rb', line 4822

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:



4834
4835
4836
4837
4838
4839
4840
4841
4842
 
# File 'lib/kaltura_client.rb', line 4834

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) 


4846
4847
4848
4849
4850
4851
4852
4853
4854
 
# File 'lib/kaltura_client.rb', line 4846

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 thumnail params id

Returns:

  • (file) 


4858
4859
4860
4861
4862
4863
4864
 
# File 'lib/kaltura_client.rb', line 4858

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:



4869
4870
4871
4872
4873
4874
4875
4876
4877
 
# File 'lib/kaltura_client.rb', line 4869

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:



4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
 
# File 'lib/kaltura_client.rb', line 4881

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:



4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
 
# File 'lib/kaltura_client.rb', line 4894

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