@storyteller-platform/audiobook API

AudiobookEntry

Defined in: entry.ts:12

Extends

• BaseAudiobookEntry

Constructors

Constructor

new AudiobookEntry(entry): AudiobookEntry

Defined in: entry.ts:41

Parameters

Parameter	Type
entry	Uint8ArrayEntry | Entry

Returns

AudiobookEntry

Overrides

BaseAudiobookEntry.constructor

Properties

entry

protected entry: Uint8ArrayEntry | Entry

Defined in: entry.ts:41

file

protected file: null | File = null

Defined in: entry.ts:15

Overrides

BaseAudiobookEntry.file

filename

filename: string

Defined in: entry.ts:13

Overrides

BaseAudiobookEntry.filename

Methods

createFile()

createFile(): Promise<File>

Defined in: entry.ts:34

Returns

Promise<File>

Overrides

BaseAudiobookEntry.createFile

getAuthors()

getAuthors(): Promise<string[]>

Defined in: base.ts:57

Returns

Promise<string[]>

Inherited from

BaseAudiobookEntry.getAuthors

getCoverArt()

getCoverArt(): Promise<null | IPicture>

Defined in: base.ts:106

Returns

Promise<null | IPicture>

Inherited from

BaseAudiobookEntry.getCoverArt

getData()

getData(): Promise<Uint8Array<ArrayBufferLike>>

Defined in: entry.ts:29

Returns

Promise<Uint8Array<ArrayBufferLike>>

Overrides

BaseAudiobookEntry.getData

getDescription()

getDescription(): Promise<null | string>

Defined in: base.ts:45

Returns

Promise<null | string>

Inherited from

BaseAudiobookEntry.getDescription

getFile()

getFile(): Promise<File>

Defined in: base.ts:17

Returns

Promise<File>

Inherited from

BaseAudiobookEntry.getFile

getNarrators()

getNarrators(): Promise<string[]>

Defined in: base.ts:84

Returns

Promise<string[]>

Inherited from

BaseAudiobookEntry.getNarrators

getPublisher()

getPublisher(): Promise<null | string>

Defined in: base.ts:130

Returns

Promise<null | string>

Inherited from

BaseAudiobookEntry.getPublisher

getReleased()

getReleased(): Promise<null | string>

Defined in: base.ts:140

Returns

Promise<null | string>

Inherited from

BaseAudiobookEntry.getReleased

getSubtitle()

getSubtitle(): Promise<null | string>

Defined in: base.ts:35

Returns

Promise<null | string>

Inherited from

BaseAudiobookEntry.getSubtitle

getTitle()

getTitle(): Promise<null | string>

Defined in: base.ts:25

Returns

Promise<null | string>

Inherited from

BaseAudiobookEntry.getTitle

readData()

protected readData(): Promise<Uint8Array<ArrayBufferLike>>

Defined in: entry.ts:17

Returns

Promise<Uint8Array<ArrayBufferLike>>

save()

save(): void

Defined in: base.ts:150

Returns

void

Inherited from

BaseAudiobookEntry.save

setAuthors()

setAuthors(authors): Promise<void>

Defined in: base.ts:75

Parameters

Parameter	Type
authors	string[]

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setAuthors

setCoverArt()

setCoverArt(picture): Promise<void>

Defined in: base.ts:116

Parameters

Parameter	Type
picture	IPicture

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setCoverArt

setDescription()

setDescription(description): Promise<void>

Defined in: base.ts:52

Parameters

Parameter	Type
description	string

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setDescription

setNarrators()

setNarrators(narrators): Promise<void>

Defined in: base.ts:100

Parameters

Parameter	Type
narrators	string[]

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setNarrators

setPublisher()

setPublisher(publisher): Promise<void>

Defined in: base.ts:135

Parameters

Parameter	Type
publisher	string

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setPublisher

setReleased()

setReleased(released): Promise<void>

Defined in: base.ts:145

Parameters

Parameter	Type
released	string

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setReleased

setSubtitle()

setSubtitle(subtitle): Promise<void>

Defined in: base.ts:40

Parameters

Parameter	Type
subtitle	string

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setSubtitle

setTitle()

setTitle(title): Promise<void>

Defined in: base.ts:30

Parameters

Parameter	Type
title	string

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setTitle

---

Uint8ArrayEntry

Defined in: entry.ts:7

Properties

data

data: Uint8Array

Defined in: entry.ts:9

filename

filename: string

Defined in: entry.ts:8

base

API Docs

abstract BaseAudiobook

Defined in: base.ts:174

Extended by

• Audiobook

Constructors

Constructor

new BaseAudiobook(): BaseAudiobook

Returns

BaseAudiobook

Properties

entries

abstract protected entries: BaseAudiobookEntry[]

Defined in: base.ts:176

metadata

protected metadata: AudiobookMetadata = {}

Defined in: base.ts:175

Methods

getAuthors()

getAuthors(): Promise<string[]>

Defined in: base.ts:247

Returns

Promise<string[]>

getCoverArt()

getCoverArt(): Promise<null | IPicture>

Defined in: base.ts:277

Returns

Promise<null | IPicture>

getDescription()

getDescription(): Promise<null | string>

Defined in: base.ts:230

Returns

Promise<null | string>

getFirstValue()

protected getFirstValue<T>(getter): Promise<null | T>

Defined in: base.ts:178

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
getter	(entry) => Promise<T>

Returns

Promise<null | T>

getNarrators()

getNarrators(): Promise<string[]>

Defined in: base.ts:262

Returns

Promise<string[]>

getPublisher()

getPublisher(): Promise<null | string>

Defined in: base.ts:293

Returns

Promise<null | string>

getReleased()

getReleased(): Promise<null | string>

Defined in: base.ts:308

Returns

Promise<null | string>

getSubtitle()

getSubtitle(): Promise<null | string>

Defined in: base.ts:214

Returns

Promise<null | string>

getTitle()

getTitle(): Promise<null | string>

Defined in: base.ts:198

Returns

Promise<null | string>

setAuthors()

setAuthors(authors): Promise<void>

Defined in: base.ts:256

Parameters

Parameter	Type
authors	string[]

Returns

Promise<void>

setCoverArt()

setCoverArt(picture): Promise<void>

Defined in: base.ts:287

Parameters

Parameter	Type
picture	IPicture

Returns

Promise<void>

setDescription()

setDescription(description): Promise<void>

Defined in: base.ts:241

Parameters

Parameter	Type
description	string

Returns

Promise<void>

setNarrators()

setNarrators(narrators): Promise<void>

Defined in: base.ts:271

Parameters

Parameter	Type
narrators	string[]

Returns

Promise<void>

setPublisher()

setPublisher(publisher): Promise<void>

Defined in: base.ts:302

Parameters

Parameter	Type
publisher	string

Returns

Promise<void>

setReleased()

setReleased(released): Promise<void>

Defined in: base.ts:317

Parameters

Parameter	Type
released	string

Returns

Promise<void>

setSubtitle()

setSubtitle(subtitle): Promise<void>

Defined in: base.ts:224

Parameters

Parameter	Type
subtitle	string

Returns

Promise<void>

setTitle()

setTitle(title): Promise<void>

Defined in: base.ts:208

Parameters

Parameter	Type
title	string

Returns

Promise<void>

setValue()

protected setValue(setter): Promise<void>

Defined in: base.ts:190

Parameters

Parameter	Type
setter	(entry) => Promise<void>

Returns

Promise<void>

---

abstract BaseAudiobookEntry

Defined in: base.ts:9

Extended by

• AudiobookEntry
• AudiobookEntry

Constructors

Constructor

new BaseAudiobookEntry(): BaseAudiobookEntry

Returns

BaseAudiobookEntry

Properties

file

abstract protected file: null | File

Defined in: base.ts:11

filename

abstract filename: string

Defined in: base.ts:10

Methods

createFile()

abstract createFile(): Promise<File>

Defined in: base.ts:15

Returns

Promise<File>

getAuthors()

getAuthors(): Promise<string[]>

Defined in: base.ts:57

Returns

Promise<string[]>

getCoverArt()

getCoverArt(): Promise<null | IPicture>

Defined in: base.ts:106

Returns

Promise<null | IPicture>

getData()

abstract getData(): Promise<Uint8Array<ArrayBufferLike>>

Defined in: base.ts:13

Returns

Promise<Uint8Array<ArrayBufferLike>>

getDescription()

getDescription(): Promise<null | string>

Defined in: base.ts:45

Returns

Promise<null | string>

getFile()

getFile(): Promise<File>

Defined in: base.ts:17

Returns

Promise<File>

getNarrators()

getNarrators(): Promise<string[]>

Defined in: base.ts:84

Returns

Promise<string[]>

getPublisher()

getPublisher(): Promise<null | string>

Defined in: base.ts:130

Returns

Promise<null | string>

getReleased()

getReleased(): Promise<null | string>

Defined in: base.ts:140

Returns

Promise<null | string>

getSubtitle()

getSubtitle(): Promise<null | string>

Defined in: base.ts:35

Returns

Promise<null | string>

getTitle()

getTitle(): Promise<null | string>

Defined in: base.ts:25

Returns

Promise<null | string>

save()

save(): void

Defined in: base.ts:150

Returns

void

setAuthors()

setAuthors(authors): Promise<void>

Defined in: base.ts:75

Parameters

Parameter	Type
authors	string[]

Returns

Promise<void>

setCoverArt()

setCoverArt(picture): Promise<void>

Defined in: base.ts:116

Parameters

Parameter	Type
picture	IPicture

Returns

Promise<void>

setDescription()

setDescription(description): Promise<void>

Defined in: base.ts:52

Parameters

Parameter	Type
description	string

Returns

Promise<void>

setNarrators()

setNarrators(narrators): Promise<void>

Defined in: base.ts:100

Parameters

Parameter	Type
narrators	string[]

Returns

Promise<void>

setPublisher()

setPublisher(publisher): Promise<void>

Defined in: base.ts:135

Parameters

Parameter	Type
publisher	string

Returns

Promise<void>

setReleased()

setReleased(released): Promise<void>

Defined in: base.ts:145

Parameters

Parameter	Type
released	string

Returns

Promise<void>

setSubtitle()

setSubtitle(subtitle): Promise<void>

Defined in: base.ts:40

Parameters

Parameter	Type
subtitle	string

Returns

Promise<void>

setTitle()

setTitle(title): Promise<void>

Defined in: base.ts:30

Parameters

Parameter	Type
title	string

Returns

Promise<void>

---

AudiobookChapter

Defined in: base.ts:155

Properties

filename

filename: string

Defined in: base.ts:156

start

start: number

Defined in: base.ts:157

stop

stop: number

Defined in: base.ts:158

title

title: string

Defined in: base.ts:159

---

AudiobookMetadata

Defined in: base.ts:162

Properties

authors?

optional authors: string[]

Defined in: base.ts:168

chapters?

optional chapters: AudiobookChapter[]

Defined in: base.ts:167

coverArt?

optional coverArt: IPicture

Defined in: base.ts:166

description?

optional description: string

Defined in: base.ts:165

narrators?

optional narrators: string[]

Defined in: base.ts:169

publisher?

optional publisher: string

Defined in: base.ts:170

released?

optional released: string

Defined in: base.ts:171

subtitle?

optional subtitle: string

Defined in: base.ts:164

title?

optional title: string

Defined in: base.ts:163

node/entry

AudiobookEntry

Defined in: node/entry.ts:12

Extends

• BaseAudiobookEntry

Constructors

Constructor

new AudiobookEntry(entry): AudiobookEntry

Defined in: node/entry.ts:17

Parameters

Parameter	Type
entry	string | Uint8ArrayEntry | Entry

Returns

AudiobookEntry

Overrides

BaseAudiobookEntry.constructor

Properties

entry

protected entry: string | > Uint8ArrayEntry > | Entry

Defined in: node/entry.ts:17

file

protected file: null | File = null

Defined in: node/entry.ts:15

Overrides

BaseAudiobookEntry.file

filename

filename: string

Defined in: node/entry.ts:13

Overrides

BaseAudiobookEntry.filename

Methods

close()

close(): void

Defined in: node/entry.ts:64

Returns

void

createFile()

createFile(): Promise<File>

Defined in: node/entry.ts:22

Returns

Promise<File>

Overrides

BaseAudiobookEntry.createFile

getAuthors()

getAuthors(): Promise<string[]>

Defined in: base.ts:57

Returns

Promise<string[]>

Inherited from

BaseAudiobookEntry.getAuthors

getCoverArt()

getCoverArt(): Promise<null | IPicture>

Defined in: base.ts:106

Returns

Promise<null | IPicture>

Inherited from

BaseAudiobookEntry.getCoverArt

getData()

getData(): Promise<Uint8Array<ArrayBufferLike>>

Defined in: node/entry.ts:35

Returns

Promise<Uint8Array<ArrayBufferLike>>

Overrides

BaseAudiobookEntry.getData

getDescription()

getDescription(): Promise<null | string>

Defined in: base.ts:45

Returns

Promise<null | string>

Inherited from

BaseAudiobookEntry.getDescription

getFile()

getFile(): Promise<File>

Defined in: base.ts:17

Returns

Promise<File>

Inherited from

BaseAudiobookEntry.getFile

getNarrators()

getNarrators(): Promise<string[]>

Defined in: base.ts:84

Returns

Promise<string[]>

Inherited from

BaseAudiobookEntry.getNarrators

getPublisher()

getPublisher(): Promise<null | string>

Defined in: base.ts:130

Returns

Promise<null | string>

Inherited from

BaseAudiobookEntry.getPublisher

getReleased()

getReleased(): Promise<null | string>

Defined in: base.ts:140

Returns

Promise<null | string>

Inherited from

BaseAudiobookEntry.getReleased

getSubtitle()

getSubtitle(): Promise<null | string>

Defined in: base.ts:35

Returns

Promise<null | string>

Inherited from

BaseAudiobookEntry.getSubtitle

getTitle()

getTitle(): Promise<null | string>

Defined in: base.ts:25

Returns

Promise<null | string>

Inherited from

BaseAudiobookEntry.getTitle

persisted()

persisted(): boolean

Defined in: node/entry.ts:60

Returns

boolean

readData()

protected readData(): Promise<Uint8Array<ArrayBufferLike>>

Defined in: node/entry.ts:44

Returns

Promise<Uint8Array<ArrayBufferLike>>

save()

save(): void

Defined in: base.ts:150

Returns

void

Inherited from

BaseAudiobookEntry.save

setAuthors()

setAuthors(authors): Promise<void>

Defined in: base.ts:75

Parameters

Parameter	Type
authors	string[]

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setAuthors

setCoverArt()

setCoverArt(picture): Promise<void>

Defined in: base.ts:116

Parameters

Parameter	Type
picture	IPicture

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setCoverArt

setDescription()

setDescription(description): Promise<void>

Defined in: base.ts:52

Parameters

Parameter	Type
description	string

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setDescription

setNarrators()

setNarrators(narrators): Promise<void>

Defined in: base.ts:100

Parameters

Parameter	Type
narrators	string[]

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setNarrators

setPublisher()

setPublisher(publisher): Promise<void>

Defined in: base.ts:135

Parameters

Parameter	Type
publisher	string

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setPublisher

setReleased()

setReleased(released): Promise<void>

Defined in: base.ts:145

Parameters

Parameter	Type
released	string

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setReleased

setSubtitle()

setSubtitle(subtitle): Promise<void>

Defined in: base.ts:40

Parameters

Parameter	Type
subtitle	string

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setSubtitle

setTitle()

setTitle(title): Promise<void>

Defined in: base.ts:30

Parameters

Parameter	Type
title	string

Returns

Promise<void>

Inherited from

BaseAudiobookEntry.setTitle