mux_ruby 3.2.0 → 3.4.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 +3 -3
- data/README.md +4 -4
- data/docs/AssetNonStandardInputReasons.md +2 -2
- data/docs/AssetResponse.md +1 -1
- data/docs/AssetsApi.md +8 -0
- data/docs/CreateLiveStreamRequest.md +3 -1
- data/docs/CreatePlaybackIDResponse.md +1 -1
- data/docs/CreatePlaybackRestrictionRequest.md +1 -1
- data/docs/CreateTrackResponse.md +1 -1
- data/docs/DirectUploadsApi.md +6 -0
- data/docs/GetAssetPlaybackIDResponse.md +1 -1
- data/docs/GetLiveStreamPlaybackIDResponse.md +1 -1
- data/docs/IncidentResponse.md +1 -1
- data/docs/InputSettings.md +3 -3
- data/docs/ListPlaybackRestrictionsResponse.md +18 -0
- data/docs/LiveStream.md +4 -2
- data/docs/LiveStreamResponse.md +1 -1
- data/docs/LiveStreamStatus.md +15 -0
- data/docs/LiveStreamsApi.md +19 -5
- data/docs/MetricsApi.md +3 -3
- data/docs/PlaybackRestrictionResponse.md +4 -1
- data/docs/PlaybackRestrictionsApi.md +21 -21
- data/docs/SigningKeyResponse.md +1 -1
- data/docs/SimulcastTargetResponse.md +1 -1
- data/docs/Track.md +9 -7
- data/docs/UpdateLiveStreamRequest.md +3 -1
- data/docs/UpdateReferrerDomainRestrictionRequest.md +37 -5
- data/docs/UploadResponse.md +1 -1
- data/docs/VideoViewResponse.md +1 -1
- data/gen/generator-config.json +1 -1
- data/lib/mux_ruby/api/assets_api.rb +8 -0
- data/lib/mux_ruby/api/direct_uploads_api.rb +6 -0
- data/lib/mux_ruby/api/live_streams_api.rb +17 -2
- data/lib/mux_ruby/api/metrics_api.rb +5 -5
- data/lib/mux_ruby/api/playback_restrictions_api.rb +23 -23
- data/lib/mux_ruby/models/abridged_video_view.rb +7 -0
- data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +2 -2
- data/lib/mux_ruby/models/create_live_stream_request.rb +40 -4
- data/lib/mux_ruby/models/input_settings.rb +3 -3
- data/lib/mux_ruby/models/list_playback_restrictions_response.rb +220 -0
- data/lib/mux_ruby/models/live_stream.rb +41 -18
- data/lib/mux_ruby/models/live_stream_status.rb +38 -0
- data/lib/mux_ruby/models/playback_restriction_response.rb +11 -2
- data/lib/mux_ruby/models/track.rb +32 -10
- data/lib/mux_ruby/models/update_live_stream_request.rb +40 -4
- data/lib/mux_ruby/models/update_referrer_domain_restriction_request.rb +74 -179
- data/lib/mux_ruby/models/video_view.rb +103 -0
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +2 -0
- data/spec/models/list_playback_restrictions_response_spec.rb +34 -0
- data/spec/models/live_stream_status_spec.rb +28 -0
- metadata +109 -101
data/docs/Track.md
CHANGED
@@ -6,17 +6,18 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | Unique identifier for the Track | [optional] |
|
8
8
|
| **type** | **String** | The type of track | [optional] |
|
9
|
-
| **duration** | **Float** | The duration in seconds of the track media. This parameter is not set for
|
9
|
+
| **duration** | **Float** | The duration in seconds of the track media. This parameter is not set for `text` type tracks. This field is optional and may not be set. The top level `duration` field of an asset will always be set. | [optional] |
|
10
10
|
| **max_width** | **Integer** | The maximum width in pixels available for the track. Only set for the `video` type track. | [optional] |
|
11
11
|
| **max_height** | **Integer** | The maximum height in pixels available for the track. Only set for the `video` type track. | [optional] |
|
12
12
|
| **max_frame_rate** | **Float** | The maximum frame rate available for the track. Only set for the `video` type track. This field may return `-1` if the frame rate of the input cannot be reliably determined. | [optional] |
|
13
13
|
| **max_channels** | **Integer** | The maximum number of audio channels the track supports. Only set for the `audio` type track. | [optional] |
|
14
14
|
| **max_channel_layout** | **String** | Only set for the `audio` type track. | [optional] |
|
15
|
-
| **text_type** | **String** | This parameter is set
|
16
|
-
| **language_code** | **String** | The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is set for `text` type and `subtitles` text type
|
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 \"English\" for subtitles text track for the `language_code` value of `en-US`. This parameter is set for
|
18
|
-
| **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is set for
|
19
|
-
| **passthrough** | **String** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. This parameter is set for `text` type
|
15
|
+
| **text_type** | **String** | This parameter is only set for `text` type tracks. | [optional] |
|
16
|
+
| **language_code** | **String** | The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is only set for `text` type and `subtitles` text type tracks. | [optional] |
|
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 \"English\" for subtitles text track for the `language_code` value of `en-US`. This parameter is only set for `text` type and `subtitles` text type tracks. | [optional] |
|
18
|
+
| **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is only set for `text` type and `subtitles` text type tracks. | [optional] |
|
19
|
+
| **passthrough** | **String** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. This parameter is only set for `text` type tracks. Max 255 characters. | [optional] |
|
20
|
+
| **status** | **String** | The status of the track. This parameter is only set for `text` type tracks. | [optional] |
|
20
21
|
|
21
22
|
## Example
|
22
23
|
|
@@ -36,7 +37,8 @@ instance = MuxRuby::Track.new(
|
|
36
37
|
language_code: null,
|
37
38
|
name: null,
|
38
39
|
closed_captions: null,
|
39
|
-
passthrough: null
|
40
|
+
passthrough: null,
|
41
|
+
status: null
|
40
42
|
)
|
41
43
|
```
|
42
44
|
|
@@ -7,6 +7,7 @@
|
|
7
7
|
| **passthrough** | **String** | Arbitrary user-supplied metadata set for the live stream. Max 255 characters. In order to clear this value, the field should be included with an empty-string value. | [optional] |
|
8
8
|
| **latency_mode** | **String** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Note: Reconnect windows are incompatible with Reduced Latency and Low Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] |
|
9
9
|
| **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. | [optional] |
|
10
|
+
| **max_continuous_duration** | **Integer** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional][default to 43200] |
|
10
11
|
|
11
12
|
## Example
|
12
13
|
|
@@ -16,7 +17,8 @@ require 'mux_ruby'
|
|
16
17
|
instance = MuxRuby::UpdateLiveStreamRequest.new(
|
17
18
|
passthrough: null,
|
18
19
|
latency_mode: null,
|
19
|
-
reconnect_window: null
|
20
|
+
reconnect_window: null,
|
21
|
+
max_continuous_duration: null
|
20
22
|
)
|
21
23
|
```
|
22
24
|
|
@@ -1,15 +1,47 @@
|
|
1
1
|
# MuxRuby::UpdateReferrerDomainRestrictionRequest
|
2
2
|
|
3
|
-
##
|
3
|
+
## Class instance methods
|
4
4
|
|
5
|
-
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
5
|
+
### `openapi_one_of`
|
7
6
|
|
8
|
-
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
MuxRuby::UpdateReferrerDomainRestrictionRequest.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'ReferrerDomainRestriction'
|
18
|
+
# ]
|
19
|
+
```
|
20
|
+
|
21
|
+
### build
|
22
|
+
|
23
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
24
|
+
|
25
|
+
#### Example
|
9
26
|
|
10
27
|
```ruby
|
11
28
|
require 'mux_ruby'
|
12
29
|
|
13
|
-
|
30
|
+
MuxRuby::UpdateReferrerDomainRestrictionRequest.build(data)
|
31
|
+
# => #<ReferrerDomainRestriction:0x00007fdd4aab02a0>
|
32
|
+
|
33
|
+
MuxRuby::UpdateReferrerDomainRestrictionRequest.build(data_that_doesnt_match)
|
34
|
+
# => nil
|
14
35
|
```
|
15
36
|
|
37
|
+
#### Parameters
|
38
|
+
|
39
|
+
| Name | Type | Description |
|
40
|
+
| ---- | ---- | ----------- |
|
41
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
42
|
+
|
43
|
+
#### Return type
|
44
|
+
|
45
|
+
- `ReferrerDomainRestriction`
|
46
|
+
- `nil` (if no type matches)
|
47
|
+
|
data/docs/UploadResponse.md
CHANGED
data/docs/VideoViewResponse.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**VideoView**](.md) | | [optional] |
|
7
|
+
| **data** | [**VideoView**](VideoView.md) | | [optional] |
|
8
8
|
| **timeframe** | **Array<Integer>** | | [optional] |
|
9
9
|
|
10
10
|
## Example
|
data/gen/generator-config.json
CHANGED
@@ -85,6 +85,7 @@ module MuxRuby
|
|
85
85
|
end
|
86
86
|
|
87
87
|
# Create a playback ID
|
88
|
+
# Creates a playback ID that can be used to stream the asset to a viewer.
|
88
89
|
# @param asset_id [String] The asset ID.
|
89
90
|
# @param create_playback_id_request [CreatePlaybackIDRequest]
|
90
91
|
# @param [Hash] opts the optional parameters
|
@@ -95,6 +96,7 @@ module MuxRuby
|
|
95
96
|
end
|
96
97
|
|
97
98
|
# Create a playback ID
|
99
|
+
# Creates a playback ID that can be used to stream the asset to a viewer.
|
98
100
|
# @param asset_id [String] The asset ID.
|
99
101
|
# @param create_playback_id_request [CreatePlaybackIDRequest]
|
100
102
|
# @param [Hash] opts the optional parameters
|
@@ -154,6 +156,7 @@ module MuxRuby
|
|
154
156
|
end
|
155
157
|
|
156
158
|
# Create an asset track
|
159
|
+
# Adds an asset track (for example, subtitles) to an asset.
|
157
160
|
# @param asset_id [String] The asset ID.
|
158
161
|
# @param create_track_request [CreateTrackRequest]
|
159
162
|
# @param [Hash] opts the optional parameters
|
@@ -164,6 +167,7 @@ module MuxRuby
|
|
164
167
|
end
|
165
168
|
|
166
169
|
# Create an asset track
|
170
|
+
# Adds an asset track (for example, subtitles) to an asset.
|
167
171
|
# @param asset_id [String] The asset ID.
|
168
172
|
# @param create_track_request [CreateTrackRequest]
|
169
173
|
# @param [Hash] opts the optional parameters
|
@@ -284,6 +288,7 @@ module MuxRuby
|
|
284
288
|
end
|
285
289
|
|
286
290
|
# Delete a playback ID
|
291
|
+
# Deletes a playback ID, rendering it nonfunctional for viewing an asset's video content. Please note that deleting the playback ID removes access to the underlying asset; a viewer who started playback before the playback ID was deleted may be able to watch the entire video for a limited duration.
|
287
292
|
# @param asset_id [String] The asset ID.
|
288
293
|
# @param playback_id [String] The live stream's playback ID.
|
289
294
|
# @param [Hash] opts the optional parameters
|
@@ -294,6 +299,7 @@ module MuxRuby
|
|
294
299
|
end
|
295
300
|
|
296
301
|
# Delete a playback ID
|
302
|
+
# Deletes a playback ID, rendering it nonfunctional for viewing an asset's video content. Please note that deleting the playback ID removes access to the underlying asset; a viewer who started playback before the playback ID was deleted may be able to watch the entire video for a limited duration.
|
297
303
|
# @param asset_id [String] The asset ID.
|
298
304
|
# @param playback_id [String] The live stream's playback ID.
|
299
305
|
# @param [Hash] opts the optional parameters
|
@@ -542,6 +548,7 @@ module MuxRuby
|
|
542
548
|
end
|
543
549
|
|
544
550
|
# Retrieve a playback ID
|
551
|
+
# Retrieves information about the specified playback ID.
|
545
552
|
# @param asset_id [String] The asset ID.
|
546
553
|
# @param playback_id [String] The live stream's playback ID.
|
547
554
|
# @param [Hash] opts the optional parameters
|
@@ -552,6 +559,7 @@ module MuxRuby
|
|
552
559
|
end
|
553
560
|
|
554
561
|
# Retrieve a playback ID
|
562
|
+
# Retrieves information about the specified playback ID.
|
555
563
|
# @param asset_id [String] The asset ID.
|
556
564
|
# @param playback_id [String] The live stream's playback ID.
|
557
565
|
# @param [Hash] opts the optional parameters
|
@@ -83,6 +83,7 @@ module MuxRuby
|
|
83
83
|
end
|
84
84
|
|
85
85
|
# Create a new direct upload URL
|
86
|
+
# Creates a new direct upload, through which video content can be uploaded for ingest to Mux.
|
86
87
|
# @param create_upload_request [CreateUploadRequest]
|
87
88
|
# @param [Hash] opts the optional parameters
|
88
89
|
# @return [UploadResponse]
|
@@ -92,6 +93,7 @@ module MuxRuby
|
|
92
93
|
end
|
93
94
|
|
94
95
|
# Create a new direct upload URL
|
96
|
+
# Creates a new direct upload, through which video content can be uploaded for ingest to Mux.
|
95
97
|
# @param create_upload_request [CreateUploadRequest]
|
96
98
|
# @param [Hash] opts the optional parameters
|
97
99
|
# @return [Array<(UploadResponse, Integer, Hash)>] UploadResponse data, response status code and response headers
|
@@ -146,6 +148,7 @@ module MuxRuby
|
|
146
148
|
end
|
147
149
|
|
148
150
|
# Retrieve a single direct upload's info
|
151
|
+
# Fetches information about a single direct upload in the current environment.
|
149
152
|
# @param upload_id [String] ID of the Upload
|
150
153
|
# @param [Hash] opts the optional parameters
|
151
154
|
# @return [UploadResponse]
|
@@ -155,6 +158,7 @@ module MuxRuby
|
|
155
158
|
end
|
156
159
|
|
157
160
|
# Retrieve a single direct upload's info
|
161
|
+
# Fetches information about a single direct upload in the current environment.
|
158
162
|
# @param upload_id [String] ID of the Upload
|
159
163
|
# @param [Hash] opts the optional parameters
|
160
164
|
# @return [Array<(UploadResponse, Integer, Hash)>] UploadResponse data, response status code and response headers
|
@@ -207,6 +211,7 @@ module MuxRuby
|
|
207
211
|
end
|
208
212
|
|
209
213
|
# List direct uploads
|
214
|
+
# Lists currently extant direct uploads in the current environment.
|
210
215
|
# @param [Hash] opts the optional parameters
|
211
216
|
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
212
217
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
|
@@ -217,6 +222,7 @@ module MuxRuby
|
|
217
222
|
end
|
218
223
|
|
219
224
|
# List direct uploads
|
225
|
+
# Lists currently extant direct uploads in the current environment.
|
220
226
|
# @param [Hash] opts the optional parameters
|
221
227
|
# @option opts [Integer] :limit Number of items to include in the response
|
222
228
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit`
|
@@ -20,6 +20,7 @@ module MuxRuby
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Create a live stream
|
23
|
+
# Creates a new live stream. Once created, an encoder can connect to Mux via the specified stream key and begin streaming to an audience.
|
23
24
|
# @param create_live_stream_request [CreateLiveStreamRequest]
|
24
25
|
# @param [Hash] opts the optional parameters
|
25
26
|
# @return [LiveStreamResponse]
|
@@ -29,6 +30,7 @@ module MuxRuby
|
|
29
30
|
end
|
30
31
|
|
31
32
|
# Create a live stream
|
33
|
+
# Creates a new live stream. Once created, an encoder can connect to Mux via the specified stream key and begin streaming to an audience.
|
32
34
|
# @param create_live_stream_request [CreateLiveStreamRequest]
|
33
35
|
# @param [Hash] opts the optional parameters
|
34
36
|
# @return [Array<(LiveStreamResponse, Integer, Hash)>] LiveStreamResponse data, response status code and response headers
|
@@ -83,6 +85,7 @@ module MuxRuby
|
|
83
85
|
end
|
84
86
|
|
85
87
|
# Create a live stream playback ID
|
88
|
+
# Create a new playback ID for this live stream, through which a viewer can watch the streamed content of the live stream.
|
86
89
|
# @param live_stream_id [String] The live stream ID
|
87
90
|
# @param create_playback_id_request [CreatePlaybackIDRequest]
|
88
91
|
# @param [Hash] opts the optional parameters
|
@@ -93,6 +96,7 @@ module MuxRuby
|
|
93
96
|
end
|
94
97
|
|
95
98
|
# Create a live stream playback ID
|
99
|
+
# Create a new playback ID for this live stream, through which a viewer can watch the streamed content of the live stream.
|
96
100
|
# @param live_stream_id [String] The live stream ID
|
97
101
|
# @param create_playback_id_request [CreatePlaybackIDRequest]
|
98
102
|
# @param [Hash] opts the optional parameters
|
@@ -223,6 +227,7 @@ module MuxRuby
|
|
223
227
|
end
|
224
228
|
|
225
229
|
# Delete a live stream
|
230
|
+
# Deletes a live stream from the current environment. If the live stream is currently active and being streamed to, ingest will be terminated and the encoder will be disconnected.
|
226
231
|
# @param live_stream_id [String] The live stream ID
|
227
232
|
# @param [Hash] opts the optional parameters
|
228
233
|
# @return [nil]
|
@@ -232,6 +237,7 @@ module MuxRuby
|
|
232
237
|
end
|
233
238
|
|
234
239
|
# Delete a live stream
|
240
|
+
# Deletes a live stream from the current environment. If the live stream is currently active and being streamed to, ingest will be terminated and the encoder will be disconnected.
|
235
241
|
# @param live_stream_id [String] The live stream ID
|
236
242
|
# @param [Hash] opts the optional parameters
|
237
243
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -282,6 +288,7 @@ module MuxRuby
|
|
282
288
|
end
|
283
289
|
|
284
290
|
# Delete a live stream playback ID
|
291
|
+
# Deletes the playback ID for the live stream. This will not disable ingest (as the live stream still exists). New attempts to play back the live stream will fail immediately. However, current viewers will be able to continue watching the stream for some period of time.
|
285
292
|
# @param live_stream_id [String] The live stream ID
|
286
293
|
# @param playback_id [String] The live stream's playback ID.
|
287
294
|
# @param [Hash] opts the optional parameters
|
@@ -292,6 +299,7 @@ module MuxRuby
|
|
292
299
|
end
|
293
300
|
|
294
301
|
# Delete a live stream playback ID
|
302
|
+
# Deletes the playback ID for the live stream. This will not disable ingest (as the live stream still exists). New attempts to play back the live stream will fail immediately. However, current viewers will be able to continue watching the stream for some period of time.
|
295
303
|
# @param live_stream_id [String] The live stream ID
|
296
304
|
# @param playback_id [String] The live stream's playback ID.
|
297
305
|
# @param [Hash] opts the optional parameters
|
@@ -603,6 +611,7 @@ module MuxRuby
|
|
603
611
|
end
|
604
612
|
|
605
613
|
# Retrieve a live stream playback ID
|
614
|
+
# Fetches information about a live stream's playback ID, through which a viewer can watch the streamed content from this live stream.
|
606
615
|
# @param live_stream_id [String] The live stream ID
|
607
616
|
# @param playback_id [String] The live stream's playback ID.
|
608
617
|
# @param [Hash] opts the optional parameters
|
@@ -613,6 +622,7 @@ module MuxRuby
|
|
613
622
|
end
|
614
623
|
|
615
624
|
# Retrieve a live stream playback ID
|
625
|
+
# Fetches information about a live stream's playback ID, through which a viewer can watch the streamed content from this live stream.
|
616
626
|
# @param live_stream_id [String] The live stream ID
|
617
627
|
# @param playback_id [String] The live stream's playback ID.
|
618
628
|
# @param [Hash] opts the optional parameters
|
@@ -739,10 +749,12 @@ module MuxRuby
|
|
739
749
|
end
|
740
750
|
|
741
751
|
# List live streams
|
752
|
+
# Lists the live streams that currently exist in the current environment.
|
742
753
|
# @param [Hash] opts the optional parameters
|
743
754
|
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
744
755
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
|
745
756
|
# @option opts [String] :stream_key Filter response to return live stream for this stream key only
|
757
|
+
# @option opts [LiveStreamStatus] :status Filter response to return live streams with the specified status only
|
746
758
|
# @return [ListLiveStreamsResponse]
|
747
759
|
def list_live_streams(opts = {})
|
748
760
|
data, _status_code, _headers = list_live_streams_with_http_info(opts)
|
@@ -750,10 +762,12 @@ module MuxRuby
|
|
750
762
|
end
|
751
763
|
|
752
764
|
# List live streams
|
765
|
+
# Lists the live streams that currently exist in the current environment.
|
753
766
|
# @param [Hash] opts the optional parameters
|
754
767
|
# @option opts [Integer] :limit Number of items to include in the response
|
755
768
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit`
|
756
769
|
# @option opts [String] :stream_key Filter response to return live stream for this stream key only
|
770
|
+
# @option opts [LiveStreamStatus] :status Filter response to return live streams with the specified status only
|
757
771
|
# @return [Array<(ListLiveStreamsResponse, Integer, Hash)>] ListLiveStreamsResponse data, response status code and response headers
|
758
772
|
def list_live_streams_with_http_info(opts = {})
|
759
773
|
if @api_client.config.debugging
|
@@ -767,6 +781,7 @@ module MuxRuby
|
|
767
781
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
768
782
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
769
783
|
query_params[:'stream_key'] = opts[:'stream_key'] if !opts[:'stream_key'].nil?
|
784
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
770
785
|
|
771
786
|
# header parameters
|
772
787
|
header_params = opts[:header_params] || {}
|
@@ -802,7 +817,7 @@ module MuxRuby
|
|
802
817
|
return data, status_code, headers
|
803
818
|
end
|
804
819
|
|
805
|
-
# Reset a live stream
|
820
|
+
# Reset a live stream's stream key
|
806
821
|
# Reset a live stream key if you want to immediately stop the current stream key from working and create a new stream key that can be used for future broadcasts.
|
807
822
|
# @param live_stream_id [String] The live stream ID
|
808
823
|
# @param [Hash] opts the optional parameters
|
@@ -812,7 +827,7 @@ module MuxRuby
|
|
812
827
|
data
|
813
828
|
end
|
814
829
|
|
815
|
-
# Reset a live stream
|
830
|
+
# Reset a live stream's stream key
|
816
831
|
# Reset a live stream key if you want to immediately stop the current stream key from working and create a new stream key that can be used for future broadcasts.
|
817
832
|
# @param live_stream_id [String] The live stream ID
|
818
833
|
# @param [Hash] opts the optional parameters
|
@@ -20,14 +20,14 @@ module MuxRuby
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Get metric timeseries data
|
23
|
-
# Returns timeseries data for a specific metric.
|
23
|
+
# 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
|
24
24
|
# @param metric_id [String] ID of the Metric
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @option opts [Array<String>] :timeframe 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`
|
27
27
|
# @option opts [Array<String>] :filters 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`
|
28
28
|
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
29
29
|
# @option opts [String] :order_direction Sort order.
|
30
|
-
# @option opts [String] :group_by Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.
|
30
|
+
# @option opts [String] :group_by 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 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.
|
31
31
|
# @return [GetMetricTimeseriesDataResponse]
|
32
32
|
def get_metric_timeseries_data(metric_id, opts = {})
|
33
33
|
data, _status_code, _headers = get_metric_timeseries_data_with_http_info(metric_id, opts)
|
@@ -35,14 +35,14 @@ module MuxRuby
|
|
35
35
|
end
|
36
36
|
|
37
37
|
# Get metric timeseries data
|
38
|
-
# Returns timeseries data for a specific metric.
|
38
|
+
# 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
|
39
39
|
# @param metric_id [String] ID of the Metric
|
40
40
|
# @param [Hash] opts the optional parameters
|
41
41
|
# @option opts [Array<String>] :timeframe 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`
|
42
42
|
# @option opts [Array<String>] :filters 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`
|
43
43
|
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
44
44
|
# @option opts [String] :order_direction Sort order.
|
45
|
-
# @option opts [String] :group_by Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.
|
45
|
+
# @option opts [String] :group_by 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 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.
|
46
46
|
# @return [Array<(GetMetricTimeseriesDataResponse, Integer, Hash)>] GetMetricTimeseriesDataResponse data, response status code and response headers
|
47
47
|
def get_metric_timeseries_data_with_http_info(metric_id, opts = {})
|
48
48
|
if @api_client.config.debugging
|
@@ -65,7 +65,7 @@ module MuxRuby
|
|
65
65
|
if @api_client.config.client_side_validation && opts[:'order_direction'] && !allowable_values.include?(opts[:'order_direction'])
|
66
66
|
fail ArgumentError, "invalid value for \"order_direction\", must be one of #{allowable_values}"
|
67
67
|
end
|
68
|
-
allowable_values = ["hour", "day"]
|
68
|
+
allowable_values = ["ten_minutes", "hour", "day"]
|
69
69
|
if @api_client.config.client_side_validation && opts[:'group_by'] && !allowable_values.include?(opts[:'group_by'])
|
70
70
|
fail ArgumentError, "invalid value for \"group_by\", must be one of #{allowable_values}"
|
71
71
|
end
|
@@ -23,7 +23,7 @@ module MuxRuby
|
|
23
23
|
# Create a new Playback Restriction.
|
24
24
|
# @param create_playback_restriction_request [CreatePlaybackRestrictionRequest]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @return [
|
26
|
+
# @return [PlaybackRestrictionResponse]
|
27
27
|
def create_playback_restriction(create_playback_restriction_request, opts = {})
|
28
28
|
data, _status_code, _headers = create_playback_restriction_with_http_info(create_playback_restriction_request, opts)
|
29
29
|
data
|
@@ -33,7 +33,7 @@ module MuxRuby
|
|
33
33
|
# Create a new Playback Restriction.
|
34
34
|
# @param create_playback_restriction_request [CreatePlaybackRestrictionRequest]
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
|
-
# @return [Array<(
|
36
|
+
# @return [Array<(PlaybackRestrictionResponse, Integer, Hash)>] PlaybackRestrictionResponse data, response status code and response headers
|
37
37
|
def create_playback_restriction_with_http_info(create_playback_restriction_request, opts = {})
|
38
38
|
if @api_client.config.debugging
|
39
39
|
@api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.create_playback_restriction ...'
|
@@ -62,7 +62,7 @@ module MuxRuby
|
|
62
62
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_playback_restriction_request)
|
63
63
|
|
64
64
|
# return_type
|
65
|
-
return_type = opts[:debug_return_type] || '
|
65
|
+
return_type = opts[:debug_return_type] || 'PlaybackRestrictionResponse'
|
66
66
|
|
67
67
|
# auth_names
|
68
68
|
auth_names = opts[:debug_auth_names] || ['accessToken']
|
@@ -149,7 +149,7 @@ module MuxRuby
|
|
149
149
|
# Retrieves a Playback Restriction associated with the unique identifier.
|
150
150
|
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
151
151
|
# @param [Hash] opts the optional parameters
|
152
|
-
# @return [
|
152
|
+
# @return [PlaybackRestrictionResponse]
|
153
153
|
def get_playback_restriction(playback_restriction_id, opts = {})
|
154
154
|
data, _status_code, _headers = get_playback_restriction_with_http_info(playback_restriction_id, opts)
|
155
155
|
data
|
@@ -159,7 +159,7 @@ module MuxRuby
|
|
159
159
|
# Retrieves a Playback Restriction associated with the unique identifier.
|
160
160
|
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
161
161
|
# @param [Hash] opts the optional parameters
|
162
|
-
# @return [Array<(
|
162
|
+
# @return [Array<(PlaybackRestrictionResponse, Integer, Hash)>] PlaybackRestrictionResponse data, response status code and response headers
|
163
163
|
def get_playback_restriction_with_http_info(playback_restriction_id, opts = {})
|
164
164
|
if @api_client.config.debugging
|
165
165
|
@api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.get_playback_restriction ...'
|
@@ -186,7 +186,7 @@ module MuxRuby
|
|
186
186
|
post_body = opts[:debug_body]
|
187
187
|
|
188
188
|
# return_type
|
189
|
-
return_type = opts[:debug_return_type] || '
|
189
|
+
return_type = opts[:debug_return_type] || 'PlaybackRestrictionResponse'
|
190
190
|
|
191
191
|
# auth_names
|
192
192
|
auth_names = opts[:debug_auth_names] || ['accessToken']
|
@@ -213,7 +213,7 @@ module MuxRuby
|
|
213
213
|
# @param [Hash] opts the optional parameters
|
214
214
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
|
215
215
|
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
216
|
-
# @return [
|
216
|
+
# @return [ListPlaybackRestrictionsResponse]
|
217
217
|
def list_playback_restrictions(opts = {})
|
218
218
|
data, _status_code, _headers = list_playback_restrictions_with_http_info(opts)
|
219
219
|
data
|
@@ -224,7 +224,7 @@ module MuxRuby
|
|
224
224
|
# @param [Hash] opts the optional parameters
|
225
225
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit`
|
226
226
|
# @option opts [Integer] :limit Number of items to include in the response
|
227
|
-
# @return [Array<(
|
227
|
+
# @return [Array<(ListPlaybackRestrictionsResponse, Integer, Hash)>] ListPlaybackRestrictionsResponse data, response status code and response headers
|
228
228
|
def list_playback_restrictions_with_http_info(opts = {})
|
229
229
|
if @api_client.config.debugging
|
230
230
|
@api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.list_playback_restrictions ...'
|
@@ -249,7 +249,7 @@ module MuxRuby
|
|
249
249
|
post_body = opts[:debug_body]
|
250
250
|
|
251
251
|
# return_type
|
252
|
-
return_type = opts[:debug_return_type] || '
|
252
|
+
return_type = opts[:debug_return_type] || 'ListPlaybackRestrictionsResponse'
|
253
253
|
|
254
254
|
# auth_names
|
255
255
|
auth_names = opts[:debug_auth_names] || ['accessToken']
|
@@ -272,23 +272,23 @@ module MuxRuby
|
|
272
272
|
end
|
273
273
|
|
274
274
|
# Update the Referrer Playback Restriction
|
275
|
-
# Allows you to modify the list of
|
275
|
+
# 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.
|
276
276
|
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
277
|
-
# @param
|
277
|
+
# @param update_referrer_domain_restriction_request [UpdateReferrerDomainRestrictionRequest]
|
278
278
|
# @param [Hash] opts the optional parameters
|
279
|
-
# @return [
|
280
|
-
def update_referrer_domain_restriction(playback_restriction_id,
|
281
|
-
data, _status_code, _headers = update_referrer_domain_restriction_with_http_info(playback_restriction_id,
|
279
|
+
# @return [PlaybackRestrictionResponse]
|
280
|
+
def update_referrer_domain_restriction(playback_restriction_id, update_referrer_domain_restriction_request, opts = {})
|
281
|
+
data, _status_code, _headers = update_referrer_domain_restriction_with_http_info(playback_restriction_id, update_referrer_domain_restriction_request, opts)
|
282
282
|
data
|
283
283
|
end
|
284
284
|
|
285
285
|
# Update the Referrer Playback Restriction
|
286
|
-
# Allows you to modify the list of
|
286
|
+
# 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.
|
287
287
|
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
288
|
-
# @param
|
288
|
+
# @param update_referrer_domain_restriction_request [UpdateReferrerDomainRestrictionRequest]
|
289
289
|
# @param [Hash] opts the optional parameters
|
290
|
-
# @return [Array<(
|
291
|
-
def update_referrer_domain_restriction_with_http_info(playback_restriction_id,
|
290
|
+
# @return [Array<(PlaybackRestrictionResponse, Integer, Hash)>] PlaybackRestrictionResponse data, response status code and response headers
|
291
|
+
def update_referrer_domain_restriction_with_http_info(playback_restriction_id, update_referrer_domain_restriction_request, opts = {})
|
292
292
|
if @api_client.config.debugging
|
293
293
|
@api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.update_referrer_domain_restriction ...'
|
294
294
|
end
|
@@ -296,9 +296,9 @@ module MuxRuby
|
|
296
296
|
if @api_client.config.client_side_validation && playback_restriction_id.nil?
|
297
297
|
fail ArgumentError, "Missing the required parameter 'playback_restriction_id' when calling PlaybackRestrictionsApi.update_referrer_domain_restriction"
|
298
298
|
end
|
299
|
-
# verify the required parameter '
|
300
|
-
if @api_client.config.client_side_validation &&
|
301
|
-
fail ArgumentError, "Missing the required parameter '
|
299
|
+
# verify the required parameter 'update_referrer_domain_restriction_request' is set
|
300
|
+
if @api_client.config.client_side_validation && update_referrer_domain_restriction_request.nil?
|
301
|
+
fail ArgumentError, "Missing the required parameter 'update_referrer_domain_restriction_request' when calling PlaybackRestrictionsApi.update_referrer_domain_restriction"
|
302
302
|
end
|
303
303
|
# resource path
|
304
304
|
local_var_path = '/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer'.sub('{' + 'PLAYBACK_RESTRICTION_ID' + '}', CGI.escape(playback_restriction_id.to_s))
|
@@ -317,10 +317,10 @@ module MuxRuby
|
|
317
317
|
form_params = opts[:form_params] || {}
|
318
318
|
|
319
319
|
# http body (model)
|
320
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
320
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_referrer_domain_restriction_request)
|
321
321
|
|
322
322
|
# return_type
|
323
|
-
return_type = opts[:debug_return_type] || '
|
323
|
+
return_type = opts[:debug_return_type] || 'PlaybackRestrictionResponse'
|
324
324
|
|
325
325
|
# auth_names
|
326
326
|
auth_names = opts[:debug_auth_names] || ['accessToken']
|
@@ -79,6 +79,13 @@ module MuxRuby
|
|
79
79
|
# List of attributes with nullable: true
|
80
80
|
def self.openapi_nullable
|
81
81
|
Set.new([
|
82
|
+
:'viewer_os_family',
|
83
|
+
:'viewer_application_name',
|
84
|
+
:'video_title',
|
85
|
+
:'player_error_message',
|
86
|
+
:'player_error_code',
|
87
|
+
:'error_type_id',
|
88
|
+
:'country_code',
|
82
89
|
])
|
83
90
|
end
|
84
91
|
|
@@ -22,10 +22,10 @@ module MuxRuby
|
|
22
22
|
# The audio codec used on the input file. Non-AAC audio codecs are non-standard.
|
23
23
|
attr_accessor :audio_codec
|
24
24
|
|
25
|
-
# The video key frame Interval (also called as Group of Picture or GOP) of the input file is `high`. This parameter is present when the gop is greater than
|
25
|
+
# The video key frame Interval (also called as Group of Picture or GOP) of the input file is `high`. This parameter is present when the gop is greater than 20 seconds.
|
26
26
|
attr_accessor :video_gop_size
|
27
27
|
|
28
|
-
# The video frame rate of the input file. Video with average frames per second (fps) less than
|
28
|
+
# The video frame rate of the input file. Video with average frames per second (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value indicates Mux could not determine the frame rate of the video track.
|
29
29
|
attr_accessor :video_frame_rate
|
30
30
|
|
31
31
|
# The video resolution of the input file. Video resolution higher than 2048 pixels on any one dimension (height or width) is considered non-standard, The resolution value is presented as `width` x `height` in pixels.
|