axparameter

package

v1.5.4 Latest Latest Go to latest Published: May 3, 2024 License: GPL-3.0 Imports: 7 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

Repository

github.com/Cacsjep/goxis

Links

Open Source Insights

Documentation ¶

Overview ¶

Package axparameter provides a Go interface to the AXParameter library, enabling the management of application-specific parameters on Axis devices.

Index ¶

func GoParameterCallback(name *C.gchar, value *C.gchar, user_data unsafe.Pointer)
type AXParameter
- func AXParameterNew(appName string) (*AXParameter, error)
type GError
- func (e *GError) Error() string
type ParameterCallback
type ParameterChangeEvent

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GoParameterCallback ¶

func GoParameterCallback(name *C.gchar, value *C.gchar, user_data unsafe.Pointer)

Types ¶

type AXParameter ¶

type AXParameter struct {
	Ptr *C.AXParameter
	// contains filtered or unexported fields
}

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axparameter/html/ax__parameter_8h.html#a454ef604d7741f45804e708a56f7bf24

func AXParameterNew ¶

func AXParameterNew(appName string) (*AXParameter, error)

Creates a new AXParameter.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axparameter/html/ax__parameter_8h.html#adf2eefe79f53d60faede33ba71d5928c

func (*AXParameter) Add ¶

func (axp *AXParameter) Add(name string, initialValue string, ptype string) error

Adds a new parameter. Returns failure if the parameter already exists.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axparameter/html/ax__parameter_8h.html#a9069e0a2a3c64cacd7d50f1408a9f5fa

func (*AXParameter) Free ¶

func (axp *AXParameter) Free()

Frees an AXParameter.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axparameter/html/ax__parameter_8h.html#a78ff4b5a312a1d9aab120436c116a5a2

func (*AXParameter) Get ¶

func (axp *AXParameter) Get(name string) (string, error)

Retrieves the value of a parameter.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axparameter/html/ax__parameter_8h.html#aa7979d96d425189cfbf5fac6539bbc68

func (*AXParameter) GetAsFloat ¶

func (axp *AXParameter) GetAsFloat(name string) (float64, error)

func (*AXParameter) GetAsInt ¶

func (axp *AXParameter) GetAsInt(name string) (int, error)

func (*AXParameter) List ¶

func (axp *AXParameter) List() ([]string, error)

Lists all parameters for the application.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axparameter/html/ax__parameter_8h.html#ace7b30d51c85d90509de80086b00d655

func (*AXParameter) OnAnyChange ¶

func (axp *AXParameter) OnAnyChange(callback func(*ParameterChangeEvent)) error

func (*AXParameter) OnChange ¶

func (axp *AXParameter) OnChange(param_name string, callback func(*ParameterChangeEvent)) error

func (*AXParameter) RegisterCallback ¶

func (axp *AXParameter) RegisterCallback(name string, callback ParameterCallback, userdata any) error

Registers a callback function to be run whenever the given named parameter is changed, eg value updated.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axparameter/html/ax__parameter_8h.html#a43ae8096bdcad55ff26bf13eadc3b781

func (*AXParameter) Remove ¶

func (axp *AXParameter) Remove(name string) error

Removes a parameter. Returns FALSE if the parameter doesn't exist.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axparameter/html/ax__parameter_8h.html#aa6f49de80979e1f25ea9d98c449ac8c4

func (*AXParameter) Set ¶

func (axp *AXParameter) Set(name string, value string, doSync bool) error

Sets the value of a parameter.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axparameter/html/ax__parameter_8h.html#a3b767bcb3c99edf38b9fab3f38b7f2d7

func (*AXParameter) UnregisterCallback ¶

func (axp *AXParameter) UnregisterCallback(name string) error

Unregisters the parameter callback function.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axparameter/html/ax__parameter_8h.html#a4e3b5330dfbe45fad22753c83a1ee065

type GError ¶

type GError struct {
	Ptr      *C.GError
	Code     int
	Message  string
	Expected bool
}

func (*GError) Error ¶

func (e *GError) Error() string

type ParameterCallback ¶

type ParameterCallback func(name string, value string, userdata any)

The typedef for a callback function registered by ax_parameter_register_callback() https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axparameter/html/ax__parameter_8h.html#a82ba0fc58e5e8749b1313825b6a7a670

type ParameterChangeEvent ¶

type ParameterChangeEvent struct {
	Name  string
	Value string
}

Source Files ¶

View all Source files

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