Options
All
  • Public
  • Public/Protected
  • All
Menu

Web Publication Audiobook format specific ReaderDocument. The source content document will always be an audio resource.

Since IWpAudiobookReaderDocument does not represent visual content, they can not be rendered in a ReaderView.

The ReaderDocument may represent a part of the source media resource. See getTimeIntervalInMediaResource().

Hierarchy

Index

Methods

createRenderableDocument

createRenderableDocumentPageIterator

fetchContentBlockTree

fetchContentBlocks

fetchContentLocationForEntireDocument

fetchEstimatedHeight

fetchEstimatedNumberOfPages

fetchLocatorForContentBlockData

  • fetchLocatorForContentBlockData(contentBlockData: IContentBlockData, charOffset?: number, charLength?: number): Promise<ILocator>
  • Fetch the locator for the complete or partial content block. NOTE: This method still exists for the legacy search API.

    deprecated

    since 0.28.0 - Please use fetchContentBlockTree(), and use IContentBlock.getLocator() instead.

    Parameters

    • contentBlockData: IContentBlockData

      The content block data to retrieve locator for.

    • Optional charOffset: number

      The character offset within textBlock.textContent. Defaults to 0.

    • Optional charLength: number

      The number of characters after charOffset to include in the locator. Defaults to end of textContent if omitted.

    Returns Promise<ILocator>

fetchViewportDimensions

getAvailableSyncMediaFormats

getContentLocation

getDurationMs

  • getDurationMs(): number
  • Returns the duration of this ReaderDocument in milliseconds.

    Returns number

getIndexInSpine

  • getIndexInSpine(): number

getLocator

getReaderPublication

getSourceContentDocument

isReflowable

  • isReflowable(): boolean

isRenderable

  • isRenderable(): boolean

toJSON

Generated using TypeDoc