Skip to content

Commit 1de44c8

Browse files
doc clarity
1 parent 22991ec commit 1de44c8

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -263,9 +263,9 @@ The following features are deprecated and will be removed in the next major rele
263263
- `Room::setOnAudioFrameCallback`, `Room::setOnVideoFrameCallback`, and
264264
`Room::setOnVideoFrameEventCallback` are deprecated. Use the `[[nodiscard]]`
265265
variants `trySetOnAudioFrameCallback`, `trySetOnVideoFrameCallback`, and
266-
`trySetOnVideoFrameEventCallback` instead, which return `false` when a
267-
callback is already registered rather than silently replacing it. To replace
268-
an active callback, call `clearOn*FrameCallback` first. (The same rename
266+
`trySetOnVideoFrameEventCallback` instead, which return `false` when a reader
267+
is already active for the key (instead of silently replacing a running callback).
268+
To replace an active callback, call `clearOn*FrameCallback` first. (The same rename
269269
applies to the corresponding `SubscriptionThreadDispatcher` methods.)
270270

271271
### `v1.0.0`

include/livekit/subscription_thread_dispatcher.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -384,8 +384,9 @@ class LIVEKIT_API SubscriptionThreadDispatcher {
384384

385385
/// Select the appropriate reader startup path for @p media track.
386386
///
387-
/// This is called by @ref Room when a remote track is subscribed. If a reader is already active for the given key,
388-
/// std::thread default constructed is returned.
387+
/// This is called by @ref Room when a remote track is subscribed. If a reader for the same track SID is already
388+
/// active, startup is skipped and a default-constructed thread is returned; otherwise any previous reader is
389+
/// extracted and returned to the caller for joining outside the lock.
389390
///
390391
/// Must be called with @ref lock_ held.
391392
std::thread startReaderLocked(const CallbackKey& key, const std::shared_ptr<Track>& track);

0 commit comments

Comments
 (0)