Add examples to overview on generated API doc

This makes it easier for readers to find them.

1 files changed, 35 insertions, 0 deletions

diff --git a/soundbox/example_pipewire_test.go b/soundbox/example_pipewire_test.go
new file mode 100644
index 0000000..53864f3
--- /dev/null
+++ b/soundbox/example_pipewire_test.go
@@ -0,0 +1,35 @@
+package soundbox_test
+
+import (
+	"context"
+	"log"
+	"net"
+	"time"
+
+	"xengineering.eu/soundbox-go/soundbox"
+)
+
+func Example_pipewire() {
+	ctx, cancel := context.WithCancel(context.Background())
+
+	// all soundboxes are referenced by their MAC address
+	soundboxes := []net.HardwareAddr{
+		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x01},
+		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x02},
+		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x03},
+	}
+
+	// start streaming
+	go func() {
+		err := soundbox.StreamPipewireContext(ctx, soundboxes)
+		if err != nil {
+			log.Fatal(err)
+		}
+	}()
+
+	// let it play for some time
+	time.Sleep(time.Minute)
+
+	// stop it
+	cancel()
+}