add docs

livekit · Dec 22, 2024 · ddcec0e · ddcec0e
1 parent 71c48d3
commit ddcec0e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/packages/livekit-rtc/src/data_streams/stream_reader.ts b/packages/livekit-rtc/src/data_streams/stream_reader.ts
@@ -28,6 +28,9 @@ abstract class BaseStreamReader<T extends BaseStreamInfo> {
   abstract readAll(): Promise<string | Array<Uint8Array>>;
 }
 
+/**
+ * A class to read chunks from a ReadableStream and provide them in a structured format.
+ */
 export class BinaryStreamReader extends BaseStreamReader<FileStreamInfo> {
   private chunksReceived: Set<number>;
 

diff --git a/packages/livekit-rtc/src/participant.ts b/packages/livekit-rtc/src/participant.ts
@@ -330,6 +330,7 @@ export class LocalParticipant extends Participant {
     return writer;
   }
 
+  /** Sends a file provided as PathLike to specified recipients */
   async sendFile(path: PathLike, options?: FileStreamOptions) {
     const fileStats = await stat(path);
     const file = await open(path);