Skip to content

Commit 236d68f

Browse files
eroppleeropple
authored
Ed/clipping (#33)
* added get-asset-or-livestream-id support * added get-asset-or-livestream-id tests * template fixes/additional documentation from other changes * reverting doc changes * code updates * docs manual fix * clip test * test report
1 parent 76efb07 commit 236d68f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1234
-79
lines changed

‎docs/Asset.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,29 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**id** | **String** | | [optional]
7-
**created_at** | **String** | | [optional]
6+
**id** | **String** | Unique identifier for the Asset. | [optional]
7+
**created_at** | **String** | Time at which the object was created. Measured in seconds since the Unix epoch. | [optional]
88
**deleted_at** | **String** | | [optional]
9-
**status** | **String** | | [optional]
10-
**duration** | **Float** | | [optional]
11-
**max_stored_resolution** | **String** | | [optional]
12-
**max_stored_frame_rate** | **Float** | | [optional]
13-
**aspect_ratio** | **String** | | [optional]
9+
**status** | **String** | The status of the asset. | [optional]
10+
**duration** | **Float** | The duration of the asset in seconds (max duration for a single asset is 24 hours). | [optional]
11+
**max_stored_resolution** | **String** | The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. | [optional]
12+
**max_stored_frame_rate** | **Float** | The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined. | [optional]
13+
**aspect_ratio** | **String** | The aspect ratio of the asset in the form of `width:height`, for example `16:9`. | [optional]
1414
**playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) | | [optional]
1515
**tracks** | [**Array<Track>**](Track.md) | | [optional]
1616
**errors** | [**AssetErrors**](AssetErrors.md) | | [optional]
1717
**per_title_encode** | **BOOLEAN** | | [optional]
18-
**is_live** | **BOOLEAN** | | [optional]
19-
**passthrough** | **String** | | [optional]
20-
**live_stream_id** | **String** | | [optional]
18+
**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]
19+
**passthrough** | **String** | Arbitrary metadata set for the asset. Max 255 characters. | [optional]
20+
**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]
2121
**master** | [**AssetMaster**](AssetMaster.md) | | [optional]
2222
**master_access** | **String** | | [optional] [default to 'none']
2323
**mp4_support** | **String** | | [optional] [default to 'none']
24-
**normalize_audio** | **BOOLEAN** | | [optional] [default to false]
24+
**source_asset_id** | **String** | Asset Identifier of the video used as the source for creating the clip. | [optional]
25+
**normalize_audio** | **BOOLEAN** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to false]
2526
**static_renditions** | [**AssetStaticRenditions**](AssetStaticRenditions.md) | | [optional]
2627
**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 | [optional]
2728
**non_standard_input_reasons** | [**AssetNonStandardInputReasons**](AssetNonStandardInputReasons.md) | | [optional]
28-
**test** | **BOOLEAN** | | [optional]
29+
**test** | **BOOLEAN** | Indicates this asset is a test asset if the value is `true`. 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]
2930

3031

‎docs/AssetErrors.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**type** | **String** | | [optional]
7-
**messages** | **Array<String>** | | [optional]
6+
**type** | **String** | The type of error that occurred for this asset. | [optional]
7+
**messages** | **Array<String>** | Error messages with more details. | [optional]
88

99

‎docs/AssetNonStandardInputReasons.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**video_codec** | **String** | The video codec used on the input file | [optional]
7-
**audio_codec** | **String** | The audio codec used on the input file | [optional]
8-
**video_gop_size** | **String** | The video key frame Interval (also called as Group of Picture or GOP) of the input file | [optional]
9-
**video_frame_rate** | **String** | The video frame rate of the input file | [optional]
10-
**video_resolution** | **String** | The video resolution of the input file | [optional]
11-
**pixel_aspect_ratio** | **String** | The video pixel aspect ratio of the input file | [optional]
12-
**video_edit_list** | **String** | Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List | [optional]
13-
**audio_edit_list** | **String** | Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List | [optional]
14-
**unexpected_media_file_parameters** | **String** | A catch-all reason when the input file in created with non-standard encoding parameters | [optional]
6+
**video_codec** | **String** | The video codec used on the input file. | [optional]
7+
**audio_codec** | **String** | The audio codec used on the input file. | [optional]
8+
**video_gop_size** | **String** | The video key frame Interval (also called as Group of Picture or GOP) of the input file. | [optional]
9+
**video_frame_rate** | **String** | The video frame rate of the input file. | [optional]
10+
**video_resolution** | **String** | The video resolution of the input file. | [optional]
11+
**pixel_aspect_ratio** | **String** | The video pixel aspect ratio of the input file. | [optional]
12+
**video_edit_list** | **String** | Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. | [optional]
13+
**audio_edit_list** | **String** | Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. | [optional]
14+
**unexpected_media_file_parameters** | **String** | A catch-all reason when the input file in created with non-standard encoding parameters. | [optional]
1515

1616

‎docs/AssetRecordingTimes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**started_at** | **DateTime** | The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format | [optional]
7-
**duration** | **Float** | The duration of the live stream recorded. The time value is in seconds | [optional]
6+
**started_at** | **DateTime** | The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format. | [optional]
7+
**duration** | **Float** | The duration of the live stream recorded. The time value is in seconds. | [optional]
88

99

‎docs/AssetStaticRenditions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**status** | **String** | * `ready`: All MP4s are downloadable * `preparing`: We are preparing the MP4s * `disabled`: MP4 support was not requested or has been removed * `errored`: There was a Mux internal error that prevented the MP4s from being created | [optional] [default to 'disabled']
6+
**status** | **String** | Indicates the status of downloadable MP4 versions of this asset. | [optional] [default to 'disabled']
77
**files** | [**Array<AssetStaticRenditionsFiles>**](AssetStaticRenditionsFiles.md) | | [optional]
88

99

‎docs/AssetsApi.md

+4
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,8 @@ Name | Type | Description | Notes
176176
177177
Delete an asset
178178

179+
Deletes a video asset and all its data
180+
179181
### Example
180182
```ruby
181183
# load the gem
@@ -477,6 +479,8 @@ Name | Type | Description | Notes
477479
478480
List assets
479481

482+
List all Mux assets.
483+
480484
### Example
481485
```ruby
482486
# load the gem

‎docs/CreateAssetRequest.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**input** | [**Array<InputSettings>**](InputSettings.md) | | [optional]
7-
**playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | | [optional]
6+
**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]
7+
**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]
88
**per_title_encode** | **BOOLEAN** | | [optional]
9-
**passthrough** | **String** | | [optional]
10-
**mp4_support** | **String** | | [optional]
9+
**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+
**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 vidoes guide](/guides/video/download-your-videos) for more information. | [optional]
1111
**normalize_audio** | **BOOLEAN** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to false]
12-
**master_access** | **String** | | [optional]
13-
**test** | **BOOLEAN** | | [optional]
12+
**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 vidoes guide](/guides/video/download-your-videos) for more information. | [optional]
13+
**test** | **BOOLEAN** | Marks the asset as a test asset when the value is set to true. 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 asset are watermarked with the Mux logo, limited to 10 seconds, deleted after 24 hrs. | [optional]
1414

1515

‎docs/CreateTrackRequest.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
66
**url** | **String** | |
77
**type** | **String** | |
88
**text_type** | **String** | |
9-
**language_code** | **String** | |
10-
**name** | **String** | | [optional]
11-
**closed_captions** | **BOOLEAN** | | [optional]
12-
**passthrough** | **String** | | [optional]
9+
**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. |
10+
**name** | **String** | The name of the track containing a human-readable description. This value must be unqiue 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]
11+
**closed_captions** | **BOOLEAN** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional]
12+
**passthrough** | **String** | Arbitrary metadata set for the track either when creating the asset or track. | [optional]
1313

1414

‎docs/GetAssetOrLiveStreamIdResponse.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# MuxRuby::GetAssetOrLiveStreamIdResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**data** | [**GetAssetOrLiveStreamIdResponseData**](GetAssetOrLiveStreamIdResponseData.md) | | [optional]
7+
8+

‎docs/GetAssetOrLiveStreamIdResponseData.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# MuxRuby::GetAssetOrLiveStreamIdResponseData
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | The Playback ID used to retrieve the corresponding asset or the live stream ID | [optional]
7+
**policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional]
8+
**object** | [**GetAssetOrLiveStreamIdResponseDataObject**](GetAssetOrLiveStreamIdResponseDataObject.md) | | [optional]
9+
10+

‎docs/GetAssetOrLiveStreamIdResponseDataObject.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# MuxRuby::GetAssetOrLiveStreamIdResponseDataObject
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | The identifier of the object. | [optional]
7+
**type** | **String** | Identifies the object type associated with the playback ID. | [optional]
8+
9+

‎docs/InputSettings.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**url** | **String** | | [optional]
6+
**url** | **String** | The web address 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]
77
**overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) | | [optional]
8-
**type** | **String** | | [optional]
9-
**text_type** | **String** | | [optional]
10-
**language_code** | **String** | | [optional]
11-
**name** | **String** | | [optional]
12-
**closed_captions** | **BOOLEAN** | | [optional]
13-
**passthrough** | **String** | | [optional]
8+
**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. | [optional]
9+
**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. | [optional]
10+
**type** | **String** | This parameter is required for the `text` track type. | [optional]
11+
**text_type** | **String** | Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for `text` track type. | [optional]
12+
**language_code** | **String** | The language code value must be a valid [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, en for English or en-US for the US version of English. This parameter is required for text type and subtitles text type track. | [optional]
13+
**name** | **String** | The name of the track containing a human-readable description. This value must be unique across all text type and subtitles `text` type tracks. The hls manifest will associate a subtitle text track with this value. For example, the value should be \"English\" for subtitles text track with language_code as en. This optional parameter should be used only for `text` type and subtitles `text` type track. If this parameter is not included, Mux will auto-populate based on the `input[].language_code` value. | [optional]
14+
**closed_captions** | **BOOLEAN** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for `text` type and subtitles `text` type tracks. | [optional]
15+
**passthrough** | **String** | This optional parameter should be used for `text` type and subtitles `text` type tracks. | [optional]
1416

1517

‎docs/InputSettingsOverlaySettings.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**vertical_align** | **String** | | [optional]
7-
**vertical_margin** | **String** | | [optional]
8-
**horizontal_align** | **String** | | [optional]
9-
**horizontal_margin** | **String** | | [optional]
10-
**width** | **String** | | [optional]
11-
**height** | **String** | | [optional]
12-
**opacity** | **String** | | [optional]
6+
**vertical_align** | **String** | Where the vertical positioning of the overlay/watermark should begin from. Defaults to `\"top\"` | [optional]
7+
**vertical_margin** | **String** | The distance from the vertical_align starting point and the image's closest edge. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). Negative values will move the overlay offscreen. In the case of 'middle', a positive value will shift the overlay towards the bottom and and a negative value will shift it towards the top. | [optional]
8+
**horizontal_align** | **String** | Where the horizontal positioning of the overlay/watermark should begin from. | [optional]
9+
**horizontal_margin** | **String** | The distance from the horizontal_align starting point and the image's closest edge. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). Negative values will move the overlay offscreen. In the case of 'center', a positive value will shift the image towards the right and and a negative value will shift it towards the left. | [optional]
10+
**width** | **String** | How wide the overlay should appear. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). If both width and height are left blank the width will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If height is supplied with no width, the width will scale proportionally to the height. | [optional]
11+
**height** | **String** | How tall the overlay should appear. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). If both width and height are left blank the height will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If width is supplied with no height, the height will scale proportionally to the width. | [optional]
12+
**opacity** | **String** | How opaque the overlay should appear, expressed as a percent. (Default 100%) | [optional]
1313

1414

‎docs/PlaybackID.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**id** | **String** | | [optional]
6+
**id** | **String** | Unique identifier for the PlaybackID | [optional]
77
**policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional]
88

99

0 commit comments

Comments
 (0)