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 (baseed 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.



3569
3570
3571
 
# File 'lib/kaltura_client.rb', line 3569

def initialize(client)
	super(client)
end

Instance Method Details

#add(playlist, update_stats = false) ⇒ Object

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



3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
 
# File 'lib/kaltura_client.rb', line 3576

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

Clone an existing playlist



3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
 
# File 'lib/kaltura_client.rb', line 3629

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



3617
3618
3619
3620
3621
3622
3623
3624
3625
 
# File 'lib/kaltura_client.rb', line 3617

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

Retrieve playlist for playing purpose



3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
 
# File 'lib/kaltura_client.rb', line 3655

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', 'array', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#execute_from_content(playlist_type, playlist_content, detailed = '', pager = KalturaNotImplemented) ⇒ Object

Retrieve playlist for playing purpose, based on content



3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
 
# File 'lib/kaltura_client.rb', line 3671

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', 'array', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#execute_from_filters(filters, total_results, detailed = '1', pager = KalturaNotImplemented) ⇒ Object

Revrieve playlist for playing purpose, based on media entry filters



3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
 
# File 'lib/kaltura_client.rb', line 3686

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', 'array', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get(id, version = -1)) ⇒ Object

Retrieve a playlist



3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
 
# File 'lib/kaltura_client.rb', line 3589

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

Retrieve playlist statistics



3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
 
# File 'lib/kaltura_client.rb', line 3701

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

List available playlists



3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
 
# File 'lib/kaltura_client.rb', line 3642

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

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



3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
 
# File 'lib/kaltura_client.rb', line 3603

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