libtiepie-hw  1.2.1

Select the event that controls the trigger output. More...

Collaboration diagram for Event:

Functions

TIEPIE_HW_API uint64_t tiepie_hw_device_trigger_output_get_events (tiepie_hw_handle handle, uint16_t output)
 Get the supported trigger output events for a specified device trigger output. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_device_trigger_output_get_event (tiepie_hw_handle handle, uint16_t output)
 Get the currently selected trigger output event for a specified device trigger output. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_device_trigger_output_set_event (tiepie_hw_handle handle, uint16_t output, uint64_t value)
 Set the trigger output event for a specified device trigger output. More...
 

Detailed Description

Select the event that controls the trigger output.

Supported events are:

Only one event at a time can be set for a trigger output.

By default, the event is set to TIEPIE_HW_TOE_GENERATOR_START.

Function Documentation

◆ tiepie_hw_device_trigger_output_get_events()

TIEPIE_HW_API uint64_t tiepie_hw_device_trigger_output_get_events ( tiepie_hw_handle  handle,
uint16_t  output 
)

Get the supported trigger output events for a specified device trigger output.

Parameters
[in]handleA device handle identifying the device.
[in]outputThe trigger output index identifying the trigger output, 0 to Dev_trOut_get_count() - 1.
Returns
The supported trigger output events, a set of OR-ed TIEPIE_HW_TOE_* values.
Status values
TIEPIE_HW_STATUS_INVALID_OUTPUT
TIEPIE_HW_STATUS_NOT_SUPPORTED The device has no trigger outputs.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_device_trigger_output_get_event
tiepie_hw_device_trigger_output_set_event
Since
1.0

◆ tiepie_hw_device_trigger_output_get_event()

TIEPIE_HW_API uint64_t tiepie_hw_device_trigger_output_get_event ( tiepie_hw_handle  handle,
uint16_t  output 
)

Get the currently selected trigger output event for a specified device trigger output.

Parameters
[in]handleA device handle identifying the device.
[in]outputThe trigger output index identifying the trigger output, 0 to Dev_trOut_get_count() - 1.
Returns
The currently selected trigger output event, a TIEPIE_HW_TOE_* value.
Status values
TIEPIE_HW_STATUS_INVALID_OUTPUT
TIEPIE_HW_STATUS_NOT_SUPPORTED The device has no trigger outputs.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_device_trigger_output_get_events
tiepie_hw_device_trigger_output_set_event
Since
1.0

◆ tiepie_hw_device_trigger_output_set_event()

TIEPIE_HW_API uint64_t tiepie_hw_device_trigger_output_set_event ( tiepie_hw_handle  handle,
uint16_t  output,
uint64_t  value 
)

Set the trigger output event for a specified device trigger output.

Parameters
[in]handleA device handle identifying the device.
[in]outputThe trigger output index identifying the trigger output, 0 to Dev_trOut_get_count() - 1.
[in]valueTrigger output event, a TIEPIE_HW_TOE_* value.
Returns
Trigger output event, a TIEPIE_HW_TOE_* value.
Status values
TIEPIE_HW_STATUS_INVALID_OUTPUT
TIEPIE_HW_STATUS_INVALID_VALUE The requested event value is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The device has no trigger outputs.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_device_trigger_output_get_events
tiepie_hw_device_trigger_output_get_event
Since
1.0