@suzumiyaaoba/voicevox-client

VOICEVOX ENGINE OSS向けのTypeScriptクライアントライブラリです。openapi-fetch と openapi-typescript によりOpenAPIスキーマから型安全なクライアントを提供します。

インストール

npm install @suzumiyaaoba/voicevox-client

使用方法

基本的な使用例

import client from '@suzumiyaaoba/voicevox-client';

// スピーカー一覧を取得
const speakersRes = await client.GET('/speakers');
console.log(speakersRes.data);

// 音声合成用のクエリを作成
const aqRes = await client.POST('/audio_query', {
  params: { query: { text: 'こんにちは', speaker: 3 } },
});

// 音声を合成（WAVをBlobで取得）
const synthRes = await client.POST('/synthesis', {
  params: { query: { speaker: 3 } },
  body: aqRes.data!,
  parseAs: 'blob',
});

const audioBlob = synthRes.data; // Blob

その他のAPI

import client from '@suzumiyaaoba/voicevox-client';

// エンジンのバージョンを取得
const versionRes = await client.GET('/version');
console.log(versionRes.data);

// 対応デバイス情報を取得
const devicesRes = await client.GET('/supported_devices');
console.log(devicesRes.data);

// ユーザー辞書の単語を取得
const dictRes = await client.GET('/user_dict');
console.log(dictRes.data);

// ユーザー辞書に単語を追加
const addRes = await client.POST('/user_dict_word', {
  params: {
    query: {
      surface: 'VOICEVOX',
      pronunciation: 'ボイスボックス',
      accent_type: 1,
    },
  },
});
console.log(addRes.data);

API仕様

このライブラリは以下のVOICEVOX ENGINE APIエンドポイントをサポートしています：

• 音声合成関連（synthesis, audioQuery, etc.）
• スピーカー情報（speakers, speakerInfo）
• 歌唱音声合成（singFrameAudioQuery, frameSynthesis）
• ユーザー辞書（user_dict関連）
• プリセット管理（presets関連）
• その他（version, coreVersions, etc.）

詳細なAPI仕様については、VOICEVOX ENGINEのドキュメントを参照してください。

開発

依存関係のインストール

npm install

テストの実行

# 通常のテスト実行
npm run test

# ワンタイムテスト実行
npm run test:run

# カバレッジ付きテスト
npm run test:coverage

# UI付きテスト
npm run test:ui

ビルド

# ESMビルド
npm run build

# ESM + CJS デュアルビルド
npm run build:dual

コードフォーマット

# チェックのみ
npm run check

# 自動修正
npm run fix

スキーマの更新

# ローカルのVOICEVOXサーバーからスキーマを更新
npm run update-schema

ライセンス

MIT

貢献

プルリクエストや Issue の報告は歓迎です。

関連プロジェクト

• VOICEVOX
• VOICEVOX ENGINE
• openapi-fetch（https://github.com/drwpow/openapi-fetch）
• openapi-typescript（https://github.com/drwpow/openapi-typescript）