rdisplay

package

v0.3.7 Latest Latest Go to latest Published: Jul 19, 2022 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Screen struct {
	Index  int
	Bounds image.Rectangle
}

Screen

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

ScreenGrabber captures video from Win/Lin/Mac screens

func (g *ScreenGrabber) Fps() int

Fps returns the frames per sec. we're capturing

func (g *ScreenGrabber) Frames() <-chan *image.RGBA

Frames returns a channel that will receive an image stream

func (g *ScreenGrabber) Screen() *Screen

Screen returns a pointer to the screen we're capturing

func (g *ScreenGrabber) Start()

Start initiates the screen capture loop

func (g *ScreenGrabber) Stop()

Stop sends a stop signal to the capture loop

type ScreenGrabberInterface interface {
	Start()
	Frames() <-chan *image.RGBA
	Stop()
	Fps() int
	Screen() *Screen
}

ScreenGrabberInterface

type ServiceInterface interface {
	CreateScreenGrabber(screen Screen, fps int) (ScreenGrabberInterface, error)
	Screens() ([]Screen, error)
}

Service

func NewVideoProvider() (ServiceInterface, error)

NewVideoProvider returns an X Server-based video provider

type VideoProvider struct{}

VideoProvider implements the rdisplay.Service interface for Win/Lin/Mac screens

func (*VideoProvider) CreateScreenGrabber(screen Screen, fps int) (ScreenGrabberInterface, error)

CreateScreenGrabber Creates an screen capturer for the X server

func (x *VideoProvider) Screens() ([]Screen, error)

Screens Returns the available screens to capture