[release] 2.3.1

eropple · eropple · commit 08a4ab2b9f77 · 2021-10-15T14:19:19.000-04:00
diff --git a/docs/CreateLiveStreamRequest.md b/docs/CreateLiveStreamRequest.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **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. | [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 subtitle 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] 
 **reduced_latency** | **bool** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. Note: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] 
 **low_latency** | **bool** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional] 
 **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] 
diff --git a/docs/LiveStreamEmbeddedSubtitleSettings.md b/docs/LiveStreamEmbeddedSubtitleSettings.md
@@ -3,9 +3,9 @@
 ## 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] 
-**language_code** | **str** | The language of the subtitle stream. Value must be BCP 47 compliant. | [optional] [default to 'en']
+**name** | **str** | A name for this live stream closed caption track. | [optional] 
+**passthrough** | **str** | Arbitrary 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']
 
 [[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/LiveStreamsApi.md b/docs/LiveStreamsApi.md
@@ -1049,7 +1049,7 @@ Name | Type | Description  | Notes
 
 Update a live stream's embedded subtitles
 
-Configures a live stream to receive embedded subtitles including captions and translations.
+Configures a live stream to receive embedded closed captions. The resulting Asset's subtitle text track will have `closed_captions: true` set. 
 
 ### Example
 
diff --git 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 subtitle 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/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": "2.3.0"
+  "packageVersion": "2.3.1"
 }
diff --git a/mux_python/__init__.py b/mux_python/__init__.py
@@ -15,7 +15,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "2.3.0"
+__version__ = "2.3.1"
 
 # import apis into sdk package
 from mux_python.api.assets_api import AssetsApi
diff --git a/mux_python/api/live_streams_api.py b/mux_python/api/live_streams_api.py
@@ -1988,7 +1988,7 @@ def signal_live_stream_complete_with_http_info(self, live_stream_id, **kwargs):
     def update_live_stream_embedded_subtitles(self, live_stream_id, update_live_stream_embedded_subtitles_request, **kwargs):  # noqa: E501
         """Update a live stream's embedded subtitles  # noqa: E501
 
-        Configures a live stream to receive embedded subtitles including captions and translations.  # noqa: E501
+        Configures a live stream to receive embedded closed captions. The resulting Asset's subtitle text track will have `closed_captions: true` set.   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -2020,7 +2020,7 @@ def update_live_stream_embedded_subtitles(self, live_stream_id, update_live_stre
     def update_live_stream_embedded_subtitles_with_http_info(self, live_stream_id, update_live_stream_embedded_subtitles_request, **kwargs):  # noqa: E501
         """Update a live stream's embedded subtitles  # noqa: E501
 
-        Configures a live stream to receive embedded subtitles including captions and translations.  # noqa: E501
+        Configures a live stream to receive embedded closed captions. The resulting Asset's subtitle text track will have `closed_captions: true` set.   # 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
@@ -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/2.3.0/python'
+        self.user_agent = 'OpenAPI-Generator/2.3.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
@@ -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: 2.3.0".\
+               "SDK Package Version: 2.3.1".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):
diff --git a/mux_python/models/create_live_stream_request.py b/mux_python/models/create_live_stream_request.py
@@ -217,7 +217,7 @@ def audio_only(self, audio_only):
     def embedded_subtitles(self):
         """Gets the embedded_subtitles of this CreateLiveStreamRequest.  # noqa: E501
 
-        Describe the subtitle contents of the incoming live stream.  # noqa: E501
+        Describe the embedded closed caption contents of the incoming live stream.  # noqa: E501
 
         :return: The embedded_subtitles of this CreateLiveStreamRequest.  # noqa: E501
         :rtype: list[LiveStreamEmbeddedSubtitleSettings]
@@ -228,7 +228,7 @@ def embedded_subtitles(self):
     def embedded_subtitles(self, embedded_subtitles):
         """Sets the embedded_subtitles of this CreateLiveStreamRequest.
 
-        Describe the subtitle contents of the incoming live stream.  # noqa: E501
+        Describe the embedded closed caption contents of the incoming live stream.  # noqa: E501
 
         :param embedded_subtitles: The embedded_subtitles of this CreateLiveStreamRequest.  # noqa: E501
         :type embedded_subtitles: list[LiveStreamEmbeddedSubtitleSettings]
diff --git a/mux_python/models/live_stream_embedded_subtitle_settings.py b/mux_python/models/live_stream_embedded_subtitle_settings.py
@@ -72,7 +72,7 @@ def __init__(self, name=None, passthrough=None, language_code='en', language_cha
     def name(self):
         """Gets the name of this LiveStreamEmbeddedSubtitleSettings.  # noqa: E501
 
-        A name for this live stream subtitle track.  # noqa: E501
+        A name for this live stream closed caption track.  # noqa: E501
 
         :return: The name of this LiveStreamEmbeddedSubtitleSettings.  # noqa: E501
         :rtype: str
@@ -83,7 +83,7 @@ def name(self):
     def name(self, name):
         """Sets the name of this LiveStreamEmbeddedSubtitleSettings.
 
-        A name for this live stream subtitle track.  # noqa: E501
+        A name for this live stream closed caption track.  # noqa: E501
 
         :param name: The name of this LiveStreamEmbeddedSubtitleSettings.  # noqa: E501
         :type name: str
@@ -95,7 +95,7 @@ def name(self, name):
     def passthrough(self):
         """Gets the passthrough of this LiveStreamEmbeddedSubtitleSettings.  # noqa: E501
 
-        Arbitrary metadata set for the live stream subtitle track. Max 255 characters.  # noqa: E501
+        Arbitrary metadata set for the live stream closed caption track. Max 255 characters.  # noqa: E501
 
         :return: The passthrough of this LiveStreamEmbeddedSubtitleSettings.  # noqa: E501
         :rtype: str
@@ -106,7 +106,7 @@ def passthrough(self):
     def passthrough(self, passthrough):
         """Sets the passthrough of this LiveStreamEmbeddedSubtitleSettings.
 
-        Arbitrary metadata set for the live stream subtitle track. Max 255 characters.  # noqa: E501
+        Arbitrary metadata set for the live stream closed caption track. Max 255 characters.  # noqa: E501
 
         :param passthrough: The passthrough of this LiveStreamEmbeddedSubtitleSettings.  # noqa: E501
         :type passthrough: str
@@ -118,7 +118,7 @@ def passthrough(self, passthrough):
     def language_code(self):
         """Gets the language_code of this LiveStreamEmbeddedSubtitleSettings.  # noqa: E501
 
-        The language of the subtitle stream. Value must be BCP 47 compliant.  # noqa: E501
+        The language of the closed caption stream. Value must be BCP 47 compliant.  # noqa: E501
 
         :return: The language_code of this LiveStreamEmbeddedSubtitleSettings.  # noqa: E501
         :rtype: str
@@ -129,7 +129,7 @@ def language_code(self):
     def language_code(self, language_code):
         """Sets the language_code of this LiveStreamEmbeddedSubtitleSettings.
 
-        The language of the subtitle stream. Value must be BCP 47 compliant.  # noqa: E501
+        The language of the closed caption stream. Value must be BCP 47 compliant.  # noqa: E501
 
         :param language_code: The language_code of this LiveStreamEmbeddedSubtitleSettings.  # noqa: E501
         :type language_code: str
diff --git a/mux_python/models/update_live_stream_embedded_subtitles_request.py b/mux_python/models/update_live_stream_embedded_subtitles_request.py
@@ -57,7 +57,7 @@ def __init__(self, embedded_subtitles=None, local_vars_configuration=None):  # n
     def embedded_subtitles(self):
         """Gets the embedded_subtitles of this UpdateLiveStreamEmbeddedSubtitlesRequest.  # noqa: E501
 
-        Describe the embedded subtitle contents of the incoming live stream.  # noqa: E501
+        Describe the embedded closed caption contents of the incoming live stream.  # noqa: E501
 
         :return: The embedded_subtitles of this UpdateLiveStreamEmbeddedSubtitlesRequest.  # noqa: E501
         :rtype: list[LiveStreamEmbeddedSubtitleSettings]
@@ -68,7 +68,7 @@ def embedded_subtitles(self):
     def embedded_subtitles(self, embedded_subtitles):
         """Sets the embedded_subtitles of this UpdateLiveStreamEmbeddedSubtitlesRequest.
 
-        Describe the embedded subtitle contents of the incoming live stream.  # noqa: E501
+        Describe the embedded closed caption contents of the incoming live stream.  # noqa: E501
 
         :param embedded_subtitles: The embedded_subtitles of this UpdateLiveStreamEmbeddedSubtitlesRequest.  # noqa: E501
         :type embedded_subtitles: list[LiveStreamEmbeddedSubtitleSettings]
diff --git a/setup.py b/setup.py
@@ -14,7 +14,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "mux_python"
-VERSION = "2.3.0"
+VERSION = "2.3.1"
 # To install the library, run the following
 #
 # python setup.py install

Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`	`"!!source": "https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/python.md",`
`3`	`3`	`"packageName": "mux_python",`
`4`	`4`	`"projectName": "mux_python",`
`5`		`- "packageVersion": "2.3.0"`
	`5`	`+ "packageVersion": "2.3.1"`
`6`	`6`	`}`