arcodange/mediabunny
1
0
Fork 0
mirror of https://github.com/arcodange-org/mediabunny.git synced 2026-10-03 13:53:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add doc block clarification (fixes #368)

Browse Source
This commit is contained in:
Vanilagy
2026-05-13 17:27:36 +02:00
parent b06bb65a0f
commit 4047038113
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/media-sink.ts
+9
View File
@@ -1821,6 +1821,9 @@ export class VideoSampleSink extends BaseMediaSampleSink<VideoSample> {
* once, and is therefore more efficient than manually getting the sample for every timestamp. The iterator may * once, and is therefore more efficient than manually getting the sample for every timestamp. The iterator may
* yield null if no frame is available for a given timestamp. * yield null if no frame is available for a given timestamp.
* *
* This method is good for sparse access of media data. If you want primarily sequential media access, prefer
* {@link VideoSampleSink.samples} instead.
*
* @param timestamps - An iterable or async iterable of timestamps in seconds. * @param timestamps - An iterable or async iterable of timestamps in seconds.
* @param options - Options used for the underlying packet retrieval. * @param options - Options used for the underlying packet retrieval.
*/ */
@@ -2120,6 +2123,9 @@ export class CanvasSink {
* therefore more efficient than manually getting the canvas for every timestamp. The iterator may yield null if * therefore more efficient than manually getting the canvas for every timestamp. The iterator may yield null if
* no frame is available for a given timestamp. * no frame is available for a given timestamp.
* *
* This method is good for sparse access of media data. If you want primarily sequential media access, prefer
* {@link CanvasSink.samples} instead.
*
* @param timestamps - An iterable or async iterable of timestamps in seconds. * @param timestamps - An iterable or async iterable of timestamps in seconds.
* @param options - Options used for the underlying packet retrieval. * @param options - Options used for the underlying packet retrieval.
*/ */
@@ -2523,6 +2529,9 @@ export class AudioSampleSink extends BaseMediaSampleSink<AudioSample> {
* once, and is therefore more efficient than manually getting the sample for every timestamp. The iterator may * once, and is therefore more efficient than manually getting the sample for every timestamp. The iterator may
* yield null if no sample is available for a given timestamp. * yield null if no sample is available for a given timestamp.
* *
* This method is good for sparse access of media data. If you want primarily sequential media access, prefer
* {@link AudioSampleSink.samples} instead.
*
* @param timestamps - An iterable or async iterable of timestamps in seconds. * @param timestamps - An iterable or async iterable of timestamps in seconds.
* @param options - Options used for the underlying packet retrieval. * @param options - Options used for the underlying packet retrieval.
*/ */