From b7b626c81d355df2080eb03804ef7777d7f77c62 Mon Sep 17 00:00:00 2001 From: Andrea Bondavalli Date: Sat, 17 Aug 2024 14:15:02 +0200 Subject: [PATCH] Updated README.md --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 52 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9b9218e..33a74ee 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,61 @@ -# AES67 Player for Android +# AES67 Player -The AES67 Player is an Android application used to play AES67 streams. +The AES67 Player application is an Android application that can be used to play to your AES67 streams. -The application is licensed under [GNU GPL](https://www.gnu.org/licenses/gpl-3.0.en.html). +# Introduction -The application can be built and installed on your device by using Android Studio. -You can also download the last released APK from: +Play your AES67 audio streams directly on your Android devices for testing, previewing or just for fun by using the AES67 Player and the AES67 Linux Daemon. -The application requires the AES67 Linux Daemon to work and playout streams. +The AES67 Linux Daemon is an open source Linux application and you can find it at: [AES67 Linux Daemon](https://github.com/bondagit/aes67-linux-daemon) -The AES67 Linux Daemon is an open source Linux application and you can find it at: https://github.com/bondagit/aes67-linux-daemon +Starting from version 2.0 the daemon is now able to capture and compress, using the AAC codec, AES67 sinks and serve them via HTTP Live Streaming supporting scalable audio distribution. -# How to setup the Daemon and use the AES67 Player +The Player is able to playback the live streams up to 6 channels each. -1. Install and configure the AES67 Linux daemon on a Linux host and attach it to your AES67 LAN. -2. Using the AES67 Linux daemon WebUI, in the Config tab, enable the Streamer feature. -3. Attach one or more AES67 Sources to your LAN. +The diagram below shows the various components and how they interact: +![Screenshot 2024-06-15 at 15 36 48](https://github.com/user-attachments/assets/8e2a8c58-c811-48c7-8954-4596331d862f) + +# License + +AES67 player is licensed under [GNU GPL](https://www.gnu.org/licenses/gpl-3.0.en.html). + +# How to build and install the app + +You can use Android Studio to build and install the application on your device. + +You can also download and install a prebuilt APK for the lastest release from: +https://github.com/bondagit/aes67-player-android/releases/latest/download/app-release.apk + + +# Setup instruction + +To use the Player follow these instructions: + +1. Install and configure the AES67 Linux daemon v2.0 or above on a Linux host and attach it to your AES67 LAN, see [How to build and setup the daemon](https://github.com/bondagit/aes67-linux-daemon?tab=readme-ov-file#how-to-build-and-setup-the-daemon). +2. Using the AES67 Linux daemon WebUI, in the Config tab, check the daemon version and enable the Streamer feature. + See picture below: + + Daemon config. + +3. Attach one or more AES67 or Dante Sources to your LAN. See [Compatible Device](https://github.com/bondagit/aes67-linux-daemon/blob/master/DEVICES.md) 4. Using the AES67 Linux daemon WebUI, in the Sinks tab, create one of more Sinks specifying the AES67 Sources discovered by the daemon. + See picture below: + + Daemon Sinks list. + 5. Open the AES67 Player application and enter the URL of the AES67 Linux daemon WebUI. -6. When the daemon appears in the daemon's list click on the go icon on the right side to connect to it. -7. On the Sinks page start or stop a Sink playback by using the play icon on the right. -8. Expand a Sink info by clicking on the expand icon on the left. + + Screenshot 2024-07-12 at 10 46 46 + +7. When the daemon appears in the daemon's list click on the go icon on the right side to connect to it. See picture below: + + Player Daemons list + +8. On the Sinks page start or stop a Sink playback by using the play icon on the right. See picture below: + + Player Sinks list + +9. Expand a Sink info by clicking on the expand icon on the left. See picture below: + + Player Sink expanded +