PodcastRSS (Podcast RSS v0.3.0)

A library for generating podcast RSS feeds.

PodcastRSS provides a simple, pipeline-friendly API for creating RSS 2.0 feeds suitable for podcast distribution. It focuses on simplicity and readability while supporting the core requirements for podcast feeds.

Examples

alias PodcastRSS.Episode

channel = PodcastRSS.new()
  |> PodcastRSS.title("Retro Gaming Chronicles")
  |> PodcastRSS.link("https://example.com")
  |> PodcastRSS.description("Exploring the golden age of video games")
  |> PodcastRSS.self_link("https://feeds.example.com/rss")
  |> PodcastRSS.image("https://example.com/cover.png")
  |> PodcastRSS.language("en-us")

episode = channel
  |> PodcastRSS.new_episode()
  |> Episode.title("The Birth of the NES")
  |> Episode.description("How Nintendo revolutionized home gaming in 1985")
  |> Episode.enclosure("https://example.com/episodes/nes-birth.mp3", 45678901, "audio/mpeg")
  |> Episode.guid("retro-001-nes-birth")
  |> Episode.duration("01:23:45")

feed_xml = channel
  |> PodcastRSS.add_episode(episode)
  |> PodcastRSS.to_xml()

Summary

Functions

add_episode(channel, episode)

Add an episode to the channel.

category(channel, category)

Set the podcast category.

category(channel, category, subcategory)

Set the podcast category with subcategory.

custom_field(channel, name, content, opts \\ [])

Add a custom field to the channel.

description(channel, description)

Set the channel description.

episodic(channel)

Set the podcast type to episodic.

image(channel, image_url)

Set the podcast cover image URL.

language(channel, language_code)

Set the podcast language.

link(channel, link)

Set the channel link (website URL).

new()

Create a new channel with useful defaults.

new_episode(channel)

Create a new episode that inherits the channel's namespaces.

register_namespace(channel, namespace, uri)

self_link(channel, feed_url)

Set the canonical RSS feed URL.

serial(channel)

Set the podcast type to serial.

title(channel, title)

Set the channel title.

to_xml(channel)

Convert the channel to RSS XML string.

Functions

add_episode(channel, episode)

Add an episode to the channel.

Delegates to PodcastRSS.Channel.add_episode/2.

category(channel, category)

Set the podcast category.

Delegates to PodcastRSS.Channel.category/2.

category(channel, category, subcategory)

Set the podcast category with subcategory.

Delegates to PodcastRSS.Channel.category/3.

custom_field(channel, name, content, opts \\ [])

Add a custom field to the channel.

Delegates to PodcastRSS.Channel.custom_field/4.

description(channel, description)

Set the channel description.

Delegates to PodcastRSS.Channel.description/2.

episodic(channel)

@spec episodic(PodcastRSS.Channel.t()) :: PodcastRSS.Channel.t()

Set the podcast type to episodic.

Delegates to PodcastRSS.Channel.type/2.

image(channel, image_url)

Set the podcast cover image URL.

Delegates to PodcastRSS.Channel.image/2.

language(channel, language_code)

Set the podcast language.

Delegates to PodcastRSS.Channel.language/2.

link(channel, link)

Set the channel link (website URL).

Delegates to PodcastRSS.Channel.link/2.

new()

@spec new() :: PodcastRSS.Channel.t()

Create a new channel with useful defaults.

Pre-registers common podcast namespaces:

iTunes namespace for iTunes-specific tags
Podcast Index namespace for modern podcast features
Atom namespace for RSS 2.0 compliance
PSC (Podlove Simple Chapters) namespace for chapter support

Sets default values:

Language: "en-us"
iTunes block: "No"
iTunes complete: "No"

For a completely empty channel without any defaults, use PodcastRSS.Channel.new/0.