gstreamer platform allows you to play audio via a gstreamer pipeline. Practically, this means you can play audio directly on the computer running Home Assistant. It is particularly suited for playing TTS. Advanced users can specify a pipeline to transform the audio stream and/or redirect it elsewhere.
To add a
gstreamer media player to your installation, add the following to your
# Example configuration.yaml entry media_player: - platform: gstreamer
- name (Optional): Name the player.
- pipeline (Optional):
music media type is supported.
And then install the following system dependencies:
sudo apt-get install python3-gst-1.0 \ gir1.2-gstreamer-1.0 gir1.2-gst-plugins-base-1.0 \ gstreamer1.0-plugins-good gstreamer1.0-plugins-ugly \ gstreamer1.0-tools
sudo yum install -y python-gstreamer1 gstreamer1-plugins-good \ gstreamer1-plugins-ugly
For Fedora replace
If you’re running Home Assistant in a virtual environment, you’ll need to symlink the system Python’s
gi module into your virtual environment:
ln -s /path/to/your/installation/of/gi /path/to/your/venv/lib/python3.4/site-packages
On a Raspberry PI, you may need to add the Home Assistant user to the
sudo usermod -a -G audio <ha_user>
To play TTS on your local computer (for example, if you have speakers attached to your Raspberry PI:
media_player: - platform: gstreamer script: tts: sequence: - service: tts.google_say # or amazon_polly, voicerss, etc data: entity_id: media_player.gstreamer message: "example text-to-speech message"
To play to a named pipe for consumption by Snapcast:
media_player: - platform: gstreamer pipeline: "audioresample ! audioconvert ! audio/x-raw,rate=48000,channels=2,format=S16LE ! wavenc ! filesink location=/tmp/snapcast_gstreamer"