capture

Documentation

Overview

Package capture provides interfaces for capturing virtual display output.

Index

• Variables
• type Capture
• type PipewireStream
  • func NewPipewire() (ret *PipewireStream, err error)
  • func (p *PipewireStream) Close() error
  • func (p *PipewireStream) Start(framerate uint32, _ image.Rectangle, cb func(image.Image)) (err error)
• type Writeback
  • func NewWriteback(card *drm.Card) (*Writeback, error)
• type X11
  • func NewX11() (ret *X11, err error)
  • func (x *X11) Close()
  • func (x *X11) Start(framerate uint32, rect image.Rectangle, cb func(image.Image))

Variables

var (
	ErrDbusBadResponse   = errors.New("unknown or malformed response")
	ErrDbusUserCancelled = errors.New("user cancelled interaction")
	ErrDbusCancelled     = errors.New("interaction cancelled")
)

Types

type Capture

type Capture interface {
	Close() error
	Start(framerate uint32, rect image.Rectangle, cb func(image.Image)) error
}

type PipewireStream

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

PipewireStream uses the org.freedesktop.portal.ScreenCast portal granted by xdg-desktop-portal to generate a pipewire stream for screen capture.

func NewPipewire

func NewPipewire() (ret *PipewireStream, err error)

func (*PipewireStream) Close

func (p *PipewireStream) Close() error

func (*PipewireStream) Start

func (p *PipewireStream) Start(framerate uint32, _ image.Rectangle, cb func(image.Image)) (err error)

type Writeback

type Writeback struct {
}

Writeback uses DRM writeback connectors for output.

See https://gitlab.freedesktop.org/wayland/weston/-/merge_requests/458 for example implementation.

This capture backend is not possible without more widespread support for DRM leasing. The required mode and prop setting is gated by being the DRM master, which won't reasonably be us.

func NewWriteback

func NewWriteback(card *drm.Card) (*Writeback, error)

type X11

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

X11 uses the X library for screen capture.

func NewX11

func NewX11() (ret *X11, err error)

func (*X11) Close

func (x *X11) Close()

func (*X11) Start

func (x *X11) Start(framerate uint32, rect image.Rectangle, cb func(image.Image))