Skip to content

java

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

java

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
voice-live-quickstarts
voice-live-quickstarts
 
 
README.md
README.md
 
 

README.md

Java Voice Assistant Samples

Reference documentation | Package (Maven)

This folder contains Java samples demonstrating how to build real-time voice assistants using Azure AI Speech VoiceLive service. Each sample is self-contained for easy understanding and deployment.

Available Samples

Agents New Quickstart

Demonstrates the new Voice Live + Foundry Agent flow, including creating an agent configured for Voice Live and running a v2 agent-connected voice assistant sample.

Key Features:

  • Agent creation utility with Voice Live metadata chunking
  • New SDK-based agent session configuration
  • Proactive greeting and barge-in handling
  • Conversation logging

Model Quickstart

Demonstrates direct integration with VoiceLive models for voice conversations without agent overhead.

Key Features:

  • Direct model access
  • Flexible authentication (API key or Azure credentials)
  • Custom instructions support
  • Model selection options
  • Real-time audio capture and playback
  • Voice Activity Detection with interruption handling

Prerequisites

All samples require:

Azure Resources

Depending on which sample you want to run:

For Model Quickstart:

Getting Started

Quick Start

  1. Choose a sample: Navigate to a folder under voice-live-quickstarts (for example, ModelQuickstart or AgentsNewQuickstart)

  2. Install prerequisites: Ensure Java 11+ and Maven 3.6+ are installed

  3. Set up Azure resources: Create required Azure resources based on the sample

  4. Configure settings: Copy application.properties.sample to application.properties and update with your Azure credentials

  5. Build and run:

    cd voice-live-quickstarts/ModelQuickstart
mvn clean install
mvn exec:java

Authentication

Model Quickstart supports both authentication methods:

# With API key (from application.properties or --api-key)
mvn exec:java

# With Azure credentials
az login
mvn exec:java -Dexec.args="--use-token-credential"

Configuration

Each sample includes an application.properties.sample file that you need to copy to application.properties and configure:

Model Quickstart Configuration

# Required: Your VoiceLive endpoint URL
azure.voicelive.endpoint=https://your-endpoint.services.ai.azure.com/

# Required: Your API key (if using API key authentication)
azure.voicelive.api-key=your-api-key-here

# Optional: Model name (default: gpt-realtime)
# azure.voicelive.model=gpt-realtime

# Optional: Voice name (default: en-US-Ava:DragonHDLatestNeural)
# azure.voicelive.voice=en-US-Ava:DragonHDLatestNeural

Available Voices

VoiceLive supports multiple neural voices:

  • en-US-Ava:DragonHDLatestNeural (default)
  • en-US-Jenny:DragonHDLatestNeural
  • en-US-Guy:DragonHDLatestNeural
  • en-US-Emma:DragonHDLatestNeural
  • en-US-Andrew:DragonHDLatestNeural

See Azure Text-to-Speech voice list for all available voices.

Common Issues and Troubleshooting

Microphone Issues

Problem: Microphone not detected or no audio input

Solutions:

  • Verify microphone is connected and set as default input device
  • Check system audio settings and permissions
  • Ensure no other application is exclusively using the microphone
  • Try running with administrator/elevated privileges

Authentication Issues

Problem: 401 Unauthorized or authentication failures

Solutions:

  • Verify your API key is correct in application.properties
  • Ensure endpoint URL is properly formatted (starts with https:// and ends with /)
  • Check that your Azure subscription is active
  • For Azure credential auth, ensure you've run az login and have the correct permissions

Audio Quality Issues

Problem: Poor audio quality, echoes, or background noise

Solutions:

  • Use a quality microphone with noise cancellation
  • Enable audio processing features in the configuration
  • Check for proper microphone positioning and environment
  • Ensure sample rate is 24kHz as required by VoiceLive

Connection Issues

Problem: Cannot connect to VoiceLive service

Solutions:

  • Verify network connectivity
  • Check firewall and proxy settings
  • Ensure the endpoint URL is accessible from your network
  • Verify your Azure resource is in a supported region

Maven Build Issues

Problem: Build failures or dependency resolution errors

Solutions:

  • Ensure you're using Java 11 or later: java -version
  • Ensure Maven 3.6+ is installed: mvn -version
  • Clear Maven cache: mvn clean or delete ~/.m2/repository
  • Check internet connectivity for dependency downloads

Additional Samples

Java quickstart content also includes:

  • Agents New Quickstart: voice-live-quickstarts/AgentsNewQuickstart
  • Model Quickstart: voice-live-quickstarts/ModelQuickstart

Additional Resources

Other Language Samples

Explore samples in other languages:

Contributing

Interested in contributing Java samples? Please see our Contributing Guidelines.

Support

For issues, questions, or contributions, please see our Support Guide.