NI-IMAQdx Properties
From NI-IMAQdx VI
NI-IMAQdx Properties
Refer to the class name below for the properties associated with each NI-IMAQdx class. Refer to the NI-IMAQdx Function Reference Help for more information about NI-IMAQdx properties and attributes.
| Attribute | Long Name | Type | Description |
|---|---|---|---|
| BaseAddress | Camera Information : Base Address |  |
Read only. Gets the base address of the camera registers. |
| BusType | Camera Information : Bus Type | Read only. Gets the bus type of the camera. | |
| ModelName | Camera Information : Model Name |  |
Read only. Returns the model name. |
| SerialNumberHigh | Camera Information : Serial Number High | |
Read only. Gets the upper 32-bits of the camera 64-bit serial number. |
| SerialNumberLow | Camera Information : Serial Number Low | |
Read only. Gets the lower 32-bits of the camera 64-bit serial number. |
| VendorName | Camera Information : Vendor Name | |
Read only. Returns the vendor name. |
| HostIPAddress | Camera Information : Host IP Address | |
Read only. Returns the host adapter IP address. |
| IPAddress | Camera Information : IP Address | |
Read only. Returns the IP address. |
| PrimaryURLString | Camera Information : Primary URL String | |
Read only. Gets the camera's primary URL string. |
| SecondaryURLString | Camera Information : Secondary URL String | |
Read only. Gets the camera's secondary URL string. |
| AcquisitionInProgress | Status Information : Acquisition In Progress |  |
Read only. Gets the current state of the acquisition. TRUE if acquiring; otherwise FALSE. |
| BufferCount | Status Information : Last Buffer Count | |
Read only. Gets the number of transferred buffers. |
| LastBufferNumber | Status Information : Last Buffer Number | |
Read only. Gets the last cumulative buffer number transferred. |
| LostBufferCount | Status Information : Lost Buffer Count | |
Read only. Gets the number of lost buffers during an acquisition session. |
| LostPacketCount | Status Information : Lost Packet Count | |
Read only. Gets the number of lost packets during an acquisition session. |
| RequestedResendPackets | Status Information : Requested Resend Packet Count | |
Read only. Gets the number of packets requested to be resent during an acquisition session. |
| ReceivedResendPackets | Status Information : Received Resend Packets | |
Read only. Gets the number of packets that were requested to be resent during an acquisition session and were completed. |
| BayerGainB | Acquisition Attributes : Bayer : Gain B |  |
Sets/gets the white balance gain for the blue component of the Bayer conversion. |
| BayerGainG | Acquisition Attributes : Bayer : Gain G | |
Sets/gets the white balance gain for the green component of the Bayer conversion. |
| BayerGainR | Acquisition Attributes : Bayer : Gain R | |
Sets/gets the white balance gain for the red component of the Bayer conversion. |
| BayerPattern | Acquisition Attributes : Bayer : Pattern | Sets/gets the Bayer pattern to use. | |
| StreamChannelMode | Acquisition Attributes : Controller : Stream Channel Mode | Gets/sets the mode for allocating a FireWire stream channel. | |
| DesiredStreamChannel | Acquisition Attributes : Controller : Desired Stream Channel | |
Gets/sets the stream channel to manually allocate. |
| FrameInterval | Acquisition Attributes : Frame Interval | |
Read only. Gets the duration in milliseconds between successive frames. |
| IgnoreFirstFrame | Acquisition Attributes : Ignore First Frame | |
Gets/sets the video delay of one frame between starting the camera and receiving the video feed. |
| OffsetX | Acquisition Attributes : Offset X | |
Gets/sets the left offset of the image. |
| OffsetY | Acquisition Attributes : Offset Y | |
Gets/sets the top offset of the image. |
| Width | Acquisition Attributes : Width | |
Gets/sets the width of the image. |
| Height | Acquisition Attributes : Height | |
Gets/sets the height of the image. |
| PixelFormat | Acquisition Attributes : Pixel Format | |
Gets/sets the pixel format of the source sensor. |
| PacketSize | Acquisition Attributes : Packet Size | |
Gets/sets the packet size in bytes. |
| PayloadSize | Acquisition Attributes : Payload Size | |
Gets/sets the frame size in bytes. |
| Speed | Acquisition Attributes : Speed | Gets/sets the transfer speed in Mbps for a FireWire packet. | |
| ShiftPixelBits | Acquisition Attributes : Shift Pixel Bits | |
Gets/sets the alignment of 16-bit cameras. Downshift the pixel bits if the camera returns most significant bit-aligned data. |
| SwapPixelBytes | Acquisition Attributes : Swap Pixel Bytes | |
Gets/sets the endianness of 16-bit cameras. Swap the pixel bytes if the camera returns little endian data. |
| OverwriteMode | Acquisition Attributes : Overwrite Mode | Gets/sets the overwrite mode, used to determine acquisition when an image transfer cannot be completed due to an overwritten internal buffer. | |
| Timeout | Acquisition Attributes : Timeout | |
Gets/sets the timeout value in milliseconds, used to abort an acquisition when the image transfer cannot be completed within the delay. |
| VideoMode | Acquisition Attributes : Video Mode | |
Gets/sets the video mode for a camera. |
| BitsPerPixel | Acquisition Attributes : Bits Per Pixel | Gets/sets the actual bits per pixel. For 16-bit components, this represents the actual bit depth (10-, 12-, 14-, or 16-bit). | |
| ReserveDualPackets | Acquisition Attributes : Reserve Dual Packets | |
Gets/sets if dual packets will be reserved for a very large FireWire packet. |
| ReceiveTimestampMode | Acquisition Attributes : Receive Timestamp Mode | Gets/sets the mode for timestamping images received by the driver. | |
| ActualPeakBandwidth | Acquisition Attributes : Advanced Ethernet : Bandwidth Control : Actual Peak Bandwidth | |
Read only. Returns the actual maximum peak bandwidth the camera will be configured to use. |
| DesiredPeakBandwidth | Acquisition Attributes : Advanced Ethernet : Bandwidth Control : Desired Peak Bandwidth | |
Gets/sets the desired maximum peak bandwidth the camera should use. |
| DestinationMode | Acquisition Attributes : Advanced Ethernet : Controller : Destination Mode | Gets/Sets where the camera is instructed to send the image stream. | |
| DestinationMulticastAddress | Acquisition Attributes : Advanced Ethernet : Controller : Destination Multicast Address | |
Gets/Sets the multicast address the camera should send data in multicast mode. |
| LostPacketMode | Acquisition Attributes : Advanced Ethernet : Lost Packet Mode | Gets/sets the behavior when the user extracts a buffer that has missing packets. | |
| MemoryWindowSize | Acquisition Attributes : Advanced Ethernet : Resend Parameters : Memory Window Size | |
Gets/sets the size of the memory window of the camera in kilobytes. Should match the camera's internal buffer size. |
| ResendsEnabled | Acquisition Attributes : Advanced Ethernet : Resend Parameters : Resends Enabled | |
Gets/sets if resends will be issued for missing packets. |
| ResendThresholdPercentage | Acquisition Attributes : Advanced Ethernet : Resend Parameters : Resend Threshold Percentage | |
Gets/sets the threshold of the packet processing window that will trigger packets to be resent. |
| ResendBatchingPercentage | Acquisition Attributes : Advanced Ethernet : Resend Parameters : Resend Batching Percentage | |
Gets/sets the percent of the packet resend threshold that will be issued as one group past the initial threshold sent in a single request. |
| MaxResendsPerPacket | Acquisition Attributes : Advanced Ethernet : Resend Parameters : Max Resends Per Packet | |
Gets/sets the maximum number of resend requests that will be issued for a missing packet. |
| ResendResponseTimeout | Acquisition Attributes : Advanced Ethernet : Resend Parameters : Resend Response Timeout | |
Gets/sets the time to wait for a resend request to be satisfied before sending another. |
| NewPacketTimeout | Acquisition Attributes : Advanced Ethernet : Resend Parameters : New Packet Timeout | |
Gets/sets the time to wait for new packets to arrive in a partially completed image before assuming the rest of the image was lost. |
| MissingPacketTimeout | Acquisition Attributes : Advanced Ethernet : Resend Parameters : Missing Packet Timeout | |
Gets/sets the time to wait for a missing packet before issuing a resend. |
| ResendTimerResolution | Acquisition Attributes : Advanced Ethernet : Resend Parameters : Resend Timer Resolution | |
Gets/sets the resolution of the packet processing system that is used for all packet-related timeouts. |
| ActiveAttribute | Camera Attributes : Active Attribute | |
Gets/sets the active attribute |
| ValueU32 | Camera Attributes : Value : U32 | |
Gets/sets the current value as an integer for the active attribute. |
| ValueI64 | Camera Attributes : Value : I64 |  |
Gets/sets the current value as a 64-bit integer for the active attribute. |
| ValueDBL | Camera Attributes : Value : DBL | |
Gets/sets the current value as a double precision floating point number for the active attribute. |
| ValueString | Camera Attributes : Value : String | |
Gets/sets the current value as a string for the active attribute. |
| ValueBool | Camera Attributes : Value : Bool | |
Gets/sets the current value as a boolean for the active attribute. |
| MinU32 | Camera Attributes : Minimum : U32 | |
Read only. Gets the current minimum as an integer for the active attribute. |
| MinI64 | Camera Attributes : Minimum : I64 | |
Read only. Gets the current minimum as a 64-bit integer for the active attribute. |
| MinDBL | Camera Attributes : Minimum : DBL | |
Read only. Gets the current minimum as a double precision floating point number for the active attribute. |
| MinString | Camera Attributes : Minimum : String | |
Read only. Gets the current minimum as a string for the active attribute. |
| MaxU32 | Camera Attributes : Maximum : U32 | |
Read only. Gets the current maximum as an integer for the active attribute. |
| MaxI64 | Camera Attributes : Maximum : I64 | |
Read only. Gets the current maximum as a 64-bit integer for the active attribute. |
| MaxDBL | Camera Attributes : Maximum : DBL | |
Read only. Gets the current maximum as a double precision floating point number for the active attribute. |
| MaxString | Camera Attributes : Maximum : String | |
Read only. Gets the current maximum as a string for the active attribute.- |
| Type | Camera Attributes : Type | Read only. Gets the active type for the active attribute. | |
| EnumValues[] | Camera Attributes : Enum : Values[] |  |
Read only. Returns an array of enum attribute values for the active attribute. |
| EnumStrings[] | Camera Attributes : Enum : Strings[] |  |
Read only. Returns an array of enum attribute strings for the active attribute. |
| IsReadable | Camera Attributes : Is Readable | |
Read only. Gets the read access for the active attribute. TRUE if readable; otherwise FALSE. |
| IsWritable | Camera Attributes : Is Writable | |
Read only. Gets the write access for the active attribute. TRUE if writable; otherwise FALSE. |
| IncU32 | Camera Attributes : Increment : U32 | |
Read only. Gets the increment as an integer for the active attribute. |
| IncI64 | Camera Attributes : Increment : I64 | |
Read only. Gets the increment as a 64-bit integer for the active attribute. |
| IncDBL | Camera Attributes : Increment : DBL | |
Read only. Gets the increment as a double precision floating point number for the active attribute. |
| IncString | Camera Attributes : Increment : String | |
Read only. Gets the increment as a string for the active attribute. |
| Tooltip | Camera Attributes : Tooltip | |
Read only. Gets the tooltip for the active attribute. |
| Units | Camera Attributes : Units | |
Read only. Gets the units for the active attribute. |
| Visibility | Camera Attributes : Visibility | Read only. Gets the visibility for the active attribute. | |
| Description | Camera Attributes : Description | |
Read only. Gets the description for the active attribute. |
| DisplayName | Camera Attributes : Display Name | |
Read only. Gets the display name for the active attribute. |