Subtitle.WebVTT.Payload (kim_subtitle v0.1.6)

Summary

Each tag will be fragmented into a list of single word tags of the same type. If words are longer than max_length, they are wrapped.

marshal!(tags)

Merges the tags until their text size reaches max_length. Calls simplify/1 on the final result.

simplify(tags)

Merges equals tags together. Useful after a fragment call.

size(tags)

string(tags)

unmarshal(text)

unmarshal!(text)

Splits words when they are longer then the specified length

@spec fragment(
  Subtitle.WebVTT.Payload.Tag.t() | [Subtitle.WebVTT.Payload.Tag.t()],
  pos_integer()
) :: [
  Subtitle.WebVTT.Payload.Tag.t()
]

Each tag will be fragmented into a list of single word tags of the same type. If words are longer than max_length, they are wrapped.

@spec marshal!([Subtitle.WebVTT.Payload.Tag.t()]) :: binary()

@spec merge([Subtitle.WebVTT.Payload.Tag.t()], pos_integer()) :: [
  [Subtitle.WebVTT.Payload.Tag.t()]
]

Merges the tags until their text size reaches max_length. Calls simplify/1 on the final result.

@spec simplify([Subtitle.WebVTT.Payload.Tag.t()]) :: [Subtitle.WebVTT.Payload.Tag.t()]

Merges equals tags together. Useful after a fragment call.

@spec unmarshal(binary()) ::
  {:ok, [Subtitle.WebVTT.Payload.Tag.t()]} | {:error, binary()}

@spec unmarshal!(binary()) :: [Subtitle.WebVTT.Payload.Tag.t()]

@spec wrap_words([binary()], pos_integer()) :: [binary()]

Splits words when they are longer then the specified length