Skip to content
Snippets Groups Projects
Commit 4204b07f authored by Christian Bager Bach Houmann's avatar Christian Bager Bach Houmann
Browse files

docs: add more api documentation

parent fc8dfd07
No related branches found
No related tags found
No related merge requests found
......@@ -14,6 +14,22 @@ export interface IAPI {
The above functions are all accessible through `app.plugins.plugins.podnotes.api`.
## `podcast`
This returns the currently playing episode.
```js
export interface Episode {
title: string,
streamUrl: string
url: string,
description: string,
podcastName: string,
feedUrl?: string,
artworkUrl?: string;
episodeDate?: Date;
}
```
## `getPodcastTimeFormatted(format: string, linkify?: boolean)`
This function will return the current playback time formatted according to the given (moment) format.
If `linkify` is true, the time will be linked to the current episode at the given time. This is used by PodNotes to play from the recorded time.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment