axevent

package
v1.5.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 3, 2024 License: GPL-3.0 Imports: 6 Imported by: 0

Documentation

Overview

Package axeventwrapper provides a Go wrapper around the axevent C library, facilitating the integration and manipulation of event systems within Axis devices.

Important: 

This package relies on CGo for integration with the axevent C library and the GLib library, necessitating a running GMainLoop for proper operation.

Index

Constants

This section is empty.

Variables

View Source 
var (
	OnfivNameSpaceTns1    string = "tns1"
	OnfivNameSpaceTnsAxis string = "tnsaxis"
	OnfivTagOnKeyValue    string = "tag-on-key-value"
)

Functions

func GoDeclarationCompleteCallback 

func GoDeclarationCompleteCallback(declaration C.guint, user_data unsafe.Pointer)

func GoSubscriptionCallback 

func GoSubscriptionCallback(subscription C.guint, event *C.AXEvent, user_data unsafe.Pointer)

Types

type AXEvent 

type AXEvent struct {
	Ptr *C.AXEvent
}

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event_8h.html#a06778bcedc5cf3aaba11d40fba6bef33

func NewAxEvent 

func NewAxEvent(axEventKeyValueSet *AXEventKeyValueSet, datetime *time.Time) *AXEvent

Creates a new AXEvent.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event_8h.html#a788775473fa91f3503b42616c7626e2b

func (*AXEvent) Free 

func (axEvent *AXEvent) Free()

Free an AXEvent.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event_8h.html#a011c2d3b82c8e9cbcf0fab02610a5020

func (*AXEvent) GetKeyValueSet 

func (axEvent *AXEvent) GetKeyValueSet() *AXEventKeyValueSet

Get the AXEventKeyValueSet associated with the AXEvent.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event_8h.html#abc27a691c703d11563ef0b0f338fc775

func (*AXEvent) GetTimestamp 

func (axEvent *AXEvent) GetTimestamp() time.Time

Get the AXEventKeyValueSet associated with the AXEvent.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event_8h.html#a37fcd4106a9ed74e315bbbec24c941fa

type AXEventErrorCode 

type AXEventErrorCode int

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event__error_8h.html 

const (
	AXEventErrorGeneric           AXEventErrorCode = AXEventErrorCode(C.AX_EVENT_ERROR_GENERIC)
	AXEventErrorInvalidArgument   AXEventErrorCode = AXEventErrorCode(C.AX_EVENT_ERROR_INVALID_ARGUMENT)
	AXEventErrorIncompatibleValue AXEventErrorCode = AXEventErrorCode(C.AX_EVENT_ERROR_INCOMPATIBLE_VALUE)
	AXEventErrorDeclaration       AXEventErrorCode = AXEventErrorCode(C.AX_EVENT_ERROR_DECLARATION)
	AXEventErrorUndeclare         AXEventErrorCode = AXEventErrorCode(C.AX_EVENT_ERROR_UNDECLARE)
	AXEventErrorSend              AXEventErrorCode = AXEventErrorCode(C.AX_EVENT_ERROR_SEND)
	AXEventErrorSubscription      AXEventErrorCode = AXEventErrorCode(C.AX_EVENT_ERROR_SUBSCRIPTION)
	AXEventErrorUnsubscribe       AXEventErrorCode = AXEventErrorCode(C.AX_EVENT_ERROR_UNSUBSCRIBE)
	AXEventErrorKeyNotFound       AXEventErrorCode = AXEventErrorCode(C.AX_EVENT_ERROR_KEY_NOT_FOUND)
	AXEventErrorEnd               AXEventErrorCode = AXEventErrorCode(C.AX_EVENT_ERROR_END)
)

func (AXEventErrorCode) ErrorName 

func (code AXEventErrorCode) ErrorName() string

ErrorName returns the string representation of the AxOverlayErrorCode.

type AXEventHandler 

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

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event__handler_8h.html#ae40c17762e9ed663356e34c5a9ea05fe

func NewEventHandler 

func NewEventHandler() *AXEventHandler

Creates a new AXEventHandler.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event__handler_8h.html#aeb60d443c4006c0deb4ea3763f896de2

func (*AXEventHandler) Declare 

func (eh *AXEventHandler) Declare(keyValueSet *AXEventKeyValueSet, stateless bool, callback DeclarationCompleteCallback, userdata any) (declaration int, err error)

Declares a new event.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event__handler_8h.html#a069c6140889e0b0aec24b8a1f9063ebc

func (*AXEventHandler) DeclareFromTemplate 

func (eh *AXEventHandler) DeclareFromTemplate(template string, keyValueSet *AXEventKeyValueSet, callback DeclarationCompleteCallback, userdata any) (int, error)

Declares a new event based upon an event template

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event__handler_8h.html#aa7d1fd47acc735ded14835b1b2c693f3

func (*AXEventHandler) Free 

func (eh *AXEventHandler) Free()

Destroys an AXEventHandler an deallocates all associated declarations and subscriptions. Any pending callbacks associated with the AXEventHandler will be cancelled.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event__handler_8h.html#ac8fa0ee5cba77fffffad4153833b040d

func (*AXEventHandler) OnEvent 

func (eh *AXEventHandler) OnEvent(kvs *AXEventKeyValueSet, callback func(*Event)) (subscription int, err error)

OnEvent creates a subscription callback for the given event key value set.

func (*AXEventHandler) SendEvent 

func (ev *AXEventHandler) SendEvent(declaration int, evt *AXEvent) error

Sends an event.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event__handler_8h.html#ac45d53fe12862e3799e2abb133b50d7a

func (*AXEventHandler) Subscribe 

func (eh *AXEventHandler) Subscribe(kvs *AXEventKeyValueSet, callback SubscriptionCallback, userdata any) (subscription int, err error)

Subscribes to an event or a set of events.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event__handler_8h.html#a5688da60eeea59fd1d50f394a8177fc9

func (*AXEventHandler) Undeclare 

func (evt *AXEventHandler) Undeclare(declaration int) error

Undeclares an event. Any pending callbacks associated with the declaration will be cancelled.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event__handler_8h.html#a61d4484571aacc5547f9e5bf524fd01d

func (*AXEventHandler) Unsubscribe 

func (eh *AXEventHandler) Unsubscribe(subscription int) error

Unsubscribes from an event or a set of events.

https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event__handler_8h.html#ae18cd4f8d25c6fc555d91fde187dac8d

type AXEventKeyValueSet 

type AXEventKeyValueSet struct {
	Ptr *C.AXEventKeyValueSet
}

https://axiscommunications.github.io/acap-documentation/3.5/api/axevent/html/ax__event__key__value__set_8h.html

func AutofocusEventKvs 

func AutofocusEventKvs(videoSourceConfigurationToken *int) (*AXEventKeyValueSet, error)

func CameraApplicationPlatformVmdCamera1ProfileANYEventKvs 

func CameraApplicationPlatformVmdCamera1ProfileANYEventKvs(active *bool) (*AXEventKeyValueSet, error)

func DayNightEventKvs 

func DayNightEventKvs(videoSourceConfigurationToken *int, day *bool) (*AXEventKeyValueSet, error)

func DigitalInputEventKvs 

func DigitalInputEventKvs(inputToken *int, logicalState *bool) (*AXEventKeyValueSet, error)

func GlobalSceneChangeEventKvs 

func GlobalSceneChangeEventKvs(source *string, state *bool) (*AXEventKeyValueSet, error)

func HeaterStatusEventKvs 

func HeaterStatusEventKvs(heater *int, running *bool) (*AXEventKeyValueSet, error)

func LiveStreamAccessedEventKvs 

func LiveStreamAccessedEventKvs() (*AXEventKeyValueSet, error)

func MotionAlarmEventKvs 

func MotionAlarmEventKvs(source *string, state *bool) (*AXEventKeyValueSet, error)

func NewAXEventKeyValueSet 

func NewAXEventKeyValueSet() *AXEventKeyValueSet

Creates a new AXEventKeyValueSet

func NewAXEventKeyValueSetFromEntries 

func NewAXEventKeyValueSetFromEntries(entries []KeyValueEntrie) *AXEventKeyValueSet

Creates a new AXEventKeyValueSet from a list of KeyValueEntries

func NewTns1AxisEvent 

func NewTns1AxisEvent(topic0 string, topic1 string, topic2 *string, topic3 *string, keyvalues []*KeyValueEntrie) (*AXEventKeyValueSet, error)

NewTns1AxisEvent creates a new AXEventKeyValueSet with the given topics and key-value pairs.

func NewTnsAxisEvent 

func NewTnsAxisEvent(topic0 string, topic1 string, topic2 *string, topic3 *string, keyvalues []*KeyValueEntrie) (*AXEventKeyValueSet, error)

TnsAxisEvent creates a new AXEventKeyValueSet with the given topics and key-value pairs.

func StorageAlertEventKvs 

func StorageAlertEventKvs(wear *int, overall_health *int, temperature *int, alert *bool) (*AXEventKeyValueSet, error)

func StorageDisruptionEventKvs 

func StorageDisruptionEventKvs(disk_id *string, disruption *bool) (*AXEventKeyValueSet, error)

func StorageFailureEventKvs 

func StorageFailureEventKvs(disk_id *string, disruption *bool) (*AXEventKeyValueSet, error)

func StorageRecordingEventKvs 

func StorageRecordingEventKvs(recording *bool) (*AXEventKeyValueSet, error)

func SupervisedPortEventKvs 

func SupervisedPortEventKvs(port *int, tampered *bool) (*AXEventKeyValueSet, error)

func SystemReadyStatusEventKvs 

func SystemReadyStatusEventKvs(ready *bool) (*AXEventKeyValueSet, error)

func TamperingEventKvs 

func TamperingEventKvs(channel *int, tampering *int) (*AXEventKeyValueSet, error)

func TriggerRelayEventKvs 

func TriggerRelayEventKvs(relayToken *int, logicalState *string) (*AXEventKeyValueSet, error)

func VirtualInputEventKvs 

func VirtualInputEventKvs(port *int, active *bool) (*AXEventKeyValueSet, error)

func (*AXEventKeyValueSet) AddKeyValue 

func (axEventKeyValueSet *AXEventKeyValueSet) AddKeyValue(key string, namespace *string, value interface{}, value_type AXEventValueType) error

Adds an key value to the event set

func (*AXEventKeyValueSet) AddNiceNames 

func (axEventKeyValueSet *AXEventKeyValueSet) AddNiceNames(key string, namespace *string, keyNiceName *string, valueNiceName *string) error

AddNiceNames sets human-readable names for a key/value pair in an AXEventKeyValueSet.

func (*AXEventKeyValueSet) Free 

func (axEventKeyValueSet *AXEventKeyValueSet) Free()

Frees an AXEventKeyValueSet.

func (*AXEventKeyValueSet) GetBoolean 

func (axEventKeyValueSet *AXEventKeyValueSet) GetBoolean(key string, namespace *string) (bool, error)

Retrieve the boolean value associated with a key.

func (*AXEventKeyValueSet) GetDouble 

func (axEventKeyValueSet *AXEventKeyValueSet) GetDouble(key string, namespace *string) (float64, error)

Retrieve the double value associated with a key.

func (*AXEventKeyValueSet) GetInteger 

func (axEventKeyValueSet *AXEventKeyValueSet) GetInteger(key string, namespace *string) (int, error)

Retrieve the integer value associated with a key.

func (*AXEventKeyValueSet) GetString 

func (axEventKeyValueSet *AXEventKeyValueSet) GetString(key string, namespace *string) (string, error)

Retrieve the value type of the value associated with a key.

func (*AXEventKeyValueSet) GetValueType 

func (axEventKeyValueSet *AXEventKeyValueSet) GetValueType(key string, namespace *string) (AXEventValueType, error)

Retrieve the value type of the value associated with a key.

func (*AXEventKeyValueSet) MarkAsData 

func (axEventKeyValueSet *AXEventKeyValueSet) MarkAsData(key string, namespace *string) error

Mark a key in the AXEventKeyValueSet as data. A data key is a key that represents the state of what the event represents. E.g. an event declaration that represents an I/O port should have a key marked as data which represents the state, high or low, of the port. Please note that although it is possible to mark more than one key as data, only events with one and only one data key can be used to trigger actions.

func (*AXEventKeyValueSet) MarkAsSource 

func (axEventKeyValueSet *AXEventKeyValueSet) MarkAsSource(key string, namespace *string) error

Mark a key in the AXEventKeyValueSet as a source. A source key is an identifier used to distinguish between multiple instances of the same event declaration. E.g. if a device has multiple I/O ports then event declarations that represent the state of each port will have the same keys but different values. The key that represents which port the event represents should be marked as source and the key which represents the state should be marked as data. Please note that although it is possible to mark more than one key as a source, only events with zero or one source keys can be used to trigger actions.

func (*AXEventKeyValueSet) MarkAsUserDefined 

func (axEventKeyValueSet *AXEventKeyValueSet) MarkAsUserDefined(key string, namespace *string, userTag *string) error

Mark a key in AXEventKeyValueSet with an user defined tag.

func (*AXEventKeyValueSet) RemoveKey 

func (axEventKeyValueSet *AXEventKeyValueSet) RemoveKey(key string, namespace *string) error

Removes a key and its associated value from an AXEventKeyValueSet.

type AXEventValueType 

type AXEventValueType int
const (
	AXValueTypeInt     AXEventValueType = AXEventValueType(C.AX_VALUE_TYPE_INT)
	AXValueTypeBool    AXEventValueType = AXEventValueType(C.AX_VALUE_TYPE_BOOL)
	AXValueTypeDouble  AXEventValueType = AXEventValueType(C.AX_VALUE_TYPE_DOUBLE)
	AXValueTypeString  AXEventValueType = AXEventValueType(C.AX_VALUE_TYPE_STRING)
	AXValueTypeElement AXEventValueType = AXEventValueType(C.AX_VALUE_TYPE_ELEMENT)
)

type AutofocusEvent 

type AutofocusEvent struct {
	VideoSourceConfigurationToken int     `eventKey:"VideoSourceConfigurationToken"`
	Focus                         float64 `eventKey:"focus"`
}

type AxEventKeyValueSetDataMark 

type AxEventKeyValueSetDataMark struct {
	Key       string
	Namespace *string
}

Mark a key in the AXEventKeyValueSet as data. A data key is a key that represents the state of what the event represents. E.g. an event declaration that represents an I/O port should have a key marked as data which represents the state, high or low, of the port. Please note that although it is possible to mark more than one key as data, only events with one and only one data key can be used to trigger actions.

type AxEventKeyValueSetNiceNames 

type AxEventKeyValueSetNiceNames struct {
	Key           string
	Namespace     *string
	KeyNiceName   *string
	ValueNiceName *string
}

Set the nice names of a key/value pair in the AXEventKeyValueSet. Nice names can be used to display human-readable information about the key/value pair.

type AxEventKeyValueSetSourceMark 

type AxEventKeyValueSetSourceMark struct {
	Key       string
	Namespace *string
}

Mark a key in the AXEventKeyValueSet as a source. A source key is an identifier used to distinguish between multiple instances of the same event declaration. E.g. if a device has multiple I/O ports then event declarations that represent the state of each port will have the same keys but different values. The key that represents which port the event represents should be marked as source and the key which represents the state should be marked as data. Please note that although it is possible to mark more than one key as a source, only events with zero or one source keys can be used to trigger actions.

type AxEventKeyValueSetUserDefineMark 

type AxEventKeyValueSetUserDefineMark struct {
	Key       string
	Namespace *string
	Tag       *string
}

Mark a key in AXEventKeyValueSet with an user defined tag.

type CameraApplicationPlatformVmdCamera1ProfileANYEvent 

type CameraApplicationPlatformVmdCamera1ProfileANYEvent struct {
	Active bool `eventKey:"active"`
}

type DayNightEvent 

type DayNightEvent struct {
	VideoSourceConfigurationToken int  `eventKey:"VideoSourceConfigurationToken"`
	Day                           bool `eventKey:"day"`
}

type DeclarationCompleteCallback 

type DeclarationCompleteCallback func(subscription int, userdata any)

This is the prototype of the callback function called when a declaration has registered with the event system. https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event__handler_8h.html#a16d563cbc9c8974b72f296f8dfbdff3a

type DigitalInputEvent 

type DigitalInputEvent struct {
	InputToken   int  `eventKey:"InputToken"`
	LogicalState bool `eventKey:"LogicalState"`
}

type Event 

type Event struct {
	Kvs       *AXEventKeyValueSet
	Timestamp time.Time
}

type EventError 

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

func (*EventError) Error 

func (e *EventError) Error() string

type GlobalSceneChangeEvent 

type GlobalSceneChangeEvent struct {
	Source string `eventKey:"Source"`
	State  bool   `eventKey:"State"`
}

type HeaterStatusEvent 

type HeaterStatusEvent struct {
	Heater  int  `eventKey:"heater"`
	Running bool `eventKey:"running"`
}

type KeyValueEntrie 

type KeyValueEntrie struct {
	Key       string
	Namespace *string
	Value     interface{}
	ValueType AXEventValueType
}

KeyValueEntrie is a key-value pair for an AXEventKeyValueSet.

type LiveStreamAccessedEvent 

type LiveStreamAccessedEvent struct {
	Accessed bool `eventKey:"accessed"`
}

type MotionAlarmEvent 

type MotionAlarmEvent struct {
	Source string `eventKey:"Source"`
	State  bool   `eventKey:"State"`
}

type StorageAlertEvent 

type StorageAlertEvent struct {
	Wear          int `eventKey:"wear"`
	OverallHealth int `eventKey:"overall_health"`

	Tampered bool `eventKey:"alert"`
	// contains filtered or unexported fields
}

type StorageDisruptionEvent 

type StorageDisruptionEvent struct {
	DiskId     string `eventKey:"disk_id"`
	Disruption bool   `eventKey:"disruption"`
}

type StorageFailureEvent 

type StorageFailureEvent struct {
	DiskId     string `eventKey:"disk_id"`
	Disruption bool   `eventKey:"disruption"`
}

type StorageRecordingEvent 

type StorageRecordingEvent struct {
	Recording bool `eventKey:"recording"`
}

type Subcription 

type Subcription uint

type SubscriptionCallback 

type SubscriptionCallback func(subscription int, event *AXEvent, userdata any)

This is the prototype of the callback function called whenever an event matching a subscription is received. https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/api/src/api/axevent/html/ax__event__handler_8h.html#ad1bb63bc12366aefb50139ea6a8b3904

type SupervisedPortEvent 

type SupervisedPortEvent struct {
	Port     int  `eventKey:"port"`
	Tampered bool `eventKey:"tampered"`
}

type SystemReadyStatusEvent 

type SystemReadyStatusEvent struct {
	Ready int `eventKey:"ready"`
}

type TamperingEvent 

type TamperingEvent struct {
	Channel   int `eventKey:"channel"`
	Tampering int `eventKey:"tampering"`
}

type TriggerRelayEvent 

type TriggerRelayEvent struct {
	RelayToken   int    `eventKey:"RelayToken"`
	LogicalState string `eventKey:"LogicalState"`
}

type VirtualInputEvent 

type VirtualInputEvent struct {
	Port   int  `eventKey:"port"`
	Active bool `eventKey:"active"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.