mux_ruby 1.0.0 → 1.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +3 -0
- data/docs/Asset.md +1 -0
- data/docs/AssetsApi.md +103 -0
- data/docs/CreateAssetRequest.md +2 -0
- data/docs/CreateLiveStreamRequest.md +3 -0
- data/docs/CreateSimulcastTargetRequest.md +10 -0
- data/docs/CreateTrackRequest.md +14 -0
- data/docs/CreateTrackResponse.md +8 -0
- data/docs/DeliveryReport.md +14 -0
- data/docs/DeliveryUsageApi.md +68 -0
- data/docs/GetMetricTimeseriesDataResponse.md +1 -1
- data/docs/GetOverallValuesResponse.md +1 -1
- data/docs/InputSettings.md +6 -1
- data/docs/InputTrack.md +0 -2
- data/docs/Insight.md +2 -2
- data/docs/ListAllMetricValuesResponse.md +1 -1
- data/docs/ListBreakdownValuesResponse.md +1 -1
- data/docs/ListDeliveryUsageResponse.md +11 -0
- data/docs/ListErrorsResponse.md +1 -1
- data/docs/ListExportsResponse.md +1 -1
- data/docs/ListFilterValuesResponse.md +1 -1
- data/docs/ListFiltersResponse.md +1 -1
- data/docs/ListInsightsResponse.md +1 -1
- data/docs/ListVideoViewsResponse.md +1 -1
- data/docs/LiveStream.md +2 -0
- data/docs/LiveStreamsApi.md +161 -0
- data/docs/SigningKeyResponse.md +1 -1
- data/docs/SimulcastTarget.md +12 -0
- data/docs/SimulcastTargetResponse.md +8 -0
- data/docs/Track.md +5 -2
- data/docs/VideoViewResponse.md +1 -1
- data/examples/data/exercise-errors.rb +1 -1
- data/examples/data/exercise-metrics.rb +0 -7
- data/examples/video/exercise-assets.rb +17 -1
- data/examples/video/exercise-delivery-usage.rb +23 -0
- data/examples/video/exercise-live-streams.rb +28 -1
- data/lib/mux_ruby/api/assets_api.rb +113 -0
- data/lib/mux_ruby/api/delivery_usage_api.rb +75 -0
- data/lib/mux_ruby/api/live_streams_api.rb +176 -0
- data/lib/mux_ruby/api_client.rb +1 -1
- data/lib/mux_ruby/models/asset.rb +12 -1
- data/lib/mux_ruby/models/create_asset_request.rb +37 -4
- data/lib/mux_ruby/models/create_live_stream_request.rb +57 -4
- data/lib/mux_ruby/models/create_simulcast_target_request.rb +210 -0
- data/lib/mux_ruby/models/create_track_request.rb +304 -0
- data/lib/mux_ruby/models/create_track_response.rb +184 -0
- data/lib/mux_ruby/models/delivery_report.rb +238 -0
- data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb +1 -1
- data/lib/mux_ruby/models/get_overall_values_response.rb +1 -1
- data/lib/mux_ruby/models/input_settings.rb +104 -13
- data/lib/mux_ruby/models/input_track.rb +4 -22
- data/lib/mux_ruby/models/insight.rb +2 -2
- data/lib/mux_ruby/models/list_all_metric_values_response.rb +1 -1
- data/lib/mux_ruby/models/list_breakdown_values_response.rb +1 -1
- data/lib/mux_ruby/models/list_delivery_usage_response.rb +216 -0
- data/lib/mux_ruby/models/list_errors_response.rb +1 -1
- data/lib/mux_ruby/models/list_exports_response.rb +1 -1
- data/lib/mux_ruby/models/list_filter_values_response.rb +1 -1
- data/lib/mux_ruby/models/list_filters_response.rb +1 -1
- data/lib/mux_ruby/models/list_insights_response.rb +1 -1
- data/lib/mux_ruby/models/list_video_views_response.rb +1 -1
- data/lib/mux_ruby/models/live_stream.rb +24 -4
- data/lib/mux_ruby/models/simulcast_target.rb +259 -0
- data/lib/mux_ruby/models/simulcast_target_response.rb +184 -0
- data/lib/mux_ruby/models/track.rb +86 -13
- data/lib/mux_ruby/models/video_view_response.rb +1 -1
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +8 -0
- data/spec/api/assets_api_spec.rb +24 -0
- data/spec/api/delivery_usage_api_spec.rb +43 -0
- data/spec/api/live_streams_api_spec.rb +39 -0
- data/spec/models/asset_spec.rb +6 -0
- data/spec/models/create_asset_request_spec.rb +16 -0
- data/spec/models/create_live_stream_request_spec.rb +18 -0
- data/spec/models/create_simulcast_target_request_spec.rb +46 -0
- data/spec/models/create_track_request_spec.rb +78 -0
- data/spec/models/create_track_response_spec.rb +34 -0
- data/spec/models/delivery_report_spec.rb +70 -0
- data/spec/models/input_settings_spec.rb +40 -2
- data/spec/models/input_track_spec.rb +0 -12
- data/spec/models/list_delivery_usage_response_spec.rb +52 -0
- data/spec/models/live_stream_spec.rb +12 -0
- data/spec/models/simulcast_target_response_spec.rb +34 -0
- data/spec/models/simulcast_target_spec.rb +62 -0
- data/spec/models/track_spec.rb +28 -2
- metadata +36 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f54c81eda311319dcb3ecb87261150d576027836
|
4
|
+
data.tar.gz: c100c8433cce1376dcb8581f4f1791b3d148fcaf
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9072b2431fa45ae5b2b09661bb6ef3da8f49ca67483a391d141b29598a3171614af8e1e95903315a83beb74a83cbdd35a946aab4f21bea4b2d03ee94054d881f
|
7
|
+
data.tar.gz: 463ec30fbd8811ed46aa196c402202c8e80edf97c92591e1da06e244f8c727182a9f456bca5449a2a93f8a05c1dfd9187068fcd58b85e5a76486b6459d9e5971
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -112,10 +112,13 @@ All errors inherit from `ApiError`, you can catch it or you can catch one of the
|
|
112
112
|
[Be sure to check out the documentation in the `docs` directory.](docs/)
|
113
113
|
|
114
114
|
## Issues
|
115
|
+
|
115
116
|
If you run into problems, [please raise a GitHub issue,](https://github.com/muxinc/mux-ruby/issues) filling in the issue template. We'll take a look as soon as possible.
|
116
117
|
|
117
118
|
## Contributing
|
119
|
+
|
118
120
|
Please do not submit PRs against this package. It is generated from our OpenAPI definitions - [Please open an issue instead!](https://github.com/muxinc/mux-ruby/issues)
|
119
121
|
|
120
122
|
## License
|
123
|
+
|
121
124
|
[MIT License.](LICENSE) Copyright 2019 Mux, Inc.
|
data/docs/Asset.md
CHANGED
@@ -22,6 +22,7 @@ Name | Type | Description | Notes
|
|
22
22
|
**master** | [**AssetMaster**](AssetMaster.md) | | [optional]
|
23
23
|
**master_access** | **String** | | [optional] [default to 'none']
|
24
24
|
**mp4_support** | **String** | | [optional] [default to 'none']
|
25
|
+
**normalize_audio** | **BOOLEAN** | | [optional] [default to false]
|
25
26
|
**static_renditions** | [**AssetStaticRenditions**](AssetStaticRenditions.md) | | [optional]
|
26
27
|
|
27
28
|
|
data/docs/AssetsApi.md
CHANGED
@@ -6,8 +6,10 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**create_asset**](AssetsApi.md#create_asset) | **POST** /video/v1/assets | Create an asset
|
8
8
|
[**create_asset_playback_id**](AssetsApi.md#create_asset_playback_id) | **POST** /video/v1/assets/{ASSET_ID}/playback-ids | Create a playback ID
|
9
|
+
[**create_asset_track**](AssetsApi.md#create_asset_track) | **POST** /video/v1/assets/{ASSET_ID}/tracks | Create an asset track
|
9
10
|
[**delete_asset**](AssetsApi.md#delete_asset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset
|
10
11
|
[**delete_asset_playback_id**](AssetsApi.md#delete_asset_playback_id) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID
|
12
|
+
[**delete_asset_track**](AssetsApi.md#delete_asset_track) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track
|
11
13
|
[**get_asset**](AssetsApi.md#get_asset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset
|
12
14
|
[**get_asset_input_info**](AssetsApi.md#get_asset_input_info) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info
|
13
15
|
[**get_asset_playback_id**](AssetsApi.md#get_asset_playback_id) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID
|
@@ -117,6 +119,57 @@ Name | Type | Description | Notes
|
|
117
119
|
|
118
120
|
|
119
121
|
|
122
|
+
# **create_asset_track**
|
123
|
+
> CreateTrackResponse create_asset_track(asset_id, create_track_request)
|
124
|
+
|
125
|
+
Create an asset track
|
126
|
+
|
127
|
+
### Example
|
128
|
+
```ruby
|
129
|
+
# load the gem
|
130
|
+
require 'mux_ruby'
|
131
|
+
# setup authorization
|
132
|
+
MuxRuby.configure do |config|
|
133
|
+
# Configure HTTP basic authorization: accessToken
|
134
|
+
config.username = 'YOUR USERNAME'
|
135
|
+
config.password = 'YOUR PASSWORD'
|
136
|
+
end
|
137
|
+
|
138
|
+
api_instance = MuxRuby::AssetsApi.new
|
139
|
+
asset_id = 'asset_id_example' # String | The asset ID.
|
140
|
+
create_track_request = MuxRuby::CreateTrackRequest.new # CreateTrackRequest |
|
141
|
+
|
142
|
+
begin
|
143
|
+
#Create an asset track
|
144
|
+
result = api_instance.create_asset_track(asset_id, create_track_request)
|
145
|
+
p result
|
146
|
+
rescue MuxRuby::ApiError => e
|
147
|
+
puts "Exception when calling AssetsApi->create_asset_track: #{e}"
|
148
|
+
end
|
149
|
+
```
|
150
|
+
|
151
|
+
### Parameters
|
152
|
+
|
153
|
+
Name | Type | Description | Notes
|
154
|
+
------------- | ------------- | ------------- | -------------
|
155
|
+
**asset_id** | **String**| The asset ID. |
|
156
|
+
**create_track_request** | [**CreateTrackRequest**](CreateTrackRequest.md)| |
|
157
|
+
|
158
|
+
### Return type
|
159
|
+
|
160
|
+
[**CreateTrackResponse**](CreateTrackResponse.md)
|
161
|
+
|
162
|
+
### Authorization
|
163
|
+
|
164
|
+
[accessToken](../README.md#accessToken)
|
165
|
+
|
166
|
+
### HTTP request headers
|
167
|
+
|
168
|
+
- **Content-Type**: application/json
|
169
|
+
- **Accept**: application/json
|
170
|
+
|
171
|
+
|
172
|
+
|
120
173
|
# **delete_asset**
|
121
174
|
> delete_asset(asset_id)
|
122
175
|
|
@@ -215,6 +268,56 @@ nil (empty response body)
|
|
215
268
|
|
216
269
|
|
217
270
|
|
271
|
+
# **delete_asset_track**
|
272
|
+
> delete_asset_track(asset_id, track_id)
|
273
|
+
|
274
|
+
Delete an asset track
|
275
|
+
|
276
|
+
### Example
|
277
|
+
```ruby
|
278
|
+
# load the gem
|
279
|
+
require 'mux_ruby'
|
280
|
+
# setup authorization
|
281
|
+
MuxRuby.configure do |config|
|
282
|
+
# Configure HTTP basic authorization: accessToken
|
283
|
+
config.username = 'YOUR USERNAME'
|
284
|
+
config.password = 'YOUR PASSWORD'
|
285
|
+
end
|
286
|
+
|
287
|
+
api_instance = MuxRuby::AssetsApi.new
|
288
|
+
asset_id = 'asset_id_example' # String | The asset ID.
|
289
|
+
track_id = 'track_id_example' # String | The track ID.
|
290
|
+
|
291
|
+
begin
|
292
|
+
#Delete an asset track
|
293
|
+
api_instance.delete_asset_track(asset_id, track_id)
|
294
|
+
rescue MuxRuby::ApiError => e
|
295
|
+
puts "Exception when calling AssetsApi->delete_asset_track: #{e}"
|
296
|
+
end
|
297
|
+
```
|
298
|
+
|
299
|
+
### Parameters
|
300
|
+
|
301
|
+
Name | Type | Description | Notes
|
302
|
+
------------- | ------------- | ------------- | -------------
|
303
|
+
**asset_id** | **String**| The asset ID. |
|
304
|
+
**track_id** | **String**| The track ID. |
|
305
|
+
|
306
|
+
### Return type
|
307
|
+
|
308
|
+
nil (empty response body)
|
309
|
+
|
310
|
+
### Authorization
|
311
|
+
|
312
|
+
[accessToken](../README.md#accessToken)
|
313
|
+
|
314
|
+
### HTTP request headers
|
315
|
+
|
316
|
+
- **Content-Type**: Not defined
|
317
|
+
- **Accept**: Not defined
|
318
|
+
|
319
|
+
|
320
|
+
|
218
321
|
# **get_asset**
|
219
322
|
> AssetResponse get_asset(asset_id)
|
220
323
|
|
data/docs/CreateAssetRequest.md
CHANGED
@@ -9,5 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**per_title_encode** | **BOOLEAN** | | [optional]
|
10
10
|
**passthrough** | **String** | | [optional]
|
11
11
|
**mp4_support** | **String** | | [optional]
|
12
|
+
**normalize_audio** | **BOOLEAN** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to false]
|
13
|
+
**master_access** | **String** | | [optional]
|
12
14
|
|
13
15
|
|
@@ -5,5 +5,8 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | | [optional]
|
7
7
|
**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional]
|
8
|
+
**reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Defaults to 60 seconds on the API if not specified. | [optional]
|
9
|
+
**passthrough** | **String** | | [optional]
|
10
|
+
**reduced_latency** | **BOOLEAN** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. Note: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional]
|
8
11
|
|
9
12
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# MuxRuby::CreateSimulcastTargetRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**passthrough** | **String** | Arbitrary metadata set by you when creating a simulcast target. | [optional]
|
7
|
+
**stream_key** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional]
|
8
|
+
**url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: 'rtmp://live.example.com/app'. |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# MuxRuby::CreateTrackRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**url** | **String** | |
|
7
|
+
**type** | **String** | |
|
8
|
+
**text_type** | **String** | |
|
9
|
+
**language_code** | **String** | |
|
10
|
+
**name** | **String** | | [optional]
|
11
|
+
**closed_captions** | **BOOLEAN** | | [optional]
|
12
|
+
**passthrough** | **String** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# MuxRuby::DeliveryReport
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**live_stream_id** | **String** | | [optional]
|
7
|
+
**asset_id** | **String** | | [optional]
|
8
|
+
**passthrough** | **String** | | [optional]
|
9
|
+
**created_at** | **String** | | [optional]
|
10
|
+
**asset_state** | **String** | | [optional]
|
11
|
+
**asset_duration** | **Float** | | [optional]
|
12
|
+
**delivered_seconds** | **Float** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,68 @@
|
|
1
|
+
# MuxRuby::DeliveryUsageApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.mux.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**list_delivery_usage**](DeliveryUsageApi.md#list_delivery_usage) | **GET** /video/v1/delivery-usage | List Usage
|
8
|
+
|
9
|
+
|
10
|
+
# **list_delivery_usage**
|
11
|
+
> ListDeliveryUsageResponse list_delivery_usage(opts)
|
12
|
+
|
13
|
+
List Usage
|
14
|
+
|
15
|
+
Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs.
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'mux_ruby'
|
21
|
+
# setup authorization
|
22
|
+
MuxRuby.configure do |config|
|
23
|
+
# Configure HTTP basic authorization: accessToken
|
24
|
+
config.username = 'YOUR USERNAME'
|
25
|
+
config.password = 'YOUR PASSWORD'
|
26
|
+
end
|
27
|
+
|
28
|
+
api_instance = MuxRuby::DeliveryUsageApi.new
|
29
|
+
opts = {
|
30
|
+
page: 1, # Integer | Offset by this many pages, of the size of `limit`
|
31
|
+
limit: 100, # Integer | Number of items to include in the response
|
32
|
+
asset_id: 'asset_id_example', # String | Filter response to return delivery usage for this asset only.
|
33
|
+
timeframe: ['timeframe_example'] # Array<String> | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.
|
34
|
+
}
|
35
|
+
|
36
|
+
begin
|
37
|
+
#List Usage
|
38
|
+
result = api_instance.list_delivery_usage(opts)
|
39
|
+
p result
|
40
|
+
rescue MuxRuby::ApiError => e
|
41
|
+
puts "Exception when calling DeliveryUsageApi->list_delivery_usage: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
Name | Type | Description | Notes
|
48
|
+
------------- | ------------- | ------------- | -------------
|
49
|
+
**page** | **Integer**| Offset by this many pages, of the size of `limit` | [optional] [default to 1]
|
50
|
+
**limit** | **Integer**| Number of items to include in the response | [optional] [default to 100]
|
51
|
+
**asset_id** | **String**| Filter response to return delivery usage for this asset only. | [optional]
|
52
|
+
**timeframe** | [**Array<String>**](String.md)| Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. | [optional]
|
53
|
+
|
54
|
+
### Return type
|
55
|
+
|
56
|
+
[**ListDeliveryUsageResponse**](ListDeliveryUsageResponse.md)
|
57
|
+
|
58
|
+
### Authorization
|
59
|
+
|
60
|
+
[accessToken](../README.md#accessToken)
|
61
|
+
|
62
|
+
### HTTP request headers
|
63
|
+
|
64
|
+
- **Content-Type**: Not defined
|
65
|
+
- **Accept**: application/json
|
66
|
+
|
67
|
+
|
68
|
+
|
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**data** | **Array<Array<String>>** | | [optional]
|
7
7
|
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<
|
8
|
+
**timeframe** | **Array<Integer>** | | [optional]
|
9
9
|
|
10
10
|
|
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**data** | [**OverallValues**](OverallValues.md) | | [optional]
|
7
7
|
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<
|
8
|
+
**timeframe** | **Array<Integer>** | | [optional]
|
9
9
|
|
10
10
|
|
data/docs/InputSettings.md
CHANGED
@@ -4,7 +4,12 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**url** | **String** | | [optional]
|
7
|
-
**language** | **String** | | [optional]
|
8
7
|
**overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) | | [optional]
|
8
|
+
**type** | **String** | | [optional]
|
9
|
+
**text_type** | **String** | | [optional]
|
10
|
+
**language_code** | **String** | | [optional]
|
11
|
+
**name** | **String** | | [optional]
|
12
|
+
**closed_captions** | **BOOLEAN** | | [optional]
|
13
|
+
**passthrough** | **String** | | [optional]
|
9
14
|
|
10
15
|
|
data/docs/InputTrack.md
CHANGED
@@ -12,7 +12,5 @@ Name | Type | Description | Notes
|
|
12
12
|
**sample_rate** | **Integer** | | [optional]
|
13
13
|
**sample_size** | **Integer** | | [optional]
|
14
14
|
**channels** | **Integer** | | [optional]
|
15
|
-
**text_track_type** | **String** | | [optional]
|
16
|
-
**language** | **String** | | [optional]
|
17
15
|
|
18
16
|
|
data/docs/Insight.md
CHANGED
@@ -5,8 +5,8 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**total_watch_time** | **Integer** | | [optional]
|
7
7
|
**total_views** | **Integer** | | [optional]
|
8
|
-
**negative_impact_score** | **
|
9
|
-
**metric** | **
|
8
|
+
**negative_impact_score** | **Float** | | [optional]
|
9
|
+
**metric** | **Float** | | [optional]
|
10
10
|
**filter_value** | **String** | | [optional]
|
11
11
|
**filter_column** | **String** | | [optional]
|
12
12
|
|
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**data** | [**Array<Score>**](Score.md) | | [optional]
|
7
7
|
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<
|
8
|
+
**timeframe** | **Array<Integer>** | | [optional]
|
9
9
|
|
10
10
|
|
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**data** | [**Array<BreakdownValue>**](BreakdownValue.md) | | [optional]
|
7
7
|
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<
|
8
|
+
**timeframe** | **Array<Integer>** | | [optional]
|
9
9
|
|
10
10
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# MuxRuby::ListDeliveryUsageResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**data** | [**Array<DeliveryReport>**](DeliveryReport.md) | | [optional]
|
7
|
+
**total_row_count** | **Integer** | | [optional]
|
8
|
+
**timeframe** | **Array<Integer>** | | [optional]
|
9
|
+
**limit** | **Integer** | Number of assets returned in this response. Default value is 100. | [optional]
|
10
|
+
|
11
|
+
|
data/docs/ListErrorsResponse.md
CHANGED
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**data** | [**Array<Error>**](Error.md) | | [optional]
|
7
7
|
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<
|
8
|
+
**timeframe** | **Array<Integer>** | | [optional]
|
9
9
|
|
10
10
|
|
data/docs/ListExportsResponse.md
CHANGED
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**data** | **Array<String>** | | [optional]
|
7
7
|
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<
|
8
|
+
**timeframe** | **Array<Integer>** | | [optional]
|
9
9
|
|
10
10
|
|
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**data** | [**Array<FilterValue>**](FilterValue.md) | | [optional]
|
7
7
|
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<
|
8
|
+
**timeframe** | **Array<Integer>** | | [optional]
|
9
9
|
|
10
10
|
|
data/docs/ListFiltersResponse.md
CHANGED
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**data** | [**ListFiltersResponseData**](ListFiltersResponseData.md) | | [optional]
|
7
7
|
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<
|
8
|
+
**timeframe** | **Array<Integer>** | | [optional]
|
9
9
|
|
10
10
|
|
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**data** | [**Array<Insight>**](Insight.md) | | [optional]
|
7
7
|
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<
|
8
|
+
**timeframe** | **Array<Integer>** | | [optional]
|
9
9
|
|
10
10
|
|
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**data** | [**Array<AbridgedVideoView>**](AbridgedVideoView.md) | | [optional]
|
7
7
|
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<
|
8
|
+
**timeframe** | **Array<Integer>** | | [optional]
|
9
9
|
|
10
10
|
|
data/docs/LiveStream.md
CHANGED
@@ -13,5 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
**new_asset_settings** | [**Asset**](Asset.md) | | [optional]
|
14
14
|
**passthrough** | **String** | | [optional]
|
15
15
|
**reconnect_window** | **Float** | | [optional]
|
16
|
+
**reduced_latency** | **BOOLEAN** | | [optional]
|
17
|
+
**simulcast_targets** | [**Array<SimulcastTarget>**](SimulcastTarget.md) | | [optional]
|
16
18
|
|
17
19
|
|
data/docs/LiveStreamsApi.md
CHANGED
@@ -6,9 +6,12 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**create_live_stream**](LiveStreamsApi.md#create_live_stream) | **POST** /video/v1/live-streams | Create a live stream
|
8
8
|
[**create_live_stream_playback_id**](LiveStreamsApi.md#create_live_stream_playback_id) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids | Create a live stream playback ID
|
9
|
+
[**create_live_stream_simulcast_target**](LiveStreamsApi.md#create_live_stream_simulcast_target) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets | Create a live stream simulcast target
|
9
10
|
[**delete_live_stream**](LiveStreamsApi.md#delete_live_stream) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID} | Delete a live stream
|
10
11
|
[**delete_live_stream_playback_id**](LiveStreamsApi.md#delete_live_stream_playback_id) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Delete a live stream playback ID
|
12
|
+
[**delete_live_stream_simulcast_target**](LiveStreamsApi.md#delete_live_stream_simulcast_target) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Delete a Live Stream Simulcast Target
|
11
13
|
[**get_live_stream**](LiveStreamsApi.md#get_live_stream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream
|
14
|
+
[**get_live_stream_simulcast_target**](LiveStreamsApi.md#get_live_stream_simulcast_target) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Retrieve a Live Stream Simulcast Target
|
12
15
|
[**list_live_streams**](LiveStreamsApi.md#list_live_streams) | **GET** /video/v1/live-streams | List live streams
|
13
16
|
[**reset_stream_key**](LiveStreamsApi.md#reset_stream_key) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream’s stream key
|
14
17
|
[**signal_live_stream_complete**](LiveStreamsApi.md#signal_live_stream_complete) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/complete | Signal a live stream is finished
|
@@ -114,6 +117,59 @@ Name | Type | Description | Notes
|
|
114
117
|
|
115
118
|
|
116
119
|
|
120
|
+
# **create_live_stream_simulcast_target**
|
121
|
+
> SimulcastTargetResponse create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)
|
122
|
+
|
123
|
+
Create a live stream simulcast target
|
124
|
+
|
125
|
+
Create a simulcast target for the parent live stream. Simulcast target can only be created when the parent live stream is in idle state. Only one simulcast target can be created at a time with this API.
|
126
|
+
|
127
|
+
### Example
|
128
|
+
```ruby
|
129
|
+
# load the gem
|
130
|
+
require 'mux_ruby'
|
131
|
+
# setup authorization
|
132
|
+
MuxRuby.configure do |config|
|
133
|
+
# Configure HTTP basic authorization: accessToken
|
134
|
+
config.username = 'YOUR USERNAME'
|
135
|
+
config.password = 'YOUR PASSWORD'
|
136
|
+
end
|
137
|
+
|
138
|
+
api_instance = MuxRuby::LiveStreamsApi.new
|
139
|
+
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
140
|
+
create_simulcast_target_request = MuxRuby::CreateSimulcastTargetRequest.new # CreateSimulcastTargetRequest |
|
141
|
+
|
142
|
+
begin
|
143
|
+
#Create a live stream simulcast target
|
144
|
+
result = api_instance.create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)
|
145
|
+
p result
|
146
|
+
rescue MuxRuby::ApiError => e
|
147
|
+
puts "Exception when calling LiveStreamsApi->create_live_stream_simulcast_target: #{e}"
|
148
|
+
end
|
149
|
+
```
|
150
|
+
|
151
|
+
### Parameters
|
152
|
+
|
153
|
+
Name | Type | Description | Notes
|
154
|
+
------------- | ------------- | ------------- | -------------
|
155
|
+
**live_stream_id** | **String**| The live stream ID |
|
156
|
+
**create_simulcast_target_request** | [**CreateSimulcastTargetRequest**](CreateSimulcastTargetRequest.md)| |
|
157
|
+
|
158
|
+
### Return type
|
159
|
+
|
160
|
+
[**SimulcastTargetResponse**](SimulcastTargetResponse.md)
|
161
|
+
|
162
|
+
### Authorization
|
163
|
+
|
164
|
+
[accessToken](../README.md#accessToken)
|
165
|
+
|
166
|
+
### HTTP request headers
|
167
|
+
|
168
|
+
- **Content-Type**: application/json
|
169
|
+
- **Accept**: application/json
|
170
|
+
|
171
|
+
|
172
|
+
|
117
173
|
# **delete_live_stream**
|
118
174
|
> delete_live_stream(live_stream_id)
|
119
175
|
|
@@ -212,6 +268,58 @@ nil (empty response body)
|
|
212
268
|
|
213
269
|
|
214
270
|
|
271
|
+
# **delete_live_stream_simulcast_target**
|
272
|
+
> delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
273
|
+
|
274
|
+
Delete a Live Stream Simulcast Target
|
275
|
+
|
276
|
+
Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state.
|
277
|
+
|
278
|
+
### Example
|
279
|
+
```ruby
|
280
|
+
# load the gem
|
281
|
+
require 'mux_ruby'
|
282
|
+
# setup authorization
|
283
|
+
MuxRuby.configure do |config|
|
284
|
+
# Configure HTTP basic authorization: accessToken
|
285
|
+
config.username = 'YOUR USERNAME'
|
286
|
+
config.password = 'YOUR PASSWORD'
|
287
|
+
end
|
288
|
+
|
289
|
+
api_instance = MuxRuby::LiveStreamsApi.new
|
290
|
+
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
291
|
+
simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.
|
292
|
+
|
293
|
+
begin
|
294
|
+
#Delete a Live Stream Simulcast Target
|
295
|
+
api_instance.delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
296
|
+
rescue MuxRuby::ApiError => e
|
297
|
+
puts "Exception when calling LiveStreamsApi->delete_live_stream_simulcast_target: #{e}"
|
298
|
+
end
|
299
|
+
```
|
300
|
+
|
301
|
+
### Parameters
|
302
|
+
|
303
|
+
Name | Type | Description | Notes
|
304
|
+
------------- | ------------- | ------------- | -------------
|
305
|
+
**live_stream_id** | **String**| The live stream ID |
|
306
|
+
**simulcast_target_id** | **String**| The ID of the simulcast target. |
|
307
|
+
|
308
|
+
### Return type
|
309
|
+
|
310
|
+
nil (empty response body)
|
311
|
+
|
312
|
+
### Authorization
|
313
|
+
|
314
|
+
[accessToken](../README.md#accessToken)
|
315
|
+
|
316
|
+
### HTTP request headers
|
317
|
+
|
318
|
+
- **Content-Type**: Not defined
|
319
|
+
- **Accept**: Not defined
|
320
|
+
|
321
|
+
|
322
|
+
|
215
323
|
# **get_live_stream**
|
216
324
|
> LiveStreamResponse get_live_stream(live_stream_id)
|
217
325
|
|
@@ -263,6 +371,59 @@ Name | Type | Description | Notes
|
|
263
371
|
|
264
372
|
|
265
373
|
|
374
|
+
# **get_live_stream_simulcast_target**
|
375
|
+
> SimulcastTargetResponse get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
376
|
+
|
377
|
+
Retrieve a Live Stream Simulcast Target
|
378
|
+
|
379
|
+
Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information.
|
380
|
+
|
381
|
+
### Example
|
382
|
+
```ruby
|
383
|
+
# load the gem
|
384
|
+
require 'mux_ruby'
|
385
|
+
# setup authorization
|
386
|
+
MuxRuby.configure do |config|
|
387
|
+
# Configure HTTP basic authorization: accessToken
|
388
|
+
config.username = 'YOUR USERNAME'
|
389
|
+
config.password = 'YOUR PASSWORD'
|
390
|
+
end
|
391
|
+
|
392
|
+
api_instance = MuxRuby::LiveStreamsApi.new
|
393
|
+
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
394
|
+
simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.
|
395
|
+
|
396
|
+
begin
|
397
|
+
#Retrieve a Live Stream Simulcast Target
|
398
|
+
result = api_instance.get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
399
|
+
p result
|
400
|
+
rescue MuxRuby::ApiError => e
|
401
|
+
puts "Exception when calling LiveStreamsApi->get_live_stream_simulcast_target: #{e}"
|
402
|
+
end
|
403
|
+
```
|
404
|
+
|
405
|
+
### Parameters
|
406
|
+
|
407
|
+
Name | Type | Description | Notes
|
408
|
+
------------- | ------------- | ------------- | -------------
|
409
|
+
**live_stream_id** | **String**| The live stream ID |
|
410
|
+
**simulcast_target_id** | **String**| The ID of the simulcast target. |
|
411
|
+
|
412
|
+
### Return type
|
413
|
+
|
414
|
+
[**SimulcastTargetResponse**](SimulcastTargetResponse.md)
|
415
|
+
|
416
|
+
### Authorization
|
417
|
+
|
418
|
+
[accessToken](../README.md#accessToken)
|
419
|
+
|
420
|
+
### HTTP request headers
|
421
|
+
|
422
|
+
- **Content-Type**: Not defined
|
423
|
+
- **Accept**: application/json
|
424
|
+
|
425
|
+
|
426
|
+
|
266
427
|
# **list_live_streams**
|
267
428
|
> ListLiveStreamsResponse list_live_streams(opts)
|
268
429
|
|