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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1506fef11ec5ebfcc6b5ac3373c2ca2c91b6517d12b0e4c80355328d7c4ac592
|
4
|
+
data.tar.gz: 1905ea66101553811136c0586b96a31e435ad119e97fcb60bfb60f8b7ffa6697
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9604f459a5072ec8c4f8f30f3f0b14ce3a486d058c8382cb4d1414d511fdb24b9db6dd87ff1c5e51f0a0d4e1a1fdbf6772c9d6af9d4a18e99720b3e8da6d5a2a
|
7
|
+
data.tar.gz: f77009abe3119763098c430d9c2899abd4cc116eed392617bbcd56215f2568c93a2f77cdc27aa7059897367f63d0b8e0b2aa74522f2e783f0b164de56e8f1d34
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
mux_ruby (3.
|
4
|
+
mux_ruby (3.4.0)
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
6
6
|
|
7
7
|
GEM
|
@@ -13,7 +13,7 @@ GEM
|
|
13
13
|
diff-lcs (1.3)
|
14
14
|
ethon (0.15.0)
|
15
15
|
ffi (>= 1.15.0)
|
16
|
-
ffi (1.15.
|
16
|
+
ffi (1.15.5)
|
17
17
|
jaro_winkler (1.5.4)
|
18
18
|
method_source (1.0.0)
|
19
19
|
parallel (1.20.1)
|
@@ -67,4 +67,4 @@ DEPENDENCIES
|
|
67
67
|
solid_assert
|
68
68
|
|
69
69
|
BUNDLED WITH
|
70
|
-
2.2.
|
70
|
+
2.2.25
|
data/README.md
CHANGED
@@ -17,7 +17,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
|
|
17
17
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
18
18
|
|
19
19
|
- API version: v1
|
20
|
-
- Package version: 3.
|
20
|
+
- Package version: 3.4.0
|
21
21
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
22
22
|
For more information, please visit [https://docs.mux.com](https://docs.mux.com)
|
23
23
|
|
@@ -34,16 +34,16 @@ gem build mux_ruby.gemspec
|
|
34
34
|
Then either install the gem locally:
|
35
35
|
|
36
36
|
```shell
|
37
|
-
gem install ./mux_ruby-3.
|
37
|
+
gem install ./mux_ruby-3.4.0.gem
|
38
38
|
```
|
39
39
|
|
40
|
-
(for development, run `gem install --dev ./mux_ruby-3.
|
40
|
+
(for development, run `gem install --dev ./mux_ruby-3.4.0.gem` to install the development dependencies)
|
41
41
|
|
42
42
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
43
43
|
|
44
44
|
Finally add this to the Gemfile:
|
45
45
|
|
46
|
-
gem 'mux_ruby', '~> 3.
|
46
|
+
gem 'mux_ruby', '~> 3.4.0'
|
47
47
|
|
48
48
|
### Install from Git
|
49
49
|
|
@@ -6,8 +6,8 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **video_codec** | **String** | The video codec used on the input file. For example, the input file encoded with `hevc` video codec is non-standard and the value of this parameter is `hevc`. | [optional] |
|
8
8
|
| **audio_codec** | **String** | The audio codec used on the input file. Non-AAC audio codecs are non-standard. | [optional] |
|
9
|
-
| **video_gop_size** | **String** | 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
|
10
|
-
| **video_frame_rate** | **String** | The video frame rate of the input file. Video with average frames per second (fps) less than
|
9
|
+
| **video_gop_size** | **String** | 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. | [optional] |
|
10
|
+
| **video_frame_rate** | **String** | 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. | [optional] |
|
11
11
|
| **video_resolution** | **String** | 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. | [optional] |
|
12
12
|
| **video_bitrate** | **String** | The video bitrate of the input file is `high`. This parameter is present when the average bitrate of any key frame interval (also known as Group of Pictures or GOP) is higher than what's considered standard which typically is 16 Mbps. | [optional] |
|
13
13
|
| **pixel_aspect_ratio** | **String** | The video pixel aspect ratio of the input file. | [optional] |
|
data/docs/AssetResponse.md
CHANGED
data/docs/AssetsApi.md
CHANGED
@@ -95,6 +95,8 @@ end
|
|
95
95
|
|
96
96
|
Create a playback ID
|
97
97
|
|
98
|
+
Creates a playback ID that can be used to stream the asset to a viewer.
|
99
|
+
|
98
100
|
### Examples
|
99
101
|
|
100
102
|
```ruby
|
@@ -165,6 +167,8 @@ end
|
|
165
167
|
|
166
168
|
Create an asset track
|
167
169
|
|
170
|
+
Adds an asset track (for example, subtitles) to an asset.
|
171
|
+
|
168
172
|
### Examples
|
169
173
|
|
170
174
|
```ruby
|
@@ -304,6 +308,8 @@ nil (empty response body)
|
|
304
308
|
|
305
309
|
Delete a playback ID
|
306
310
|
|
311
|
+
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.
|
312
|
+
|
307
313
|
### Examples
|
308
314
|
|
309
315
|
```ruby
|
@@ -584,6 +590,8 @@ end
|
|
584
590
|
|
585
591
|
Retrieve a playback ID
|
586
592
|
|
593
|
+
Retrieves information about the specified playback ID.
|
594
|
+
|
587
595
|
### Examples
|
588
596
|
|
589
597
|
```ruby
|
@@ -15,6 +15,7 @@
|
|
15
15
|
| **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] |
|
16
16
|
| **test** | **Boolean** | Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] |
|
17
17
|
| **simulcast_targets** | [**Array<CreateSimulcastTargetRequest>**](CreateSimulcastTargetRequest.md) | | [optional] |
|
18
|
+
| **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] |
|
18
19
|
|
19
20
|
## Example
|
20
21
|
|
@@ -32,7 +33,8 @@ instance = MuxRuby::CreateLiveStreamRequest.new(
|
|
32
33
|
low_latency: null,
|
33
34
|
latency_mode: null,
|
34
35
|
test: null,
|
35
|
-
simulcast_targets: null
|
36
|
+
simulcast_targets: null,
|
37
|
+
max_continuous_duration: null
|
36
38
|
)
|
37
39
|
```
|
38
40
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **referrer** | [**ReferrerDomainRestriction**](.md) | | [optional] |
|
7
|
+
| **referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional] |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
data/docs/CreateTrackResponse.md
CHANGED
data/docs/DirectUploadsApi.md
CHANGED
@@ -86,6 +86,8 @@ end
|
|
86
86
|
|
87
87
|
Create a new direct upload URL
|
88
88
|
|
89
|
+
Creates a new direct upload, through which video content can be uploaded for ingest to Mux.
|
90
|
+
|
89
91
|
### Examples
|
90
92
|
|
91
93
|
```ruby
|
@@ -154,6 +156,8 @@ end
|
|
154
156
|
|
155
157
|
Retrieve a single direct upload's info
|
156
158
|
|
159
|
+
Fetches information about a single direct upload in the current environment.
|
160
|
+
|
157
161
|
### Examples
|
158
162
|
|
159
163
|
```ruby
|
@@ -222,6 +226,8 @@ end
|
|
222
226
|
|
223
227
|
List direct uploads
|
224
228
|
|
229
|
+
Lists currently extant direct uploads in the current environment.
|
230
|
+
|
225
231
|
### Examples
|
226
232
|
|
227
233
|
```ruby
|
data/docs/IncidentResponse.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | [**Incident**](.md) | | [optional] |
|
7
|
+
| **data** | [**Incident**](Incident.md) | | [optional] |
|
8
8
|
| **timeframe** | **Array<Integer>** | | [optional] |
|
9
9
|
|
10
10
|
## Example
|
data/docs/InputSettings.md
CHANGED
@@ -8,10 +8,10 @@
|
|
8
8
|
| **overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) | | [optional] |
|
9
9
|
| **start_time** | **Float** | The time offset in seconds from the beginning of the video indicating the clip's starting marker. The default value is 0 when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format. | [optional] |
|
10
10
|
| **end_time** | **Float** | The time offset in seconds from the beginning of the video, indicating the clip's ending marker. The default value is the duration of the video when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format. | [optional] |
|
11
|
-
| **type** | **String** | This parameter is required for
|
12
|
-
| **text_type** | **String** | Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for `text`
|
11
|
+
| **type** | **String** | This parameter is required for `text` type tracks. | [optional] |
|
12
|
+
| **text_type** | **String** | Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for `text` type tracks. | [optional] |
|
13
13
|
| **language_code** | **String** | The language code value must be a valid [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 required for text type and subtitles text type track. | [optional] |
|
14
|
-
| **name** | **String** | The name of the track containing a human-readable description. This value must be unique across all text type and subtitles `text` type tracks. The hls manifest will associate a subtitle text track with this value. For example, the value should be \"English\" for subtitles text track with language_code as en. This optional parameter should be used only for `text` type and subtitles `text` type
|
14
|
+
| **name** | **String** | The name of the track containing a human-readable description. This value must be unique across all text type and subtitles `text` type tracks. The hls manifest will associate a subtitle text track with this value. For example, the value should be \"English\" for subtitles text track with language_code as en. This optional parameter should be used only for `text` type and subtitles `text` type tracks. If this parameter is not included, Mux will auto-populate based on the `input[].language_code` value. | [optional] |
|
15
15
|
| **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for `text` type and subtitles `text` type tracks. | [optional] |
|
16
16
|
| **passthrough** | **String** | This optional parameter should be used for `text` type and subtitles `text` type tracks. | [optional] |
|
17
17
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MuxRuby::ListPlaybackRestrictionsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<PlaybackRestriction>**](PlaybackRestriction.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::ListPlaybackRestrictionsResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/LiveStream.md
CHANGED
@@ -9,7 +9,7 @@
|
|
9
9
|
| **stream_key** | **String** | Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming. | [optional] |
|
10
10
|
| **active_asset_id** | **String** | The Asset that is currently being created if there is an active broadcast. | [optional] |
|
11
11
|
| **recent_asset_ids** | **Array<String>** | An array of strings with the most recent Assets that were created from this live stream. | [optional] |
|
12
|
-
| **status** | **
|
12
|
+
| **status** | [**LiveStreamStatus**](LiveStreamStatus.md) | | [optional] |
|
13
13
|
| **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional] |
|
14
14
|
| **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] |
|
15
15
|
| **passthrough** | **String** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] |
|
@@ -21,6 +21,7 @@
|
|
21
21
|
| **simulcast_targets** | [**Array<SimulcastTarget>**](SimulcastTarget.md) | Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/video/stream-live-to-3rd-party-platforms). | [optional] |
|
22
22
|
| **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] |
|
23
23
|
| **test** | **Boolean** | True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] |
|
24
|
+
| **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] |
|
24
25
|
|
25
26
|
## Example
|
26
27
|
|
@@ -44,7 +45,8 @@ instance = MuxRuby::LiveStream.new(
|
|
44
45
|
low_latency: null,
|
45
46
|
simulcast_targets: null,
|
46
47
|
latency_mode: null,
|
47
|
-
test: null
|
48
|
+
test: null,
|
49
|
+
max_continuous_duration: null
|
48
50
|
)
|
49
51
|
```
|
50
52
|
|
data/docs/LiveStreamResponse.md
CHANGED
data/docs/LiveStreamsApi.md
CHANGED
@@ -16,7 +16,7 @@ All URIs are relative to *https://api.mux.com*
|
|
16
16
|
| [**get_live_stream_playback_id**](LiveStreamsApi.md#get_live_stream_playback_id) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a live stream playback ID |
|
17
17
|
| [**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 |
|
18
18
|
| [**list_live_streams**](LiveStreamsApi.md#list_live_streams) | **GET** /video/v1/live-streams | List live streams |
|
19
|
-
| [**reset_stream_key**](LiveStreamsApi.md#reset_stream_key) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream
|
19
|
+
| [**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 |
|
20
20
|
| [**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 |
|
21
21
|
| [**update_live_stream**](LiveStreamsApi.md#update_live_stream) | **PATCH** /video/v1/live-streams/{LIVE_STREAM_ID} | Update a live stream |
|
22
22
|
| [**update_live_stream_embedded_subtitles**](LiveStreamsApi.md#update_live_stream_embedded_subtitles) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles | Update a live stream's embedded subtitles |
|
@@ -28,6 +28,8 @@ All URIs are relative to *https://api.mux.com*
|
|
28
28
|
|
29
29
|
Create a live stream
|
30
30
|
|
31
|
+
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
|
+
|
31
33
|
### Examples
|
32
34
|
|
33
35
|
```ruby
|
@@ -96,6 +98,8 @@ end
|
|
96
98
|
|
97
99
|
Create a live stream playback ID
|
98
100
|
|
101
|
+
Create a new playback ID for this live stream, through which a viewer can watch the streamed content of the live stream.
|
102
|
+
|
99
103
|
### Examples
|
100
104
|
|
101
105
|
```ruby
|
@@ -238,6 +242,8 @@ end
|
|
238
242
|
|
239
243
|
Delete a live stream
|
240
244
|
|
245
|
+
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.
|
246
|
+
|
241
247
|
### Examples
|
242
248
|
|
243
249
|
```ruby
|
@@ -305,6 +311,8 @@ nil (empty response body)
|
|
305
311
|
|
306
312
|
Delete a live stream playback ID
|
307
313
|
|
314
|
+
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.
|
315
|
+
|
308
316
|
### Examples
|
309
317
|
|
310
318
|
```ruby
|
@@ -655,6 +663,8 @@ end
|
|
655
663
|
|
656
664
|
Retrieve a live stream playback ID
|
657
665
|
|
666
|
+
Fetches information about a live stream's playback ID, through which a viewer can watch the streamed content from this live stream.
|
667
|
+
|
658
668
|
### Examples
|
659
669
|
|
660
670
|
```ruby
|
@@ -797,6 +807,8 @@ end
|
|
797
807
|
|
798
808
|
List live streams
|
799
809
|
|
810
|
+
Lists the live streams that currently exist in the current environment.
|
811
|
+
|
800
812
|
### Examples
|
801
813
|
|
802
814
|
```ruby
|
@@ -813,7 +825,8 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
813
825
|
opts = {
|
814
826
|
limit: 56, # Integer | Number of items to include in the response
|
815
827
|
page: 56, # Integer | Offset by this many pages, of the size of `limit`
|
816
|
-
stream_key: 'stream_key_example' # String | Filter response to return live stream for this stream key only
|
828
|
+
stream_key: 'stream_key_example', # String | Filter response to return live stream for this stream key only
|
829
|
+
status: MuxRuby::LiveStreamStatus::ACTIVE # LiveStreamStatus | Filter response to return live streams with the specified status only
|
817
830
|
}
|
818
831
|
|
819
832
|
begin
|
@@ -850,6 +863,7 @@ end
|
|
850
863
|
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
851
864
|
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
852
865
|
| **stream_key** | **String** | Filter response to return live stream for this stream key only | [optional] |
|
866
|
+
| **status** | [**LiveStreamStatus**](.md) | Filter response to return live streams with the specified status only | [optional] |
|
853
867
|
|
854
868
|
### Return type
|
855
869
|
|
@@ -869,7 +883,7 @@ end
|
|
869
883
|
|
870
884
|
> <LiveStreamResponse> reset_stream_key(live_stream_id)
|
871
885
|
|
872
|
-
Reset a live stream
|
886
|
+
Reset a live stream's stream key
|
873
887
|
|
874
888
|
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.
|
875
889
|
|
@@ -889,7 +903,7 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
889
903
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
890
904
|
|
891
905
|
begin
|
892
|
-
# Reset a live stream
|
906
|
+
# Reset a live stream's stream key
|
893
907
|
result = api_instance.reset_stream_key(live_stream_id)
|
894
908
|
p result
|
895
909
|
rescue MuxRuby::ApiError => e
|
@@ -905,7 +919,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
905
919
|
|
906
920
|
```ruby
|
907
921
|
begin
|
908
|
-
# Reset a live stream
|
922
|
+
# Reset a live stream's stream key
|
909
923
|
data, status_code, headers = api_instance.reset_stream_key_with_http_info(live_stream_id)
|
910
924
|
p status_code # => 2xx
|
911
925
|
p headers # => { ... }
|
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
|
|
@@ -38,7 +38,7 @@ opts = {
|
|
38
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: '
|
41
|
+
group_by: 'ten_minutes' # 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 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.
|
42
42
|
}
|
43
43
|
|
44
44
|
begin
|
@@ -77,7 +77,7 @@ end
|
|
77
77
|
| **filters** | [**Array<String>**](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 `!` 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` | [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 timeframe.
|
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 `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. | [optional] |
|
81
81
|
|
82
82
|
### Return type
|
83
83
|
|
@@ -4,12 +4,15 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**PlaybackRestriction**](PlaybackRestriction.md) | | [optional] |
|
7
8
|
|
8
9
|
## Example
|
9
10
|
|
10
11
|
```ruby
|
11
12
|
require 'mux_ruby'
|
12
13
|
|
13
|
-
instance = MuxRuby::PlaybackRestrictionResponse.new(
|
14
|
+
instance = MuxRuby::PlaybackRestrictionResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
14
17
|
```
|
15
18
|
|
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.mux.com*
|
|
13
13
|
|
14
14
|
## create_playback_restriction
|
15
15
|
|
16
|
-
> <
|
16
|
+
> <PlaybackRestrictionResponse> create_playback_restriction(create_playback_restriction_request)
|
17
17
|
|
18
18
|
Create a Playback Restriction
|
19
19
|
|
@@ -47,7 +47,7 @@ end
|
|
47
47
|
|
48
48
|
This returns an Array which contains the response data, status code and headers.
|
49
49
|
|
50
|
-
> <Array(<
|
50
|
+
> <Array(<PlaybackRestrictionResponse>, Integer, Hash)> create_playback_restriction_with_http_info(create_playback_restriction_request)
|
51
51
|
|
52
52
|
```ruby
|
53
53
|
begin
|
@@ -55,7 +55,7 @@ begin
|
|
55
55
|
data, status_code, headers = api_instance.create_playback_restriction_with_http_info(create_playback_restriction_request)
|
56
56
|
p status_code # => 2xx
|
57
57
|
p headers # => { ... }
|
58
|
-
p data # => <
|
58
|
+
p data # => <PlaybackRestrictionResponse>
|
59
59
|
rescue MuxRuby::ApiError => e
|
60
60
|
puts "Error when calling PlaybackRestrictionsApi->create_playback_restriction_with_http_info: #{e}"
|
61
61
|
end
|
@@ -69,7 +69,7 @@ end
|
|
69
69
|
|
70
70
|
### Return type
|
71
71
|
|
72
|
-
[**
|
72
|
+
[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
|
73
73
|
|
74
74
|
### Authorization
|
75
75
|
|
@@ -152,7 +152,7 @@ nil (empty response body)
|
|
152
152
|
|
153
153
|
## get_playback_restriction
|
154
154
|
|
155
|
-
> <
|
155
|
+
> <PlaybackRestrictionResponse> get_playback_restriction(playback_restriction_id)
|
156
156
|
|
157
157
|
Retrieve a Playback Restriction
|
158
158
|
|
@@ -186,7 +186,7 @@ end
|
|
186
186
|
|
187
187
|
This returns an Array which contains the response data, status code and headers.
|
188
188
|
|
189
|
-
> <Array(<
|
189
|
+
> <Array(<PlaybackRestrictionResponse>, Integer, Hash)> get_playback_restriction_with_http_info(playback_restriction_id)
|
190
190
|
|
191
191
|
```ruby
|
192
192
|
begin
|
@@ -194,7 +194,7 @@ begin
|
|
194
194
|
data, status_code, headers = api_instance.get_playback_restriction_with_http_info(playback_restriction_id)
|
195
195
|
p status_code # => 2xx
|
196
196
|
p headers # => { ... }
|
197
|
-
p data # => <
|
197
|
+
p data # => <PlaybackRestrictionResponse>
|
198
198
|
rescue MuxRuby::ApiError => e
|
199
199
|
puts "Error when calling PlaybackRestrictionsApi->get_playback_restriction_with_http_info: #{e}"
|
200
200
|
end
|
@@ -208,7 +208,7 @@ end
|
|
208
208
|
|
209
209
|
### Return type
|
210
210
|
|
211
|
-
[**
|
211
|
+
[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
|
212
212
|
|
213
213
|
### Authorization
|
214
214
|
|
@@ -222,7 +222,7 @@ end
|
|
222
222
|
|
223
223
|
## list_playback_restrictions
|
224
224
|
|
225
|
-
> <
|
225
|
+
> <ListPlaybackRestrictionsResponse> list_playback_restrictions(opts)
|
226
226
|
|
227
227
|
List Playback Restrictions
|
228
228
|
|
@@ -259,7 +259,7 @@ end
|
|
259
259
|
|
260
260
|
This returns an Array which contains the response data, status code and headers.
|
261
261
|
|
262
|
-
> <Array(<
|
262
|
+
> <Array(<ListPlaybackRestrictionsResponse>, Integer, Hash)> list_playback_restrictions_with_http_info(opts)
|
263
263
|
|
264
264
|
```ruby
|
265
265
|
begin
|
@@ -267,7 +267,7 @@ begin
|
|
267
267
|
data, status_code, headers = api_instance.list_playback_restrictions_with_http_info(opts)
|
268
268
|
p status_code # => 2xx
|
269
269
|
p headers # => { ... }
|
270
|
-
p data # => <
|
270
|
+
p data # => <ListPlaybackRestrictionsResponse>
|
271
271
|
rescue MuxRuby::ApiError => e
|
272
272
|
puts "Error when calling PlaybackRestrictionsApi->list_playback_restrictions_with_http_info: #{e}"
|
273
273
|
end
|
@@ -282,7 +282,7 @@ end
|
|
282
282
|
|
283
283
|
### Return type
|
284
284
|
|
285
|
-
[**
|
285
|
+
[**ListPlaybackRestrictionsResponse**](ListPlaybackRestrictionsResponse.md)
|
286
286
|
|
287
287
|
### Authorization
|
288
288
|
|
@@ -296,11 +296,11 @@ end
|
|
296
296
|
|
297
297
|
## update_referrer_domain_restriction
|
298
298
|
|
299
|
-
> <
|
299
|
+
> <PlaybackRestrictionResponse> update_referrer_domain_restriction(playback_restriction_id, update_referrer_domain_restriction_request)
|
300
300
|
|
301
301
|
Update the Referrer Playback Restriction
|
302
302
|
|
303
|
-
Allows you to modify the list of
|
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
304
|
|
305
305
|
### Examples
|
306
306
|
|
@@ -316,11 +316,11 @@ end
|
|
316
316
|
|
317
317
|
api_instance = MuxRuby::PlaybackRestrictionsApi.new
|
318
318
|
playback_restriction_id = 'playback_restriction_id_example' # String | ID of the Playback Restriction.
|
319
|
-
|
319
|
+
update_referrer_domain_restriction_request = MuxRuby::ReferrerDomainRestriction.new # UpdateReferrerDomainRestrictionRequest |
|
320
320
|
|
321
321
|
begin
|
322
322
|
# Update the Referrer Playback Restriction
|
323
|
-
result = api_instance.update_referrer_domain_restriction(playback_restriction_id,
|
323
|
+
result = api_instance.update_referrer_domain_restriction(playback_restriction_id, update_referrer_domain_restriction_request)
|
324
324
|
p result
|
325
325
|
rescue MuxRuby::ApiError => e
|
326
326
|
puts "Error when calling PlaybackRestrictionsApi->update_referrer_domain_restriction: #{e}"
|
@@ -331,15 +331,15 @@ end
|
|
331
331
|
|
332
332
|
This returns an Array which contains the response data, status code and headers.
|
333
333
|
|
334
|
-
> <Array(<
|
334
|
+
> <Array(<PlaybackRestrictionResponse>, Integer, Hash)> update_referrer_domain_restriction_with_http_info(playback_restriction_id, update_referrer_domain_restriction_request)
|
335
335
|
|
336
336
|
```ruby
|
337
337
|
begin
|
338
338
|
# Update the Referrer Playback Restriction
|
339
|
-
data, status_code, headers = api_instance.update_referrer_domain_restriction_with_http_info(playback_restriction_id,
|
339
|
+
data, status_code, headers = api_instance.update_referrer_domain_restriction_with_http_info(playback_restriction_id, update_referrer_domain_restriction_request)
|
340
340
|
p status_code # => 2xx
|
341
341
|
p headers # => { ... }
|
342
|
-
p data # => <
|
342
|
+
p data # => <PlaybackRestrictionResponse>
|
343
343
|
rescue MuxRuby::ApiError => e
|
344
344
|
puts "Error when calling PlaybackRestrictionsApi->update_referrer_domain_restriction_with_http_info: #{e}"
|
345
345
|
end
|
@@ -350,11 +350,11 @@ end
|
|
350
350
|
| Name | Type | Description | Notes |
|
351
351
|
| ---- | ---- | ----------- | ----- |
|
352
352
|
| **playback_restriction_id** | **String** | ID of the Playback Restriction. | |
|
353
|
-
| **
|
353
|
+
| **update_referrer_domain_restriction_request** | [**UpdateReferrerDomainRestrictionRequest**](UpdateReferrerDomainRestrictionRequest.md) | | |
|
354
354
|
|
355
355
|
### Return type
|
356
356
|
|
357
|
-
[**
|
357
|
+
[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
|
358
358
|
|
359
359
|
### Authorization
|
360
360
|
|