amcrest

Documentation

Index

• Constants
• type AmcrestClient
  • func New(host string, username string, password string) *AmcrestClient
  • func (c *AmcrestClient) GetConfig(configName string) ([]ConfigValue, error)
  • func (c *AmcrestClient) GetEncodingConfigCapabilities() ([]ConfigValue, error)
  • func (c *AmcrestClient) GetSnapshot(channel ...int) (GetSnapshotResponse, error)
  • func (c *AmcrestClient) SetConfig(inputs ...ConfigValue) error
• type ConfigValue
  • func ConfigValueFromString(input string) (ConfigValue, error)
  • func (c ConfigValue) ToParamString() string
• type GetSnapshotResponse

Constants

const EncodeConfig string = "Encode"

const EncodeTypeAlarm int = 2

const EncodeTypeMotion int = 1

const EncodeTypeRegular int = 0

const ExtraFormat string = "ExtraFormat"

const GeneralConfig string = "General"

const MainFormat string = "MainFormat"

const SnapConfig string = "Snap"

const SnapFormat string = "SnapFormat"

const VideoBitRateControlParam string = "Video.BitRateControl"

const VideoBitRateParam string = "Video.BitRate"

const VideoCompressionParam string = "Video.Compression"

const VideoEncodingH263 string = "H263"

const VideoEncodingH264 string = "H264"

const VideoEncodingH265 string = "H265"

const VideoEncodingMJPG string = "MJPG"

const VideoEncodingMPEG1 string = "MPEG1"

const VideoEncodingMPEG2 string = "MPEG2"

const VideoEncodingMPEG4 string = "MPEG4"

const VideoFPSParam string = "Video.FPS"

const VideoGOPParam string = "Video.GOP"

const VideoResolution1080P = VideoResolution1920x1080

const VideoResolution1920x1080 string = "1920x1080"

const VideoResolution2560x1920 string = "2560x1920"

const VideoResolution5_1M = VideoResolution2560x1920

const VideoResolutionDefault string = "720x576"

const VideoResolutionParam string = "Video.resolution"

Types

type AmcrestClient

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

func New

func New(host string, username string, password string) *AmcrestClient

func (*AmcrestClient) GetConfig

func (c *AmcrestClient) GetConfig(configName string) ([]ConfigValue, error)

func (*AmcrestClient) GetEncodingConfigCapabilities

func (c *AmcrestClient) GetEncodingConfigCapabilities() ([]ConfigValue, error)

func (*AmcrestClient) GetSnapshot

func (c *AmcrestClient) GetSnapshot(channel ...int) (GetSnapshotResponse, error)

Get a snapshot from the specified channel

Parameter

channel int (optional): the channel index (starts at 1)

func (*AmcrestClient) SetConfig

func (c *AmcrestClient) SetConfig(inputs ...ConfigValue) error

type ConfigValue

type ConfigValue struct {
	// Category[Channel].FormatType[FormatEncodeType].Param=Value
	Category         string
	Channel          int // The channel index (starts at 0)
	FormatType       string
	FormatEncodeType int
	Param            string
	Value            any
}

func ConfigValueFromString

func ConfigValueFromString(input string) (ConfigValue, error)

Parse config values from a string

input: a string like "Category[Channel].FormatType[FormatEncodeType].Param.Name=Value"

func (ConfigValue) ToParamString

func (c ConfigValue) ToParamString() string

type GetSnapshotResponse

type GetSnapshotResponse struct {
	MimeType string
	Data     []byte
}