mux_ruby 3.12.0 → 3.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +4 -4
- data/docs/AbridgedVideoView.md +5 -1
- data/docs/Asset.md +3 -1
- data/docs/AssetsApi.md +79 -4
- data/docs/CreateSimulcastTargetRequest.md +2 -2
- data/docs/DimensionsApi.md +2 -0
- data/docs/Error.md +3 -1
- data/docs/ErrorsApi.md +2 -0
- data/docs/GenerateTrackSubtitlesRequest.md +18 -0
- data/docs/GenerateTrackSubtitlesResponse.md +18 -0
- data/docs/InputSettings.md +2 -2
- data/docs/LiveStream.md +5 -1
- data/docs/LiveStreamsApi.md +8 -8
- data/docs/MetricsApi.md +13 -1
- data/docs/MonitoringBreakdownTimeseriesDatapoint.md +3 -1
- data/docs/PlaybackIDApi.md +4 -4
- data/docs/ReferrerDomainRestriction.md +1 -1
- data/docs/SimulcastTarget.md +6 -4
- data/docs/Track.md +3 -1
- data/docs/VideoView.md +30 -2
- data/docs/VideoViewsApi.md +2 -0
- data/gen/generator-config.json +1 -1
- data/lib/mux_ruby/api/assets_api.rb +79 -2
- data/lib/mux_ruby/api/dimensions_api.rb +3 -0
- data/lib/mux_ruby/api/errors_api.rb +3 -0
- data/lib/mux_ruby/api/live_streams_api.rb +4 -4
- data/lib/mux_ruby/api/metrics_api.rb +24 -6
- data/lib/mux_ruby/api/playback_id_api.rb +2 -2
- data/lib/mux_ruby/api/video_views_api.rb +3 -0
- data/lib/mux_ruby/models/abridged_video_view.rb +24 -4
- data/lib/mux_ruby/models/asset.rb +26 -4
- data/lib/mux_ruby/models/asset_generated_subtitle_settings.rb +2 -2
- data/lib/mux_ruby/models/create_simulcast_target_request.rb +2 -2
- data/lib/mux_ruby/models/error.rb +16 -5
- data/lib/mux_ruby/models/generate_track_subtitles_request.rb +221 -0
- data/lib/mux_ruby/models/generate_track_subtitles_response.rb +218 -0
- data/lib/mux_ruby/models/input_settings.rb +2 -2
- data/lib/mux_ruby/models/live_stream.rb +36 -4
- data/lib/mux_ruby/models/monitoring_breakdown_timeseries_datapoint.rb +13 -4
- data/lib/mux_ruby/models/referrer_domain_restriction.rb +1 -1
- data/lib/mux_ruby/models/simulcast_target.rb +29 -7
- data/lib/mux_ruby/models/track.rb +14 -4
- data/lib/mux_ruby/models/video_view.rb +142 -5
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +2 -0
- data/spec/models/generate_track_subtitles_request_spec.rb +34 -0
- data/spec/models/generate_track_subtitles_response_spec.rb +34 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/ffi_c.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/mkmf.log +16 -16
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/gem_make.out +14 -14
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/jaro_winkler/jaro_winkler_ext.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/mkmf.log +4 -4
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/psych.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/mkmf.log +2 -2
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/stringio.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug/Makefile +6 -6
- data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c/Makefile +6 -6
- data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/lib/ffi_c.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +6 -6
- data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/ext/psych/Makefile +6 -6
- data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/lib/psych.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/ext/stringio/Makefile +6 -6
- data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/lib/stringio.so +0 -0
- data/vendor/bundle/ruby/3.2.0/specifications/ast-2.4.2.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/byebug-11.1.3.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/coderay-1.1.3.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/diff-lcs-1.5.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/ethon-0.16.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/ffi-1.16.3.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/jaro_winkler-1.5.4.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/method_source-1.0.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/parallel-1.22.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/parser-3.1.2.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/pry-0.13.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/pry-byebug-3.9.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/psych-4.0.4.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rainbow-3.1.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rake-13.0.6.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-3.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-core-3.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-expectations-3.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-mocks-3.11.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-support-3.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rubocop-0.66.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/ruby-progressbar-1.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/solid_assert-1.1.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/stringio-3.0.2.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/typhoeus-1.4.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/unicode-display_width-1.5.0.gemspec +2 -2
- metadata +160 -152
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e69002fc9fae0b20c36601d64999f83b3c2248cae537473108ec65968b28d222
|
4
|
+
data.tar.gz: acb69733b34d4e45a04593552a79779b4d34235da7af0de9b704e3461d7685fa
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: df62f360323df0a57ab8aff4c863366a8a7e963a86ca1aa24e4e1887428d99791c2972123ae40845971d29a6c40189e3f66ca34143c9b4a01da596e05486ebc4
|
7
|
+
data.tar.gz: 594a75d23b9b6aaa7734076b909b67a78b23120f5af153a5eda5f0e48ec35a8becc0ca23b68429f9e4caba0180328a61e8d1320115d8ade181ec39ecb3599690
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -23,7 +23,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
|
|
23
23
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
24
24
|
|
25
25
|
- API version: v1
|
26
|
-
- Package version: 3.
|
26
|
+
- Package version: 3.14.0
|
27
27
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
28
28
|
For more information, please visit [https://docs.mux.com](https://docs.mux.com)
|
29
29
|
|
@@ -40,16 +40,16 @@ gem build mux_ruby.gemspec
|
|
40
40
|
Then either install the gem locally:
|
41
41
|
|
42
42
|
```shell
|
43
|
-
gem install ./mux_ruby-3.
|
43
|
+
gem install ./mux_ruby-3.14.0.gem
|
44
44
|
```
|
45
45
|
|
46
|
-
(for development, run `gem install --dev ./mux_ruby-3.
|
46
|
+
(for development, run `gem install --dev ./mux_ruby-3.14.0.gem` to install the development dependencies)
|
47
47
|
|
48
48
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
49
49
|
|
50
50
|
Finally add this to the Gemfile:
|
51
51
|
|
52
|
-
gem 'mux_ruby', '~> 3.
|
52
|
+
gem 'mux_ruby', '~> 3.14.0'
|
53
53
|
|
54
54
|
### Install from Git
|
55
55
|
|
data/docs/AbridgedVideoView.md
CHANGED
@@ -15,6 +15,8 @@
|
|
15
15
|
| **country_code** | **String** | | [optional] |
|
16
16
|
| **view_start** | **String** | | [optional] |
|
17
17
|
| **view_end** | **String** | | [optional] |
|
18
|
+
| **viewer_experience_score** | **Float** | | [optional] |
|
19
|
+
| **watch_time** | **Integer** | | [optional] |
|
18
20
|
|
19
21
|
## Example
|
20
22
|
|
@@ -32,7 +34,9 @@ instance = MuxRuby::AbridgedVideoView.new(
|
|
32
34
|
error_type_id: null,
|
33
35
|
country_code: null,
|
34
36
|
view_start: null,
|
35
|
-
view_end: null
|
37
|
+
view_end: null,
|
38
|
+
viewer_experience_score: null,
|
39
|
+
watch_time: null
|
36
40
|
)
|
37
41
|
```
|
38
42
|
|
data/docs/Asset.md
CHANGED
@@ -31,6 +31,7 @@
|
|
31
31
|
| **recording_times** | [**Array<AssetRecordingTimes>**](AssetRecordingTimes.md) | An array of individual live stream recording sessions. A recording session is created on each encoder connection during the live stream. Additionally any time slate media is inserted during brief interruptions in the live stream media or times when the live streaming software disconnects, a recording session representing the slate media will be added with a \"slate\" type. | [optional] |
|
32
32
|
| **non_standard_input_reasons** | [**AssetNonStandardInputReasons**](AssetNonStandardInputReasons.md) | | [optional] |
|
33
33
|
| **test** | **Boolean** | True means this live stream is a test asset. A test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test assets are watermarked with the Mux logo, limited to 10 seconds, and deleted after 24 hrs. | [optional] |
|
34
|
+
| **ingest_type** | **String** | The type of ingest used to create the asset. | [optional] |
|
34
35
|
|
35
36
|
## Example
|
36
37
|
|
@@ -64,7 +65,8 @@ instance = MuxRuby::Asset.new(
|
|
64
65
|
static_renditions: null,
|
65
66
|
recording_times: null,
|
66
67
|
non_standard_input_reasons: null,
|
67
|
-
test: null
|
68
|
+
test: null,
|
69
|
+
ingest_type: null
|
68
70
|
)
|
69
71
|
```
|
70
72
|
|
data/docs/AssetsApi.md
CHANGED
@@ -10,11 +10,12 @@ All URIs are relative to *https://api.mux.com*
|
|
10
10
|
| [**delete_asset**](AssetsApi.md#delete_asset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset |
|
11
11
|
| [**delete_asset_playback_id**](AssetsApi.md#delete_asset_playback_id) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID |
|
12
12
|
| [**delete_asset_track**](AssetsApi.md#delete_asset_track) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track |
|
13
|
+
| [**generate_asset_track_subtitles**](AssetsApi.md#generate_asset_track_subtitles) | **POST** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}/generate-subtitles | Generate track subtitles |
|
13
14
|
| [**get_asset**](AssetsApi.md#get_asset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset |
|
14
15
|
| [**get_asset_input_info**](AssetsApi.md#get_asset_input_info) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info |
|
15
16
|
| [**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
17
|
| [**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
|
18
|
+
| [**update_asset**](AssetsApi.md#update_asset) | **PATCH** /video/v1/assets/{ASSET_ID} | Update an asset |
|
18
19
|
| [**update_asset_master_access**](AssetsApi.md#update_asset_master_access) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access |
|
19
20
|
| [**update_asset_mp4_support**](AssetsApi.md#update_asset_mp4_support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support |
|
20
21
|
|
@@ -444,6 +445,80 @@ nil (empty response body)
|
|
444
445
|
- **Accept**: Not defined
|
445
446
|
|
446
447
|
|
448
|
+
## generate_asset_track_subtitles
|
449
|
+
|
450
|
+
> <GenerateTrackSubtitlesResponse> generate_asset_track_subtitles(asset_id, track_id, generate_track_subtitles_request)
|
451
|
+
|
452
|
+
Generate track subtitles
|
453
|
+
|
454
|
+
Generates subtitles (captions) for a given audio track. This API can be used for up to 7 days after an asset is created.
|
455
|
+
|
456
|
+
### Examples
|
457
|
+
|
458
|
+
```ruby
|
459
|
+
require 'time'
|
460
|
+
require 'mux_ruby'
|
461
|
+
# setup authorization
|
462
|
+
MuxRuby.configure do |config|
|
463
|
+
# Configure HTTP basic authorization: accessToken
|
464
|
+
config.username = 'YOUR USERNAME'
|
465
|
+
config.password = 'YOUR PASSWORD'
|
466
|
+
end
|
467
|
+
|
468
|
+
api_instance = MuxRuby::AssetsApi.new
|
469
|
+
asset_id = 'asset_id_example' # String | The asset ID.
|
470
|
+
track_id = 'track_id_example' # String | The track ID.
|
471
|
+
generate_track_subtitles_request = MuxRuby::GenerateTrackSubtitlesRequest.new # GenerateTrackSubtitlesRequest |
|
472
|
+
|
473
|
+
begin
|
474
|
+
# Generate track subtitles
|
475
|
+
result = api_instance.generate_asset_track_subtitles(asset_id, track_id, generate_track_subtitles_request)
|
476
|
+
p result
|
477
|
+
rescue MuxRuby::ApiError => e
|
478
|
+
puts "Error when calling AssetsApi->generate_asset_track_subtitles: #{e}"
|
479
|
+
end
|
480
|
+
```
|
481
|
+
|
482
|
+
#### Using the generate_asset_track_subtitles_with_http_info variant
|
483
|
+
|
484
|
+
This returns an Array which contains the response data, status code and headers.
|
485
|
+
|
486
|
+
> <Array(<GenerateTrackSubtitlesResponse>, Integer, Hash)> generate_asset_track_subtitles_with_http_info(asset_id, track_id, generate_track_subtitles_request)
|
487
|
+
|
488
|
+
```ruby
|
489
|
+
begin
|
490
|
+
# Generate track subtitles
|
491
|
+
data, status_code, headers = api_instance.generate_asset_track_subtitles_with_http_info(asset_id, track_id, generate_track_subtitles_request)
|
492
|
+
p status_code # => 2xx
|
493
|
+
p headers # => { ... }
|
494
|
+
p data # => <GenerateTrackSubtitlesResponse>
|
495
|
+
rescue MuxRuby::ApiError => e
|
496
|
+
puts "Error when calling AssetsApi->generate_asset_track_subtitles_with_http_info: #{e}"
|
497
|
+
end
|
498
|
+
```
|
499
|
+
|
500
|
+
### Parameters
|
501
|
+
|
502
|
+
| Name | Type | Description | Notes |
|
503
|
+
| ---- | ---- | ----------- | ----- |
|
504
|
+
| **asset_id** | **String** | The asset ID. | |
|
505
|
+
| **track_id** | **String** | The track ID. | |
|
506
|
+
| **generate_track_subtitles_request** | [**GenerateTrackSubtitlesRequest**](GenerateTrackSubtitlesRequest.md) | | |
|
507
|
+
|
508
|
+
### Return type
|
509
|
+
|
510
|
+
[**GenerateTrackSubtitlesResponse**](GenerateTrackSubtitlesResponse.md)
|
511
|
+
|
512
|
+
### Authorization
|
513
|
+
|
514
|
+
[accessToken](../README.md#accessToken)
|
515
|
+
|
516
|
+
### HTTP request headers
|
517
|
+
|
518
|
+
- **Content-Type**: application/json
|
519
|
+
- **Accept**: application/json
|
520
|
+
|
521
|
+
|
447
522
|
## get_asset
|
448
523
|
|
449
524
|
> <AssetResponse> get_asset(asset_id)
|
@@ -738,7 +813,7 @@ end
|
|
738
813
|
|
739
814
|
> <AssetResponse> update_asset(asset_id, update_asset_request)
|
740
815
|
|
741
|
-
Update an
|
816
|
+
Update an asset
|
742
817
|
|
743
818
|
Updates the details of an already-created Asset with the provided Asset ID. This currently supports only the `passthrough` field.
|
744
819
|
|
@@ -759,7 +834,7 @@ asset_id = 'asset_id_example' # String | The asset ID.
|
|
759
834
|
update_asset_request = MuxRuby::UpdateAssetRequest.new # UpdateAssetRequest |
|
760
835
|
|
761
836
|
begin
|
762
|
-
# Update an
|
837
|
+
# Update an asset
|
763
838
|
result = api_instance.update_asset(asset_id, update_asset_request)
|
764
839
|
p result
|
765
840
|
rescue MuxRuby::ApiError => e
|
@@ -775,7 +850,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
775
850
|
|
776
851
|
```ruby
|
777
852
|
begin
|
778
|
-
# Update an
|
853
|
+
# Update an asset
|
779
854
|
data, status_code, headers = api_instance.update_asset_with_http_info(asset_id, update_asset_request)
|
780
855
|
p status_code # => 2xx
|
781
856
|
p headers # => { ... }
|
@@ -5,8 +5,8 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **passthrough** | **String** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional] |
|
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
|
-
| **url** | **String** | RTMP
|
8
|
+
| **stream_key** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. Only used for RTMP(s) simulcast destinations. | [optional] |
|
9
|
+
| **url** | **String** | The RTMP(s) or SRT endpoint for a simulcast destination. * For RTMP(s) destinations, this should include the application name for the third party live streaming service, for example: `rtmp://live.example.com/app`. * For SRT destinations, this should be a fully formed SRT connection string, for example: `srt://srt-live.example.com:1234?streamid={stream_key}&passphrase={srt_passphrase}`. Note: SRT simulcast targets can only be used when an source is connected over SRT. | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
data/docs/DimensionsApi.md
CHANGED
@@ -34,6 +34,7 @@ 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
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
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
37
38
|
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
39
|
}
|
39
40
|
|
@@ -72,6 +73,7 @@ end
|
|
72
73
|
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
73
74
|
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
74
75
|
| **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] |
|
76
|
+
| **metric_filters** | [**Array<String>**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
75
77
|
| **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
78
|
|
77
79
|
### Return type
|
data/docs/Error.md
CHANGED
@@ -12,6 +12,7 @@
|
|
12
12
|
| **description** | **String** | Description of the error. | [optional] |
|
13
13
|
| **count** | **Integer** | The total number of views that experienced this error. | [optional] |
|
14
14
|
| **code** | **Integer** | The error code | [optional] |
|
15
|
+
| **player_error_code** | **String** | The string version of the error code | [optional] |
|
15
16
|
|
16
17
|
## Example
|
17
18
|
|
@@ -26,7 +27,8 @@ instance = MuxRuby::Error.new(
|
|
26
27
|
last_seen: null,
|
27
28
|
description: null,
|
28
29
|
count: null,
|
29
|
-
code: null
|
30
|
+
code: null,
|
31
|
+
player_error_code: null
|
30
32
|
)
|
31
33
|
```
|
32
34
|
|
data/docs/ErrorsApi.md
CHANGED
@@ -30,6 +30,7 @@ end
|
|
30
30
|
api_instance = MuxRuby::ErrorsApi.new
|
31
31
|
opts = {
|
32
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
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
33
34
|
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
35
|
}
|
35
36
|
|
@@ -65,6 +66,7 @@ end
|
|
65
66
|
| Name | Type | Description | Notes |
|
66
67
|
| ---- | ---- | ----------- | ----- |
|
67
68
|
| **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] |
|
69
|
+
| **metric_filters** | [**Array<String>**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
68
70
|
| **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
71
|
|
70
72
|
### Return type
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MuxRuby::GenerateTrackSubtitlesRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **generated_subtitles** | [**Array<AssetGeneratedSubtitleSettings>**](AssetGeneratedSubtitleSettings.md) | Generate subtitle tracks using automatic speech recognition with this configuration. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::GenerateTrackSubtitlesRequest.new(
|
15
|
+
generated_subtitles: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MuxRuby::GenerateTrackSubtitlesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Track**](Track.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::GenerateTrackSubtitlesResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/InputSettings.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **url** | **String** | The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `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/) formats 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. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input. | [optional] |
|
7
|
+
| **url** | **String** | The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `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/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. The maximum size is 4096x4096. * 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. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input. | [optional] |
|
8
8
|
| **overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) | | [optional] |
|
9
|
-
| **generated_subtitles** | [**Array<AssetGeneratedSubtitleSettings>**](AssetGeneratedSubtitleSettings.md) | Generate subtitle tracks using automatic speech recognition
|
9
|
+
| **generated_subtitles** | [**Array<AssetGeneratedSubtitleSettings>**](AssetGeneratedSubtitleSettings.md) | Generate subtitle tracks using automatic speech recognition with this configuration. This may only be provided for the first input object (the main input file). For direct uploads, this first input should omit the url parameter, as the main input file is provided via the direct upload. This will create subtitles based on the audio track ingested from that main input file. Note that subtitle generation happens after initial ingest, so the generated tracks will be in the `preparing` state when the asset transitions to `ready`. | [optional] |
|
10
10
|
| **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] |
|
11
11
|
| **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] |
|
12
12
|
| **type** | **String** | This parameter is required for `text` type tracks. | [optional] |
|
data/docs/LiveStream.md
CHANGED
@@ -25,6 +25,8 @@
|
|
25
25
|
| **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. | [optional] |
|
26
26
|
| **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] |
|
27
27
|
| **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] |
|
28
|
+
| **srt_passphrase** | **String** | Unique key used for encrypting a stream to a Mux SRT endpoint. | [optional] |
|
29
|
+
| **active_ingest_protocol** | **String** | The protocol used for the active ingest stream. This is only set when the live stream is active. | [optional] |
|
28
30
|
|
29
31
|
## Example
|
30
32
|
|
@@ -52,7 +54,9 @@ instance = MuxRuby::LiveStream.new(
|
|
52
54
|
simulcast_targets: null,
|
53
55
|
latency_mode: null,
|
54
56
|
test: null,
|
55
|
-
max_continuous_duration: null
|
57
|
+
max_continuous_duration: null,
|
58
|
+
srt_passphrase: null,
|
59
|
+
active_ingest_protocol: null
|
56
60
|
)
|
57
61
|
```
|
58
62
|
|
data/docs/LiveStreamsApi.md
CHANGED
@@ -9,12 +9,12 @@ All URIs are relative to *https://api.mux.com*
|
|
9
9
|
| [**create_live_stream_simulcast_target**](LiveStreamsApi.md#create_live_stream_simulcast_target) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets | Create a live stream simulcast target |
|
10
10
|
| [**delete_live_stream**](LiveStreamsApi.md#delete_live_stream) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID} | Delete a live stream |
|
11
11
|
| [**delete_live_stream_playback_id**](LiveStreamsApi.md#delete_live_stream_playback_id) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Delete a live stream playback ID |
|
12
|
-
| [**delete_live_stream_simulcast_target**](LiveStreamsApi.md#delete_live_stream_simulcast_target) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Delete a
|
12
|
+
| [**delete_live_stream_simulcast_target**](LiveStreamsApi.md#delete_live_stream_simulcast_target) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Delete a live stream simulcast target |
|
13
13
|
| [**disable_live_stream**](LiveStreamsApi.md#disable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/disable | Disable a live stream |
|
14
14
|
| [**enable_live_stream**](LiveStreamsApi.md#enable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/enable | Enable a live stream |
|
15
15
|
| [**get_live_stream**](LiveStreamsApi.md#get_live_stream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream |
|
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
|
-
| [**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
|
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
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 |
|
@@ -381,7 +381,7 @@ nil (empty response body)
|
|
381
381
|
|
382
382
|
> delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
383
383
|
|
384
|
-
Delete a
|
384
|
+
Delete a live stream simulcast target
|
385
385
|
|
386
386
|
Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state.
|
387
387
|
|
@@ -402,7 +402,7 @@ live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
|
402
402
|
simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.
|
403
403
|
|
404
404
|
begin
|
405
|
-
# Delete a
|
405
|
+
# Delete a live stream simulcast target
|
406
406
|
api_instance.delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
407
407
|
rescue MuxRuby::ApiError => e
|
408
408
|
puts "Error when calling LiveStreamsApi->delete_live_stream_simulcast_target: #{e}"
|
@@ -417,7 +417,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
|
|
417
417
|
|
418
418
|
```ruby
|
419
419
|
begin
|
420
|
-
# Delete a
|
420
|
+
# Delete a live stream simulcast target
|
421
421
|
data, status_code, headers = api_instance.delete_live_stream_simulcast_target_with_http_info(live_stream_id, simulcast_target_id)
|
422
422
|
p status_code # => 2xx
|
423
423
|
p headers # => { ... }
|
@@ -734,7 +734,7 @@ end
|
|
734
734
|
|
735
735
|
> <SimulcastTargetResponse> get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
736
736
|
|
737
|
-
Retrieve a
|
737
|
+
Retrieve a live stream simulcast target
|
738
738
|
|
739
739
|
Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information.
|
740
740
|
|
@@ -755,7 +755,7 @@ live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
|
755
755
|
simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.
|
756
756
|
|
757
757
|
begin
|
758
|
-
# Retrieve a
|
758
|
+
# Retrieve a live stream simulcast target
|
759
759
|
result = api_instance.get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
760
760
|
p result
|
761
761
|
rescue MuxRuby::ApiError => e
|
@@ -771,7 +771,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
771
771
|
|
772
772
|
```ruby
|
773
773
|
begin
|
774
|
-
# Retrieve a
|
774
|
+
# Retrieve a live stream simulcast target
|
775
775
|
data, status_code, headers = api_instance.get_live_stream_simulcast_target_with_http_info(live_stream_id, simulcast_target_id)
|
776
776
|
p status_code # => 2xx
|
777
777
|
p headers # => { ... }
|
data/docs/MetricsApi.md
CHANGED
@@ -36,6 +36,7 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
|
|
36
36
|
opts = {
|
37
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
|
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
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
39
40
|
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
|
40
41
|
order_direction: 'asc', # String | Sort order.
|
41
42
|
group_by: 'minute' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, 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.
|
@@ -75,6 +76,7 @@ end
|
|
75
76
|
| **metric_id** | **String** | ID of the Metric | |
|
76
77
|
| **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
78
|
| **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] |
|
79
|
+
| **metric_filters** | [**Array<String>**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
78
80
|
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
|
79
81
|
| **order_direction** | **String** | Sort order. | [optional] |
|
80
82
|
| **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 less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, 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] |
|
@@ -118,6 +120,7 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
|
|
118
120
|
opts = {
|
119
121
|
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
122
|
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`
|
123
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
121
124
|
measurement: '95th' # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
|
122
125
|
}
|
123
126
|
|
@@ -155,6 +158,7 @@ end
|
|
155
158
|
| **metric_id** | **String** | ID of the Metric | |
|
156
159
|
| **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
160
|
| **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] |
|
161
|
+
| **metric_filters** | [**Array<String>**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
158
162
|
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
|
159
163
|
|
160
164
|
### Return type
|
@@ -195,6 +199,7 @@ api_instance = MuxRuby::MetricsApi.new
|
|
195
199
|
opts = {
|
196
200
|
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
201
|
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`
|
202
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
198
203
|
dimension: 'asn', # String | Dimension the specified value belongs to
|
199
204
|
value: 'value_example' # String | Value to show all available metrics for
|
200
205
|
}
|
@@ -232,6 +237,7 @@ end
|
|
232
237
|
| ---- | ---- | ----------- | ----- |
|
233
238
|
| **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
239
|
| **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] |
|
240
|
+
| **metric_filters** | [**Array<String>**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
235
241
|
| **dimension** | **String** | Dimension the specified value belongs to | [optional] |
|
236
242
|
| **value** | **String** | Value to show all available metrics for | [optional] |
|
237
243
|
|
@@ -275,6 +281,7 @@ opts = {
|
|
275
281
|
group_by: 'asn', # String | Breakdown value to group the results by
|
276
282
|
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
|
277
283
|
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`
|
284
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
278
285
|
limit: 56, # Integer | Number of items to include in the response
|
279
286
|
page: 56, # Integer | Offset by this many pages, of the size of `limit`
|
280
287
|
order_by: 'negative_impact', # String | Value to order the results by
|
@@ -317,6 +324,7 @@ end
|
|
317
324
|
| **group_by** | **String** | Breakdown value to group the results by | [optional] |
|
318
325
|
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
|
319
326
|
| **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] |
|
327
|
+
| **metric_filters** | [**Array<String>**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
320
328
|
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
321
329
|
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
322
330
|
| **order_by** | **String** | Value to order the results by | [optional] |
|
@@ -362,7 +370,9 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
|
|
362
370
|
opts = {
|
363
371
|
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
|
364
372
|
order_direction: 'asc', # String | Sort order.
|
365
|
-
timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
|
373
|
+
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`
|
374
|
+
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`
|
375
|
+
metric_filters: ['inner_example'] # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
366
376
|
}
|
367
377
|
|
368
378
|
begin
|
@@ -400,6 +410,8 @@ end
|
|
400
410
|
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
|
401
411
|
| **order_direction** | **String** | Sort order. | [optional] |
|
402
412
|
| **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] |
|
413
|
+
| **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] |
|
414
|
+
| **metric_filters** | [**Array<String>**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
403
415
|
|
404
416
|
### Return type
|
405
417
|
|
@@ -7,6 +7,7 @@
|
|
7
7
|
| **value** | **String** | | [optional] |
|
8
8
|
| **metric_value** | **Float** | | [optional] |
|
9
9
|
| **concurrent_viewers** | **Integer** | | [optional] |
|
10
|
+
| **starting_up_viewers** | **Integer** | | [optional] |
|
10
11
|
|
11
12
|
## Example
|
12
13
|
|
@@ -16,7 +17,8 @@ require 'mux_ruby'
|
|
16
17
|
instance = MuxRuby::MonitoringBreakdownTimeseriesDatapoint.new(
|
17
18
|
value: null,
|
18
19
|
metric_value: null,
|
19
|
-
concurrent_viewers: null
|
20
|
+
concurrent_viewers: null,
|
21
|
+
starting_up_viewers: null
|
20
22
|
)
|
21
23
|
```
|
22
24
|
|
data/docs/PlaybackIDApi.md
CHANGED
@@ -4,14 +4,14 @@ All URIs are relative to *https://api.mux.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**get_asset_or_livestream_id**](PlaybackIDApi.md#get_asset_or_livestream_id) | **GET** /video/v1/playback-ids/{PLAYBACK_ID} | Retrieve an
|
7
|
+
| [**get_asset_or_livestream_id**](PlaybackIDApi.md#get_asset_or_livestream_id) | **GET** /video/v1/playback-ids/{PLAYBACK_ID} | Retrieve an asset or live stream ID |
|
8
8
|
|
9
9
|
|
10
10
|
## get_asset_or_livestream_id
|
11
11
|
|
12
12
|
> <GetAssetOrLiveStreamIdResponse> get_asset_or_livestream_id(playback_id)
|
13
13
|
|
14
|
-
Retrieve an
|
14
|
+
Retrieve an asset or live stream ID
|
15
15
|
|
16
16
|
Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
|
17
17
|
|
@@ -31,7 +31,7 @@ api_instance = MuxRuby::PlaybackIDApi.new
|
|
31
31
|
playback_id = 'playback_id_example' # String | The live stream's playback ID.
|
32
32
|
|
33
33
|
begin
|
34
|
-
# Retrieve an
|
34
|
+
# Retrieve an asset or live stream ID
|
35
35
|
result = api_instance.get_asset_or_livestream_id(playback_id)
|
36
36
|
p result
|
37
37
|
rescue MuxRuby::ApiError => e
|
@@ -47,7 +47,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
47
47
|
|
48
48
|
```ruby
|
49
49
|
begin
|
50
|
-
# Retrieve an
|
50
|
+
# Retrieve an asset or live stream ID
|
51
51
|
data, status_code, headers = api_instance.get_asset_or_livestream_id_with_http_info(playback_id)
|
52
52
|
p status_code # => 2xx
|
53
53
|
p headers # => { ... }
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **allowed_domains** | **Array<String>** | List of domains allowed to play videos. Possible values are * `[]` Empty Array indicates deny video playback requests for all domains * `[\"*\"]` A Single Wildcard `*` entry means allow video playback requests from any domain *
|
7
|
+
| **allowed_domains** | **Array<String>** | List of domains allowed to play videos. Possible values are * `[]` Empty Array indicates deny video playback requests for all domains * `[\"*\"]` A Single Wildcard `*` entry means allow video playback requests from any domain * `[\"*.example.com\", \"foo.com\"]` A list of up to 10 domains or valid dns-style wildcards | [optional] |
|
8
8
|
| **allow_no_referrer** | **Boolean** | A boolean to determine whether to allow or deny HTTP requests without `Referer` HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not have a `Referer` HTTP header. Set this value to `true` to allow these playback requests. | [optional][default to false] |
|
9
9
|
|
10
10
|
## Example
|