class Kaltura::KalturaThumbAssetService

Retrieve information and invoke actions on Thumb Asset

Public Class Methods

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

Public Instance Methods

add(entry_id, thumb_asset) click to toggle source

Add thumbnail asset @return [KalturaThumbAsset]

# File lib/kaltura_client.rb, line 4790
def add(entry_id, thumb_asset)
        kparams = {}
        client.add_param(kparams, 'entryId', entry_id)
        client.add_param(kparams, 'thumbAsset', thumb_asset)
        client.queue_service_action_call('thumbasset', 'add', 'KalturaThumbAsset', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
add_from_image(entry_id, file_data) click to toggle source

@return [KalturaThumbAsset]

# File lib/kaltura_client.rb, line 4802
def add_from_image(entry_id, file_data)
        kparams = {}
        kfiles = {}
        client.add_param(kparams, 'entryId', entry_id)
        client.add_param(kfiles, 'fileData', file_data)
        client.queue_service_action_call('thumbasset', 'addFromImage', 'KalturaThumbAsset', kparams, kfiles)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
add_from_url(entry_id, url) click to toggle source

@return [KalturaThumbAsset]

# File lib/kaltura_client.rb, line 4815
def add_from_url(entry_id, url)
        kparams = {}
        client.add_param(kparams, 'entryId', entry_id)
        client.add_param(kparams, 'url', url)
        client.queue_service_action_call('thumbasset', 'addFromUrl', 'KalturaThumbAsset', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
delete(thumb_asset_id) click to toggle source

@return []

# File lib/kaltura_client.rb, line 4827
def delete(thumb_asset_id)
        kparams = {}
        client.add_param(kparams, 'thumbAssetId', thumb_asset_id)
        client.queue_service_action_call('thumbasset', 'delete', '', 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 4839
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('thumbasset', 'export', 'KalturaFlavorAsset', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
generate(entry_id, thumb_params, source_asset_id=KalturaNotImplemented) click to toggle source

@return [KalturaThumbAsset]

# File lib/kaltura_client.rb, line 4851
def generate(entry_id, thumb_params, source_asset_id=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'entryId', entry_id)
        client.add_param(kparams, 'thumbParams', thumb_params)
        client.add_param(kparams, 'sourceAssetId', source_asset_id)
        client.queue_service_action_call('thumbasset', 'generate', 'KalturaThumbAsset', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
generate_by_entry_id(entry_id, dest_thumb_params_id) click to toggle source

@return [KalturaThumbAsset]

# File lib/kaltura_client.rb, line 4864
def generate_by_entry_id(entry_id, dest_thumb_params_id)
        kparams = {}
        client.add_param(kparams, 'entryId', entry_id)
        client.add_param(kparams, 'destThumbParamsId', dest_thumb_params_id)
        client.queue_service_action_call('thumbasset', 'generateByEntryId', 'KalturaThumbAsset', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get(thumb_asset_id) click to toggle source

@return [KalturaThumbAsset]

# File lib/kaltura_client.rb, line 4876
def get(thumb_asset_id)
        kparams = {}
        client.add_param(kparams, 'thumbAssetId', thumb_asset_id)
        client.queue_service_action_call('thumbasset', 'get', 'KalturaThumbAsset', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get_by_entry_id(entry_id) click to toggle source

@return [array]

# File lib/kaltura_client.rb, line 4887
def get_by_entry_id(entry_id)
        kparams = {}
        client.add_param(kparams, 'entryId', entry_id)
        client.queue_service_action_call('thumbasset', 'getByEntryId', 'KalturaThumbAsset', 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 4899
def get_remote_paths(id)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.queue_service_action_call('thumbasset', 'getRemotePaths', 'KalturaRemotePathListResponse', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get_url(id, storage_id=KalturaNotImplemented, thumb_params=KalturaNotImplemented) click to toggle source

Get download URL for the asset @return [string]

# File lib/kaltura_client.rb, line 4911
def get_url(id, storage_id=KalturaNotImplemented, thumb_params=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'storageId', storage_id)
        client.add_param(kparams, 'thumbParams', thumb_params)
        client.queue_service_action_call('thumbasset', 'getUrl', 'string', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) click to toggle source

List Thumbnail Assets by filter and pager @return [KalturaThumbAssetListResponse]

# File lib/kaltura_client.rb, line 4925
def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'filter', filter)
        client.add_param(kparams, 'pager', pager)
        client.queue_service_action_call('thumbasset', 'list', 'KalturaThumbAssetListResponse', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
regenerate(thumb_asset_id) click to toggle source

@return [KalturaThumbAsset]

# File lib/kaltura_client.rb, line 4937
def regenerate(thumb_asset_id)
        kparams = {}
        client.add_param(kparams, 'thumbAssetId', thumb_asset_id)
        client.queue_service_action_call('thumbasset', 'regenerate', 'KalturaThumbAsset', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
serve(thumb_asset_id, version=KalturaNotImplemented, thumb_params=KalturaNotImplemented, options=KalturaNotImplemented) click to toggle source

Serves thumbnail by its id @return [file]

# File lib/kaltura_client.rb, line 4949
def serve(thumb_asset_id, version=KalturaNotImplemented, thumb_params=KalturaNotImplemented, options=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'thumbAssetId', thumb_asset_id)
        client.add_param(kparams, 'version', version)
        client.add_param(kparams, 'thumbParams', thumb_params)
        client.add_param(kparams, 'options', options)
        client.queue_service_action_call('thumbasset', 'serve', 'file', kparams)
        return client.get_serve_url()
end
serve_by_entry_id(entry_id, thumb_param_id=KalturaNotImplemented) click to toggle source

Serves thumbnail by entry id and thumnail params id @return [file]

# File lib/kaltura_client.rb, line 4961
def serve_by_entry_id(entry_id, thumb_param_id=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'entryId', entry_id)
        client.add_param(kparams, 'thumbParamId', thumb_param_id)
        client.queue_service_action_call('thumbasset', 'serveByEntryId', 'file', kparams)
        return client.get_serve_url()
end
set_as_default(thumb_asset_id) click to toggle source

Tags the thumbnail as DEFAULT_THUMB and removes that tag from all other thumbnail assets of the entry.

Create a new file sync link on the entry thumbnail that points to the thumbnail asset file sync.

@return []

# File lib/kaltura_client.rb, line 4972
def set_as_default(thumb_asset_id)
        kparams = {}
        client.add_param(kparams, 'thumbAssetId', thumb_asset_id)
        client.queue_service_action_call('thumbasset', 'setAsDefault', '', 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 thumbnail asset @return [KalturaThumbAsset]

# File lib/kaltura_client.rb, line 4984
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('thumbasset', 'setContent', 'KalturaThumbAsset', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
update(id, thumb_asset) click to toggle source

Update thumbnail asset @return [KalturaThumbAsset]

# File lib/kaltura_client.rb, line 4997
def update(id, thumb_asset)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'thumbAsset', thumb_asset)
        client.queue_service_action_call('thumbasset', 'update', 'KalturaThumbAsset', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end