mux_ruby 3.1.0 → 3.2.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 +2 -2
- data/README.md +4 -4
- data/docs/Asset.md +1 -1
- data/docs/AssetsApi.md +73 -0
- data/docs/CreateAssetRequest.md +1 -1
- data/docs/CreateLiveStreamRequest.md +4 -2
- data/docs/CreatePlaybackRestrictionRequest.md +18 -0
- data/docs/CreateSimulcastTargetRequest.md +1 -1
- data/docs/CreateTrackRequest.md +1 -1
- data/docs/DeliveryUsageApi.md +4 -2
- data/docs/DimensionsApi.md +4 -4
- data/docs/ErrorsApi.md +4 -4
- data/docs/FiltersApi.md +4 -4
- data/docs/InputSettings.md +1 -1
- data/docs/LiveStream.md +7 -3
- data/docs/LiveStreamEmbeddedSubtitleSettings.md +1 -1
- data/docs/LiveStreamsApi.md +73 -0
- data/docs/MetricsApi.md +18 -18
- data/docs/PlaybackRestriction.md +24 -0
- data/docs/PlaybackRestrictionResponse.md +15 -0
- data/docs/PlaybackRestrictionsApi.md +367 -0
- data/docs/RealTimeApi.md +6 -6
- data/docs/ReferrerDomainRestriction.md +20 -0
- data/docs/SimulcastTarget.md +1 -1
- data/docs/Track.md +1 -1
- data/docs/UpdateAssetRequest.md +18 -0
- data/docs/UpdateLiveStreamRequest.md +22 -0
- data/docs/UpdateReferrerDomainRestrictionRequest.md +15 -0
- data/docs/VideoViewsApi.md +4 -4
- data/gen/generator-config.json +1 -1
- data/lib/mux_ruby/api/assets_api.rb +71 -0
- data/lib/mux_ruby/api/delivery_usage_api.rb +5 -2
- data/lib/mux_ruby/api/dimensions_api.rb +4 -4
- data/lib/mux_ruby/api/errors_api.rb +4 -4
- data/lib/mux_ruby/api/filters_api.rb +4 -4
- data/lib/mux_ruby/api/live_streams_api.rb +71 -0
- data/lib/mux_ruby/api/metrics_api.rb +18 -18
- data/lib/mux_ruby/api/playback_restrictions_api.rb +345 -0
- data/lib/mux_ruby/api/real_time_api.rb +6 -6
- data/lib/mux_ruby/api/video_views_api.rb +4 -4
- data/lib/mux_ruby/models/asset.rb +1 -1
- data/lib/mux_ruby/models/create_asset_request.rb +1 -1
- data/lib/mux_ruby/models/create_live_stream_request.rb +47 -3
- data/lib/mux_ruby/models/create_playback_restriction_request.rb +218 -0
- data/lib/mux_ruby/models/create_simulcast_target_request.rb +1 -1
- data/lib/mux_ruby/models/create_track_request.rb +1 -1
- data/lib/mux_ruby/models/input_settings.rb +1 -1
- data/lib/mux_ruby/models/input_settings_overlay_settings.rb +1 -1
- data/lib/mux_ruby/models/live_stream.rb +38 -4
- data/lib/mux_ruby/models/live_stream_embedded_subtitle_settings.rb +1 -1
- data/lib/mux_ruby/models/playback_restriction.rb +248 -0
- data/lib/mux_ruby/models/playback_restriction_response.rb +209 -0
- data/lib/mux_ruby/models/referrer_domain_restriction.rb +234 -0
- data/lib/mux_ruby/models/simulcast_target.rb +1 -1
- data/lib/mux_ruby/models/track.rb +1 -1
- data/lib/mux_ruby/models/update_asset_request.rb +219 -0
- data/lib/mux_ruby/models/update_live_stream_request.rb +297 -0
- data/lib/mux_ruby/models/update_referrer_domain_restriction_request.rb +209 -0
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +8 -0
- data/spec/api/playback_restrictions_api_spec.rb +97 -0
- data/spec/models/create_playback_restriction_request_spec.rb +34 -0
- data/spec/models/playback_restriction_response_spec.rb +28 -0
- data/spec/models/playback_restriction_spec.rb +52 -0
- data/spec/models/referrer_domain_restriction_spec.rb +40 -0
- data/spec/models/update_asset_request_spec.rb +34 -0
- data/spec/models/update_live_stream_request_spec.rb +50 -0
- data/spec/models/update_referrer_domain_restriction_request_spec.rb +28 -0
- metadata +129 -97
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a63c390b26263da0a802a7cbce36ad9b2938b39ed68da78099750b59c21a32b4
|
|
4
|
+
data.tar.gz: 6a52eba37eeb1b825eb169d852a73a141f07b339dd38f4de6ffbc428dab0bdf9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: dddc47ce920e32ba44a453af1504f3b790a690c69bf9465e090a912c823012c51a1c4c5e20d39f117b89087256921d8ec2f155bf9b16abd2dc56fbe271192cc6
|
|
7
|
+
data.tar.gz: ca207a01923be742f9836f4cd1703ab9d5018e782f790d824bc56390c55884e3780b9d08e91b4a7824928d534b778c49f8c996b06e0fee71c44036470575fe99
|
data/Gemfile.lock
CHANGED
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.2.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.2.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.2.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.2.0'
|
|
47
47
|
|
|
48
48
|
### Install from Git
|
|
49
49
|
|
data/docs/Asset.md
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
| **per_title_encode** | **Boolean** | | [optional] |
|
|
18
18
|
| **upload_id** | **String** | Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload. | [optional] |
|
|
19
19
|
| **is_live** | **Boolean** | Whether the asset is created from a live stream and the live stream is currently `active` and not in `idle` state. | [optional] |
|
|
20
|
-
| **passthrough** | **String** | Arbitrary metadata set for the asset. Max 255 characters. | [optional] |
|
|
20
|
+
| **passthrough** | **String** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] |
|
|
21
21
|
| **live_stream_id** | **String** | Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream. | [optional] |
|
|
22
22
|
| **master** | [**AssetMaster**](AssetMaster.md) | | [optional] |
|
|
23
23
|
| **master_access** | **String** | | [optional][default to 'none'] |
|
data/docs/AssetsApi.md
CHANGED
|
@@ -14,6 +14,7 @@ All URIs are relative to *https://api.mux.com*
|
|
|
14
14
|
| [**get_asset_input_info**](AssetsApi.md#get_asset_input_info) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info |
|
|
15
15
|
| [**get_asset_playback_id**](AssetsApi.md#get_asset_playback_id) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID |
|
|
16
16
|
| [**list_assets**](AssetsApi.md#list_assets) | **GET** /video/v1/assets | List assets |
|
|
17
|
+
| [**update_asset**](AssetsApi.md#update_asset) | **PATCH** /video/v1/assets/{ASSET_ID} | Update an Asset |
|
|
17
18
|
| [**update_asset_master_access**](AssetsApi.md#update_asset_master_access) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access |
|
|
18
19
|
| [**update_asset_mp4_support**](AssetsApi.md#update_asset_mp4_support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support |
|
|
19
20
|
|
|
@@ -725,6 +726,78 @@ end
|
|
|
725
726
|
- **Accept**: application/json
|
|
726
727
|
|
|
727
728
|
|
|
729
|
+
## update_asset
|
|
730
|
+
|
|
731
|
+
> <AssetResponse> update_asset(asset_id, update_asset_request)
|
|
732
|
+
|
|
733
|
+
Update an Asset
|
|
734
|
+
|
|
735
|
+
Updates the details of an already-created Asset with the provided Asset ID. This currently supports only the `passthrough` field.
|
|
736
|
+
|
|
737
|
+
### Examples
|
|
738
|
+
|
|
739
|
+
```ruby
|
|
740
|
+
require 'time'
|
|
741
|
+
require 'mux_ruby'
|
|
742
|
+
# setup authorization
|
|
743
|
+
MuxRuby.configure do |config|
|
|
744
|
+
# Configure HTTP basic authorization: accessToken
|
|
745
|
+
config.username = 'YOUR USERNAME'
|
|
746
|
+
config.password = 'YOUR PASSWORD'
|
|
747
|
+
end
|
|
748
|
+
|
|
749
|
+
api_instance = MuxRuby::AssetsApi.new
|
|
750
|
+
asset_id = 'asset_id_example' # String | The asset ID.
|
|
751
|
+
update_asset_request = MuxRuby::UpdateAssetRequest.new # UpdateAssetRequest |
|
|
752
|
+
|
|
753
|
+
begin
|
|
754
|
+
# Update an Asset
|
|
755
|
+
result = api_instance.update_asset(asset_id, update_asset_request)
|
|
756
|
+
p result
|
|
757
|
+
rescue MuxRuby::ApiError => e
|
|
758
|
+
puts "Error when calling AssetsApi->update_asset: #{e}"
|
|
759
|
+
end
|
|
760
|
+
```
|
|
761
|
+
|
|
762
|
+
#### Using the update_asset_with_http_info variant
|
|
763
|
+
|
|
764
|
+
This returns an Array which contains the response data, status code and headers.
|
|
765
|
+
|
|
766
|
+
> <Array(<AssetResponse>, Integer, Hash)> update_asset_with_http_info(asset_id, update_asset_request)
|
|
767
|
+
|
|
768
|
+
```ruby
|
|
769
|
+
begin
|
|
770
|
+
# Update an Asset
|
|
771
|
+
data, status_code, headers = api_instance.update_asset_with_http_info(asset_id, update_asset_request)
|
|
772
|
+
p status_code # => 2xx
|
|
773
|
+
p headers # => { ... }
|
|
774
|
+
p data # => <AssetResponse>
|
|
775
|
+
rescue MuxRuby::ApiError => e
|
|
776
|
+
puts "Error when calling AssetsApi->update_asset_with_http_info: #{e}"
|
|
777
|
+
end
|
|
778
|
+
```
|
|
779
|
+
|
|
780
|
+
### Parameters
|
|
781
|
+
|
|
782
|
+
| Name | Type | Description | Notes |
|
|
783
|
+
| ---- | ---- | ----------- | ----- |
|
|
784
|
+
| **asset_id** | **String** | The asset ID. | |
|
|
785
|
+
| **update_asset_request** | [**UpdateAssetRequest**](UpdateAssetRequest.md) | | |
|
|
786
|
+
|
|
787
|
+
### Return type
|
|
788
|
+
|
|
789
|
+
[**AssetResponse**](AssetResponse.md)
|
|
790
|
+
|
|
791
|
+
### Authorization
|
|
792
|
+
|
|
793
|
+
[accessToken](../README.md#accessToken)
|
|
794
|
+
|
|
795
|
+
### HTTP request headers
|
|
796
|
+
|
|
797
|
+
- **Content-Type**: application/json
|
|
798
|
+
- **Accept**: application/json
|
|
799
|
+
|
|
800
|
+
|
|
728
801
|
## update_asset_master_access
|
|
729
802
|
|
|
730
803
|
> <AssetResponse> update_asset_master_access(asset_id, update_asset_master_access_request)
|
data/docs/CreateAssetRequest.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **input** | [**Array<InputSettings>**](InputSettings.md) | An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See `input[].url` for requirements. | [optional] |
|
|
8
8
|
| **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: `\"public\"` (anyone with the playback URL can stream the asset). And `\"signed\"` (an additional access token is required to play the asset). If no playback_policy is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional] |
|
|
9
9
|
| **per_title_encode** | **Boolean** | | [optional] |
|
|
10
|
-
| **passthrough** | **String** | Arbitrary metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] |
|
|
10
|
+
| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] |
|
|
11
11
|
| **mp4_support** | **String** | Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] |
|
|
12
12
|
| **normalize_audio** | **Boolean** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional][default to false] |
|
|
13
13
|
| **master_access** | **String** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] |
|
|
@@ -10,8 +10,9 @@
|
|
|
10
10
|
| **passthrough** | **String** | | [optional] |
|
|
11
11
|
| **audio_only** | **Boolean** | Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted. | [optional] |
|
|
12
12
|
| **embedded_subtitles** | [**Array<LiveStreamEmbeddedSubtitleSettings>**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional] |
|
|
13
|
-
| **reduced_latency** | **Boolean** | Latency is the time from when the streamer
|
|
14
|
-
| **low_latency** | **Boolean** | Latency is the time from when the streamer
|
|
13
|
+
| **reduced_latency** | **Boolean** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. Note: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] |
|
|
14
|
+
| **low_latency** | **Boolean** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional] |
|
|
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] |
|
|
15
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] |
|
|
16
17
|
| **simulcast_targets** | [**Array<CreateSimulcastTargetRequest>**](CreateSimulcastTargetRequest.md) | | [optional] |
|
|
17
18
|
|
|
@@ -29,6 +30,7 @@ instance = MuxRuby::CreateLiveStreamRequest.new(
|
|
|
29
30
|
embedded_subtitles: null,
|
|
30
31
|
reduced_latency: null,
|
|
31
32
|
low_latency: null,
|
|
33
|
+
latency_mode: null,
|
|
32
34
|
test: null,
|
|
33
35
|
simulcast_targets: null
|
|
34
36
|
)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# MuxRuby::CreatePlaybackRestrictionRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **referrer** | [**ReferrerDomainRestriction**](.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'mux_ruby'
|
|
13
|
+
|
|
14
|
+
instance = MuxRuby::CreatePlaybackRestrictionRequest.new(
|
|
15
|
+
referrer: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **passthrough** | **String** | Arbitrary metadata set by you when creating a simulcast target. | [optional] |
|
|
7
|
+
| **passthrough** | **String** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional] |
|
|
8
8
|
| **stream_key** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional] |
|
|
9
9
|
| **url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: 'rtmp://live.example.com/app'. | |
|
|
10
10
|
|
data/docs/CreateTrackRequest.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **language_code** | **String** | The language code value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English. | |
|
|
11
11
|
| **name** | **String** | The name of the track containing a human-readable description. This value must be unique across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to \"English\" for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value. | [optional] |
|
|
12
12
|
| **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional] |
|
|
13
|
-
| **passthrough** | **String** | Arbitrary metadata set for the track either when creating the asset or track. | [optional] |
|
|
13
|
+
| **passthrough** | **String** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. | [optional] |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
data/docs/DeliveryUsageApi.md
CHANGED
|
@@ -31,7 +31,8 @@ api_instance = MuxRuby::DeliveryUsageApi.new
|
|
|
31
31
|
opts = {
|
|
32
32
|
page: 56, # Integer | Offset by this many pages, of the size of `limit`
|
|
33
33
|
limit: 56, # Integer | Number of items to include in the response
|
|
34
|
-
asset_id: 'asset_id_example', # String | Filter response to return delivery usage for this asset only.
|
|
34
|
+
asset_id: 'asset_id_example', # String | Filter response to return delivery usage for this asset only. You cannot specify both the `asset_id` and `live_stream_id` parameters together.
|
|
35
|
+
live_stream_id: 'live_stream_id_example', # String | Filter response to return delivery usage for assets for this live stream. You cannot specify both the `asset_id` and `live_stream_id` parameters together.
|
|
35
36
|
timeframe: ['inner_example'] # Array<String> | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.
|
|
36
37
|
}
|
|
37
38
|
|
|
@@ -68,7 +69,8 @@ end
|
|
|
68
69
|
| ---- | ---- | ----------- | ----- |
|
|
69
70
|
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
|
70
71
|
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 100] |
|
|
71
|
-
| **asset_id** | **String** | Filter response to return delivery usage for this asset only. | [optional] |
|
|
72
|
+
| **asset_id** | **String** | Filter response to return delivery usage for this asset only. You cannot specify both the `asset_id` and `live_stream_id` parameters together. | [optional] |
|
|
73
|
+
| **live_stream_id** | **String** | Filter response to return delivery usage for assets for this live stream. You cannot specify both the `asset_id` and `live_stream_id` parameters together. | [optional] |
|
|
72
74
|
| **timeframe** | [**Array<String>**](String.md) | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. | [optional] |
|
|
73
75
|
|
|
74
76
|
### Return type
|
data/docs/DimensionsApi.md
CHANGED
|
@@ -33,8 +33,8 @@ dimension_id = 'abcd1234' # String | ID of the Dimension
|
|
|
33
33
|
opts = {
|
|
34
34
|
limit: 56, # Integer | Number of items to include in the response
|
|
35
35
|
page: 56, # Integer | Offset by this many pages, of the size of `limit`
|
|
36
|
-
filters: ['inner_example'], # Array<String> |
|
|
37
|
-
timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
|
36
|
+
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`
|
|
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
38
|
}
|
|
39
39
|
|
|
40
40
|
begin
|
|
@@ -71,8 +71,8 @@ end
|
|
|
71
71
|
| **dimension_id** | **String** | ID of the Dimension | |
|
|
72
72
|
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
|
73
73
|
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
|
74
|
-
| **filters** | [**Array<String>**](String.md) |
|
|
75
|
-
| **timeframe** | [**Array<String>**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
|
74
|
+
| **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] |
|
|
75
|
+
| **timeframe** | [**Array<String>**](String.md) | 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` | [optional] |
|
|
76
76
|
|
|
77
77
|
### Return type
|
|
78
78
|
|
data/docs/ErrorsApi.md
CHANGED
|
@@ -29,8 +29,8 @@ end
|
|
|
29
29
|
|
|
30
30
|
api_instance = MuxRuby::ErrorsApi.new
|
|
31
31
|
opts = {
|
|
32
|
-
filters: ['inner_example'], # Array<String> |
|
|
33
|
-
timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
|
32
|
+
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`
|
|
33
|
+
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`
|
|
34
34
|
}
|
|
35
35
|
|
|
36
36
|
begin
|
|
@@ -64,8 +64,8 @@ end
|
|
|
64
64
|
|
|
65
65
|
| Name | Type | Description | Notes |
|
|
66
66
|
| ---- | ---- | ----------- | ----- |
|
|
67
|
-
| **filters** | [**Array<String>**](String.md) |
|
|
68
|
-
| **timeframe** | [**Array<String>**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
|
67
|
+
| **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] |
|
|
68
|
+
| **timeframe** | [**Array<String>**](String.md) | 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` | [optional] |
|
|
69
69
|
|
|
70
70
|
### Return type
|
|
71
71
|
|
data/docs/FiltersApi.md
CHANGED
|
@@ -33,8 +33,8 @@ filter_id = 'abcd1234' # String | ID of the Filter
|
|
|
33
33
|
opts = {
|
|
34
34
|
limit: 56, # Integer | Number of items to include in the response
|
|
35
35
|
page: 56, # Integer | Offset by this many pages, of the size of `limit`
|
|
36
|
-
filters: ['inner_example'], # Array<String> |
|
|
37
|
-
timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
|
36
|
+
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`
|
|
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
38
|
}
|
|
39
39
|
|
|
40
40
|
begin
|
|
@@ -71,8 +71,8 @@ end
|
|
|
71
71
|
| **filter_id** | **String** | ID of the Filter | |
|
|
72
72
|
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
|
73
73
|
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
|
74
|
-
| **filters** | [**Array<String>**](String.md) |
|
|
75
|
-
| **timeframe** | [**Array<String>**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
|
74
|
+
| **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] |
|
|
75
|
+
| **timeframe** | [**Array<String>**](String.md) | 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` | [optional] |
|
|
76
76
|
|
|
77
77
|
### Return type
|
|
78
78
|
|
data/docs/InputSettings.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **url** | **String** | The
|
|
7
|
+
| **url** | **String** | The URL of the file that Mux should download and use. * For subtitles text tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) format for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. | [optional] |
|
|
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] |
|
data/docs/LiveStream.md
CHANGED
|
@@ -12,12 +12,14 @@
|
|
|
12
12
|
| **status** | **String** | `idle` indicates that there is no active broadcast. `active` indicates that there is an active broadcast and `disabled` status indicates that no future RTMP streams can be published. | [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
|
-
| **passthrough** | **String** | Arbitrary metadata set for the asset. Max 255 characters. | [optional] |
|
|
15
|
+
| **passthrough** | **String** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] |
|
|
16
16
|
| **audio_only** | **Boolean** | The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted. | [optional] |
|
|
17
|
+
| **embedded_subtitles** | [**Array<LiveStreamEmbeddedSubtitleSettings>**](LiveStreamEmbeddedSubtitleSettings.md) | Describes the embedded closed caption configuration of the incoming live stream. | [optional] |
|
|
17
18
|
| **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. **Min**: 0.1s. **Max**: 300s (5 minutes). | [optional][default to 60] |
|
|
18
|
-
| **reduced_latency** | **Boolean** | Latency is the time from when the streamer
|
|
19
|
-
| **low_latency** | **Boolean** | Latency is the time from when the streamer
|
|
19
|
+
| **reduced_latency** | **Boolean** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. **Note**: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional] |
|
|
20
|
+
| **low_latency** | **Boolean** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional] |
|
|
20
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
|
+
| **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] |
|
|
21
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] |
|
|
22
24
|
|
|
23
25
|
## Example
|
|
@@ -36,10 +38,12 @@ instance = MuxRuby::LiveStream.new(
|
|
|
36
38
|
new_asset_settings: null,
|
|
37
39
|
passthrough: null,
|
|
38
40
|
audio_only: null,
|
|
41
|
+
embedded_subtitles: null,
|
|
39
42
|
reconnect_window: null,
|
|
40
43
|
reduced_latency: null,
|
|
41
44
|
low_latency: null,
|
|
42
45
|
simulcast_targets: null,
|
|
46
|
+
latency_mode: null,
|
|
43
47
|
test: null
|
|
44
48
|
)
|
|
45
49
|
```
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | A name for this live stream closed caption track. | [optional] |
|
|
8
|
-
| **passthrough** | **String** | Arbitrary metadata set for the live stream closed caption track. Max 255 characters. | [optional] |
|
|
8
|
+
| **passthrough** | **String** | Arbitrary user-supplied metadata set for the live stream closed caption track. Max 255 characters. | [optional] |
|
|
9
9
|
| **language_code** | **String** | The language of the closed caption stream. Value must be BCP 47 compliant. | [optional][default to 'en'] |
|
|
10
10
|
| **language_channel** | **String** | CEA-608 caption channel to read data from. | [optional][default to 'cc1'] |
|
|
11
11
|
|
data/docs/LiveStreamsApi.md
CHANGED
|
@@ -18,6 +18,7 @@ All URIs are relative to *https://api.mux.com*
|
|
|
18
18
|
| [**list_live_streams**](LiveStreamsApi.md#list_live_streams) | **GET** /video/v1/live-streams | List live streams |
|
|
19
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
|
+
| [**update_live_stream**](LiveStreamsApi.md#update_live_stream) | **PATCH** /video/v1/live-streams/{LIVE_STREAM_ID} | Update a live stream |
|
|
21
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 |
|
|
22
23
|
|
|
23
24
|
|
|
@@ -1004,6 +1005,78 @@ end
|
|
|
1004
1005
|
- **Accept**: application/json
|
|
1005
1006
|
|
|
1006
1007
|
|
|
1008
|
+
## update_live_stream
|
|
1009
|
+
|
|
1010
|
+
> <LiveStreamResponse> update_live_stream(live_stream_id, update_live_stream_request)
|
|
1011
|
+
|
|
1012
|
+
Update a live stream
|
|
1013
|
+
|
|
1014
|
+
Updates the parameters of a previously-created live stream. This currently supports a subset of variables. Supply the live stream ID and the updated parameters and Mux will return the corresponding live stream information. The information returned will be the same after update as for subsequent get live stream requests.
|
|
1015
|
+
|
|
1016
|
+
### Examples
|
|
1017
|
+
|
|
1018
|
+
```ruby
|
|
1019
|
+
require 'time'
|
|
1020
|
+
require 'mux_ruby'
|
|
1021
|
+
# setup authorization
|
|
1022
|
+
MuxRuby.configure do |config|
|
|
1023
|
+
# Configure HTTP basic authorization: accessToken
|
|
1024
|
+
config.username = 'YOUR USERNAME'
|
|
1025
|
+
config.password = 'YOUR PASSWORD'
|
|
1026
|
+
end
|
|
1027
|
+
|
|
1028
|
+
api_instance = MuxRuby::LiveStreamsApi.new
|
|
1029
|
+
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
|
1030
|
+
update_live_stream_request = MuxRuby::UpdateLiveStreamRequest.new # UpdateLiveStreamRequest |
|
|
1031
|
+
|
|
1032
|
+
begin
|
|
1033
|
+
# Update a live stream
|
|
1034
|
+
result = api_instance.update_live_stream(live_stream_id, update_live_stream_request)
|
|
1035
|
+
p result
|
|
1036
|
+
rescue MuxRuby::ApiError => e
|
|
1037
|
+
puts "Error when calling LiveStreamsApi->update_live_stream: #{e}"
|
|
1038
|
+
end
|
|
1039
|
+
```
|
|
1040
|
+
|
|
1041
|
+
#### Using the update_live_stream_with_http_info variant
|
|
1042
|
+
|
|
1043
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1044
|
+
|
|
1045
|
+
> <Array(<LiveStreamResponse>, Integer, Hash)> update_live_stream_with_http_info(live_stream_id, update_live_stream_request)
|
|
1046
|
+
|
|
1047
|
+
```ruby
|
|
1048
|
+
begin
|
|
1049
|
+
# Update a live stream
|
|
1050
|
+
data, status_code, headers = api_instance.update_live_stream_with_http_info(live_stream_id, update_live_stream_request)
|
|
1051
|
+
p status_code # => 2xx
|
|
1052
|
+
p headers # => { ... }
|
|
1053
|
+
p data # => <LiveStreamResponse>
|
|
1054
|
+
rescue MuxRuby::ApiError => e
|
|
1055
|
+
puts "Error when calling LiveStreamsApi->update_live_stream_with_http_info: #{e}"
|
|
1056
|
+
end
|
|
1057
|
+
```
|
|
1058
|
+
|
|
1059
|
+
### Parameters
|
|
1060
|
+
|
|
1061
|
+
| Name | Type | Description | Notes |
|
|
1062
|
+
| ---- | ---- | ----------- | ----- |
|
|
1063
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
|
1064
|
+
| **update_live_stream_request** | [**UpdateLiveStreamRequest**](UpdateLiveStreamRequest.md) | | |
|
|
1065
|
+
|
|
1066
|
+
### Return type
|
|
1067
|
+
|
|
1068
|
+
[**LiveStreamResponse**](LiveStreamResponse.md)
|
|
1069
|
+
|
|
1070
|
+
### Authorization
|
|
1071
|
+
|
|
1072
|
+
[accessToken](../README.md#accessToken)
|
|
1073
|
+
|
|
1074
|
+
### HTTP request headers
|
|
1075
|
+
|
|
1076
|
+
- **Content-Type**: application/json
|
|
1077
|
+
- **Accept**: application/json
|
|
1078
|
+
|
|
1079
|
+
|
|
1007
1080
|
## update_live_stream_embedded_subtitles
|
|
1008
1081
|
|
|
1009
1082
|
> <LiveStreamResponse> update_live_stream_embedded_subtitles(live_stream_id, update_live_stream_embedded_subtitles_request)
|
data/docs/MetricsApi.md
CHANGED
|
@@ -34,8 +34,8 @@ 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[]=).
|
|
38
|
-
filters: ['inner_example'], # Array<String> |
|
|
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
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.
|
|
@@ -73,8 +73,8 @@ end
|
|
|
73
73
|
| Name | Type | Description | Notes |
|
|
74
74
|
| ---- | ---- | ----------- | ----- |
|
|
75
75
|
| **metric_id** | **String** | ID of the Metric | |
|
|
76
|
-
| **timeframe** | [**Array<String>**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
|
77
|
-
| **filters** | [**Array<String>**](String.md) |
|
|
76
|
+
| **timeframe** | [**Array<String>**](String.md) | 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` | [optional] |
|
|
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
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 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. | [optional] |
|
|
@@ -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[]=).
|
|
120
|
-
filters: ['inner_example'], # Array<String> |
|
|
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<String>**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
|
157
|
-
| **filters** | [**Array<String>**](String.md) |
|
|
156
|
+
| **timeframe** | [**Array<String>**](String.md) | 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` | [optional] |
|
|
157
|
+
| **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] |
|
|
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[]=).
|
|
197
|
-
filters: ['inner_example'], # Array<String> |
|
|
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<String>**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
|
234
|
-
| **filters** | [**Array<String>**](String.md) |
|
|
233
|
+
| **timeframe** | [**Array<String>**](String.md) | 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` | [optional] |
|
|
234
|
+
| **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] |
|
|
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> |
|
|
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[]=).
|
|
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<String>**](String.md) |
|
|
319
|
+
| **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] |
|
|
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 `limit` | [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<String>**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
|
324
|
+
| **timeframe** | [**Array<String>**](String.md) | 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` | [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[]=).
|
|
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<String>**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
|
402
|
+
| **timeframe** | [**Array<String>**](String.md) | 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` | [optional] |
|
|
403
403
|
|
|
404
404
|
### Return type
|
|
405
405
|
|