SpeakOptions constructor

SpeakOptions({
  1. String? voiceName,
  2. String? lang,
  3. VoiceGender? gender,
  4. double? rate,
  5. double? pitch,
  6. double? volume,
})

Implementation

SpeakOptions({
  /// The name of the voice to use for synthesis.
  String? voiceName,

  /// The language to be used for synthesis, in the form _language_-_region_.
  /// Examples: 'en', 'en-US', 'en-GB', 'zh-CN'.
  String? lang,

  /// Gender of voice for synthesized speech.
  VoiceGender? gender,

  /// Speaking rate relative to the default rate for this voice. 1.0 is the
  /// default rate, normally around 180 to 220 words per minute. 2.0 is twice
  /// as fast, and 0.5 is half as fast. This value is guaranteed to be between
  /// 0.1 and 10.0, inclusive. When a voice does not support this full range
  /// of rates, don't return an error. Instead, clip the rate to the range the
  /// voice supports.
  double? rate,

  /// Speaking pitch between 0 and 2 inclusive, with 0 being lowest and 2
  /// being highest. 1.0 corresponds to this voice's default pitch.
  double? pitch,

  /// Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1
  /// being highest, with a default of 1.0.
  double? volume,
}) : _wrapped = $js.SpeakOptions(
        voiceName: voiceName,
        lang: lang,
        gender: gender?.toJS,
        rate: rate,
        pitch: pitch,
        volume: volume,
      );