Liking cljdoc? Tell your friends :D

dk.simongray.podcast.profile.marks

The marks that the listener puts on the episodes of a profile: stars, bookmarks, clips and ratings.

Each is a collection of the profile, so a mark syncs like the rest of it. The played mark is the profile's own, since dk.simongray.podcast.profile/progress sets it.

The marks that the listener puts on the episodes of a profile: stars,
bookmarks, clips and ratings.

Each is a collection of the profile, so a mark syncs like the rest of
it. The played mark is the profile's own, since
dk.simongray.podcast.profile/progress sets it.
raw docstring

bookmarkclj/s

(bookmark profile id position at)
(bookmark profile id position title at)

Bookmark the episode id in profile at position seconds at at, with a title when it's given. Another bookmark at the same whole second replaces its title.

Bookmark the episode `id` in `profile` at `position` seconds at `at`, with
a `title` when it's given. Another bookmark at the same whole second
replaces its title.
sourceraw docstring

bookmarksclj/s

(bookmarks profile)
(bookmarks profile id)

The bookmarks of profile, the latest written first, or those of the episode id in order of position.

A bookmark is a map of :id, :position in whole seconds, :title and :updated-at.

The bookmarks of `profile`, the latest written first, or those of the
episode `id` in order of position.

A bookmark is a map of :id, :position in whole seconds, :title and
:updated-at.
sourceraw docstring

clipclj/s

(clip profile id start duration at)
(clip profile id start duration title at)

Keep a clip of the episode id in profile at at, from start seconds for duration seconds, with a title when it's given.

A clip has the shape of a podcast:soundbite. Another clip at the same whole second replaces it, and a start or duration that isn't a number of seconds keeps no clip.

Keep a clip of the episode `id` in `profile` at `at`, from `start` seconds
for `duration` seconds, with a `title` when it's given.

A clip has the shape of a podcast:soundbite. Another clip at the same
whole second replaces it, and a start or duration that isn't a number of
seconds keeps no clip.
sourceraw docstring

clipsclj/s

(clips profile)
(clips profile id)

The clips of profile, the latest written first, or those of the episode id in order of start.

A clip is a map of :id, :start-time in whole seconds, :duration in seconds, :title and :updated-at.

The clips of `profile`, the latest written first, or those of the episode
`id` in order of start.

A clip is a map of :id, :start-time in whole seconds, :duration in
seconds, :title and :updated-at.
sourceraw docstring

rate-episodeclj/s

(rate-episode profile id n at)
(rate-episode profile id n at {:keys [scale] :as opts})

Give the episode id in profile the rating n at at, in the scale of opts, replacing any earlier rating.

The rating must be within its scale, or nothing changes. The profile keeps the scale with the rating, so another app can read it in its own scale.

Give the episode `id` in `profile` the rating `n` at `at`, in the scale
of `opts`, replacing any earlier rating.

The rating must be within its scale, or nothing changes. The profile
keeps the scale with the rating, so another app can read it in its own
scale.
sourceraw docstring

ratedclj/s

(rated profile)
(rated profile {:keys [scale] :as opts})

The episodes of profile that have a rating, the latest rated first, in the scale of opts if it gives one.

Each is a map of :id, :rating, the :worst and :best of its scale, and :updated-at. A :scale in opts converts the ratings.

The episodes of `profile` that have a rating, the latest rated first, in
the scale of `opts` if it gives one.

Each is a map of :id, :rating, the :worst and :best of its scale, and
:updated-at. A :scale in `opts` converts the ratings.
sourceraw docstring

ratingclj/s

(rating profile id)
(rating profile id {:keys [scale] :as opts})

The rating that the listener gave the episode id in profile, or nil, in the scale of opts if it gives one.

It's in the scale that it was given in. A :scale in opts converts it, e.g. a 4 of 1 to 5 is 75.25 of 1 to 100.

The rating that the listener gave the episode `id` in `profile`, or nil,
in the scale of `opts` if it gives one.

It's in the scale that it was given in. A :scale in `opts` converts it,
e.g. a 4 of 1 to 5 is 75.25 of 1 to 100.
sourceraw docstring

rating-scaleclj/s

The scale of ratings when no other is given: from 1 for the worst to 5 for the best, like the stars of most apps.

A scale is a map of :worst and :best, two different numbers, as in a schema.org Rating. Give another as :scale in the options, e.g. {:worst 0 :best 1} for thumbs down and up.

The scale of ratings when no other is given: from 1 for the worst to 5
for the best, like the stars of most apps.

A scale is a map of :worst and :best, two different numbers, as in a
schema.org Rating. Give another as :scale in the options, e.g.
{:worst 0 :best 1} for thumbs down and up.
sourceraw docstring

starclj/s

(star profile id at)

Star the episode id in profile at at, unless it has a star.

Star the episode `id` in `profile` at `at`, unless it has a star.
sourceraw docstring

starredclj/s

(starred profile)

The starred episode ids of profile, the latest starred first.

The starred episode ids of `profile`, the latest starred first.
sourceraw docstring

starred?clj/s

(starred? profile id)

Whether the episode id has a star in profile.

Whether the episode `id` has a star in `profile`.
sourceraw docstring

unbookmarkclj/s

(unbookmark profile id position at)

Remove the bookmark of the episode id at position seconds from profile at at, leaving a tombstone.

Remove the bookmark of the episode `id` at `position` seconds from
`profile` at `at`, leaving a tombstone.
sourceraw docstring

unclipclj/s

(unclip profile id start at)

Remove the clip of the episode id that starts at start seconds from profile at at, leaving a tombstone.

Remove the clip of the episode `id` that starts at `start` seconds
from `profile` at `at`, leaving a tombstone.
sourceraw docstring

unrate-episodeclj/s

(unrate-episode profile id at)

Take the rating off the episode id in profile at at, leaving a tombstone.

Take the rating off the episode `id` in `profile` at `at`, leaving a
tombstone.
sourceraw docstring

unstarclj/s

(unstar profile id at)

Take the star off the episode id in profile at at, leaving a tombstone, so that it outlives an older star on another device.

Take the star off the episode `id` in `profile` at `at`, leaving a
tombstone, so that it outlives an older star on another device.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close