types

package

Go to main page

Versions in this module

v1

v1.6.18

Jan 26, 2024

v1.6.17

Jan 26, 2024

Changes in this version

type DesktopManager

+ IsFileChooserDialogEnabled func() bool

+ IsUploadDropEnabled func() bool

v1.6.16

Nov 19, 2023

v1.6.15

Sep 11, 2023

Changes in this version

type KeyboardModifiers

+ Alt *bool

+ AltGr *bool

+ Control *bool

+ Meta *bool

+ Shift *bool

+ Super *bool

v1.6.14

Sep 9, 2023

Changes in this version

type DesktopManager

+ HasTouchSupport func() bool

+ TouchBegin func(touchId uint32, x, y int, pressure uint8) error

+ TouchEnd func(touchId uint32, x, y int, pressure uint8) error

+ TouchUpdate func(touchId uint32, x, y int, pressure uint8) error

type ScreenSize

+ func (s ScreenSize) String() string

v1.6.13

Jun 26, 2023

Changes in this version

+ type PeerAudio struct

+ Disabled bool

+ type PeerAudioRequest struct

+ Disabled *bool

+ type PeerVideo struct

+ Auto bool

+ Disabled bool

+ ID string

+ Video string

+ type PeerVideoRequest struct

+ Auto *bool

+ Disabled *bool

+ Selector *StreamSelector

type WebRTCPeer

+ Audio func() PeerAudio

+ SetAudio func(PeerAudioRequest) error

+ Video func() PeerVideo

v1.6.12

May 15, 2023

Changes in this version

+ var ErrWebRTCStreamNotFound = errors.New("webrtc stream not found")

type SessionState

+ ConnectedSince *time.Time

+ NotConnectedSince *time.Time

+ NotWatchingSince *time.Time

+ WatchingSince *time.Time

type Settings

+ LockedControls bool

+ type StreamSelector struct

+ Bitrate uint64

+ ID string

+ Type StreamSelectorType

+ type StreamSelectorManager interface

+ Codec func() codec.RTPCodec

+ GetStream func(selector StreamSelector) (StreamSinkManager, bool)

+ IDs func() []string

+ type StreamSelectorType int

+ const StreamSelectorTypeExact

+ const StreamSelectorTypeHigher

+ const StreamSelectorTypeLower

+ const StreamSelectorTypeNearest

+ func (s *StreamSelectorType) UnmarshalText(text []byte) error

+ func (s StreamSelectorType) MarshalText() ([]byte, error)

+ func (s StreamSelectorType) String() string

type WebRTCPeer

+ Paused func() bool

+ SetVideo func(StreamSelector) error

+ VideoID func() (string, bool)

v1.6.11

Apr 28, 2023

Changes in this version

type Session

+ ConnectWebSocketPeer func(websocketPeer WebSocketPeer)

+ DestroyWebSocketPeer func(reason string)

+ DisconnectWebSocketPeer func(websocketPeer WebSocketPeer, delayed bool)

type Settings

+ Plugins map[string]any

v1.6.10

Apr 18, 2023

Changes in this version

+ type PluginMetadata struct

+ DependsOn []string

+ IsDependable bool

+ IsExposable bool

+ Name string

type WebRTCPeer

+ SetRemoteDescription func(webrtc.SessionDescription) error

v1.6.9

Mar 27, 2023

Changes in this version

type Sample

+ Length int

+ Timestamp time.Time

+ type SampleListener interface

+ WriteSample func(Sample)

+ type SessionProfile struct

+ Id string

+ Profile MemberProfile

+ Token string

v1.6.8

Feb 20, 2023

Changes in this version

type Sample

+ Data []byte

+ DeltaUnit bool

+ Duration time.Duration

v1.6.7

Feb 6, 2023

Changes in this version

type BucketsManager

+ DestroyAll func()

+ RecreateAll func() error

+ Shutdown func()

type Receiver

+ OnVideoChange func(f func(videoID string) (changed bool, err error))

+ SetVideoAuto func(videoAuto bool)

+ VideoAuto func() bool

type StreamSinkManager

+ Bitrate func() int

+ CreatePipeline func() error

+ DestroyPipeline func()

type WebRTCPeer

+ GetVideoID func() string

+ SetVideoAuto func(auto bool)

+ VideoAuto func() bool

v1.6.6

Jan 9, 2023

v1.6.5

Nov 28, 2022

v1.6.4

Nov 11, 2022

Changes in this version

+ type BucketsManager interface

+ Codec func() codec.RTPCodec

+ IDs func() []string

+ RemoveReceiver func(receiver Receiver) error

+ SetReceiver func(receiver Receiver) error

type CaptureManager

+ GetBitrateFromVideoID func(videoID string) (int, error)

+ type Receiver interface

+ OnBitrateChange func(f func(int) error)

+ RemoveStream func()

+ SetStream func(stream StreamSinkManager) error

type StreamSinkManager

+ ID func() string

type VideoConfig

+ Bitrate int

+ func (config *VideoConfig) GetBitrateFn(getScreen func() *ScreenSize) func() (int, error)

type WebRTCPeer

+ GetVideoId func() string

+ SetVideoBitrate func(bitrate int) error

v1.6.3

Aug 26, 2022

Changes in this version

+ var ErrCapturePipelineAlreadyExists = errors.New("capture pipeline already exists")

+ var ErrMemberAlreadyExists = errors.New("member already exists")

+ var ErrMemberDoesNotExist = errors.New("member does not exist")

+ var ErrMemberInvalidPassword = errors.New("invalid password")

+ var ErrSessionAlreadyConnected = errors.New("session is already connected")

+ var ErrSessionAlreadyExists = errors.New("session already exists")

+ var ErrSessionLoginDisabled = errors.New("session login disabled")

+ var ErrSessionNotFound = errors.New("session not found")

+ var ErrWebRTCConnectionNotFound = errors.New("webrtc connection not found")

+ var ErrWebRTCDataChannelNotFound = errors.New("webrtc data channel not found")

+ var ErrWebRTCVideoNotFound = errors.New("webrtc video not found")

+ type ApiManager interface

+ AddRouter func(path string, router func(Router))

+ Route func(r Router)

+ type BroadcastManager interface

+ Start func(url string) error

+ Started func() bool

+ Stop func()

+ Url func() string

+ type CaptureManager interface

+ Audio func() StreamSinkManager

+ Broadcast func() BroadcastManager

+ Microphone func() StreamSrcManager

+ Screencast func() ScreencastManager

+ Shutdown func() error

+ Start func()

+ Video func(videoID string) (StreamSinkManager, bool)

+ VideoIDs func() []string

+ Webcam func() StreamSrcManager

+ type CheckOrigin func(r *http.Request) bool

+ type ClipboardText struct

+ HTML string

+ Text string

+ type Cursor struct

+ X int

+ Y int

+ type CursorImage struct

+ Height uint16

+ Image *image.RGBA

+ Serial uint64

+ Width uint16

+ Xhot uint16

+ Yhot uint16

+ type DependablePlugin interface

+ DependsOn func() []string

+ type DesktopManager interface

+ ButtonDown func(code uint32) error

+ ButtonPress func(code uint32) error

+ ButtonUp func(code uint32) error

+ ClipboardGetBinary func(mime string) ([]byte, error)

+ ClipboardGetTargets func() ([]string, error)

+ ClipboardGetText func() (*ClipboardText, error)

+ ClipboardSetBinary func(mime string, data []byte) error

+ ClipboardSetText func(data ClipboardText) error

+ CloseFileChooserDialog func()

+ DropFiles func(x int, y int, files []string) bool

+ GetCursorImage func() *CursorImage

+ GetCursorPosition func() (int, int)

+ GetKeyboardMap func() (*KeyboardMap, error)

+ GetKeyboardModifiers func() KeyboardModifiers

+ GetScreenSize func() *ScreenSize

+ GetScreenshotImage func() *image.RGBA

+ HandleFileChooserDialog func(uri string) error

+ IsFileChooserDialogOpened func() bool

+ KeyDown func(code uint32) error

+ KeyPress func(codes ...uint32) error

+ KeyUp func(code uint32) error

+ Move func(x, y int)

+ OnAfterScreenSizeChange func(listener func())

+ OnBeforeScreenSizeChange func(listener func())

+ OnClipboardUpdated func(listener func())

+ OnCursorChanged func(listener func(serial uint64))

+ OnEventError func(...)

+ OnFileChooserDialogClosed func(listener func())

+ OnFileChooserDialogOpened func(listener func())

+ ResetKeys func()

+ ScreenConfigurations func() map[int]ScreenConfiguration

+ Scroll func(x, y int)

+ SetKeyboardMap func(KeyboardMap) error

+ SetKeyboardModifiers func(mod KeyboardModifiers)

+ SetScreenSize func(ScreenSize) error

+ Shutdown func() error

+ Start func()

+ type ExposablePlugin interface

+ ExposeService func() any

+ type HttpManager interface

+ Shutdown func() error

+ Start func()

+ type ICEServer struct

+ Credential string

+ URLs []string

+ Username string

+ type KeyboardMap struct

+ Layout string

+ Variant string

+ type KeyboardModifiers struct

+ CapsLock *bool

+ NumLock *bool

+ type MemberManager interface

+ Login func(username string, password string) (Session, string, error)

+ Logout func(id string) error

+ type MemberProfile struct

+ CanAccessClipboard bool

+ CanConnect bool

+ CanHost bool

+ CanLogin bool

+ CanSeeInactiveCursors bool

+ CanShareMedia bool

+ CanWatch bool

+ IsAdmin bool

+ Name string

+ Plugins map[string]any

+ SendsInactiveCursor bool

+ type MemberProvider interface

+ Authenticate func(username string, password string) (string, MemberProfile, error)

+ Connect func() error

+ Delete func(id string) error

+ Disconnect func() error

+ Insert func(username string, password string, profile MemberProfile) (string, error)

+ Select func(id string) (MemberProfile, error)

+ SelectAll func(limit int, offset int) (map[string]MemberProfile, error)

+ UpdatePassword func(id string, password string) error

+ UpdateProfile func(id string, profile MemberProfile) error

+ type MiddlewareHandler func(w http.ResponseWriter, r *http.Request) (context.Context, error)

+ type Plugin interface

+ Config func() PluginConfig

+ Name func() string

+ Shutdown func() error

+ Start func(PluginManagers) error

+ type PluginConfig interface

+ Init func(cmd *cobra.Command) error

+ Set func()

+ type PluginManagers struct

+ ApiManager ApiManager

+ LoadServiceFromPlugin func(string) (any, error)

+ SessionManager SessionManager

+ WebSocketManager WebSocketManager

+ func (p *PluginManagers) Validate() error

+ type Router interface

+ Delete func(pattern string, fn RouterHandler)

+ Get func(pattern string, fn RouterHandler)

+ Group func(fn func(Router))

+ Patch func(pattern string, fn RouterHandler)

+ Post func(pattern string, fn RouterHandler)

+ Put func(pattern string, fn RouterHandler)

+ Route func(pattern string, fn func(Router))

+ ServeHTTP func(w http.ResponseWriter, req *http.Request)

+ Use func(fn MiddlewareHandler)

+ UseBypass func(fn func(next http.Handler) http.Handler)

+ With func(fn MiddlewareHandler) Router

+ WithBypass func(fn func(next http.Handler) http.Handler) Router

+ type RouterHandler func(w http.ResponseWriter, r *http.Request) error

+ type Sample media.Sample

+ type ScreenConfiguration struct

+ Height int

+ Rates map[int]int16

+ Width int

+ type ScreenSize struct

+ Height int

+ Rate int16

+ Width int

+ type ScreencastManager interface

+ Enabled func() bool

+ Image func() ([]byte, error)

+ Started func() bool

+ type Session interface

+ GetWebRTCPeer func() WebRTCPeer

+ GetWebSocketPeer func() WebSocketPeer

+ ID func() string

+ IsHost func() bool

+ PrivateModeEnabled func() bool

+ Profile func() MemberProfile

+ Send func(event string, payload any)

+ SetCursor func(cursor Cursor)

+ SetWebRTCConnected func(webrtcPeer WebRTCPeer, connected bool)

+ SetWebRTCPeer func(webrtcPeer WebRTCPeer)

+ SetWebSocketConnected func(websocketPeer WebSocketPeer, connected bool, delayed bool)

+ SetWebSocketPeer func(websocketPeer WebSocketPeer)

+ State func() SessionState

+ type SessionManager interface

+ AdminBroadcast func(event string, payload any, exclude ...string)

+ Authenticate func(r *http.Request) (Session, error)

+ Broadcast func(event string, payload any, exclude ...string)

+ ClearHost func()

+ CookieClearToken func(w http.ResponseWriter, r *http.Request)

+ CookieEnabled func() bool

+ CookieSetToken func(w http.ResponseWriter, token string)

+ Create func(id string, profile MemberProfile) (Session, string, error)

+ Delete func(id string) error

+ Get func(id string) (Session, bool)

+ GetByToken func(token string) (Session, bool)

+ GetHost func() (Session, bool)

+ InactiveCursorsBroadcast func(event string, payload any, exclude ...string)

+ List func() []Session

+ OnConnected func(listener func(session Session))

+ OnCreated func(listener func(session Session))

+ OnDeleted func(listener func(session Session))

+ OnDisconnected func(listener func(session Session))

+ OnHostChanged func(listener func(session Session))

+ OnProfileChanged func(listener func(session Session))

+ OnSettingsChanged func(listener func(new Settings, old Settings))

+ OnStateChanged func(listener func(session Session))

+ PopCursors func() map[Session][]Cursor

+ SetCursor func(cursor Cursor, session Session)

+ SetHost func(host Session)

+ Settings func() Settings

+ Update func(id string, profile MemberProfile) error

+ UpdateSettings func(Settings)

+ type SessionState struct

+ IsConnected bool

+ IsWatching bool

+ type Settings struct

+ ImplicitHosting bool

+ InactiveCursors bool

+ MercifulReconnect bool

+ PrivateMode bool

+ type StreamSinkManager interface

+ AddListener func(listener *func(sample Sample)) error

+ Codec func() codec.RTPCodec

+ ListenersCount func() int

+ MoveListenerTo func(listener *func(sample Sample), targetStream StreamSinkManager) error

+ RemoveListener func(listener *func(sample Sample)) error

+ Started func() bool

+ type StreamSrcManager interface

+ Codec func() codec.RTPCodec

+ Push func(bytes []byte)

+ Start func(codec codec.RTPCodec) error

+ Started func() bool

+ Stop func()

+ type VideoConfig struct

+ Fps string

+ GstEncoder string

+ GstParams map[string]string

+ GstPipeline string

+ GstPrefix string

+ GstSuffix string

+ Height string

+ Width string

+ func (config *VideoConfig) GetPipeline(screen ScreenSize) (string, error)

+ type WebRTCManager interface

+ CreatePeer func(session Session, videoID string) (*webrtc.SessionDescription, error)

+ ICEServers func() []ICEServer

+ SetCursorPosition func(x, y int)

+ Shutdown func() error

+ Start func()

+ type WebRTCPeer interface

+ CreateAnswer func() (*webrtc.SessionDescription, error)

+ CreateOffer func(ICERestart bool) (*webrtc.SessionDescription, error)

+ Destroy func()

+ SendCursorImage func(cur *CursorImage, img []byte) error

+ SendCursorPosition func(x, y int) error

+ SetAnswer func(sdp string) error

+ SetCandidate func(candidate webrtc.ICECandidateInit) error

+ SetOffer func(sdp string) error

+ SetPaused func(isPaused bool) error

+ SetVideoID func(videoID string) error

+ type WebSocketHandler func(Session, WebSocketMessage) bool

+ type WebSocketManager interface

+ AddHandler func(handler WebSocketHandler)

+ Shutdown func() error

+ Start func()

+ Upgrade func(checkOrigin CheckOrigin) RouterHandler

+ type WebSocketMessage struct

+ Event string

+ Payload json.RawMessage

+ type WebSocketPeer interface

+ Destroy func(reason string)

+ Ping func() error

+ Send func(event string, payload any)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL