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.



3792
3793
3794
 
# File 'lib/kaltura_client.rb', line 3792

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:



3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
 
# File 'lib/kaltura_client.rb', line 3799

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:



3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
 
# File 'lib/kaltura_client.rb', line 3812

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:



3825
3826
3827
3828
3829
3830
3831
3832
3833
 
# File 'lib/kaltura_client.rb', line 3825

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) 


3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
 
# File 'lib/kaltura_client.rb', line 3837

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) 


3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
 
# File 'lib/kaltura_client.rb', line 3853

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) 


3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
 
# File 'lib/kaltura_client.rb', line 3868

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:



3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
 
# File 'lib/kaltura_client.rb', line 3883

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:



3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
 
# File 'lib/kaltura_client.rb', line 3896

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:



3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
 
# File 'lib/kaltura_client.rb', line 3909

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:



3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
 
# File 'lib/kaltura_client.rb', line 3923

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