tencentcloud-sdk-python-intl-en 3.0.1075__py2.py3-none-any.whl → 3.0.1076__py2.py3-none-any.whl

tencentcloud/tts/v20190823/models.py

@@ -48,6 +48,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def Text(self):
+        """The word in the text that is sent.
+        :rtype: str
+        """
         return self._Text
 
     @Text.setter
@@ -56,6 +59,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def BeginTime(self):
+        """The start timestamp of the word in the synthesized audio data, in milliseconds.
+        :rtype: int
+        """
         return self._BeginTime
 
     @BeginTime.setter
@@ -64,6 +70,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def EndTime(self):
+        """The end timestamp of the word in the synthesized audio data, in milliseconds.
+        :rtype: int
+        """
         return self._EndTime
 
     @EndTime.setter
@@ -72,6 +81,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def BeginIndex(self):
+        """The start index of the character in the whole sentence, starting from 0.
+        :rtype: int
+        """
         return self._BeginIndex
 
     @BeginIndex.setter
@@ -80,6 +92,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def EndIndex(self):
+        """The end index of the character in the whole sentence, starting from 0.
+        :rtype: int
+        """
         return self._EndIndex
 
     @EndIndex.setter
@@ -88,6 +103,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def Phoneme(self):
+        """The phonemes of the word.
+Note: This field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._Phoneme
 
     @Phoneme.setter
@@ -164,6 +183,10 @@ It can contain up to 150 Chinese characters (a full-width punctuation as a Chine
 
     @property
     def Text(self):
+        """The source text for synthesizing speech, which is encoded in UTF-8.
+It can contain up to 150 Chinese characters (a full-width punctuation as a Chinese character) or 500 letters ( a half-width punctuation as a letter).
+        :rtype: str
+        """
         return self._Text
 
     @Text.setter
@@ -172,6 +195,9 @@ It can contain up to 150 Chinese characters (a full-width punctuation as a Chine
 
     @property
     def SessionId(self):
+        """The `SessionId` of a request, which will be returned as-is. We recommend that you pass characters like uuid to prevent repetition.
+        :rtype: str
+        """
         return self._SessionId
 
     @SessionId.setter
@@ -180,6 +206,9 @@ It can contain up to 150 Chinese characters (a full-width punctuation as a Chine
 
     @property
     def Volume(self):
+        """Volume range: [0, 10], corresponding to 11 volume levels. 0 is the default value, indicating the normal volume. There is no mute option.
+        :rtype: float
+        """
         return self._Volume
 
     @Volume.setter
@@ -188,6 +217,9 @@ It can contain up to 150 Chinese characters (a full-width punctuation as a Chine
 
     @property
     def Speed(self):
+        """Speed range: [-2, 6], corresponding to different speeds<li>-2 for 0.6 times</li><li>-1 for 0.8 times</li><li>0 for 1.0 time (default)</li><li>1 for 1.2 times</li><li>2 for 1.5 times</li><li>6 for 2.5 times</li>To set finer-grained speed levels, keep one decimal place, such as 0.5, 1.1, and 1.8.<br>
+        :rtype: float
+        """
         return self._Speed
 
     @Speed.setter
@@ -196,6 +228,9 @@ It can contain up to 150 Chinese characters (a full-width punctuation as a Chine
 
     @property
     def ProjectId(self):
+        """Project ID, which defaults to 0 and can be customized.
+        :rtype: int
+        """
         return self._ProjectId
 
     @ProjectId.setter
@@ -204,6 +239,9 @@ It can contain up to 150 Chinese characters (a full-width punctuation as a Chine
 
     @property
     def ModelType(self):
+        """Model type, with `1` for the default model.
+        :rtype: int
+        """
         return self._ModelType
 
     @ModelType.setter
@@ -212,6 +250,13 @@ It can contain up to 150 Chinese characters (a full-width punctuation as a Chine
 
     @property
     def VoiceType(self):
+        """Standard voices <li>10510000-zhixiaoyao (Chinese)</li><li>1001-zhiyu (Chinese)</li><li>1002-zhiling (Chinese)</li><li>1003-zhimei (Chinese)</li><li>1004-zhiyun (Chinese)</li><li>1005-zhili (Chinese)</li><li>1007-zhina (Chinese)</li><li>1008-zhiqi (Chinese)</li><li>1009-zhiyun (Chinese)</li><li>1010-zhihua (Chinese)</li><li>1017-zhirong (Chinese)</li><li>1018-zhijing (Chinese)</li><li>1050-WeJack (English)</li><li>1051-WeRose (English)</li>Premium voices<br>Premium voices have higher fidelity and more natural-sounding quality than standard voices. For price details, see [Purchase Guide](https://www.tencentcloud.com/document/product/1154/47874).<br><li>100510000-zhixiaoyao (Chinese)</li><li>101001-zhiyu (Chinese)</li><li>101002-zhiling (Chinese)</li><li>101003-zhimei (Chinese)</li><li>101004-zhiyun (Chinese)</li><li>101005-zhili (Chinese)</li><li>101006-zhiyan (Chinese)</li><li>101007-zhina (Chinese)</li><li>101008-zhiqi (Chinese)</li><li>101009-zhiyun (Chinese)</li><li>101010-zhihua (Chinese)</li><li>101011-zhiyan (Chinese)</li><li>101012-zhidan (Chinese)</li><li>101013-zhihui (Chinese)</li><li>101014-zhining (Chinese)</li><li>101015-zhimeng (Chinese)</li><li>101016-zhitian (Chinese)</li><li>101017-zhirong (Chinese)</li><li>101018-zhijing (Chinese)</li><li>101019-zhitong (Cantonese)</li><li>101020-zhigang (Chinese)</li><li>101021-zhirui (Chinese)</li><li>101022-zhihong (Chinese)</li><li>101023-zhixuan (Chinese)</li><li>101024-zhihao (Chinese)</li><li>101025-zhiwei (Chinese)</li><li>101026-zhixi (Chinese)</li><li>101027-zhimei (Chinese)</li><li>101028-zhijie (Chinese)</li><li>101029-zhikai (Chinese)</li><li>101030-zhike (Chinese)</li><li>101031-zhikui (Chinese)</li><li>101032-zhifang (Chinese)</li><li>101033-zhibei (Chinese)</li><li>101034-zhilian (Chinese)</li><li>101035-zhiyi (Chinese)</li><li>101040-zhichuan (Sichuan dialect)</li><li>101050-WeJack (English)</li><li>101051-WeRose (English)</li><li>101052-zhiwei (Chinese)</li>
+<li>101053-zhifang (Chinese)</li>
+<li>101054-zhiyou (Chinese)</li>
+<li>101055-zhiyou (Chinese)</li>
+<li>101056-zhilin (Northeastern Mandarin)</li>
+        :rtype: int
+        """
         return self._VoiceType
 
     @VoiceType.setter
@@ -220,6 +265,9 @@ It can contain up to 150 Chinese characters (a full-width punctuation as a Chine
 
     @property
     def PrimaryLanguage(self):
+        """Primary language type: <li>1 - Chinese (default)</li><li>2 - English</li>
+        :rtype: int
+        """
         return self._PrimaryLanguage
 
     @PrimaryLanguage.setter
@@ -228,6 +276,9 @@ It can contain up to 150 Chinese characters (a full-width punctuation as a Chine
 
     @property
     def SampleRate(self):
+        """Audio sample rate: <li>16000: 16k (default)</li><li>8000: 8k</li>
+        :rtype: int
+        """
         return self._SampleRate
 
     @SampleRate.setter
@@ -236,6 +287,9 @@ It can contain up to 150 Chinese characters (a full-width punctuation as a Chine
 
     @property
     def Codec(self):
+        """Format of returned audio. Valid values: WAV (default), MP3, and PCM.
+        :rtype: str
+        """
         return self._Codec
 
     @Codec.setter
@@ -244,6 +298,9 @@ It can contain up to 150 Chinese characters (a full-width punctuation as a Chine
 
     @property
     def EnableSubtitle(self):
+        """Whether to enable the timestamp feature. Default value: `false`.
+        :rtype: bool
+        """
         return self._EnableSubtitle
 
     @EnableSubtitle.setter
@@ -252,6 +309,9 @@ It can contain up to 150 Chinese characters (a full-width punctuation as a Chine
 
     @property
     def SegmentRate(self):
+        """The threshold of speech segmentation sensibility, which can be `0` (default), `1`, or `2`. A larger value indicates fewer segments, and the model tends to only segment sentences based on punctuation marks. We recommend you not change this parameter to avoid adverse effect on speech synthesis.
+        :rtype: int
+        """
         return self._SegmentRate
 
     @SegmentRate.setter
@@ -305,6 +365,9 @@ class TextToVoiceResponse(AbstractModel):
 
     @property
     def Audio(self):
+        """Base64-encoded WAV/MP3 audio data
+        :rtype: str
+        """
         return self._Audio
 
     @Audio.setter
@@ -313,6 +376,9 @@ class TextToVoiceResponse(AbstractModel):
 
     @property
     def SessionId(self):
+        """The `SessionId` of a request
+        :rtype: str
+        """
         return self._SessionId
 
     @SessionId.setter
@@ -321,6 +387,9 @@ class TextToVoiceResponse(AbstractModel):
 
     @property
     def Subtitles(self):
+        """Timestamp information. If the timestamp feature is not enabled, an empty array will be returned.
+        :rtype: list of Subtitle
+        """
         return self._Subtitles
 
     @Subtitles.setter
@@ -329,6 +398,9 @@ class TextToVoiceResponse(AbstractModel):
 
     @property
     def RequestId(self):
+        """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
+        :rtype: str
+        """
         return self._RequestId
 
     @RequestId.setter