Exported TypeScript Types

The RxPlayer being written in TypeScript, it has type definitions attached to its source code that can be helpful if you develop an application in TypeScript yourself.

"Using" types

Because we follow the usual way of adding definition files (as d.ts file alongside our sources), those typings should be auto-exported when importing our library in your favorite editor (as long as it is linked to a TSServer of some sort).

Importing specific types

As some APIs can have pretty complicated arguments, you might also want to import some of our internal type definitions into your code.

To simplify this process, we export some type definitions which can be imported through the following line in your file:

import { SOME_TYPE } from "rx-player/types"

Here are the list of exported types, per category.

RxPlayer Constructor

The type IConstructorOptions corresponds to the interface that the RxPlayer constructor accepts as an argument.

Example:

import RxPlayer from "rx-player";
import { IConstructorOptions } from "rx-player/types";

function generateConstructorOptions() : IConstructorOptions {
  const videoElement = document.querySelector("video");
  return {
    stopAtEnd: false,
    videoElement,
  };
}

const options = generateConstructorOptions();
const player = new RxPlayer(options);

export default player;

Two constructor options have also their type definition exported, those are:

  • IAudioTrackPreference: which is the type of a single element in the preferredAudioTracks array.

  • ITextTrackPreference: which is the type of a single element in the preferredTextTracks array.

  • IVideoTrackPreference: which is the type of a single element in the preferredVideoTracks array.

loadVideo

The ILoadVideoOptions type corresponds to the argument to give to the RxPlayer's method loadVideo.

Example:

// the type wanted
import { ILoadVideoOptions } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

// hypothetical file exporting a configuration object
import config from "./config"; // define a global config

function generateLoadVideoOptions(url : string) : ILoadVideoOptions {
  return {
    url,
    transport: "dash",
    autoPlay: true,
  };
}

const loadVideoOpts = generateLoadVideoOptions(config.DEFAULT_URL);
rxPlayer.loadVideo(loadVideoOpts);

Speaking of loadVideo, some subparts of ILoadVideoOptions are also exported:

  • IKeySystemOption: type for an element of the keySystems array, which is an optional property given to loadVideo.

    To clarify, the keySystems property in a loadVideo call is an optional array of one or multiple IKeySystemOption.

  • IPersistentSessionStorage: type of the licenseStorage property of the keySystems option given to loadVideo.

  • IPersistentSessionInfo: type used by an IPersistentSessionStorage.

  • ITransportOptions: type for the transportOptions property optionally given to loadVideo.

  • IManifestLoader: type for the manifestLoader function optionally set on the transportOptions option of loadVideo.

  • IRepresentationFilter: type for the representationFilter function optionally set on the transportOptions option of loadVideo.

  • IRepresentationInfos: type for the second argument of the representationFilter function (defined by IRepresentationFilter.)

  • IServerSyncInfos: type for the serverSyncInfos property optionally set on the transportOptions option of loadVideo.

  • IInitialManifest: type for the initialManifest property optionally set on the transportOptions option of loadVideo.

  • ISegmentLoader: type for the segmentLoader function optionally set on the transportOptions option of loadVideo.

  • ISupplementaryTextTrackOption: type for an element of the supplementaryTextTracks array, which is an optional property given to loadVideo.

  • ISupplementaryImageTrackOption: type for an element of the supplementaryImageTracks array, which is an optional property given to loadVideo.

  • IDefaultAudioTrackOption: type for the defaultAudioTrack property optionally given to loadVideo.

  • IDefaultTextTrackOption: type for the defaultAudioTrack property optionally given to loadVideo.

  • INetworkConfigOption: type for the networkConfig property optionally given to loadVideo.

  • IStartAtOption: type for the startAt property optionally given to loadVideo.

  • IAudioTrackSwitchingMode: The various values accepted on the audioTrackSwitchingMode property optionally given to loadVideo.

Manifest structure

Several RxPlayer methods rely on a Manifest structure and one of its "children": the Period, the Adaptation, the Representation or the Segment.

All of those can be imported from "rx-player/types" respectively as IManifest, IPeriod, IAdaptation, IRepresentation and ISegment

getPlayerState method / playerStateChange event

The return type of the getPlayerState state method and of the playerStateChange events is a string describing the current state of the RxPlayer.

All values possible are defined through the IPlayerState type:

// the type(s) wanted
import { IPlayerState } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

function getPlayerState() : IPlayerState {
  return rxPlayer.getPlayerState();
}

getAvailableAudioTracks method / availableAudioTracksChange event

The return type of the getAvailableAudioTracks method is an array of objects. Each of this objects corresponds to the IAvailableAudioTrack interface.

Example:

// the type(s) wanted
import { IAvailableAudioTrack } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

function getAvailableAudioTracks() : IAvailableAudioTrack[] {
  return rxPlayer.getAvailableAudioTracks();
}

The property of each track's representations property corresponds to the IAudioRepresentation type.

getAvailableTextTracks method / availabletextTracksChange event

The return type of the getAvailableTextTracks method is an array of objects. Each of this objects corresponds to the IAvailableTextTrack interface.

Example:

// the type(s) wanted
import { IAvailableTextTrack } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

// hypothetical file exporting a configuration object
import config from "./config"; // define a global config

function getAvailableTextTracks() : IAvailableTextTrack[] {
  return rxPlayer.getAvailableTextTracks();
}

getAvailableVideoTracks method / availableVideoTracksChange event

The return type of the getAvailableVideoTracks method is an array of objects. Each of this objects corresponds to the IAvailableVideoTrack interface.

Example:

// the type(s) wanted
import { IAvailableVideoTrack } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

// hypothetical file exporting a configuration object
import config from "./config"; // define a global config

function getAvailableVideoTracks() : IAvailableVideoTrack[] {
  return rxPlayer.getAvailableVideoTracks();
}

The property of each track's representations property corresponds to the IVideoRepresentation type.

getAudioTrack method /audioTrackChange event

The IAudioTrack corresponds to both the type returned by the getAudioTrack method and emitted as the payload of the audioTrackChange event.

Example:

// the type(s) wanted
import { IAudioTrack } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

// hypothetical file exporting a configuration object
import config from "./config"; // define a global config

rxPlayer.addEventListener("audioTrackChange", (track : IAudioTrack) => {
  console.log("current track:", track);
});

function getCurrentlyDownloadedAudioTrack() : IAudioTrack {
  return rxPlayer.getAudioTrack();
}

The representations property also has an exported type: IAudioRepresentation.

getTextTrack method / textTrackChange event

The ITextTrack corresponds to both the type returned by the getTextTrack method and emitted as the payload of the textTrackChange event.

Example:

// the type(s) wanted
import { ITextTrack } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

// hypothetical file exporting a configuration object
import config from "./config"; // define a global config

rxPlayer.addEventListener("textTrackChange", (track : ITextTrack) => {
  console.log("current track:", track);
});

function getCurrentlyDownloadedTextTrack() : ITextTrack {
  return rxPlayer.getTextTrack();
}

getVideoTrack method / videoTrackChange event

The IVideoTrack corresponds to both the type returned by the getVideoTrack method and emitted as the payload of the videoTrackChange event.

Example:

// the type(s) wanted
import { IVideoTrack } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

// hypothetical file exporting a configuration object
import config from "./config"; // define a global config

rxPlayer.addEventListener("videoTrackChange", (track : IVideoTrack) => {
  console.log("current track:", track);
});

function getCurrentlyDownloadedVideoTrack() : IVideoTrack {
  return rxPlayer.getVideoTrack();
}

The representations property also has an exported type: IAudioRepresentation.

positionUpdate event

The type IPositionUpdate corresponds to the payload of a positionUpdate event.

Example:

// the type(s) wanted
import { IPositionUpdate } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

rxPlayer.addEventListener("positionUpdate", (evt : IPositionUpdate) {
  console.log(evt);
});

streamEvent / streamEventSkip events

The type IStreamEvent corresponds to the payload of either a streamEvent or a streamEventSkip event.

The type IStreamEventData is the type of its data property.

Example:

// the type(s) wanted
import { IStreamEvent, IStreamEventData } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

function processEventData(eventData : IStreamEventData) {
  if (eventData.type === "dash-event-stream") {
    console.log("DASH EventStream's event received!");
  }
}

rxPlayer.addEventListener("streamEvent", (evt : IStreamEvent) {
  processEventData(evt.data);
});

bitrateEstimationChange event

The type IBitrateEstimate corresponds to the payload of a bitrateEstimationChange event.

Example:

// the type(s) wanted
import { IBitrateEstimate } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

rxPlayer.addEventListener("bitrateEstimationChange", (evt : IBitrateEstimate) {
  console.log(evt);
});

decipherabilityUpdate event

The type IDecipherabilityUpdateContent corresponds to the payload of a decipherabilityUpdate event.

Example:

// the type(s) wanted
import { IDecipherabilityUpdateContent } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

rxPlayer.addEventListener("decipherabilityUpdate", (evt : IDecipherabilityUpdateContent) {
  console.log(evt);
});

RxPlayer errors and warnings

RxPlayer errors and warnings may for now be either a plain Error instance or a special RxPlayer-defined error (which extends the Error Object).

All RxPlayer-defined error are compatible with the exported IPlayerError type.

Which means that you could write the following:

// the type wanted
import { IPlayerError } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

rxPlayer.addEventListener("error", (err : Error | IPlayerError) => {
  // ...
});

rxPlayer.addEventListener("warning", (err : Error | IPlayerError) => {
  // ...
});

EncryptedMediaError's keyStatuses property

Some EncryptedMediaError error thrown by the RxPlayer, may have a keyStatuses property set. In that case, the type is described by the IEncryptedMediaErrorKeyStatusObject type:

// the type wanted
import { IEncryptedMediaErrorKeyStatusObject } from "rx-player/types";

// hypothetical file exporting an RxPlayer instance
import rxPlayer from "./player";

rxPlayer.addEventListener("error", (err : Error | IPlayerError) => {
  if (err.type === "ENCRYPTED_MEDIA_ERROR" && err.keyStatuses !== undefined) {
    logKeyStatuses(err.keyStatuses);
  }
});

function logKeyStatuses(keyStatuses: IEncryptedMediaErrorKeyStatusObject): void {
console.log(keyStatuses);
}

Exported TypeScript Types

Page List