@volorio/media-services 0.2.0

package/README.md

@@ -0,0 +1,34 @@
+# @volorio/media-services
+
+Server-side helpers for Volorio media service products.
+
+```ts
+import { VolorioMediaServicesClient } from "@volorio/media-services";
+
+const media = new VolorioMediaServicesClient({
+  apiBaseUrl: "https://api.volorio.com",
+  apiKey: process.env.VOLORIO_SERVER_API_KEY!,
+});
+
+await media.cloudTranscodings.start({
+  roomId: "room_123",
+  outputUrl: "rtmp://cdn.example.com/live/stream",
+  quality: "fullhd",
+  layout: "grid",
+});
+
+await media.mediaPushes.start({
+  roomId: "room_123",
+  outputUrl: "rtmp://cdn.example.com/live/stream",
+  quality: "hd",
+  layout: "speaker",
+});
+
+await media.mediaPulls.start({
+  roomId: "room_123",
+  sourceUrl: "https://cdn.example.com/live/source.m3u8",
+  participantIdentity: "remote_stage",
+});
+```
+
+API keys must stay on your backend. Do not ship server API keys to browser or mobile apps.

package/dist/src/index.d.ts

@@ -0,0 +1,36 @@
+import { VolorioServerClient, type StartCloudTranscodingInput, type StartMediaPushInput, type StartMediaPullInput, type StartMediaGatewayInput, type StartRecordingInput, type VolorioCloudTranscoding, type VolorioCloudTranscodingOperation, type VolorioMediaGateway, type VolorioMediaGatewayOperation, type VolorioMediaPush, type VolorioMediaPushOperation, type VolorioMediaPull, type VolorioMediaPullOperation, type VolorioMediaServiceOperation, type VolorioRecording, type VolorioRecordingOperation, type VolorioServerClientOptions, type ReconcileMediaServiceOperationInput } from "@volorio/server";
+type VolorioMediaServicesServerClient = Pick<VolorioServerClient, "startRecording" | "stopRecording" | "startMediaGateway" | "stopMediaGateway" | "startCloudTranscoding" | "stopCloudTranscoding" | "startMediaPush" | "stopMediaPush" | "startMediaPull" | "stopMediaPull" | "getMediaServiceOperation" | "reconcileMediaServiceOperation">;
+export type VolorioMediaServicesClientOptions = (VolorioServerClientOptions & {
+    serverClient?: undefined;
+}) | {
+    serverClient: VolorioMediaServicesServerClient;
+};
+export declare class VolorioMediaServicesClient {
+    private readonly serverClient;
+    readonly recordings: {
+        start: (input: StartRecordingInput) => Promise<VolorioRecordingOperation>;
+        stop: (recordingId: string) => Promise<VolorioRecording>;
+    };
+    readonly mediaGateways: {
+        start: (input: StartMediaGatewayInput) => Promise<VolorioMediaGatewayOperation>;
+        stop: (gatewayId: string) => Promise<VolorioMediaGateway>;
+    };
+    readonly cloudTranscodings: {
+        start: (input: StartCloudTranscodingInput) => Promise<VolorioCloudTranscodingOperation>;
+        stop: (transcodingId: string) => Promise<VolorioCloudTranscoding>;
+    };
+    readonly mediaPushes: {
+        start: (input: StartMediaPushInput) => Promise<VolorioMediaPushOperation>;
+        stop: (pushId: string) => Promise<VolorioMediaPush>;
+    };
+    readonly mediaPulls: {
+        start: (input: StartMediaPullInput) => Promise<VolorioMediaPullOperation>;
+        stop: (pullId: string) => Promise<VolorioMediaPull>;
+    };
+    readonly operations: {
+        get: (operationId: string) => Promise<VolorioMediaServiceOperation>;
+        reconcile: (input: ReconcileMediaServiceOperationInput) => Promise<VolorioMediaServiceOperation>;
+    };
+    constructor(options: VolorioMediaServicesClientOptions);
+}
+export type { StartCloudTranscodingInput, StartMediaPushInput, StartMediaPullInput, StartMediaGatewayInput, StartRecordingInput, VolorioCloudTranscoding, VolorioCloudTranscodingOperation, VolorioMediaGateway, VolorioMediaGatewayOperation, VolorioMediaPush, VolorioMediaPushOperation, VolorioMediaPull, VolorioMediaPullOperation, VolorioMediaServiceOperation, VolorioRecording, VolorioRecordingOperation, ReconcileMediaServiceOperationInput, };

package/dist/src/index.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VolorioMediaServicesClient = void 0;
+const server_1 = require("@volorio/server");
+class VolorioMediaServicesClient {
+    serverClient;
+    recordings;
+    mediaGateways;
+    cloudTranscodings;
+    mediaPushes;
+    mediaPulls;
+    operations;
+    constructor(options) {
+        this.serverClient =
+            "serverClient" in options && options.serverClient
+                ? options.serverClient
+                : new server_1.VolorioServerClient(options);
+        this.recordings = {
+            start: (input) => this.serverClient.startRecording(input),
+            stop: (recordingId) => this.serverClient.stopRecording(recordingId),
+        };
+        this.mediaGateways = {
+            start: (input) => this.serverClient.startMediaGateway(input),
+            stop: (gatewayId) => this.serverClient.stopMediaGateway(gatewayId),
+        };
+        this.cloudTranscodings = {
+            start: (input) => this.serverClient.startCloudTranscoding(input),
+            stop: (transcodingId) => this.serverClient.stopCloudTranscoding(transcodingId),
+        };
+        this.mediaPushes = {
+            start: (input) => this.serverClient.startMediaPush(input),
+            stop: (pushId) => this.serverClient.stopMediaPush(pushId),
+        };
+        this.mediaPulls = {
+            start: (input) => this.serverClient.startMediaPull(input),
+            stop: (pullId) => this.serverClient.stopMediaPull(pullId),
+        };
+        this.operations = {
+            get: (operationId) => this.serverClient.getMediaServiceOperation(operationId),
+            reconcile: (input) => this.serverClient.reconcileMediaServiceOperation(input),
+        };
+    }
+}
+exports.VolorioMediaServicesClient = VolorioMediaServicesClient;
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,4CAoByB;AAsBzB,MAAa,0BAA0B;IACpB,YAAY,CAAmC;IAEvD,UAAU,CAGjB;IAEO,aAAa,CAGpB;IAEO,iBAAiB,CAGxB;IAEO,WAAW,CAGlB;IAEO,UAAU,CAGjB;IAEO,UAAU,CAGjB;IAEF,YAAY,OAA0C;QACpD,IAAI,CAAC,YAAY;YACf,cAAc,IAAI,OAAO,IAAI,OAAO,CAAC,YAAY;gBAC/C,CAAC,CAAC,OAAO,CAAC,YAAY;gBACtB,CAAC,CAAC,IAAI,4BAAmB,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG;YAChB,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,CAAC;YACzD,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,WAAW,CAAC;SACpE,CAAC;QACF,IAAI,CAAC,aAAa,GAAG;YACnB,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,KAAK,CAAC;YAC5D,IAAI,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,SAAS,CAAC;SACnE,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG;YACvB,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,KAAK,CAAC;YAChE,IAAI,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,aAAa,CAAC;SAC/E,CAAC;QACF,IAAI,CAAC,WAAW,GAAG;YACjB,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,CAAC;YACzD,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC;SAC1D,CAAC;QACF,IAAI,CAAC,UAAU,GAAG;YAChB,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,CAAC;YACzD,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC;SAC1D,CAAC;QACF,IAAI,CAAC,UAAU,GAAG;YAChB,GAAG,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,wBAAwB,CAAC,WAAW,CAAC;YAC7E,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,8BAA8B,CAAC,KAAK,CAAC;SAC9E,CAAC;IACJ,CAAC;CACF;AA/DD,gEA+DC"}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@volorio/media-services",
+  "version": "0.2.0",
+  "private": false,
+  "description": "Server-side Volorio media service product helpers for recording, media gateway, cloud transcoding, media push, and media pull.",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    }
+  },
+  "files": [
+    "dist/src",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "tsc -p tsconfig.json && node --test dist/test/*.spec.js",
+    "pack:local": "pnpm build && npm pack --pack-destination dist"
+  },
+  "dependencies": {
+    "@volorio/server": "^0.2.0"
+  }
+}