onvif

README

ONVIF Plugin

Documentation

Documentation

Index

• Constants
• Variables
• func DownloadSnapshotBind(plugin *plugin) func(entityId string) string
• func GetSnapshotUriBind(plugin *plugin) func(entityId string) string
• func New() supervisor.Pluggable
• func NewActions() map[string]supervisor.ActorAction
• func NewAttr() m.Attributes
• func NewSettings() map[string]*m.Attribute
• func NewStates() (states map[string]supervisor.ActorState)
• type Actor
  • func NewActor(entity *m.Entity, service supervisor.Service) (actor *Actor)
  • func (a *Actor) Destroy()
  • func (a *Actor) GetSnapshotUri() string
  • func (a *Actor) SetState(params supervisor.EntityStateParams) error
  • func (a *Actor) Spawn()
• type Client
  • func NewClient(handler func(interface{})) *Client
  • func (s *Client) ContinuousMove(X, Y float32) error
  • func (s *Client) GetCapabilities() error
  • func (s *Client) GetSnapshotURI() *string
  • func (s *Client) GetStreamList() ([]string, error)
  • func (s *Client) Shutdown() (err error)
  • func (s *Client) Start(username, password, address string, port int64, requireAuthorization bool) (err error)
  • func (s *Client) StopContinuousMove() error
• type ClientBind
  • func NewClientBind(client *Client) *ClientBind
  • func (c *ClientBind) ContinuousMove(X, Y float32)
  • func (c *ClientBind) StopContinuousMove()
• type ConnectionStatus
• type MotionAlarm
• type StreamList

Constants

const (
	// Name ...
	Name = "onvif"
	// FuncEntityAction ...
	FuncEntityAction = "entityAction"

	Version = "0.0.1"

	AttrAddress              = "address"
	AttrOnvifPort            = "onvifPort"
	AttrRtspPort             = "rtspPort"
	AttrUserName             = "userName"
	AttrPassword             = "password"
	AttrConnected            = "connected"
	AttrOffline              = "offline"
	AttrRequireAuthorization = "requireAuthorization"

	AttrMotion     = "motion"
	AttrMotionTime = "motionTime"

	ActionContinuousMove     = "continuousMove"
	ActionStopContinuousMove = "stopContinuousMove"
)

Variables

var F embed.FS

Functions

func DownloadSnapshotBind

func DownloadSnapshotBind(plugin *plugin) func(entityId string) string

experimental method ...

func GetSnapshotUriBind

func GetSnapshotUriBind(plugin *plugin) func(entityId string) string

func New

func New() supervisor.Pluggable

New ...

func NewActions

func NewActions() map[string]supervisor.ActorAction

func NewAttr

func NewAttr() m.Attributes

NewAttr ...

func NewSettings

func NewSettings() map[string]*m.Attribute

NewSettings ...

func NewStates

func NewStates() (states map[string]supervisor.ActorState)

NewStates ...

Types

type Actor

type Actor struct {
	*supervisor.BaseActor
	// contains filtered or unexported fields
}

Actor ...

func NewActor

func NewActor(entity *m.Entity,
	service supervisor.Service) (actor *Actor)

NewActor ...

func (*Actor) Destroy

func (a *Actor) Destroy()

func (*Actor) GetSnapshotUri

func (a *Actor) GetSnapshotUri() string

func (*Actor) SetState

func (a *Actor) SetState(params supervisor.EntityStateParams) error

SetState ...

func (*Actor) Spawn

func (a *Actor) Spawn()

Spawn ...

type Client

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

func NewClient

func NewClient(handler func(interface{})) *Client

func (*Client) ContinuousMove

func (s *Client) ContinuousMove(X, Y float32) error

func (*Client) GetCapabilities

func (s *Client) GetCapabilities() error

func (*Client) GetSnapshotURI

func (s *Client) GetSnapshotURI() *string

func (*Client) GetStreamList

func (s *Client) GetStreamList() ([]string, error)

func (*Client) Shutdown

func (s *Client) Shutdown() (err error)

func (*Client) Start

func (s *Client) Start(username, password, address string, port int64, requireAuthorization bool) (err error)

func (*Client) StopContinuousMove

func (s *Client) StopContinuousMove() error

type ClientBind

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

func NewClientBind

func NewClientBind(client *Client) *ClientBind

func (*ClientBind) ContinuousMove

func (c *ClientBind) ContinuousMove(X, Y float32)

func (*ClientBind) StopContinuousMove

func (c *ClientBind) StopContinuousMove()

type ConnectionStatus

type ConnectionStatus struct {
	Connected bool
}

type MotionAlarm

type MotionAlarm struct {
	State bool
	Time  time.Time
}

type StreamList

type StreamList struct {
	List        []string
	SnapshotUri *string
}