class Kaltura::KalturaSearchService

Search service allows you to search for media in various media providers

This service is being used mostly by the CW component

Public Class Methods

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

Public Instance Methods

external_login(search_source, user_name, password) click to toggle source

@return [KalturaSearchAuthData]

# File lib/kaltura_client.rb, line 4189
def external_login(search_source, user_name, password)
        kparams = {}
        client.add_param(kparams, 'searchSource', search_source)
        client.add_param(kparams, 'userName', user_name)
        client.add_param(kparams, 'password', password)
        client.queue_service_action_call('search', 'externalLogin', 'KalturaSearchAuthData', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get_media_info(search_result) click to toggle source

Retrieve extra information about media found in search action

Some providers return only part of the fields needed to create entry from, use this action to get the rest of the fields.

@return [KalturaSearchResult]

# File lib/kaltura_client.rb, line 4204
def get_media_info(search_result)
        kparams = {}
        client.add_param(kparams, 'searchResult', search_result)
        client.queue_service_action_call('search', 'getMediaInfo', 'KalturaSearchResult', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
search_url(media_type, url) click to toggle source

Search for media given a specific URL

Kaltura supports a searchURL action on some of the media providers.
This action will return a KalturaSearchResult object based on a given URL (assuming the media provider is supported)

@return [KalturaSearchResult]

# File lib/kaltura_client.rb, line 4231
def search_url(media_type, url)
        kparams = {}
        client.add_param(kparams, 'mediaType', media_type)
        client.add_param(kparams, 'url', url)
        client.queue_service_action_call('search', 'searchUrl', 'KalturaSearchResult', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end