Summary

Functions

new(path, opts \\ [])

Creates a new audio/video reader.

new!(path, opts \\ [])

The same as new/1 but raises on error.

next_frame(reader)

Reads and decodes the next frame.

seek(reader, time_in_seconds)

Seeks the reader to the given time in seconds

stream!(path, opts \\ [])

Creates a new reader stream.

Types

opts()

@type opts() :: [
  read: :audio | :video,
  device?: boolean(),
  out_format: Xav.Frame.format(),
  out_sample_rate: integer(),
  out_channels: integer()
]

Reader options.

read - determines which stream to read from a file. Defaults to :video.
device? - determines whether path points to the camera. Defaults to false.

t()

@type t() :: %Xav.Reader{
  bit_rate: integer(),
  codec: atom(),
  duration: integer(),
  framerate: {integer(), integer()} | nil,
  in_channels: integer() | nil,
  in_format: atom(),
  in_sample_rate: integer() | nil,
  out_channels: integer() | nil,
  out_format: atom(),
  out_sample_rate: integer() | nil,
  reader: reference()
}

Functions

new(path, opts \\ [])

@spec new(String.t(), opts()) :: {:ok, t()} | {:error, term()}

Creates a new audio/video reader.

Both reading from a file and from a video camera are supported. In case of using a video camera, the v4l2 driver is required, and FPS are locked to 10.

Microphone input is not supported.

opts can be used to specify desired output parameters. Video frames are always returned in RGB format. This setting cannot be changed. Audio samples are always in the packed form. See Xav.Decoder.new/2 for more information.

new!(path, opts \\ [])

@spec new!(String.t(), opts()) :: t()

The same as new/1 but raises on error.

next_frame(reader)

@spec next_frame(t()) :: {:ok, Xav.Frame.t()} | {:error, :eof}

Reads and decodes the next frame.

seek(reader, time_in_seconds)

@spec seek(t(), float()) :: :ok | {:error, term()}

Seeks the reader to the given time in seconds

stream!(path, opts \\ [])

@spec stream!(String.t(), opts()) :: Enumerable.t()

Creates a new reader stream.

View Source Xav.Reader (xav v0.8.0)

Summary

Types

Functions

Types

opts()

t()

Functions

new(path, opts \\ [])

new!(path, opts \\ [])

next_frame(reader)

seek(reader, time_in_seconds)

stream!(path, opts \\ [])