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.



1756
1757
1758
 
# File 'lib/kaltura_client.rb', line 1756

def initialize(client)
	super(client)
end

Instance Method Details

#add(entry_id, flavor_asset) ⇒ KalturaFlavorAsset

Add flavor asset

Returns:



1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
 
# File 'lib/kaltura_client.rb', line 1762

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', 'KalturaFlavorAsset', 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

Returns:



1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
 
# File 'lib/kaltura_client.rb', line 1775

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

Returns:



1789
1790
1791
1792
1793
1794
1795
1796
1797
 
# File 'lib/kaltura_client.rb', line 1789

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

Returns:



1801
1802
1803
1804
1805
1806
1807
1808
1809
 
# File 'lib/kaltura_client.rb', line 1801

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) ⇒ KalturaFlavorAsset

manually export an asset

Returns:



1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
 
# File 'lib/kaltura_client.rb', line 1813

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

#get(id) ⇒ KalturaFlavorAsset

Get Flavor Asset by ID

Returns:



1826
1827
1828
1829
1830
1831
1832
1833
1834
 
# File 'lib/kaltura_client.rb', line 1826

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

#get_by_entry_id(entry_id) ⇒ array

Get Flavor Assets for Entry

Returns:

  • (array) 


1838
1839
1840
1841
1842
1843
1844
1845
1846
 
# File 'lib/kaltura_client.rb', line 1838

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

#get_download_url(id, use_cdn = false) ⇒ string

Get download URL for the Flavor Asset

Returns:

  • (string) 


1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
 
# File 'lib/kaltura_client.rb', line 1850

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

#get_flavor_assets_with_params(entry_id) ⇒ array

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

Returns:

  • (array) 


1863
1864
1865
1866
1867
1868
1869
1870
1871
 
# File 'lib/kaltura_client.rb', line 1863

def get_flavor_assets_with_params(entry_id)
	kparams = {}
	client.add_param(kparams, 'entryId', entry_id)
	client.queue_service_action_call('flavorasset', 'getFlavorAssetsWithParams', 'KalturaFlavorAssetWithParams', 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:



1875
1876
1877
1878
1879
1880
1881
1882
1883
 
# File 'lib/kaltura_client.rb', line 1875

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

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

Get download URL for the asset

Returns:

  • (string) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
 
# File 'lib/kaltura_client.rb', line 1887

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

#get_volume_map(flavor_id) ⇒ file

Get volume map by entry id

Returns:

  • (file) 


1902
1903
1904
1905
1906
1907
 
# File 'lib/kaltura_client.rb', line 1902

def get_volume_map(flavor_id)
	kparams = {}
	client.add_param(kparams, 'flavorId', flavor_id)
	client.queue_service_action_call('flavorasset', 'getVolumeMap', 'file', kparams)
	return client.get_serve_url()
end

#get_web_playable_by_entry_id(entry_id) ⇒ array

Get web playable Flavor Assets for Entry

Returns:

  • (array) 


1911
1912
1913
1914
1915
1916
1917
1918
1919
 
# File 'lib/kaltura_client.rb', line 1911

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

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

List Flavor Assets by filter and pager

Returns:



1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
 
# File 'lib/kaltura_client.rb', line 1923

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

#reconvert(id) ⇒ Object

Reconvert Flavor Asset by ID

Returns:



1936
1937
1938
1939
1940
1941
1942
1943
1944
 
# File 'lib/kaltura_client.rb', line 1936

def reconvert(id)
	kparams = {}
	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

#serve_ad_stitch_cmd(asset_id, ffprobe_json = KalturaNotImplemented, duration = KalturaNotImplemented) ⇒ string

serve cmd line to transcode the ad

Returns:

  • (string) 


1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
 
# File 'lib/kaltura_client.rb', line 1948

def serve_ad_stitch_cmd(asset_id, ffprobe_json=KalturaNotImplemented, duration=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'assetId', asset_id)
	client.add_param(kparams, 'ffprobeJson', ffprobe_json)
	client.add_param(kparams, 'duration', duration)
	client.queue_service_action_call('flavorasset', 'serveAdStitchCmd', 'string', 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

Returns:



1962
1963
1964
1965
1966
1967
1968
1969
1970
 
# File 'lib/kaltura_client.rb', line 1962

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) ⇒ KalturaFlavorAsset

Update content of flavor asset

Returns:



1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File 'lib/kaltura_client.rb', line 1974

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

#update(id, flavor_asset) ⇒ KalturaFlavorAsset

Update flavor asset

Returns:



1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
 
# File 'lib/kaltura_client.rb', line 1987

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