preview

Documentation

Index

• Variables
• type Data
• type Option
  • func WithExcludedFiles(files map[string]struct{}) Option
  • func WithImage(param bool) Option
  • func WithMaxFileSize(param int64) Option
  • func WithMaxImages(param int64) Option
  • func WithMaxVideos(param int64) Option
  • func WithTimeout(param time.Duration) Option
  • func WithVideo(param bool) Option
• type Previewer
  • func NewPreviewer(opts ...Option) (*Previewer, error)
  • func (p Previewer) Pull(src Source) (Data, error)
• type Source
• type VideoParams

Variables

var (
	ErrVipsNewImage = errors.New("failed init new image")
	ErrImageResize  = errors.New("failed to resize the image")
	ErrImageExport  = errors.New("failed export the image")
)

var (
	ErrVideoPreview = errors.New("failed create preview for video")
	ErrImagePreview = errors.New("failed create preview for image")
)

var (
	ErrCommandNotFound          = errors.New("not found")
	ErrIncorrectFFmpegVersion   = errors.New("can't be parsed")
	ErrOutdatedFFmpegVersion    = errors.New("is outdated")
	ErrMetaInfoUnmarshal        = errors.New("failed to decode file's meta information")
	ErrMetaInfoFramesCountParse = errors.New("failed to parse frames count from meta information")
	ErrMetaInfoDurationParse    = errors.New("failed to parse duration from meta information")
	ErrVideoStreamNotFound      = errors.New("video stream not found")
	ErrParseFrameRate           = errors.New("failed to parse frame rate")

	ErrPullSnapshot = errors.New("failed to pull snapshot")
	ErrImageDecode  = errors.New("failed to decode image")
	ErrImageEncode  = errors.New("failed to encode image")
	ErrImageScale   = errors.New("failed to scale image")
	ErrBufferCopy   = errors.New("failed to copy buffer")
)

Types

type Data

type Data interface {
	Data() []byte
	Duration() time.Duration
	Resolution() (int, int)
}

type Option

type Option func(*Previewer)

func WithExcludedFiles

func WithExcludedFiles(files map[string]struct{}) Option

files = map[FilePath]struct{}.

func WithImage

func WithImage(param bool) Option

func WithMaxFileSize

func WithMaxFileSize(param int64) Option

func WithMaxImages

func WithMaxImages(param int64) Option

func WithMaxVideos

func WithMaxVideos(param int64) Option

func WithTimeout

func WithTimeout(param time.Duration) Option

func WithVideo

func WithVideo(param bool) Option

type Previewer

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

func NewPreviewer

func NewPreviewer(opts ...Option) (*Previewer, error)

func (Previewer) Pull

func (p Previewer) Pull(src Source) (Data, error)

type Source

type Source interface {
	IsImage() bool
	IsVideo() bool
	IsAnimatedImage() bool
	Path() string
	Size() int64
}

type VideoParams

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