camstreamerlib 4.0.0-beta.127 → 4.0.0-beta.129

package/cjs/CamStreamerAPI.d.ts

@@ -3110,12 +3110,26 @@ export declare class CamStreamerAPI<Client extends IClient<TResponse, any>> exte
         streamIdentifier?: string | undefined;
     }>;
     setStream(streamId: string, streamData: TStream, options?: THttpRequestOptions): Promise<void>;
-    getStreamStats(streamId: number, options?: THttpRequestOptions): Promise<{
+    getStreamNetworkStatistics(streamId: string, options?: THttpRequestOptions): Promise<{
         net_stats: string;
         stream_bytes_time_ms: number;
         stream_bytes: number;
         start_count: number;
-        is_streaming: number;
+        is_streaming: 0 | 1;
+    }>;
+    getSrtStreamStatistics(streamId: string, options?: THttpRequestOptions): Promise<{
+        msTimeStamp: number;
+        pktSentTotal: number;
+        byteSentTotal: number;
+        pktRetransTotal: number;
+        byteRetransTotal: number;
+        pktSndDropTotal: number;
+        byteSndDropTotal: number;
+        mbpsSendRate: number;
+        mbpsBandwidth: number;
+        mbpsMaxBW: number;
+        msRTT: number;
+        msSndBuf: number;
     }>;
     setStreamEnabled(streamId: string, enabled: boolean, options?: THttpRequestOptions): Promise<void>;
     setStreamActive(streamId: string, active: boolean, options?: THttpRequestOptions): Promise<void>;

package/cjs/CamStreamerAPI.js

@@ -91,10 +91,14 @@ class CamStreamerAPI extends BasicAPI_1.BasicAPI {
             stream_id: streamId,
         }, options);
     }
-    async getStreamStats(streamId, options) {
+    async getStreamNetworkStatistics(streamId, options) {
         const res = await this._getJson(`${BASE_PATH}/get_streamstat.cgi`, { stream_id: streamId }, options);
         return CamStreamerAPI_1.streamStatsSchema.parse(res.data);
     }
+    async getSrtStreamStatistics(streamId, options) {
+        const res = await this._getJson(`${BASE_PATH}/srt_statistics.cgi`, { stream_id: streamId }, options);
+        return CamStreamerAPI_1.srtStreamStatisticsSchema.parse(res.data);
+    }
     async setStreamEnabled(streamId, enabled, options) {
         await this._postUrlEncoded(`${BASE_PATH}/set_stream_enabled.cgi`, { stream_id: streamId, enabled: enabled ? 1 : 0 }, options);
     }

package/cjs/VapixAPI.d.ts

@@ -1,4 +1,4 @@
-import { IClient, TResponse } from './internal/types';
+import { IClient, TParameters, TResponse } from './internal/types';
 import { TAudioDevice, TPortSetSchema, TPortSequenceStateSchema } from './types/VapixAPI';
 import { TCameraImageConfig, THttpRequestOptions } from './types/common';
 import { BasicAPI } from './internal/BasicAPI';
@@ -8,6 +8,7 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> extends Ba
         new (form?: HTMLFormElement | undefined, submitter?: HTMLElement | null | undefined): FormData;
         prototype: FormData;
     });
+    postUrlEncoded(path: string, parameters?: TParameters, headers?: Record<string, string>, options?: THttpRequestOptions): Promise<TResponse>;
     postJson: (path: string, data: Record<string, any>, headers?: Record<string, string>, options?: THttpRequestOptions) => Promise<TResponse>;
     getCameraImage(parameters: TCameraImageConfig, options?: THttpRequestOptions): Promise<ReturnType<Client["get"]>>;
     getEventDeclarations(options?: THttpRequestOptions): Promise<string>;

package/cjs/VapixAPI.js

@@ -13,6 +13,16 @@ class VapixAPI extends BasicAPI_1.BasicAPI {
         super(client);
         this.CustomFormData = CustomFormData;
     }
+    async postUrlEncoded(path, parameters, headers, options) {
+        const data = (0, utils_1.paramToUrl)(parameters);
+        const head = { ...headers, 'Content-Type': 'application/x-www-form-urlencoded' };
+        const agent = this.getClient(options?.proxyParams);
+        const res = await agent.post({ path, data, headers: head, timeout: options?.timeout });
+        if (!res.ok) {
+            throw new errors_1.ErrorWithResponse(res);
+        }
+        return res;
+    }
     postJson = async (path, data, headers, options) => {
         const agent = this.getClient(options?.proxyParams);
         const jsonData = JSON.stringify(data);
@@ -22,12 +32,10 @@ class VapixAPI extends BasicAPI_1.BasicAPI {
             headers: { ...headers, 'Content-Type': 'application/json' },
             timeout: options?.timeout,
         });
-        if (res.ok) {
-            return res;
-        }
-        else {
+        if (!res.ok) {
             throw new errors_1.ErrorWithResponse(res);
         }
+        return res;
     };
     async getCameraImage(parameters, options) {
         const agent = this.getClient(options?.proxyParams);

package/cjs/internal/BasicAPI.js

@@ -70,12 +70,10 @@ class BasicAPI {
             headers: { 'Content-Type': 'application/json' },
             timeout: options?.timeout,
         });
-        if (res.ok) {
-            return res;
-        }
-        else {
+        if (!res.ok) {
             throw new errors_1.ErrorWithResponse(res);
         }
+        return res;
     }
     async _postUrlEncoded(path, data, options) {
         const encodedData = (0, utils_1.paramToUrl)(data);
@@ -86,12 +84,10 @@ class BasicAPI {
             headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
             timeout: options?.timeout,
         });
-        if (res.ok) {
-            return res;
-        }
-        else {
+        if (!res.ok) {
             throw new errors_1.ErrorWithResponse(res);
         }
+        return res;
     }
 }
 exports.BasicAPI = BasicAPI;

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

@@ -22301,18 +22301,59 @@ export declare const streamStatsSchema: z.ZodObject<{
     stream_bytes_time_ms: z.ZodNumber;
     stream_bytes: z.ZodNumber;
     start_count: z.ZodNumber;
-    is_streaming: z.ZodNumber;
+    is_streaming: z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>]>;
 }, "strip", z.ZodTypeAny, {
     net_stats: string;
     stream_bytes_time_ms: number;
     stream_bytes: number;
     start_count: number;
-    is_streaming: number;
+    is_streaming: 0 | 1;
 }, {
     net_stats: string;
     stream_bytes_time_ms: number;
     stream_bytes: number;
     start_count: number;
-    is_streaming: number;
+    is_streaming: 0 | 1;
 }>;
 export type TStreamStats = z.infer<typeof streamStatsSchema>;
+export declare const srtStreamStatisticsSchema: z.ZodObject<{
+    msTimeStamp: z.ZodNumber;
+    pktSentTotal: z.ZodNumber;
+    byteSentTotal: z.ZodNumber;
+    pktRetransTotal: z.ZodNumber;
+    byteRetransTotal: z.ZodNumber;
+    pktSndDropTotal: z.ZodNumber;
+    byteSndDropTotal: z.ZodNumber;
+    mbpsSendRate: z.ZodNumber;
+    mbpsBandwidth: z.ZodNumber;
+    mbpsMaxBW: z.ZodNumber;
+    msRTT: z.ZodNumber;
+    msSndBuf: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    msTimeStamp: number;
+    pktSentTotal: number;
+    byteSentTotal: number;
+    pktRetransTotal: number;
+    byteRetransTotal: number;
+    pktSndDropTotal: number;
+    byteSndDropTotal: number;
+    mbpsSendRate: number;
+    mbpsBandwidth: number;
+    mbpsMaxBW: number;
+    msRTT: number;
+    msSndBuf: number;
+}, {
+    msTimeStamp: number;
+    pktSentTotal: number;
+    byteSentTotal: number;
+    pktRetransTotal: number;
+    byteRetransTotal: number;
+    pktSndDropTotal: number;
+    byteSndDropTotal: number;
+    mbpsSendRate: number;
+    mbpsBandwidth: number;
+    mbpsMaxBW: number;
+    msRTT: number;
+    msSndBuf: number;
+}>;
+export type TSrtStreamStatistics = z.infer<typeof srtStreamStatisticsSchema>;

package/cjs/types/CamStreamerAPI/CamStreamerAPI.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.streamStatsSchema = exports.audioLocalSchema = exports.audioUrlSchema = exports.audioFileListSchema = exports.audioFileSchema = exports.storageListSchema = exports.audioFileStorageTypeSchema = exports.AudioType = exports.isYoutubeRtmpStream = exports.isGameChangerStream = exports.isMicrosoftStream = exports.isMicrosoftAzureStream = exports.isIbmStream = exports.isDailymotionStream = exports.isWowzaStream = exports.isHlsPushStream = exports.isHlsPullStream = exports.isDaCastStream = exports.isSrtStream = exports.isChurchStream = exports.isTwitchStream = exports.isVimeoStream = exports.isYouTubeStream = exports.isWindyStream = exports.isSdCardStream = exports.isRtmpStream = exports.isMpegDvbStream = exports.isFacebookStream = exports.streamListSchema = exports.streamSchema = void 0;
+exports.srtStreamStatisticsSchema = exports.streamStatsSchema = exports.audioLocalSchema = exports.audioUrlSchema = exports.audioFileListSchema = exports.audioFileSchema = exports.storageListSchema = exports.audioFileStorageTypeSchema = exports.AudioType = exports.isYoutubeRtmpStream = exports.isGameChangerStream = exports.isMicrosoftStream = exports.isMicrosoftAzureStream = exports.isIbmStream = exports.isDailymotionStream = exports.isWowzaStream = exports.isHlsPushStream = exports.isHlsPullStream = exports.isDaCastStream = exports.isSrtStream = exports.isChurchStream = exports.isTwitchStream = exports.isVimeoStream = exports.isYouTubeStream = exports.isWindyStream = exports.isSdCardStream = exports.isRtmpStream = exports.isMpegDvbStream = exports.isFacebookStream = exports.streamListSchema = exports.streamSchema = void 0;
 const zod_1 = require("zod");
 const facebookSchema_1 = require("./facebookSchema");
 const windySchema_1 = require("./windySchema");
@@ -144,8 +144,22 @@ exports.audioLocalSchema = zod_1.z.object({
 });
 exports.streamStatsSchema = zod_1.z.object({
     net_stats: zod_1.z.string(),
-    stream_bytes_time_ms: zod_1.z.number(),
-    stream_bytes: zod_1.z.number(),
-    start_count: zod_1.z.number(),
-    is_streaming: zod_1.z.number(),
+    stream_bytes_time_ms: zod_1.z.number().nonnegative(),
+    stream_bytes: zod_1.z.number().nonnegative(),
+    start_count: zod_1.z.number().nonnegative(),
+    is_streaming: zod_1.z.literal(0).or(zod_1.z.literal(1)),
+});
+exports.srtStreamStatisticsSchema = zod_1.z.object({
+    msTimeStamp: zod_1.z.number().nonnegative(),
+    pktSentTotal: zod_1.z.number().nonnegative(),
+    byteSentTotal: zod_1.z.number().nonnegative(),
+    pktRetransTotal: zod_1.z.number().nonnegative(),
+    byteRetransTotal: zod_1.z.number().nonnegative(),
+    pktSndDropTotal: zod_1.z.number().nonnegative(),
+    byteSndDropTotal: zod_1.z.number().nonnegative(),
+    mbpsSendRate: zod_1.z.number().nonnegative(),
+    mbpsBandwidth: zod_1.z.number().nonnegative(),
+    mbpsMaxBW: zod_1.z.number().nonnegative(),
+    msRTT: zod_1.z.number().nonnegative(),
+    msSndBuf: zod_1.z.number().nonnegative(),
 });

package/esm/CamStreamerAPI.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { audioFileListSchema, storageListSchema, streamSchema, streamStatsSchema, } from './types/CamStreamerAPI/CamStreamerAPI';
+import { audioFileListSchema, srtStreamStatisticsSchema, storageListSchema, streamSchema, streamStatsSchema, } from './types/CamStreamerAPI/CamStreamerAPI';
 import { UtcTimeFetchError, WsAuthorizationError, MigrationError } from './errors/errors';
 import { oldStringStreamSchema, oldStringStreamSchemaWithId, } from './types/CamStreamerAPI/oldStreamSchema';
 import { BasicAPI } from './internal/BasicAPI';
@@ -88,10 +88,14 @@ export class CamStreamerAPI extends BasicAPI {
             stream_id: streamId,
         }, options);
     }
-    async getStreamStats(streamId, options) {
+    async getStreamNetworkStatistics(streamId, options) {
         const res = await this._getJson(`${BASE_PATH}/get_streamstat.cgi`, { stream_id: streamId }, options);
         return streamStatsSchema.parse(res.data);
     }
+    async getSrtStreamStatistics(streamId, options) {
+        const res = await this._getJson(`${BASE_PATH}/srt_statistics.cgi`, { stream_id: streamId }, options);
+        return srtStreamStatisticsSchema.parse(res.data);
+    }
     async setStreamEnabled(streamId, enabled, options) {
         await this._postUrlEncoded(`${BASE_PATH}/set_stream_enabled.cgi`, { stream_id: streamId, enabled: enabled ? 1 : 0 }, options);
     }

package/esm/VapixAPI.js

@@ -1,4 +1,4 @@
-import { arrayToUrl, isNullish } from './internal/utils';
+import { arrayToUrl, isNullish, paramToUrl } from './internal/utils';
 import { sdCardWatchedStatuses, APP_IDS, maxFpsResponseSchema, dateTimeinfoSchema, audioDeviceRequestSchema, audioSampleRatesResponseSchema, timeZoneSchema, getPortsResponseSchema, guardTourSchema, ptzOverviewSchema, cameraPTZItemDataSchema, applicationListSchema, sdCardInfoSchema, } from './types/VapixAPI';
 import { ApplicationAPIError, MaxFPSError, NoDeviceInfoError, PtzNotSupportedError, ErrorWithResponse, SDCardActionError, SDCardJobError, SettingParameterError, TimezoneFetchError, TimezoneNotSetupError, } from './errors/errors';
 import { z } from 'zod';
@@ -10,6 +10,16 @@ export class VapixAPI extends BasicAPI {
         super(client);
         this.CustomFormData = CustomFormData;
     }
+    async postUrlEncoded(path, parameters, headers, options) {
+        const data = paramToUrl(parameters);
+        const head = { ...headers, 'Content-Type': 'application/x-www-form-urlencoded' };
+        const agent = this.getClient(options?.proxyParams);
+        const res = await agent.post({ path, data, headers: head, timeout: options?.timeout });
+        if (!res.ok) {
+            throw new ErrorWithResponse(res);
+        }
+        return res;
+    }
     postJson = async (path, data, headers, options) => {
         const agent = this.getClient(options?.proxyParams);
         const jsonData = JSON.stringify(data);
@@ -19,12 +29,10 @@ export class VapixAPI extends BasicAPI {
             headers: { ...headers, 'Content-Type': 'application/json' },
             timeout: options?.timeout,
         });
-        if (res.ok) {
-            return res;
-        }
-        else {
+        if (!res.ok) {
             throw new ErrorWithResponse(res);
         }
+        return res;
     };
     async getCameraImage(parameters, options) {
         const agent = this.getClient(options?.proxyParams);

package/esm/internal/BasicAPI.js

@@ -67,12 +67,10 @@ export class BasicAPI {
             headers: { 'Content-Type': 'application/json' },
             timeout: options?.timeout,
         });
-        if (res.ok) {
-            return res;
-        }
-        else {
+        if (!res.ok) {
             throw new ErrorWithResponse(res);
         }
+        return res;
     }
     async _postUrlEncoded(path, data, options) {
         const encodedData = paramToUrl(data);
@@ -83,11 +81,9 @@ export class BasicAPI {
             headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
             timeout: options?.timeout,
         });
-        if (res.ok) {
-            return res;
-        }
-        else {
+        if (!res.ok) {
             throw new ErrorWithResponse(res);
         }
+        return res;
     }
 }

package/esm/types/CamStreamerAPI/CamStreamerAPI.js

@@ -121,8 +121,22 @@ export const audioLocalSchema = z.object({
 });
 export const streamStatsSchema = z.object({
     net_stats: z.string(),
-    stream_bytes_time_ms: z.number(),
-    stream_bytes: z.number(),
-    start_count: z.number(),
-    is_streaming: z.number(),
+    stream_bytes_time_ms: z.number().nonnegative(),
+    stream_bytes: z.number().nonnegative(),
+    start_count: z.number().nonnegative(),
+    is_streaming: z.literal(0).or(z.literal(1)),
+});
+export const srtStreamStatisticsSchema = z.object({
+    msTimeStamp: z.number().nonnegative(),
+    pktSentTotal: z.number().nonnegative(),
+    byteSentTotal: z.number().nonnegative(),
+    pktRetransTotal: z.number().nonnegative(),
+    byteRetransTotal: z.number().nonnegative(),
+    pktSndDropTotal: z.number().nonnegative(),
+    byteSndDropTotal: z.number().nonnegative(),
+    mbpsSendRate: z.number().nonnegative(),
+    mbpsBandwidth: z.number().nonnegative(),
+    mbpsMaxBW: z.number().nonnegative(),
+    msRTT: z.number().nonnegative(),
+    msSndBuf: z.number().nonnegative(),
 });

package/package.json

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

package/types/CamStreamerAPI.d.ts

@@ -3110,12 +3110,26 @@ export declare class CamStreamerAPI<Client extends IClient<TResponse, any>> exte
         streamIdentifier?: string | undefined;
     }>;
     setStream(streamId: string, streamData: TStream, options?: THttpRequestOptions): Promise<void>;
-    getStreamStats(streamId: number, options?: THttpRequestOptions): Promise<{
+    getStreamNetworkStatistics(streamId: string, options?: THttpRequestOptions): Promise<{
         net_stats: string;
         stream_bytes_time_ms: number;
         stream_bytes: number;
         start_count: number;
-        is_streaming: number;
+        is_streaming: 0 | 1;
+    }>;
+    getSrtStreamStatistics(streamId: string, options?: THttpRequestOptions): Promise<{
+        msTimeStamp: number;
+        pktSentTotal: number;
+        byteSentTotal: number;
+        pktRetransTotal: number;
+        byteRetransTotal: number;
+        pktSndDropTotal: number;
+        byteSndDropTotal: number;
+        mbpsSendRate: number;
+        mbpsBandwidth: number;
+        mbpsMaxBW: number;
+        msRTT: number;
+        msSndBuf: number;
     }>;
     setStreamEnabled(streamId: string, enabled: boolean, options?: THttpRequestOptions): Promise<void>;
     setStreamActive(streamId: string, active: boolean, options?: THttpRequestOptions): Promise<void>;

package/types/VapixAPI.d.ts

@@ -1,4 +1,4 @@
-import { IClient, TResponse } from './internal/types';
+import { IClient, TParameters, TResponse } from './internal/types';
 import { TAudioDevice, TPortSetSchema, TPortSequenceStateSchema } from './types/VapixAPI';
 import { TCameraImageConfig, THttpRequestOptions } from './types/common';
 import { BasicAPI } from './internal/BasicAPI';
@@ -8,6 +8,7 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> extends Ba
         new (form?: HTMLFormElement | undefined, submitter?: HTMLElement | null | undefined): FormData;
         prototype: FormData;
     });
+    postUrlEncoded(path: string, parameters?: TParameters, headers?: Record<string, string>, options?: THttpRequestOptions): Promise<TResponse>;
     postJson: (path: string, data: Record<string, any>, headers?: Record<string, string>, options?: THttpRequestOptions) => Promise<TResponse>;
     getCameraImage(parameters: TCameraImageConfig, options?: THttpRequestOptions): Promise<ReturnType<Client["get"]>>;
     getEventDeclarations(options?: THttpRequestOptions): Promise<string>;

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

@@ -22301,18 +22301,59 @@ export declare const streamStatsSchema: z.ZodObject<{
     stream_bytes_time_ms: z.ZodNumber;
     stream_bytes: z.ZodNumber;
     start_count: z.ZodNumber;
-    is_streaming: z.ZodNumber;
+    is_streaming: z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>]>;
 }, "strip", z.ZodTypeAny, {
     net_stats: string;
     stream_bytes_time_ms: number;
     stream_bytes: number;
     start_count: number;
-    is_streaming: number;
+    is_streaming: 0 | 1;
 }, {
     net_stats: string;
     stream_bytes_time_ms: number;
     stream_bytes: number;
     start_count: number;
-    is_streaming: number;
+    is_streaming: 0 | 1;
 }>;
 export type TStreamStats = z.infer<typeof streamStatsSchema>;
+export declare const srtStreamStatisticsSchema: z.ZodObject<{
+    msTimeStamp: z.ZodNumber;
+    pktSentTotal: z.ZodNumber;
+    byteSentTotal: z.ZodNumber;
+    pktRetransTotal: z.ZodNumber;
+    byteRetransTotal: z.ZodNumber;
+    pktSndDropTotal: z.ZodNumber;
+    byteSndDropTotal: z.ZodNumber;
+    mbpsSendRate: z.ZodNumber;
+    mbpsBandwidth: z.ZodNumber;
+    mbpsMaxBW: z.ZodNumber;
+    msRTT: z.ZodNumber;
+    msSndBuf: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    msTimeStamp: number;
+    pktSentTotal: number;
+    byteSentTotal: number;
+    pktRetransTotal: number;
+    byteRetransTotal: number;
+    pktSndDropTotal: number;
+    byteSndDropTotal: number;
+    mbpsSendRate: number;
+    mbpsBandwidth: number;
+    mbpsMaxBW: number;
+    msRTT: number;
+    msSndBuf: number;
+}, {
+    msTimeStamp: number;
+    pktSentTotal: number;
+    byteSentTotal: number;
+    pktRetransTotal: number;
+    byteRetransTotal: number;
+    pktSndDropTotal: number;
+    byteSndDropTotal: number;
+    mbpsSendRate: number;
+    mbpsBandwidth: number;
+    mbpsMaxBW: number;
+    msRTT: number;
+    msSndBuf: number;
+}>;
+export type TSrtStreamStatistics = z.infer<typeof srtStreamStatisticsSchema>;