Class: KalturaApi::KalturaFlavorAssetService

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

Overview

Retrieve information and invoke actions on Flavor Asset

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaFlavorAssetService

Returns a new instance of KalturaFlavorAssetService.



10608
10609
10610
 
# File 'lib/kaltura_client.rb', line 10608

def initialize(client)
	super(client)
end

Instance Method Details

#add(entry_id, flavor_asset) ⇒ Object

Add flavor asset



10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
 
# File 'lib/kaltura_client.rb', line 10614

def add(entry_id, flavor_asset)
	kparams = {}
	client.add_param(kparams, 'entryId', entry_id);
	client.add_param(kparams, 'flavorAsset', flavor_asset);
	client.queue_service_action_call('flavorasset', 'add', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#convert(entry_id, flavor_params_id, priority = 0) ⇒ Object

Add and convert new Flavor Asset for Entry with specific Flavor Params



10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
 
# File 'lib/kaltura_client.rb', line 10702

def convert(entry_id, flavor_params_id, priority=0)
	kparams = {}
	client.add_param(kparams, 'entryId', entry_id);
	client.add_param(kparams, 'flavorParamsId', flavor_params_id);
	client.add_param(kparams, 'priority', priority);
	client.queue_service_action_call('flavorasset', 'convert', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#delete(id) ⇒ Object

Delete Flavor Asset by ID



10729
10730
10731
10732
10733
10734
10735
10736
10737
 
# File 'lib/kaltura_client.rb', line 10729

def delete(id)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.queue_service_action_call('flavorasset', 'delete', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#export(asset_id, storage_profile_id) ⇒ Object

manually export an asset



10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
 
# File 'lib/kaltura_client.rb', line 10792

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('flavorasset', 'export', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get(id) ⇒ Object

Get Flavor Asset by ID



10653
10654
10655
10656
10657
10658
10659
10660
10661
 
# File 'lib/kaltura_client.rb', line 10653

def get(id)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.queue_service_action_call('flavorasset', 'get', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get_by_entry_id(entry_id) ⇒ Object

Get Flavor Assets for Entry



10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'lib/kaltura_client.rb', line 10665

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

#get_download_url(id, use_cdn = false) ⇒ Object

Get download URL for the Flavor Asset



10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
 
# File 'lib/kaltura_client.rb', line 10767

def get_download_url(id, use_cdn=false)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.add_param(kparams, 'useCdn', use_cdn);
	client.queue_service_action_call('flavorasset', 'getDownloadUrl', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get_flavor_assets_with_params(entry_id) ⇒ Object

Get Flavor Asset with the relevant Flavor Params (Flavor Params can exist without Flavor Asset & vice versa)



10780
10781
10782
10783
10784
10785
10786
10787
10788
 
# File 'lib/kaltura_client.rb', line 10780

def get_flavor_assets_with_params(entry_id)
	kparams = {}
	client.add_param(kparams, 'entryId', entry_id);
	client.queue_service_action_call('flavorasset', 'getFlavorAssetsWithParams', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get_remote_paths(id) ⇒ Object

Get remote storage existing paths for the asset



10755
10756
10757
10758
10759
10760
10761
10762
10763
 
# File 'lib/kaltura_client.rb', line 10755

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

#get_url(id, storage_id = KalturaNotImplemented, force_proxy = false) ⇒ Object

Get download URL for the asset



10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
 
# File 'lib/kaltura_client.rb', line 10741

def get_url(id, storage_id=KalturaNotImplemented, force_proxy=false)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.add_param(kparams, 'storageId', storage_id);
	client.add_param(kparams, 'forceProxy', force_proxy);
	client.queue_service_action_call('flavorasset', 'getUrl', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get_web_playable_by_entry_id(entry_id) ⇒ Object

Get web playable Flavor Assets for Entry



10690
10691
10692
10693
10694
10695
10696
10697
10698
 
# File 'lib/kaltura_client.rb', line 10690

def get_web_playable_by_entry_id(entry_id)
	kparams = {}
	client.add_param(kparams, 'entryId', entry_id);
	client.queue_service_action_call('flavorasset', 'getWebPlayableByEntryId', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

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

List Flavor Assets by filter and pager



10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
 
# File 'lib/kaltura_client.rb', line 10677

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

#reconvert(id) ⇒ Object

Reconvert Flavor Asset by ID



10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
 
# File 'lib/kaltura_client.rb', line 10716

def reconvert(id)
	kparams = {}
	# Flavor Asset ID
	client.add_param(kparams, 'id', id);
	client.queue_service_action_call('flavorasset', 'reconvert', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#set_as_source(asset_id) ⇒ Object

Set a given flavor as the original flavor



10805
10806
10807
10808
10809
10810
10811
10812
10813
 
# File 'lib/kaltura_client.rb', line 10805

def set_as_source(asset_id)
	kparams = {}
	client.add_param(kparams, 'assetId', asset_id);
	client.queue_service_action_call('flavorasset', 'setAsSource', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#set_content(id, content_resource) ⇒ Object

Update content of flavor asset



10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
 
# File 'lib/kaltura_client.rb', line 10640

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

#update(id, flavor_asset) ⇒ Object

Update flavor asset



10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
 
# File 'lib/kaltura_client.rb', line 10627

def update(id, flavor_asset)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.add_param(kparams, 'flavorAsset', flavor_asset);
	client.queue_service_action_call('flavorasset', 'update', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end