diff --git a/docs/AbridgedVideoView.md b/docs/AbridgedVideoView.md index bea36d8..6d290c6 100644 --- a/docs/AbridgedVideoView.md +++ b/docs/AbridgedVideoView.md @@ -3,17 +3,17 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**viewer_os_family** | **str** | | [optional] -**viewer_application_name** | **str** | | [optional] -**video_title** | **str** | | [optional] -**total_row_count** | **int** | | [optional] -**player_error_message** | **str** | | [optional] -**player_error_code** | **str** | | [optional] -**error_type_id** | **int** | | [optional] -**country_code** | **str** | | [optional] -**view_start** | **str** | | [optional] -**view_end** | **str** | | [optional] +**id** | **str** | | [optional] +**viewer_os_family** | **str** | | [optional] +**viewer_application_name** | **str** | | [optional] +**video_title** | **str** | | [optional] +**total_row_count** | **int** | | [optional] +**player_error_message** | **str** | | [optional] +**player_error_code** | **str** | | [optional] +**error_type_id** | **int** | | [optional] +**country_code** | **str** | | [optional] +**view_start** | **str** | | [optional] +**view_end** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Asset.md b/docs/Asset.md index c9bea70..5358f84 100644 --- a/docs/Asset.md +++ b/docs/Asset.md @@ -3,30 +3,30 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the Asset. Max 255 characters. | [optional] -**created_at** | **str** | Time the Asset was created, defined as a Unix timestamp (seconds since epoch). | [optional] -**status** | **str** | The status of the asset. | [optional] -**duration** | **float** | The duration of the asset in seconds (max duration for a single asset is 12 hours). | [optional] -**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] -**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] -**aspect_ratio** | **str** | The aspect ratio of the asset in the form of `width:height`, for example `16:9`. | [optional] -**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] -**tracks** | [**list[Track]**](Track.md) | The individual media tracks that make up an asset. | [optional] -**errors** | [**AssetErrors**](AssetErrors.md) | | [optional] -**per_title_encode** | **bool** | | [optional] -**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] -**is_live** | **bool** | Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream. | [optional] -**passthrough** | **str** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] -**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] -**master** | [**AssetMaster**](AssetMaster.md) | | [optional] +**id** | **str** | Unique identifier for the Asset. Max 255 characters. | [optional] +**created_at** | **str** | Time the Asset was created, defined as a Unix timestamp (seconds since epoch). | [optional] +**status** | **str** | The status of the asset. | [optional] +**duration** | **float** | The duration of the asset in seconds (max duration for a single asset is 12 hours). | [optional] +**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] +**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] +**aspect_ratio** | **str** | The aspect ratio of the asset in the form of `width:height`, for example `16:9`. | [optional] +**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] +**tracks** | [**list[Track]**](Track.md) | The individual media tracks that make up an asset. | [optional] +**errors** | [**AssetErrors**](AssetErrors.md) | | [optional] +**per_title_encode** | **bool** | | [optional] +**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] +**is_live** | **bool** | Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream. | [optional] +**passthrough** | **str** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] +**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] +**master** | [**AssetMaster**](AssetMaster.md) | | [optional] **master_access** | **str** | | [optional] [default to 'none'] **mp4_support** | **str** | | [optional] [default to 'none'] -**source_asset_id** | **str** | Asset Identifier of the video used as the source for creating the clip. | [optional] +**source_asset_id** | **str** | Asset Identifier of the video used as the source for creating the clip. | [optional] **normalize_audio** | **bool** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to False] -**static_renditions** | [**AssetStaticRenditions**](AssetStaticRenditions.md) | | [optional] -**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 \"slate\" type. | [optional] -**non_standard_input_reasons** | [**AssetNonStandardInputReasons**](AssetNonStandardInputReasons.md) | | [optional] -**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] +**static_renditions** | [**AssetStaticRenditions**](AssetStaticRenditions.md) | | [optional] +**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 \"slate\" type. | [optional] +**non_standard_input_reasons** | [**AssetNonStandardInputReasons**](AssetNonStandardInputReasons.md) | | [optional] +**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] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AssetErrors.md b/docs/AssetErrors.md index c7b6abb..8cb6eff 100644 --- a/docs/AssetErrors.md +++ b/docs/AssetErrors.md @@ -4,8 +4,8 @@ Object that describes any errors that happened when processing this asset. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | The type of error that occurred for this asset. | [optional] -**messages** | **list[str]** | Error messages with more details. | [optional] +**type** | **str** | The type of error that occurred for this asset. | [optional] +**messages** | **list[str]** | Error messages with more details. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AssetMaster.md b/docs/AssetMaster.md index 6ccb387..4568542 100644 --- a/docs/AssetMaster.md +++ b/docs/AssetMaster.md @@ -4,8 +4,8 @@ An object containing the current status of Master Access and the link to the Mas ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **str** | | [optional] -**url** | **str** | The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours. | [optional] +**status** | **str** | | [optional] +**url** | **str** | The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AssetNonStandardInputReasons.md b/docs/AssetNonStandardInputReasons.md index 8084a52..7e6d316 100644 --- a/docs/AssetNonStandardInputReasons.md +++ b/docs/AssetNonStandardInputReasons.md @@ -4,16 +4,16 @@ An object containing one or more reasons the input file is non-standard. See [th ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**video_codec** | **str** | The video codec used on the input file. For example, the input file encoded with `hevc` video codec is non-standard and the value of this parameter is `hevc`. | [optional] -**audio_codec** | **str** | The audio codec used on the input file. Non-AAC audio codecs are non-standard. | [optional] -**video_gop_size** | **str** | The video key frame Interval (also called as Group of Picture or GOP) of the input file is `high`. This parameter is present when the gop is greater than 20 seconds. | [optional] -**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 `-1` frame rate value indicates Mux could not determine the frame rate of the video track. | [optional] -**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 `width` x `height` in pixels. | [optional] -**video_bitrate** | **str** | The video bitrate of the input file is `high`. This parameter is present when the average bitrate of any key frame interval (also known as Group of Pictures or GOP) is higher than what's considered standard which typically is 16 Mbps. | [optional] -**pixel_aspect_ratio** | **str** | The video pixel aspect ratio of the input file. | [optional] -**video_edit_list** | **str** | Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. | [optional] -**audio_edit_list** | **str** | Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. | [optional] -**unexpected_media_file_parameters** | **str** | A catch-all reason when the input file in created with non-standard encoding parameters. | [optional] +**video_codec** | **str** | The video codec used on the input file. For example, the input file encoded with `hevc` video codec is non-standard and the value of this parameter is `hevc`. | [optional] +**audio_codec** | **str** | The audio codec used on the input file. Non-AAC audio codecs are non-standard. | [optional] +**video_gop_size** | **str** | The video key frame Interval (also called as Group of Picture or GOP) of the input file is `high`. This parameter is present when the gop is greater than 20 seconds. | [optional] +**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 `-1` frame rate value indicates Mux could not determine the frame rate of the video track. | [optional] +**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 `width` x `height` in pixels. | [optional] +**video_bitrate** | **str** | The video bitrate of the input file is `high`. This parameter is present when the average bitrate of any key frame interval (also known as Group of Pictures or GOP) is higher than what's considered standard which typically is 16 Mbps. | [optional] +**pixel_aspect_ratio** | **str** | The video pixel aspect ratio of the input file. | [optional] +**video_edit_list** | **str** | Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. | [optional] +**audio_edit_list** | **str** | Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. | [optional] +**unexpected_media_file_parameters** | **str** | A catch-all reason when the input file in created with non-standard encoding parameters. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AssetRecordingTimes.md b/docs/AssetRecordingTimes.md index c1fb37c..11fd764 100644 --- a/docs/AssetRecordingTimes.md +++ b/docs/AssetRecordingTimes.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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] -**duration** | **float** | The duration of the live stream recorded. The time value is in seconds. | [optional] -**type** | **str** | The type of media represented by the recording session, either `content` for normal stream content or `slate` for slate media inserted during stream interruptions. | [optional] +**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] +**duration** | **float** | The duration of the live stream recorded. The time value is in seconds. | [optional] +**type** | **str** | The type of media represented by the recording session, either `content` for normal stream content or `slate` for slate media inserted during stream interruptions. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AssetResponse.md b/docs/AssetResponse.md index 93d6c22..94b2fd4 100644 --- a/docs/AssetResponse.md +++ b/docs/AssetResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**Asset**](Asset.md) | | [optional] +**data** | [**Asset**](Asset.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AssetStaticRenditions.md b/docs/AssetStaticRenditions.md index d33ebce..2f3219e 100644 --- a/docs/AssetStaticRenditions.md +++ b/docs/AssetStaticRenditions.md @@ -5,7 +5,7 @@ An object containing the current status of any static renditions (mp4s). The obj Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **status** | **str** | Indicates the status of downloadable MP4 versions of this asset. | [optional] [default to 'disabled'] -**files** | [**list[AssetStaticRenditionsFiles]**](AssetStaticRenditionsFiles.md) | Array of file objects. | [optional] +**files** | [**list[AssetStaticRenditionsFiles]**](AssetStaticRenditionsFiles.md) | Array of file objects. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AssetStaticRenditionsFiles.md b/docs/AssetStaticRenditionsFiles.md index c3e2c2f..a61d8eb 100644 --- a/docs/AssetStaticRenditionsFiles.md +++ b/docs/AssetStaticRenditionsFiles.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | | [optional] -**ext** | **str** | Extension of the static rendition file | [optional] -**height** | **int** | The height of the static rendition's file in pixels | [optional] -**width** | **int** | The width of the static rendition's file in pixels | [optional] -**bitrate** | **int** | The bitrate in bits per second | [optional] -**filesize** | **str** | The file size in bytes | [optional] +**name** | **str** | | [optional] +**ext** | **str** | Extension of the static rendition file | [optional] +**height** | **int** | The height of the static rendition's file in pixels | [optional] +**width** | **int** | The width of the static rendition's file in pixels | [optional] +**bitrate** | **int** | The bitrate in bits per second | [optional] +**filesize** | **str** | The file size in bytes | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BreakdownValue.md b/docs/BreakdownValue.md index 29cf8cf..4d24c9c 100644 --- a/docs/BreakdownValue.md +++ b/docs/BreakdownValue.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**views** | **int** | | [optional] -**value** | **float** | | [optional] -**total_watch_time** | **int** | | [optional] -**negative_impact** | **int** | | [optional] -**field** | **str** | | [optional] +**views** | **int** | | [optional] +**value** | **float** | | [optional] +**total_watch_time** | **int** | | [optional] +**negative_impact** | **int** | | [optional] +**field** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Broadcast.md b/docs/Broadcast.md index 1fdecc6..0495516 100644 --- a/docs/Broadcast.md +++ b/docs/Broadcast.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the broadcast. Max 255 characters. | -**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] -**live_stream_id** | **str** | The ID of the live stream that the broadcast will be sent to. | -**status** | [**BroadcastStatus**](BroadcastStatus.md) | | -**layout** | [**BroadcastLayout**](BroadcastLayout.md) | | -**background** | **str** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] -**resolution** | [**BroadcastResolution**](BroadcastResolution.md) | | +**id** | **str** | Unique identifier for the broadcast. Max 255 characters. | +**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] +**live_stream_id** | **str** | The ID of the live stream that the broadcast will be sent to. | +**status** | [**BroadcastStatus**](BroadcastStatus.md) | | +**layout** | [**BroadcastLayout**](BroadcastLayout.md) | | +**background** | **str** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] +**resolution** | [**BroadcastResolution**](BroadcastResolution.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BroadcastResponse.md b/docs/BroadcastResponse.md index 67ef1c3..2641270 100644 --- a/docs/BroadcastResponse.md +++ b/docs/BroadcastResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**Broadcast**](Broadcast.md) | | +**data** | [**Broadcast**](Broadcast.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateAssetRequest.md b/docs/CreateAssetRequest.md index 598d44b..87ed9e3 100644 --- a/docs/CreateAssetRequest.md +++ b/docs/CreateAssetRequest.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**input** | [**list[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] -**playback_policy** | [**list[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] -**per_title_encode** | **bool** | | [optional] -**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] -**mp4_support** | **str** | Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] +**input** | [**list[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] +**playback_policy** | [**list[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] +**per_title_encode** | **bool** | | [optional] +**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] +**mp4_support** | **str** | Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] **normalize_audio** | **bool** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to False] -**master_access** | **str** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] -**test** | **bool** | 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] +**master_access** | **str** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] +**test** | **bool** | 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] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateBroadcastRequest.md b/docs/CreateBroadcastRequest.md index aced479..8aa9058 100644 --- a/docs/CreateBroadcastRequest.md +++ b/docs/CreateBroadcastRequest.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] -**live_stream_id** | **str** | The ID of the live stream that you want to broadcast to. | -**layout** | [**BroadcastLayout**](BroadcastLayout.md) | | [optional] -**background** | **str** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] -**resolution** | [**BroadcastResolution**](BroadcastResolution.md) | | [optional] +**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] +**live_stream_id** | **str** | The ID of the live stream that you want to broadcast to. | +**layout** | [**BroadcastLayout**](BroadcastLayout.md) | | [optional] +**background** | **str** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] +**resolution** | [**BroadcastResolution**](BroadcastResolution.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateLiveStreamRequest.md b/docs/CreateLiveStreamRequest.md index dd79587..7fa1108 100644 --- a/docs/CreateLiveStreamRequest.md +++ b/docs/CreateLiveStreamRequest.md @@ -3,20 +3,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**playback_policy** | [**list[PlaybackPolicy]**](PlaybackPolicy.md) | | [optional] -**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] +**playback_policy** | [**list[PlaybackPolicy]**](PlaybackPolicy.md) | | [optional] +**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] **reconnect_window** | **float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Defaults to 60 seconds on the API if not specified. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. | [optional] [default to 60] -**use_slate_for_standard_latency** | **bool** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional] [default to False] -**reconnect_slate_url** | **str** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. | [optional] -**passthrough** | **str** | | [optional] -**audio_only** | **bool** | Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted. | [optional] -**embedded_subtitles** | [**list[LiveStreamEmbeddedSubtitleSettings]**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional] -**generated_subtitles** | [**list[LiveStreamGeneratedSubtitleSettings]**](LiveStreamGeneratedSubtitleSettings.md) | Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with `generated_subtitles` configured will automatically receive two text tracks. The first of these will have a `text_source` value of `generated_live`, and will be available with `ready` status as soon as the stream is live. The second text track will have a `text_source` value of `generated_live_final` and will contain subtitles with improved accuracy, timing, and formatting. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional] -**reduced_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] -**low_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. | [optional] -**latency_mode** | **str** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] -**test** | **bool** | Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] -**simulcast_targets** | [**list[CreateSimulcastTargetRequest]**](CreateSimulcastTargetRequest.md) | | [optional] +**use_slate_for_standard_latency** | **bool** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional] [default to False] +**reconnect_slate_url** | **str** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. | [optional] +**passthrough** | **str** | | [optional] +**audio_only** | **bool** | Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted. | [optional] +**embedded_subtitles** | [**list[LiveStreamEmbeddedSubtitleSettings]**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional] +**generated_subtitles** | [**list[LiveStreamGeneratedSubtitleSettings]**](LiveStreamGeneratedSubtitleSettings.md) | Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with `generated_subtitles` configured will automatically receive two text tracks. The first of these will have a `text_source` value of `generated_live`, and will be available with `ready` status as soon as the stream is live. The second text track will have a `text_source` value of `generated_live_final` and will contain subtitles with improved accuracy, timing, and formatting. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional] +**reduced_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] +**low_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. | [optional] +**latency_mode** | **str** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] +**test** | **bool** | Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] +**simulcast_targets** | [**list[CreateSimulcastTargetRequest]**](CreateSimulcastTargetRequest.md) | | [optional] **max_continuous_duration** | **int** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional] [default to 43200] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreatePlaybackIDRequest.md b/docs/CreatePlaybackIDRequest.md index c106fec..96e6d39 100644 --- a/docs/CreatePlaybackIDRequest.md +++ b/docs/CreatePlaybackIDRequest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional] +**policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreatePlaybackIDResponse.md b/docs/CreatePlaybackIDResponse.md index 028e5a7..cb7206f 100644 --- a/docs/CreatePlaybackIDResponse.md +++ b/docs/CreatePlaybackIDResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**PlaybackID**](PlaybackID.md) | | [optional] +**data** | [**PlaybackID**](PlaybackID.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreatePlaybackRestrictionRequest.md b/docs/CreatePlaybackRestrictionRequest.md index c2da1b9..7e0772d 100644 --- a/docs/CreatePlaybackRestrictionRequest.md +++ b/docs/CreatePlaybackRestrictionRequest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional] +**referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateSimulcastTargetRequest.md b/docs/CreateSimulcastTargetRequest.md index b435b4a..1720a38 100644 --- a/docs/CreateSimulcastTargetRequest.md +++ b/docs/CreateSimulcastTargetRequest.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**passthrough** | **str** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional] -**stream_key** | **str** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional] -**url** | **str** | RTMP hostname including application name for the third party live streaming service. Example: `rtmp://live.example.com/app`. | +**passthrough** | **str** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional] +**stream_key** | **str** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional] +**url** | **str** | RTMP hostname including application name for the third party live streaming service. Example: `rtmp://live.example.com/app`. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateSpaceRequest.md b/docs/CreateSpaceRequest.md index d8c3da1..600d3d1 100644 --- a/docs/CreateSpaceRequest.md +++ b/docs/CreateSpaceRequest.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | [**SpaceType**](SpaceType.md) | | [optional] -**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional] -**broadcasts** | [**list[CreateBroadcastRequest]**](CreateBroadcastRequest.md) | An array of broadcast destinations you want to stream the space to. **Note:** By default only a single broadcast destination can be specified. Contact Mux support if you need more. | [optional] +**type** | [**SpaceType**](SpaceType.md) | | [optional] +**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional] +**broadcasts** | [**list[CreateBroadcastRequest]**](CreateBroadcastRequest.md) | An array of broadcast destinations you want to stream the space to. **Note:** By default only a single broadcast destination can be specified. Contact Mux support if you need more. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateTrackRequest.md b/docs/CreateTrackRequest.md index 4ac4b65..9d278e8 100644 --- a/docs/CreateTrackRequest.md +++ b/docs/CreateTrackRequest.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**url** | **str** | | -**type** | **str** | | -**text_type** | **str** | | -**language_code** | **str** | 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. | -**name** | **str** | The name of the track containing a human-readable description. This value must be unique across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to \"English\" for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value. | [optional] -**closed_captions** | **bool** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional] -**passthrough** | **str** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. | [optional] +**url** | **str** | | +**type** | **str** | | +**text_type** | **str** | | +**language_code** | **str** | 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. | +**name** | **str** | The name of the track containing a human-readable description. This value must be unique across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to \"English\" for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value. | [optional] +**closed_captions** | **bool** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional] +**passthrough** | **str** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateTrackResponse.md b/docs/CreateTrackResponse.md index 75cc3f7..b6dc721 100644 --- a/docs/CreateTrackResponse.md +++ b/docs/CreateTrackResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**Track**](Track.md) | | [optional] +**data** | [**Track**](Track.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateTranscriptionVocabularyRequest.md b/docs/CreateTranscriptionVocabularyRequest.md index 113562b..cf5e225 100644 --- a/docs/CreateTranscriptionVocabularyRequest.md +++ b/docs/CreateTranscriptionVocabularyRequest.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | The user-supplied name of the Transcription Vocabulary. | [optional] -**phrases** | **list[str]** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream's `generated_subtitles`, the probability of successful speech recognition for these words or phrases is boosted. | -**passthrough** | **str** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [optional] +**name** | **str** | The user-supplied name of the Transcription Vocabulary. | [optional] +**phrases** | **list[str]** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream's `generated_subtitles`, the probability of successful speech recognition for these words or phrases is boosted. | +**passthrough** | **str** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateUploadRequest.md b/docs/CreateUploadRequest.md index 3d362ea..03fbf3b 100644 --- a/docs/CreateUploadRequest.md +++ b/docs/CreateUploadRequest.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **timeout** | **int** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked `timed_out` | [optional] [default to 3600] -**cors_origin** | **str** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] -**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | -**test** | **bool** | | [optional] +**cors_origin** | **str** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] +**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | +**test** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/DeliveryReport.md b/docs/DeliveryReport.md index 82269a3..c13fb2a 100644 --- a/docs/DeliveryReport.md +++ b/docs/DeliveryReport.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**live_stream_id** | **str** | Unique identifier for the live stream that created the asset. | [optional] -**asset_id** | **str** | Unique identifier for the asset. | [optional] -**passthrough** | **str** | The `passthrough` value for the asset. | [optional] -**created_at** | **str** | Time at which the asset was created. Measured in seconds since the Unix epoch. | [optional] -**deleted_at** | **str** | If exists, time at which the asset was deleted. Measured in seconds since the Unix epoch. | [optional] -**asset_state** | **str** | The state of the asset. | [optional] -**asset_duration** | **float** | The duration of the asset in seconds. | [optional] -**delivered_seconds** | **float** | Total number of delivered seconds during this time window. | [optional] +**live_stream_id** | **str** | Unique identifier for the live stream that created the asset. | [optional] +**asset_id** | **str** | Unique identifier for the asset. | [optional] +**passthrough** | **str** | The `passthrough` value for the asset. | [optional] +**created_at** | **str** | Time at which the asset was created. Measured in seconds since the Unix epoch. | [optional] +**deleted_at** | **str** | If exists, time at which the asset was deleted. Measured in seconds since the Unix epoch. | [optional] +**asset_state** | **str** | The state of the asset. | [optional] +**asset_duration** | **float** | The duration of the asset in seconds. | [optional] +**delivered_seconds** | **float** | Total number of delivered seconds during this time window. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/DimensionValue.md b/docs/DimensionValue.md index 9529367..bc300aa 100644 --- a/docs/DimensionValue.md +++ b/docs/DimensionValue.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | | [optional] -**total_count** | **int** | | [optional] +**value** | **str** | | [optional] +**total_count** | **int** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/DisableLiveStreamResponse.md b/docs/DisableLiveStreamResponse.md index f218568..e13f644 100644 --- a/docs/DisableLiveStreamResponse.md +++ b/docs/DisableLiveStreamResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | **object** | | [optional] +**data** | **object** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/EnableLiveStreamResponse.md b/docs/EnableLiveStreamResponse.md index 2822acc..f4a652f 100644 --- a/docs/EnableLiveStreamResponse.md +++ b/docs/EnableLiveStreamResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | **object** | | [optional] +**data** | **object** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Error.md b/docs/Error.md index 633389a..8342e09 100644 --- a/docs/Error.md +++ b/docs/Error.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | A unique identifier for this error. | [optional] -**percentage** | **float** | The percentage of views that experienced this error. | [optional] -**notes** | **str** | Notes that are attached to this error. | [optional] -**message** | **str** | The error message. | [optional] -**last_seen** | **str** | The last time this error was seen (ISO 8601 timestamp). | [optional] -**description** | **str** | Description of the error. | [optional] -**count** | **int** | The total number of views that experiend this error. | [optional] -**code** | **int** | The error code | [optional] +**id** | **int** | A unique identifier for this error. | [optional] +**percentage** | **float** | The percentage of views that experienced this error. | [optional] +**notes** | **str** | Notes that are attached to this error. | [optional] +**message** | **str** | The error message. | [optional] +**last_seen** | **str** | The last time this error was seen (ISO 8601 timestamp). | [optional] +**description** | **str** | Description of the error. | [optional] +**count** | **int** | The total number of views that experiend this error. | [optional] +**code** | **int** | The error code | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ExportDate.md b/docs/ExportDate.md index 77856f0..7f9ff1a 100644 --- a/docs/ExportDate.md +++ b/docs/ExportDate.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**export_date** | **date** | | [optional] -**files** | [**list[ExportFile]**](ExportFile.md) | | [optional] +**export_date** | **date** | | [optional] +**files** | [**list[ExportFile]**](ExportFile.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ExportFile.md b/docs/ExportFile.md index 1f3d41e..f21006c 100644 --- a/docs/ExportFile.md +++ b/docs/ExportFile.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**version** | **int** | | [optional] -**type** | **str** | | [optional] -**path** | **str** | | [optional] +**version** | **int** | | [optional] +**type** | **str** | | [optional] +**path** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/FilterValue.md b/docs/FilterValue.md index 4a5835c..ebd40f2 100644 --- a/docs/FilterValue.md +++ b/docs/FilterValue.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | | [optional] -**total_count** | **int** | | [optional] +**value** | **str** | | [optional] +**total_count** | **int** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetAssetInputInfoResponse.md b/docs/GetAssetInputInfoResponse.md index 05d1faf..0aac73d 100644 --- a/docs/GetAssetInputInfoResponse.md +++ b/docs/GetAssetInputInfoResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[InputInfo]**](InputInfo.md) | | [optional] +**data** | [**list[InputInfo]**](InputInfo.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetAssetOrLiveStreamIdResponse.md b/docs/GetAssetOrLiveStreamIdResponse.md index da5eb9e..1ce0ca7 100644 --- a/docs/GetAssetOrLiveStreamIdResponse.md +++ b/docs/GetAssetOrLiveStreamIdResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**GetAssetOrLiveStreamIdResponseData**](GetAssetOrLiveStreamIdResponseData.md) | | [optional] +**data** | [**GetAssetOrLiveStreamIdResponseData**](GetAssetOrLiveStreamIdResponseData.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetAssetOrLiveStreamIdResponseData.md b/docs/GetAssetOrLiveStreamIdResponseData.md index d502e3c..2197f67 100644 --- a/docs/GetAssetOrLiveStreamIdResponseData.md +++ b/docs/GetAssetOrLiveStreamIdResponseData.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The Playback ID used to retrieve the corresponding asset or the live stream ID | [optional] -**policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional] -**object** | [**GetAssetOrLiveStreamIdResponseDataObject**](GetAssetOrLiveStreamIdResponseDataObject.md) | | [optional] +**id** | **str** | The Playback ID used to retrieve the corresponding asset or the live stream ID | [optional] +**policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional] +**object** | [**GetAssetOrLiveStreamIdResponseDataObject**](GetAssetOrLiveStreamIdResponseDataObject.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetAssetOrLiveStreamIdResponseDataObject.md b/docs/GetAssetOrLiveStreamIdResponseDataObject.md index 797a90b..b14c974 100644 --- a/docs/GetAssetOrLiveStreamIdResponseDataObject.md +++ b/docs/GetAssetOrLiveStreamIdResponseDataObject.md @@ -4,8 +4,8 @@ Describes the Asset or LiveStream object associated with the playback ID. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The identifier of the object. | [optional] -**type** | **str** | Identifies the object type associated with the playback ID. | [optional] +**id** | **str** | The identifier of the object. | [optional] +**type** | **str** | Identifies the object type associated with the playback ID. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetAssetPlaybackIDResponse.md b/docs/GetAssetPlaybackIDResponse.md index b2ca7e7..e049bfe 100644 --- a/docs/GetAssetPlaybackIDResponse.md +++ b/docs/GetAssetPlaybackIDResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**PlaybackID**](PlaybackID.md) | | [optional] +**data** | [**PlaybackID**](PlaybackID.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetLiveStreamPlaybackIDResponse.md b/docs/GetLiveStreamPlaybackIDResponse.md index 8ac8592..81477de 100644 --- a/docs/GetLiveStreamPlaybackIDResponse.md +++ b/docs/GetLiveStreamPlaybackIDResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**PlaybackID**](PlaybackID.md) | | [optional] +**data** | [**PlaybackID**](PlaybackID.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetMetricTimeseriesDataResponse.md b/docs/GetMetricTimeseriesDataResponse.md index 7d850b8..f635bd8 100644 --- a/docs/GetMetricTimeseriesDataResponse.md +++ b/docs/GetMetricTimeseriesDataResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | **list[list[str]]** | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | **list[list[str]]** | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetOverallValuesResponse.md b/docs/GetOverallValuesResponse.md index b809728..a4ee877 100644 --- a/docs/GetOverallValuesResponse.md +++ b/docs/GetOverallValuesResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**OverallValues**](OverallValues.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**OverallValues**](OverallValues.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetRealTimeBreakdownResponse.md b/docs/GetRealTimeBreakdownResponse.md index 3c8c9ac..a3bc09e 100644 --- a/docs/GetRealTimeBreakdownResponse.md +++ b/docs/GetRealTimeBreakdownResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[RealTimeBreakdownValue]**](RealTimeBreakdownValue.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[RealTimeBreakdownValue]**](RealTimeBreakdownValue.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetRealTimeHistogramTimeseriesResponse.md b/docs/GetRealTimeHistogramTimeseriesResponse.md index ac40b1c..cc56867 100644 --- a/docs/GetRealTimeHistogramTimeseriesResponse.md +++ b/docs/GetRealTimeHistogramTimeseriesResponse.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**meta** | [**GetRealTimeHistogramTimeseriesResponseMeta**](GetRealTimeHistogramTimeseriesResponseMeta.md) | | [optional] -**data** | [**list[RealTimeHistogramTimeseriesDatapoint]**](RealTimeHistogramTimeseriesDatapoint.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**meta** | [**GetRealTimeHistogramTimeseriesResponseMeta**](GetRealTimeHistogramTimeseriesResponseMeta.md) | | [optional] +**data** | [**list[RealTimeHistogramTimeseriesDatapoint]**](RealTimeHistogramTimeseriesDatapoint.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetRealTimeHistogramTimeseriesResponseMeta.md b/docs/GetRealTimeHistogramTimeseriesResponseMeta.md index e44c003..25d89cb 100644 --- a/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +++ b/docs/GetRealTimeHistogramTimeseriesResponseMeta.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**buckets** | [**list[RealTimeHistogramTimeseriesBucket]**](RealTimeHistogramTimeseriesBucket.md) | | [optional] +**buckets** | [**list[RealTimeHistogramTimeseriesBucket]**](RealTimeHistogramTimeseriesBucket.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetRealTimeTimeseriesResponse.md b/docs/GetRealTimeTimeseriesResponse.md index 20d4213..a994234 100644 --- a/docs/GetRealTimeTimeseriesResponse.md +++ b/docs/GetRealTimeTimeseriesResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[RealTimeTimeseriesDatapoint]**](RealTimeTimeseriesDatapoint.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[RealTimeTimeseriesDatapoint]**](RealTimeTimeseriesDatapoint.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Incident.md b/docs/Incident.md index 18965c4..e5f81c9 100644 --- a/docs/Incident.md +++ b/docs/Incident.md @@ -3,27 +3,27 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**threshold** | **float** | | [optional] -**status** | **str** | | [optional] -**started_at** | **str** | | [optional] -**severity** | **str** | | [optional] -**sample_size_unit** | **str** | | [optional] -**sample_size** | **int** | | [optional] -**resolved_at** | **str** | | [optional] -**notifications** | [**list[IncidentNotification]**](IncidentNotification.md) | | [optional] -**notification_rules** | [**list[IncidentNotificationRule]**](IncidentNotificationRule.md) | | [optional] -**measurement** | **str** | | [optional] -**measured_value_on_close** | **float** | | [optional] -**measured_value** | **float** | | [optional] -**incident_key** | **str** | | [optional] -**impact** | **str** | | [optional] -**id** | **str** | | [optional] -**error_description** | **str** | | [optional] -**description** | **str** | | [optional] -**breakdowns** | [**list[IncidentBreakdown]**](IncidentBreakdown.md) | | [optional] -**affected_views_per_hour_on_open** | **int** | | [optional] -**affected_views_per_hour** | **int** | | [optional] -**affected_views** | **int** | | [optional] +**threshold** | **float** | | [optional] +**status** | **str** | | [optional] +**started_at** | **str** | | [optional] +**severity** | **str** | | [optional] +**sample_size_unit** | **str** | | [optional] +**sample_size** | **int** | | [optional] +**resolved_at** | **str** | | [optional] +**notifications** | [**list[IncidentNotification]**](IncidentNotification.md) | | [optional] +**notification_rules** | [**list[IncidentNotificationRule]**](IncidentNotificationRule.md) | | [optional] +**measurement** | **str** | | [optional] +**measured_value_on_close** | **float** | | [optional] +**measured_value** | **float** | | [optional] +**incident_key** | **str** | | [optional] +**impact** | **str** | | [optional] +**id** | **str** | | [optional] +**error_description** | **str** | | [optional] +**description** | **str** | | [optional] +**breakdowns** | [**list[IncidentBreakdown]**](IncidentBreakdown.md) | | [optional] +**affected_views_per_hour_on_open** | **int** | | [optional] +**affected_views_per_hour** | **int** | | [optional] +**affected_views** | **int** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/IncidentBreakdown.md b/docs/IncidentBreakdown.md index 4637c17..bbf3b8c 100644 --- a/docs/IncidentBreakdown.md +++ b/docs/IncidentBreakdown.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | | [optional] -**name** | **str** | | [optional] -**id** | **str** | | [optional] +**value** | **str** | | [optional] +**name** | **str** | | [optional] +**id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/IncidentNotification.md b/docs/IncidentNotification.md index cd58569..ad01f08 100644 --- a/docs/IncidentNotification.md +++ b/docs/IncidentNotification.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**queued_at** | **str** | | [optional] -**id** | **int** | | [optional] -**attempted_at** | **str** | | [optional] +**queued_at** | **str** | | [optional] +**id** | **int** | | [optional] +**attempted_at** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/IncidentNotificationRule.md b/docs/IncidentNotificationRule.md index 1105162..9e166d6 100644 --- a/docs/IncidentNotificationRule.md +++ b/docs/IncidentNotificationRule.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **str** | | [optional] -**rules** | [**list[NotificationRule]**](NotificationRule.md) | | [optional] -**property_id** | **str** | | [optional] -**id** | **str** | | [optional] -**action** | **str** | | [optional] +**status** | **str** | | [optional] +**rules** | [**list[NotificationRule]**](NotificationRule.md) | | [optional] +**property_id** | **str** | | [optional] +**id** | **str** | | [optional] +**action** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/IncidentResponse.md b/docs/IncidentResponse.md index 7dccf34..2427fe4 100644 --- a/docs/IncidentResponse.md +++ b/docs/IncidentResponse.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**Incident**](Incident.md) | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**Incident**](Incident.md) | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InputFile.md b/docs/InputFile.md index a6cdf30..c24eedb 100644 --- a/docs/InputFile.md +++ b/docs/InputFile.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**container_format** | **str** | | [optional] -**tracks** | [**list[InputTrack]**](InputTrack.md) | | [optional] +**container_format** | **str** | | [optional] +**tracks** | [**list[InputTrack]**](InputTrack.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InputInfo.md b/docs/InputInfo.md index 74dd1a7..78a63ac 100644 --- a/docs/InputInfo.md +++ b/docs/InputInfo.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**settings** | [**InputSettings**](InputSettings.md) | | [optional] -**file** | [**InputFile**](InputFile.md) | | [optional] +**settings** | [**InputSettings**](InputSettings.md) | | [optional] +**file** | [**InputFile**](InputFile.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InputSettings.md b/docs/InputSettings.md index 3abcb3b..a58b87d 100644 --- a/docs/InputSettings.md +++ b/docs/InputSettings.md @@ -4,16 +4,16 @@ An array of objects that each describe an input file to be used to create the as ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**url** | **str** | The URL of the file that Mux should download and use. * For subtitles text tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) format for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. | [optional] -**overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) | | [optional] -**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] -**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] -**type** | **str** | This parameter is required for `text` type tracks. | [optional] -**text_type** | **str** | Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for `text` type tracks. | [optional] -**language_code** | **str** | 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] -**name** | **str** | The name of the track containing a human-readable description. This value must be unique across all text type and subtitles `text` type tracks. The hls manifest will associate a subtitle text track with this value. For example, the value should be \"English\" for subtitles text track with language_code as en. This optional parameter should be used only for `text` type and subtitles `text` type tracks. If this parameter is not included, Mux will auto-populate based on the `input[].language_code` value. | [optional] -**closed_captions** | **bool** | 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] -**passthrough** | **str** | This optional parameter should be used for `text` type and subtitles `text` type tracks. | [optional] +**url** | **str** | The URL of the file that Mux should download and use. * For subtitles text tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) format for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. | [optional] +**overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) | | [optional] +**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] +**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] +**type** | **str** | This parameter is required for `text` type tracks. | [optional] +**text_type** | **str** | Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for `text` type tracks. | [optional] +**language_code** | **str** | 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] +**name** | **str** | The name of the track containing a human-readable description. This value must be unique across all text type and subtitles `text` type tracks. The hls manifest will associate a subtitle text track with this value. For example, the value should be \"English\" for subtitles text track with language_code as en. This optional parameter should be used only for `text` type and subtitles `text` type tracks. If this parameter is not included, Mux will auto-populate based on the `input[].language_code` value. | [optional] +**closed_captions** | **bool** | 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] +**passthrough** | **str** | This optional parameter should be used for `text` type and subtitles `text` type tracks. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InputSettingsOverlaySettings.md b/docs/InputSettingsOverlaySettings.md index cf180a1..f649bb4 100644 --- a/docs/InputSettingsOverlaySettings.md +++ b/docs/InputSettingsOverlaySettings.md @@ -4,13 +4,13 @@ An object that describes how the image file referenced in URL should be placed o ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**vertical_align** | **str** | Where the vertical positioning of the overlay/watermark should begin from. Defaults to `\"top\"` | [optional] -**vertical_margin** | **str** | 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] -**horizontal_align** | **str** | Where the horizontal positioning of the overlay/watermark should begin from. | [optional] -**horizontal_margin** | **str** | 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] -**width** | **str** | 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] -**height** | **str** | 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] -**opacity** | **str** | How opaque the overlay should appear, expressed as a percent. (Default 100%) | [optional] +**vertical_align** | **str** | Where the vertical positioning of the overlay/watermark should begin from. Defaults to `\"top\"` | [optional] +**vertical_margin** | **str** | 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] +**horizontal_align** | **str** | Where the horizontal positioning of the overlay/watermark should begin from. | [optional] +**horizontal_margin** | **str** | 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] +**width** | **str** | 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] +**height** | **str** | 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] +**opacity** | **str** | How opaque the overlay should appear, expressed as a percent. (Default 100%) | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InputTrack.md b/docs/InputTrack.md index 47a2825..5ffa7bc 100644 --- a/docs/InputTrack.md +++ b/docs/InputTrack.md @@ -3,15 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | | [optional] -**duration** | **float** | | [optional] -**encoding** | **str** | | [optional] -**width** | **int** | | [optional] -**height** | **int** | | [optional] -**frame_rate** | **float** | | [optional] -**sample_rate** | **int** | | [optional] -**sample_size** | **int** | | [optional] -**channels** | **int** | | [optional] +**type** | **str** | | [optional] +**duration** | **float** | | [optional] +**encoding** | **str** | | [optional] +**width** | **int** | | [optional] +**height** | **int** | | [optional] +**frame_rate** | **float** | | [optional] +**sample_rate** | **int** | | [optional] +**sample_size** | **int** | | [optional] +**channels** | **int** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Insight.md b/docs/Insight.md index 1400ce5..96d413b 100644 --- a/docs/Insight.md +++ b/docs/Insight.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total_watch_time** | **int** | | [optional] -**total_views** | **int** | | [optional] -**negative_impact_score** | **float** | | [optional] -**metric** | **float** | | [optional] -**filter_value** | **str** | | [optional] -**filter_column** | **str** | | [optional] +**total_watch_time** | **int** | | [optional] +**total_views** | **int** | | [optional] +**negative_impact_score** | **float** | | [optional] +**metric** | **float** | | [optional] +**filter_value** | **str** | | [optional] +**filter_column** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListAllMetricValuesResponse.md b/docs/ListAllMetricValuesResponse.md index 914f4fe..4ba9acb 100644 --- a/docs/ListAllMetricValuesResponse.md +++ b/docs/ListAllMetricValuesResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[Score]**](Score.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[Score]**](Score.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListAssetsResponse.md b/docs/ListAssetsResponse.md index a9ef74b..60e3607 100644 --- a/docs/ListAssetsResponse.md +++ b/docs/ListAssetsResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[Asset]**](Asset.md) | | [optional] +**data** | [**list[Asset]**](Asset.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListBreakdownValuesResponse.md b/docs/ListBreakdownValuesResponse.md index 71766fd..e4993b2 100644 --- a/docs/ListBreakdownValuesResponse.md +++ b/docs/ListBreakdownValuesResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[BreakdownValue]**](BreakdownValue.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[BreakdownValue]**](BreakdownValue.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListDeliveryUsageResponse.md b/docs/ListDeliveryUsageResponse.md index 2d410d4..da3ff44 100644 --- a/docs/ListDeliveryUsageResponse.md +++ b/docs/ListDeliveryUsageResponse.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[DeliveryReport]**](DeliveryReport.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] -**limit** | **int** | Number of assets returned in this response. Default value is 100. | [optional] +**data** | [**list[DeliveryReport]**](DeliveryReport.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] +**limit** | **int** | Number of assets returned in this response. Default value is 100. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListDimensionValuesResponse.md b/docs/ListDimensionValuesResponse.md index e128eca..53b0c39 100644 --- a/docs/ListDimensionValuesResponse.md +++ b/docs/ListDimensionValuesResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[DimensionValue]**](DimensionValue.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[DimensionValue]**](DimensionValue.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListDimensionsResponse.md b/docs/ListDimensionsResponse.md index 37803b1..df345db 100644 --- a/docs/ListDimensionsResponse.md +++ b/docs/ListDimensionsResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**ListFiltersResponseData**](ListFiltersResponseData.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**ListFiltersResponseData**](ListFiltersResponseData.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListErrorsResponse.md b/docs/ListErrorsResponse.md index 063c1ff..6e82e6c 100644 --- a/docs/ListErrorsResponse.md +++ b/docs/ListErrorsResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[Error]**](Error.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[Error]**](Error.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListExportsResponse.md b/docs/ListExportsResponse.md index 2da57ad..7c63fc3 100644 --- a/docs/ListExportsResponse.md +++ b/docs/ListExportsResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | **list[str]** | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | **list[str]** | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListFilterValuesResponse.md b/docs/ListFilterValuesResponse.md index ca13dc4..a9ce930 100644 --- a/docs/ListFilterValuesResponse.md +++ b/docs/ListFilterValuesResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[FilterValue]**](FilterValue.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[FilterValue]**](FilterValue.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListFiltersResponse.md b/docs/ListFiltersResponse.md index ea82c73..9a551fd 100644 --- a/docs/ListFiltersResponse.md +++ b/docs/ListFiltersResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**ListFiltersResponseData**](ListFiltersResponseData.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**ListFiltersResponseData**](ListFiltersResponseData.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListFiltersResponseData.md b/docs/ListFiltersResponseData.md index 7732197..2e3ac4d 100644 --- a/docs/ListFiltersResponseData.md +++ b/docs/ListFiltersResponseData.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**basic** | **list[str]** | | [optional] -**advanced** | **list[str]** | | [optional] +**basic** | **list[str]** | | [optional] +**advanced** | **list[str]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListIncidentsResponse.md b/docs/ListIncidentsResponse.md index 2977f9d..ff71ccb 100644 --- a/docs/ListIncidentsResponse.md +++ b/docs/ListIncidentsResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[Incident]**](Incident.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[Incident]**](Incident.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListInsightsResponse.md b/docs/ListInsightsResponse.md index 02cf57a..50fb564 100644 --- a/docs/ListInsightsResponse.md +++ b/docs/ListInsightsResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[Insight]**](Insight.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[Insight]**](Insight.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListLiveStreamsResponse.md b/docs/ListLiveStreamsResponse.md index 6a244e4..3acb103 100644 --- a/docs/ListLiveStreamsResponse.md +++ b/docs/ListLiveStreamsResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[LiveStream]**](LiveStream.md) | | [optional] +**data** | [**list[LiveStream]**](LiveStream.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListPlaybackRestrictionsResponse.md b/docs/ListPlaybackRestrictionsResponse.md index 7d08bd6..32754f0 100644 --- a/docs/ListPlaybackRestrictionsResponse.md +++ b/docs/ListPlaybackRestrictionsResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[PlaybackRestriction]**](PlaybackRestriction.md) | | [optional] +**data** | [**list[PlaybackRestriction]**](PlaybackRestriction.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListRealTimeDimensionsResponse.md b/docs/ListRealTimeDimensionsResponse.md index 75835ad..bc02817 100644 --- a/docs/ListRealTimeDimensionsResponse.md +++ b/docs/ListRealTimeDimensionsResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[ListRealTimeDimensionsResponseData]**](ListRealTimeDimensionsResponseData.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[ListRealTimeDimensionsResponseData]**](ListRealTimeDimensionsResponseData.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListRealTimeDimensionsResponseData.md b/docs/ListRealTimeDimensionsResponseData.md index 95f6016..ee269a7 100644 --- a/docs/ListRealTimeDimensionsResponseData.md +++ b/docs/ListRealTimeDimensionsResponseData.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | | [optional] -**display_name** | **str** | | [optional] +**name** | **str** | | [optional] +**display_name** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListRealTimeMetricsResponse.md b/docs/ListRealTimeMetricsResponse.md index 55c9934..33ec658 100644 --- a/docs/ListRealTimeMetricsResponse.md +++ b/docs/ListRealTimeMetricsResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[ListRealTimeDimensionsResponseData]**](ListRealTimeDimensionsResponseData.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[ListRealTimeDimensionsResponseData]**](ListRealTimeDimensionsResponseData.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListRelatedIncidentsResponse.md b/docs/ListRelatedIncidentsResponse.md index 59e8208..61191d0 100644 --- a/docs/ListRelatedIncidentsResponse.md +++ b/docs/ListRelatedIncidentsResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[Incident]**](Incident.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[Incident]**](Incident.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListSigningKeysResponse.md b/docs/ListSigningKeysResponse.md index 7df8c4f..a367db9 100644 --- a/docs/ListSigningKeysResponse.md +++ b/docs/ListSigningKeysResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[SigningKey]**](SigningKey.md) | | [optional] +**data** | [**list[SigningKey]**](SigningKey.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListSpacesResponse.md b/docs/ListSpacesResponse.md index 7a599e8..c7c4e9c 100644 --- a/docs/ListSpacesResponse.md +++ b/docs/ListSpacesResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[Space]**](Space.md) | | +**data** | [**list[Space]**](Space.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListTranscriptionVocabulariesResponse.md b/docs/ListTranscriptionVocabulariesResponse.md index 94c37ac..4eb5947 100644 --- a/docs/ListTranscriptionVocabulariesResponse.md +++ b/docs/ListTranscriptionVocabulariesResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[TranscriptionVocabulary]**](TranscriptionVocabulary.md) | | [optional] +**data** | [**list[TranscriptionVocabulary]**](TranscriptionVocabulary.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListUploadsResponse.md b/docs/ListUploadsResponse.md index 34f070b..18d6eb5 100644 --- a/docs/ListUploadsResponse.md +++ b/docs/ListUploadsResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[Upload]**](Upload.md) | | [optional] +**data** | [**list[Upload]**](Upload.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListVideoViewExportsResponse.md b/docs/ListVideoViewExportsResponse.md index 3dd616c..a52e060 100644 --- a/docs/ListVideoViewExportsResponse.md +++ b/docs/ListVideoViewExportsResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[ExportDate]**](ExportDate.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[ExportDate]**](ExportDate.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListVideoViewsResponse.md b/docs/ListVideoViewsResponse.md index f590e15..9bb5754 100644 --- a/docs/ListVideoViewsResponse.md +++ b/docs/ListVideoViewsResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**list[AbridgedVideoView]**](AbridgedVideoView.md) | | [optional] -**total_row_count** | **int** | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**list[AbridgedVideoView]**](AbridgedVideoView.md) | | [optional] +**total_row_count** | **int** | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LiveStream.md b/docs/LiveStream.md index 5547209..94e79b1 100644 --- a/docs/LiveStream.md +++ b/docs/LiveStream.md @@ -3,26 +3,26 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the Live Stream. Max 255 characters. | [optional] -**created_at** | **str** | Time the Live Stream was created, defined as a Unix timestamp (seconds since epoch). | [optional] -**stream_key** | **str** | Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming. | [optional] -**active_asset_id** | **str** | The Asset that is currently being created if there is an active broadcast. | [optional] -**recent_asset_ids** | **list[str]** | An array of strings with the most recent Assets that were created from this live stream. | [optional] -**status** | [**LiveStreamStatus**](LiveStreamStatus.md) | | [optional] -**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] -**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] -**passthrough** | **str** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] -**audio_only** | **bool** | The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted. | [optional] -**embedded_subtitles** | [**list[LiveStreamEmbeddedSubtitleSettings]**](LiveStreamEmbeddedSubtitleSettings.md) | Describes the embedded closed caption configuration of the incoming live stream. | [optional] -**generated_subtitles** | [**list[LiveStreamGeneratedSubtitleSettings]**](LiveStreamGeneratedSubtitleSettings.md) | Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with `generated_subtitles` configured will automatically receive two text tracks. The first of these will have a `text_source` value of `generated_live`, and will be available with `ready` status as soon as the stream is live. The second text track will have a `text_source` value of `generated_live_final` and will contain subtitles with improved accuracy, timing, and formatting. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional] +**id** | **str** | Unique identifier for the Live Stream. Max 255 characters. | [optional] +**created_at** | **str** | Time the Live Stream was created, defined as a Unix timestamp (seconds since epoch). | [optional] +**stream_key** | **str** | Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming. | [optional] +**active_asset_id** | **str** | The Asset that is currently being created if there is an active broadcast. | [optional] +**recent_asset_ids** | **list[str]** | An array of strings with the most recent Assets that were created from this live stream. | [optional] +**status** | [**LiveStreamStatus**](LiveStreamStatus.md) | | [optional] +**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] +**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] +**passthrough** | **str** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] +**audio_only** | **bool** | The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted. | [optional] +**embedded_subtitles** | [**list[LiveStreamEmbeddedSubtitleSettings]**](LiveStreamEmbeddedSubtitleSettings.md) | Describes the embedded closed caption configuration of the incoming live stream. | [optional] +**generated_subtitles** | [**list[LiveStreamGeneratedSubtitleSettings]**](LiveStreamGeneratedSubtitleSettings.md) | Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with `generated_subtitles` configured will automatically receive two text tracks. The first of these will have a `text_source` value of `generated_live`, and will be available with `ready` status as soon as the stream is live. The second text track will have a `text_source` value of `generated_live_final` and will contain subtitles with improved accuracy, timing, and formatting. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional] **reconnect_window** | **float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. **Max**: 1800s (30 minutes). Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. | [optional] [default to 60] -**use_slate_for_standard_latency** | **bool** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional] [default to False] -**reconnect_slate_url** | **str** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. | [optional] -**reduced_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional] -**low_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. | [optional] -**simulcast_targets** | [**list[SimulcastTarget]**](SimulcastTarget.md) | Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/video/stream-live-to-3rd-party-platforms). | [optional] -**latency_mode** | **str** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] -**test** | **bool** | 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] +**use_slate_for_standard_latency** | **bool** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional] [default to False] +**reconnect_slate_url** | **str** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. | [optional] +**reduced_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional] +**low_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. | [optional] +**simulcast_targets** | [**list[SimulcastTarget]**](SimulcastTarget.md) | Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/video/stream-live-to-3rd-party-platforms). | [optional] +**latency_mode** | **str** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] +**test** | **bool** | 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] **max_continuous_duration** | **int** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional] [default to 43200] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LiveStreamEmbeddedSubtitleSettings.md b/docs/LiveStreamEmbeddedSubtitleSettings.md index d0e615e..3874bb0 100644 --- a/docs/LiveStreamEmbeddedSubtitleSettings.md +++ b/docs/LiveStreamEmbeddedSubtitleSettings.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | A name for this live stream closed caption track. | [optional] -**passthrough** | **str** | Arbitrary user-supplied metadata set for the live stream closed caption track. Max 255 characters. | [optional] +**name** | **str** | A name for this live stream closed caption track. | [optional] +**passthrough** | **str** | Arbitrary user-supplied metadata set for the live stream closed caption track. Max 255 characters. | [optional] **language_code** | **str** | The language of the closed caption stream. Value must be BCP 47 compliant. | [optional] [default to 'en'] **language_channel** | **str** | CEA-608 caption channel to read data from. | [optional] [default to 'cc1'] diff --git a/docs/LiveStreamGeneratedSubtitleSettings.md b/docs/LiveStreamGeneratedSubtitleSettings.md index 39d3707..9786791 100644 --- a/docs/LiveStreamGeneratedSubtitleSettings.md +++ b/docs/LiveStreamGeneratedSubtitleSettings.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | A name for this live stream subtitle track. | [optional] -**passthrough** | **str** | Arbitrary metadata set for the live stream subtitle track. Max 255 characters. | [optional] +**name** | **str** | A name for this live stream subtitle track. | [optional] +**passthrough** | **str** | Arbitrary metadata set for the live stream subtitle track. Max 255 characters. | [optional] **language_code** | **str** | The language to generate subtitles in. | [optional] [default to 'en'] -**transcription_vocabulary_ids** | **list[str]** | Unique identifiers for existing Transcription Vocabularies to use while generating subtitles for the live stream. If the Transcription Vocabularies provided collectively have more than 1000 phrases, only the first 1000 phrases will be included. | [optional] +**transcription_vocabulary_ids** | **list[str]** | Unique identifiers for existing Transcription Vocabularies to use while generating subtitles for the live stream. If the Transcription Vocabularies provided collectively have more than 1000 phrases, only the first 1000 phrases will be included. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LiveStreamResponse.md b/docs/LiveStreamResponse.md index a0f3706..95c4d42 100644 --- a/docs/LiveStreamResponse.md +++ b/docs/LiveStreamResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**LiveStream**](LiveStream.md) | | [optional] +**data** | [**LiveStream**](LiveStream.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Metric.md b/docs/Metric.md index 911ed0e..868cf26 100644 --- a/docs/Metric.md +++ b/docs/Metric.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **float** | | [optional] -**type** | **str** | | [optional] -**name** | **str** | | [optional] -**metric** | **str** | | [optional] -**measurement** | **str** | | [optional] +**value** | **float** | | [optional] +**type** | **str** | | [optional] +**name** | **str** | | [optional] +**metric** | **str** | | [optional] +**measurement** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/NotificationRule.md b/docs/NotificationRule.md index c4bc046..2df88f4 100644 --- a/docs/NotificationRule.md +++ b/docs/NotificationRule.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | | [optional] -**name** | **str** | | [optional] -**id** | **str** | | [optional] +**value** | **str** | | [optional] +**name** | **str** | | [optional] +**id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/OverallValues.md b/docs/OverallValues.md index be56e5a..ba1394d 100644 --- a/docs/OverallValues.md +++ b/docs/OverallValues.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **float** | | [optional] -**total_watch_time** | **int** | | [optional] -**total_views** | **int** | | [optional] -**global_value** | **float** | | [optional] +**value** | **float** | | [optional] +**total_watch_time** | **int** | | [optional] +**total_views** | **int** | | [optional] +**global_value** | **float** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PlaybackID.md b/docs/PlaybackID.md index e3752f4..eb05b4e 100644 --- a/docs/PlaybackID.md +++ b/docs/PlaybackID.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the PlaybackID | [optional] -**policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional] +**id** | **str** | Unique identifier for the PlaybackID | [optional] +**policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PlaybackRestriction.md b/docs/PlaybackRestriction.md index 202fd63..03b5fad 100644 --- a/docs/PlaybackRestriction.md +++ b/docs/PlaybackRestriction.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the Playback Restriction. Max 255 characters. | [optional] -**created_at** | **str** | Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch). | [optional] -**updated_at** | **str** | Time the Playback Restriction was last updated, defined as a Unix timestamp (seconds since epoch). | [optional] -**referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional] +**id** | **str** | Unique identifier for the Playback Restriction. Max 255 characters. | [optional] +**created_at** | **str** | Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch). | [optional] +**updated_at** | **str** | Time the Playback Restriction was last updated, defined as a Unix timestamp (seconds since epoch). | [optional] +**referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PlaybackRestrictionResponse.md b/docs/PlaybackRestrictionResponse.md index a220b2c..52aa8b3 100644 --- a/docs/PlaybackRestrictionResponse.md +++ b/docs/PlaybackRestrictionResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**PlaybackRestriction**](PlaybackRestriction.md) | | [optional] +**data** | [**PlaybackRestriction**](PlaybackRestriction.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RealTimeBreakdownValue.md b/docs/RealTimeBreakdownValue.md index 25b4dcd..2ecba2a 100644 --- a/docs/RealTimeBreakdownValue.md +++ b/docs/RealTimeBreakdownValue.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | | [optional] -**negative_impact** | **int** | | [optional] -**metric_value** | **float** | | [optional] -**display_value** | **str** | | [optional] -**concurrent_viewers** | **int** | | [optional] +**value** | **str** | | [optional] +**negative_impact** | **int** | | [optional] +**metric_value** | **float** | | [optional] +**display_value** | **str** | | [optional] +**concurrent_viewers** | **int** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RealTimeHistogramTimeseriesBucket.md b/docs/RealTimeHistogramTimeseriesBucket.md index ff0a537..11a9bed 100644 --- a/docs/RealTimeHistogramTimeseriesBucket.md +++ b/docs/RealTimeHistogramTimeseriesBucket.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**start** | **int** | | [optional] -**end** | **int** | | [optional] +**start** | **int** | | [optional] +**end** | **int** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RealTimeHistogramTimeseriesBucketValues.md b/docs/RealTimeHistogramTimeseriesBucketValues.md index a9d39b1..ca8f9eb 100644 --- a/docs/RealTimeHistogramTimeseriesBucketValues.md +++ b/docs/RealTimeHistogramTimeseriesBucketValues.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**percentage** | **float** | | [optional] -**count** | **int** | | [optional] +**percentage** | **float** | | [optional] +**count** | **int** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RealTimeHistogramTimeseriesDatapoint.md b/docs/RealTimeHistogramTimeseriesDatapoint.md index d6f0352..5431d47 100644 --- a/docs/RealTimeHistogramTimeseriesDatapoint.md +++ b/docs/RealTimeHistogramTimeseriesDatapoint.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**timestamp** | **str** | | [optional] -**sum** | **int** | | [optional] -**p95** | **float** | | [optional] -**median** | **float** | | [optional] -**max_percentage** | **float** | | [optional] -**bucket_values** | [**list[RealTimeHistogramTimeseriesBucketValues]**](RealTimeHistogramTimeseriesBucketValues.md) | | [optional] -**average** | **float** | | [optional] +**timestamp** | **str** | | [optional] +**sum** | **int** | | [optional] +**p95** | **float** | | [optional] +**median** | **float** | | [optional] +**max_percentage** | **float** | | [optional] +**bucket_values** | [**list[RealTimeHistogramTimeseriesBucketValues]**](RealTimeHistogramTimeseriesBucketValues.md) | | [optional] +**average** | **float** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RealTimeTimeseriesDatapoint.md b/docs/RealTimeTimeseriesDatapoint.md index fcdd58b..33c01c5 100644 --- a/docs/RealTimeTimeseriesDatapoint.md +++ b/docs/RealTimeTimeseriesDatapoint.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **float** | | [optional] -**date** | **str** | | [optional] -**concurrent_viewers** | **int** | | [optional] +**value** | **float** | | [optional] +**date** | **str** | | [optional] +**concurrent_viewers** | **int** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ReferrerDomainRestriction.md b/docs/ReferrerDomainRestriction.md index ecbc9be..2ec5ad0 100644 --- a/docs/ReferrerDomainRestriction.md +++ b/docs/ReferrerDomainRestriction.md @@ -4,7 +4,7 @@ A list of domains allowed to play your videos. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**allowed_domains** | **list[str]** | 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] +**allowed_domains** | **list[str]** | 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] **allow_no_referrer** | **bool** | 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] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Score.md b/docs/Score.md index eefb73c..20cdf51 100644 --- a/docs/Score.md +++ b/docs/Score.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**watch_time** | **int** | | [optional] -**view_count** | **int** | | [optional] -**name** | **str** | | [optional] -**value** | **float** | | [optional] -**metric** | **str** | | [optional] -**items** | [**list[Metric]**](Metric.md) | | [optional] +**watch_time** | **int** | | [optional] +**view_count** | **int** | | [optional] +**name** | **str** | | [optional] +**value** | **float** | | [optional] +**metric** | **str** | | [optional] +**items** | [**list[Metric]**](Metric.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SignalLiveStreamCompleteResponse.md b/docs/SignalLiveStreamCompleteResponse.md index 974fa4f..9e24539 100644 --- a/docs/SignalLiveStreamCompleteResponse.md +++ b/docs/SignalLiveStreamCompleteResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | **object** | | [optional] +**data** | **object** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SigningKey.md b/docs/SigningKey.md index 972dde6..29da399 100644 --- a/docs/SigningKey.md +++ b/docs/SigningKey.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the Signing Key. | [optional] -**created_at** | **str** | Time at which the object was created. Measured in seconds since the Unix epoch. | [optional] -**private_key** | **str** | A Base64 encoded private key that can be used with the RS256 algorithm when creating a [JWT](https://jwt.io/). **Note that this value is only returned once when creating a URL signing key.** | [optional] +**id** | **str** | Unique identifier for the Signing Key. | [optional] +**created_at** | **str** | Time at which the object was created. Measured in seconds since the Unix epoch. | [optional] +**private_key** | **str** | A Base64 encoded private key that can be used with the RS256 algorithm when creating a [JWT](https://jwt.io/). **Note that this value is only returned once when creating a URL signing key.** | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SigningKeyResponse.md b/docs/SigningKeyResponse.md index 7672e2a..8927624 100644 --- a/docs/SigningKeyResponse.md +++ b/docs/SigningKeyResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**SigningKey**](SigningKey.md) | | [optional] +**data** | [**SigningKey**](SigningKey.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SimulcastTarget.md b/docs/SimulcastTarget.md index 1ea8951..e9fdf73 100644 --- a/docs/SimulcastTarget.md +++ b/docs/SimulcastTarget.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | ID of the Simulcast Target | [optional] -**passthrough** | **str** | Arbitrary user-supplied metadata set when creating a simulcast target. | [optional] -**status** | **str** | The current status of the simulcast target. See Statuses below for detailed description. * `idle`: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state. * `starting`: The simulcast target transitions into this state when the parent live stream transition into connected state. * `broadcasting`: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service. * `errored`: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. Compared to other errored statuses in the Mux Video API, a simulcast may transition back into the broadcasting state if a connection with the service can be re-established. | [optional] -**stream_key** | **str** | Stream Key represents an stream identifier for the third party live streaming service to simulcast the parent live stream too. | [optional] -**url** | **str** | RTMP hostname including the application name for the third party live streaming service. | [optional] +**id** | **str** | ID of the Simulcast Target | [optional] +**passthrough** | **str** | Arbitrary user-supplied metadata set when creating a simulcast target. | [optional] +**status** | **str** | The current status of the simulcast target. See Statuses below for detailed description. * `idle`: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state. * `starting`: The simulcast target transitions into this state when the parent live stream transition into connected state. * `broadcasting`: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service. * `errored`: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. Compared to other errored statuses in the Mux Video API, a simulcast may transition back into the broadcasting state if a connection with the service can be re-established. | [optional] +**stream_key** | **str** | Stream Key represents an stream identifier for the third party live streaming service to simulcast the parent live stream too. | [optional] +**url** | **str** | RTMP hostname including the application name for the third party live streaming service. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SimulcastTargetResponse.md b/docs/SimulcastTargetResponse.md index d76e230..27fba41 100644 --- a/docs/SimulcastTargetResponse.md +++ b/docs/SimulcastTargetResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**SimulcastTarget**](SimulcastTarget.md) | | [optional] +**data** | [**SimulcastTarget**](SimulcastTarget.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Space.md b/docs/Space.md index a375bdf..31cbd2f 100644 --- a/docs/Space.md +++ b/docs/Space.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the space. Max 255 characters. | -**created_at** | **str** | Time the space was created, defined as a Unix timestamp (seconds since epoch). | -**type** | [**SpaceType**](SpaceType.md) | | -**status** | [**SpaceStatus**](SpaceStatus.md) | | -**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional] -**broadcasts** | [**list[Broadcast]**](Broadcast.md) | An array of broadcast destinations. | [optional] -**active_session_id** | **str** | Unique identifier for the current lifecycle of the space. Only set when the space is `active` and is set to a new value each time the space transitions from `idle` to `active`. This value is useful for logging and debugging issues. Max 255 characters. | [optional] +**id** | **str** | Unique identifier for the space. Max 255 characters. | +**created_at** | **str** | Time the space was created, defined as a Unix timestamp (seconds since epoch). | +**type** | [**SpaceType**](SpaceType.md) | | +**status** | [**SpaceStatus**](SpaceStatus.md) | | +**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional] +**broadcasts** | [**list[Broadcast]**](Broadcast.md) | An array of broadcast destinations. | [optional] +**active_session_id** | **str** | Unique identifier for the current lifecycle of the space. Only set when the space is `active` and is set to a new value each time the space transitions from `idle` to `active`. This value is useful for logging and debugging issues. Max 255 characters. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SpaceResponse.md b/docs/SpaceResponse.md index ef6bd22..b53b45a 100644 --- a/docs/SpaceResponse.md +++ b/docs/SpaceResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**Space**](Space.md) | | +**data** | [**Space**](Space.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/StartSpaceBroadcastResponse.md b/docs/StartSpaceBroadcastResponse.md index f7e5ae4..775a48f 100644 --- a/docs/StartSpaceBroadcastResponse.md +++ b/docs/StartSpaceBroadcastResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | **object** | | [optional] +**data** | **object** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/StopSpaceBroadcastResponse.md b/docs/StopSpaceBroadcastResponse.md index fca5563..8264aed 100644 --- a/docs/StopSpaceBroadcastResponse.md +++ b/docs/StopSpaceBroadcastResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | **object** | | [optional] +**data** | **object** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Track.md b/docs/Track.md index e6cd366..d9690fe 100644 --- a/docs/Track.md +++ b/docs/Track.md @@ -3,21 +3,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the Track | [optional] -**type** | **str** | The type of track | [optional] -**duration** | **float** | The duration in seconds of the track media. This parameter is not set for `text` type tracks. This field is optional and may not be set. The top level `duration` field of an asset will always be set. | [optional] -**max_width** | **int** | The maximum width in pixels available for the track. Only set for the `video` type track. | [optional] -**max_height** | **int** | The maximum height in pixels available for the track. Only set for the `video` type track. | [optional] -**max_frame_rate** | **float** | The maximum frame rate available for the track. Only set for the `video` type track. This field may return `-1` if the frame rate of the input cannot be reliably determined. | [optional] -**max_channels** | **int** | The maximum number of audio channels the track supports. Only set for the `audio` type track. | [optional] -**max_channel_layout** | **str** | Only set for the `audio` type track. | [optional] -**text_type** | **str** | This parameter is only set for `text` type tracks. | [optional] -**text_source** | **str** | The source of the text contained in a Track of type `text`. Valid `text_source` values are listed below. * `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API. * `embedded`: Tracks extracted from an embedded stream of CEA-608 closed captions. * `generated_live`: Tracks generated by automatic speech recognition on a live stream configured with `generated_subtitles`. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. * `generated_live_final`: Tracks generated by automatic speech recognition on a live stream using `generated_subtitles`. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding `generated_live` tracks. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional] -**language_code** | **str** | The language code value represents [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 only set for `text` type and `subtitles` text type tracks. | [optional] -**name** | **str** | The name of the track containing a human-readable description. The hls manifest will associate a subtitle text track with this value. For example, the value is \"English\" for subtitles text track for the `language_code` value of `en-US`. This parameter is only set for `text` type and `subtitles` text type tracks. | [optional] -**closed_captions** | **bool** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is only set for `text` type and `subtitles` text type tracks. | [optional] -**passthrough** | **str** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. This parameter is only set for `text` type tracks. Max 255 characters. | [optional] -**status** | **str** | The status of the track. This parameter is only set for `text` type tracks. | [optional] +**id** | **str** | Unique identifier for the Track | [optional] +**type** | **str** | The type of track | [optional] +**duration** | **float** | The duration in seconds of the track media. This parameter is not set for `text` type tracks. This field is optional and may not be set. The top level `duration` field of an asset will always be set. | [optional] +**max_width** | **int** | The maximum width in pixels available for the track. Only set for the `video` type track. | [optional] +**max_height** | **int** | The maximum height in pixels available for the track. Only set for the `video` type track. | [optional] +**max_frame_rate** | **float** | The maximum frame rate available for the track. Only set for the `video` type track. This field may return `-1` if the frame rate of the input cannot be reliably determined. | [optional] +**max_channels** | **int** | The maximum number of audio channels the track supports. Only set for the `audio` type track. | [optional] +**max_channel_layout** | **str** | Only set for the `audio` type track. | [optional] +**text_type** | **str** | This parameter is only set for `text` type tracks. | [optional] +**text_source** | **str** | The source of the text contained in a Track of type `text`. Valid `text_source` values are listed below. * `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API. * `embedded`: Tracks extracted from an embedded stream of CEA-608 closed captions. * `generated_live`: Tracks generated by automatic speech recognition on a live stream configured with `generated_subtitles`. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. * `generated_live_final`: Tracks generated by automatic speech recognition on a live stream using `generated_subtitles`. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding `generated_live` tracks. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional] +**language_code** | **str** | The language code value represents [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 only set for `text` type and `subtitles` text type tracks. | [optional] +**name** | **str** | The name of the track containing a human-readable description. The hls manifest will associate a subtitle text track with this value. For example, the value is \"English\" for subtitles text track for the `language_code` value of `en-US`. This parameter is only set for `text` type and `subtitles` text type tracks. | [optional] +**closed_captions** | **bool** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is only set for `text` type and `subtitles` text type tracks. | [optional] +**passthrough** | **str** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. This parameter is only set for `text` type tracks. Max 255 characters. | [optional] +**status** | **str** | The status of the track. This parameter is only set for `text` type tracks. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TranscriptionVocabulary.md b/docs/TranscriptionVocabulary.md index 56cb2b8..bce73c7 100644 --- a/docs/TranscriptionVocabulary.md +++ b/docs/TranscriptionVocabulary.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the Transcription Vocabulary | [optional] -**name** | **str** | The user-supplied name of the Transcription Vocabulary. | [optional] -**phrases** | **list[str]** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream's `generated_subtitles` configuration, the probability of successful speech recognition for these words or phrases is boosted. | [optional] -**passthrough** | **str** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [optional] -**created_at** | **str** | Time the Transcription Vocabulary was created, defined as a Unix timestamp (seconds since epoch). | [optional] -**updated_at** | **str** | Time the Transcription Vocabulary was updated, defined as a Unix timestamp (seconds since epoch). | [optional] +**id** | **str** | Unique identifier for the Transcription Vocabulary | [optional] +**name** | **str** | The user-supplied name of the Transcription Vocabulary. | [optional] +**phrases** | **list[str]** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream's `generated_subtitles` configuration, the probability of successful speech recognition for these words or phrases is boosted. | [optional] +**passthrough** | **str** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [optional] +**created_at** | **str** | Time the Transcription Vocabulary was created, defined as a Unix timestamp (seconds since epoch). | [optional] +**updated_at** | **str** | Time the Transcription Vocabulary was updated, defined as a Unix timestamp (seconds since epoch). | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TranscriptionVocabularyResponse.md b/docs/TranscriptionVocabularyResponse.md index 9addab7..32a21e9 100644 --- a/docs/TranscriptionVocabularyResponse.md +++ b/docs/TranscriptionVocabularyResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**TranscriptionVocabulary**](TranscriptionVocabulary.md) | | [optional] +**data** | [**TranscriptionVocabulary**](TranscriptionVocabulary.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateAssetMP4SupportRequest.md b/docs/UpdateAssetMP4SupportRequest.md index 0303c85..dfb4ce2 100644 --- a/docs/UpdateAssetMP4SupportRequest.md +++ b/docs/UpdateAssetMP4SupportRequest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mp4_support** | **str** | String value for the level of mp4 support | [optional] +**mp4_support** | **str** | String value for the level of mp4 support | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateAssetMasterAccessRequest.md b/docs/UpdateAssetMasterAccessRequest.md index fe04a77..4a493dd 100644 --- a/docs/UpdateAssetMasterAccessRequest.md +++ b/docs/UpdateAssetMasterAccessRequest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**master_access** | **str** | Add or remove access to the master version of the video. | [optional] +**master_access** | **str** | Add or remove access to the master version of the video. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateAssetRequest.md b/docs/UpdateAssetRequest.md index f56ff65..3ee0c7f 100644 --- a/docs/UpdateAssetRequest.md +++ b/docs/UpdateAssetRequest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**passthrough** | **str** | Arbitrary metadata set for the Asset. Max 255 characters. In order to clear this value, the field should be included with an empty string value. | [optional] +**passthrough** | **str** | Arbitrary metadata set for the Asset. Max 255 characters. In order to clear this value, the field should be included with an empty string value. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md b/docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md index 04abd75..6542fa2 100644 --- a/docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md +++ b/docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**embedded_subtitles** | [**list[LiveStreamEmbeddedSubtitleSettings]**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional] +**embedded_subtitles** | [**list[LiveStreamEmbeddedSubtitleSettings]**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateLiveStreamGeneratedSubtitlesRequest.md b/docs/UpdateLiveStreamGeneratedSubtitlesRequest.md index 123358d..aa81be9 100644 --- a/docs/UpdateLiveStreamGeneratedSubtitlesRequest.md +++ b/docs/UpdateLiveStreamGeneratedSubtitlesRequest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**generated_subtitles** | [**list[LiveStreamGeneratedSubtitleSettings]**](LiveStreamGeneratedSubtitleSettings.md) | Update automated speech recognition subtitle configuration for a live stream. At most one subtitle track is allowed. | [optional] +**generated_subtitles** | [**list[LiveStreamGeneratedSubtitleSettings]**](LiveStreamGeneratedSubtitleSettings.md) | Update automated speech recognition subtitle configuration for a live stream. At most one subtitle track is allowed. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateLiveStreamRequest.md b/docs/UpdateLiveStreamRequest.md index 7aec116..d9c8dfc 100644 --- a/docs/UpdateLiveStreamRequest.md +++ b/docs/UpdateLiveStreamRequest.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**passthrough** | **str** | Arbitrary user-supplied metadata set for the live stream. Max 255 characters. In order to clear this value, the field should be included with an empty-string value. | [optional] -**latency_mode** | **str** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] +**passthrough** | **str** | Arbitrary user-supplied metadata set for the live stream. Max 255 characters. In order to clear this value, the field should be included with an empty-string value. | [optional] +**latency_mode** | **str** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] **reconnect_window** | **float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. | [optional] [default to 60] -**use_slate_for_standard_latency** | **bool** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional] [default to False] -**reconnect_slate_url** | **str** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the default slate media will be used. | [optional] +**use_slate_for_standard_latency** | **bool** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional] [default to False] +**reconnect_slate_url** | **str** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the default slate media will be used. | [optional] **max_continuous_duration** | **int** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional] [default to 43200] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateReferrerDomainRestrictionRequest.md b/docs/UpdateReferrerDomainRestrictionRequest.md index e25f7f0..d07a439 100644 --- a/docs/UpdateReferrerDomainRestrictionRequest.md +++ b/docs/UpdateReferrerDomainRestrictionRequest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**allowed_domains** | **list[str]** | 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] +**allowed_domains** | **list[str]** | 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] **allow_no_referrer** | **bool** | 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] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateTranscriptionVocabularyRequest.md b/docs/UpdateTranscriptionVocabularyRequest.md index 53610d4..275a471 100644 --- a/docs/UpdateTranscriptionVocabularyRequest.md +++ b/docs/UpdateTranscriptionVocabularyRequest.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | The user-supplied name of the Transcription Vocabulary. | [optional] -**phrases** | **list[str]** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream's `generated_subtitles`, the probability of successful speech recognition for these words or phrases is boosted. | -**passthrough** | **str** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [optional] +**name** | **str** | The user-supplied name of the Transcription Vocabulary. | [optional] +**phrases** | **list[str]** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream's `generated_subtitles`, the probability of successful speech recognition for these words or phrases is boosted. | +**passthrough** | **str** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Upload.md b/docs/Upload.md index d74889c..53f8211 100644 --- a/docs/Upload.md +++ b/docs/Upload.md @@ -3,15 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the Direct Upload. | [optional] +**id** | **str** | Unique identifier for the Direct Upload. | [optional] **timeout** | **int** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked `timed_out` | [optional] [default to 3600] -**status** | **str** | | [optional] -**new_asset_settings** | [**Asset**](Asset.md) | | [optional] -**asset_id** | **str** | Only set once the upload is in the `asset_created` state. | [optional] -**error** | [**UploadError**](UploadError.md) | | [optional] -**cors_origin** | **str** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] -**url** | **str** | The URL to upload the associated source media to. | [optional] -**test** | **bool** | Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a `test` Asset. | [optional] +**status** | **str** | | [optional] +**new_asset_settings** | [**Asset**](Asset.md) | | [optional] +**asset_id** | **str** | Only set once the upload is in the `asset_created` state. | [optional] +**error** | [**UploadError**](UploadError.md) | | [optional] +**cors_origin** | **str** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] +**url** | **str** | The URL to upload the associated source media to. | [optional] +**test** | **bool** | Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a `test` Asset. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UploadError.md b/docs/UploadError.md index 3288b49..783de91 100644 --- a/docs/UploadError.md +++ b/docs/UploadError.md @@ -4,8 +4,8 @@ Only set if an error occurred during asset creation. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | Label for the specific error | [optional] -**message** | **str** | Human readable error message | [optional] +**type** | **str** | Label for the specific error | [optional] +**message** | **str** | Human readable error message | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UploadResponse.md b/docs/UploadResponse.md index 8ed377a..0862fc1 100644 --- a/docs/UploadResponse.md +++ b/docs/UploadResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**Upload**](Upload.md) | | [optional] +**data** | [**Upload**](Upload.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VideoView.md b/docs/VideoView.md index 792837a..f430cc3 100644 --- a/docs/VideoView.md +++ b/docs/VideoView.md @@ -3,131 +3,131 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**view_total_upscaling** | **str** | | [optional] -**preroll_ad_asset_hostname** | **str** | | [optional] -**player_source_domain** | **str** | | [optional] -**region** | **str** | | [optional] -**viewer_user_agent** | **str** | | [optional] -**preroll_requested** | **bool** | | [optional] -**page_type** | **str** | | [optional] -**startup_score** | **str** | | [optional] -**view_seek_duration** | **int** | | [optional] -**country_name** | **str** | | [optional] -**player_source_height** | **int** | | [optional] -**longitude** | **str** | | [optional] -**buffering_count** | **int** | | [optional] -**video_duration** | **int** | | [optional] -**player_source_type** | **str** | | [optional] -**city** | **str** | | [optional] -**view_id** | **str** | | [optional] -**platform_description** | **str** | | [optional] -**video_startup_preroll_request_time** | **int** | | [optional] -**viewer_device_name** | **str** | | [optional] -**video_series** | **str** | | [optional] -**viewer_application_name** | **str** | | [optional] -**updated_at** | **str** | | [optional] -**view_total_content_playback_time** | **int** | | [optional] -**cdn** | **str** | | [optional] -**player_instance_id** | **str** | | [optional] -**video_language** | **str** | | [optional] -**player_source_width** | **int** | | [optional] -**player_error_message** | **str** | | [optional] -**player_mux_plugin_version** | **str** | | [optional] -**watched** | **bool** | | [optional] -**playback_score** | **str** | | [optional] -**page_url** | **str** | | [optional] -**metro** | **str** | | [optional] -**view_max_request_latency** | **int** | | [optional] -**requests_for_first_preroll** | **int** | | [optional] -**view_total_downscaling** | **str** | | [optional] -**latitude** | **str** | | [optional] -**player_source_host_name** | **str** | | [optional] -**inserted_at** | **str** | | [optional] -**view_end** | **str** | | [optional] -**mux_embed_version** | **str** | | [optional] -**player_language** | **str** | | [optional] -**page_load_time** | **int** | | [optional] -**viewer_device_category** | **str** | | [optional] -**video_startup_preroll_load_time** | **int** | | [optional] -**player_version** | **str** | | [optional] -**watch_time** | **int** | | [optional] -**player_source_stream_type** | **str** | | [optional] -**preroll_ad_tag_hostname** | **str** | | [optional] -**viewer_device_manufacturer** | **str** | | [optional] -**rebuffering_score** | **str** | | [optional] -**experiment_name** | **str** | | [optional] -**viewer_os_version** | **str** | | [optional] -**player_preload** | **bool** | | [optional] -**buffering_duration** | **int** | | [optional] -**player_view_count** | **int** | | [optional] -**player_software** | **str** | | [optional] -**player_load_time** | **int** | | [optional] -**platform_summary** | **str** | | [optional] -**video_encoding_variant** | **str** | | [optional] -**player_width** | **int** | | [optional] -**view_seek_count** | **int** | | [optional] -**viewer_experience_score** | **str** | | [optional] -**view_error_id** | **int** | | [optional] -**video_variant_name** | **str** | | [optional] -**preroll_played** | **bool** | | [optional] -**viewer_application_engine** | **str** | | [optional] -**viewer_os_architecture** | **str** | | [optional] -**player_error_code** | **str** | | [optional] -**buffering_rate** | **str** | | [optional] -**events** | [**list[VideoViewEvent]**](VideoViewEvent.md) | | [optional] -**player_name** | **str** | | [optional] -**view_start** | **str** | | [optional] -**view_average_request_throughput** | **int** | | [optional] -**video_producer** | **str** | | [optional] -**error_type_id** | **int** | | [optional] -**mux_viewer_id** | **str** | | [optional] -**video_id** | **str** | | [optional] -**continent_code** | **str** | | [optional] -**session_id** | **str** | | [optional] -**exit_before_video_start** | **bool** | | [optional] -**video_content_type** | **str** | | [optional] -**viewer_os_family** | **str** | | [optional] -**player_poster** | **str** | | [optional] -**view_average_request_latency** | **int** | | [optional] -**video_variant_id** | **str** | | [optional] -**player_source_duration** | **int** | | [optional] -**player_source_url** | **str** | | [optional] -**mux_api_version** | **str** | | [optional] -**video_title** | **str** | | [optional] -**id** | **str** | | [optional] -**short_time** | **str** | | [optional] -**rebuffer_percentage** | **str** | | [optional] -**time_to_first_frame** | **int** | | [optional] -**viewer_user_id** | **str** | | [optional] -**video_stream_type** | **str** | | [optional] -**player_startup_time** | **int** | | [optional] -**viewer_application_version** | **str** | | [optional] -**view_max_downscale_percentage** | **str** | | [optional] -**view_max_upscale_percentage** | **str** | | [optional] -**country_code** | **str** | | [optional] -**used_fullscreen** | **bool** | | [optional] -**isp** | **str** | | [optional] -**property_id** | **int** | | [optional] -**player_autoplay** | **bool** | | [optional] -**player_height** | **int** | | [optional] -**asn** | **int** | | [optional] -**asn_name** | **str** | | [optional] -**quality_score** | **str** | | [optional] -**player_software_version** | **str** | | [optional] -**player_mux_plugin_name** | **str** | | [optional] -**sub_property_id** | **str** | | [optional] -**player_remote_played** | **bool** | | [optional] -**view_max_playhead_position** | **str** | | [optional] -**view_playing_time** | **str** | | [optional] -**view_session_id** | **str** | | [optional] -**viewer_connection_type** | **str** | | [optional] -**viewer_device_model** | **str** | | [optional] -**weighted_average_bitrate** | **int** | | [optional] -**custom_1** | **str** | | [optional] -**custom_2** | **str** | | [optional] -**custom_3** | **str** | | [optional] -**custom_4** | **str** | | [optional] -**custom_5** | **str** | | [optional] +**view_total_upscaling** | **str** | | [optional] +**preroll_ad_asset_hostname** | **str** | | [optional] +**player_source_domain** | **str** | | [optional] +**region** | **str** | | [optional] +**viewer_user_agent** | **str** | | [optional] +**preroll_requested** | **bool** | | [optional] +**page_type** | **str** | | [optional] +**startup_score** | **str** | | [optional] +**view_seek_duration** | **int** | | [optional] +**country_name** | **str** | | [optional] +**player_source_height** | **int** | | [optional] +**longitude** | **str** | | [optional] +**buffering_count** | **int** | | [optional] +**video_duration** | **int** | | [optional] +**player_source_type** | **str** | | [optional] +**city** | **str** | | [optional] +**view_id** | **str** | | [optional] +**platform_description** | **str** | | [optional] +**video_startup_preroll_request_time** | **int** | | [optional] +**viewer_device_name** | **str** | | [optional] +**video_series** | **str** | | [optional] +**viewer_application_name** | **str** | | [optional] +**updated_at** | **str** | | [optional] +**view_total_content_playback_time** | **int** | | [optional] +**cdn** | **str** | | [optional] +**player_instance_id** | **str** | | [optional] +**video_language** | **str** | | [optional] +**player_source_width** | **int** | | [optional] +**player_error_message** | **str** | | [optional] +**player_mux_plugin_version** | **str** | | [optional] +**watched** | **bool** | | [optional] +**playback_score** | **str** | | [optional] +**page_url** | **str** | | [optional] +**metro** | **str** | | [optional] +**view_max_request_latency** | **int** | | [optional] +**requests_for_first_preroll** | **int** | | [optional] +**view_total_downscaling** | **str** | | [optional] +**latitude** | **str** | | [optional] +**player_source_host_name** | **str** | | [optional] +**inserted_at** | **str** | | [optional] +**view_end** | **str** | | [optional] +**mux_embed_version** | **str** | | [optional] +**player_language** | **str** | | [optional] +**page_load_time** | **int** | | [optional] +**viewer_device_category** | **str** | | [optional] +**video_startup_preroll_load_time** | **int** | | [optional] +**player_version** | **str** | | [optional] +**watch_time** | **int** | | [optional] +**player_source_stream_type** | **str** | | [optional] +**preroll_ad_tag_hostname** | **str** | | [optional] +**viewer_device_manufacturer** | **str** | | [optional] +**rebuffering_score** | **str** | | [optional] +**experiment_name** | **str** | | [optional] +**viewer_os_version** | **str** | | [optional] +**player_preload** | **bool** | | [optional] +**buffering_duration** | **int** | | [optional] +**player_view_count** | **int** | | [optional] +**player_software** | **str** | | [optional] +**player_load_time** | **int** | | [optional] +**platform_summary** | **str** | | [optional] +**video_encoding_variant** | **str** | | [optional] +**player_width** | **int** | | [optional] +**view_seek_count** | **int** | | [optional] +**viewer_experience_score** | **str** | | [optional] +**view_error_id** | **int** | | [optional] +**video_variant_name** | **str** | | [optional] +**preroll_played** | **bool** | | [optional] +**viewer_application_engine** | **str** | | [optional] +**viewer_os_architecture** | **str** | | [optional] +**player_error_code** | **str** | | [optional] +**buffering_rate** | **str** | | [optional] +**events** | [**list[VideoViewEvent]**](VideoViewEvent.md) | | [optional] +**player_name** | **str** | | [optional] +**view_start** | **str** | | [optional] +**view_average_request_throughput** | **int** | | [optional] +**video_producer** | **str** | | [optional] +**error_type_id** | **int** | | [optional] +**mux_viewer_id** | **str** | | [optional] +**video_id** | **str** | | [optional] +**continent_code** | **str** | | [optional] +**session_id** | **str** | | [optional] +**exit_before_video_start** | **bool** | | [optional] +**video_content_type** | **str** | | [optional] +**viewer_os_family** | **str** | | [optional] +**player_poster** | **str** | | [optional] +**view_average_request_latency** | **int** | | [optional] +**video_variant_id** | **str** | | [optional] +**player_source_duration** | **int** | | [optional] +**player_source_url** | **str** | | [optional] +**mux_api_version** | **str** | | [optional] +**video_title** | **str** | | [optional] +**id** | **str** | | [optional] +**short_time** | **str** | | [optional] +**rebuffer_percentage** | **str** | | [optional] +**time_to_first_frame** | **int** | | [optional] +**viewer_user_id** | **str** | | [optional] +**video_stream_type** | **str** | | [optional] +**player_startup_time** | **int** | | [optional] +**viewer_application_version** | **str** | | [optional] +**view_max_downscale_percentage** | **str** | | [optional] +**view_max_upscale_percentage** | **str** | | [optional] +**country_code** | **str** | | [optional] +**used_fullscreen** | **bool** | | [optional] +**isp** | **str** | | [optional] +**property_id** | **int** | | [optional] +**player_autoplay** | **bool** | | [optional] +**player_height** | **int** | | [optional] +**asn** | **int** | | [optional] +**asn_name** | **str** | | [optional] +**quality_score** | **str** | | [optional] +**player_software_version** | **str** | | [optional] +**player_mux_plugin_name** | **str** | | [optional] +**sub_property_id** | **str** | | [optional] +**player_remote_played** | **bool** | | [optional] +**view_max_playhead_position** | **str** | | [optional] +**view_playing_time** | **str** | | [optional] +**view_session_id** | **str** | | [optional] +**viewer_connection_type** | **str** | | [optional] +**viewer_device_model** | **str** | | [optional] +**weighted_average_bitrate** | **int** | | [optional] +**custom_1** | **str** | | [optional] +**custom_2** | **str** | | [optional] +**custom_3** | **str** | | [optional] +**custom_4** | **str** | | [optional] +**custom_5** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VideoViewEvent.md b/docs/VideoViewEvent.md index b81edfe..19929fe 100644 --- a/docs/VideoViewEvent.md +++ b/docs/VideoViewEvent.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**viewer_time** | **int** | | [optional] -**playback_time** | **int** | | [optional] -**name** | **str** | | [optional] -**event_time** | **int** | | [optional] +**viewer_time** | **int** | | [optional] +**playback_time** | **int** | | [optional] +**name** | **str** | | [optional] +**event_time** | **int** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VideoViewResponse.md b/docs/VideoViewResponse.md index 724aed5..b83f483 100644 --- a/docs/VideoViewResponse.md +++ b/docs/VideoViewResponse.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**VideoView**](VideoView.md) | | [optional] -**timeframe** | **list[int]** | | [optional] +**data** | [**VideoView**](VideoView.md) | | [optional] +**timeframe** | **list[int]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VideoViewsApi.md b/docs/VideoViewsApi.md index 30fa21c..c2330c6 100644 --- a/docs/VideoViewsApi.md +++ b/docs/VideoViewsApi.md @@ -86,7 +86,7 @@ Name | Type | Description | Notes List Video Views -Returns a list of video views. +Returns a list of video views which match the filters and have a `view_end` within the specified timeframe. ### Example diff --git a/gen/generator-config.json b/gen/generator-config.json index b0771cd..87364b2 100644 --- a/gen/generator-config.json +++ b/gen/generator-config.json @@ -2,5 +2,5 @@ "!!source": "https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/python.md", "packageName": "mux_python", "projectName": "mux_python", - "packageVersion": "3.7.0" + "packageVersion": "3.7.1" } diff --git a/mux_python/__init__.py b/mux_python/__init__.py index d4d3e70..da486fb 100644 --- a/mux_python/__init__.py +++ b/mux_python/__init__.py @@ -15,7 +15,7 @@ from __future__ import absolute_import -__version__ = "3.7.0" +__version__ = "3.7.1" # import apis into sdk package from mux_python.api.assets_api import AssetsApi diff --git a/mux_python/api/video_views_api.py b/mux_python/api/video_views_api.py index dfc4eb7..317d346 100644 --- a/mux_python/api/video_views_api.py +++ b/mux_python/api/video_views_api.py @@ -175,7 +175,7 @@ def get_video_view_with_http_info(self, video_view_id, **kwargs): # noqa: E501 def list_video_views(self, **kwargs): # noqa: E501 """List Video Views # noqa: E501 - Returns a list of video views. # noqa: E501 + Returns a list of video views which match the filters and have a `view_end` within the specified timeframe. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -217,7 +217,7 @@ def list_video_views(self, **kwargs): # noqa: E501 def list_video_views_with_http_info(self, **kwargs): # noqa: E501 """List Video Views # noqa: E501 - Returns a list of video views. # noqa: E501 + Returns a list of video views which match the filters and have a `view_end` within the specified timeframe. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/mux_python/api_client.py b/mux_python/api_client.py index ab6f775..5f8ba5d 100644 --- a/mux_python/api_client.py +++ b/mux_python/api_client.py @@ -79,7 +79,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/3.7.0/python' + self.user_agent = 'OpenAPI-Generator/3.7.1/python' self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/mux_python/configuration.py b/mux_python/configuration.py index a1dce4d..a44df89 100644 --- a/mux_python/configuration.py +++ b/mux_python/configuration.py @@ -406,7 +406,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: v1\n"\ - "SDK Package Version: 3.7.0".\ + "SDK Package Version: 3.7.1".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/mux_python/models/asset.py b/mux_python/models/asset.py index ab7deae..d74f123 100644 --- a/mux_python/models/asset.py +++ b/mux_python/models/asset.py @@ -667,7 +667,7 @@ def static_renditions(self, static_renditions): def recording_times(self): """Gets the recording_times of this Asset. # noqa: E501 - 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. # noqa: E501 + 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. # noqa: E501 :return: The recording_times of this Asset. # noqa: E501 :rtype: list[AssetRecordingTimes] @@ -678,7 +678,7 @@ def recording_times(self): def recording_times(self, recording_times): """Sets the recording_times of this Asset. - 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. # noqa: E501 + 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. # noqa: E501 :param recording_times: The recording_times of this Asset. # noqa: E501 :type recording_times: list[AssetRecordingTimes] diff --git a/mux_python/models/create_live_stream_request.py b/mux_python/models/create_live_stream_request.py index dc55fa3..8dcee05 100644 --- a/mux_python/models/create_live_stream_request.py +++ b/mux_python/models/create_live_stream_request.py @@ -198,7 +198,7 @@ def reconnect_window(self, reconnect_window): def use_slate_for_standard_latency(self): """Gets the use_slate_for_standard_latency of this CreateLiveStreamRequest. # noqa: E501 - By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. # noqa: E501 + By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. # noqa: E501 :return: The use_slate_for_standard_latency of this CreateLiveStreamRequest. # noqa: E501 :rtype: bool @@ -209,7 +209,7 @@ def use_slate_for_standard_latency(self): def use_slate_for_standard_latency(self, use_slate_for_standard_latency): """Sets the use_slate_for_standard_latency of this CreateLiveStreamRequest. - By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. # noqa: E501 + By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. # noqa: E501 :param use_slate_for_standard_latency: The use_slate_for_standard_latency of this CreateLiveStreamRequest. # noqa: E501 :type use_slate_for_standard_latency: bool @@ -221,7 +221,7 @@ def use_slate_for_standard_latency(self, use_slate_for_standard_latency): def reconnect_slate_url(self): """Gets the reconnect_slate_url of this CreateLiveStreamRequest. # noqa: E501 - The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. # noqa: E501 + The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. # noqa: E501 :return: The reconnect_slate_url of this CreateLiveStreamRequest. # noqa: E501 :rtype: str @@ -232,7 +232,7 @@ def reconnect_slate_url(self): def reconnect_slate_url(self, reconnect_slate_url): """Sets the reconnect_slate_url of this CreateLiveStreamRequest. - The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. # noqa: E501 + The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. # noqa: E501 :param reconnect_slate_url: The reconnect_slate_url of this CreateLiveStreamRequest. # noqa: E501 :type reconnect_slate_url: str diff --git a/mux_python/models/live_stream.py b/mux_python/models/live_stream.py index 670071d..f104fe1 100644 --- a/mux_python/models/live_stream.py +++ b/mux_python/models/live_stream.py @@ -458,7 +458,7 @@ def reconnect_window(self, reconnect_window): def use_slate_for_standard_latency(self): """Gets the use_slate_for_standard_latency of this LiveStream. # noqa: E501 - By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. # noqa: E501 + By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. # noqa: E501 :return: The use_slate_for_standard_latency of this LiveStream. # noqa: E501 :rtype: bool @@ -469,7 +469,7 @@ def use_slate_for_standard_latency(self): def use_slate_for_standard_latency(self, use_slate_for_standard_latency): """Sets the use_slate_for_standard_latency of this LiveStream. - By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. # noqa: E501 + By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. # noqa: E501 :param use_slate_for_standard_latency: The use_slate_for_standard_latency of this LiveStream. # noqa: E501 :type use_slate_for_standard_latency: bool @@ -481,7 +481,7 @@ def use_slate_for_standard_latency(self, use_slate_for_standard_latency): def reconnect_slate_url(self): """Gets the reconnect_slate_url of this LiveStream. # noqa: E501 - The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. # noqa: E501 + The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. # noqa: E501 :return: The reconnect_slate_url of this LiveStream. # noqa: E501 :rtype: str @@ -492,7 +492,7 @@ def reconnect_slate_url(self): def reconnect_slate_url(self, reconnect_slate_url): """Sets the reconnect_slate_url of this LiveStream. - The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. # noqa: E501 + The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. # noqa: E501 :param reconnect_slate_url: The reconnect_slate_url of this LiveStream. # noqa: E501 :type reconnect_slate_url: str diff --git a/mux_python/models/track.py b/mux_python/models/track.py index 3891404..e91f29a 100644 --- a/mux_python/models/track.py +++ b/mux_python/models/track.py @@ -346,7 +346,7 @@ def text_type(self, text_type): def text_source(self): """Gets the text_source of this Track. # noqa: E501 - The source of the text contained in a Track of type `text`. Valid `text_source` values are listed below. * `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API. * `embedded`: Tracks extracted from an embedded stream of CEA-608 closed captions. * `generated_live`: Tracks generated by automatic speech recognition on a live stream configured with `generated_subtitles`. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. * `generated_live_final`: Tracks generated by automatic speech recognition on a live stream using `generated_subtitles`. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding `generated_live` tracks. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. # noqa: E501 + The source of the text contained in a Track of type `text`. Valid `text_source` values are listed below. * `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API. * `embedded`: Tracks extracted from an embedded stream of CEA-608 closed captions. * `generated_live`: Tracks generated by automatic speech recognition on a live stream configured with `generated_subtitles`. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. * `generated_live_final`: Tracks generated by automatic speech recognition on a live stream using `generated_subtitles`. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding `generated_live` tracks. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. # noqa: E501 :return: The text_source of this Track. # noqa: E501 :rtype: str @@ -357,7 +357,7 @@ def text_source(self): def text_source(self, text_source): """Sets the text_source of this Track. - The source of the text contained in a Track of type `text`. Valid `text_source` values are listed below. * `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API. * `embedded`: Tracks extracted from an embedded stream of CEA-608 closed captions. * `generated_live`: Tracks generated by automatic speech recognition on a live stream configured with `generated_subtitles`. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. * `generated_live_final`: Tracks generated by automatic speech recognition on a live stream using `generated_subtitles`. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding `generated_live` tracks. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. # noqa: E501 + The source of the text contained in a Track of type `text`. Valid `text_source` values are listed below. * `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API. * `embedded`: Tracks extracted from an embedded stream of CEA-608 closed captions. * `generated_live`: Tracks generated by automatic speech recognition on a live stream configured with `generated_subtitles`. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. * `generated_live_final`: Tracks generated by automatic speech recognition on a live stream using `generated_subtitles`. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding `generated_live` tracks. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. # noqa: E501 :param text_source: The text_source of this Track. # noqa: E501 :type text_source: str diff --git a/mux_python/models/update_live_stream_request.py b/mux_python/models/update_live_stream_request.py index 821ff80..693ccac 100644 --- a/mux_python/models/update_live_stream_request.py +++ b/mux_python/models/update_live_stream_request.py @@ -163,7 +163,7 @@ def reconnect_window(self, reconnect_window): def use_slate_for_standard_latency(self): """Gets the use_slate_for_standard_latency of this UpdateLiveStreamRequest. # noqa: E501 - By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. # noqa: E501 + By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. # noqa: E501 :return: The use_slate_for_standard_latency of this UpdateLiveStreamRequest. # noqa: E501 :rtype: bool @@ -174,7 +174,7 @@ def use_slate_for_standard_latency(self): def use_slate_for_standard_latency(self, use_slate_for_standard_latency): """Sets the use_slate_for_standard_latency of this UpdateLiveStreamRequest. - By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. # noqa: E501 + By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. # noqa: E501 :param use_slate_for_standard_latency: The use_slate_for_standard_latency of this UpdateLiveStreamRequest. # noqa: E501 :type use_slate_for_standard_latency: bool @@ -186,7 +186,7 @@ def use_slate_for_standard_latency(self, use_slate_for_standard_latency): def reconnect_slate_url(self): """Gets the reconnect_slate_url of this UpdateLiveStreamRequest. # noqa: E501 - The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the default slate media will be used. # noqa: E501 + The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the default slate media will be used. # noqa: E501 :return: The reconnect_slate_url of this UpdateLiveStreamRequest. # noqa: E501 :rtype: str @@ -197,7 +197,7 @@ def reconnect_slate_url(self): def reconnect_slate_url(self, reconnect_slate_url): """Sets the reconnect_slate_url of this UpdateLiveStreamRequest. - The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the default slate media will be used. # noqa: E501 + The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the default slate media will be used. # noqa: E501 :param reconnect_slate_url: The reconnect_slate_url of this UpdateLiveStreamRequest. # noqa: E501 :type reconnect_slate_url: str diff --git a/setup.py b/setup.py index e9351bb..16076b3 100644 --- a/setup.py +++ b/setup.py @@ -15,7 +15,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "mux_python" -VERSION = "3.7.0" +VERSION = "3.7.1" # To install the library, run the following # # python setup.py install @@ -44,4 +44,4 @@ def get_file_text(file_name): include_package_data=True, long_description=get_file_text("README.md"), long_description_content_type="text/markdown", -) + )