velir_kaltura-ruby 0.4.6 → 0.4.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. data/VERSION.yml +1 -1
  2. data/lib/kaltura/constants/access_control_order_by.rb +8 -2
  3. data/lib/kaltura/constants/audio_codec.rb +10 -5
  4. data/lib/kaltura/constants/base.rb +47 -20
  5. data/lib/kaltura/constants/batch_job.rb +74 -49
  6. data/lib/kaltura/constants/bit_rate_mode.rb +8 -2
  7. data/lib/kaltura/constants/category_order_by.rb +12 -6
  8. data/lib/kaltura/constants/commercial_use_type.rb +8 -2
  9. data/lib/kaltura/constants/container_format.rb +15 -9
  10. data/lib/kaltura/constants/control_panel_command.rb +19 -4
  11. data/lib/kaltura/constants/conversion_profile_order_by.rb +8 -2
  12. data/lib/kaltura/constants/country_restriction_type.rb +10 -2
  13. data/lib/kaltura/constants/data_entry_order_by.rb +14 -8
  14. data/lib/kaltura/constants/directory_restriction_type.rb +8 -2
  15. data/lib/kaltura/constants/document.rb +29 -11
  16. data/lib/kaltura/constants/duration_type.rb +10 -4
  17. data/lib/kaltura/constants/editor_type.rb +8 -2
  18. data/lib/kaltura/constants/email_ingestion_profile_status.rb +8 -2
  19. data/lib/kaltura/constants/entry.rb +45 -21
  20. data/lib/kaltura/constants/file_sync.rb +53 -25
  21. data/lib/kaltura/constants/flavor_asset_status.rb +12 -6
  22. data/lib/kaltura/constants/gender.rb +9 -3
  23. data/lib/kaltura/constants/google_syndication_feed.rb +29 -11
  24. data/lib/kaltura/constants/i_tunes_syndication_feed/categories.rb +74 -67
  25. data/lib/kaltura/constants/i_tunes_syndication_feed.rb +30 -12
  26. data/lib/kaltura/constants/license_type.rb +23 -17
  27. data/lib/kaltura/constants/live_stream_admin_entry_order_by.rb +25 -18
  28. data/lib/kaltura/constants/mail_job_order_by.rb +10 -4
  29. data/lib/kaltura/constants/media.rb +44 -25
  30. data/lib/kaltura/constants/mix_entry_order_by.rb +22 -16
  31. data/lib/kaltura/constants/moderation.rb +20 -8
  32. data/lib/kaltura/constants/notification.rb +32 -13
  33. data/lib/kaltura/constants/nullable_boolean.rb +8 -3
  34. data/lib/kaltura/constants/partner.rb +51 -26
  35. data/lib/kaltura/constants/playable_entry_order_by.rb +22 -16
  36. data/lib/kaltura/constants/playlist.rb +24 -11
  37. data/lib/kaltura/constants/report_type.rb +18 -8
  38. data/lib/kaltura/constants/search_provider_type.rb +23 -16
  39. data/lib/kaltura/constants/session_type.rb +8 -2
  40. data/lib/kaltura/constants/site_restriction_type.rb +8 -2
  41. data/lib/kaltura/constants/source_type.rb +11 -5
  42. data/lib/kaltura/constants/stats/kmc_event_type.rb +69 -63
  43. data/lib/kaltura/constants/stats.rb +39 -26
  44. data/lib/kaltura/constants/syndication_feed.rb +26 -6
  45. data/lib/kaltura/constants.rb +15 -2
  46. data/lib/kaltura/kaltura_client_base.rb +3 -1
  47. data/lib/kaltura/service/base_entry_service.rb +1 -1
  48. data/lib/kaltura/service/live_stream_service.rb +49 -3
  49. data/lib/kaltura/service/media_service.rb +401 -4
  50. data/velir_kaltura-ruby.gemspec +2 -2
  51. metadata +4 -4
@@ -1,70 +1,76 @@
1
1
  module Kaltura
2
2
  module Constants
3
3
  module Stats
4
+ ##
5
+ # The constants module will soon be depreciated into an Enumeration module to
6
+ # be more in line with the C# API client's namespacing.
7
+ #
8
+ # @see Kaltura::StatsKmcEvent
9
+ ##
4
10
  class KmcEventType
5
- CONTENT_PAGE_VIEW = 1001
6
- CONTENT_ADD_PLAYLIST = 1010
7
- CONTENT_EDIT_PLAYLIST = 1011
8
- CONTENT_DELETE_PLAYLIST = 1012
9
- CONTENT_DELETE_ITEM = 1058
10
- CONTENT_EDIT_ENTRY = 1013
11
- CONTENT_CHANGE_THUMBNAIL = 1014
12
- CONTENT_ADD_TAGS = 1015
13
- CONTENT_REMOVE_TAGS = 1016
14
- CONTENT_ADD_ADMIN_TAGS = 1017
15
- CONTENT_REMOVE_ADMIN_TAGS = 1018
16
- CONTENT_DOWNLOAD = 1019
17
- CONTENT_APPROVE_MODERATION = 1020
18
- CONTENT_REJECT_MODERATION = 1021
19
- CONTENT_BULK_UPLOAD = 1022
20
- CONTENT_ADMIN_KCW_UPLOAD = 1023
21
- CONTENT_CONTENT_GO_TO_PAGE = 1057
22
- CONTENT_ENTRY_DRILLDOWN = 1088
23
- CONTENT_OPEN_PREVIEW_AND_EMBED = 1089
24
- ACCOUNT_CHANGE_PARTNER_INFO = 1030
25
- ACCOUNT_CHANGE_LOGIN_INFO = 1031
26
- ACCOUNT_CONTACT_US_USAGE = 1032
27
- ACCOUNT_UPDATE_SERVER_SETTINGS = 1033
28
- ACCOUNT_ACCOUNT_OVERVIEW = 1034
29
- ACCOUNT_ACCESS_CONTROL = 1035
30
- ACCOUNT_TRANSCODING_SETTINGS = 1036
31
- ACCOUNT_ACCOUNT_UPGRADE = 1037
32
- ACCOUNT_SAVE_SERVER_SETTINGS = 1038
33
- ACCOUNT_ACCESS_CONTROL_DELETE = 1039
34
- ACCOUNT_SAVE_TRANSCODING_SETTINGS = 1040
35
- LOGIN = 1041
36
- DASHBOARD_IMPORT_CONTENT = 1042
37
- DASHBOARD_UPDATE_CONTENT = 1043
38
- DASHBOARD_ACCOUNT_CONTACT_US = 1044
39
- DASHBOARD_VIEW_REPORTS = 1045
40
- DASHBOARD_EMBED_PLAYER = 1046
41
- DASHBOARD_EMBED_PLAYLIST = 1047
42
- DASHBOARD_CUSTOMIZE_PLAYERS = 1048
43
- APP_STUDIO_NEW_PLAYER_SINGLE_VIDEO = 1050
44
- APP_STUDIO_NEW_PLAYER_PLAYLIST = 1051
45
- APP_STUDIO_NEW_PLAYER_MULTI_TAB_PLAYLIST = 1052
46
- APP_STUDIO_EDIT_PLAYER_SINGLE_VIDEO = 1053
47
- APP_STUDIO_EDIT_PLAYER_PLAYLIST = 1054
48
- APP_STUDIO_EDIT_PLAYER_MULTI_TAB_PLAYLIST = 1055
49
- APP_STUDIO_DUPLICATE_PLAYER = 1056
50
- REPORTS_AND_ANALYTICS_BANDWIDTH_USAGE_TAB = 1070
51
- REPORTS_AND_ANALYTICS_CONTENT_REPORTS_TAB = 1071
52
- REPORTS_AND_ANALYTICS_USERS_AND_COMMUNITY_REPORTS_TAB = 1072
53
- REPORTS_AND_ANALYTICS_TOP_CONTRIBUTORS = 1073
54
- REPORTS_AND_ANALYTICS_MAP_OVERLAYS = 1074
55
- REPORTS_AND_ANALYTICS_TOP_SYNDICATIONS = 1075
56
- REPORTS_AND_ANALYTICS_TOP_CONTENT = 1076
57
- REPORTS_AND_ANALYTICS_CONTENT_DROPOFF = 1077
58
- REPORTS_AND_ANALYTICS_CONTENT_INTERACTIONS = 1078
59
- REPORTS_AND_ANALYTICS_CONTENT_CONTRIBUTIONS = 1079
60
- REPORTS_AND_ANALYTICS_VIDEO_DRILL_DOWN = 1080
61
- REPORTS_AND_ANALYTICS_CONTENT_DRILL_DOWN_INTERACTION = 1081
62
- REPORTS_AND_ANALYTICS_CONTENT_CONTRIBUTIONS_DRILLDOWN = 1082
63
- REPORTS_AND_ANALYTICS_VIDEO_DRILL_DOWN_DROPOFF = 1083
64
- REPORTS_AND_ANALYTICS_MAP_OVERLAYS_DRILLDOWN = 1084
65
- REPORTS_AND_ANALYTICS_TOP_SYNDICATIONS_DRILL_DOWN = 1085
66
- REPORTS_AND_ANALYTICS_BANDWIDTH_USAGE_VIEW_MONTHLY = 1086
67
- REPORTS_AND_ANALYTICS_BANDWIDTH_USAGE_VIEW_YEARLY = 1087
11
+ CONTENT_PAGE_VIEW = 1001 #A page with a KDP widget is viewed.
12
+ CONTENT_ADD_PLAYLIST = 1010 #A playable entry is added to a playlist.
13
+ CONTENT_EDIT_PLAYLIST = 1011 #A playist is edited.
14
+ CONTENT_DELETE_PLAYLIST = 1012 #Content is removed from a playlist.
15
+ CONTENT_DELETE_ITEM = 1058 #A property is removed from an entry.
16
+ CONTENT_EDIT_ENTRY = 1013 #An entry is edited.
17
+ CONTENT_CHANGE_THUMBNAIL = 1014 #An entry's thumbnail is changed.
18
+ CONTENT_ADD_TAGS = 1015 #Tags are added to an entry.
19
+ CONTENT_REMOVE_TAGS = 1016 #Tags are removed from an entry.
20
+ CONTENT_ADD_ADMIN_TAGS = 1017 #Administrative tags are added to an entry.
21
+ CONTENT_REMOVE_ADMIN_TAGS = 1018 #Administrative tags are removed from an entry.
22
+ CONTENT_DOWNLOAD = 1019 #An entry/flavor is downloaded.
23
+ CONTENT_APPROVE_MODERATION = 1020 #An entry is appproved.
24
+ CONTENT_REJECT_MODERATION = 1021 #An entry is rejected.
25
+ CONTENT_BULK_UPLOAD = 1022 #The Batch uploaded use used.
26
+ CONTENT_ADMIN_KCW_UPLOAD = 1023 #The KCW is used to upload content.
27
+ CONTENT_CONTENT_GO_TO_PAGE = 1057 #An entry is clicked, bringing up a detailed menu.
28
+ CONTENT_ENTRY_DRILLDOWN = 1088 #A dropdown is entered from the entry menu.
29
+ CONTENT_OPEN_PREVIEW_AND_EMBED = 1089 #the preview and embed link is clicked.
30
+ ACCOUNT_CHANGE_PARTNER_INFO = 1030 #The accounts API information is changed.
31
+ ACCOUNT_CHANGE_LOGIN_INFO = 1031 #The accounts login information is changed.
32
+ ACCOUNT_CONTACT_US_USAGE = 1032 #The accounts contact information is changed.
33
+ ACCOUNT_UPDATE_SERVER_SETTINGS = 1033 #The accounts server settings are changed.
34
+ ACCOUNT_ACCOUNT_OVERVIEW = 1034 #The account overview settings are changed.
35
+ ACCOUNT_ACCESS_CONTROL = 1035 #The access control for an account is modified.
36
+ ACCOUNT_TRANSCODING_SETTINGS = 1036 #The default transcoding settings are modified.
37
+ ACCOUNT_ACCOUNT_UPGRADE = 1037 #The Account is upgraded/downgraded.
38
+ ACCOUNT_SAVE_SERVER_SETTINGS = 1038 #The Account udpates are saved to the database.
39
+ ACCOUNT_ACCESS_CONTROL_DELETE = 1039 #The account's access has been revoked.
40
+ ACCOUNT_SAVE_TRANSCODING_SETTINGS = 1040 #The accounts encoding settings have been saved to the database.
41
+ LOGIN = 1041 #A KMC login event fires.
42
+ DASHBOARD_IMPORT_CONTENT = 1042 #The content report is brought in on the dashboard.
43
+ DASHBOARD_UPDATE_CONTENT = 1043 #The content report is updated on the dashbaord.
44
+ DASHBOARD_ACCOUNT_CONTACT_US = 1044 #The Dashboard contact settings have changed.
45
+ DASHBOARD_VIEW_REPORTS = 1045 #The view report for the Dashboard is updated.
46
+ DASHBOARD_EMBED_PLAYER = 1046 #The player is embedded on the Dashboard report is updated.
47
+ DASHBOARD_EMBED_PLAYLIST = 1047 #The dashboard playlist is updated.
48
+ DASHBOARD_CUSTOMIZE_PLAYERS = 1048 #The dashboard player is customized.
49
+ APP_STUDIO_NEW_PLAYER_SINGLE_VIDEO = 1050 #A new single video player is created.
50
+ APP_STUDIO_NEW_PLAYER_PLAYLIST = 1051 #A new playlist player is created.
51
+ APP_STUDIO_NEW_PLAYER_MULTI_TAB_PLAYLIST = 1052 #A new multi-tab playlist player is created.
52
+ APP_STUDIO_EDIT_PLAYER_SINGLE_VIDEO = 1053 #A single video player is updated.
53
+ APP_STUDIO_EDIT_PLAYER_PLAYLIST = 1054 #A playlist player is updated.
54
+ APP_STUDIO_EDIT_PLAYER_MULTI_TAB_PLAYLIST = 1055 #A multitab playlist player is updated.
55
+ APP_STUDIO_DUPLICATE_PLAYER = 1056 #A player is duplicated.
56
+ REPORTS_AND_ANALYTICS_BANDWIDTH_USAGE_TAB = 1070 #The bandwidth usage report is updated.
57
+ REPORTS_AND_ANALYTICS_CONTENT_REPORTS_TAB = 1071 #The content reports tab is updated.
58
+ REPORTS_AND_ANALYTICS_USERS_AND_COMMUNITY_REPORTS_TAB = 1072 #The user community report is updated.
59
+ REPORTS_AND_ANALYTICS_TOP_CONTRIBUTORS = 1073 #The top contributors report is updated.
60
+ REPORTS_AND_ANALYTICS_MAP_OVERLAYS = 1074 #The map overlays report is updated.
61
+ REPORTS_AND_ANALYTICS_TOP_SYNDICATIONS = 1075 #The top syndications report is updated.
62
+ REPORTS_AND_ANALYTICS_TOP_CONTENT = 1076 #The top content report is updated.
63
+ REPORTS_AND_ANALYTICS_CONTENT_DROPOFF = 1077 #The content dropoff report is updated.
64
+ REPORTS_AND_ANALYTICS_CONTENT_INTERACTIONS = 1078 #The content intearaction report is updated.
65
+ REPORTS_AND_ANALYTICS_CONTENT_CONTRIBUTIONS = 1079 #The content contributions report is updated.
66
+ REPORTS_AND_ANALYTICS_VIDEO_DRILL_DOWN = 1080 #The dropdowns on the reports section is clicked.
67
+ REPORTS_AND_ANALYTICS_CONTENT_DRILL_DOWN_INTERACTION = 1081 #The dropdown on the report section is used.
68
+ REPORTS_AND_ANALYTICS_CONTENT_CONTRIBUTIONS_DRILLDOWN = 1082 #The content contributions dropdown is selected.
69
+ REPORTS_AND_ANALYTICS_VIDEO_DRILL_DOWN_DROPOFF = 1083 #The content dropoff dropdown is selected.
70
+ REPORTS_AND_ANALYTICS_MAP_OVERLAYS_DRILLDOWN = 1084 #The map overlays dropdown is selected.
71
+ REPORTS_AND_ANALYTICS_TOP_SYNDICATIONS_DRILL_DOWN = 1085 #The top syndications dropdown is selected.
72
+ REPORTS_AND_ANALYTICS_BANDWIDTH_USAGE_VIEW_MONTHLY = 1086 #The monthly bandwith report.
73
+ REPORTS_AND_ANALYTICS_BANDWIDTH_USAGE_VIEW_YEARLY = 1087 #The yearly bandwith report.
68
74
  end
69
75
  end
70
76
  end
@@ -2,34 +2,47 @@ require 'kaltura/constants/stats/kmc_event_type'
2
2
 
3
3
  module Kaltura
4
4
  module Constants
5
+ ##
6
+ # The constants module will soon be depreciated into an Enumeration module to
7
+ # be more in line with the C# API client's namespacing.
8
+ #
9
+ # @see Kaltura::StatsEvent
10
+ # @see Kaltura::StatsKmcEvent
11
+ ##
5
12
  module Stats
13
+ ##
14
+ # The constants module will soon be depreciated into an Enumeration module to
15
+ # be more in line with the C# API client's namespacing.
16
+ #
17
+ # @see Kaltura::StatsEvent
18
+ ##
6
19
  class EventType
7
- WIDGET_LOADED = 1
8
- MEDIA_LOADED = 2
9
- PLAY = 3
10
- PLAY_REACHED_25 = 4
11
- PLAY_REACHED_50 = 5
12
- PLAY_REACHED_75 = 6
13
- PLAY_REACHED_100 = 7
14
- OPEN_EDIT = 8
15
- OPEN_VIRAL = 9
16
- OPEN_DOWNLOAD = 10
17
- OPEN_REPORT = 11
18
- BUFFER_START = 12
19
- BUFFER_END = 13
20
- OPEN_FULL_SCREEN = 14
21
- CLOSE_FULL_SCREEN = 15
22
- REPLAY = 16
23
- SEEK = 17
24
- OPEN_UPLOAD = 18
25
- SAVE_PUBLISH = 19
26
- CLOSE_EDITOR = 20
27
- PRE_BUMPER_PLAYED = 21
28
- POST_BUMPER_PLAYED = 22
29
- BUMPER_CLICKED = 23
30
- FUTURE_USE_1 = 24
31
- FUTURE_USE_2 = 25
32
- FUTURE_USE_3 = 26
20
+ WIDGET_LOADED = 1 #Widget loaded event.
21
+ MEDIA_LOADED = 2 #Media loaded event.
22
+ PLAY = 3 #Play event.
23
+ PLAY_REACHED_25 = 4 #Player has reached 25% completed event.
24
+ PLAY_REACHED_50 = 5 #Player has reached 50% completed event.
25
+ PLAY_REACHED_75 = 6 #Player has reached 75% completed event.
26
+ PLAY_REACHED_100 = 7 #Player has reached 100% completed event.
27
+ OPEN_EDIT = 8 #Editor has been opened event.
28
+ OPEN_VIRAL = 9 #Share button has been clicked.
29
+ OPEN_DOWNLOAD = 10 #Download button has been clicked.
30
+ OPEN_REPORT = 11 #Report has been generated.
31
+ BUFFER_START = 12 #The player has started buffering.
32
+ BUFFER_END = 13 #The player has ended buffering.
33
+ OPEN_FULL_SCREEN = 14 #The fullscreen button has been clicked.
34
+ CLOSE_FULL_SCREEN = 15 #The fullscreen window has been closed.
35
+ REPLAY = 16 #The replay button has been clicked.
36
+ SEEK = 17 #A seek event has fired.
37
+ OPEN_UPLOAD = 18 #A KSU/KCW upload has begun.
38
+ SAVE_PUBLISH = 19 #A KCW/KAE/KSE clip has been saved.
39
+ CLOSE_EDITOR = 20 #A KCW/KAE/KSE clip has been saved.
40
+ PRE_BUMPER_PLAYED = 21 #The ad at the start of the video has played
41
+ POST_BUMPER_PLAYED = 22 #The ad at the end of the video has been played.
42
+ BUMPER_CLICKED = 23 #The ad was clicked.
43
+ FUTURE_USE_1 = 24 #When unicorns rule the earth.
44
+ FUTURE_USE_2 = 25 #Reserved for when twitter gains sentience.
45
+ FUTURE_USE_3 = 26 #Unsure.
33
46
  end
34
47
  end
35
48
  end
@@ -1,16 +1,36 @@
1
1
  module Kaltura
2
2
  module Constants
3
+ ##
4
+ # The constants module will soon be depreciated into an Enumeration module to
5
+ # be more in line with the C# API client's namespacing.
6
+ #
7
+ # @see Kaltura::Service::SyndicationFeedService
8
+ ##
3
9
  module SyndicationFeed
10
+
11
+ ##
12
+ # The constants module will soon be depreciated into an Enumeration module to
13
+ # be more in line with the C# API client's namespacing.
14
+ #
15
+ # @see Kaltura::Service::SyndicationFeedService
16
+ ##
4
17
  class Status
5
- DELETED = -1
6
- ACTIVE = 1
18
+ DELETED = -1 #Deleted Syndication Feed
19
+ ACTIVE = 1 #Active Syndication Feed
7
20
  end
8
21
 
22
+ ##
23
+ # The constants module will soon be depreciated into an Enumeration module to
24
+ # be more in line with the C# API client's namespacing.
25
+ #
26
+ # @see Kaltura::Filter::ITunesSyndicationFeedFilter
27
+ # @see Kaltura::Service::SyndicationFeedService
28
+ ##
9
29
  class Type
10
- GOOGLE_VIDEO = 1
11
- YAHOO = 2
12
- ITUNES = 3
13
- TUBE_MOGUL = 4
30
+ GOOGLE_VIDEO = 1 #GoogleVideoSyndicationFeed
31
+ YAHOO = 2 #YahooSyndicationFeed
32
+ ITUNES = 3 #ITunesSyndicationFeed
33
+ TUBE_MOGUL = 4 #TubeMogulSyndicationFeed
14
34
  end
15
35
  end
16
36
  end
@@ -49,14 +49,27 @@ require 'kaltura/constants/widget'
49
49
  require 'kaltura/constants/yahoo_syndication_feed'
50
50
 
51
51
  module Kaltura
52
+ ##
53
+ # The constants module will soon be depreciated into an Enumeration module to
54
+ # be more in line with the C# API client's namespacing.
55
+ ##
52
56
  module Constants
53
-
57
+
58
+ ##
59
+ # @deprecated This class has no constants.
60
+ ##
54
61
  class FlavorParamsOrderBy
55
62
  end
56
63
 
64
+ ##
65
+ # @deprecated This class has no constants.
66
+ ##
57
67
  class FlavorParamsOutputOrderBy
58
68
  end
59
-
69
+
70
+ ##
71
+ # @deprecated This class has no constants.
72
+ ##
60
73
  class MediaInfoOrderBy
61
74
  end
62
75
 
@@ -282,7 +282,9 @@ module Kaltura
282
282
  request.gsub("Kaltura","")
283
283
  end
284
284
  def self.request_is_response?(request)
285
- request == request.split("Response",0).to_s
285
+ request_array = []
286
+ request_array << request
287
+ request_array == request.split("Response",0)
286
288
  end
287
289
  end
288
290
 
@@ -316,7 +316,7 @@ module Kaltura
316
316
  # @param [Kaltura::EntryContextDataParams] context_data_params The only field not inherited from Kaltura::ObjectBase
317
317
  # is referrer, so I imagine that is what you should set.
318
318
  #
319
- # @return [Kaltura::EntryConextDataResult] Returns some context info, including is the entry restricted by country or session.
319
+ # @return [Kaltura::EntryContextDataResult] Returns some context info, including is the entry restricted by country or session.
320
320
  #
321
321
  # @raise [Kaltura::APIError] Raises default Kaltura errors.
322
322
  ##
@@ -53,7 +53,12 @@ module Kaltura
53
53
  # Like all of the other Kaltura API update actions it is best to instantiate a new LiveStreamAdminEntry object
54
54
  # instead of pulling the existing one and updating its fields.
55
55
  #
56
- # @param [String] The
56
+ # @param [String] entry_id The live stream entry ID.
57
+ # @param [Kaltura::LiveStreamEntry] live_stream_entry A LiveStreamEntry object with the fields you wish to update populated.
58
+ #
59
+ # @return [Kaltura::LiveStreamEntry] Returns the entry_id with the updated fields. It will also bump the version.
60
+ #
61
+ # @raise [Kaltura::APIError] Raises 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist.
57
62
  #
58
63
  ##
59
64
  def update(entry_id, live_stream_entry)
@@ -63,19 +68,49 @@ module Kaltura
63
68
  perform_request('liveStream','update',kparams,false)
64
69
  end
65
70
 
71
+ ##
72
+ # Deletes a live stream entry object.
73
+ #
74
+ # @param [String] entry_id The live stream entry ID.
75
+ #
76
+ # @return [nil] Returns nothing
77
+ #
78
+ # @raise [Kaltura::APIError] Raises 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist.
79
+ ##
66
80
  def delete(entry_id)
67
81
  kparams = {}
68
82
  client.add_param(kparams, 'entryId', entry_id)
69
83
  perform_request('liveStream','delete',kparams,false)
70
84
  end
71
-
85
+
86
+ ##
87
+ # Lists live streams by the filter with paging support for large sets of live streams.
88
+ #
89
+ # @param [Kaltura::Filter::LiveStreamEntryFilter] The live stream filter is a wrapper for Kaltura::Filter::MediaEntryFilter
90
+ # @param [Kaltura::FilterPager] The default Kaltura pager.
91
+ #
92
+ # @return [Kaltura::Response::LiveStreamListResponse] This is a wrapper for Kaltura::Response::BaseRespsone.
93
+ #
94
+ # @raise [Kaltura::APIError] Raises default Kaltura API errors.
95
+ ##
72
96
  def list(filter=nil, pager=nil)
73
97
  kparams = {}
74
98
  client.add_param(kparams, 'filter', filter)
75
99
  client.add_param(kparams, 'pager', pager)
76
100
  perform_request('liveStream','list',kparams,false)
77
101
  end
78
-
102
+
103
+ ##
104
+ # Updates the live stream entries offline thumbnail using a raw jpgeg file.
105
+ #
106
+ # @param [String] entry_id The live stream entry ID.
107
+ # @param [File] file_data The JPEG file to use as the stream is offline backdrop.
108
+ #
109
+ # @return [Kaltura::LiveStreamEntry] The live stream entry with the updated thumbnail and version.
110
+ #
111
+ # @raise [Kaltura::APIError] Raises default Kaltura errors plus 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist and
112
+ # 'PERMISSION_DENIED_TO_UPDATE_ENTRY' if the user is does not own the live stream and isn't an administrator.
113
+ ##
79
114
  def update_offline_thumbnail_jpeg(entry_id, file_data)
80
115
  kparams = {}
81
116
  client.add_param(kparams, 'entryId', entry_id)
@@ -83,6 +118,17 @@ module Kaltura
83
118
  perform_request('liveStream','updateOfflineThumbnailJpeg',kparams,false)
84
119
  end
85
120
 
121
+ ##
122
+ # Updates the live stream entries offline thumbnail using a URL.
123
+ #
124
+ # @param [String] entry_id The live stream entry ID.
125
+ # @param [File] url The URL to a JPEG file to use as the stream is offline backdrop.
126
+ #
127
+ # @return [Kaltura::LiveStreamEntry] The live stream entry with the updated thumbnail and version.
128
+ #
129
+ # @raise [Kaltura::APIError] Raises default Kaltura errors plus 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist and
130
+ # 'PERMISSION_DENIED_TO_UPDATE_ENTRY' if the user is does not own the live stream and isn't an administrator.
131
+ ##
86
132
  def update_offline_thumbnail_from_url(entry_id, url)
87
133
  kparams = {}
88
134
  client.add_param(kparams, 'entryId', entry_id)