ugcinc 2.4.2 → 2.4.3

package/README.md

@@ -77,6 +77,13 @@ For complete API documentation, including all endpoints, parameters, and example
 - Delete API keys
 - Edit API key names
 
+### Render
+- Render videos from editor configurations (supports video, audio, text, image segments)
+- Render static images from editor configurations (supports text and image segments only)
+- Check render job status
+- Download rendered files (MP4 for videos, PNG/JPEG for images)
+- Type-safe methods enforce correct segment types at compile time
+
 ### Examples
 
 **Get accounts with filters:**
@@ -305,6 +312,123 @@ if (response.ok) {
 }
 ```
 
+**Render a video:**
+```typescript
+// Submit a video render job
+const videoJob = await client.render.renderVideo({
+  editor: {
+    width: 1080,
+    height: 1920,
+    fps: 30,
+    duration: 5000,
+    channels: [
+      {
+        id: 'background',
+        segments: [
+          {
+            id: 'bg-video',
+            type: 'video',  // All segment types allowed for video
+            source: 'https://example.com/video.mp4',
+            order: 0,
+            offset: { type: 'absolute', value: 0 },
+            xOffset: 0,
+            yOffset: 0,
+            width: 1080,
+            height: 1920
+          }
+        ]
+      },
+      {
+        id: 'text-layer',
+        segments: [
+          {
+            id: 'title',
+            type: 'text',
+            source: '',
+            text: 'My Video',
+            order: 0,
+            offset: { type: 'absolute', value: 0 },
+            fontSize: 80,
+            color: '#FFFFFF'
+          }
+        ]
+      }
+    ]
+  }
+});
+
+// Poll for completion
+let status;
+do {
+  await new Promise(resolve => setTimeout(resolve, 5000)); // Wait 5 seconds
+  const statusResponse = await client.render.getStatus(videoJob.data.job_id);
+  if (statusResponse.ok) {
+    status = statusResponse.data;
+    console.log(`Status: ${status.status} - ${status.message}`);
+  }
+} while (status?.status === 'pending' || status?.status === 'processing');
+
+if (status?.status === 'completed') {
+  console.log('Video ready:', status.download_url);
+}
+```
+
+**Render a static image:**
+```typescript
+// Submit an image render job (text and images only, no video/audio)
+const imageJob = await client.render.renderImage({
+  editor: {
+    width: 1080,
+    height: 1920,
+    fps: 30,  // Required but not used for images
+    duration: 1000,  // Required but not used for images
+    channels: [
+      {
+        id: 'background',
+        segments: [
+          {
+            id: 'bg-image',
+            type: 'image',  // Only image and text segments allowed
+            source: 'https://example.com/background.jpg',
+            order: 0,
+            offset: { type: 'absolute', value: 0 },
+            xOffset: 0,
+            yOffset: 0,
+            width: 1080,
+            height: 1920
+          }
+        ]
+      },
+      {
+        id: 'text-layer',
+        segments: [
+          {
+            id: 'title',
+            type: 'text',
+            source: '',
+            text: 'Thumbnail Title',
+            order: 0,
+            offset: { type: 'absolute', value: 0 },
+            fontSize: 100,
+            fontWeight: 'bold',
+            color: '#FFFFFF',
+            strokeColor: '#000000',
+            strokeWidth: 4
+          }
+        ]
+      }
+    ]
+  },
+  image_format: 'png'  // or 'jpeg'
+});
+
+// Check status
+const statusResponse = await client.render.getStatus(imageJob.data.job_id);
+if (statusResponse.ok && statusResponse.data.status === 'completed') {
+  console.log('Image ready:', statusResponse.data.download_url);
+}
+```
+
 ## TypeScript Support
 
 This package is written in TypeScript and provides full type definitions:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ugcinc",
-  "version": "2.4.2",
+  "version": "2.4.3",
   "description": "TypeScript/JavaScript client for the UGC Inc API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",