Class: Kaltura::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.



12485
12486
12487
# File 'lib/kaltura_client.rb', line 12485

def initialize(client)
	super(client)
end

Instance Method Details

#add(entry_id, flavor_asset) ⇒ Object

Add flavor asset



12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
# File 'lib/kaltura_client.rb', line 12491

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



12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
# File 'lib/kaltura_client.rb', line 12579

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



12606
12607
12608
12609
12610
12611
12612
12613
12614
# File 'lib/kaltura_client.rb', line 12606

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

#delete_local_content(asset_id) ⇒ Object

delete all local file syncs for this asset



12695
12696
12697
12698
12699
12700
12701
12702
12703
# File 'lib/kaltura_client.rb', line 12695

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

#export(asset_id, storage_profile_id) ⇒ Object

manually export an asset



12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
# File 'lib/kaltura_client.rb', line 12670

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



12530
12531
12532
12533
12534
12535
12536
12537
12538
# File 'lib/kaltura_client.rb', line 12530

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



12542
12543
12544
12545
12546
12547
12548
12549
12550
# File 'lib/kaltura_client.rb', line 12542

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



12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
# File 'lib/kaltura_client.rb', line 12645

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)



12658
12659
12660
12661
12662
12663
12664
12665
12666
# File 'lib/kaltura_client.rb', line 12658

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



12633
12634
12635
12636
12637
12638
12639
12640
12641
# File 'lib/kaltura_client.rb', line 12633

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, options = KalturaNotImplemented) ⇒ Object

Get download URL for the asset



12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
# File 'lib/kaltura_client.rb', line 12618

def get_url(id, storage_id=KalturaNotImplemented, force_proxy=false, options=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.add_param(kparams, 'storageId', storage_id);
	client.add_param(kparams, 'forceProxy', force_proxy);
	client.add_param(kparams, 'options', options);
	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



12567
12568
12569
12570
12571
12572
12573
12574
12575
# File 'lib/kaltura_client.rb', line 12567

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



12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
# File 'lib/kaltura_client.rb', line 12554

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



12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
# File 'lib/kaltura_client.rb', line 12593

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



12683
12684
12685
12686
12687
12688
12689
12690
12691
# File 'lib/kaltura_client.rb', line 12683

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



12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
# File 'lib/kaltura_client.rb', line 12517

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



12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
# File 'lib/kaltura_client.rb', line 12504

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