Skip to main content

A Python wrapper for A.I.VOICE Editor API

Project description

A.I.VOICE Python Library

A Python wrapper for A.I.VOICE Editor API that makes it easy to control A.I.VOICE Editor from Python.

Features

Easy to use: Simple Python interface for A.I.VOICE Editor API
🎵 Voice synthesis: Generate speech from text using A.I.VOICE voices
🔧 Full control: Access to all A.I.VOICE Editor functions
🛡️ Type safety: Full type hints for better development experience

Requirements

  • Windows OS
  • A.I.VOICE Editor (v1.3.0 or later)
  • Python 3.8+
  • pythonnet

Installation

pip install aivoice-python

Quick Start

import time
from aivoice_python import AIVoiceTTsControl, HostStatus

# Create A.I.VOICE controller (using default installation path)
tts_control = AIVoiceTTsControl()

# Or specify custom installation path:
# tts_control = AIVoiceTTsControl(editor_dir="C:\\MyPath\\AIVoice\\AIVoiceEditor\\")

# Initialize API
host_name = tts_control.get_available_host_names()[0]
tts_control.initialize(host_name)

# Start A.I.VOICE Editor if not running
if tts_control.status == HostStatus.NotRunning:
    tts_control.start_host()

# Connect to A.I.VOICE Editor
tts_control.connect()

# Set text and play
tts_control.text = "Hello, A.I.VOICE!"
play_time = tts_control.get_play_time()
tts_control.play()

# Wait for playback to complete
time.sleep((play_time + 500) / 1000)

# Disconnect
tts_control.disconnect()

API Reference

AIVoiceTTsControl

Main class for controlling A.I.VOICE Editor.

Constructor

  • AIVoiceTTsControl(editor_dir: str = None) - Create controller instance
    • editor_dir: Custom A.I.VOICE Editor installation path (optional)

Properties

  • text: str - Text to synthesize
  • current_voice_preset_name: str - Current voice preset name
  • voice_names: List[str] - Available voice names
  • voice_preset_names: List[str] - Available voice preset names
  • status: HostStatus - Current host status
  • version: str - Host version

Methods

  • initialize(service_name: str) - Initialize API
  • connect() - Connect to A.I.VOICE Editor
  • disconnect() - Disconnect from A.I.VOICE Editor
  • start_host() - Start A.I.VOICE Editor
  • play() - Start/pause playback
  • stop() - Stop playback
  • get_play_time() -> int - Get playback duration in milliseconds
  • save_audio_to_file(path: str) - Save audio to file

Enums

HostStatus

  • NotRunning - A.I.VOICE Editor is not running
  • NotConnected - Not connected to A.I.VOICE Editor
  • Idle - Connected and idle
  • Busy - Connected and busy

TextEditMode

  • Text - Text mode
  • List - List mode

Examples

Custom Installation Path

If A.I.VOICE Editor is installed in a non-standard location:

from aivoice_python import AIVoiceTTsControl

# Specify custom installation path
tts_control = AIVoiceTTsControl(editor_dir="D:\\MyApps\\AIVoice\\AIVoiceEditor\\")
# ... rest of the code ...

Save Audio to File

from aivoice_python import AIVoiceTTsControl

tts_control = AIVoiceTTsControl()
# ... initialization code ...

tts_control.text = "Hello, World!"
tts_control.save_audio_to_file("output.wav")

Use Different Voice

from aivoice_python import AIVoiceTTsControl

tts_control = AIVoiceTTsControl()
# ... initialization code ...

# Get available voices
voices = tts_control.voice_names
print(f"Available voices: {voices}")

# Set voice
if voices:
    tts_control.current_voice_preset_name = voices[1]  # Use second voice

Error Handling

from aivoice_python import AIVoiceTTsControl

try:
    tts_control = AIVoiceTTsControl()
except FileNotFoundError as e:
    print(f"A.I.VOICE Editor not found: {e}")
    # Try with custom path
    try:
        tts_control = AIVoiceTTsControl(editor_dir="C:\\MyPath\\AIVoice\\AIVoiceEditor\\")
    except FileNotFoundError:
        print("Please install A.I.VOICE Editor v1.3.0 or later.")

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

If you encounter any issues, please create an issue on the GitHub repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aivoice_python-0.1.6.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aivoice_python-0.1.6-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file aivoice_python-0.1.6.tar.gz.

File metadata

  • Download URL: aivoice_python-0.1.6.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.3 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for aivoice_python-0.1.6.tar.gz
Algorithm Hash digest
SHA256 27a17ddf091fd342fe4d60a3b3923db45aa95b37dc38485af54e4397debf77e0
MD5 9147e12a516e99d0b2dd3f69569e87bb
BLAKE2b-256 fdd115d871b2159a2e648220802fbceecbfe6df0341c8b2fb602b09d099fe47c

See more details on using hashes here.

File details

Details for the file aivoice_python-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: aivoice_python-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.3 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for aivoice_python-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 7fa6689d52048d526bcc656fc7982420720f0400545d2ec0cb9565b0c2ec4943
MD5 a26429ba73f398e81e7132208046b7c3
BLAKE2b-256 2e300ef1317b7d9effbd32cd6228953d24a818db705e9c91eb26b098147eb539

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page