imagesnap

Documentation

Overview

Package imagesnap implements an image recorder with the imagesnap command for macOS.

Index

• func ListDevices() ([]image.Device, error)
• type Recorder
  • func NewRecorder(opts RecorderOpts) (recorder *Recorder, rerr error)
  • func (r *Recorder) Close() error
  • func (r *Recorder) Events() chan image.Event
• type RecorderOpts

Functions

func ListDevices

func ListDevices() ([]image.Device, error)

ListDevices returns all image capturing devices available to imagesnap. ListDevices returns an error if no devices are available.

Types

type Recorder

type Recorder struct {
	// contains filtered or unexported fields
}

Recorder records images by starting imagesnap and configuring it to write images to temporary storage.

func NewRecorder

func NewRecorder(opts RecorderOpts) (recorder *Recorder, rerr error)

NewRecorder creates a new recorder by starting imagesnap, making it write images to a temporary directory. These images are read and sent on the channel returned by Events.

Callers must call Close to clean up.

func (*Recorder) Close

func (r *Recorder) Close() error

Close shuts down the recorder, stopping the imagesnap process and removing the temporary directory.

func (*Recorder) Events

func (r *Recorder) Events() chan image.Event

Events returns a channel on which Events can be received.

type RecorderOpts

type RecorderOpts struct {
	Verbose  bool
	Interval time.Duration // How often to record an image.
	DeviceID string        // As returned by ListDevices. If empty, NewRecorder will use the first device returned by ListDevices.
}

RecorderOpts has options for a new imagesnap recorder.