summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxegineering <me@xegineering.eu>2024-10-06 17:58:34 +0200
committerxegineering <me@xegineering.eu>2024-10-06 17:58:34 +0200
commit735a7863845da130e6c727136aac75c2e7bf23da (patch)
tree9efd853f6a6637c607a57670ef24d5000d5b6cc1
parentb8fed490c275487f14bff4f5b49a6072d27e5b5f (diff)
downloadsoundbox-go-735a7863845da130e6c727136aac75c2e7bf23da.tar
soundbox-go-735a7863845da130e6c727136aac75c2e7bf23da.tar.zst
soundbox-go-735a7863845da130e6c727136aac75c2e7bf23da.zip
Add missing doc string to public function
-rw-r--r--stream.go3
1 files changed, 3 insertions, 0 deletions
diff --git a/stream.go b/stream.go
index ac0a189..cc8fcea 100644
--- a/stream.go
+++ b/stream.go
@@ -11,6 +11,9 @@ import (
// incoming audio stream data.
const streamingPort = 5316
+// StreamURLContext streams audio from a given URL to one or multiple soundbox
+// devices. The devices are referenced via their MAC addresses given by the
+// targets argument. The ctx argument is passed to cancel the streaming.
func StreamURLContext(ctx context.Context, url string, targets []net.HardwareAddr) error {
iface, err := getInterface()
if err != nil {