@skylineos/clsp-player/index.d.ts

Skyline Technology Solutions' CLSP Video Player. Stream video in near-real-time in modern browsers.

// Type definitions for CLSP Player
// Project: https://github.com/skylineos/clsp-player

import StreamConfiguration from "./src/js/iov/StreamConfiguration";

// @see - https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-d-ts.html
// @see - https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react/index.d.ts

export as namespace CLSP;

interface StreamConfigurationTokenConfig {
  b64HashAccessUrl: string;
  jwt: string;
}

interface StreamConfigurationConfig {
  streamName: string;
  host: string;
  port: number;
  useSSL: boolean;
  tokenConfig: StreamConfigurationTokenConfig;
}

/**
 * Defined in /src/js/iov/StreamConfiguration.js
 */
declare class StreamConfiguration {
  static factory(streamName: string, host: string, port: number, useSSL: boolean, tokenConfig: StreamConfigurationTokenConfig): StreamConfiguration;
  static fromObject(config): StreamConfiguration;
  static isStreamConfiguration(target: any): boolean;
  static generateConfigFromUrl(url: string): StreamConfigurationConfig;
  static fromUrl(url): StreamConfiguration;
  protocol: string;
  url: string;
  clone(streamConfiguration: StreamConfiguration): StreamConfiguration;
  toObject(): StreamConfigurationConfig;
  destroy();
}

/**
 * Internet of Video client. This module uses the MediaSource API to
 * deliver video content streamed through CLSP from distributed sources.
 */
export class Iov {
  on(eventName: string, handler: Function);
  changeSrc(url: string | StreamConfiguration): Promise<void>;
  stop():Promise<void>;
  restart():Promise<void>;
  enterFullscreen();
  exitFullscreen();
  toggleFullscreen();
  getLoadingAnimation();
  destroyAllLoadingAnimations();
  createLoadingAnimation();
  /**
   * Dereference the necessary properties, clear any intervals and timeouts, and
   * remove any listeners.  Will also destroy the player.
   */
  destroy(): Promise<void>;
}

interface IovCreateConfig {
  videoElementId: string,
  videoElement: HTMLElement,
  containerElementId: string,
  containerElement: HTMLElement,
}

/**
 * The Iov Collection is meant to be a singleton, and is meant to manage all
 * Iovs in a given browser window/document.  There are certain centralized
 * functions it is meant to perform, such as generating the guids that are
 * needed to establish a connection to a unique topic on the SFS, and to listen
 * to window messages and route the relevant messages to the appropriate Iov
 * instance.
 */
export class IovCollection {
  static asSingleton():IovCollection;
  /**
   * Create an Iov for a specific stream, and add it to this collection.
   */
  create(config: IovCreateConfig): Iov;
  /**
   * Determine whether or not an iov with the passed id exists in this
   * collection.
   */
  has(id: string): boolean;
  /**
   * Get an iov with the passed id from this collection.
   */
  get(id: string): Iov | null;
  /**
   * Remove an iov instance from this collection and destroy it.
   */
  remove(id: string): this;
  /**
   * Destroy this collection and destroy all iov instances in this collection.
   */
  destroy();
}

interface PageVisibilityApiPropertyNames {
  hiddenStateName: string;
  visibilityChangeEventName: string;
}

export class utils {
  static name: string;
  static version: string;
  static MINIMUM_CHROME_VERSION: number;
  static SUPPORTED_MIME_TYPE: string;
  static DEFAULT_STREAM_TIMEOUT: number;
  static supported(): boolean;
  static isSupportedMimeType(): boolean;
  static windowStateNames: PageVisibilityApiPropertyNames;
  static isDocumentHidden(): boolean;
  static isOnline(): boolean;
  static getDefaultStreamPort(): number;
  static setDefaultStreamPort(protocol: string, port: number);
}