Decodes CMSF catalog payloads and provides track discovery helpers.
A CMSF catalog is a UTF-8 JSON payload retrieved via MOQX.Helpers.fetch_catalog/2.
This module parses those raw bytes into an inspectable Elixir structure.
Example
{:ok, ref} = MOQX.Helpers.fetch_catalog(subscriber, namespace: "moqtail")
{:ok, catalog} = MOQX.Helpers.await_catalog(ref, 5_000)
catalog
|> MOQX.Catalog.video_tracks()
|> Enum.map(& &1.name)
#=> ["259", "260", "261"]The raw field on both MOQX.Catalog and MOQX.Catalog.Track preserves
the original JSON map for forward compatibility with fields not yet modeled
as struct keys.
Summary
Functions
Returns all audio tracks.
Decodes a raw CMSF catalog binary into a %MOQX.Catalog{}.
Bang variant of decode/1. Raises on invalid input.
Finds a track by exact name. Returns nil if not found.
Returns all tracks in the catalog.
Returns tracks matching the given role string (e.g. "video", "audio").
Returns all video tracks.
Types
@type t() :: %MOQX.Catalog{ raw: map(), supports_delta_updates: boolean() | nil, tracks: [MOQX.Catalog.Track.t()], version: integer() | nil }
Functions
@spec audio_tracks(t()) :: [MOQX.Catalog.Track.t()]
Returns all audio tracks.
Decodes a raw CMSF catalog binary into a %MOQX.Catalog{}.
Accepts the raw bytes delivered by {:moqx_fetch_object, ...} messages.
Returns {:ok, catalog} on success or {:error, reason} on failure.
Example
{:ok, catalog} = MOQX.Catalog.decode(payload)
MOQX.Catalog.video_tracks(catalog)Bang variant of decode/1. Raises on invalid input.
@spec get_track(t(), String.t()) :: MOQX.Catalog.Track.t() | nil
Finds a track by exact name. Returns nil if not found.
@spec tracks(t()) :: [MOQX.Catalog.Track.t()]
Returns all tracks in the catalog.
@spec tracks_by_role(t(), String.t()) :: [MOQX.Catalog.Track.t()]
Returns tracks matching the given role string (e.g. "video", "audio").
@spec video_tracks(t()) :: [MOQX.Catalog.Track.t()]
Returns all video tracks.