body method

  1. @override
String body(
  1. String baseName,
  2. String className
)
override

Defines the actual body code. path is passed relative to lib, baseName is the filename, and className is the filename converted to Pascal case.

実際の本体コードを定義します。pathlibからの相対パス、baseNameにファイル名が渡され、classNameにファイル名をパスカルケースに変換した値が渡されます。

Implementation

@override
String body(String baseName, String className) {
  return """
`Text-To-Speech`は下記のように利用する。

## 概要

$excerpt

## 設定方法

1. `katana.yaml`に下記の設定を追加。

  ```yaml
  # katana.yaml

  # Describe the settings for using speech synthesis.
  # 音声合成による発話を利用するための設定を記述します。
  text_to_speech:
    enable: true # Text-To-Speechを利用する場合false -> trueに変更
  ```

2. 下記のコマンドを実行して設定を適用。

  ```bash
  katana apply
  ```

3. `lib/adapter.dart`の`masamuneAdapters`に`MasamuneAdapter`を追加。

  ```dart
  // lib/adapter.dart

  /// Masamune adapter.
  ///
  /// The Masamune framework plugin functions can be defined together.
  // TODO: Add the adapters.
  final masamuneAdapters = <MasamuneAdapter>[
      const UniversalMasamuneAdapter(),

      // Text-To-Speechのアダプターを追加。
      const TextToSpeechMasamuneAdapter(),
  ];
  ```

## 利用方法

```dart
// Text-To-Speechのコントローラーを取得。
final tts = ref.app.controller(TextToSpeech.query());

// 音声を再生。
await tts.speak(
// 発話するテキスト。
text: "こんにちは。",
// 言語。
language: "ja-JP",
// 音量(0.0 - 1.0)。
volume: 1.0,
// 速度(0.0 - 2.0)。
rate: 1.0,
// ピッチ(0.0 - 2.0)。
pitch: 1.0,
);

// 音声を一時停止。
await tts.pause();

// 音声を再開。
await tts.resume();

// 音声を停止。
await tts.stop();
```
""";
}