@vertexvis/stream-api 0.24.5-canary.4 → 1.0.0-testing.0

package/dist/connection.d.ts

@@ -1,4 +1,4 @@
-export interface ConnectionDescriptor {
-    url: string;
-    protocols?: string | string[];
-}
+export interface ConnectionDescriptor {
+    url: string;
+    protocols?: string | string[];
+}

package/dist/encoder.d.ts

@@ -1,3 +1,3 @@
-import { vertexvis } from '@vertexvis/frame-streaming-protos';
-export declare function encode(message: vertexvis.protobuf.stream.IStreamMessage): Uint8Array;
-export declare function decode(bufferOrBytes: ArrayBuffer | Uint8Array): vertexvis.protobuf.stream.IStreamMessage;
+import { vertexvis } from '@vertexvis/frame-streaming-protos';
+export declare function encode(message: vertexvis.protobuf.stream.IStreamMessage): Uint8Array;
+export declare function decode(bufferOrBytes: ArrayBuffer | Uint8Array): vertexvis.protobuf.stream.IStreamMessage;

package/dist/errors.d.ts

@@ -1,8 +1,8 @@
-import { vertexvis } from '@vertexvis/frame-streaming-protos';
-export declare class StreamRequestError extends Error {
-    readonly requestId: string;
-    readonly requestPayload: vertexvis.protobuf.stream.IStreamRequest;
-    readonly summary: string | null | undefined;
-    readonly details: string | null | undefined;
-    constructor(requestId: string, requestPayload: vertexvis.protobuf.stream.IStreamRequest, summary: string | null | undefined, details: string | null | undefined);
-}
+import { vertexvis } from '@vertexvis/frame-streaming-protos';
+export declare class StreamRequestError extends Error {
+    readonly requestId: string;
+    readonly requestPayload: vertexvis.protobuf.stream.IStreamRequest;
+    readonly summary: string | null | undefined;
+    readonly details: string | null | undefined;
+    constructor(requestId: string, requestPayload: vertexvis.protobuf.stream.IStreamRequest, summary: string | null | undefined, details: string | null | undefined);
+}

package/dist/index.d.ts

@@ -1,12 +1,13 @@
-/**
- * @module Stream API
- */
-export * from './connection';
-export * from './encoder';
-export * from './errors';
-export { AdaptiveRenderingSettings, FrameDeliverySettings, QualityOfServiceSettings, Settings, } from './settings';
-export * from './streamApi';
-export * from './testing';
-export * from './time';
-export * from './types';
-export * from './webSocketClient';
+/**
+ * @module Stream API
+ */
+export * from './connection';
+export * from './encoder';
+export * from './errors';
+export type { AdaptiveRenderingSettings, FrameDeliverySettings, QualityOfServiceSettings, Settings, } from './settings';
+export { appendSettingsToUrl } from './settings';
+export * from './streamApi';
+export * from './testing';
+export * from './time';
+export * from './types';
+export * from './webSocketClient';

package/dist/paramsBuilder.d.ts

@@ -1,5 +1,5 @@
-export declare type ParamsBuilder<S> = (settings: S) => Record<string, string>;
-export declare function defineParams<S>(...definitions: ParamsBuilder<S>[]): ParamsBuilder<S>;
-export declare function defineBoolean<S, P extends keyof S = keyof S>(param: string, prop: P): ParamsBuilder<S>;
-export declare function defineNumber<S, P extends keyof S = keyof S>(param: string, prop: P): ParamsBuilder<S>;
-export declare function defineString<S, P extends keyof S = keyof S>(param: string, prop: P): ParamsBuilder<S>;
+export type ParamsBuilder<S> = (settings: S) => Record<string, string>;
+export declare function defineParams<S>(...definitions: ParamsBuilder<S>[]): ParamsBuilder<S>;
+export declare function defineBoolean<S, P extends keyof S = keyof S>(param: string, prop: P): ParamsBuilder<S>;
+export declare function defineNumber<S, P extends keyof S = keyof S>(param: string, prop: P): ParamsBuilder<S>;
+export declare function defineString<S, P extends keyof S = keyof S>(param: string, prop: P): ParamsBuilder<S>;

package/dist/settings.d.ts

@@ -1,106 +1,106 @@
-/**
- * Settings to configure the delivery of images over the websocket connection.
- */
-export interface FrameDeliverySettings {
-    /**
-     * Indicates if the rate limiting of frame delivery is enabled based on
-     * detected internet throughput.
-     */
-    rateLimitingEnabled?: boolean;
-    /**
-     * Enables rate limiting when the variation coefficient of frame latencies
-     * exceeds this threshold. The variation coefficient is defined by the
-     * standard deviation of latencies over the average of recorded latencies.
-     *
-     * Lower numbers will increase the aggressiveness of packet loss detection,
-     * but may trigger unexpected delivery rate limiting.
-     */
-    packetLossThreshold?: number;
-    /**
-     * The maximum number of latencies to record. Higher numbers could result in
-     * more delay before packet loss is detected. Lower numbers could result in
-     * packet loss not being detected.
-     */
-    historyMaxSize?: number;
-    /**
-     * The duration at which point a frame will be considered failed if the server
-     * has not received an acknowledgement.
-     */
-    timeout?: string;
-    /**
-     * Enables rate limiting when the number of frames that failed to receive an
-     * acknowledgement within the timeout window exceeds this ratio.
-     */
-    timeoutRatioThreshold?: number;
-}
-/**
- * Settings to configure the adaptive rendering of images. If enabled, the
- * performance of delivering images is analyzed, and will be adjusted to deliver
- * frames quicker to the client.
- */
-export interface AdaptiveRenderingSettings {
-    /**
-     * Indicates if adaptive rendering is enabled.
-     */
-    enabled?: boolean;
-    /**
-     * The adaptive rendering algorithm to use. Defaults to `median`.
-     */
-    method?: 'median' | 'average' | 'smoothed-median' | 'median-of-smoothed-median' | 'average-of-smoothed-median';
-    /**
-     * A number between 1 and 100 representing the minimum JPEG quality for
-     * rendered frames.
-     */
-    jpegMinQuality?: number;
-    /**
-     * A number between 1 and 100 representing the maximum JPEG quality for
-     * rendered frames.
-     */
-    jpegMaxQuality?: number;
-    /**
-     * A number between 0 and 1 representing the minimum scale factor for rendered
-     * frames.
-     */
-    imageMinScale?: number;
-    /**
-     * A number between 0 and 1 representing the maximum scale factor for rendered
-     * frames.
-     */
-    imageMaxScale?: number;
-    /**
-     * The window size to use for smoothing based adaptive rendering methods. This
-     * applies to: `smoothed-median`, `median-of-smoothed-median`,
-     * `average-of-smoothed-median`. Higher window sizes will result in values
-     * that are more smoothed, and have less "wave" like behavior to image
-     * quality. However, higher window sizes will take longer to respond to
-     * changes in network conditions.
-     */
-    windowSize?: number;
-}
-/**
- * Settings to configure the quality of service metrics used by the server.
- */
-export interface QualityOfServiceSettings {
-    /**
-     * Specifies how many timings to track before old timings are purged.
-     */
-    historyMaxSize?: number;
-}
-/**
- * Settings to configure the frame stream and its websocket connection.
- */
-export interface Settings {
-    /**
-     * **EXPERIMENTAL.** Settings to configure the delivery of frames.
-     */
-    EXPERIMENTAL_frameDelivery?: FrameDeliverySettings;
-    /**
-     * **EXPERIMENTAL.** Settings to configure adaptive rendering of frames.
-     */
-    EXPERIMENTAL_adaptiveRendering?: AdaptiveRenderingSettings;
-    /**
-     * **EXPERIMENTAL.** Settings to configure quality of service.
-     */
-    EXPERIMENTAL_qualityOfService?: QualityOfServiceSettings;
-}
-export declare function appendSettingsToUrl(url: string, settings: Settings): string;
+/**
+ * Settings to configure the delivery of images over the websocket connection.
+ */
+export interface FrameDeliverySettings {
+    /**
+     * Indicates if the rate limiting of frame delivery is enabled based on
+     * detected internet throughput.
+     */
+    rateLimitingEnabled?: boolean;
+    /**
+     * Enables rate limiting when the variation coefficient of frame latencies
+     * exceeds this threshold. The variation coefficient is defined by the
+     * standard deviation of latencies over the average of recorded latencies.
+     *
+     * Lower numbers will increase the aggressiveness of packet loss detection,
+     * but may trigger unexpected delivery rate limiting.
+     */
+    packetLossThreshold?: number;
+    /**
+     * The maximum number of latencies to record. Higher numbers could result in
+     * more delay before packet loss is detected. Lower numbers could result in
+     * packet loss not being detected.
+     */
+    historyMaxSize?: number;
+    /**
+     * The duration at which point a frame will be considered failed if the server
+     * has not received an acknowledgement.
+     */
+    timeout?: string;
+    /**
+     * Enables rate limiting when the number of frames that failed to receive an
+     * acknowledgement within the timeout window exceeds this ratio.
+     */
+    timeoutRatioThreshold?: number;
+}
+/**
+ * Settings to configure the adaptive rendering of images. If enabled, the
+ * performance of delivering images is analyzed, and will be adjusted to deliver
+ * frames quicker to the client.
+ */
+export interface AdaptiveRenderingSettings {
+    /**
+     * Indicates if adaptive rendering is enabled.
+     */
+    enabled?: boolean;
+    /**
+     * The adaptive rendering algorithm to use. Defaults to `median`.
+     */
+    method?: 'median' | 'average' | 'smoothed-median' | 'median-of-smoothed-median' | 'average-of-smoothed-median';
+    /**
+     * A number between 1 and 100 representing the minimum JPEG quality for
+     * rendered frames.
+     */
+    jpegMinQuality?: number;
+    /**
+     * A number between 1 and 100 representing the maximum JPEG quality for
+     * rendered frames.
+     */
+    jpegMaxQuality?: number;
+    /**
+     * A number between 0 and 1 representing the minimum scale factor for rendered
+     * frames.
+     */
+    imageMinScale?: number;
+    /**
+     * A number between 0 and 1 representing the maximum scale factor for rendered
+     * frames.
+     */
+    imageMaxScale?: number;
+    /**
+     * The window size to use for smoothing based adaptive rendering methods. This
+     * applies to: `smoothed-median`, `median-of-smoothed-median`,
+     * `average-of-smoothed-median`. Higher window sizes will result in values
+     * that are more smoothed, and have less "wave" like behavior to image
+     * quality. However, higher window sizes will take longer to respond to
+     * changes in network conditions.
+     */
+    windowSize?: number;
+}
+/**
+ * Settings to configure the quality of service metrics used by the server.
+ */
+export interface QualityOfServiceSettings {
+    /**
+     * Specifies how many timings to track before old timings are purged.
+     */
+    historyMaxSize?: number;
+}
+/**
+ * Settings to configure the frame stream and its websocket connection.
+ */
+export interface Settings {
+    /**
+     * **EXPERIMENTAL.** Settings to configure the delivery of frames.
+     */
+    EXPERIMENTAL_frameDelivery?: FrameDeliverySettings;
+    /**
+     * **EXPERIMENTAL.** Settings to configure adaptive rendering of frames.
+     */
+    EXPERIMENTAL_adaptiveRendering?: AdaptiveRenderingSettings;
+    /**
+     * **EXPERIMENTAL.** Settings to configure quality of service.
+     */
+    EXPERIMENTAL_qualityOfService?: QualityOfServiceSettings;
+}
+export declare function appendSettingsToUrl(url: string, settings: Settings): string;