mux_ruby 1.4.0 → 1.8.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/Gemfile +2 -1
- data/Gemfile.lock +37 -35
- data/README.md +6 -1
- data/docs/Asset.md +3 -1
- data/docs/AssetNonStandardInputReasons.md +16 -0
- data/docs/AssetRecordingTimes.md +9 -0
- data/docs/CreateAssetRequest.md +1 -1
- data/docs/CreateLiveStreamRequest.md +2 -0
- data/docs/CreateUploadRequest.md +1 -0
- data/docs/DimensionValue.md +9 -0
- data/docs/DimensionsApi.md +118 -0
- data/docs/DisableLiveStreamResponse.md +8 -0
- data/docs/EnableLiveStreamResponse.md +8 -0
- data/docs/FiltersApi.md +2 -2
- data/docs/GetRealTimeBreakdownResponse.md +10 -0
- data/docs/GetRealTimeHistogramTimeseriesResponse.md +11 -0
- data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +8 -0
- data/docs/GetRealTimeTimeseriesResponse.md +10 -0
- data/docs/Incident.md +28 -0
- data/docs/IncidentBreakdown.md +10 -0
- data/docs/IncidentNotification.md +10 -0
- data/docs/IncidentNotificationRule.md +12 -0
- data/docs/IncidentResponse.md +9 -0
- data/docs/IncidentsApi.md +186 -0
- data/docs/ListDimensionValuesResponse.md +10 -0
- data/docs/ListDimensionsResponse.md +10 -0
- data/docs/ListIncidentsResponse.md +10 -0
- data/docs/ListRealTimeDimensionsResponse.md +10 -0
- data/docs/ListRealTimeDimensionsResponseData.md +9 -0
- data/docs/ListRealTimeMetricsResponse.md +10 -0
- data/docs/ListRelatedIncidentsResponse.md +10 -0
- data/docs/LiveStream.md +2 -1
- data/docs/LiveStreamsApi.md +104 -0
- data/docs/NotificationRule.md +10 -0
- data/docs/RealTimeApi.md +280 -0
- data/docs/RealTimeBreakdownValue.md +12 -0
- data/docs/RealTimeHistogramTimeseriesBucket.md +9 -0
- data/docs/RealTimeHistogramTimeseriesBucketValues.md +9 -0
- data/docs/RealTimeHistogramTimeseriesDatapoint.md +14 -0
- data/docs/RealTimeTimeseriesDatapoint.md +10 -0
- data/docs/Upload.md +1 -0
- data/docs/VideoView.md +16 -14
- data/examples/data/exercise-dimensions.rb +29 -0
- data/examples/data/exercise-errors.rb +1 -1
- data/examples/data/exercise-incidents.rb +29 -0
- data/examples/data/exercise-realtime.rb +60 -0
- data/examples/video/exercise-live-streams.rb +22 -0
- data/lib/mux_ruby.rb +30 -0
- data/lib/mux_ruby/api/dimensions_api.rb +128 -0
- data/lib/mux_ruby/api/filters_api.rb +4 -4
- data/lib/mux_ruby/api/incidents_api.rb +217 -0
- data/lib/mux_ruby/api/live_streams_api.rb +106 -0
- data/lib/mux_ruby/api/real_time_api.rb +311 -0
- data/lib/mux_ruby/api_client.rb +1 -1
- data/lib/mux_ruby/configuration.rb +1 -4
- data/lib/mux_ruby/models/asset.rb +46 -13
- data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +335 -0
- data/lib/mux_ruby/models/asset_recording_times.rb +195 -0
- data/lib/mux_ruby/models/asset_static_renditions_files.rb +4 -4
- data/lib/mux_ruby/models/create_asset_request.rb +13 -13
- data/lib/mux_ruby/models/create_live_stream_request.rb +24 -4
- data/lib/mux_ruby/models/create_upload_request.rb +13 -4
- data/lib/mux_ruby/models/dimension_value.rb +193 -0
- data/lib/mux_ruby/models/disable_live_stream_response.rb +184 -0
- data/lib/mux_ruby/models/enable_live_stream_response.rb +184 -0
- data/lib/mux_ruby/models/get_real_time_breakdown_response.rb +206 -0
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +215 -0
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +186 -0
- data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +206 -0
- data/lib/mux_ruby/models/incident.rb +370 -0
- data/lib/mux_ruby/models/incident_breakdown.rb +202 -0
- data/lib/mux_ruby/models/incident_notification.rb +202 -0
- data/lib/mux_ruby/models/incident_notification_rule.rb +222 -0
- data/lib/mux_ruby/models/incident_response.rb +195 -0
- data/lib/mux_ruby/models/input_settings_overlay_settings.rb +46 -0
- data/lib/mux_ruby/models/list_dimension_values_response.rb +206 -0
- data/lib/mux_ruby/models/list_dimensions_response.rb +204 -0
- data/lib/mux_ruby/models/list_incidents_response.rb +206 -0
- data/lib/mux_ruby/models/list_real_time_dimensions_response.rb +206 -0
- data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +193 -0
- data/lib/mux_ruby/models/list_real_time_metrics_response.rb +206 -0
- data/lib/mux_ruby/models/list_related_incidents_response.rb +206 -0
- data/lib/mux_ruby/models/live_stream.rb +14 -5
- data/lib/mux_ruby/models/notification_rule.rb +202 -0
- data/lib/mux_ruby/models/real_time_breakdown_value.rb +220 -0
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +193 -0
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +193 -0
- data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +240 -0
- data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +202 -0
- data/lib/mux_ruby/models/upload.rb +13 -4
- data/lib/mux_ruby/models/video_view.rb +36 -18
- data/lib/mux_ruby/version.rb +1 -1
- data/spec/api/dimensions_api_spec.rb +55 -0
- data/spec/api/filters_api_spec.rb +2 -2
- data/spec/api/incidents_api_spec.rb +73 -0
- data/spec/api/live_streams_api_spec.rb +24 -0
- data/spec/api/real_time_api_spec.rb +93 -0
- data/spec/models/asset_non_standard_input_reasons_spec.rb +98 -0
- data/spec/models/asset_recording_times_spec.rb +40 -0
- data/spec/models/asset_spec.rb +22 -6
- data/spec/models/asset_static_renditions_files_spec.rb +2 -2
- data/spec/models/create_asset_request_spec.rb +6 -6
- data/spec/models/create_live_stream_request_spec.rb +12 -0
- data/spec/models/create_upload_request_spec.rb +6 -0
- data/spec/models/dimension_value_spec.rb +40 -0
- data/spec/models/disable_live_stream_response_spec.rb +34 -0
- data/spec/models/enable_live_stream_response_spec.rb +34 -0
- data/spec/models/get_real_time_breakdown_response_spec.rb +46 -0
- data/spec/models/get_real_time_histogram_timeseries_response_meta_spec.rb +34 -0
- data/spec/models/get_real_time_histogram_timeseries_response_spec.rb +52 -0
- data/spec/models/get_real_time_timeseries_response_spec.rb +46 -0
- data/spec/models/incident_breakdown_spec.rb +46 -0
- data/spec/models/incident_notification_rule_spec.rb +58 -0
- data/spec/models/incident_notification_spec.rb +46 -0
- data/spec/models/incident_response_spec.rb +40 -0
- data/spec/models/incident_spec.rb +154 -0
- data/spec/models/input_settings_overlay_settings_spec.rb +8 -0
- data/spec/models/list_dimension_values_response_spec.rb +46 -0
- data/spec/models/list_dimensions_response_spec.rb +46 -0
- data/spec/models/list_incidents_response_spec.rb +46 -0
- data/spec/models/list_real_time_dimensions_response_data_spec.rb +40 -0
- data/spec/models/list_real_time_dimensions_response_spec.rb +46 -0
- data/spec/models/list_real_time_metrics_response_spec.rb +46 -0
- data/spec/models/list_related_incidents_response_spec.rb +46 -0
- data/spec/models/live_stream_spec.rb +6 -0
- data/spec/models/notification_rule_spec.rb +46 -0
- data/spec/models/real_time_breakdown_value_spec.rb +58 -0
- data/spec/models/real_time_histogram_timeseries_bucket_spec.rb +40 -0
- data/spec/models/real_time_histogram_timeseries_bucket_values_spec.rb +40 -0
- data/spec/models/real_time_histogram_timeseries_datapoint_spec.rb +70 -0
- data/spec/models/real_time_timeseries_datapoint_spec.rb +46 -0
- data/spec/models/upload_spec.rb +6 -0
- data/spec/models/video_view_spec.rb +12 -0
- data/test.sh +28 -0
- metadata +181 -58
data/docs/RealTimeApi.md
ADDED
@@ -0,0 +1,280 @@
|
|
1
|
+
# MuxRuby::RealTimeApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.mux.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_realtime_breakdown**](RealTimeApi.md#get_realtime_breakdown) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown | Get Real-Time Breakdown
|
8
|
+
[**get_realtime_histogram_timeseries**](RealTimeApi.md#get_realtime_histogram_timeseries) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/histogram-timeseries | Get Real-Time Histogram Timeseries
|
9
|
+
[**get_realtime_timeseries**](RealTimeApi.md#get_realtime_timeseries) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries | Get Real-Time Timeseries
|
10
|
+
[**list_realtime_dimensions**](RealTimeApi.md#list_realtime_dimensions) | **GET** /data/v1/realtime/dimensions | List Real-Time Dimensions
|
11
|
+
[**list_realtime_metrics**](RealTimeApi.md#list_realtime_metrics) | **GET** /data/v1/realtime/metrics | List Real-Time Metrics
|
12
|
+
|
13
|
+
|
14
|
+
# **get_realtime_breakdown**
|
15
|
+
> GetRealTimeBreakdownResponse get_realtime_breakdown(realtime_metric_id, opts)
|
16
|
+
|
17
|
+
Get Real-Time Breakdown
|
18
|
+
|
19
|
+
Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.
|
20
|
+
|
21
|
+
### Example
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'mux_ruby'
|
25
|
+
# setup authorization
|
26
|
+
MuxRuby.configure do |config|
|
27
|
+
# Configure HTTP basic authorization: accessToken
|
28
|
+
config.username = 'YOUR USERNAME'
|
29
|
+
config.password = 'YOUR PASSWORD'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = MuxRuby::RealTimeApi.new
|
33
|
+
realtime_metric_id = 'video-startup-time' # String | ID of the Realtime Metric
|
34
|
+
opts = {
|
35
|
+
dimension: 'dimension_example', # String | Dimension the specified value belongs to
|
36
|
+
timestamp: 3.4, # Float | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
|
37
|
+
filters: ['filters_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
|
38
|
+
order_by: 'order_by_example', # String | Value to order the results by
|
39
|
+
order_direction: 'order_direction_example' # String | Sort order.
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
#Get Real-Time Breakdown
|
44
|
+
result = api_instance.get_realtime_breakdown(realtime_metric_id, opts)
|
45
|
+
p result
|
46
|
+
rescue MuxRuby::ApiError => e
|
47
|
+
puts "Exception when calling RealTimeApi->get_realtime_breakdown: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
### Parameters
|
52
|
+
|
53
|
+
Name | Type | Description | Notes
|
54
|
+
------------- | ------------- | ------------- | -------------
|
55
|
+
**realtime_metric_id** | **String**| ID of the Realtime Metric |
|
56
|
+
**dimension** | **String**| Dimension the specified value belongs to | [optional]
|
57
|
+
**timestamp** | **Float**| Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional]
|
58
|
+
**filters** | [**Array<String>**](String.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional]
|
59
|
+
**order_by** | **String**| Value to order the results by | [optional]
|
60
|
+
**order_direction** | **String**| Sort order. | [optional]
|
61
|
+
|
62
|
+
### Return type
|
63
|
+
|
64
|
+
[**GetRealTimeBreakdownResponse**](GetRealTimeBreakdownResponse.md)
|
65
|
+
|
66
|
+
### Authorization
|
67
|
+
|
68
|
+
[accessToken](../README.md#accessToken)
|
69
|
+
|
70
|
+
### HTTP request headers
|
71
|
+
|
72
|
+
- **Content-Type**: Not defined
|
73
|
+
- **Accept**: application/json
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
# **get_realtime_histogram_timeseries**
|
78
|
+
> GetRealTimeHistogramTimeseriesResponse get_realtime_histogram_timeseries(realtime_metric_id, opts)
|
79
|
+
|
80
|
+
Get Real-Time Histogram Timeseries
|
81
|
+
|
82
|
+
Gets histogram timeseries information for a specific metric.
|
83
|
+
|
84
|
+
### Example
|
85
|
+
```ruby
|
86
|
+
# load the gem
|
87
|
+
require 'mux_ruby'
|
88
|
+
# setup authorization
|
89
|
+
MuxRuby.configure do |config|
|
90
|
+
# Configure HTTP basic authorization: accessToken
|
91
|
+
config.username = 'YOUR USERNAME'
|
92
|
+
config.password = 'YOUR PASSWORD'
|
93
|
+
end
|
94
|
+
|
95
|
+
api_instance = MuxRuby::RealTimeApi.new
|
96
|
+
realtime_metric_id = 'video-startup-time' # String | ID of the Realtime Metric
|
97
|
+
opts = {
|
98
|
+
filters: ['filters_example'] # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
|
99
|
+
}
|
100
|
+
|
101
|
+
begin
|
102
|
+
#Get Real-Time Histogram Timeseries
|
103
|
+
result = api_instance.get_realtime_histogram_timeseries(realtime_metric_id, opts)
|
104
|
+
p result
|
105
|
+
rescue MuxRuby::ApiError => e
|
106
|
+
puts "Exception when calling RealTimeApi->get_realtime_histogram_timeseries: #{e}"
|
107
|
+
end
|
108
|
+
```
|
109
|
+
|
110
|
+
### Parameters
|
111
|
+
|
112
|
+
Name | Type | Description | Notes
|
113
|
+
------------- | ------------- | ------------- | -------------
|
114
|
+
**realtime_metric_id** | **String**| ID of the Realtime Metric |
|
115
|
+
**filters** | [**Array<String>**](String.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional]
|
116
|
+
|
117
|
+
### Return type
|
118
|
+
|
119
|
+
[**GetRealTimeHistogramTimeseriesResponse**](GetRealTimeHistogramTimeseriesResponse.md)
|
120
|
+
|
121
|
+
### Authorization
|
122
|
+
|
123
|
+
[accessToken](../README.md#accessToken)
|
124
|
+
|
125
|
+
### HTTP request headers
|
126
|
+
|
127
|
+
- **Content-Type**: Not defined
|
128
|
+
- **Accept**: application/json
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
# **get_realtime_timeseries**
|
133
|
+
> GetRealTimeTimeseriesResponse get_realtime_timeseries(realtime_metric_id, opts)
|
134
|
+
|
135
|
+
Get Real-Time Timeseries
|
136
|
+
|
137
|
+
Gets Time series information for a specific metric along with the number of concurrent viewers.
|
138
|
+
|
139
|
+
### Example
|
140
|
+
```ruby
|
141
|
+
# load the gem
|
142
|
+
require 'mux_ruby'
|
143
|
+
# setup authorization
|
144
|
+
MuxRuby.configure do |config|
|
145
|
+
# Configure HTTP basic authorization: accessToken
|
146
|
+
config.username = 'YOUR USERNAME'
|
147
|
+
config.password = 'YOUR PASSWORD'
|
148
|
+
end
|
149
|
+
|
150
|
+
api_instance = MuxRuby::RealTimeApi.new
|
151
|
+
realtime_metric_id = 'video-startup-time' # String | ID of the Realtime Metric
|
152
|
+
opts = {
|
153
|
+
filters: ['filters_example'] # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
|
154
|
+
}
|
155
|
+
|
156
|
+
begin
|
157
|
+
#Get Real-Time Timeseries
|
158
|
+
result = api_instance.get_realtime_timeseries(realtime_metric_id, opts)
|
159
|
+
p result
|
160
|
+
rescue MuxRuby::ApiError => e
|
161
|
+
puts "Exception when calling RealTimeApi->get_realtime_timeseries: #{e}"
|
162
|
+
end
|
163
|
+
```
|
164
|
+
|
165
|
+
### Parameters
|
166
|
+
|
167
|
+
Name | Type | Description | Notes
|
168
|
+
------------- | ------------- | ------------- | -------------
|
169
|
+
**realtime_metric_id** | **String**| ID of the Realtime Metric |
|
170
|
+
**filters** | [**Array<String>**](String.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional]
|
171
|
+
|
172
|
+
### Return type
|
173
|
+
|
174
|
+
[**GetRealTimeTimeseriesResponse**](GetRealTimeTimeseriesResponse.md)
|
175
|
+
|
176
|
+
### Authorization
|
177
|
+
|
178
|
+
[accessToken](../README.md#accessToken)
|
179
|
+
|
180
|
+
### HTTP request headers
|
181
|
+
|
182
|
+
- **Content-Type**: Not defined
|
183
|
+
- **Accept**: application/json
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
# **list_realtime_dimensions**
|
188
|
+
> ListRealTimeDimensionsResponse list_realtime_dimensions
|
189
|
+
|
190
|
+
List Real-Time Dimensions
|
191
|
+
|
192
|
+
Lists availiable real-time dimensions
|
193
|
+
|
194
|
+
### Example
|
195
|
+
```ruby
|
196
|
+
# load the gem
|
197
|
+
require 'mux_ruby'
|
198
|
+
# setup authorization
|
199
|
+
MuxRuby.configure do |config|
|
200
|
+
# Configure HTTP basic authorization: accessToken
|
201
|
+
config.username = 'YOUR USERNAME'
|
202
|
+
config.password = 'YOUR PASSWORD'
|
203
|
+
end
|
204
|
+
|
205
|
+
api_instance = MuxRuby::RealTimeApi.new
|
206
|
+
|
207
|
+
begin
|
208
|
+
#List Real-Time Dimensions
|
209
|
+
result = api_instance.list_realtime_dimensions
|
210
|
+
p result
|
211
|
+
rescue MuxRuby::ApiError => e
|
212
|
+
puts "Exception when calling RealTimeApi->list_realtime_dimensions: #{e}"
|
213
|
+
end
|
214
|
+
```
|
215
|
+
|
216
|
+
### Parameters
|
217
|
+
This endpoint does not need any parameter.
|
218
|
+
|
219
|
+
### Return type
|
220
|
+
|
221
|
+
[**ListRealTimeDimensionsResponse**](ListRealTimeDimensionsResponse.md)
|
222
|
+
|
223
|
+
### Authorization
|
224
|
+
|
225
|
+
[accessToken](../README.md#accessToken)
|
226
|
+
|
227
|
+
### HTTP request headers
|
228
|
+
|
229
|
+
- **Content-Type**: Not defined
|
230
|
+
- **Accept**: application/json
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
# **list_realtime_metrics**
|
235
|
+
> ListRealTimeMetricsResponse list_realtime_metrics
|
236
|
+
|
237
|
+
List Real-Time Metrics
|
238
|
+
|
239
|
+
Lists availiable real-time metrics.
|
240
|
+
|
241
|
+
### Example
|
242
|
+
```ruby
|
243
|
+
# load the gem
|
244
|
+
require 'mux_ruby'
|
245
|
+
# setup authorization
|
246
|
+
MuxRuby.configure do |config|
|
247
|
+
# Configure HTTP basic authorization: accessToken
|
248
|
+
config.username = 'YOUR USERNAME'
|
249
|
+
config.password = 'YOUR PASSWORD'
|
250
|
+
end
|
251
|
+
|
252
|
+
api_instance = MuxRuby::RealTimeApi.new
|
253
|
+
|
254
|
+
begin
|
255
|
+
#List Real-Time Metrics
|
256
|
+
result = api_instance.list_realtime_metrics
|
257
|
+
p result
|
258
|
+
rescue MuxRuby::ApiError => e
|
259
|
+
puts "Exception when calling RealTimeApi->list_realtime_metrics: #{e}"
|
260
|
+
end
|
261
|
+
```
|
262
|
+
|
263
|
+
### Parameters
|
264
|
+
This endpoint does not need any parameter.
|
265
|
+
|
266
|
+
### Return type
|
267
|
+
|
268
|
+
[**ListRealTimeMetricsResponse**](ListRealTimeMetricsResponse.md)
|
269
|
+
|
270
|
+
### Authorization
|
271
|
+
|
272
|
+
[accessToken](../README.md#accessToken)
|
273
|
+
|
274
|
+
### HTTP request headers
|
275
|
+
|
276
|
+
- **Content-Type**: Not defined
|
277
|
+
- **Accept**: application/json
|
278
|
+
|
279
|
+
|
280
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# MuxRuby::RealTimeBreakdownValue
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**value** | **String** | | [optional]
|
7
|
+
**negative_impact** | **Integer** | | [optional]
|
8
|
+
**metric_value** | **Float** | | [optional]
|
9
|
+
**display_value** | **String** | | [optional]
|
10
|
+
**concurent_viewers** | **Integer** | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# MuxRuby::RealTimeHistogramTimeseriesDatapoint
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**timestamp** | **String** | | [optional]
|
7
|
+
**sum** | **Integer** | | [optional]
|
8
|
+
**p95** | **Float** | | [optional]
|
9
|
+
**median** | **Float** | | [optional]
|
10
|
+
**max_percentage** | **Float** | | [optional]
|
11
|
+
**bucket_values** | [**Array<RealTimeHistogramTimeseriesBucketValues>**](RealTimeHistogramTimeseriesBucketValues.md) | | [optional]
|
12
|
+
**average** | **Float** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# MuxRuby::RealTimeTimeseriesDatapoint
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**value** | **Float** | | [optional]
|
7
|
+
**date** | **String** | | [optional]
|
8
|
+
**concurent_viewers** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/Upload.md
CHANGED
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
|
|
11
11
|
**error** | [**UploadError**](UploadError.md) | | [optional]
|
12
12
|
**cors_origin** | **String** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional]
|
13
13
|
**url** | **String** | The URL to upload the associated source media to. | [optional]
|
14
|
+
**test** | **BOOLEAN** | | [optional]
|
14
15
|
|
15
16
|
|
data/docs/VideoView.md
CHANGED
@@ -11,22 +11,22 @@ Name | Type | Description | Notes
|
|
11
11
|
**preroll_requested** | **BOOLEAN** | | [optional]
|
12
12
|
**page_type** | **String** | | [optional]
|
13
13
|
**startup_score** | **String** | | [optional]
|
14
|
-
**view_seek_duration** | **
|
14
|
+
**view_seek_duration** | **Integer** | | [optional]
|
15
15
|
**country_name** | **String** | | [optional]
|
16
16
|
**player_source_height** | **Integer** | | [optional]
|
17
17
|
**longitude** | **String** | | [optional]
|
18
|
-
**buffering_count** | **
|
19
|
-
**video_duration** | **
|
18
|
+
**buffering_count** | **Integer** | | [optional]
|
19
|
+
**video_duration** | **Integer** | | [optional]
|
20
20
|
**player_source_type** | **String** | | [optional]
|
21
21
|
**city** | **String** | | [optional]
|
22
22
|
**view_id** | **String** | | [optional]
|
23
23
|
**platform_description** | **String** | | [optional]
|
24
|
-
**video_startup_preroll_request_time** | **
|
24
|
+
**video_startup_preroll_request_time** | **Integer** | | [optional]
|
25
25
|
**viewer_device_name** | **String** | | [optional]
|
26
26
|
**video_series** | **String** | | [optional]
|
27
27
|
**viewer_application_name** | **String** | | [optional]
|
28
28
|
**updated_at** | **String** | | [optional]
|
29
|
-
**view_total_content_playback_time** | **
|
29
|
+
**view_total_content_playback_time** | **Integer** | | [optional]
|
30
30
|
**cdn** | **String** | | [optional]
|
31
31
|
**player_instance_id** | **String** | | [optional]
|
32
32
|
**video_language** | **String** | | [optional]
|
@@ -37,8 +37,8 @@ Name | Type | Description | Notes
|
|
37
37
|
**playback_score** | **String** | | [optional]
|
38
38
|
**page_url** | **String** | | [optional]
|
39
39
|
**metro** | **String** | | [optional]
|
40
|
-
**view_max_request_latency** | **
|
41
|
-
**requests_for_first_preroll** | **
|
40
|
+
**view_max_request_latency** | **Integer** | | [optional]
|
41
|
+
**requests_for_first_preroll** | **Integer** | | [optional]
|
42
42
|
**view_total_downscaling** | **String** | | [optional]
|
43
43
|
**latitude** | **String** | | [optional]
|
44
44
|
**player_source_host_name** | **String** | | [optional]
|
@@ -48,7 +48,7 @@ Name | Type | Description | Notes
|
|
48
48
|
**player_language** | **String** | | [optional]
|
49
49
|
**page_load_time** | **Integer** | | [optional]
|
50
50
|
**viewer_device_category** | **String** | | [optional]
|
51
|
-
**video_startup_preroll_load_time** | **
|
51
|
+
**video_startup_preroll_load_time** | **Integer** | | [optional]
|
52
52
|
**player_version** | **String** | | [optional]
|
53
53
|
**watch_time** | **Integer** | | [optional]
|
54
54
|
**player_source_stream_type** | **String** | | [optional]
|
@@ -58,14 +58,14 @@ Name | Type | Description | Notes
|
|
58
58
|
**experiment_name** | **String** | | [optional]
|
59
59
|
**viewer_os_version** | **String** | | [optional]
|
60
60
|
**player_preload** | **BOOLEAN** | | [optional]
|
61
|
-
**buffering_duration** | **
|
61
|
+
**buffering_duration** | **Integer** | | [optional]
|
62
62
|
**player_view_count** | **Integer** | | [optional]
|
63
63
|
**player_software** | **String** | | [optional]
|
64
|
-
**player_load_time** | **
|
64
|
+
**player_load_time** | **Integer** | | [optional]
|
65
65
|
**platform_summary** | **String** | | [optional]
|
66
66
|
**video_encoding_variant** | **String** | | [optional]
|
67
67
|
**player_width** | **Integer** | | [optional]
|
68
|
-
**view_seek_count** | **
|
68
|
+
**view_seek_count** | **Integer** | | [optional]
|
69
69
|
**viewer_experience_score** | **String** | | [optional]
|
70
70
|
**view_error_id** | **Integer** | | [optional]
|
71
71
|
**video_variant_name** | **String** | | [optional]
|
@@ -77,7 +77,7 @@ Name | Type | Description | Notes
|
|
77
77
|
**events** | [**Array<VideoViewEvent>**](VideoViewEvent.md) | | [optional]
|
78
78
|
**player_name** | **String** | | [optional]
|
79
79
|
**view_start** | **String** | | [optional]
|
80
|
-
**view_average_request_throughput** | **
|
80
|
+
**view_average_request_throughput** | **Integer** | | [optional]
|
81
81
|
**video_producer** | **String** | | [optional]
|
82
82
|
**error_type_id** | **Integer** | | [optional]
|
83
83
|
**mux_viewer_id** | **String** | | [optional]
|
@@ -88,7 +88,7 @@ Name | Type | Description | Notes
|
|
88
88
|
**video_content_type** | **String** | | [optional]
|
89
89
|
**viewer_os_family** | **String** | | [optional]
|
90
90
|
**player_poster** | **String** | | [optional]
|
91
|
-
**view_average_request_latency** | **
|
91
|
+
**view_average_request_latency** | **Integer** | | [optional]
|
92
92
|
**video_variant_id** | **String** | | [optional]
|
93
93
|
**player_source_duration** | **Integer** | | [optional]
|
94
94
|
**player_source_url** | **String** | | [optional]
|
@@ -97,7 +97,7 @@ Name | Type | Description | Notes
|
|
97
97
|
**id** | **String** | | [optional]
|
98
98
|
**short_time** | **String** | | [optional]
|
99
99
|
**rebuffer_percentage** | **String** | | [optional]
|
100
|
-
**time_to_first_frame** | **
|
100
|
+
**time_to_first_frame** | **Integer** | | [optional]
|
101
101
|
**viewer_user_id** | **String** | | [optional]
|
102
102
|
**video_stream_type** | **String** | | [optional]
|
103
103
|
**player_startup_time** | **Integer** | | [optional]
|
@@ -111,7 +111,9 @@ Name | Type | Description | Notes
|
|
111
111
|
**player_autoplay** | **BOOLEAN** | | [optional]
|
112
112
|
**player_height** | **Integer** | | [optional]
|
113
113
|
**asn** | **Integer** | | [optional]
|
114
|
+
**asn_name** | **String** | | [optional]
|
114
115
|
**quality_score** | **String** | | [optional]
|
115
116
|
**player_software_version** | **String** | | [optional]
|
117
|
+
**player_mux_plugin_name** | **String** | | [optional]
|
116
118
|
|
117
119
|
|