@fraku/video 0.1.39 → 0.1.41

package/README.md

@@ -1,2 +1,22 @@
 # fraku-video
-Module of fraku, for integrate Video in Voting and Admin 
+
+This documentation provides an overview of the `VideoPlugin` library, its function flow, and its integration with the Zoom SDK. The library is designed to integrate video functionality into the Voting and Admin applications.
+
+## Getting Started
+
+1. **Install the library:**
+
+   ```bash
+   npm install @fraku/video
+   ```
+
+2. **Import and use the `VideoPlugin` component:**
+
+   ```tsx
+   import { VideoPlugin } from '@fraku/video'
+
+   const App = () => {
+     const ref = useRef<VideoPluginHandle>(null)
+     return <VideoPlugin ref={ref} />
+   }
+   ```

package/dist/VideoPlugin.d.ts

@@ -1,13 +1,16 @@
 import { VideoPluginProps } from './types';
 
-type VideoPluginHandle = {
-    cleanup: () => Promise<void> | undefined;
-    sessionStarted: boolean;
-    joinSession: () => Promise<void> | undefined;
-    leaveSession: ({ finishForAll }: {
+/**
+ * Public API exposed to library consumers
+ */
+export type VideoPluginRef = {
+    isReady: () => boolean;
+    cleanup: () => Promise<void>;
+    getSessionStarted: () => boolean;
+    joinSession: () => Promise<void>;
+    leaveSession: (options: {
         finishForAll?: boolean;
-    }) => Promise<void> | undefined;
+    }) => Promise<void>;
 };
-export declare const VideoPlugin: import('react').ForwardRefExoticComponent<VideoPluginProps & import('react').RefAttributes<VideoPluginHandle>>;
-export type VideoPlugin = VideoPluginHandle;
+export declare const VideoPlugin: import('react').ForwardRefExoticComponent<VideoPluginProps & import('react').RefAttributes<VideoPluginRef>>;
 export default VideoPlugin;