summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWim Taymans <wtaymans@redhat.com>2020-07-27 16:47:30 +0200
committerWim Taymans <wtaymans@redhat.com>2020-07-27 16:47:30 +0200
commit6e2d3feb077f3bc2ca8645e319f71d69808c4f21 (patch)
tree75f2e1b16ce460dd1cecae3ddf1a8e8b3b677be2 /doc
parentca5836cdf460644aadf5ef24706653f08ef46450 (diff)
doc: clarify version field in events
Diffstat (limited to 'doc')
-rw-r--r--doc/spa/design.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/spa/design.md b/doc/spa/design.md
index 173b9b49..b7d18080 100644
--- a/doc/spa/design.md
+++ b/doc/spa/design.md
@@ -256,6 +256,11 @@ be called with `my_data` as the first data field. The events are usually
also triggered when the listener is added, to enumerate the current
state of the object.
+Events have a `version` field, set to `SPA_VERSION_NODE_EVENTS` in the
+above example. It should contain the version of the event structure
+you compiled with. When new events are added later, the version field
+will be checked and the new signal will be ignored for older versions.
+
You can remove your listener with:
```c