@vidtreo/recorder 0.8.5 → 0.9.0

package/README.md

@@ -15,7 +15,7 @@ import { VidtreoRecorder } from '@vidtreo/recorder';
 
 const recorder = new VidtreoRecorder({
   apiKey: 'your-api-key',
-  apiUrl: 'https://your-worker.workers.dev',
+  apiUrl: 'https://api.vidtreo.com', // Optional, defaults to https://api.vidtreo.com
   enableSourceSwitching: true,
   maxRecordingTime: 300000,
   onUploadComplete: (result) => {
@@ -47,7 +47,7 @@ Creates a new recorder instance with the specified configuration.
 **Parameters:**
 
 - `config.apiKey` (required): Your API key for backend authentication
-- `config.apiUrl` (required): Your backend API URL endpoint
+- `config.apiUrl` (optional): Your backend API URL endpoint. Defaults to `https://api.vidtreo.com` if not provided
 - `config.enableSourceSwitching` (optional): Enable switching between camera and screen during recording. Default: `false`
 - `config.enableMute` (optional): Enable mute/unmute functionality. When disabled, `muteAudio()`, `unmuteAudio()`, and `toggleMute()` will throw errors. Default: `true`
 - `config.enablePause` (optional): Enable pause/resume functionality. When disabled, `pauseRecording()` and `resumeRecording()` will throw errors. Default: `true`
@@ -62,7 +62,7 @@ Creates a new recorder instance with the specified configuration.
 - `config.onRecordingStop` (optional): Callback invoked when recording stops
 - `config.onError` (optional): Callback invoked when a stream error occurs
 
-**Throws:** `Error` if `apiKey` or `apiUrl` are missing
+**Throws:** `Error` if `apiKey` is missing
 
 #### Methods
 
@@ -200,7 +200,7 @@ Cleans up all resources, stops active streams, and cancels any pending operation
 ```typescript
 interface VidtreoRecorderConfig {
   apiKey: string;
-  apiUrl: string;
+  apiUrl?: string;
   enableSourceSwitching?: boolean;
   enableMute?: boolean;
   enablePause?: boolean;
@@ -281,7 +281,7 @@ import { VidtreoRecorder } from '@vidtreo/recorder';
 
 const recorder = new VidtreoRecorder({
   apiKey: 'your-api-key',
-  apiUrl: 'https://api.example.com',
+  apiUrl: 'https://api.example.com', // Optional, defaults to https://api.vidtreo.com
   onUploadComplete: (result) => {
     console.log('Uploaded:', result.uploadUrl);
   },
@@ -612,7 +612,7 @@ const controller = new RecorderController({
 
 await controller.initialize({
   apiKey: 'your-api-key',
-  backendUrl: 'https://api.example.com',
+  backendUrl: 'https://api.example.com', // Optional, defaults to https://api.vidtreo.com
 });
 ```
 
@@ -628,7 +628,7 @@ const stream = streamManager.getStream();
 
 ## Configuration
 
-Video transcoding configuration is managed through your backend API. The recorder fetches configuration using the provided `apiKey` and `apiUrl`. Default transcoding settings include:
+Video transcoding configuration is managed through your backend API. The recorder fetches configuration using the provided `apiKey` and `apiUrl` (defaults to `https://api.vidtreo.com` if not provided). Default transcoding settings include:
 
 - Format: MP4
 - Frame rate: 30 fps