@livepeer-frameworks/streamcrafter-core 0.0.2 → 0.1.0

package/README.md

@@ -19,7 +19,7 @@ import { StreamCrafterV2 } from '@livepeer-frameworks/streamcrafter-core';
 import '@livepeer-frameworks/streamcrafter-core/streamcrafter.css';
 
 const crafter = new StreamCrafterV2({
-  whipUrl: 'https://ingest.example.com/whip/your-stream-key',
+  whipUrl: 'https://ingest.example.com/webrtc/your-stream-key',
   profile: 'broadcast',
 });
 
@@ -31,6 +31,29 @@ await crafter.stopStreaming();
 crafter.destroy();
 ```
 
+### Gateway Resolution (Advanced)
+
+The vanilla `StreamCrafterV2` constructor requires a **direct WHIP URL**. If you want gateway resolution, use the `IngestClient` (or the React/Svelte wrappers).
+
+```ts
+import { IngestClient, StreamCrafterV2 } from '@livepeer-frameworks/streamcrafter-core';
+
+const ingest = new IngestClient({
+  gatewayUrl: 'https://api.example.com/graphql',
+  streamKey: 'sk_live_...',
+});
+
+const endpoints = await ingest.resolve();
+const whipUrl = endpoints?.primary?.whipUrl;
+
+if (!whipUrl) throw new Error('No WHIP URL resolved');
+
+const crafter = new StreamCrafterV2({ whipUrl, profile: 'broadcast' });
+```
+
+Notes:
+- There is **no default gateway**; you must supply `whipUrl` or resolve it yourself.
+
 ## Notes
 
 - WebCodecs + Web Workers are used when available for background-safe encoding.