onvif

README

Go-ONVIF

Go-ONVIF is a Go package for communicating with network camera which supports the ONVIF specifications. ONVIF (Open Network Video Interface) is an open industry forum promoting and developing global standards for interfaces of IP-based physical security products such as network cameras. Recently, almost all network cameras support ONVIF specifications, especially network camera that made in China, which usually can bought with cheap price.

Progress

This package is still in develoment following guide from ONVIF, with several features already available.

License

Go-ONVIF is distributed using MIT license, which means you can use it however you want as long as you preserve copyright and license notices of this package.

Documentation

Index

• type AudioEncoderConfig
• type Device
  • func StartDiscovery(duration time.Duration) ([]Device, error)
  • func StartDiscoveryWithContext(ctx context.Context, addrs []net.Addr, duration time.Duration) ([]Device, error)
  • func (device Device) GetCapabilities() (DeviceCapabilities, error)
  • func (device Device) GetDiscoveryMode() (string, error)
  • func (device Device) GetHostname() (HostnameInformation, error)
  • func (device Device) GetInformation() (DeviceInformation, error)
  • func (device Device) GetNetworkInterfaces() (NetworkInterfaces, error)
  • func (device Device) GetNetworkProtocols() ([]NetworkProtocol, error)
  • func (device Device) GetProfiles() ([]MediaProfile, error)
  • func (device Device) GetScopes() ([]string, error)
  • func (device Device) GetStreamURI(profileToken, protocol string) (MediaURI, error)
• type DeviceCapabilities
• type DeviceInformation
• type ErrNewUnsupportedError
  • func NewUnsupportedError(subCode, detail string) ErrNewUnsupportedError
  • func (e ErrNewUnsupportedError) Error() string
• type ErrOperationProhibited
  • func NewErrOperationProhibited(detail string) ErrOperationProhibited
  • func (e ErrOperationProhibited) Error() string
• type FromDHCP
• type HostnameInformation
• type IPv4
• type IPv4Config
• type MediaBounds
• type MediaProfile
• type MediaSourceConfig
• type MediaURI
• type NetworkCapabilities
• type NetworkInfo
• type NetworkInterfaces
• type NetworkProtocol
• type NetworkProtocolsResponse
• type OnvifErr
• type PTZConfig
• type SOAP
  • func (soap SOAP) SendRequest(xaddr string) (mxj.Map, error)
• type VideoEncoderConfig
• type VideoRateControl

Types

type AudioEncoderConfig

type AudioEncoderConfig struct {
	Name           string
	Token          string
	Encoding       string
	Bitrate        int
	SampleRate     int
	SessionTimeout string
}

AudioEncoderConfig contains configuration of an audio encoder

type Device

type Device struct {
	ID       string
	Name     string
	XAddr    string
	User     string
	Password string
}

Device contains data of ONVIF camera

func StartDiscovery

func StartDiscovery(duration time.Duration) ([]Device, error)

StartDiscovery send a WS-Discovery message and wait for all matching device to respond

func StartDiscoveryWithContext

func StartDiscoveryWithContext(ctx context.Context, addrs []net.Addr, duration time.Duration) ([]Device, error)

func (Device) GetCapabilities

func (device Device) GetCapabilities() (DeviceCapabilities, error)

GetCapabilities fetch info of ONVIF camera's capabilities

func (Device) GetDiscoveryMode

func (device Device) GetDiscoveryMode() (string, error)

GetDiscoveryMode fetch network discovery mode of an ONVIF camera

func (Device) GetHostname

func (device Device) GetHostname() (HostnameInformation, error)

GetHostname fetch hostname of an ONVIF camera

func (Device) GetInformation

func (device Device) GetInformation() (DeviceInformation, error)

GetInformation fetch information of ONVIF camera

func (Device) GetNetworkInterfaces

func (device Device) GetNetworkInterfaces() (NetworkInterfaces, error)

GetNetworkInterfaces fetches the Network Interfaces of an ONVIF camera

func (Device) GetNetworkProtocols

func (device Device) GetNetworkProtocols() ([]NetworkProtocol, error)

GetNetworkProtocols fetches the network protocols that you can access the device on.

func (Device) GetProfiles

func (device Device) GetProfiles() ([]MediaProfile, error)

GetProfiles fetch available media profiles of ONVIF camera

func (Device) GetScopes

func (device Device) GetScopes() ([]string, error)

GetScopes fetch scopes of an ONVIF camera

func (Device) GetStreamURI

func (device Device) GetStreamURI(profileToken, protocol string) (MediaURI, error)

GetStreamURI fetch stream URI of a media profile. Possible protocol is UDP, HTTP or RTSP

type DeviceCapabilities

type DeviceCapabilities struct {
	Network   NetworkCapabilities
	Events    map[string]bool
	Streaming map[string]bool
}

DeviceCapabilities contains capabilities of an ONVIF camera

type DeviceInformation

type DeviceInformation struct {
	FirmwareVersion string
	HardwareID      string
	Manufacturer    string
	Model           string
	SerialNumber    string
}

DeviceInformation contains information of ONVIF camera

type ErrNewUnsupportedError

type ErrNewUnsupportedError OnvifErr

func NewUnsupportedError

func NewUnsupportedError(subCode, detail string) ErrNewUnsupportedError

func (ErrNewUnsupportedError) Error

func (e ErrNewUnsupportedError) Error() string

type ErrOperationProhibited

type ErrOperationProhibited OnvifErr

func NewErrOperationProhibited

func NewErrOperationProhibited(detail string) ErrOperationProhibited

func (ErrOperationProhibited) Error

func (e ErrOperationProhibited) Error() string

type FromDHCP

type FromDHCP struct {
	Address      string
	PrefixLength string
}

type HostnameInformation

type HostnameInformation struct {
	Name     string
	FromDHCP bool
}

HostnameInformation contains hostname info of an ONVIF camera

type IPv4

type IPv4 struct {
	Enabled    string
	IPv4Config IPv4Config `json:"Config"`
}

type IPv4Config

type IPv4Config struct {
	DHCP     string
	FromDHCP FromDHCP `json:"FromDHCP"`
}

type MediaBounds

type MediaBounds struct {
	Height int
	Width  int
}

MediaBounds contains resolution of a video media

type MediaProfile

type MediaProfile struct {
	Name               string
	Token              string
	VideoSourceConfig  MediaSourceConfig
	VideoEncoderConfig VideoEncoderConfig
	AudioSourceConfig  MediaSourceConfig
	AudioEncoderConfig AudioEncoderConfig
	PTZConfig          PTZConfig
}

MediaProfile contains media profile of an ONVIF camera

type MediaSourceConfig

type MediaSourceConfig struct {
	Name        string
	Token       string
	SourceToken string
	Bounds      MediaBounds
}

MediaSourceConfig contains configuration of a media source

type MediaURI

type MediaURI struct {
	URI                 string
	Timeout             string
	InvalidAfterConnect bool
	InvalidAfterReboot  bool
}

MediaURI contains streaming URI of an ONVIF camera

type NetworkCapabilities

type NetworkCapabilities struct {
	DynDNS     bool
	IPFilter   bool
	IPVersion6 bool
	ZeroConfig bool
}

NetworkCapabilities contains networking capabilities of ONVIF camera

type NetworkInfo

type NetworkInfo struct {
	HwAddress string
}

type NetworkInterfaces

type NetworkInterfaces struct {
	Enabled string
	IPv4    IPv4
	// IPv6    IPv6
	Info NetworkInfo
}

type NetworkProtocol

type NetworkProtocol struct {
	Enabled bool
	Name    string
	Port    int64
}

type NetworkProtocolsResponse

type NetworkProtocolsResponse struct {
	NetworkProtocols []networkProtocol `json:"NetworkProtocols"`
}

type OnvifErr

type OnvifErr struct {
	Detail string
	// contains filtered or unexported fields
}

type PTZConfig

type PTZConfig struct {
	Name      string
	Token     string
	NodeToken string
}

PTZConfig contains configuration of a PTZ control in camera

type SOAP

type SOAP struct {
	Body     string
	XMLNs    []string
	User     string
	Password string
	TokenAge time.Duration
}

SOAP contains data for SOAP request

func (SOAP) SendRequest

func (soap SOAP) SendRequest(xaddr string) (mxj.Map, error)

SendRequest sends SOAP request to xAddr

type VideoEncoderConfig

type VideoEncoderConfig struct {
	Name           string
	Token          string
	Encoding       string
	Quality        int
	RateControl    VideoRateControl
	Resolution     MediaBounds
	SessionTimeout string
}

VideoEncoderConfig contains configuration of a video encoder

type VideoRateControl

type VideoRateControl struct {
	BitrateLimit     int
	EncodingInterval int
	FrameRateLimit   int
}

VideoRateControl contains rate control of a video