class Kaltura::KalturaFlavorAssetService

Retrieve information and invoke actions on Flavor Asset

Public Class Methods

new(client) click to toggle source
Calls superclass method
# File lib/kaltura_client.rb, line 1716
def initialize(client)
        super(client)
end

Public Instance Methods

add(entry_id, flavor_asset) click to toggle source

Add flavor asset @return [KalturaFlavorAsset]

# File lib/kaltura_client.rb, line 1722
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) click to toggle source

Add and convert new Flavor Asset for Entry with specific Flavor Params @return []

# File lib/kaltura_client.rb, line 1735
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) click to toggle source

Delete Flavor Asset by ID @return []

# File lib/kaltura_client.rb, line 1749
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) click to toggle source

delete all local file syncs for this asset @return []

# File lib/kaltura_client.rb, line 1761
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) click to toggle source

manually export an asset @return [KalturaFlavorAsset]

# File lib/kaltura_client.rb, line 1773
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) click to toggle source

Get Flavor Asset by ID @return [KalturaFlavorAsset]

# File lib/kaltura_client.rb, line 1786
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) click to toggle source

Get Flavor Assets for Entry @return [array]

# File lib/kaltura_client.rb, line 1798
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) click to toggle source

Get download URL for the Flavor Asset @return [string]

# File lib/kaltura_client.rb, line 1810
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) click to toggle source

Get Flavor Asset with the relevant Flavor Params (Flavor Params can exist without Flavor Asset & vice versa) @return [array]

# File lib/kaltura_client.rb, line 1823
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) click to toggle source

Get remote storage existing paths for the asset @return [KalturaRemotePathListResponse]

# File lib/kaltura_client.rb, line 1835
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) click to toggle source

Get download URL for the asset @return [string]

# File lib/kaltura_client.rb, line 1847
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) click to toggle source

Get volume map by entry id @return [file]

# File lib/kaltura_client.rb, line 1862
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) click to toggle source

Get web playable Flavor Assets for Entry @return [array]

# File lib/kaltura_client.rb, line 1871
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) click to toggle source

List Flavor Assets by filter and pager @return [KalturaFlavorAssetListResponse]

# File lib/kaltura_client.rb, line 1883
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) click to toggle source

Reconvert Flavor Asset by ID @return []

# File lib/kaltura_client.rb, line 1896
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) click to toggle source

serve cmd line to transcode the ad @return [string]

# File lib/kaltura_client.rb, line 1908
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) click to toggle source

Set a given flavor as the original flavor @return []

# File lib/kaltura_client.rb, line 1922
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) click to toggle source

Update content of flavor asset @return [KalturaFlavorAsset]

# File lib/kaltura_client.rb, line 1934
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) click to toggle source

Update flavor asset @return [KalturaFlavorAsset]

# File lib/kaltura_client.rb, line 1947
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