Class: Kaltura::KalturaPlaylistService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

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)

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaPlaylistService

Returns a new instance of KalturaPlaylistService.



3676
3677
3678
 
# File 'lib/kaltura_client.rb', line 3676

def initialize(client)
	super(client)
end

Instance Method Details

#add(playlist, update_stats = false) ⇒ KalturaPlaylist

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

Returns:



3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
 
# File 'lib/kaltura_client.rb', line 3683

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) ⇒ KalturaPlaylist

Clone an existing playlist

Returns:



3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
 
# File 'lib/kaltura_client.rb', line 3696

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) ⇒ Object

Delete existing playlist

Returns:



3709
3710
3711
3712
3713
3714
3715
3716
3717
 
# File 'lib/kaltura_client.rb', line 3709

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) ⇒ array

Retrieve playlist for playing purpose

Returns:

  • (array) 


3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
 
# File 'lib/kaltura_client.rb', line 3721

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) ⇒ array

Retrieve playlist for playing purpose, based on content

Returns:

  • (array) 


3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
 
# File 'lib/kaltura_client.rb', line 3737

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) ⇒ array

Retrieve playlist for playing purpose, based on media entry filters

Returns:

  • (array) 


3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
 
# File 'lib/kaltura_client.rb', line 3752

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)) ⇒ KalturaPlaylist

Retrieve a playlist

Returns:



3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
 
# File 'lib/kaltura_client.rb', line 3767

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) ⇒ KalturaPlaylist

Retrieve playlist statistics

Returns:



3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
 
# File 'lib/kaltura_client.rb', line 3780

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) ⇒ KalturaPlaylistListResponse

List available playlists

Returns:



3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
 
# File 'lib/kaltura_client.rb', line 3793

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) ⇒ KalturaPlaylist

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

Returns:



3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
 
# File 'lib/kaltura_client.rb', line 3807

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