mux_ruby 3.0.0 → 3.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +4 -4
  4. data/docs/Asset.md +1 -1
  5. data/docs/AssetsApi.md +73 -0
  6. data/docs/CreateAssetRequest.md +1 -1
  7. data/docs/CreateLiveStreamRequest.md +4 -2
  8. data/docs/CreatePlaybackRestrictionRequest.md +18 -0
  9. data/docs/CreateSimulcastTargetRequest.md +1 -1
  10. data/docs/CreateTrackRequest.md +1 -1
  11. data/docs/DeliveryUsageApi.md +4 -2
  12. data/docs/DimensionsApi.md +4 -4
  13. data/docs/ErrorsApi.md +4 -4
  14. data/docs/FiltersApi.md +4 -4
  15. data/docs/InputSettings.md +1 -1
  16. data/docs/ListPlaybackRestrictionsResponse.md +18 -0
  17. data/docs/LiveStream.md +8 -4
  18. data/docs/LiveStreamEmbeddedSubtitleSettings.md +1 -1
  19. data/docs/LiveStreamStatus.md +15 -0
  20. data/docs/LiveStreamsApi.md +76 -1
  21. data/docs/MetricsApi.md +21 -21
  22. data/docs/PlaybackRestriction.md +24 -0
  23. data/docs/PlaybackRestrictionResponse.md +18 -0
  24. data/docs/PlaybackRestrictionsApi.md +367 -0
  25. data/docs/RealTimeApi.md +6 -6
  26. data/docs/ReferrerDomainRestriction.md +20 -0
  27. data/docs/SimulcastTarget.md +1 -1
  28. data/docs/Track.md +1 -1
  29. data/docs/UpdateAssetRequest.md +18 -0
  30. data/docs/UpdateLiveStreamRequest.md +22 -0
  31. data/docs/UpdateReferrerDomainRestrictionRequest.md +15 -0
  32. data/docs/VideoViewsApi.md +4 -4
  33. data/examples/data/exercise-errors.rb +0 -1
  34. data/gen/generator-config.json +1 -1
  35. data/lib/mux_ruby/api/assets_api.rb +71 -0
  36. data/lib/mux_ruby/api/delivery_usage_api.rb +5 -2
  37. data/lib/mux_ruby/api/dimensions_api.rb +4 -4
  38. data/lib/mux_ruby/api/errors_api.rb +4 -4
  39. data/lib/mux_ruby/api/filters_api.rb +4 -4
  40. data/lib/mux_ruby/api/live_streams_api.rb +74 -0
  41. data/lib/mux_ruby/api/metrics_api.rb +22 -22
  42. data/lib/mux_ruby/api/playback_restrictions_api.rb +345 -0
  43. data/lib/mux_ruby/api/real_time_api.rb +6 -6
  44. data/lib/mux_ruby/api/video_views_api.rb +4 -4
  45. data/lib/mux_ruby/models/asset.rb +1 -1
  46. data/lib/mux_ruby/models/create_asset_request.rb +1 -1
  47. data/lib/mux_ruby/models/create_live_stream_request.rb +47 -3
  48. data/lib/mux_ruby/models/create_playback_restriction_request.rb +218 -0
  49. data/lib/mux_ruby/models/create_simulcast_target_request.rb +1 -1
  50. data/lib/mux_ruby/models/create_track_request.rb +1 -1
  51. data/lib/mux_ruby/models/input_settings.rb +1 -1
  52. data/lib/mux_ruby/models/input_settings_overlay_settings.rb +1 -1
  53. data/lib/mux_ruby/models/list_playback_restrictions_response.rb +220 -0
  54. data/lib/mux_ruby/models/live_stream.rb +35 -14
  55. data/lib/mux_ruby/models/live_stream_embedded_subtitle_settings.rb +1 -1
  56. data/lib/mux_ruby/models/live_stream_status.rb +38 -0
  57. data/lib/mux_ruby/models/playback_restriction.rb +248 -0
  58. data/lib/mux_ruby/models/playback_restriction_response.rb +218 -0
  59. data/lib/mux_ruby/models/referrer_domain_restriction.rb +234 -0
  60. data/lib/mux_ruby/models/simulcast_target.rb +1 -1
  61. data/lib/mux_ruby/models/track.rb +1 -1
  62. data/lib/mux_ruby/models/update_asset_request.rb +219 -0
  63. data/lib/mux_ruby/models/update_live_stream_request.rb +297 -0
  64. data/lib/mux_ruby/models/update_referrer_domain_restriction_request.rb +209 -0
  65. data/lib/mux_ruby/version.rb +1 -1
  66. data/lib/mux_ruby.rb +10 -0
  67. data/spec/api/playback_restrictions_api_spec.rb +97 -0
  68. data/spec/models/create_playback_restriction_request_spec.rb +34 -0
  69. data/spec/models/list_playback_restrictions_response_spec.rb +34 -0
  70. data/spec/models/live_stream_status_spec.rb +28 -0
  71. data/spec/models/playback_restriction_response_spec.rb +28 -0
  72. data/spec/models/playback_restriction_spec.rb +52 -0
  73. data/spec/models/referrer_domain_restriction_spec.rb +40 -0
  74. data/spec/models/update_asset_request_spec.rb +34 -0
  75. data/spec/models/update_live_stream_request_spec.rb +50 -0
  76. data/spec/models/update_referrer_domain_restriction_request_spec.rb +28 -0
  77. metadata +135 -95
data/docs/MetricsApi.md CHANGED
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.mux.com*
17
17
 
18
18
  Get metric timeseries data
19
19
 
20
- Returns timeseries data for a specific metric.
20
+ Returns timeseries data for a specific metric. Each interval represented in the data array contains an array with the following values: * the first element is the interval time * the second element is the calculated metric value * the third element is the number of views in the interval that have a valid metric value
21
21
 
22
22
  ### Examples
23
23
 
@@ -34,11 +34,11 @@ end
34
34
  api_instance = MuxRuby::MetricsApi.new
35
35
  metric_id = 'aggregate_startup_time' # String | ID of the Metric
36
36
  opts = {
37
- timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.
38
- filters: ['inner_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.
37
+ timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
38
+ filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
39
39
  measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
40
40
  order_direction: 'asc', # String | Sort order.
41
- group_by: 'hour' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.
41
+ group_by: 'hour' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity.
42
42
  }
43
43
 
44
44
  begin
@@ -73,11 +73,11 @@ end
73
73
  | Name | Type | Description | Notes |
74
74
  | ---- | ---- | ----------- | ----- |
75
75
  | **metric_id** | **String** | ID of the Metric | |
76
- | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. | [optional] |
77
- | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
76
+ | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
77
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
78
78
  | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
79
79
  | **order_direction** | **String** | Sort order. | [optional] |
80
- | **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe. | [optional] |
80
+ | **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is &#x60;ten_minutes&#x60;. Between 6 hours and 15 hours inclusive, the default granularity is &#x60;hour&#x60;. The granularity of timeframes that exceed 15 hours is &#x60;day&#x60;. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. | [optional] |
81
81
 
82
82
  ### Return type
83
83
 
@@ -116,8 +116,8 @@ end
116
116
  api_instance = MuxRuby::MetricsApi.new
117
117
  metric_id = 'aggregate_startup_time' # String | ID of the Metric
118
118
  opts = {
119
- timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.
120
- filters: ['inner_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.
119
+ timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
120
+ filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
121
121
  measurement: '95th' # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
122
122
  }
123
123
 
@@ -153,8 +153,8 @@ end
153
153
  | Name | Type | Description | Notes |
154
154
  | ---- | ---- | ----------- | ----- |
155
155
  | **metric_id** | **String** | ID of the Metric | |
156
- | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. | [optional] |
157
- | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
156
+ | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
157
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
158
158
  | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
159
159
 
160
160
  ### Return type
@@ -193,8 +193,8 @@ end
193
193
 
194
194
  api_instance = MuxRuby::MetricsApi.new
195
195
  opts = {
196
- timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.
197
- filters: ['inner_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.
196
+ timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
197
+ filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
198
198
  dimension: 'asn', # String | Dimension the specified value belongs to
199
199
  value: 'value_example' # String | Value to show all available metrics for
200
200
  }
@@ -230,8 +230,8 @@ end
230
230
 
231
231
  | Name | Type | Description | Notes |
232
232
  | ---- | ---- | ----------- | ----- |
233
- | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. | [optional] |
234
- | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
233
+ | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
234
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
235
235
  | **dimension** | **String** | Dimension the specified value belongs to | [optional] |
236
236
  | **value** | **String** | Value to show all available metrics for | [optional] |
237
237
 
@@ -274,12 +274,12 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
274
274
  opts = {
275
275
  group_by: 'asn', # String | Breakdown value to group the results by
276
276
  measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
277
- filters: ['inner_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.
277
+ filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
278
278
  limit: 56, # Integer | Number of items to include in the response
279
279
  page: 56, # Integer | Offset by this many pages, of the size of `limit`
280
280
  order_by: 'negative_impact', # String | Value to order the results by
281
281
  order_direction: 'asc', # String | Sort order.
282
- timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.
282
+ timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
283
283
  }
284
284
 
285
285
  begin
@@ -316,12 +316,12 @@ end
316
316
  | **metric_id** | **String** | ID of the Metric | |
317
317
  | **group_by** | **String** | Breakdown value to group the results by | [optional] |
318
318
  | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
319
- | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
319
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
320
320
  | **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
321
321
  | **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
322
322
  | **order_by** | **String** | Value to order the results by | [optional] |
323
323
  | **order_direction** | **String** | Sort order. | [optional] |
324
- | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. | [optional] |
324
+ | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
325
325
 
326
326
  ### Return type
327
327
 
@@ -362,7 +362,7 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
362
362
  opts = {
363
363
  measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
364
364
  order_direction: 'asc', # String | Sort order.
365
- timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.
365
+ timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
366
366
  }
367
367
 
368
368
  begin
@@ -399,7 +399,7 @@ end
399
399
  | **metric_id** | **String** | ID of the Metric | |
400
400
  | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
401
401
  | **order_direction** | **String** | Sort order. | [optional] |
402
- | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. | [optional] |
402
+ | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
403
403
 
404
404
  ### Return type
405
405
 
@@ -0,0 +1,24 @@
1
+ # MuxRuby::PlaybackRestriction
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier for the Playback Restriction. Max 255 characters. | [optional] |
8
+ | **created_at** | **String** | Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
9
+ | **updated_at** | **String** | Time the Playback Restriction was last updated, defined as a Unix timestamp (seconds since epoch). | [optional] |
10
+ | **referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'mux_ruby'
16
+
17
+ instance = MuxRuby::PlaybackRestriction.new(
18
+ id: null,
19
+ created_at: null,
20
+ updated_at: null,
21
+ referrer: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # MuxRuby::PlaybackRestrictionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**PlaybackRestriction**](.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::PlaybackRestrictionResponse.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,367 @@
1
+ # MuxRuby::PlaybackRestrictionsApi
2
+
3
+ All URIs are relative to *https://api.mux.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_playback_restriction**](PlaybackRestrictionsApi.md#create_playback_restriction) | **POST** /video/v1/playback-restrictions | Create a Playback Restriction |
8
+ | [**delete_playback_restriction**](PlaybackRestrictionsApi.md#delete_playback_restriction) | **DELETE** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID} | Delete a Playback Restriction |
9
+ | [**get_playback_restriction**](PlaybackRestrictionsApi.md#get_playback_restriction) | **GET** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID} | Retrieve a Playback Restriction |
10
+ | [**list_playback_restrictions**](PlaybackRestrictionsApi.md#list_playback_restrictions) | **GET** /video/v1/playback-restrictions | List Playback Restrictions |
11
+ | [**update_referrer_domain_restriction**](PlaybackRestrictionsApi.md#update_referrer_domain_restriction) | **PUT** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer | Update the Referrer Playback Restriction |
12
+
13
+
14
+ ## create_playback_restriction
15
+
16
+ > <PlaybackRestrictionResponse> create_playback_restriction(create_playback_restriction_request)
17
+
18
+ Create a Playback Restriction
19
+
20
+ Create a new Playback Restriction.
21
+
22
+ ### Examples
23
+
24
+ ```ruby
25
+ require 'time'
26
+ require 'mux_ruby'
27
+ # setup authorization
28
+ MuxRuby.configure do |config|
29
+ # Configure HTTP basic authorization: accessToken
30
+ config.username = 'YOUR USERNAME'
31
+ config.password = 'YOUR PASSWORD'
32
+ end
33
+
34
+ api_instance = MuxRuby::PlaybackRestrictionsApi.new
35
+ create_playback_restriction_request = MuxRuby::CreatePlaybackRestrictionRequest.new # CreatePlaybackRestrictionRequest |
36
+
37
+ begin
38
+ # Create a Playback Restriction
39
+ result = api_instance.create_playback_restriction(create_playback_restriction_request)
40
+ p result
41
+ rescue MuxRuby::ApiError => e
42
+ puts "Error when calling PlaybackRestrictionsApi->create_playback_restriction: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the create_playback_restriction_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<PlaybackRestrictionResponse>, Integer, Hash)> create_playback_restriction_with_http_info(create_playback_restriction_request)
51
+
52
+ ```ruby
53
+ begin
54
+ # Create a Playback Restriction
55
+ data, status_code, headers = api_instance.create_playback_restriction_with_http_info(create_playback_restriction_request)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <PlaybackRestrictionResponse>
59
+ rescue MuxRuby::ApiError => e
60
+ puts "Error when calling PlaybackRestrictionsApi->create_playback_restriction_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **create_playback_restriction_request** | [**CreatePlaybackRestrictionRequest**](CreatePlaybackRestrictionRequest.md) | | |
69
+
70
+ ### Return type
71
+
72
+ [**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
73
+
74
+ ### Authorization
75
+
76
+ [accessToken](../README.md#accessToken)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: application/json
81
+ - **Accept**: application/json
82
+
83
+
84
+ ## delete_playback_restriction
85
+
86
+ > delete_playback_restriction(playback_restriction_id)
87
+
88
+ Delete a Playback Restriction
89
+
90
+ Deletes a single Playback Restriction.
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'mux_ruby'
97
+ # setup authorization
98
+ MuxRuby.configure do |config|
99
+ # Configure HTTP basic authorization: accessToken
100
+ config.username = 'YOUR USERNAME'
101
+ config.password = 'YOUR PASSWORD'
102
+ end
103
+
104
+ api_instance = MuxRuby::PlaybackRestrictionsApi.new
105
+ playback_restriction_id = 'playback_restriction_id_example' # String | ID of the Playback Restriction.
106
+
107
+ begin
108
+ # Delete a Playback Restriction
109
+ api_instance.delete_playback_restriction(playback_restriction_id)
110
+ rescue MuxRuby::ApiError => e
111
+ puts "Error when calling PlaybackRestrictionsApi->delete_playback_restriction: #{e}"
112
+ end
113
+ ```
114
+
115
+ #### Using the delete_playback_restriction_with_http_info variant
116
+
117
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
118
+
119
+ > <Array(nil, Integer, Hash)> delete_playback_restriction_with_http_info(playback_restriction_id)
120
+
121
+ ```ruby
122
+ begin
123
+ # Delete a Playback Restriction
124
+ data, status_code, headers = api_instance.delete_playback_restriction_with_http_info(playback_restriction_id)
125
+ p status_code # => 2xx
126
+ p headers # => { ... }
127
+ p data # => nil
128
+ rescue MuxRuby::ApiError => e
129
+ puts "Error when calling PlaybackRestrictionsApi->delete_playback_restriction_with_http_info: #{e}"
130
+ end
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+ | Name | Type | Description | Notes |
136
+ | ---- | ---- | ----------- | ----- |
137
+ | **playback_restriction_id** | **String** | ID of the Playback Restriction. | |
138
+
139
+ ### Return type
140
+
141
+ nil (empty response body)
142
+
143
+ ### Authorization
144
+
145
+ [accessToken](../README.md#accessToken)
146
+
147
+ ### HTTP request headers
148
+
149
+ - **Content-Type**: Not defined
150
+ - **Accept**: Not defined
151
+
152
+
153
+ ## get_playback_restriction
154
+
155
+ > <PlaybackRestrictionResponse> get_playback_restriction(playback_restriction_id)
156
+
157
+ Retrieve a Playback Restriction
158
+
159
+ Retrieves a Playback Restriction associated with the unique identifier.
160
+
161
+ ### Examples
162
+
163
+ ```ruby
164
+ require 'time'
165
+ require 'mux_ruby'
166
+ # setup authorization
167
+ MuxRuby.configure do |config|
168
+ # Configure HTTP basic authorization: accessToken
169
+ config.username = 'YOUR USERNAME'
170
+ config.password = 'YOUR PASSWORD'
171
+ end
172
+
173
+ api_instance = MuxRuby::PlaybackRestrictionsApi.new
174
+ playback_restriction_id = 'playback_restriction_id_example' # String | ID of the Playback Restriction.
175
+
176
+ begin
177
+ # Retrieve a Playback Restriction
178
+ result = api_instance.get_playback_restriction(playback_restriction_id)
179
+ p result
180
+ rescue MuxRuby::ApiError => e
181
+ puts "Error when calling PlaybackRestrictionsApi->get_playback_restriction: #{e}"
182
+ end
183
+ ```
184
+
185
+ #### Using the get_playback_restriction_with_http_info variant
186
+
187
+ This returns an Array which contains the response data, status code and headers.
188
+
189
+ > <Array(<PlaybackRestrictionResponse>, Integer, Hash)> get_playback_restriction_with_http_info(playback_restriction_id)
190
+
191
+ ```ruby
192
+ begin
193
+ # Retrieve a Playback Restriction
194
+ data, status_code, headers = api_instance.get_playback_restriction_with_http_info(playback_restriction_id)
195
+ p status_code # => 2xx
196
+ p headers # => { ... }
197
+ p data # => <PlaybackRestrictionResponse>
198
+ rescue MuxRuby::ApiError => e
199
+ puts "Error when calling PlaybackRestrictionsApi->get_playback_restriction_with_http_info: #{e}"
200
+ end
201
+ ```
202
+
203
+ ### Parameters
204
+
205
+ | Name | Type | Description | Notes |
206
+ | ---- | ---- | ----------- | ----- |
207
+ | **playback_restriction_id** | **String** | ID of the Playback Restriction. | |
208
+
209
+ ### Return type
210
+
211
+ [**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
212
+
213
+ ### Authorization
214
+
215
+ [accessToken](../README.md#accessToken)
216
+
217
+ ### HTTP request headers
218
+
219
+ - **Content-Type**: Not defined
220
+ - **Accept**: application/json
221
+
222
+
223
+ ## list_playback_restrictions
224
+
225
+ > <ListPlaybackRestrictionsResponse> list_playback_restrictions(opts)
226
+
227
+ List Playback Restrictions
228
+
229
+ Returns a list of all Playback Restrictions.
230
+
231
+ ### Examples
232
+
233
+ ```ruby
234
+ require 'time'
235
+ require 'mux_ruby'
236
+ # setup authorization
237
+ MuxRuby.configure do |config|
238
+ # Configure HTTP basic authorization: accessToken
239
+ config.username = 'YOUR USERNAME'
240
+ config.password = 'YOUR PASSWORD'
241
+ end
242
+
243
+ api_instance = MuxRuby::PlaybackRestrictionsApi.new
244
+ opts = {
245
+ page: 56, # Integer | Offset by this many pages, of the size of `limit`
246
+ limit: 56 # Integer | Number of items to include in the response
247
+ }
248
+
249
+ begin
250
+ # List Playback Restrictions
251
+ result = api_instance.list_playback_restrictions(opts)
252
+ p result
253
+ rescue MuxRuby::ApiError => e
254
+ puts "Error when calling PlaybackRestrictionsApi->list_playback_restrictions: #{e}"
255
+ end
256
+ ```
257
+
258
+ #### Using the list_playback_restrictions_with_http_info variant
259
+
260
+ This returns an Array which contains the response data, status code and headers.
261
+
262
+ > <Array(<ListPlaybackRestrictionsResponse>, Integer, Hash)> list_playback_restrictions_with_http_info(opts)
263
+
264
+ ```ruby
265
+ begin
266
+ # List Playback Restrictions
267
+ data, status_code, headers = api_instance.list_playback_restrictions_with_http_info(opts)
268
+ p status_code # => 2xx
269
+ p headers # => { ... }
270
+ p data # => <ListPlaybackRestrictionsResponse>
271
+ rescue MuxRuby::ApiError => e
272
+ puts "Error when calling PlaybackRestrictionsApi->list_playback_restrictions_with_http_info: #{e}"
273
+ end
274
+ ```
275
+
276
+ ### Parameters
277
+
278
+ | Name | Type | Description | Notes |
279
+ | ---- | ---- | ----------- | ----- |
280
+ | **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
281
+ | **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
282
+
283
+ ### Return type
284
+
285
+ [**ListPlaybackRestrictionsResponse**](ListPlaybackRestrictionsResponse.md)
286
+
287
+ ### Authorization
288
+
289
+ [accessToken](../README.md#accessToken)
290
+
291
+ ### HTTP request headers
292
+
293
+ - **Content-Type**: Not defined
294
+ - **Accept**: application/json
295
+
296
+
297
+ ## update_referrer_domain_restriction
298
+
299
+ > <PlaybackRestrictionResponse> update_referrer_domain_restriction(playback_restriction_id, body)
300
+
301
+ Update the Referrer Playback Restriction
302
+
303
+ Allows you to modify the list of domains or change how Mux validates playback requests without the `Referer` HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.
304
+
305
+ ### Examples
306
+
307
+ ```ruby
308
+ require 'time'
309
+ require 'mux_ruby'
310
+ # setup authorization
311
+ MuxRuby.configure do |config|
312
+ # Configure HTTP basic authorization: accessToken
313
+ config.username = 'YOUR USERNAME'
314
+ config.password = 'YOUR PASSWORD'
315
+ end
316
+
317
+ api_instance = MuxRuby::PlaybackRestrictionsApi.new
318
+ playback_restriction_id = 'playback_restriction_id_example' # String | ID of the Playback Restriction.
319
+ body = {"allowed_domains":["*.example.com"],"allow_no_referrer":true} # ReferrerDomainRestriction |
320
+
321
+ begin
322
+ # Update the Referrer Playback Restriction
323
+ result = api_instance.update_referrer_domain_restriction(playback_restriction_id, body)
324
+ p result
325
+ rescue MuxRuby::ApiError => e
326
+ puts "Error when calling PlaybackRestrictionsApi->update_referrer_domain_restriction: #{e}"
327
+ end
328
+ ```
329
+
330
+ #### Using the update_referrer_domain_restriction_with_http_info variant
331
+
332
+ This returns an Array which contains the response data, status code and headers.
333
+
334
+ > <Array(<PlaybackRestrictionResponse>, Integer, Hash)> update_referrer_domain_restriction_with_http_info(playback_restriction_id, body)
335
+
336
+ ```ruby
337
+ begin
338
+ # Update the Referrer Playback Restriction
339
+ data, status_code, headers = api_instance.update_referrer_domain_restriction_with_http_info(playback_restriction_id, body)
340
+ p status_code # => 2xx
341
+ p headers # => { ... }
342
+ p data # => <PlaybackRestrictionResponse>
343
+ rescue MuxRuby::ApiError => e
344
+ puts "Error when calling PlaybackRestrictionsApi->update_referrer_domain_restriction_with_http_info: #{e}"
345
+ end
346
+ ```
347
+
348
+ ### Parameters
349
+
350
+ | Name | Type | Description | Notes |
351
+ | ---- | ---- | ----------- | ----- |
352
+ | **playback_restriction_id** | **String** | ID of the Playback Restriction. | |
353
+ | **body** | **ReferrerDomainRestriction** | | |
354
+
355
+ ### Return type
356
+
357
+ [**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
358
+
359
+ ### Authorization
360
+
361
+ [accessToken](../README.md#accessToken)
362
+
363
+ ### HTTP request headers
364
+
365
+ - **Content-Type**: application/json
366
+ - **Accept**: application/json
367
+
data/docs/RealTimeApi.md CHANGED
@@ -36,7 +36,7 @@ realtime_metric_id = 'current-concurrent-viewers' # String | ID of the Realtime
36
36
  opts = {
37
37
  dimension: 'asn', # String | Dimension the specified value belongs to
38
38
  timestamp: 8.14, # Float | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
39
- filters: ['inner_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.
39
+ filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
40
40
  order_by: 'negative_impact', # String | Value to order the results by
41
41
  order_direction: 'asc' # String | Sort order.
42
42
  }
@@ -75,7 +75,7 @@ end
75
75
  | **realtime_metric_id** | **String** | ID of the Realtime Metric | |
76
76
  | **dimension** | **String** | Dimension the specified value belongs to | [optional] |
77
77
  | **timestamp** | **Float** | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] |
78
- | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
78
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
79
79
  | **order_by** | **String** | Value to order the results by | [optional] |
80
80
  | **order_direction** | **String** | Sort order. | [optional] |
81
81
 
@@ -116,7 +116,7 @@ end
116
116
  api_instance = MuxRuby::RealTimeApi.new
117
117
  realtime_histogram_metric_id = 'video-startup-time' # String | ID of the Realtime Histogram Metric
118
118
  opts = {
119
- filters: ['inner_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.
119
+ filters: ['inner_example'] # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
120
120
  }
121
121
 
122
122
  begin
@@ -151,7 +151,7 @@ end
151
151
  | Name | Type | Description | Notes |
152
152
  | ---- | ---- | ----------- | ----- |
153
153
  | **realtime_histogram_metric_id** | **String** | ID of the Realtime Histogram Metric | |
154
- | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
154
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
155
155
 
156
156
  ### Return type
157
157
 
@@ -190,7 +190,7 @@ end
190
190
  api_instance = MuxRuby::RealTimeApi.new
191
191
  realtime_metric_id = 'current-concurrent-viewers' # String | ID of the Realtime Metric
192
192
  opts = {
193
- filters: ['inner_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.
193
+ filters: ['inner_example'] # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
194
194
  }
195
195
 
196
196
  begin
@@ -225,7 +225,7 @@ end
225
225
  | Name | Type | Description | Notes |
226
226
  | ---- | ---- | ----------- | ----- |
227
227
  | **realtime_metric_id** | **String** | ID of the Realtime Metric | |
228
- | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
228
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
229
229
 
230
230
  ### Return type
231
231
 
@@ -0,0 +1,20 @@
1
+ # MuxRuby::ReferrerDomainRestriction
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **allowed_domains** | **Array&lt;String&gt;** | List of domains allowed to play videos. Possible values are * &#x60;[]&#x60; Empty Array indicates deny video playback requests for all domains * &#x60;[\&quot;*\&quot;]&#x60; A Single Wildcard &#x60;*&#x60; entry means allow video playback requests from any domain * &#x60;[\&quot;*.example.com\&quot;, \&quot;foo.com\&quot;]&#x60; A list of up to 10 domains or valid dns-style wildcards | [optional] |
8
+ | **allow_no_referrer** | **Boolean** | A boolean to determine whether to allow or deny HTTP requests without &#x60;Referer&#x60; HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not have a &#x60;Referer&#x60; HTTP header. Set this value to &#x60;true&#x60; to allow these playback requests. | [optional][default to false] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mux_ruby'
14
+
15
+ instance = MuxRuby::ReferrerDomainRestriction.new(
16
+ allowed_domains: null,
17
+ allow_no_referrer: null
18
+ )
19
+ ```
20
+
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | ID of the Simulcast Target | [optional] |
8
- | **passthrough** | **String** | Arbitrary Metadata set when creating a simulcast target. | [optional] |
8
+ | **passthrough** | **String** | Arbitrary user-supplied metadata set when creating a simulcast target. | [optional] |
9
9
  | **status** | **String** | The current status of the simulcast target. See Statuses below for detailed description. * &#x60;idle&#x60;: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state. * &#x60;starting&#x60;: The simulcast target transitions into this state when the parent live stream transition into connected state. * &#x60;broadcasting&#x60;: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service. * &#x60;errored&#x60;: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. Compared to other errored statuses in the Mux Video API, a simulcast may transition back into the broadcasting state if a connection with the service can be re-established. | [optional] |
10
10
  | **stream_key** | **String** | Stream Key represents an stream identifier for the third party live streaming service to simulcast the parent live stream too. | [optional] |
11
11
  | **url** | **String** | RTMP hostname including the application name for the third party live streaming service. | [optional] |
data/docs/Track.md CHANGED
@@ -16,7 +16,7 @@
16
16
  | **language_code** | **String** | The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, &#x60;en&#x60; for English or &#x60;en-US&#x60; for the US version of English. This parameter is set for &#x60;text&#x60; type and &#x60;subtitles&#x60; text type track. | [optional] |
17
17
  | **name** | **String** | The name of the track containing a human-readable description. The hls manifest will associate a subtitle text track with this value. For example, the value is \&quot;English\&quot; for subtitles text track for the &#x60;language_code&#x60; value of &#x60;en-US&#x60;. This parameter is set for the &#x60;text&#x60; type and &#x60;subtitles&#x60; text type track. | [optional] |
18
18
  | **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is set for the &#x60;text&#x60; type and &#x60;subtitles&#x60; text type track. | [optional] |
19
- | **passthrough** | **String** | Arbitrary metadata set for the track either when creating the asset or track. This parameter is set for &#x60;text&#x60; type and &#x60;subtitles&#x60; text type track. Max 255 characters. | [optional] |
19
+ | **passthrough** | **String** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. This parameter is set for &#x60;text&#x60; type and &#x60;subtitles&#x60; text type track. Max 255 characters. | [optional] |
20
20
 
21
21
  ## Example
22
22