@fastpix/fastpix-node 2.0.0 → 2.0.2

package/samples/index.ts

@@ -0,0 +1,224 @@
+/**
+ * FastPix Node.js SDK Samples Index
+ * 
+ * This file provides an overview of all available samples and can be used
+ * to run multiple samples or get a quick reference of what's available.
+ * 
+ * Run this file to see all available samples:
+ * npx tsx index.ts
+ */
+
+import { createFastpixClient } from "./common/setup.js";
+
+// Sample categories and their descriptions
+const sampleCategories = {
+  media: {
+    name: "Media API Samples",
+    description: "Upload, manage, and transform video content",
+    samples: [
+      {
+        file: "media/input-video.ts",
+        name: "Input Video",
+        description: "Create media from URL and upload from device"
+      },
+      {
+        file: "media/manage-videos.ts", 
+        name: "Manage Videos",
+        description: "List, update, delete, and manage video tracks"
+      },
+      {
+        file: "media/playback.ts",
+        name: "Playback",
+        description: "Create and manage playback IDs for secure access"
+      },
+      {
+        file: "media/playlist.ts",
+        name: "Playlist",
+        description: "Create and manage video playlists"
+      }
+    ]
+  },
+  live: {
+    name: "Live Streaming Samples",
+    description: "Stream, manage, and transform live video content",
+    samples: [
+      {
+        file: "live/start-live-stream.ts",
+        name: "Start Live Stream",
+        description: "Create new live streaming sessions"
+      },
+      {
+        file: "live/manage-live-stream.ts",
+        name: "Manage Live Stream",
+        description: "Manage active live streams and viewer statistics"
+      },
+      {
+        file: "live/live-playback.ts",
+        name: "Live Playback",
+        description: "Create and manage live playback access"
+      }
+    ]
+  },
+  analytics: {
+    name: "Analytics Samples",
+    description: "Monitor video performance and quality with comprehensive analytics",
+    samples: [
+      {
+        file: "analytics/views.ts",
+        name: "Views",
+        description: "Analyze video views and viewer behavior"
+      },
+      {
+        file: "analytics/metrics.ts",
+        name: "Metrics",
+        description: "Get performance metrics and breakdowns"
+      },
+      {
+        file: "analytics/dimensions.ts",
+        name: "Dimensions",
+        description: "Explore data dimensions and filter values"
+      },
+      {
+        file: "analytics/errors.ts",
+        name: "Errors",
+        description: "Track and analyze playback errors"
+      }
+    ]
+  },
+  ai: {
+    name: "AI Features Samples",
+    description: "Enhance video content with AI-powered features",
+    samples: [
+      {
+        file: "ai/ai-features.ts",
+        name: "AI Features",
+        description: "Generate summaries, chapters, entities, and moderation"
+      }
+    ]
+  },
+  security: {
+    name: "Security Samples",
+    description: "Manage security and authentication",
+    samples: [
+      {
+        file: "security/signing-keys.ts",
+        name: "Signing Keys",
+        description: "Create and manage signing key pairs for authentication"
+      },
+      {
+        file: "security/drm-configurations.ts",
+        name: "DRM Configurations",
+        description: "Manage DRM settings and configurations"
+      }
+    ]
+  }
+};
+
+function displaySampleIndex() {
+  console.log("📚 FastPix Node.js SDK Samples");
+  console.log("===============================");
+  console.log("Comprehensive examples demonstrating FastPix API usage\n");
+
+  Object.entries(sampleCategories).forEach(([categoryKey, category]) => {
+    console.log(`📁 ${category.name}`);
+    console.log(`   ${category.description}\n`);
+    
+    category.samples.forEach(sample => {
+      console.log(`   📄 ${sample.name}`);
+      console.log(`      File: ${sample.file}`);
+      console.log(`      Description: ${sample.description}`);
+      console.log(`      Run: npx tsx ${sample.file}\n`);
+    });
+  });
+
+  console.log("🚀 Quick Start Commands:");
+  console.log("========================");
+  console.log("npm run media          # Run all media samples");
+  console.log("npm run live           # Run all live streaming samples");
+  console.log("npm run analytics      # Run all analytics samples");
+  console.log("npm run ai             # Run AI features samples");
+  console.log("npm run security       # Run security samples");
+  console.log("npm run all            # Run all samples");
+  console.log("\n📖 For detailed instructions, see README.md");
+}
+
+function displayQuickReference() {
+  console.log("\n🔧 Quick Reference");
+  console.log("==================");
+  console.log("Common operations you can perform:\n");
+  
+  console.log("📹 Media Management:");
+  console.log("  • Upload videos from URL or device");
+  console.log("  • List, update, and delete media");
+  console.log("  • Add audio/subtitle tracks");
+  console.log("  • Generate automatic subtitles");
+  console.log("  • Create and manage playlists");
+  console.log("  • Generate secure playback IDs\n");
+  
+  console.log("🔴 Live Streaming:");
+  console.log("  • Create live streams (RTMPS/SRT)");
+  console.log("  • Manage stream settings and privacy");
+  console.log("  • Enable/disable streams");
+  console.log("  • Monitor viewer counts");
+  console.log("  • Create live playback access\n");
+  
+  console.log("📊 Analytics:");
+  console.log("  • Track video views and engagement");
+  console.log("  • Analyze performance metrics");
+  console.log("  • Monitor concurrent viewers");
+  console.log("  • Track playback errors");
+  console.log("  • Filter data by dimensions\n");
+  
+  console.log("🤖 AI Features:");
+  console.log("  • Generate video summaries");
+  console.log("  • Create automatic chapters");
+  console.log("  • Extract named entities");
+  console.log("  • Enable content moderation\n");
+  
+  console.log("🔐 Security:");
+  console.log("  • Create signing key pairs");
+  console.log("  • Manage DRM configurations");
+  console.log("  • Secure token-based authentication\n");
+}
+
+async function testConnection() {
+  console.log("\n🔌 Testing FastPix Connection");
+  console.log("=============================");
+  
+  try {
+    const fastpix = createFastpixClient();
+    
+    // Test with a simple API call
+    const dimensions = await fastpix.dimensions.listDimensions();
+    console.log("✅ Connection successful!");
+    console.log(`📊 Found ${dimensions.listDimensionsSuccessResponse?.data?.dimensions?.length || 0} available dimensions`);
+    
+    return true;
+  } catch (error) {
+    console.log("❌ Connection failed!");
+    console.log("Please check your credentials in the .env file");
+    console.log("Error:", error.message || error);
+    
+    return false;
+  }
+}
+
+async function main() {
+  displaySampleIndex();
+  displayQuickReference();
+  
+  const connected = await testConnection();
+  
+  if (connected) {
+    console.log("\n🎉 You're ready to start using the FastPix SDK samples!");
+    console.log("Choose a sample from the list above and run it with:");
+    console.log("npx tsx <sample-file>");
+  } else {
+    console.log("\n⚠️  Please configure your credentials before running samples");
+    console.log("1. Copy env.example to .env");
+    console.log("2. Add your FastPix credentials");
+    console.log("3. Run this file again to test the connection");
+  }
+}
+
+main().catch(console.error);

package/samples/live/live-playback.ts

@@ -0,0 +1,104 @@
+/**
+ * Live Playback API Samples
+ * 
+ * This file demonstrates how to use the Live Playback API to:
+ * - Create playback IDs for live streams
+ * - Get live playback ID details
+ * - Delete live playback IDs
+ * 
+ * Run this sample:
+ * npx tsx live/live-playback.ts
+ */
+
+import { createFastpixClient, runSample } from "../common/setup.js";
+import { logResponse } from "../common/config.js";
+
+let streamId: string | undefined;
+let createdPlaybackId: string | undefined;
+
+async function getStreamForPlayback() {
+  const fastpix = createFastpixClient();
+  
+  // First, get a stream to create playback ID for
+  const streams = await fastpix.manageLiveStream.getAllStreams({ limit: 1 });
+  const stream = streams.getAllStreamsSuccessResponse?.data?.streams?.[0];
+  
+  if (!stream?.id) {
+    console.log("⚠️  No streams found. Please create a stream first using start-live-stream.ts");
+    return;
+  }
+
+  streamId = stream.id;
+  console.log(`📺 Using stream ID: ${streamId}`);
+  return stream;
+}
+
+async function createPlaybackIdOfStream() {
+  if (!streamId) {
+    console.log("⚠️  No stream ID available. Run getStreamForPlayback first.");
+    return;
+  }
+
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.livePlayback.createPlaybackIdOfStream({
+    streamId: streamId,
+    requestBody: {
+      policy: "public",
+    },
+  });
+
+  if (result.createPlaybackIdOfStreamSuccessResponse?.data?.id) {
+    createdPlaybackId = result.createPlaybackIdOfStreamSuccessResponse.data.id;
+  }
+
+  logResponse("Create Playback ID of Stream", result);
+  return result;
+}
+
+async function getLiveStreamPlaybackId() {
+  if (!createdPlaybackId) {
+    console.log("⚠️  No playback ID available. Run createPlaybackIdOfStream first.");
+    return;
+  }
+
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.livePlayback.getLiveStreamPlaybackId({
+    playbackId: createdPlaybackId,
+  });
+
+  logResponse("Get Live Stream Playback ID", result);
+  return result;
+}
+
+async function deletePlaybackIdOfStream() {
+  if (!createdPlaybackId) {
+    console.log("⚠️  No playback ID available. Run createPlaybackIdOfStream first.");
+    return;
+  }
+
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.livePlayback.deletePlaybackIdOfStream({
+    playbackId: createdPlaybackId,
+  });
+
+  logResponse("Delete Playback ID of Stream", result);
+  createdPlaybackId = undefined; // Reset the ID since playback ID is deleted
+  return result;
+}
+
+async function main() {
+  console.log("▶️  Live Playback API Samples");
+  console.log("=============================");
+  
+  await runSample("Get Stream for Playback", getStreamForPlayback);
+  await runSample("Create Playback ID of Stream", createPlaybackIdOfStream);
+  await runSample("Get Live Stream Playback ID", getLiveStreamPlaybackId);
+  
+  // Uncomment to delete the playback ID
+  // await runSample("Delete Playback ID of Stream", deletePlaybackIdOfStream);
+}
+
+main().catch(console.error);

package/samples/live/manage-live-stream.ts

@@ -0,0 +1,176 @@
+/**
+ * Manage Live Stream API Samples
+ * 
+ * This file demonstrates how to use the Manage Live Stream API to:
+ * - List all streams
+ * - Get stream by ID
+ * - Update stream settings
+ * - Enable/disable streams
+ * - Get viewer count
+ * - Complete streams
+ * - Delete streams
+ * 
+ * Run this sample:
+ * npx tsx live/manage-live-stream.ts
+ */
+
+import { createFastpixClient, runSample } from "../common/setup.js";
+import { config, logResponse } from "../common/config.js";
+
+let streamId: string | undefined;
+
+async function listAllStreams() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.manageLiveStream.getAllStreams({
+    limit: 10,
+    offset: 0,
+  });
+
+  logResponse("List All Streams", result);
+  
+  // Store the first stream ID for other operations
+  if (result.getAllStreamsSuccessResponse?.data?.streams?.[0]?.id) {
+    streamId = result.getAllStreamsSuccessResponse.data.streams[0].id;
+  }
+  
+  return result;
+}
+
+async function getStreamById() {
+  if (!streamId) {
+    console.log("⚠️  No stream ID available. Run listAllStreams first.");
+    return;
+  }
+
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.manageLiveStream.getLiveStreamById({
+    streamId: streamId,
+  });
+
+  logResponse("Get Stream by ID", result);
+  return result;
+}
+
+async function updateStream() {
+  if (!streamId) {
+    console.log("⚠️  No stream ID available. Run listAllStreams first.");
+    return;
+  }
+
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.manageLiveStream.updateLiveStream({
+    streamId: streamId,
+    requestBody: {
+      metadata: {
+        name: "Updated Stream Name",
+        description: "This stream has been updated via SDK",
+      },
+      reconnectWindow: 60,
+    },
+  });
+
+  logResponse("Update Stream", result);
+  return result;
+}
+
+async function enableStream() {
+  if (!streamId) {
+    console.log("⚠️  No stream ID available. Run listAllStreams first.");
+    return;
+  }
+
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.manageLiveStream.enableLiveStream({
+    streamId: streamId,
+  });
+
+  logResponse("Enable Stream", result);
+  return result;
+}
+
+async function disableStream() {
+  if (!streamId) {
+    console.log("⚠️  No stream ID available. Run listAllStreams first.");
+    return;
+  }
+
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.manageLiveStream.disableLiveStream({
+    streamId: streamId,
+  });
+
+  logResponse("Disable Stream", result);
+  return result;
+}
+
+async function getViewerCount() {
+  if (!streamId) {
+    console.log("⚠️  No stream ID available. Run listAllStreams first.");
+    return;
+  }
+
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.manageLiveStream.getLiveStreamViewerCountById({
+    streamId: streamId,
+  });
+
+  logResponse("Get Viewer Count", result);
+  return result;
+}
+
+async function completeStream() {
+  if (!streamId) {
+    console.log("⚠️  No stream ID available. Run listAllStreams first.");
+    return;
+  }
+
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.manageLiveStream.completeLiveStream({
+    streamId: streamId,
+  });
+
+  logResponse("Complete Stream", result);
+  return result;
+}
+
+async function deleteStream() {
+  if (!streamId) {
+    console.log("⚠️  No stream ID available. Run listAllStreams first.");
+    return;
+  }
+
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.manageLiveStream.deleteLiveStream({
+    streamId: streamId,
+  });
+
+  logResponse("Delete Stream", result);
+  streamId = undefined; // Reset the ID since stream is deleted
+  return result;
+}
+
+async function main() {
+  console.log("📺 Manage Live Stream API Samples");
+  console.log("==================================");
+  
+  await runSample("List All Streams", listAllStreams);
+  await runSample("Get Stream by ID", getStreamById);
+  await runSample("Update Stream", updateStream);
+  await runSample("Enable Stream", enableStream);
+  await runSample("Get Viewer Count", getViewerCount);
+  await runSample("Disable Stream", disableStream);
+  
+  // Uncomment to complete or delete the stream (be careful!)
+  // await runSample("Complete Stream", completeStream);
+  // await runSample("Delete Stream", deleteStream);
+}
+
+main().catch(console.error);

package/samples/live/start-live-stream.ts

@@ -0,0 +1,91 @@
+/**
+ * Start Live Stream API Samples
+ * 
+ * This file demonstrates how to use the Start Live Stream API to:
+ * - Create new live streams
+ * - Configure stream settings
+ * 
+ * Run this sample:
+ * npx tsx live/start-live-stream.ts
+ */
+
+import { createFastpixClient, runSample } from "../common/setup.js";
+import { config, logResponse } from "../common/config.js";
+
+let createdStreamId: string | undefined;
+
+async function createNewStream() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.startLiveStream.createNewStream({
+    requestBody: {
+      metadata: {
+        name: config.sampleStreamName,
+        description: config.sampleStreamDescription,
+      },
+      reconnectWindow: 30, // 30 seconds
+      privacy: "public",
+    },
+  });
+
+  if (result.data?.id) {
+    createdStreamId = result.data.id;
+  }
+
+  logResponse("Create New Stream", result);
+  return result;
+}
+
+async function createPrivateStream() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.startLiveStream.createNewStream({
+    requestBody: {
+      metadata: {
+        name: "Private Sample Stream",
+        description: "A private stream created via SDK",
+      },
+      reconnectWindow: 60, // 60 seconds
+      privacy: "private",
+    },
+  });
+
+  logResponse("Create Private Stream", result);
+  return result;
+}
+
+async function createStreamWithCustomSettings() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.startLiveStream.createNewStream({
+    requestBody: {
+      metadata: {
+        name: "Custom Settings Stream",
+        description: "A stream with custom settings",
+        category: "gaming",
+        tags: ["live", "demo", "sdk"],
+      },
+      reconnectWindow: 45, // 45 seconds
+      privacy: "public",
+    },
+  });
+
+  logResponse("Create Stream with Custom Settings", result);
+  return result;
+}
+
+async function main() {
+  console.log("🔴 Start Live Stream API Samples");
+  console.log("=================================");
+  
+  await runSample("Create New Stream", createNewStream);
+  await runSample("Create Private Stream", createPrivateStream);
+  await runSample("Create Stream with Custom Settings", createStreamWithCustomSettings);
+  
+  if (createdStreamId) {
+    console.log(`\n📝 Created stream ID: ${createdStreamId}`);
+    console.log("   You can use this ID with the manage-live-stream.ts sample");
+  }
+}
+
+main().catch(console.error);

package/samples/media/input-video.ts

@@ -0,0 +1,65 @@
+/**
+ * Input Video API Samples
+ * 
+ * This file demonstrates how to use the Input Video API to:
+ * - Create media from URL
+ * - Upload media from device
+ * 
+ * Run this sample:
+ * npx tsx media/input-video.ts
+ */
+
+import { createFastpixClient, runSample } from "../common/setup.js";
+import { config, logResponse, logError } from "../common/config.js";
+
+async function createMediaFromUrl() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.inputVideo.createMedia({
+    inputs: [
+      {
+        type: "video",
+        url: config.sampleVideoUrl,
+      },
+    ],
+    metadata: {
+      title: "Sample Video from URL",
+      description: "This video was created using the FastPix SDK",
+      category: "sample",
+    },
+    accessPolicy: "public",
+  });
+
+  logResponse("Create Media from URL", result);
+  return result;
+}
+
+async function uploadMediaFromDevice() {
+  const fastpix = createFastpixClient();
+  
+  // Note: This example shows the structure, but you'll need an actual file
+  // In a real application, you'd get the file from a file input or file system
+  const result = await fastpix.inputVideo.directUploadVideoMedia({
+    file: new Blob(["sample video content"], { type: "video/mp4" }),
+    metadata: {
+      title: "Sample Uploaded Video",
+      description: "This video was uploaded directly from device",
+    },
+    accessPolicy: "public",
+  });
+
+  logResponse("Upload Media from Device", result);
+  return result;
+}
+
+async function main() {
+  console.log("📹 Input Video API Samples");
+  console.log("==========================");
+  
+  await runSample("Create Media from URL", createMediaFromUrl);
+  
+  // Uncomment to test direct upload (requires actual file)
+  // await runSample("Upload Media from Device", uploadMediaFromDevice);
+}
+
+main().catch(console.error);