Wiki

Clone wiki

announce / Home

About Announce!

Announce! is a text-to-speech system that plays text messages using a synthetic voice. The voice is reproduced in the computer where Announce! is installed. Announce! uses a HTTP API for sending messages to play. It also provides a web console to quickly announce messages! :)

What can I do with Announce!?

A few ideas to get you started:

  • use it with an continuous integration system to announce build results. Jenkins Speech may help!
  • announce system events and status (startup/shutdown, services status, etc).
  • trigger it using a cron task to regularly announce events.
  • announce team schedules.
  • share the web console with your team and have fun!

Requirements

  • Java 6 or higher.
  • Internet access (to query Google Translate).

Quick-start guide

Compilation and execution

#!bash
cd server
mvn install
#!bash
cd target
java -jar announce-war-exec.jar

If you prefer, you can deploy server/target/announce.war to your own application server (Tomcat, GlassFish, etc.) instead of running from the command line.

Changing default HTTP port

java -jar announce-war-exec.jar -httpPort 80

Using behind a Proxy Server

java -Dhttp.proxyHost=yourproxy.com -Dhttp.proxyPort=4567 -jar announce-war-exec.jar

More command line options

There are more command line options.

Web console

Open with your web browser http://localhost:8080/announce

HTTP API usage

GET http://localhost:8080/announce/services/annoucements?text=hello&language=en

You can also POST to the same URL using both parameters.

Parameters

  • text: the text to announce. It can not be longer than 100 characters.
  • language: the language code of the text message (en, es, pt, etc.). Available values in class com.gtranslate.Language

Extensions

The extensions directory contains optional extensions for Announce!.

  • Announce! Cron Extension sends messages at regular intervals to announces, using a cron-like file. Very useful for reminding your scheduled meetings and more.

Updated