Skip to content

Commit 844d5c9

Browse files
committed
Make 3.7.1 release with recent changes
Signed-off-by: Jared Smith <[email protected]>
1 parent ee0b6fc commit 844d5c9

File tree

135 files changed

+594
-594
lines changed

Some content is hidden

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

135 files changed

+594
-594
lines changed

docs/AbridgedVideoView.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**id** | **str** | | [optional]
7-
**viewer_os_family** | **str** | | [optional]
8-
**viewer_application_name** | **str** | | [optional]
9-
**video_title** | **str** | | [optional]
10-
**total_row_count** | **int** | | [optional]
11-
**player_error_message** | **str** | | [optional]
12-
**player_error_code** | **str** | | [optional]
13-
**error_type_id** | **int** | | [optional]
14-
**country_code** | **str** | | [optional]
15-
**view_start** | **str** | | [optional]
16-
**view_end** | **str** | | [optional]
6+
**id** | **str** | | [optional]
7+
**viewer_os_family** | **str** | | [optional]
8+
**viewer_application_name** | **str** | | [optional]
9+
**video_title** | **str** | | [optional]
10+
**total_row_count** | **int** | | [optional]
11+
**player_error_message** | **str** | | [optional]
12+
**player_error_code** | **str** | | [optional]
13+
**error_type_id** | **int** | | [optional]
14+
**country_code** | **str** | | [optional]
15+
**view_start** | **str** | | [optional]
16+
**view_end** | **str** | | [optional]
1717

1818
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1919

docs/Asset.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,30 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**id** | **str** | Unique identifier for the Asset. Max 255 characters. | [optional]
7-
**created_at** | **str** | Time the Asset was created, defined as a Unix timestamp (seconds since epoch). | [optional]
8-
**status** | **str** | The status of the asset. | [optional]
9-
**duration** | **float** | The duration of the asset in seconds (max duration for a single asset is 12 hours). | [optional]
10-
**max_stored_resolution** | **str** | 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]
11-
**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]
12-
**aspect_ratio** | **str** | The aspect ratio of the asset in the form of &#x60;width:height&#x60;, for example &#x60;16:9&#x60;. | [optional]
13-
**playback_ids** | [**list[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-
**tracks** | [**list[Track]**](Track.md) | The individual media tracks that make up an asset. | [optional]
15-
**errors** | [**AssetErrors**](AssetErrors.md) | | [optional]
16-
**per_title_encode** | **bool** | | [optional]
17-
**upload_id** | **str** | Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload. | [optional]
18-
**is_live** | **bool** | Indicates whether the live stream that created this asset is currently &#x60;active&#x60; and not in &#x60;idle&#x60; state. This is an optional parameter added when the asset is created from a live stream. | [optional]
19-
**passthrough** | **str** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional]
20-
**live_stream_id** | **str** | Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream. | [optional]
21-
**master** | [**AssetMaster**](AssetMaster.md) | | [optional]
6+
**id** | **str** | Unique identifier for the Asset. Max 255 characters. | [optional]
7+
**created_at** | **str** | Time the Asset was created, defined as a Unix timestamp (seconds since epoch). | [optional]
8+
**status** | **str** | The status of the asset. | [optional]
9+
**duration** | **float** | The duration of the asset in seconds (max duration for a single asset is 12 hours). | [optional]
10+
**max_stored_resolution** | **str** | 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]
11+
**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]
12+
**aspect_ratio** | **str** | The aspect ratio of the asset in the form of &#x60;width:height&#x60;, for example &#x60;16:9&#x60;. | [optional]
13+
**playback_ids** | [**list[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+
**tracks** | [**list[Track]**](Track.md) | The individual media tracks that make up an asset. | [optional]
15+
**errors** | [**AssetErrors**](AssetErrors.md) | | [optional]
16+
**per_title_encode** | **bool** | | [optional]
17+
**upload_id** | **str** | Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload. | [optional]
18+
**is_live** | **bool** | Indicates whether the live stream that created this asset is currently &#x60;active&#x60; and not in &#x60;idle&#x60; state. This is an optional parameter added when the asset is created from a live stream. | [optional]
19+
**passthrough** | **str** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional]
20+
**live_stream_id** | **str** | Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream. | [optional]
21+
**master** | [**AssetMaster**](AssetMaster.md) | | [optional]
2222
**master_access** | **str** | | [optional] [default to 'none']
2323
**mp4_support** | **str** | | [optional] [default to 'none']
24-
**source_asset_id** | **str** | Asset Identifier of the video used as the source for creating the clip. | [optional]
24+
**source_asset_id** | **str** | Asset Identifier of the video used as the source for creating the clip. | [optional]
2525
**normalize_audio** | **bool** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to False]
26-
**static_renditions** | [**AssetStaticRenditions**](AssetStaticRenditions.md) | | [optional]
27-
**recording_times** | [**list[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 \&quot;slate\&quot; type. | [optional]
28-
**non_standard_input_reasons** | [**AssetNonStandardInputReasons**](AssetNonStandardInputReasons.md) | | [optional]
29-
**test** | **bool** | 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]
26+
**static_renditions** | [**AssetStaticRenditions**](AssetStaticRenditions.md) | | [optional]
27+
**recording_times** | [**list[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 \&quot;slate\&quot; type. | [optional]
28+
**non_standard_input_reasons** | [**AssetNonStandardInputReasons**](AssetNonStandardInputReasons.md) | | [optional]
29+
**test** | **bool** | 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]
3030

3131
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
3232

docs/AssetErrors.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Object that describes any errors that happened when processing this asset.
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**type** | **str** | The type of error that occurred for this asset. | [optional]
8-
**messages** | **list[str]** | Error messages with more details. | [optional]
7+
**type** | **str** | The type of error that occurred for this asset. | [optional]
8+
**messages** | **list[str]** | Error messages with more details. | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

docs/AssetMaster.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ An object containing the current status of Master Access and the link to the Mas
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**status** | **str** | | [optional]
8-
**url** | **str** | The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours. | [optional]
7+
**status** | **str** | | [optional]
8+
**url** | **str** | The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours. | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

docs/AssetNonStandardInputReasons.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ An object containing one or more reasons the input file is non-standard. See [th
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**video_codec** | **str** | The video codec used on the input file. For example, the input file encoded with &#x60;hevc&#x60; video codec is non-standard and the value of this parameter is &#x60;hevc&#x60;. | [optional]
8-
**audio_codec** | **str** | The audio codec used on the input file. Non-AAC audio codecs are non-standard. | [optional]
9-
**video_gop_size** | **str** | The video key frame Interval (also called as Group of Picture or GOP) of the input file is &#x60;high&#x60;. This parameter is present when the gop is greater than 20 seconds. | [optional]
10-
**video_frame_rate** | **str** | The video frame rate of the input file. Video with average frames per second (fps) less than 5 or greater than 120 is non-standard. A &#x60;-1&#x60; frame rate value indicates Mux could not determine the frame rate of the video track. | [optional]
11-
**video_resolution** | **str** | The video resolution of the input file. Video resolution higher than 2048 pixels on any one dimension (height or width) is considered non-standard, The resolution value is presented as &#x60;width&#x60; x &#x60;height&#x60; in pixels. | [optional]
12-
**video_bitrate** | **str** | The video bitrate of the input file is &#x60;high&#x60;. This parameter is present when the average bitrate of any key frame interval (also known as Group of Pictures or GOP) is higher than what&#39;s considered standard which typically is 16 Mbps. | [optional]
13-
**pixel_aspect_ratio** | **str** | The video pixel aspect ratio of the input file. | [optional]
14-
**video_edit_list** | **str** | Video Edit List reason indicates that the input file&#39;s video track contains a complex Edit Decision List. | [optional]
15-
**audio_edit_list** | **str** | Audio Edit List reason indicates that the input file&#39;s audio track contains a complex Edit Decision List. | [optional]
16-
**unexpected_media_file_parameters** | **str** | A catch-all reason when the input file in created with non-standard encoding parameters. | [optional]
7+
**video_codec** | **str** | The video codec used on the input file. For example, the input file encoded with &#x60;hevc&#x60; video codec is non-standard and the value of this parameter is &#x60;hevc&#x60;. | [optional]
8+
**audio_codec** | **str** | The audio codec used on the input file. Non-AAC audio codecs are non-standard. | [optional]
9+
**video_gop_size** | **str** | The video key frame Interval (also called as Group of Picture or GOP) of the input file is &#x60;high&#x60;. This parameter is present when the gop is greater than 20 seconds. | [optional]
10+
**video_frame_rate** | **str** | The video frame rate of the input file. Video with average frames per second (fps) less than 5 or greater than 120 is non-standard. A &#x60;-1&#x60; frame rate value indicates Mux could not determine the frame rate of the video track. | [optional]
11+
**video_resolution** | **str** | The video resolution of the input file. Video resolution higher than 2048 pixels on any one dimension (height or width) is considered non-standard, The resolution value is presented as &#x60;width&#x60; x &#x60;height&#x60; in pixels. | [optional]
12+
**video_bitrate** | **str** | The video bitrate of the input file is &#x60;high&#x60;. This parameter is present when the average bitrate of any key frame interval (also known as Group of Pictures or GOP) is higher than what&#39;s considered standard which typically is 16 Mbps. | [optional]
13+
**pixel_aspect_ratio** | **str** | The video pixel aspect ratio of the input file. | [optional]
14+
**video_edit_list** | **str** | Video Edit List reason indicates that the input file&#39;s video track contains a complex Edit Decision List. | [optional]
15+
**audio_edit_list** | **str** | Audio Edit List reason indicates that the input file&#39;s audio track contains a complex Edit Decision List. | [optional]
16+
**unexpected_media_file_parameters** | **str** | A catch-all reason when the input file in created with non-standard encoding parameters. | [optional]
1717

1818
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1919

docs/AssetRecordingTimes.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
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]
8-
**type** | **str** | The type of media represented by the recording session, either &#x60;content&#x60; for normal stream content or &#x60;slate&#x60; for slate media inserted during stream interruptions. | [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]
8+
**type** | **str** | The type of media represented by the recording session, either &#x60;content&#x60; for normal stream content or &#x60;slate&#x60; for slate media inserted during stream interruptions. | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

docs/AssetResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**data** | [**Asset**](Asset.md) | | [optional]
6+
**data** | [**Asset**](Asset.md) | | [optional]
77

88
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
99

docs/AssetStaticRenditions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ An object containing the current status of any static renditions (mp4s). The obj
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**status** | **str** | Indicates the status of downloadable MP4 versions of this asset. | [optional] [default to 'disabled']
8-
**files** | [**list[AssetStaticRenditionsFiles]**](AssetStaticRenditionsFiles.md) | Array of file objects. | [optional]
8+
**files** | [**list[AssetStaticRenditionsFiles]**](AssetStaticRenditionsFiles.md) | Array of file objects. | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

docs/AssetStaticRenditionsFiles.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**name** | **str** | | [optional]
7-
**ext** | **str** | Extension of the static rendition file | [optional]
8-
**height** | **int** | The height of the static rendition&#39;s file in pixels | [optional]
9-
**width** | **int** | The width of the static rendition&#39;s file in pixels | [optional]
10-
**bitrate** | **int** | The bitrate in bits per second | [optional]
11-
**filesize** | **str** | The file size in bytes | [optional]
6+
**name** | **str** | | [optional]
7+
**ext** | **str** | Extension of the static rendition file | [optional]
8+
**height** | **int** | The height of the static rendition&#39;s file in pixels | [optional]
9+
**width** | **int** | The width of the static rendition&#39;s file in pixels | [optional]
10+
**bitrate** | **int** | The bitrate in bits per second | [optional]
11+
**filesize** | **str** | The file size in bytes | [optional]
1212

1313
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1414

docs/BreakdownValue.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**views** | **int** | | [optional]
7-
**value** | **float** | | [optional]
8-
**total_watch_time** | **int** | | [optional]
9-
**negative_impact** | **int** | | [optional]
10-
**field** | **str** | | [optional]
6+
**views** | **int** | | [optional]
7+
**value** | **float** | | [optional]
8+
**total_watch_time** | **int** | | [optional]
9+
**negative_impact** | **int** | | [optional]
10+
**field** | **str** | | [optional]
1111

1212
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1313

0 commit comments

Comments
 (0)