arcodange/mediabunny
1
0
Fork 0
mirror of https://github.com/arcodange-org/mediabunny.git synced 2026-09-27 02:43:48 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add pause and resume methods to MediaStreamTrack sources (closes #241)

Browse Source
This commit is contained in:
Vanilagy
2025-12-11 15:51:18 +01:00
parent 1ff8abdaab
commit 84dec01dfd
3 changed files with 140 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/guide/media-sources.md
+20
View File
@@ -187,6 +187,16 @@ videoTrackSource.errorPromise.catch((error) => ...);
This source requires no additional method calls; data will automatically be captured and piped to the output file as soon as `start()` is called on the `Output`. Make sure to `stop()` on `videoTrack` after finalizing the `Output` if you don't need the user's media anymore.
If you want to temporarily stop capturing video frames from this source, you can use the `pause()` and `resume()` methods:
```ts
videoTrackSource.pause();
// Later:
videoTrackSource.resume();
```
While paused, video frames emitted by the stream will be ignored. When resumed, video frames are let through again, offset in timestamp such that the result plays back continuously with no gap in playback. Note that pausing does *not* stop the underlying media stream.
::: info
If this source is the only MediaStreamTrack source in the `Output`, then the first video sample added by it starts at timestamp 0. If there are multiple, then the earliest media sample across all tracks starts at timestamp 0, and all tracks will be perfectly synchronized with each other.
:::
@@ -344,6 +354,16 @@ audioTrackSource.errorPromise.catch((error) => ...);
This source requires no additional method calls; data will automatically be captured and piped to the output file as soon as `start()` is called on the `Output`. Make sure to `stop()` on `audioTrack` after finalizing the `Output` if you don't need the user's media anymore.
If you want to temporarily stop capturing audio data from this source, you can use the `pause()` and `resume()` methods:
```ts
audioTrackSource.pause();
// Later:
audioTrackSource.resume();
```
While paused, audio data emitted by the stream will be ignored. When resumed, audio data are let through again, offset in timestamp such that the result plays back continuously with no gap in playback. Note that pausing does *not* stop the underlying media stream.
::: info
If this source is the only MediaStreamTrack source in the `Output`, then the first audio sample added by it starts at timestamp 0. If there are multiple, then the earliest media sample across all tracks starts at timestamp 0, and all tracks will be perfectly synchronized with each other.
:::