class Kaltura::KalturaPlaylistService

Playlist service lets you create,manage and play your playlists

Playlists could be static (containing a fixed list of entries) or dynamic (based on a filter)

Public Class Methods

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

Public Instance Methods

add(playlist, update_stats=false) click to toggle source

Add new playlist

Note that all entries used in a playlist will become public and may appear in KalturaNetwork

@return [KalturaPlaylist]

# File lib/kaltura_client.rb, line 3776
def add(playlist, update_stats=false)
        kparams = {}
        client.add_param(kparams, 'playlist', playlist)
        client.add_param(kparams, 'updateStats', update_stats)
        client.queue_service_action_call('playlist', 'add', 'KalturaPlaylist', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
clone(id, new_playlist=KalturaNotImplemented) click to toggle source

Clone an existing playlist @return [KalturaPlaylist]

# File lib/kaltura_client.rb, line 3789
def clone(id, new_playlist=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'newPlaylist', new_playlist)
        client.queue_service_action_call('playlist', 'clone', 'KalturaPlaylist', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
delete(id) click to toggle source

Delete existing playlist @return []

# File lib/kaltura_client.rb, line 3802
def delete(id)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.queue_service_action_call('playlist', 'delete', '', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
execute(id, detailed='', playlist_context=KalturaNotImplemented, filter=KalturaNotImplemented, pager=KalturaNotImplemented) click to toggle source

Retrieve playlist for playing purpose @return [array]

# File lib/kaltura_client.rb, line 3814
def execute(id, detailed='', playlist_context=KalturaNotImplemented, filter=KalturaNotImplemented, pager=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'detailed', detailed)
        client.add_param(kparams, 'playlistContext', playlist_context)
        client.add_param(kparams, 'filter', filter)
        client.add_param(kparams, 'pager', pager)
        client.queue_service_action_call('playlist', 'execute', 'KalturaBaseEntry', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
execute_from_content(playlist_type, playlist_content, detailed='', pager=KalturaNotImplemented) click to toggle source

Retrieve playlist for playing purpose, based on content @return [array]

# File lib/kaltura_client.rb, line 3830
def execute_from_content(playlist_type, playlist_content, detailed='', pager=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'playlistType', playlist_type)
        client.add_param(kparams, 'playlistContent', playlist_content)
        client.add_param(kparams, 'detailed', detailed)
        client.add_param(kparams, 'pager', pager)
        client.queue_service_action_call('playlist', 'executeFromContent', 'KalturaBaseEntry', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
execute_from_filters(filters, total_results, detailed='1', pager=KalturaNotImplemented) click to toggle source

Retrieve playlist for playing purpose, based on media entry filters @return [array]

# File lib/kaltura_client.rb, line 3845
def execute_from_filters(filters, total_results, detailed='1', pager=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'filters', filters)
        client.add_param(kparams, 'totalResults', total_results)
        client.add_param(kparams, 'detailed', detailed)
        client.add_param(kparams, 'pager', pager)
        client.queue_service_action_call('playlist', 'executeFromFilters', 'KalturaBaseEntry', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get(id, version=-1) click to toggle source

Retrieve a playlist @return [KalturaPlaylist]

# File lib/kaltura_client.rb, line 3860
def get(id, version=-1)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'version', version)
        client.queue_service_action_call('playlist', 'get', 'KalturaPlaylist', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get_stats_from_content(playlist_type, playlist_content) click to toggle source

Retrieve playlist statistics @return [KalturaPlaylist]

# File lib/kaltura_client.rb, line 3873
def get_stats_from_content(playlist_type, playlist_content)
        kparams = {}
        client.add_param(kparams, 'playlistType', playlist_type)
        client.add_param(kparams, 'playlistContent', playlist_content)
        client.queue_service_action_call('playlist', 'getStatsFromContent', 'KalturaPlaylist', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) click to toggle source

List available playlists @return [KalturaPlaylistListResponse]

# File lib/kaltura_client.rb, line 3886
def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'filter', filter)
        client.add_param(kparams, 'pager', pager)
        client.queue_service_action_call('playlist', 'list', 'KalturaPlaylistListResponse', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
update(id, playlist, update_stats=false) click to toggle source

Update existing playlist

Note - you cannot change playlist type. Updated playlist must be of the same type.

@return [KalturaPlaylist]

# File lib/kaltura_client.rb, line 3900
def update(id, playlist, update_stats=false)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'playlist', playlist)
        client.add_param(kparams, 'updateStats', update_stats)
        client.queue_service_action_call('playlist', 'update', 'KalturaPlaylist', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end