camstreamerlib 4.0.0-beta.97 → 4.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (218) hide show
  1. package/README.md +44 -15
  2. package/cjs/CamOverlayAPI.d.ts +147 -109
  3. package/cjs/CamOverlayAPI.js +14 -63
  4. package/cjs/CamScripterAPI.d.ts +5 -8
  5. package/cjs/CamScripterAPI.js +11 -29
  6. package/cjs/CamStreamerAPI.d.ts +2745 -589
  7. package/cjs/CamStreamerAPI.js +68 -76
  8. package/cjs/CamSwitcherAPI.d.ts +23 -22
  9. package/cjs/CamSwitcherAPI.js +30 -88
  10. package/cjs/PlaneTrackerAPI.d.ts +28 -30
  11. package/cjs/PlaneTrackerAPI.js +20 -75
  12. package/cjs/VapixAPI.d.ts +36 -23
  13. package/cjs/VapixAPI.js +227 -106
  14. package/cjs/errors/errors.d.ts +11 -5
  15. package/cjs/errors/errors.js +5 -1
  16. package/cjs/index.d.ts +1 -0
  17. package/cjs/index.js +1 -0
  18. package/cjs/internal/BasicAPI.d.ts +15 -0
  19. package/cjs/internal/BasicAPI.js +93 -0
  20. package/cjs/internal/WsEvents.d.ts +1 -0
  21. package/cjs/internal/WsEvents.js +5 -0
  22. package/cjs/internal/constants.d.ts +1 -0
  23. package/cjs/internal/constants.js +2 -1
  24. package/cjs/internal/convertors.d.ts +6 -0
  25. package/cjs/internal/convertors.js +115 -0
  26. package/cjs/internal/transformers.js +8 -8
  27. package/cjs/internal/types.d.ts +3 -0
  28. package/cjs/internal/versionCompare.d.ts +2 -2
  29. package/cjs/types/CamOverlayAPI/CamOverlayAPI.d.ts +894 -374
  30. package/cjs/types/CamOverlayAPI/CamOverlayAPI.js +54 -11
  31. package/cjs/types/CamOverlayAPI/accuweatherSchema.d.ts +10 -10
  32. package/cjs/types/CamOverlayAPI/customGraphicsSchema.d.ts +40 -40
  33. package/cjs/types/CamOverlayAPI/htmlOverlaySchema.d.ts +81 -0
  34. package/cjs/types/CamOverlayAPI/htmlOverlaySchema.js +21 -0
  35. package/cjs/types/CamOverlayAPI/imagesSchema.d.ts +10 -10
  36. package/cjs/types/CamOverlayAPI/index.d.ts +1 -0
  37. package/cjs/types/CamOverlayAPI/index.js +1 -0
  38. package/cjs/types/CamOverlayAPI/infotickerSchema.d.ts +8 -8
  39. package/cjs/types/CamOverlayAPI/pipSchema.d.ts +8 -8
  40. package/cjs/types/CamOverlayAPI/ptzCompassSchema.d.ts +10 -10
  41. package/cjs/types/CamOverlayAPI/ptzSchema.d.ts +13 -13
  42. package/cjs/types/CamOverlayAPI/scoreBoardSchema.d.ts +18 -18
  43. package/cjs/types/CamOverlayAPI/screenSharingSchema.d.ts +8 -8
  44. package/cjs/types/CamOverlayAPI/serviceCommonTypes.d.ts +17 -16
  45. package/cjs/types/CamOverlayAPI/serviceCommonTypes.js +6 -3
  46. package/cjs/types/CamOverlayAPI/webCameraSharingSchema.d.ts +8 -8
  47. package/cjs/types/CamScripterAPI.d.ts +0 -11
  48. package/cjs/types/CamScripterAPI.js +1 -5
  49. package/cjs/types/CamStreamerAPI/CamStreamerAPI.d.ts +19642 -3073
  50. package/cjs/types/CamStreamerAPI/CamStreamerAPI.js +126 -57
  51. package/cjs/types/CamStreamerAPI/facebookSchema.d.ts +434 -52
  52. package/cjs/types/CamStreamerAPI/facebookSchema.js +13 -1
  53. package/cjs/types/CamStreamerAPI/index.d.ts +1 -3
  54. package/cjs/types/CamStreamerAPI/index.js +1 -3
  55. package/cjs/types/CamStreamerAPI/oldStreamSchema.d.ts +47 -47
  56. package/cjs/types/CamStreamerAPI/oldStreamSchema.js +1 -1
  57. package/cjs/types/CamStreamerAPI/streamCommonTypes.d.ts +430 -219
  58. package/cjs/types/CamStreamerAPI/streamCommonTypes.js +116 -58
  59. package/cjs/types/CamStreamerAPI/streamsSchema.d.ts +8812 -0
  60. package/cjs/types/CamStreamerAPI/streamsSchema.js +81 -0
  61. package/cjs/types/CamStreamerAPI/windySchema.d.ts +394 -52
  62. package/cjs/types/CamStreamerAPI/windySchema.js +9 -1
  63. package/cjs/types/CamStreamerAPI/youtubeSchema.d.ts +402 -52
  64. package/cjs/types/CamStreamerAPI/youtubeSchema.js +12 -1
  65. package/cjs/types/CamSwitcherAPI.d.ts +96 -91
  66. package/cjs/types/CamSwitcherAPI.js +9 -9
  67. package/cjs/types/GenetecAgent.d.ts +2 -2
  68. package/cjs/types/PlaneTrackerAPI.d.ts +60 -47
  69. package/cjs/types/PlaneTrackerAPI.js +5 -2
  70. package/cjs/types/VapixAPI.d.ts +51 -32
  71. package/cjs/types/VapixAPI.js +10 -3
  72. package/cjs/types/common.d.ts +27 -0
  73. package/cjs/types/common.js +13 -1
  74. package/cjs/types/ws/CamStreamerEvents.d.ts +110 -77
  75. package/cjs/types/ws/CamStreamerEvents.js +11 -7
  76. package/cjs/types/ws/CamSwitcherEvents.d.ts +8 -8
  77. package/cjs/types/ws/PlaneTrackerEvents.d.ts +3 -3
  78. package/esm/CamOverlayAPI.js +16 -65
  79. package/esm/CamScripterAPI.js +9 -30
  80. package/esm/CamStreamerAPI.js +70 -78
  81. package/esm/CamSwitcherAPI.js +31 -89
  82. package/esm/PlaneTrackerAPI.js +21 -76
  83. package/esm/VapixAPI.js +228 -107
  84. package/esm/errors/errors.js +5 -1
  85. package/esm/index.js +1 -0
  86. package/esm/internal/BasicAPI.js +89 -0
  87. package/esm/internal/WsEvents.js +5 -0
  88. package/esm/internal/constants.js +1 -0
  89. package/esm/internal/convertors.js +108 -0
  90. package/esm/internal/transformers.js +1 -1
  91. package/esm/types/CamOverlayAPI/CamOverlayAPI.js +47 -10
  92. package/esm/types/CamOverlayAPI/htmlOverlaySchema.js +18 -0
  93. package/esm/types/CamOverlayAPI/index.js +1 -0
  94. package/esm/types/CamOverlayAPI/serviceCommonTypes.js +6 -3
  95. package/esm/types/CamScripterAPI.js +0 -4
  96. package/esm/types/CamStreamerAPI/CamStreamerAPI.js +109 -41
  97. package/esm/types/CamStreamerAPI/facebookSchema.js +13 -1
  98. package/esm/types/CamStreamerAPI/index.js +1 -3
  99. package/esm/types/CamStreamerAPI/oldStreamSchema.js +1 -1
  100. package/esm/types/CamStreamerAPI/streamCommonTypes.js +116 -58
  101. package/esm/types/CamStreamerAPI/streamsSchema.js +75 -0
  102. package/esm/types/CamStreamerAPI/windySchema.js +9 -1
  103. package/esm/types/CamStreamerAPI/youtubeSchema.js +12 -1
  104. package/esm/types/CamSwitcherAPI.js +8 -8
  105. package/esm/types/PlaneTrackerAPI.js +5 -2
  106. package/esm/types/VapixAPI.js +9 -2
  107. package/esm/types/common.js +12 -0
  108. package/esm/types/ws/CamStreamerEvents.js +11 -7
  109. package/package.json +4 -4
  110. package/types/CamOverlayAPI.d.ts +147 -109
  111. package/types/CamScripterAPI.d.ts +5 -8
  112. package/types/CamStreamerAPI.d.ts +2745 -589
  113. package/types/CamSwitcherAPI.d.ts +23 -22
  114. package/types/PlaneTrackerAPI.d.ts +28 -30
  115. package/types/VapixAPI.d.ts +36 -23
  116. package/types/errors/errors.d.ts +11 -5
  117. package/types/index.d.ts +1 -0
  118. package/types/internal/BasicAPI.d.ts +15 -0
  119. package/types/internal/WsEvents.d.ts +1 -0
  120. package/types/internal/constants.d.ts +1 -0
  121. package/types/internal/convertors.d.ts +6 -0
  122. package/types/internal/types.d.ts +3 -0
  123. package/types/internal/versionCompare.d.ts +2 -2
  124. package/types/types/CamOverlayAPI/CamOverlayAPI.d.ts +894 -374
  125. package/types/types/CamOverlayAPI/accuweatherSchema.d.ts +10 -10
  126. package/types/types/CamOverlayAPI/customGraphicsSchema.d.ts +40 -40
  127. package/types/types/CamOverlayAPI/htmlOverlaySchema.d.ts +81 -0
  128. package/types/types/CamOverlayAPI/imagesSchema.d.ts +10 -10
  129. package/types/types/CamOverlayAPI/index.d.ts +1 -0
  130. package/types/types/CamOverlayAPI/infotickerSchema.d.ts +8 -8
  131. package/types/types/CamOverlayAPI/pipSchema.d.ts +8 -8
  132. package/types/types/CamOverlayAPI/ptzCompassSchema.d.ts +10 -10
  133. package/types/types/CamOverlayAPI/ptzSchema.d.ts +13 -13
  134. package/types/types/CamOverlayAPI/scoreBoardSchema.d.ts +18 -18
  135. package/types/types/CamOverlayAPI/screenSharingSchema.d.ts +8 -8
  136. package/types/types/CamOverlayAPI/serviceCommonTypes.d.ts +17 -16
  137. package/types/types/CamOverlayAPI/webCameraSharingSchema.d.ts +8 -8
  138. package/types/types/CamScripterAPI.d.ts +0 -11
  139. package/types/types/CamStreamerAPI/CamStreamerAPI.d.ts +19642 -3073
  140. package/types/types/CamStreamerAPI/facebookSchema.d.ts +434 -52
  141. package/types/types/CamStreamerAPI/index.d.ts +1 -3
  142. package/types/types/CamStreamerAPI/oldStreamSchema.d.ts +47 -47
  143. package/types/types/CamStreamerAPI/streamCommonTypes.d.ts +430 -219
  144. package/types/types/CamStreamerAPI/streamsSchema.d.ts +8812 -0
  145. package/types/types/CamStreamerAPI/windySchema.d.ts +394 -52
  146. package/types/types/CamStreamerAPI/youtubeSchema.d.ts +402 -52
  147. package/types/types/CamSwitcherAPI.d.ts +96 -91
  148. package/types/types/GenetecAgent.d.ts +2 -2
  149. package/types/types/PlaneTrackerAPI.d.ts +60 -47
  150. package/types/types/VapixAPI.d.ts +51 -32
  151. package/types/types/common.d.ts +27 -0
  152. package/types/types/ws/CamStreamerEvents.d.ts +110 -77
  153. package/types/types/ws/CamSwitcherEvents.d.ts +8 -8
  154. package/types/types/ws/PlaneTrackerEvents.d.ts +3 -3
  155. package/cjs/types/CamStreamerAPI/churchSchema.d.ts +0 -202
  156. package/cjs/types/CamStreamerAPI/churchSchema.js +0 -11
  157. package/cjs/types/CamStreamerAPI/daCastSchema.d.ts +0 -202
  158. package/cjs/types/CamStreamerAPI/daCastSchema.js +0 -11
  159. package/cjs/types/CamStreamerAPI/dailymotionSchema.d.ts +0 -202
  160. package/cjs/types/CamStreamerAPI/dailymotionSchema.js +0 -11
  161. package/cjs/types/CamStreamerAPI/gameChangerSchema.d.ts +0 -202
  162. package/cjs/types/CamStreamerAPI/gameChangerSchema.js +0 -11
  163. package/cjs/types/CamStreamerAPI/hlsPullSchema.d.ts +0 -202
  164. package/cjs/types/CamStreamerAPI/hlsPullSchema.js +0 -11
  165. package/cjs/types/CamStreamerAPI/hlsPushSchema.d.ts +0 -202
  166. package/cjs/types/CamStreamerAPI/hlsPushSchema.js +0 -11
  167. package/cjs/types/CamStreamerAPI/ibmSchema.d.ts +0 -202
  168. package/cjs/types/CamStreamerAPI/ibmSchema.js +0 -11
  169. package/cjs/types/CamStreamerAPI/microsoftAzureSchema.d.ts +0 -202
  170. package/cjs/types/CamStreamerAPI/microsoftAzureSchema.js +0 -11
  171. package/cjs/types/CamStreamerAPI/microsoftStreamSchema.d.ts +0 -202
  172. package/cjs/types/CamStreamerAPI/microsoftStreamSchema.js +0 -11
  173. package/cjs/types/CamStreamerAPI/mpegDvbSchema.d.ts +0 -250
  174. package/cjs/types/CamStreamerAPI/mpegDvbSchema.js +0 -27
  175. package/cjs/types/CamStreamerAPI/rtmpSchema.d.ts +0 -211
  176. package/cjs/types/CamStreamerAPI/rtmpSchema.js +0 -14
  177. package/cjs/types/CamStreamerAPI/sdCardSchema.d.ts +0 -202
  178. package/cjs/types/CamStreamerAPI/sdCardSchema.js +0 -11
  179. package/cjs/types/CamStreamerAPI/srtSchema.d.ts +0 -202
  180. package/cjs/types/CamStreamerAPI/srtSchema.js +0 -11
  181. package/cjs/types/CamStreamerAPI/twitchSchema.d.ts +0 -202
  182. package/cjs/types/CamStreamerAPI/twitchSchema.js +0 -11
  183. package/cjs/types/CamStreamerAPI/vimeoSchema.d.ts +0 -202
  184. package/cjs/types/CamStreamerAPI/vimeoSchema.js +0 -11
  185. package/cjs/types/CamStreamerAPI/wowzaSchema.d.ts +0 -202
  186. package/cjs/types/CamStreamerAPI/wowzaSchema.js +0 -11
  187. package/esm/types/CamStreamerAPI/churchSchema.js +0 -5
  188. package/esm/types/CamStreamerAPI/daCastSchema.js +0 -5
  189. package/esm/types/CamStreamerAPI/dailymotionSchema.js +0 -5
  190. package/esm/types/CamStreamerAPI/gameChangerSchema.js +0 -5
  191. package/esm/types/CamStreamerAPI/hlsPullSchema.js +0 -5
  192. package/esm/types/CamStreamerAPI/hlsPushSchema.js +0 -5
  193. package/esm/types/CamStreamerAPI/ibmSchema.js +0 -5
  194. package/esm/types/CamStreamerAPI/microsoftAzureSchema.js +0 -5
  195. package/esm/types/CamStreamerAPI/microsoftStreamSchema.js +0 -5
  196. package/esm/types/CamStreamerAPI/mpegDvbSchema.js +0 -21
  197. package/esm/types/CamStreamerAPI/rtmpSchema.js +0 -8
  198. package/esm/types/CamStreamerAPI/sdCardSchema.js +0 -5
  199. package/esm/types/CamStreamerAPI/srtSchema.js +0 -5
  200. package/esm/types/CamStreamerAPI/twitchSchema.js +0 -5
  201. package/esm/types/CamStreamerAPI/vimeoSchema.js +0 -5
  202. package/esm/types/CamStreamerAPI/wowzaSchema.js +0 -5
  203. package/types/types/CamStreamerAPI/churchSchema.d.ts +0 -202
  204. package/types/types/CamStreamerAPI/daCastSchema.d.ts +0 -202
  205. package/types/types/CamStreamerAPI/dailymotionSchema.d.ts +0 -202
  206. package/types/types/CamStreamerAPI/gameChangerSchema.d.ts +0 -202
  207. package/types/types/CamStreamerAPI/hlsPullSchema.d.ts +0 -202
  208. package/types/types/CamStreamerAPI/hlsPushSchema.d.ts +0 -202
  209. package/types/types/CamStreamerAPI/ibmSchema.d.ts +0 -202
  210. package/types/types/CamStreamerAPI/microsoftAzureSchema.d.ts +0 -202
  211. package/types/types/CamStreamerAPI/microsoftStreamSchema.d.ts +0 -202
  212. package/types/types/CamStreamerAPI/mpegDvbSchema.d.ts +0 -250
  213. package/types/types/CamStreamerAPI/rtmpSchema.d.ts +0 -211
  214. package/types/types/CamStreamerAPI/sdCardSchema.d.ts +0 -202
  215. package/types/types/CamStreamerAPI/srtSchema.d.ts +0 -202
  216. package/types/types/CamStreamerAPI/twitchSchema.d.ts +0 -202
  217. package/types/types/CamStreamerAPI/vimeoSchema.d.ts +0 -202
  218. package/types/types/CamStreamerAPI/wowzaSchema.d.ts +0 -202
@@ -1,9 +1,8 @@
1
1
  import { IClient, TResponse } from './internal/types';
2
2
  import { TStreamSaveList, TTrackerSaveList, TClipSaveList, TPlaylistSaveList, TCameraOptions, TGlobalAudioSettings, TSecondaryAudioSettings } from './types/CamSwitcherAPI';
3
- import { TAudioChannel, THttpRequestOptions, TProxyParams, TStorageType } from './types/common';
4
- import { ProxyClient } from './internal/ProxyClient';
5
- export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> {
6
- private client;
3
+ import { TAudioChannel, THttpRequestOptions, TStorageType } from './types/common';
4
+ import { BasicAPI } from './internal/BasicAPI';
5
+ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> extends BasicAPI<Client> {
7
6
  private CustomFormData;
8
7
  private vapixAgent;
9
8
  constructor(client: Client, CustomFormData?: {
@@ -13,7 +12,7 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> {
13
12
  static getProxyPath: () => string;
14
13
  static getWsEventsPath: () => string;
15
14
  static getClipPreviewPath: (clipId: string, storage: TStorageType) => string;
16
- getClient(proxyParams?: TProxyParams): Client | ProxyClient<Client>;
15
+ checkAPIAvailable(options?: THttpRequestOptions): Promise<void>;
17
16
  checkCameraTime(options?: THttpRequestOptions): Promise<boolean>;
18
17
  getNetworkCameraList(options?: THttpRequestOptions): Promise<{
19
18
  name: string;
@@ -22,9 +21,9 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> {
22
21
  generateSilence(sampleRate: number, channels: TAudioChannel, options?: THttpRequestOptions): Promise<void>;
23
22
  getMaxFps(source: number, options?: THttpRequestOptions): Promise<number>;
24
23
  getStorageInfo(options?: THttpRequestOptions): Promise<{
24
+ size: number;
25
25
  storage: "FLASH" | "SD_DISK";
26
26
  writable: boolean;
27
- size: number;
28
27
  available: number;
29
28
  }[]>;
30
29
  wsAuthorization(options?: THttpRequestOptions): Promise<string>;
@@ -39,26 +38,26 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> {
39
38
  }>;
40
39
  getStreamSaveList(options?: THttpRequestOptions): Promise<Record<string, {
41
40
  ip?: string | undefined;
41
+ enabled?: boolean | undefined;
42
+ port?: number | undefined;
42
43
  niceName?: string | undefined;
43
44
  mdnsName?: string | undefined;
44
- port?: number | undefined;
45
- enabled?: boolean | undefined;
46
45
  auth?: string | undefined;
47
46
  query?: string | undefined;
48
- channel?: "audio" | "video" | "av" | undefined;
47
+ channel?: "video" | "audio" | "av" | undefined;
49
48
  keyboard?: Record<string, string | null> | undefined;
50
49
  sortIndexOverview?: number | undefined;
51
50
  viewNumber?: number | undefined;
52
51
  }>>;
53
52
  getClipSaveList(options?: THttpRequestOptions): Promise<Record<string, {
54
53
  niceName?: string | undefined;
55
- channel?: "audio" | "video" | "av" | undefined;
54
+ channel?: "video" | "audio" | "av" | undefined;
56
55
  keyboard?: Record<string, string | null> | undefined;
57
56
  sortIndexOverview?: number | undefined;
58
57
  }>>;
59
58
  getPlaylistSaveList(options?: THttpRequestOptions): Promise<Record<string, {
60
59
  niceName?: string | undefined;
61
- channel?: "audio" | "video" | "av" | undefined;
60
+ channel?: "video" | "audio" | "av" | undefined;
62
61
  keyboard?: Record<string, string | null> | undefined;
63
62
  sortIndexOverview?: number | undefined;
64
63
  isFavourite?: boolean | undefined;
@@ -87,16 +86,16 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> {
87
86
  }>>;
88
87
  getTrackerSaveList(options?: THttpRequestOptions): Promise<Record<string, {
89
88
  name?: string | undefined;
90
- channel?: "audio" | "video" | "av" | undefined;
89
+ fps?: number | undefined;
90
+ id?: string | undefined;
91
+ width?: number | undefined;
92
+ height?: number | undefined;
93
+ duration?: number | undefined;
94
+ channel?: "video" | "audio" | "av" | undefined;
91
95
  keyboard?: Record<string, string | null> | undefined;
92
96
  sortIndexOverview?: number | undefined;
93
97
  viewNumber?: number | undefined;
94
- id?: string | undefined;
95
98
  previewId?: string | undefined;
96
- duration?: number | undefined;
97
- width?: number | undefined;
98
- height?: number | undefined;
99
- fps?: number | undefined;
100
99
  motion_history_frames?: number | undefined;
101
100
  include_zone?: number[][] | undefined;
102
101
  include_node_ids?: string[] | undefined;
@@ -123,11 +122,12 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> {
123
122
  removeClip(clipId: string, storage: TStorageType, options?: THttpRequestOptions): Promise<void>;
124
123
  getClipList(options?: THttpRequestOptions): Promise<Record<string, {
125
124
  storage: "FLASH" | "SD_DISK";
125
+ duration: number;
126
126
  stream_list: ({
127
127
  type: "video";
128
+ fps: number;
128
129
  width: number;
129
130
  height: number;
130
- fps: number;
131
131
  sample_rate: number;
132
132
  h264_profile: "high" | "main" | "baseline";
133
133
  h264_level: "4.1";
@@ -138,7 +138,6 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> {
138
138
  sample_rate: number;
139
139
  channel_count: 1 | 2;
140
140
  })[];
141
- duration: number;
142
141
  }>>;
143
142
  setCamSwitchOptions(data: TCameraOptions, cameraFWVersion: string, options?: THttpRequestOptions): Promise<void>;
144
143
  setGlobalAudioSettings(settings: TGlobalAudioSettings, options?: THttpRequestOptions): Promise<void>;
@@ -147,7 +146,7 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> {
147
146
  setPermanentRtspUrlToken(token: string, options?: THttpRequestOptions): Promise<void>;
148
147
  getCamSwitchOptions(options?: THttpRequestOptions): Promise<any>;
149
148
  getGlobalAudioSettings(options?: THttpRequestOptions): Promise<{
150
- type: "fromSource" | "source";
149
+ type: "source" | "fromSource";
151
150
  source: string;
152
151
  storage?: string | undefined;
153
152
  }>;
@@ -160,8 +159,10 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> {
160
159
  clipName?: string | undefined;
161
160
  }>;
162
161
  getPermanentRtspUrlToken(options?: THttpRequestOptions): Promise<string>;
163
- private _getJson;
164
- private _post;
162
+ downloadReport(options?: THttpRequestOptions): Promise<string>;
165
163
  private setParamFromCameraJSON;
166
164
  private getParamFromCameraAndJSONParse;
165
+ getUploadedFileList(clipName: string, storage: TStorageType, options?: THttpRequestOptions): Promise<string[]>;
166
+ downloadClipFile(fileName: string, storage: TStorageType, options?: THttpRequestOptions): Promise<ReturnType<Awaited<ReturnType<Client["get"]>>["blob"]>>;
167
+ uploadClipFiles(files: File[], storage: TStorageType, options?: THttpRequestOptions): Promise<void>;
167
168
  }
@@ -1,16 +1,15 @@
1
- import { IClient, TBlobResponse, TParameters, TResponse } from './internal/types';
1
+ import { IClient, TParameters, TResponse } from './internal/types';
2
2
  import { ICAO, TApiUser, TBlackList, TCameraSettings, TExportDataType, TGetIcaoByOption, TImportDataType, TPriorityList, TTrackingMode, TTypePriorityList, TWhiteList, TZones } from './types/PlaneTrackerAPI';
3
- import { THttpRequestOptions, TProxyParams } from './types/common';
4
- import { ProxyClient } from './internal/ProxyClient';
5
- export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
6
- private client;
3
+ import { THttpRequestOptions } from './types/common';
4
+ import { BasicAPI } from './internal/BasicAPI';
5
+ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> extends BasicAPI<Client> {
7
6
  private apiUser;
8
7
  constructor(client: Client, apiUser: TApiUser);
9
8
  static getProxyPath: () => string;
10
9
  static getWsEventsPath: () => string;
11
- getClient(proxyParams?: TProxyParams): Client | ProxyClient<Client>;
10
+ checkAPIAvailable(options?: THttpRequestOptions): Promise<void>;
12
11
  checkCameraTime(options?: THttpRequestOptions): Promise<boolean>;
13
- serverRunCheck(options?: THttpRequestOptions): Promise<TResponse>;
12
+ serverRunCheck(options?: THttpRequestOptions): Promise<boolean>;
14
13
  getLiveViewAlias(rtspUrl: string, options?: THttpRequestOptions): Promise<{
15
14
  ws: string;
16
15
  ws_initial_message: string;
@@ -22,11 +21,12 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
22
21
  camera: {
23
22
  ip: string;
24
23
  port: number;
25
- protocol: "https" | "http" | "https_insecure";
26
- user: string;
27
24
  pass: string;
25
+ user: string;
26
+ protocol: "https" | "http" | "https_insecure";
28
27
  };
29
28
  units: "metric" | "imperial";
29
+ trackingDomain: "adsb" | "dronetag";
30
30
  adsbSource: {
31
31
  ip: string;
32
32
  port: number;
@@ -84,8 +84,8 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
84
84
  };
85
85
  radarcapeFlightInfoSource: {
86
86
  ip: string;
87
- port: number;
88
87
  enabled: boolean;
88
+ port: number;
89
89
  priority: number;
90
90
  };
91
91
  identificationLabel: {
@@ -97,22 +97,22 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
97
97
  };
98
98
  acs: {
99
99
  ip: string;
100
- port: number;
101
100
  enabled: boolean;
102
- protocol: "https" | "http" | "https_insecure";
103
- user: string;
101
+ port: number;
104
102
  pass: string;
103
+ user: string;
104
+ protocol: "https" | "http" | "https_insecure";
105
105
  sourceKey: string;
106
106
  };
107
107
  genetec: {
108
108
  ip: string;
109
- port: number;
110
109
  enabled: boolean;
110
+ port: number;
111
111
  cameraList: string[];
112
+ pass: string;
112
113
  appId: string;
113
- protocol: "https" | "http" | "https_insecure";
114
114
  user: string;
115
- pass: string;
115
+ protocol: "https" | "http" | "https_insecure";
116
116
  baseUri: string;
117
117
  };
118
118
  camstreamerIntegration: {
@@ -132,18 +132,20 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
132
132
  displayPTError?: boolean | undefined;
133
133
  displayPTZSpeed?: boolean | undefined;
134
134
  displayVelocityData?: boolean | undefined;
135
+ displayAdsbVelocityData?: boolean | undefined;
135
136
  displaySignalQuality?: boolean | undefined;
136
137
  displayAutoTrackingInfo?: boolean | undefined;
137
138
  displayGPSCoords?: boolean | undefined;
138
139
  displayVapixQuery?: boolean | undefined;
139
140
  displayFocus?: boolean | undefined;
140
141
  displayAperture?: boolean | undefined;
142
+ displayAircraftInfo?: boolean | undefined;
141
143
  displaySunDistance?: boolean | undefined;
142
144
  displayTickTime?: boolean | undefined;
143
- displayAircraftInfo?: boolean | undefined;
145
+ displaySystemInfo?: boolean | undefined;
144
146
  } | undefined;
145
147
  }>;
146
- setCameraSettings(settings: TCameraSettings, options?: THttpRequestOptions): Promise<TResponse>;
148
+ setCameraSettings(settings: TCameraSettings, options?: THttpRequestOptions): Promise<void>;
147
149
  fetchServerSettings(options?: THttpRequestOptions): Promise<{
148
150
  cameraCalibration: {
149
151
  posLat: number;
@@ -162,7 +164,7 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
162
164
  }[];
163
165
  };
164
166
  }>;
165
- exportAppSettings(dataType: TExportDataType, options?: THttpRequestOptions): Promise<TBlobResponse<Client>>;
167
+ exportAppSettings(dataType: TExportDataType, options?: THttpRequestOptions): Promise<ReturnType<Awaited<ReturnType<Client["get"]>>["blob"]>>;
166
168
  importAppSettings(dataType: TImportDataType, formData: Parameters<Client['post']>[0]['data'], options?: THttpRequestOptions): Promise<void>;
167
169
  fetchFlightInfo(icao: ICAO, options?: THttpRequestOptions): Promise<{
168
170
  destinationAirport: {
@@ -193,13 +195,13 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
193
195
  stopTrackingPlane(options?: THttpRequestOptions): Promise<void>;
194
196
  getIcao(by: TGetIcaoByOption, value: string, options?: THttpRequestOptions): Promise<string>;
195
197
  getPriorityList(options?: THttpRequestOptions): Promise<string[]>;
196
- setPriorityList(priorityList: TPriorityList['priorityList'], options?: THttpRequestOptions): Promise<TResponse>;
198
+ setPriorityList(priorityList: TPriorityList['priorityList'], options?: THttpRequestOptions): Promise<void>;
197
199
  getTypePriorityList(options?: THttpRequestOptions): Promise<string[]>;
198
- setTypePriorityList(typePriorityList: TTypePriorityList['typePriorityList'], options?: THttpRequestOptions): Promise<TResponse>;
200
+ setTypePriorityList(typePriorityList: TTypePriorityList['typePriorityList'], options?: THttpRequestOptions): Promise<void>;
199
201
  getWhiteList(options?: THttpRequestOptions): Promise<string[]>;
200
- setWhiteList(whiteList: TWhiteList['whiteList'], options?: THttpRequestOptions): Promise<TResponse>;
202
+ setWhiteList(whiteList: TWhiteList['whiteList'], options?: THttpRequestOptions): Promise<void>;
201
203
  getBlackList(options?: THttpRequestOptions): Promise<string[]>;
202
- setBlackList(blackList: TBlackList['blackList'], options?: THttpRequestOptions): Promise<TResponse>;
204
+ setBlackList(blackList: TBlackList['blackList'], options?: THttpRequestOptions): Promise<void>;
203
205
  fetchMapInfo(options?: THttpRequestOptions): Promise<{
204
206
  minZoom: number;
205
207
  maxZoom: number;
@@ -227,15 +229,11 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
227
229
  }>;
228
230
  setZones(zones: TZones, options?: THttpRequestOptions): Promise<void>;
229
231
  goToCoordinates(lat: number, lon: number, alt?: number, options?: THttpRequestOptions): Promise<void>;
230
- checkGenetecConnection(params: TParameters, options?: THttpRequestOptions): Promise<TResponse>;
232
+ downloadReport(options?: THttpRequestOptions): Promise<string>;
233
+ checkGenetecConnection(params: TParameters, options?: THttpRequestOptions): Promise<boolean>;
231
234
  getGenetecCameraList(params: TParameters, options?: THttpRequestOptions): Promise<{
232
235
  value: string;
233
- index: number;
234
236
  label: string;
237
+ index: number;
235
238
  }[]>;
236
- private _getJson;
237
- private _getBlob;
238
- private parseBlobResponse;
239
- private _postJsonEncoded;
240
- private _postUrlEncoded;
241
239
  }
@@ -1,17 +1,15 @@
1
1
  import { IClient, TParameters, TResponse } from './internal/types';
2
2
  import { TAudioDevice, TPortSetSchema, TPortSequenceStateSchema } from './types/VapixAPI';
3
- import { ProxyClient } from './internal/ProxyClient';
4
- import { TCameraImageConfig, THttpRequestOptions, TProxyParams } from './types/common';
5
- export declare class VapixAPI<Client extends IClient<TResponse, any>> {
6
- private client;
3
+ import { TCameraImageConfig, THttpRequestOptions } from './types/common';
4
+ import { BasicAPI } from './internal/BasicAPI';
5
+ export declare class VapixAPI<Client extends IClient<TResponse, any>> extends BasicAPI<Client> {
7
6
  private CustomFormData;
8
7
  constructor(client: Client, CustomFormData?: {
9
8
  new (form?: HTMLFormElement | undefined, submitter?: HTMLElement | null | undefined): FormData;
10
9
  prototype: FormData;
11
10
  });
12
- getClient(proxyParams?: TProxyParams): Client | ProxyClient<Client>;
13
11
  postUrlEncoded(path: string, parameters?: TParameters, headers?: Record<string, string>, options?: THttpRequestOptions): Promise<TResponse>;
14
- postJson(path: string, jsonData: Record<string, any>, headers?: Record<string, string>, options?: THttpRequestOptions): Promise<TResponse>;
12
+ postJson(path: string, data: Record<string, any>, headers?: Record<string, string>, options?: THttpRequestOptions): Promise<TResponse>;
15
13
  getCameraImage(parameters: TCameraImageConfig, options?: THttpRequestOptions): Promise<ReturnType<Client["get"]>>;
16
14
  getEventDeclarations(options?: THttpRequestOptions): Promise<string>;
17
15
  getSupportedAudioSampleRate(options?: THttpRequestOptions): Promise<{
@@ -19,17 +17,8 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> {
19
17
  bitRates: number[];
20
18
  }[]>;
21
19
  performAutofocus(options?: THttpRequestOptions): Promise<void>;
22
- checkSDCard(options?: THttpRequestOptions): Promise<{
23
- status: "OK" | "connected" | "disconnected";
24
- totalSize: number;
25
- freeSize: number;
26
- }>;
27
- mountSDCard(options?: THttpRequestOptions): Promise<number>;
28
- unmountSDCard(options?: THttpRequestOptions): Promise<number>;
29
- private _doSDCardMountAction;
30
- fetchSDCardJobProgress(jobId: number, options?: THttpRequestOptions): Promise<number>;
31
- downloadCameraReport(options?: THttpRequestOptions): Promise<TResponse>;
32
- getSystemLog(options?: THttpRequestOptions): Promise<TResponse>;
20
+ downloadCameraReport(options?: THttpRequestOptions): Promise<string>;
21
+ getSystemLog(options?: THttpRequestOptions): Promise<string>;
33
22
  getMaxFps(channel: number, options?: THttpRequestOptions): Promise<number>;
34
23
  getTimezone(options?: THttpRequestOptions): Promise<string>;
35
24
  getDateTimeInfo(options?: THttpRequestOptions): Promise<{
@@ -44,7 +33,16 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> {
44
33
  getDevicesSettings(options?: THttpRequestOptions): Promise<TAudioDevice[]>;
45
34
  fetchRemoteDeviceInfo<T extends Record<string, any>>(payload: T, options?: THttpRequestOptions): Promise<any>;
46
35
  getHeaders(options?: THttpRequestOptions): Promise<Record<string, string>>;
47
- setHeaders(headers: Record<string, string>, options?: THttpRequestOptions): Promise<TResponse>;
36
+ setHeaders(headers: Record<string, string>, options?: THttpRequestOptions): Promise<void>;
37
+ checkSDCard(options?: THttpRequestOptions): Promise<{
38
+ status: "OK" | "connected" | "disconnected";
39
+ totalSize: number;
40
+ freeSize: number;
41
+ }>;
42
+ mountSDCard(options?: THttpRequestOptions): Promise<number>;
43
+ unmountSDCard(options?: THttpRequestOptions): Promise<number>;
44
+ private _doSDCardMountAction;
45
+ fetchSDCardJobProgress(jobId: number, options?: THttpRequestOptions): Promise<number>;
48
46
  getParameter(paramNames: string | string[], options?: THttpRequestOptions): Promise<Record<string, string>>;
49
47
  setParameter(params: Record<string, string | number | boolean>, options?: THttpRequestOptions): Promise<void>;
50
48
  getGuardTourList(options?: THttpRequestOptions): Promise<{
@@ -52,8 +50,8 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> {
52
50
  id: string;
53
51
  running: string;
54
52
  tour: {
55
- moveSpeed?: unknown;
56
53
  position?: unknown;
54
+ moveSpeed?: unknown;
57
55
  presetNbr?: unknown;
58
56
  waitTime?: unknown;
59
57
  waitTimeViewType?: unknown;
@@ -66,18 +64,18 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> {
66
64
  getPTZPresetList(channel: number, options?: THttpRequestOptions): Promise<string[]>;
67
65
  listPTZ(camera: number, options?: THttpRequestOptions): Promise<{
68
66
  name: string;
69
- id: number;
70
67
  data: {
71
68
  pan?: number | undefined;
72
69
  tilt?: number | undefined;
73
70
  zoom?: number | undefined;
74
71
  };
72
+ id: number;
75
73
  }[]>;
76
74
  listPtzVideoSourceOverview(options?: THttpRequestOptions): Promise<Record<number, {
77
75
  name: string;
78
76
  id: number;
79
77
  }[]>>;
80
- goToPreset(channel: number, presetName: string, options?: THttpRequestOptions): Promise<TResponse>;
78
+ goToPreset(channel: number, presetName: string, options?: THttpRequestOptions): Promise<void>;
81
79
  getPtzPosition(camera: number, options?: THttpRequestOptions): Promise<{
82
80
  pan?: number | undefined;
83
81
  tilt?: number | undefined;
@@ -86,15 +84,27 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> {
86
84
  getPorts(options?: THttpRequestOptions): Promise<{
87
85
  name: string;
88
86
  port: string;
87
+ direction: "output" | "input";
89
88
  state: "open" | "closed";
90
89
  configurable: boolean;
91
90
  usage: string;
92
- direction: "input" | "output";
93
91
  normalState: "open" | "closed";
94
92
  readonly?: boolean | undefined;
95
93
  }[]>;
96
94
  setPorts(ports: TPortSetSchema[], options?: THttpRequestOptions): Promise<void>;
97
95
  setPortStateSequence(port: number, sequence: TPortSequenceStateSchema[], options?: THttpRequestOptions): Promise<void>;
96
+ addCameraUser(username: string, pass: string, sgrp: string, comment?: string, options?: THttpRequestOptions): Promise<void>;
97
+ getCameraUsers(options?: THttpRequestOptions): Promise<string[]>;
98
+ editCameraUser(username: string, pass: string, options?: THttpRequestOptions): Promise<void>;
99
+ getRecordingRuleList(options?: THttpRequestOptions): Promise<{
100
+ options: Record<string, string>;
101
+ diskid: string;
102
+ eventid: string;
103
+ profile: string;
104
+ }[]>;
105
+ addRecordingRule(params: Record<string, string>, options?: THttpRequestOptions): Promise<string | null>;
106
+ removeRecordingRule(profileId: string, options?: THttpRequestOptions): Promise<void>;
107
+ getDiskInfo(diskId?: string, options?: THttpRequestOptions): Promise<boolean>;
98
108
  getApplicationList(options?: THttpRequestOptions): Promise<{
99
109
  Name: string;
100
110
  NiceName: string;
@@ -102,7 +112,7 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> {
102
112
  Version: string;
103
113
  License: string;
104
114
  Status: string;
105
- appId: "CamStreamer" | "CamSwitcher" | "CamOverlay" | "CamScripter" | "PlaneTracker" | "Ndihxplugin" | "SportTracker" | null;
115
+ appId: "CamStreamer" | "CamSwitcher" | "CamOverlay" | "CamScripter" | "PlaneTracker" | "Ndihxplugin" | "SportTracker" | "CamOverlayHtmlplugin" | null;
106
116
  ApplicationID?: string | undefined;
107
117
  ConfigurationPage?: string | undefined;
108
118
  VendorHomePage?: string | undefined;
@@ -112,7 +122,10 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> {
112
122
  restartApplication(applicationId: string, options?: THttpRequestOptions): Promise<void>;
113
123
  stopApplication(applicationId: string, options?: THttpRequestOptions): Promise<void>;
114
124
  installApplication(data: Parameters<typeof FormData.prototype.append>[1], fileName: string, options?: THttpRequestOptions): Promise<void>;
125
+ private static parseQueryString;
126
+ private static checkTextResponseForError;
115
127
  private static parseParameters;
116
128
  private static parseCameraPtzResponse;
117
129
  private static parsePtz;
130
+ private static parseXmlResponse;
118
131
  }
@@ -92,11 +92,17 @@ export declare class BadRequestError<T extends TResponse> extends ErrorWithRespo
92
92
  }
93
93
  export declare class MigrationError extends Error {
94
94
  readonly valid: TStream[];
95
- readonly invalid: (TOldStream & {
96
- id: number;
95
+ readonly old: (TOldStream & {
96
+ streamId: string;
97
97
  })[];
98
- constructor(valid: TStream[], invalid: (TOldStream & {
99
- id: number;
100
- })[]);
98
+ readonly invalid: any[];
99
+ readonly unknown: {
100
+ platform: string;
101
+ }[];
102
+ constructor(valid: TStream[], old: (TOldStream & {
103
+ streamId: string;
104
+ })[], invalid?: any[], unknown?: {
105
+ platform: string;
106
+ }[]);
101
107
  }
102
108
  export {};
package/types/index.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  export * from './errors/errors';
2
2
  export * from './internal/types';
3
3
  export * from './internal/constants';
4
+ export * from './internal/convertors';
4
5
  export * from './internal/utils';
5
6
  export * from './internal/versionCompare';
6
7
  export * from './internal/ProxyClient';
@@ -0,0 +1,15 @@
1
+ import { THttpRequestOptions, TProxyParams } from '../types/common';
2
+ import { ProxyClient } from './ProxyClient';
3
+ import { IClient, TBlobResponse, TParameters, TResponse } from './types';
4
+ export declare class BasicAPI<Client extends IClient<TResponse, any>> {
5
+ protected client: Client;
6
+ constructor(client: Client);
7
+ getClient(proxyParams?: TProxyParams): Client | ProxyClient<Client>;
8
+ protected _getJson(path: string, parameters?: TParameters, options?: THttpRequestOptions): Promise<any>;
9
+ protected _getText(path: string, parameters?: TParameters, options?: THttpRequestOptions): Promise<string>;
10
+ protected _getBlob(path: string, parameters?: TParameters, options?: THttpRequestOptions): Promise<TBlobResponse<Client>>;
11
+ private parseBlobResponse;
12
+ protected _post(path: string, data: string | Parameters<Client['post']>[0]['data'], parameters?: TParameters, options?: THttpRequestOptions, headers?: Record<string, string>): Promise<any>;
13
+ protected _postJsonEncoded(path: string, data: string | Parameters<Client['post']>[0]['data'], parameters?: TParameters, options?: THttpRequestOptions): Promise<TResponse>;
14
+ protected _postUrlEncoded(path: string, data: TParameters, options?: THttpRequestOptions): Promise<TResponse>;
15
+ }
@@ -30,6 +30,7 @@ export declare class WsEvents<T extends {
30
30
  resendInitData(): void;
31
31
  addListener<Type extends TEventType<T>>(type: Type, listener: TListenerFunction<T, Type>, id: string): void;
32
32
  removeListener<Type extends TEventType<T>>(type: Type, id: string): void;
33
+ removeAllListenersForId(id: string): void;
33
34
  private onMessage;
34
35
  private processMessage;
35
36
  destroy(): void;
@@ -1 +1,2 @@
1
1
  export declare const FIRMWARE_WITH_BITRATE_MODES_SUPPORT = "11.11.73";
2
+ export declare const FIRMWARE_WITH_OVERLAYS_SUPPORT = "10.7.0";
@@ -0,0 +1,6 @@
1
+ import { TInternalVapixParameters } from '../types/CamStreamerAPI';
2
+ import { TBitrateMode, TBitrateVapixParams } from '../types/common';
3
+ export declare const parseBitrateOptionsToVapixParams: (firmWareVersion: string, bitrateMode: TBitrateMode | undefined, cameraOptions: Partial<TBitrateVapixParams>) => string;
4
+ export declare const parseVapixParamsToBitrateOptions: (bitrateVapixParams: string) => TBitrateVapixParams;
5
+ export declare const parseVideoOptionsToVapixParams: (firmWareVersion: string, video: TInternalVapixParameters) => string;
6
+ export declare const parseVapixParamsToVideoOptions: (internalVapixParams: string) => TInternalVapixParameters;
@@ -17,6 +17,9 @@ export type TResponse = {
17
17
  status: number;
18
18
  ok: boolean;
19
19
  statusText: string;
20
+ headers: {
21
+ get: (name: string) => string | null;
22
+ };
20
23
  };
21
24
  export type TGetParams = {
22
25
  path: string;
@@ -1,6 +1,6 @@
1
1
  export declare const assertVersionString: (s: string, msg?: string) => void;
2
2
  export declare const isFirmwareVersionAtLeast: (version: string, compareVersion: string) => boolean;
3
3
  export declare const isVersionAtLeast: (version: string, compareVersion: string) => boolean;
4
- export declare const firmwareVersionCompare: (a: string, b: string) => 0 | 1 | -1;
5
- export declare const versionCompare: (a: string, b: string) => 0 | 1 | -1;
4
+ export declare const firmwareVersionCompare: (a: string, b: string) => 1 | 0 | -1;
5
+ export declare const versionCompare: (a: string, b: string) => 1 | 0 | -1;
6
6
  export declare const fixVersionToDots: (version: string) => string;