summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2024-01-21 09:19:43 +0100
committerxengineering <me@xengineering.eu>2024-01-21 09:19:43 +0100
commit38d6997e5f6bd725b28c8cc6ed28cda670a2e900 (patch)
tree837dcbcc72c4912cb3bcc36222115e9123fba5de
parent090e063a539f6ee6e62e65ada619787930c31eac (diff)
downloadsoundbox-38d6997e5f6bd725b28c8cc6ed28cda670a2e900.tar
soundbox-38d6997e5f6bd725b28c8cc6ed28cda670a2e900.tar.zst
soundbox-38d6997e5f6bd725b28c8cc6ed28cda670a2e900.zip
doc: Rework user guide for streaming
The default streaming guide is now far away from the original taken from the FFmpeg streaming guide. Since the command can handle a lot of inputs its also not useful to send sine waves to soundbox devices.
-rw-r--r--doc/documentation.tex31
1 files changed, 6 insertions, 25 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 65d0dc8..fe58ba6 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -71,35 +71,16 @@ seconds a new discovery packet is emitted by soundbox. Thus it can take up to
\section{Playing audio} \label{playing-audio}
-For a simple audio streaming test the following commands from the FFmpeg
-streaming
-guide\footnote{\href{https://trac.ffmpeg.org/wiki/StreamingGuide\#StreamingasimpleRTPaudiostreamfromFFmpeg}{https://trac.ffmpeg.org/wiki/StreamingGuide\#StreamingasimpleRTPaudiostreamfromFFmpeg}}
-can be used. The following command has to be executed on the soundbox to start
-listening on port \texttt{5316} of a local multicast IPv4 address for incoming
-audio streams. Since multicast is used, this can be executed on multiple
-soundbox devices to stream to all of them.
+Audio can be streamed to \texttt{soundbox} devices with the \texttt{ffmpeg}
+command. Audio files or internet stream addresses can be passed as input.
\begin{verbatim}
- ffplay udp://224.0.0.99:5316
+ffmpeg -re -i <input> -acodec libmp3lame -f matroska \
+ udp://224.0.0.99:5316
\end{verbatim}
-As soon as the soundbox is listening the stream can be send from another
-computer in the same network with this command:
-
-\begin{verbatim}
- ffmpeg -re -f lavfi -i aevalsrc="sin(400*2*PI*t)" \
- -acodec libmp3lame -f matroska udp://224.0.0.99:5316
-\end{verbatim}
-
-It will send a simple sine wave with 400~Hz to the soundbox device.
-Alternatively a MP3 file can be sent like this:
-
-\begin{verbatim}
- ffmpeg -re -i <file-path> \
- -acodec libmp3lame -f matroska udp://224.0.0.99:5316
-\end{verbatim}
-
-These commands allow to test the \texttt{soundbox} device setup.
+More details about FFmpeg streaming can be read from the FFmpeg streaming
+guide\footnote{\href{https://trac.ffmpeg.org/wiki/StreamingGuide}{https://trac.ffmpeg.org/wiki/StreamingGuide}}.
\chapter{Production}