camstreamerlib 4.0.0-beta.162 → 4.0.0-beta.163

package/README.md

@@ -1,13 +1,8 @@
 # CamStreamerLib - BETA
 
-**This is beta version of CamStreamerLib v4, dont use it on production. Is going to be changed significantly.**
+Web and Node.js helper library for CamStreamer ACAP applications.
 
-**The documentation is in progress**
-
-Node.js helper library for CamStreamer ACAP applications.
-
-The library is primarily developed for the CamScripter ACAP application running directly in Axis cameras.
-Examples of CamScripter packages can be found at https://github.com/CamStreamer/CamScripterApp_examples
+The library is primarily developed for ACAP applications running directly in Axis cameras.
 
 ## Installation
 
@@ -26,7 +21,7 @@ npm install camstreamerlib
 | [CamSwitcherAPI](doc/CamSwitcherAPI.md)            | Module to access CamSwitcher API.                                                                                      |
 | [PlaneTrackerAPI](doc/PlaneTrackerAPI.md)          | Module to access PlaneTracker API.                                                                                     |
 | [CamStreamerEvents](doc/ws/CamStreamerEvents.md)   | Module which allows receiving events from CamStreamer ACAP application.                                                |
-| [OverlayEvents](doc/ws/OverlayEvents.md)           | Module which allows receiving events from Overlay ACAP application.                                                    |
+| [CamOverlayEvents](doc/ws/CamOverlayEvents.md)     | Module which allows receiving events from CamOverlay ACAP application.                                                 |
 | [CamSwitcherEvents](doc/ws/CamSwitcherEvents.md)   | Module which allows receiving events from CamSwitcher ACAP application.                                                |
 | [PlaneTrackerEvents](doc/ws/PlaneTrackerEvents.md) | Module which allows receiving events from PlaneTracker ACAP application.                                               |
 
@@ -56,11 +51,11 @@ npm install camstreamerlib
 
 ### ACAP API Class Constructors Updated
 
-All ACAP API classes now **require a client instance to be passed into their constructors** instead of options object.
+All ACAP API classes now **require a client instance to be passed into their constructors** instead of `options` object.
 
 -   This change improves flexibility by allowing you to use either the Node or Web client, depending on your environment.
 
-Example (before → now):
+**Example (before → now)**:
 
 ```typescript
 // Before
@@ -78,6 +73,12 @@ const coApi = new CamOverlayAPI({
 import { DefaultClient } from 'camstreamerlib/web';
 import { CamOverlayAPI } from 'camstreamerlib';
 
+// Use DefaultClient in constructor
+const coApi = new CamOverlayAPI(
+    new DefaultClient()
+);
+
+// Or adjust DefaultClient default values with your own
 const coApi = new CamOverlayAPI(
     new DefaultClient({
         tls: false,
@@ -109,17 +110,43 @@ import { Painter } from 'camstreamerlib/node';
 import { DefaultClient } from 'camstreamerlib/web';
 ```
 
-> Note: To ensure compatibility, set the module resolution in your projects tsconfig.json to `"moduleResolution": "bundler"`.
+> :information_source: Note: To ensure compatibility, set the module resolution in your web projects tsconfig.json to `"moduleResolution": "bundler"`.
 
-### Class and Method Refactored
+### Classes and Methods Refactored
 
 -   **CameraVapix API** has been renamed to [**VapixAPI**](doc/VapixAPI.md).
 -   **DefaultAgent** has been refactored into two separate classes - one for node, one for web as [**DefaultClient**](doc/Client.md)
 -   Several method names and parameter names across the library have been updated for consistency and clarity.
+-   New API modules and endpoints have been introduced, providing extended functionality and better coverage of the underlying service.
 
-> Please refer to [the documentation](#documentation-for-acap-and-camera-api).
+### Stream List Migration
 
--   New API modules and endpoints have been introduced, providing extended functionality and better coverage of the underlying service.
+-   `CamStreamerAPI.getStreamList()` and `getStream()` now throw a **`MigrationError`** when old-format (v3) stream data is detected on the camera.
+-   `MigrationError` provides four arrays to help you handle the transition: `.valid`, `.old`, `.invalid`, and `.unknown`.
+
+```typescript
+import { MigrationError } from 'camstreamerlib';
+
+try {
+    const streams = await csApi.getStreamList();
+} catch (e) {
+    if (e instanceof MigrationError) {
+        console.log('Valid streams:', e.valid);
+        console.log('Old-format streams needing migration:', e.old);
+    }
+}
+```
+
+### CreatePackage Script Path Changed
+
+-   The path to the `CreatePackage` script changed from `camstreamerlib/CreatePackage.js` to `camstreamerlib/bin/CreatePackage.js`.
+-   Update any `package.json` scripts accordingly:
+
+```json
+"scripts": {
+    "create-package": "node node_modules/camstreamerlib/bin/CreatePackage.js"
+}
+```
 
 <hr/>
 </details>
@@ -204,3 +231,5 @@ The zip package is created in the current directory. You can choose different lo
     "create-package": "node node_modules/camstreamerlib/bin/CreatePackage.js -i -e=react"
 }
 ```
+
+> :warning: Path to `CreatePackage` script has changed from `camstreamerlib/CreatePackage.js` to `camstreamerlib/bin/CreatePackage.js` (from v.4.0.0)

package/cjs/CamStreamerAPI.d.ts

@@ -205,6 +205,7 @@ export declare class CamStreamerAPI<Client extends IClient<TResponse, any>> exte
         direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
         position: "fix" | "rotating" | "controllable";
         webPageUrl: string;
+        mediaServerUrl: string | null;
     } | {
         status: {
             led: boolean;
@@ -1958,6 +1959,7 @@ export declare class CamStreamerAPI<Client extends IClient<TResponse, any>> exte
         direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
         position: "fix" | "rotating" | "controllable";
         webPageUrl: string;
+        mediaServerUrl: string | null;
     } | {
         status: {
             led: boolean;

package/cjs/VapixAPI.d.ts

@@ -17,15 +17,6 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> extends Ba
         bitRates: number[];
     }[]>;
     performAutofocus(options?: THttpRequestOptions): Promise<void>;
-    checkSDCard(options?: THttpRequestOptions): Promise<{
-        status: "OK" | "connected" | "disconnected";
-        totalSize: number;
-        freeSize: number;
-    }>;
-    mountSDCard(options?: THttpRequestOptions): Promise<number>;
-    unmountSDCard(options?: THttpRequestOptions): Promise<number>;
-    private _doSDCardMountAction;
-    fetchSDCardJobProgress(jobId: number, options?: THttpRequestOptions): Promise<number>;
     downloadCameraReport(options?: THttpRequestOptions): Promise<string>;
     getSystemLog(options?: THttpRequestOptions): Promise<string>;
     getMaxFps(channel: number, options?: THttpRequestOptions): Promise<number>;
@@ -43,6 +34,15 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> extends Ba
     fetchRemoteDeviceInfo<T extends Record<string, any>>(payload: T, options?: THttpRequestOptions): Promise<any>;
     getHeaders(options?: THttpRequestOptions): Promise<Record<string, string>>;
     setHeaders(headers: Record<string, string>, options?: THttpRequestOptions): Promise<void>;
+    checkSDCard(options?: THttpRequestOptions): Promise<{
+        status: "OK" | "connected" | "disconnected";
+        totalSize: number;
+        freeSize: number;
+    }>;
+    mountSDCard(options?: THttpRequestOptions): Promise<number>;
+    unmountSDCard(options?: THttpRequestOptions): Promise<number>;
+    private _doSDCardMountAction;
+    fetchSDCardJobProgress(jobId: number, options?: THttpRequestOptions): Promise<number>;
     getParameter(paramNames: string | string[], options?: THttpRequestOptions): Promise<Record<string, string>>;
     setParameter(params: Record<string, string | number | boolean>, options?: THttpRequestOptions): Promise<void>;
     getGuardTourList(options?: THttpRequestOptions): Promise<{

package/cjs/VapixAPI.js

@@ -98,65 +98,6 @@ class VapixAPI extends BasicAPI_1.BasicAPI {
             }, options);
         }
     }
-    async checkSDCard(options) {
-        const res = await this._postUrlEncoded('/axis-cgi/disks/list.cgi', {
-            diskid: 'SD_DISK',
-        }, options);
-        const xmlText = await res.text();
-        const parser = new fast_xml_parser_1.XMLParser({
-            ignoreAttributes: false,
-            attributeNamePrefix: '',
-            allowBooleanAttributes: true,
-        });
-        const result = parser.parse(xmlText);
-        const data = result.root.disks.disk;
-        return VapixAPI_1.sdCardInfoSchema.parse({
-            totalSize: parseInt(data.totalsize),
-            freeSize: parseInt(data.freesize),
-            status: VapixAPI_1.sdCardWatchedStatuses.includes(data.status) ? data.status : 'disconnected',
-        });
-    }
-    mountSDCard(options) {
-        return this._doSDCardMountAction('MOUNT', options);
-    }
-    unmountSDCard(options) {
-        return this._doSDCardMountAction('UNMOUNT', options);
-    }
-    async _doSDCardMountAction(action, options) {
-        const res = await this._postUrlEncoded('/axis-cgi/disks/mount.cgi', {
-            action: action,
-            diskid: 'SD_DISK',
-        }, options);
-        const textXml = await res.text();
-        const parser = new fast_xml_parser_1.XMLParser({
-            ignoreAttributes: false,
-            attributeNamePrefix: '',
-            allowBooleanAttributes: true,
-        });
-        const result = parser.parse(textXml);
-        const job = result.root.job;
-        if (job.result !== 'OK') {
-            throw new errors_1.SDCardActionError(action, job.description);
-        }
-        return Number(job.jobid);
-    }
-    async fetchSDCardJobProgress(jobId, options) {
-        const res = await this._postUrlEncoded('/axis-cgi/disks/job.cgi', {
-            jobid: String(jobId),
-            diskid: 'SD_DISK',
-        }, options);
-        const textXml = await res.text();
-        const parser = new fast_xml_parser_1.XMLParser({
-            ignoreAttributes: false,
-            attributeNamePrefix: '',
-            allowBooleanAttributes: true,
-        });
-        const job = parser.parse(textXml).root.job;
-        if (job.result !== 'OK') {
-            throw new errors_1.SDCardJobError(job.description);
-        }
-        return Number(job.progress);
-    }
     downloadCameraReport(options) {
         return this._getText('/axis-cgi/serverreport.cgi', { mode: 'text' }, options);
     }
@@ -242,6 +183,65 @@ class VapixAPI extends BasicAPI_1.BasicAPI {
         const data = { apiVersion: '1.0', method: 'set', params: headers };
         await this._postJsonEncoded('/axis-cgi/customhttpheader.cgi', data, undefined, options);
     }
+    async checkSDCard(options) {
+        const res = await this._postUrlEncoded('/axis-cgi/disks/list.cgi', {
+            diskid: 'SD_DISK',
+        }, options);
+        const xmlText = await res.text();
+        const parser = new fast_xml_parser_1.XMLParser({
+            ignoreAttributes: false,
+            attributeNamePrefix: '',
+            allowBooleanAttributes: true,
+        });
+        const result = parser.parse(xmlText);
+        const data = result.root.disks.disk;
+        return VapixAPI_1.sdCardInfoSchema.parse({
+            totalSize: parseInt(data.totalsize),
+            freeSize: parseInt(data.freesize),
+            status: VapixAPI_1.sdCardWatchedStatuses.includes(data.status) ? data.status : 'disconnected',
+        });
+    }
+    mountSDCard(options) {
+        return this._doSDCardMountAction('MOUNT', options);
+    }
+    unmountSDCard(options) {
+        return this._doSDCardMountAction('UNMOUNT', options);
+    }
+    async _doSDCardMountAction(action, options) {
+        const res = await this._postUrlEncoded('/axis-cgi/disks/mount.cgi', {
+            action: action,
+            diskid: 'SD_DISK',
+        }, options);
+        const textXml = await res.text();
+        const parser = new fast_xml_parser_1.XMLParser({
+            ignoreAttributes: false,
+            attributeNamePrefix: '',
+            allowBooleanAttributes: true,
+        });
+        const result = parser.parse(textXml);
+        const job = result.root.job;
+        if (job.result !== 'OK') {
+            throw new errors_1.SDCardActionError(action, job.description);
+        }
+        return Number(job.jobid);
+    }
+    async fetchSDCardJobProgress(jobId, options) {
+        const res = await this._postUrlEncoded('/disks/job.cgi', {
+            jobid: String(jobId),
+            diskid: 'SD_DISK',
+        }, options);
+        const textXml = await res.text();
+        const parser = new fast_xml_parser_1.XMLParser({
+            ignoreAttributes: false,
+            attributeNamePrefix: '',
+            allowBooleanAttributes: true,
+        });
+        const job = parser.parse(textXml).root.job;
+        if (job.result !== 'OK') {
+            throw new errors_1.SDCardJobError(job.description);
+        }
+        return Number(job.progress);
+    }
     async getParameter(paramNames, options) {
         const response = await this._postUrlEncoded('/axis-cgi/param.cgi', {
             action: 'list',

package/cjs/types/CamStreamerAPI/CamStreamerAPI.d.ts

@@ -2960,6 +2960,7 @@ export declare const streamSchema: z.ZodDiscriminatedUnion<"platform", [z.ZodObj
     direction: z.ZodNullable<z.ZodEnum<["N", "NE", "E", "SE", "S", "SW", "W", "NW"]>>;
     position: z.ZodUnion<[z.ZodLiteral<"fix">, z.ZodLiteral<"rotating">, z.ZodLiteral<"controllable">]>;
     webPageUrl: z.ZodString;
+    mediaServerUrl: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     status: {
         led: boolean;
@@ -3054,6 +3055,7 @@ export declare const streamSchema: z.ZodDiscriminatedUnion<"platform", [z.ZodObj
     direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
     position: "fix" | "rotating" | "controllable";
     webPageUrl: string;
+    mediaServerUrl: string | null;
 }, {
     status: {
         led: boolean;
@@ -3148,6 +3150,7 @@ export declare const streamSchema: z.ZodDiscriminatedUnion<"platform", [z.ZodObj
     direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
     position: "fix" | "rotating" | "controllable";
     webPageUrl: string;
+    mediaServerUrl: string | null;
 }>, z.ZodObject<{
     streamId: z.ZodString;
     enabled: z.ZodBoolean;
@@ -13323,6 +13326,7 @@ export declare const streamListSchema: z.ZodObject<{
         direction: z.ZodNullable<z.ZodEnum<["N", "NE", "E", "SE", "S", "SW", "W", "NW"]>>;
         position: z.ZodUnion<[z.ZodLiteral<"fix">, z.ZodLiteral<"rotating">, z.ZodLiteral<"controllable">]>;
         webPageUrl: z.ZodString;
+        mediaServerUrl: z.ZodNullable<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         status: {
             led: boolean;
@@ -13417,6 +13421,7 @@ export declare const streamListSchema: z.ZodObject<{
         direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
         position: "fix" | "rotating" | "controllable";
         webPageUrl: string;
+        mediaServerUrl: string | null;
     }, {
         status: {
             led: boolean;
@@ -13511,6 +13516,7 @@ export declare const streamListSchema: z.ZodObject<{
         direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
         position: "fix" | "rotating" | "controllable";
         webPageUrl: string;
+        mediaServerUrl: string | null;
     }>, z.ZodObject<{
         streamId: z.ZodString;
         enabled: z.ZodBoolean;
@@ -20918,6 +20924,7 @@ export declare const streamListSchema: z.ZodObject<{
         direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
         position: "fix" | "rotating" | "controllable";
         webPageUrl: string;
+        mediaServerUrl: string | null;
     } | {
         status: {
             led: boolean;
@@ -22669,6 +22676,7 @@ export declare const streamListSchema: z.ZodObject<{
         direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
         position: "fix" | "rotating" | "controllable";
         webPageUrl: string;
+        mediaServerUrl: string | null;
     } | {
         status: {
             led: boolean;
@@ -24776,6 +24784,7 @@ export declare const isWindyStream: (stream: TStream) => stream is {
     direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
     position: "fix" | "rotating" | "controllable";
     webPageUrl: string;
+    mediaServerUrl: string | null;
 };
 export type TYouTubeStream = z.infer<typeof youtubeSchema>;
 export declare const isYouTubeStream: (stream: TStream) => stream is {

package/cjs/types/CamStreamerAPI/oldStreamSchema.d.ts

@@ -32,10 +32,10 @@ export declare const oldStringStreamSchema: z.ZodObject<{
     userVapixParameters: string;
     forceStereo: string;
     avSyncMsec: string;
+    mediaServerUrl: string;
     audioSource: string;
     outputParameters: string;
     outputType: string;
-    mediaServerUrl: string;
     inputType: string;
     inputUrl: string;
     streamDelay: string;
@@ -54,10 +54,10 @@ export declare const oldStringStreamSchema: z.ZodObject<{
     userVapixParameters: string;
     forceStereo: string;
     avSyncMsec: string;
+    mediaServerUrl: string;
     audioSource: string;
     outputParameters: string;
     outputType: string;
-    mediaServerUrl: string;
     inputType: string;
     inputUrl: string;
     streamDelay: string;
@@ -102,10 +102,10 @@ export declare const oldStringStreamSchemaWithId: z.ZodObject<{
     userVapixParameters: string;
     forceStereo: string;
     avSyncMsec: string;
+    mediaServerUrl: string;
     audioSource: string;
     outputParameters: string;
     outputType: string;
-    mediaServerUrl: string;
     inputType: string;
     inputUrl: string;
     streamDelay: string;
@@ -125,10 +125,10 @@ export declare const oldStringStreamSchemaWithId: z.ZodObject<{
     userVapixParameters: string;
     forceStereo: string;
     avSyncMsec: string;
+    mediaServerUrl: string;
     audioSource: string;
     outputParameters: string;
     outputType: string;
-    mediaServerUrl: string;
     inputType: string;
     inputUrl: string;
     streamDelay: string;
@@ -171,10 +171,10 @@ export declare const oldStreamSchema: z.ZodObject<{
     userVapixParameters: string;
     forceStereo: 0 | 1;
     avSyncMsec: number;
+    mediaServerUrl: string;
     audioSource: string;
     outputParameters: string;
     outputType: "video" | "images" | "none";
-    mediaServerUrl: string;
     inputType: "RTSP_URL" | "CSw" | "CRS";
     inputUrl: string;
     streamDelay: number | null;
@@ -193,10 +193,10 @@ export declare const oldStreamSchema: z.ZodObject<{
     userVapixParameters: string;
     forceStereo: 0 | 1;
     avSyncMsec: number;
+    mediaServerUrl: string;
     audioSource: string;
     outputParameters: string;
     outputType: "video" | "images" | "none";
-    mediaServerUrl: string;
     inputType: "RTSP_URL" | "CSw" | "CRS";
     inputUrl: string;
     streamDelay: number | null;

package/cjs/types/CamStreamerAPI/windySchema.d.ts

@@ -348,6 +348,7 @@ export declare const windySchema: z.ZodObject<{
     direction: z.ZodNullable<z.ZodEnum<["N", "NE", "E", "SE", "S", "SW", "W", "NW"]>>;
     position: z.ZodUnion<[z.ZodLiteral<"fix">, z.ZodLiteral<"rotating">, z.ZodLiteral<"controllable">]>;
     webPageUrl: z.ZodString;
+    mediaServerUrl: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     status: {
         led: boolean;
@@ -442,6 +443,7 @@ export declare const windySchema: z.ZodObject<{
     direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
     position: "fix" | "rotating" | "controllable";
     webPageUrl: string;
+    mediaServerUrl: string | null;
 }, {
     status: {
         led: boolean;
@@ -536,6 +538,7 @@ export declare const windySchema: z.ZodObject<{
     direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
     position: "fix" | "rotating" | "controllable";
     webPageUrl: string;
+    mediaServerUrl: string | null;
 }>;
 export type TWindyDirection = z.infer<typeof windySchema>['direction'];
 export type TWindyPosition = z.infer<typeof windySchema>['position'];

package/cjs/types/CamStreamerAPI/windySchema.js

@@ -16,4 +16,5 @@ exports.windySchema = streamCommonTypes_1.streamCommonSchema.extend({
     direction: zod_1.default.enum(['N', 'NE', 'E', 'SE', 'S', 'SW', 'W', 'NW']).nullable(),
     position: zod_1.default.union([zod_1.default.literal('fix'), zod_1.default.literal('rotating'), zod_1.default.literal('controllable')]),
     webPageUrl: zod_1.default.string(),
+    mediaServerUrl: zod_1.default.string().nullable(),
 });

package/esm/VapixAPI.js

@@ -95,65 +95,6 @@ export class VapixAPI extends BasicAPI {
             }, options);
         }
     }
-    async checkSDCard(options) {
-        const res = await this._postUrlEncoded('/axis-cgi/disks/list.cgi', {
-            diskid: 'SD_DISK',
-        }, options);
-        const xmlText = await res.text();
-        const parser = new XMLParser({
-            ignoreAttributes: false,
-            attributeNamePrefix: '',
-            allowBooleanAttributes: true,
-        });
-        const result = parser.parse(xmlText);
-        const data = result.root.disks.disk;
-        return sdCardInfoSchema.parse({
-            totalSize: parseInt(data.totalsize),
-            freeSize: parseInt(data.freesize),
-            status: sdCardWatchedStatuses.includes(data.status) ? data.status : 'disconnected',
-        });
-    }
-    mountSDCard(options) {
-        return this._doSDCardMountAction('MOUNT', options);
-    }
-    unmountSDCard(options) {
-        return this._doSDCardMountAction('UNMOUNT', options);
-    }
-    async _doSDCardMountAction(action, options) {
-        const res = await this._postUrlEncoded('/axis-cgi/disks/mount.cgi', {
-            action: action,
-            diskid: 'SD_DISK',
-        }, options);
-        const textXml = await res.text();
-        const parser = new XMLParser({
-            ignoreAttributes: false,
-            attributeNamePrefix: '',
-            allowBooleanAttributes: true,
-        });
-        const result = parser.parse(textXml);
-        const job = result.root.job;
-        if (job.result !== 'OK') {
-            throw new SDCardActionError(action, job.description);
-        }
-        return Number(job.jobid);
-    }
-    async fetchSDCardJobProgress(jobId, options) {
-        const res = await this._postUrlEncoded('/axis-cgi/disks/job.cgi', {
-            jobid: String(jobId),
-            diskid: 'SD_DISK',
-        }, options);
-        const textXml = await res.text();
-        const parser = new XMLParser({
-            ignoreAttributes: false,
-            attributeNamePrefix: '',
-            allowBooleanAttributes: true,
-        });
-        const job = parser.parse(textXml).root.job;
-        if (job.result !== 'OK') {
-            throw new SDCardJobError(job.description);
-        }
-        return Number(job.progress);
-    }
     downloadCameraReport(options) {
         return this._getText('/axis-cgi/serverreport.cgi', { mode: 'text' }, options);
     }
@@ -239,6 +180,65 @@ export class VapixAPI extends BasicAPI {
         const data = { apiVersion: '1.0', method: 'set', params: headers };
         await this._postJsonEncoded('/axis-cgi/customhttpheader.cgi', data, undefined, options);
     }
+    async checkSDCard(options) {
+        const res = await this._postUrlEncoded('/axis-cgi/disks/list.cgi', {
+            diskid: 'SD_DISK',
+        }, options);
+        const xmlText = await res.text();
+        const parser = new XMLParser({
+            ignoreAttributes: false,
+            attributeNamePrefix: '',
+            allowBooleanAttributes: true,
+        });
+        const result = parser.parse(xmlText);
+        const data = result.root.disks.disk;
+        return sdCardInfoSchema.parse({
+            totalSize: parseInt(data.totalsize),
+            freeSize: parseInt(data.freesize),
+            status: sdCardWatchedStatuses.includes(data.status) ? data.status : 'disconnected',
+        });
+    }
+    mountSDCard(options) {
+        return this._doSDCardMountAction('MOUNT', options);
+    }
+    unmountSDCard(options) {
+        return this._doSDCardMountAction('UNMOUNT', options);
+    }
+    async _doSDCardMountAction(action, options) {
+        const res = await this._postUrlEncoded('/axis-cgi/disks/mount.cgi', {
+            action: action,
+            diskid: 'SD_DISK',
+        }, options);
+        const textXml = await res.text();
+        const parser = new XMLParser({
+            ignoreAttributes: false,
+            attributeNamePrefix: '',
+            allowBooleanAttributes: true,
+        });
+        const result = parser.parse(textXml);
+        const job = result.root.job;
+        if (job.result !== 'OK') {
+            throw new SDCardActionError(action, job.description);
+        }
+        return Number(job.jobid);
+    }
+    async fetchSDCardJobProgress(jobId, options) {
+        const res = await this._postUrlEncoded('/disks/job.cgi', {
+            jobid: String(jobId),
+            diskid: 'SD_DISK',
+        }, options);
+        const textXml = await res.text();
+        const parser = new XMLParser({
+            ignoreAttributes: false,
+            attributeNamePrefix: '',
+            allowBooleanAttributes: true,
+        });
+        const job = parser.parse(textXml).root.job;
+        if (job.result !== 'OK') {
+            throw new SDCardJobError(job.description);
+        }
+        return Number(job.progress);
+    }
     async getParameter(paramNames, options) {
         const response = await this._postUrlEncoded('/axis-cgi/param.cgi', {
             action: 'list',

package/esm/types/CamStreamerAPI/windySchema.js

@@ -10,4 +10,5 @@ export const windySchema = streamCommonSchema.extend({
     direction: z.enum(['N', 'NE', 'E', 'SE', 'S', 'SW', 'W', 'NW']).nullable(),
     position: z.union([z.literal('fix'), z.literal('rotating'), z.literal('controllable')]),
     webPageUrl: z.string(),
+    mediaServerUrl: z.string().nullable(),
 });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "camstreamerlib",
-    "version": "4.0.0-beta.162",
+    "version": "4.0.0-beta.163",
     "description": "Helper library for CamStreamer ACAP applications.",
     "prettier": "@camstreamer/prettier-config",
     "engine": {

package/types/CamStreamerAPI.d.ts

@@ -205,6 +205,7 @@ export declare class CamStreamerAPI<Client extends IClient<TResponse, any>> exte
         direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
         position: "fix" | "rotating" | "controllable";
         webPageUrl: string;
+        mediaServerUrl: string | null;
     } | {
         status: {
             led: boolean;
@@ -1958,6 +1959,7 @@ export declare class CamStreamerAPI<Client extends IClient<TResponse, any>> exte
         direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
         position: "fix" | "rotating" | "controllable";
         webPageUrl: string;
+        mediaServerUrl: string | null;
     } | {
         status: {
             led: boolean;

package/types/VapixAPI.d.ts

@@ -17,15 +17,6 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> extends Ba
         bitRates: number[];
     }[]>;
     performAutofocus(options?: THttpRequestOptions): Promise<void>;
-    checkSDCard(options?: THttpRequestOptions): Promise<{
-        status: "OK" | "connected" | "disconnected";
-        totalSize: number;
-        freeSize: number;
-    }>;
-    mountSDCard(options?: THttpRequestOptions): Promise<number>;
-    unmountSDCard(options?: THttpRequestOptions): Promise<number>;
-    private _doSDCardMountAction;
-    fetchSDCardJobProgress(jobId: number, options?: THttpRequestOptions): Promise<number>;
     downloadCameraReport(options?: THttpRequestOptions): Promise<string>;
     getSystemLog(options?: THttpRequestOptions): Promise<string>;
     getMaxFps(channel: number, options?: THttpRequestOptions): Promise<number>;
@@ -43,6 +34,15 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> extends Ba
     fetchRemoteDeviceInfo<T extends Record<string, any>>(payload: T, options?: THttpRequestOptions): Promise<any>;
     getHeaders(options?: THttpRequestOptions): Promise<Record<string, string>>;
     setHeaders(headers: Record<string, string>, options?: THttpRequestOptions): Promise<void>;
+    checkSDCard(options?: THttpRequestOptions): Promise<{
+        status: "OK" | "connected" | "disconnected";
+        totalSize: number;
+        freeSize: number;
+    }>;
+    mountSDCard(options?: THttpRequestOptions): Promise<number>;
+    unmountSDCard(options?: THttpRequestOptions): Promise<number>;
+    private _doSDCardMountAction;
+    fetchSDCardJobProgress(jobId: number, options?: THttpRequestOptions): Promise<number>;
     getParameter(paramNames: string | string[], options?: THttpRequestOptions): Promise<Record<string, string>>;
     setParameter(params: Record<string, string | number | boolean>, options?: THttpRequestOptions): Promise<void>;
     getGuardTourList(options?: THttpRequestOptions): Promise<{

package/types/types/CamStreamerAPI/CamStreamerAPI.d.ts

@@ -2960,6 +2960,7 @@ export declare const streamSchema: z.ZodDiscriminatedUnion<"platform", [z.ZodObj
     direction: z.ZodNullable<z.ZodEnum<["N", "NE", "E", "SE", "S", "SW", "W", "NW"]>>;
     position: z.ZodUnion<[z.ZodLiteral<"fix">, z.ZodLiteral<"rotating">, z.ZodLiteral<"controllable">]>;
     webPageUrl: z.ZodString;
+    mediaServerUrl: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     status: {
         led: boolean;
@@ -3054,6 +3055,7 @@ export declare const streamSchema: z.ZodDiscriminatedUnion<"platform", [z.ZodObj
     direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
     position: "fix" | "rotating" | "controllable";
     webPageUrl: string;
+    mediaServerUrl: string | null;
 }, {
     status: {
         led: boolean;
@@ -3148,6 +3150,7 @@ export declare const streamSchema: z.ZodDiscriminatedUnion<"platform", [z.ZodObj
     direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
     position: "fix" | "rotating" | "controllable";
     webPageUrl: string;
+    mediaServerUrl: string | null;
 }>, z.ZodObject<{
     streamId: z.ZodString;
     enabled: z.ZodBoolean;
@@ -13323,6 +13326,7 @@ export declare const streamListSchema: z.ZodObject<{
         direction: z.ZodNullable<z.ZodEnum<["N", "NE", "E", "SE", "S", "SW", "W", "NW"]>>;
         position: z.ZodUnion<[z.ZodLiteral<"fix">, z.ZodLiteral<"rotating">, z.ZodLiteral<"controllable">]>;
         webPageUrl: z.ZodString;
+        mediaServerUrl: z.ZodNullable<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         status: {
             led: boolean;
@@ -13417,6 +13421,7 @@ export declare const streamListSchema: z.ZodObject<{
         direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
         position: "fix" | "rotating" | "controllable";
         webPageUrl: string;
+        mediaServerUrl: string | null;
     }, {
         status: {
             led: boolean;
@@ -13511,6 +13516,7 @@ export declare const streamListSchema: z.ZodObject<{
         direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
         position: "fix" | "rotating" | "controllable";
         webPageUrl: string;
+        mediaServerUrl: string | null;
     }>, z.ZodObject<{
         streamId: z.ZodString;
         enabled: z.ZodBoolean;
@@ -20918,6 +20924,7 @@ export declare const streamListSchema: z.ZodObject<{
         direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
         position: "fix" | "rotating" | "controllable";
         webPageUrl: string;
+        mediaServerUrl: string | null;
     } | {
         status: {
             led: boolean;
@@ -22669,6 +22676,7 @@ export declare const streamListSchema: z.ZodObject<{
         direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
         position: "fix" | "rotating" | "controllable";
         webPageUrl: string;
+        mediaServerUrl: string | null;
     } | {
         status: {
             led: boolean;
@@ -24776,6 +24784,7 @@ export declare const isWindyStream: (stream: TStream) => stream is {
     direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
     position: "fix" | "rotating" | "controllable";
     webPageUrl: string;
+    mediaServerUrl: string | null;
 };
 export type TYouTubeStream = z.infer<typeof youtubeSchema>;
 export declare const isYouTubeStream: (stream: TStream) => stream is {

package/types/types/CamStreamerAPI/oldStreamSchema.d.ts

@@ -32,10 +32,10 @@ export declare const oldStringStreamSchema: z.ZodObject<{
     userVapixParameters: string;
     forceStereo: string;
     avSyncMsec: string;
+    mediaServerUrl: string;
     audioSource: string;
     outputParameters: string;
     outputType: string;
-    mediaServerUrl: string;
     inputType: string;
     inputUrl: string;
     streamDelay: string;
@@ -54,10 +54,10 @@ export declare const oldStringStreamSchema: z.ZodObject<{
     userVapixParameters: string;
     forceStereo: string;
     avSyncMsec: string;
+    mediaServerUrl: string;
     audioSource: string;
     outputParameters: string;
     outputType: string;
-    mediaServerUrl: string;
     inputType: string;
     inputUrl: string;
     streamDelay: string;
@@ -102,10 +102,10 @@ export declare const oldStringStreamSchemaWithId: z.ZodObject<{
     userVapixParameters: string;
     forceStereo: string;
     avSyncMsec: string;
+    mediaServerUrl: string;
     audioSource: string;
     outputParameters: string;
     outputType: string;
-    mediaServerUrl: string;
     inputType: string;
     inputUrl: string;
     streamDelay: string;
@@ -125,10 +125,10 @@ export declare const oldStringStreamSchemaWithId: z.ZodObject<{
     userVapixParameters: string;
     forceStereo: string;
     avSyncMsec: string;
+    mediaServerUrl: string;
     audioSource: string;
     outputParameters: string;
     outputType: string;
-    mediaServerUrl: string;
     inputType: string;
     inputUrl: string;
     streamDelay: string;
@@ -171,10 +171,10 @@ export declare const oldStreamSchema: z.ZodObject<{
     userVapixParameters: string;
     forceStereo: 0 | 1;
     avSyncMsec: number;
+    mediaServerUrl: string;
     audioSource: string;
     outputParameters: string;
     outputType: "video" | "images" | "none";
-    mediaServerUrl: string;
     inputType: "RTSP_URL" | "CSw" | "CRS";
     inputUrl: string;
     streamDelay: number | null;
@@ -193,10 +193,10 @@ export declare const oldStreamSchema: z.ZodObject<{
     userVapixParameters: string;
     forceStereo: 0 | 1;
     avSyncMsec: number;
+    mediaServerUrl: string;
     audioSource: string;
     outputParameters: string;
     outputType: "video" | "images" | "none";
-    mediaServerUrl: string;
     inputType: "RTSP_URL" | "CSw" | "CRS";
     inputUrl: string;
     streamDelay: number | null;

package/types/types/CamStreamerAPI/windySchema.d.ts

@@ -348,6 +348,7 @@ export declare const windySchema: z.ZodObject<{
     direction: z.ZodNullable<z.ZodEnum<["N", "NE", "E", "SE", "S", "SW", "W", "NW"]>>;
     position: z.ZodUnion<[z.ZodLiteral<"fix">, z.ZodLiteral<"rotating">, z.ZodLiteral<"controllable">]>;
     webPageUrl: z.ZodString;
+    mediaServerUrl: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     status: {
         led: boolean;
@@ -442,6 +443,7 @@ export declare const windySchema: z.ZodObject<{
     direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
     position: "fix" | "rotating" | "controllable";
     webPageUrl: string;
+    mediaServerUrl: string | null;
 }, {
     status: {
         led: boolean;
@@ -536,6 +538,7 @@ export declare const windySchema: z.ZodObject<{
     direction: "N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW" | null;
     position: "fix" | "rotating" | "controllable";
     webPageUrl: string;
+    mediaServerUrl: string | null;
 }>;
 export type TWindyDirection = z.infer<typeof windySchema>['direction'];
 export type TWindyPosition = z.infer<typeof windySchema>['position'];