Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMediaSourceFactoryOptions

Used when creating new MediaSourceFactory instances. Used internally by the framework.

Hierarchy

  • IMediaSourceFactoryOptions

Index

Properties

Properties

Optional allowRemoteUrls

allowRemoteUrls?: boolean

Sets whether it should be possible to use remote http/https urls as-is. This option is usually controlled by either one of the following options: IEpubReaderPublication.remoteResourcesScriptedDocumentsOptions IEpubReaderPublication.remoteResourcesNonScriptedDocumentsOptions

default

false

Optional enableBlobUrls

enableBlobUrls?: boolean

This option controls how resource data should be loaded when the MediaSourceFactory cannot stream a resource.

If this option is true, MediaSourceFactory create blob: URLs for resources. If this option is false, MediaSourceFactory create data: URLs for resources. If this option is null, MediaSourceFactory decides how to create URLs for resource.

default

null

Optional enableMediaStreaming

enableMediaStreaming?: boolean

If true, the media will be streamed using the MSE (Media Source Extensions) API if:

  • The MSE API is available.
  • The media type is supported by MSE and the readingsystem engine.
  • The resource URL cannot be used by the browser directly (for example it might point to a resource in an .epub file).
  • The ResourceProvider supports byte range requests for the resource.
  • The resource size in bytes is larger than mediaStreamingMinSize.
default

false

Optional highPrecisionSeek

highPrecisionSeek?: boolean

If high precision seek operations are required.

If set to false, low precision seek metadata from the media file may be used in order to reduce the amount of data that is required to be downloaded. This can cause the seek to be off by a several seconds.

If set to true, highest possible seeking precision will be used.

This option only has an effect when enableMediaStreaming is set to true.

default

false

Optional minimumSizeForMediaStreaming

minimumSizeForMediaStreaming?: number

Files with byte sizes smaller than this value will not be streamed, even if enableMediaStreaming is set to true.

Defaults to 1MB

default

1000000

Generated using TypeDoc