Liking cljdoc? Tell your friends :D

dk.simongray.podcast.format.media.id3

The ID3v2 tags at the start of an MP3 or AAC file, and what they say about the file: its tags, its duration, its artwork and its chapters.

The tags come through a view of the file, and id3-clj reads them from their bytes, as dk.simongray.id3 describes. Its frames are true to the ID3 specs, and this namespace gives what they say in the shapes of podcast-clj, e.g. the chapters in seconds. The quirks of the reading and its diagnostics are those of id3-clj.

The ID3v2 tags at the start of an MP3 or AAC file, and what they say
about the file: its tags, its duration, its artwork and its chapters.

The tags come through a view of the file, and id3-clj reads them from
their bytes, as dk.simongray.id3 describes. Its frames are true to the
ID3 specs, and this namespace gives what they say in the shapes of
podcast-clj, e.g. the chapters in seconds. The quirks of the reading
and its diagnostics are those of id3-clj.
raw docstring

artworkclj/s

(artwork frames)

The picture in frames as a map of :type, :data and :description, or nil when they hold none. The front cover comes before each other picture.

The picture in `frames` as a map of :type, :data and :description, or
nil when they hold none. The front cover comes before each other
picture.
sourceraw docstring

chaptersclj/s

(chapters frames)

The chapters in frames, from their CHAP and CTOC frames, in the shape of dk.simongray.podcast.format.chapters.

Each chapter is a map with :start-time and :end-time in seconds. It has the :title, the :url and the picture of the frames inside its frame, the picture as :artwork, a map of :type and :data. The top-level table of contents gives the order. A chapter that the table doesn't list comes after the others, by its start, with :toc false.

The chapters in `frames`, from their CHAP and CTOC frames, in the shape
of dk.simongray.podcast.format.chapters.

Each chapter is a map with :start-time and :end-time in seconds. It has
the :title, the :url and the picture of the frames inside its frame, the
picture as :artwork, a map of :type and :data. The top-level table of
contents gives the order. A chapter that the table doesn't list comes
after the others, by its start, with :toc false.
sourceraw docstring

durationclj/s

(duration frames)

The duration of the audio in seconds, from the TLEN frame in frames, or nil when no TLEN frame gives a number. The frame gives the length in milliseconds.

The duration of the audio in seconds, from the TLEN frame in `frames`,
or nil when no TLEN frame gives a number. The frame gives the length in
milliseconds.
sourceraw docstring

namedclj/s

(named frames)

The tags of frames as one map of :title, :artist, :album, :date, :genre and :description, each absent when the frames don't have it. The description is that of a podcast's episode, or else the comment.

The tags of `frames` as one map of :title, :artist, :album, :date,
:genre and :description, each absent when the frames don't have it. The
description is that of a podcast's episode, or else the comment.
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