docs(readme): check loop and context errors in the video example

commit: adcd7e54016728e72a3127d3fbfab0bb62f055b0
author: brice · 7d ago · 2026-10-15 02:40 UTC
parent: d7dc935
signature: GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email

1 file · +11 -4

M README.md +11 -4


@@ -115,9 +115,15 @@ if err != nil {
115	115		}
116	116		defer rt.Deinit()
117	117
118		-	loop, _ := rt.NewLoop()
	118	+	loop, err := rt.NewLoop()
	119	+	if err != nil {
	120	+	return err
	121	+	}
119	122		defer loop.Destroy()
120		-	ctx, _ := rt.NewContext(loop)
	123	+	ctx, err := rt.NewContext(loop)
	124	+	if err != nil {
	125	+	return err
	126	+	}
121	127		defer ctx.Destroy()
122	128		core, err := ctx.Connect()
123	129		if err != nil {

@@ -151,8 +157,9 @@ if b := src.Dequeue(); b != nil { // nil: no buffer is free, skip the frame
151	157
152	158		Buffers that PipeWire removes while you still hold them (renegotiation,
153	159		`Resize`, `Destroy`, the consumer leaving) stay mapped until you hand them back
154		-	with `Queue` or `Release`. `Resize` and `Destroy` are best called when no buffer
155		-	is borrowed. A consumer that is not a plain `pipewiresrc` may need to declare
	160	+	with `Queue` or `Release`. `Resize` fails with `ErrVideoBorrowed` while a buffer
	161	+	is borrowed, and `Destroy` is best called when none is. Formats are BGRx and
	162	+	BGRA. A consumer that is not a plain `pipewiresrc` may need to declare
156	163		`media.type=Video` (for example `pipewiresrc stream-properties=props,media.type=Video`)
157	164		for WirePlumber to link it.
158	165

 }
 defer rt.Deinit()
-loop, _ := rt.NewLoop()
+loop, err := rt.NewLoop()
+if err != nil {
+	return err
+}
 defer loop.Destroy()
-ctx, _ := rt.NewContext(loop)
+ctx, err := rt.NewContext(loop)
+if err != nil {
+	return err
+}
 defer ctx.Destroy()
 core, err := ctx.Connect()
 if err != nil {
 Buffers that PipeWire removes while you still hold them (renegotiation,
 `Resize`, `Destroy`, the consumer leaving) stay mapped until you hand them back
-with `Queue` or `Release`. `Resize` and `Destroy` are best called when no buffer
+with `Queue` or `Release`. `Resize` fails with `ErrVideoBorrowed` while a buffer
-is borrowed. A consumer that is not a plain `pipewiresrc` may need to declare
+is borrowed, and `Destroy` is best called when none is. Formats are BGRx and
+BGRA. A consumer that is not a plain `pipewiresrc` may need to declare
 `media.type=Video` (for example `pipewiresrc stream-properties=props,media.type=Video`)
 for WirePlumber to link it.