Class: Kaltura::KalturaFlavorAssetService
- Inherits:
-
KalturaServiceBase
- Object
- KalturaServiceBase
- Kaltura::KalturaFlavorAssetService
- Defined in:
- lib/kaltura_client.rb
Overview
Retrieve information and invoke actions on Flavor Asset
Instance Attribute Summary
Attributes inherited from KalturaServiceBase
Instance Method Summary collapse
-
#add(entry_id, flavor_asset) ⇒ Object
Add flavor asset.
-
#convert(entry_id, flavor_params_id, priority = 0) ⇒ Object
Add and convert new Flavor Asset for Entry with specific Flavor Params.
-
#delete(id) ⇒ Object
Delete Flavor Asset by ID.
-
#delete_local_content(asset_id) ⇒ Object
delete all local file syncs for this asset.
-
#export(asset_id, storage_profile_id) ⇒ Object
manually export an asset.
-
#get(id) ⇒ Object
Get Flavor Asset by ID.
-
#get_by_entry_id(entry_id) ⇒ Object
Get Flavor Assets for Entry.
-
#get_download_url(id, use_cdn = false) ⇒ Object
Get download URL for the Flavor Asset.
-
#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).
-
#get_remote_paths(id) ⇒ Object
Get remote storage existing paths for the asset.
-
#get_url(id, storage_id = KalturaNotImplemented, force_proxy = false, options = KalturaNotImplemented) ⇒ Object
Get download URL for the asset.
-
#get_web_playable_by_entry_id(entry_id) ⇒ Object
Get web playable Flavor Assets for Entry.
-
#initialize(client) ⇒ KalturaFlavorAssetService
constructor
A new instance of KalturaFlavorAssetService.
-
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ Object
List Flavor Assets by filter and pager.
-
#reconvert(id) ⇒ Object
Reconvert Flavor Asset by ID.
-
#set_as_source(asset_id) ⇒ Object
Set a given flavor as the original flavor.
-
#set_content(id, content_resource) ⇒ Object
Update content of flavor asset.
-
#update(id, flavor_asset) ⇒ Object
Update flavor asset.
Constructor Details
#initialize(client) ⇒ KalturaFlavorAssetService
Returns a new instance of KalturaFlavorAssetService.
1764 1765 1766 |
# File 'lib/kaltura_client.rb', line 1764 def initialize(client) super(client) end |
Instance Method Details
#add(entry_id, flavor_asset) ⇒ Object
Add flavor asset
1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 |
# File 'lib/kaltura_client.rb', line 1770 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
1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 |
# File 'lib/kaltura_client.rb', line 1858 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
1884 1885 1886 1887 1888 1889 1890 1891 1892 |
# File 'lib/kaltura_client.rb', line 1884 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
1973 1974 1975 1976 1977 1978 1979 1980 1981 |
# File 'lib/kaltura_client.rb', line 1973 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
1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 |
# File 'lib/kaltura_client.rb', line 1948 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) ⇒ Object
Get Flavor Asset by ID
1809 1810 1811 1812 1813 1814 1815 1816 1817 |
# File 'lib/kaltura_client.rb', line 1809 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) ⇒ Object
Get Flavor Assets for Entry
1821 1822 1823 1824 1825 1826 1827 1828 1829 |
# File 'lib/kaltura_client.rb', line 1821 def get_by_entry_id(entry_id) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.queue_service_action_call('flavorasset', 'getByEntryId', 'array', 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
1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 |
# File 'lib/kaltura_client.rb', line 1923 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) ⇒ Object
Get Flavor Asset with the relevant Flavor Params (Flavor Params can exist without Flavor Asset & vice versa)
1936 1937 1938 1939 1940 1941 1942 1943 1944 |
# File 'lib/kaltura_client.rb', line 1936 def get_flavor_assets_with_params(entry_id) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.queue_service_action_call('flavorasset', 'getFlavorAssetsWithParams', 'array', 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
1911 1912 1913 1914 1915 1916 1917 1918 1919 |
# File 'lib/kaltura_client.rb', line 1911 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) ⇒ Object
Get download URL for the asset
1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 |
# File 'lib/kaltura_client.rb', line 1896 def get_url(id, storage_id=KalturaNotImplemented, force_proxy=false, =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', ) client.queue_service_action_call('flavorasset', 'getUrl', 'string', 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
1846 1847 1848 1849 1850 1851 1852 1853 1854 |
# File 'lib/kaltura_client.rb', line 1846 def get_web_playable_by_entry_id(entry_id) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.queue_service_action_call('flavorasset', 'getWebPlayableByEntryId', 'array', 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
1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 |
# File 'lib/kaltura_client.rb', line 1833 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
1872 1873 1874 1875 1876 1877 1878 1879 1880 |
# File 'lib/kaltura_client.rb', line 1872 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 |
#set_as_source(asset_id) ⇒ Object
Set a given flavor as the original flavor
1961 1962 1963 1964 1965 1966 1967 1968 1969 |
# File 'lib/kaltura_client.rb', line 1961 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
1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 |
# File 'lib/kaltura_client.rb', line 1796 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) ⇒ Object
Update flavor asset
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 |
# File 'lib/kaltura_client.rb', line 1783 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 |