Jido.Chat.Media (Jido Chat v1.0.0)

Copy Markdown View Source

Normalized media entry used in Jido.Chat.Incoming.

Summary

Types

input()
t()

Functions

new(media)

Creates a media struct from map input.

normalize(media)

Normalizes supported attachment inputs into a canonical media struct.

normalize_many(media)

Normalizes a list of attachments into canonical media structs.

schema()

Returns the Zoi schema for Media.

Types

input()

@type input() ::
  t()
  | Jido.Chat.Content.Image.t()
  | Jido.Chat.Content.Audio.t()
  | Jido.Chat.Content.Video.t()
  | Jido.Chat.Content.File.t()
  | map()
  | String.t()

t()

@type t() :: %Jido.Chat.Media{
  duration: nil | nil | integer(),
  filename: nil | nil | binary(),
  height: nil | nil | integer(),
  kind: :image | :audio | :video | :file,
  media_type: nil | nil | binary(),
  metadata: map(),
  size_bytes: nil | nil | integer(),
  url: nil | nil | binary(),
  width: nil | nil | integer()
}

Functions

new(media)

Creates a media struct from map input.

normalize(media)

@spec normalize(input()) :: t()

Normalizes supported attachment inputs into a canonical media struct.

normalize_many(media)

@spec normalize_many([input()]) :: [t()]

Normalizes a list of attachments into canonical media structs.

schema()

Returns the Zoi schema for Media.