Class eBUSDotNet
Main wrapper class for the eBUS .NET SDK providing access to Pleora Technologies' eBUS SDK functionality. This class contains static utility methods for pixel type operations, SDK error codes, pixel format constants, and version information for the eBUS SDK.
Inherited Members
Namespace: eBUSDotNet
Assembly: eBUSDotNet.dll
Syntax
public class eBUSDotNet
Fields
View SourceGDC_1D
Part type for standard 1D array data.
Declaration
public static readonly int GDC_1D
Field Value
| Type | Description |
|---|---|
| int |
GDC_2D
Part type for standard uncompressed 2D image data.
Declaration
public static readonly int GDC_2D
Field Value
| Type | Description |
|---|---|
| int |
GDC_2D_H264
Part type for H.264 compressed 2D image data.
Declaration
public static readonly int GDC_2D_H264
Field Value
| Type | Description |
|---|---|
| int |
GDC_2D_JPEG
Part type for JPEG compressed 2D image data.
Declaration
public static readonly int GDC_2D_JPEG
Field Value
| Type | Description |
|---|---|
| int |
GDC_2D_JPEG2000
Part type for JPEG 2000 compressed 2D image data.
Declaration
public static readonly int GDC_2D_JPEG2000
Field Value
| Type | Description |
|---|---|
| int |
GDC_COMPONENT_HEADER
HeaderType value indicating a GenDC component header.
Declaration
public static readonly int GDC_COMPONENT_HEADER
Field Value
| Type | Description |
|---|---|
| int |
GDC_COMPONENT_PART_COUNT_MIN
Minimum number of part offset entries in a GenDC component header.
Declaration
public static readonly int GDC_COMPONENT_PART_COUNT_MIN
Field Value
| Type | Description |
|---|---|
| int |
GDC_CONFIDENCE
Component type for confidence map data.
Declaration
public static readonly int GDC_CONFIDENCE
Field Value
| Type | Description |
|---|---|
| int |
GDC_CONTAINER_COMPONENT_COUNT_MIN
Minimum number of component offset entries in a GenDC container header.
Declaration
public static readonly int GDC_CONTAINER_COMPONENT_COUNT_MIN
Field Value
| Type | Description |
|---|---|
| int |
GDC_CONTAINER_HEADER
HeaderType value indicating a GenDC container header.
Declaration
public static readonly int GDC_CONTAINER_HEADER
Field Value
| Type | Description |
|---|---|
| int |
GDC_CUSTOM_COMPONENT
Default custom component type value.
Declaration
public static readonly int GDC_CUSTOM_COMPONENT
Field Value
| Type | Description |
|---|---|
| int |
GDC_CUSTOM_COMPONENT_MAX
Maximum value for custom component types.
Declaration
public static readonly int GDC_CUSTOM_COMPONENT_MAX
Field Value
| Type | Description |
|---|---|
| int |
GDC_CUSTOM_COMPONENT_MIN
Minimum value for custom component types.
Declaration
public static readonly int GDC_CUSTOM_COMPONENT_MIN
Field Value
| Type | Description |
|---|---|
| int |
GDC_DISPARITY
Component type for stereo camera disparity data.
Declaration
public static readonly int GDC_DISPARITY
Field Value
| Type | Description |
|---|---|
| int |
GDC_EXTENDED_COMPONENT
Base value for extended (non-standard) component types.
Declaration
public static readonly int GDC_EXTENDED_COMPONENT
Field Value
| Type | Description |
|---|---|
| int |
GDC_FLOW_TABLE_HEADER
HeaderType value indicating a GenDC flow table header.
Declaration
public static readonly int GDC_FLOW_TABLE_HEADER
Field Value
| Type | Description |
|---|---|
| int |
GDC_GENERIC_PART_1D
Generic part type for 1D array data parts.
Declaration
public static readonly int GDC_GENERIC_PART_1D
Field Value
| Type | Description |
|---|---|
| int |
GDC_GENERIC_PART_2D
Generic part type for 2D image data parts.
Declaration
public static readonly int GDC_GENERIC_PART_2D
Field Value
| Type | Description |
|---|---|
| int |
GDC_GENERIC_PART_CUSTOM
Generic part type for custom data parts.
Declaration
public static readonly int GDC_GENERIC_PART_CUSTOM
Field Value
| Type | Description |
|---|---|
| int |
GDC_GENERIC_PART_METADATA
Generic part type for metadata parts.
Declaration
public static readonly int GDC_GENERIC_PART_METADATA
Field Value
| Type | Description |
|---|---|
| int |
GDC_GENERIC_PART_TYPE_MASK
Bitmask to extract the generic part type category from a part HeaderType.
Declaration
public static readonly int GDC_GENERIC_PART_TYPE_MASK
Field Value
| Type | Description |
|---|---|
| int |
GDC_HEADER_TYPE_MASK
Bitmask to extract the header type field from a HeaderType value.
Declaration
public static readonly int GDC_HEADER_TYPE_MASK
Field Value
| Type | Description |
|---|---|
| int |
GDC_INFRARED
Component type for non-visible infrared light data.
Declaration
public static readonly int GDC_INFRARED
Field Value
| Type | Description |
|---|---|
| int |
GDC_INTENSITY
Component type for intensity (monochrome or color) image data.
Declaration
public static readonly int GDC_INTENSITY
Field Value
| Type | Description |
|---|---|
| int |
GDC_METADATA
Component type for metadata.
Declaration
public static readonly int GDC_METADATA
Field Value
| Type | Description |
|---|---|
| int |
GDC_METADATA_GENICAM_CHUNK
Part type for GenICam chunk metadata.
Declaration
public static readonly int GDC_METADATA_GENICAM_CHUNK
Field Value
| Type | Description |
|---|---|
| int |
GDC_METADATA_GENICAM_XML
Part type for GenICam XML metadata.
Declaration
public static readonly int GDC_METADATA_GENICAM_XML
Field Value
| Type | Description |
|---|---|
| int |
GDC_MULTISPECTRAL
Component type for multispectral band data.
Declaration
public static readonly int GDC_MULTISPECTRAL
Field Value
| Type | Description |
|---|---|
| int |
GDC_PART_HEADER
HeaderType value indicating a generic GenDC part header.
Declaration
public static readonly int GDC_PART_HEADER
Field Value
| Type | Description |
|---|---|
| int |
GDC_PART_HEADER_MAX
Maximum HeaderType value for GenDC part headers.
Declaration
public static readonly int GDC_PART_HEADER_MAX
Field Value
| Type | Description |
|---|---|
| int |
GDC_PART_HEADER_MIN
Minimum HeaderType value for GenDC part headers.
Declaration
public static readonly int GDC_PART_HEADER_MIN
Field Value
| Type | Description |
|---|---|
| int |
GDC_RANGE
Component type for range (distance/depth) data.
Declaration
public static readonly int GDC_RANGE
Field Value
| Type | Description |
|---|---|
| int |
GDC_REFLECTANCE
Component type for reflected intensity acquired with range data.
Declaration
public static readonly int GDC_REFLECTANCE
Field Value
| Type | Description |
|---|---|
| int |
GDC_RESERVED_COMPONENT
Reserved component type value (not for use).
Declaration
public static readonly int GDC_RESERVED_COMPONENT
Field Value
| Type | Description |
|---|---|
| int |
GDC_SCATTER
Component type for scattered light data.
Declaration
public static readonly int GDC_SCATTER
Field Value
| Type | Description |
|---|---|
| int |
GDC_SIGNATURE
GenDC container signature value ("GNDC" in little-endian ASCII).
Declaration
public static readonly int GDC_SIGNATURE
Field Value
| Type | Description |
|---|---|
| int |
GDC_ULTRAVIOLET
Component type for non-visible ultraviolet light data.
Declaration
public static readonly int GDC_ULTRAVIOLET
Field Value
| Type | Description |
|---|---|
| int |
GDC_UNDEFINED_COMPONENT
Component type indicating an undefined or unknown component.
Declaration
public static readonly int GDC_UNDEFINED_COMPONENT
Field Value
| Type | Description |
|---|---|
| int |
GDC_UNDEFINED_HEADER
HeaderType value indicating an undefined or unknown header.
Declaration
public static readonly int GDC_UNDEFINED_HEADER
Field Value
| Type | Description |
|---|---|
| int |
GDC_UNDEFINED_PART
Part type indicating an undefined or unknown part.
Declaration
public static readonly int GDC_UNDEFINED_PART
Field Value
| Type | Description |
|---|---|
| int |
GDC_VERSION_MAJOR
GenDC specification major version number.
Declaration
public static readonly int GDC_VERSION_MAJOR
Field Value
| Type | Description |
|---|---|
| int |
GDC_VERSION_MINOR
GenDC specification minor version number.
Declaration
public static readonly int GDC_VERSION_MINOR
Field Value
| Type | Description |
|---|---|
| int |
GDC_VERSION_SUBMINOR
GenDC specification subminor version number.
Declaration
public static readonly int GDC_VERSION_SUBMINOR
Field Value
| Type | Description |
|---|---|
| int |
NVERSION_STRING
Complete version string in the format A.B.C.D.
Declaration
public static readonly string NVERSION_STRING
Field Value
| Type | Description |
|---|---|
| string |
PRODUCT_NAME
Product name.
Declaration
public static readonly string PRODUCT_NAME
Field Value
| Type | Description |
|---|---|
| string |
PRODUCT_NAME_MEDIUM
Product name.
Declaration
public static readonly string PRODUCT_NAME_MEDIUM
Field Value
| Type | Description |
|---|---|
| string |
PRODUCT_NAME_SHORT
Product name.
Declaration
public static readonly string PRODUCT_NAME_SHORT
Field Value
| Type | Description |
|---|---|
| string |
PVBITSPERPIXELMASK
Mask to extract the bits per pixel from a pixel type.
Declaration
public const uint PVBITSPERPIXELMASK = 16711680
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL10BIT
10 bits per pixel.
Declaration
public const uint PVPIXEL10BIT = 655360
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL12BIT
12 bits per pixel.
Declaration
public const uint PVPIXEL12BIT = 786432
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL14BIT
14 bits per pixel.
Declaration
public const uint PVPIXEL14BIT = 917504
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL16BIT
16 bits per pixel.
Declaration
public const uint PVPIXEL16BIT = 1048576
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL1BIT
1 bit per pixel.
Declaration
public const uint PVPIXEL1BIT = 65536
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL20BIT
20 bits per pixel.
Declaration
public const uint PVPIXEL20BIT = 1310720
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL24BIT
24 bits per pixel.
Declaration
public const uint PVPIXEL24BIT = 1572864
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL2BIT
2 bits per pixel.
Declaration
public const uint PVPIXEL2BIT = 131072
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL30BIT
30 bits per pixel.
Declaration
public const uint PVPIXEL30BIT = 1966080
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL32BIT
32 bits per pixel.
Declaration
public const uint PVPIXEL32BIT = 2097152
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL36BIT
36 bits per pixel.
Declaration
public const uint PVPIXEL36BIT = 2359296
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL40BIT
40 bits per pixel.
Declaration
public const uint PVPIXEL40BIT = 2621440
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL48BIT
48 bits per pixel.
Declaration
public const uint PVPIXEL48BIT = 3145728
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL4BIT
4 bits per pixel.
Declaration
public const uint PVPIXEL4BIT = 262144
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL64BIT
64 bits per pixel.
Declaration
public const uint PVPIXEL64BIT = 4194304
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL8BIT
8 bits per pixel.
Declaration
public const uint PVPIXEL8BIT = 524288
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXEL96BIT
96 bits per pixel.
Declaration
public const uint PVPIXEL96BIT = 6291456
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXELCOLOR
Pixel type mask for color pixels (GEV 1.1+).
Declaration
public const uint PVPIXELCOLOR = 33554432
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXELCOLORMASK
Mask to extract the color component from a pixel type.
Declaration
public const uint PVPIXELCOLORMASK = 4278190080
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXELCUSTOM
Pixel type mask for custom pixels.
Declaration
public const uint PVPIXELCUSTOM = 2147483648
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXELIDMASK
Mask to extract the pixel type ID.
Declaration
public const uint PVPIXELIDMASK = 65535
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXELMONO
Pixel type mask for monochrome pixels.
Declaration
public const uint PVPIXELMONO = 16777216
Field Value
| Type | Description |
|---|---|
| uint |
PVPIXELRGB
Pixel type mask for RGB pixels (pre GEV 1.1).
Declaration
public const uint PVPIXELRGB = 33554432
Field Value
| Type | Description |
|---|---|
| uint |
PV_ABORTED
The operation was aborted.
Declaration
public const uint PV_ABORTED = 1
Field Value
| Type | Description |
|---|---|
| uint |
PV_AUTO_ABORTED
Buffer reception failed, auto-aborted.
Declaration
public const uint PV_AUTO_ABORTED = 2818
Field Value
| Type | Description |
|---|---|
| uint |
PV_BAD_VERSION
Some component versions are not compatible.
Declaration
public const uint PV_BAD_VERSION = 513
Field Value
| Type | Description |
|---|---|
| uint |
PV_BUFFER_TOO_SMALL
The buffer was not large enough to hold the payload.
Declaration
public const uint PV_BUFFER_TOO_SMALL = 4
Field Value
| Type | Description |
|---|---|
| uint |
PV_BUSY
The resource requested is already in use.
Declaration
public const uint PV_BUSY = 514
Field Value
| Type | Description |
|---|---|
| uint |
PV_CANCEL
The user cancelled the operation.
Declaration
public const uint PV_CANCEL = 16386
Field Value
| Type | Description |
|---|---|
| uint |
PV_CANNOT_OPEN_FILE
The file doesn't exist or can't be opened.
Declaration
public const uint PV_CANNOT_OPEN_FILE = 6
Field Value
| Type | Description |
|---|---|
| uint |
PV_CANT_READ_MANIFEST
The manifest table of the device could not be read.
Declaration
public const uint PV_CANT_READ_MANIFEST = 2309
Field Value
| Type | Description |
|---|---|
| uint |
PV_CORRUPTED_DATA
The data is corrupted.
Declaration
public const uint PV_CORRUPTED_DATA = 771
Field Value
| Type | Description |
|---|---|
| uint |
PV_ERR_OVERFLOW
Overflow occurred.
Declaration
public const uint PV_ERR_OVERFLOW = 27
Field Value
| Type | Description |
|---|---|
| uint |
PV_FILE_ERROR
A file operation error occurred.
Declaration
public const uint PV_FILE_ERROR = 16
Field Value
| Type | Description |
|---|---|
| uint |
PV_GENERIC_ERROR
An undefined error occurred.
Declaration
public const uint PV_GENERIC_ERROR = 16384
Field Value
| Type | Description |
|---|---|
| uint |
PV_GENICAM_XML_ERROR
The GenICam XML file could not be loaded.
Declaration
public const uint PV_GENICAM_XML_ERROR = 2308
Field Value
| Type | Description |
|---|---|
| uint |
PV_IMAGE_ERROR
Error with an image.
Declaration
public const uint PV_IMAGE_ERROR = 37
Field Value
| Type | Description |
|---|---|
| uint |
PV_INVALID_DATA_FORMAT
The data format is not supported for the requested operation.
Declaration
public const uint PV_INVALID_DATA_FORMAT = 1281
Field Value
| Type | Description |
|---|---|
| uint |
PV_INVALID_PARAMETER
A parameter passed to the method is invalid.
Declaration
public const uint PV_INVALID_PARAMETER = 16385
Field Value
| Type | Description |
|---|---|
| uint |
PV_MISSING_PACKETS
Some packets are missing in the buffer.
Declaration
public const uint PV_MISSING_PACKETS = 39
Field Value
| Type | Description |
|---|---|
| uint |
PV_NETWORK_CONFIG_ERROR
A network configuration error occurred.
Declaration
public const uint PV_NETWORK_CONFIG_ERROR = 1536
Field Value
| Type | Description |
|---|---|
| uint |
PV_NETWORK_ERROR
A network error occurred.
Declaration
public const uint PV_NETWORK_ERROR = 19
Field Value
| Type | Description |
|---|---|
| uint |
PV_NOT_CONNECTED
The object is not connected.
Declaration
public const uint PV_NOT_CONNECTED = 23
Field Value
| Type | Description |
|---|---|
| uint |
PV_NOT_ENOUGH_MEMORY
Not enough memory available.
Declaration
public const uint PV_NOT_ENOUGH_MEMORY = 24
Field Value
| Type | Description |
|---|---|
| uint |
PV_NOT_FOUND
The expected item wasn't found.
Declaration
public const uint PV_NOT_FOUND = 25
Field Value
| Type | Description |
|---|---|
| uint |
PV_NOT_IMPLEMENTED
The requested feature or functionality is not implemented.
Declaration
public const uint PV_NOT_IMPLEMENTED = 1540
Field Value
| Type | Description |
|---|---|
| uint |
PV_NOT_INITIALIZED
An error code hasn't been set.
Declaration
public const uint PV_NOT_INITIALIZED = 1541
Field Value
| Type | Description |
|---|---|
| uint |
PV_NOT_SUPPORTED
The requested feature or functionality is not supported.
Declaration
public const uint PV_NOT_SUPPORTED = 26
Field Value
| Type | Description |
|---|---|
| uint |
PV_NO_AVAILABLE_DATA
There is no available data to enumerate.
Declaration
public const uint PV_NO_AVAILABLE_DATA = 20
Field Value
| Type | Description |
|---|---|
| uint |
PV_NO_LICENSE
An eBUS SDK license is missing.
Declaration
public const uint PV_NO_LICENSE = 1538
Field Value
| Type | Description |
|---|---|
| uint |
PV_NO_MORE_ENTRY
There are no more entries to retrieve.
Declaration
public const uint PV_NO_MORE_ENTRY = 1539
Field Value
| Type | Description |
|---|---|
| uint |
PV_NO_MORE_ITEM
No more items available.
Declaration
public const uint PV_NO_MORE_ITEM = 21
Field Value
| Type | Description |
|---|---|
| uint |
PV_OK
Success (immediate).
Declaration
public const uint PV_OK = 0
Field Value
| Type | Description |
|---|---|
| uint |
PV_PENDING
Success (pending) - operation queued but not yet complete.
Declaration
public const uint PV_PENDING = 65535
Field Value
| Type | Description |
|---|---|
| uint |
PV_RESENDS_FAILURE
Failure to receive all missing packets through resends.
Declaration
public const uint PV_RESENDS_FAILURE = 2817
Field Value
| Type | Description |
|---|---|
| uint |
PV_RESYNC
Forced resynchronization occurred.
Declaration
public const uint PV_RESYNC = 40
Field Value
| Type | Description |
|---|---|
| uint |
PV_STATE_ERROR
The system's current state doesn't allow the action.
Declaration
public const uint PV_STATE_ERROR = 28
Field Value
| Type | Description |
|---|---|
| uint |
PV_THREAD_ERROR
An error occurred while performing an operation on a thread.
Declaration
public const uint PV_THREAD_ERROR = 29
Field Value
| Type | Description |
|---|---|
| uint |
PV_TIMEOUT
The operation timed out.
Declaration
public const uint PV_TIMEOUT = 30
Field Value
| Type | Description |
|---|---|
| uint |
PV_TOO_MANY_CONSECUTIVE_RESENDS
Too many consecutive resends, buffer reception failed.
Declaration
public const uint PV_TOO_MANY_CONSECUTIVE_RESENDS = 2819
Field Value
| Type | Description |
|---|---|
| uint |
PV_TOO_MANY_RESENDS
Too many resend packets were requested.
Declaration
public const uint PV_TOO_MANY_RESENDS = 2816
Field Value
| Type | Description |
|---|---|
| uint |
SOFTWARE_ROOT
The environmental variable name set to the root of the product.
Declaration
public static readonly string SOFTWARE_ROOT
Field Value
| Type | Description |
|---|---|
| string |
VERSION_BUILD
Build version. D in vA.B.C.D.
Declaration
public static readonly int VERSION_BUILD
Field Value
| Type | Description |
|---|---|
| int |
VERSION_COMMENT
Comment.
Declaration
public static readonly string VERSION_COMMENT
Field Value
| Type | Description |
|---|---|
| string |
VERSION_COMPANY_NAME
Company name.
Declaration
public static readonly string VERSION_COMPANY_NAME
Field Value
| Type | Description |
|---|---|
| string |
VERSION_COPYRIGHT
Copyright string.
Declaration
public static readonly string VERSION_COPYRIGHT
Field Value
| Type | Description |
|---|---|
| string |
VERSION_LICENSING_STRING
Licensing string.
Declaration
public static readonly string VERSION_LICENSING_STRING
Field Value
| Type | Description |
|---|---|
| string |
VERSION_MAJOR
Major version. A in vA.B.C.D.
Declaration
public static readonly int VERSION_MAJOR
Field Value
| Type | Description |
|---|---|
| int |
VERSION_MINOR
Minor version. B in vA.B.C.D.
Declaration
public static readonly int VERSION_MINOR
Field Value
| Type | Description |
|---|---|
| int |
VERSION_STRING
Complete version string in the format A, B, C, D.
Declaration
public static readonly string VERSION_STRING
Field Value
| Type | Description |
|---|---|
| string |
VERSION_SUB
Sub version. C in vA.B.C.D.
Declaration
public static readonly int VERSION_SUB
Field Value
| Type | Description |
|---|---|
| int |
VERSION_TRADEMARK
Trademark string.
Declaration
public static readonly string VERSION_TRADEMARK
Field Value
| Type | Description |
|---|---|
| string |
Methods
View SourcePvPixelTypeGetBitsPerComponent(PvPixelType)
Static method returning the number of bit per components for a pixel type.
Declaration
public static uint PvPixelTypeGetBitsPerComponent(PvPixelType aPixelType)
Parameters
| Type | Name | Description |
|---|---|---|
| PvPixelType | aPixelType | The pixel type to query |
Returns
| Type | Description |
|---|---|
| uint | The number of bits per component |
PvPixelTypeGetBitsPerPixel(PvPixelType)
Returns how many bits are required to hold a pixel using the current buffer's pixel type
Declaration
public static uint PvPixelTypeGetBitsPerPixel(PvPixelType aPixelType)
Parameters
| Type | Name | Description |
|---|---|---|
| PvPixelType | aPixelType | The pixel type to query |
Returns
| Type | Description |
|---|---|
| uint | The number of bits required to hold a pixel |
PvPixelTypeGetPixelBitCount(PvPixelType)
Returns the size of one pixel of a specific pixel type, in bits.
Declaration
public static uint PvPixelTypeGetPixelBitCount(PvPixelType aType)
Parameters
| Type | Name | Description |
|---|---|---|
| PvPixelType | aType | The pixel type to query |
Returns
| Type | Description |
|---|---|
| uint | The size of one pixel in bits |
PvPixelTypeGetPixelSize(PvPixelType)
Static method returning the pixel size in bits for a specific pixel type
Declaration
public static uint PvPixelTypeGetPixelSize(PvPixelType aPixelType)
Parameters
| Type | Name | Description |
|---|---|---|
| PvPixelType | aPixelType | The pixel type to query |
Returns
| Type | Description |
|---|---|
| uint | The pixel size in bits |
PvPixelTypeIsPixelColor(PvPixelType)
Returns true if the pixel type is color.
Declaration
public static bool PvPixelTypeIsPixelColor(PvPixelType aPixelType)
Parameters
| Type | Name | Description |
|---|---|---|
| PvPixelType | aPixelType | The pixel type to query |
Returns
| Type | Description |
|---|---|
| bool | True if the pixel type is color, false otherwise |
PvPixelTypeIsPixelHighRes(PvPixelType)
Static method returning whether a pixel type is higher than 8-bit per channel or not
Declaration
public static bool PvPixelTypeIsPixelHighRes(PvPixelType aPixelType)
Parameters
| Type | Name | Description |
|---|---|---|
| PvPixelType | aPixelType | The pixel type to query |
Returns
| Type | Description |
|---|---|
| bool | True if the pixel type is higher than 8-bit per channel, false otherwise |
PvPixelTypeToString(PvPixelType)
Static method returning a string representation of a pixel type.
Declaration
public static string PvPixelTypeToString(PvPixelType aPixelType)
Parameters
| Type | Name | Description |
|---|---|---|
| PvPixelType | aPixelType | The pixel type to convert to string |
Returns
| Type | Description |
|---|---|
| string | A string representation of the pixel type |
PvSessionInfo_GetAddress(PvSessionInfo)
Get the session connection address (IPv4) for a given PvSessionInfo.
Declaration
public static string PvSessionInfo_GetAddress(PvSessionInfo aInfo)
Parameters
| Type | Name | Description |
|---|---|---|
| PvSessionInfo | aInfo | The session info object. |
Returns
| Type | Description |
|---|---|
| string | The session connection address. |
PvSessionInfo_GetLocalAddress(PvSessionInfo)
Get the local address on which the session was discovered for a given PvSessionInfo.
Declaration
public static string PvSessionInfo_GetLocalAddress(PvSessionInfo aInfo)
Parameters
| Type | Name | Description |
|---|---|---|
| PvSessionInfo | aInfo | The session info object. |
Returns
| Type | Description |
|---|---|
| string | The local address on which the session was discovered. |
PvSessionInfo_GetName(PvSessionInfo)
Get the textual session name for a given PvSessionInfo.
Declaration
public static string PvSessionInfo_GetName(PvSessionInfo aInfo)
Parameters
| Type | Name | Description |
|---|---|---|
| PvSessionInfo | aInfo | The session info object. |
Returns
| Type | Description |
|---|---|
| string | The session name. |
PvSessionInfo_GetPort(PvSessionInfo)
Get the session transport port for a given PvSessionInfo.
Declaration
public static ushort PvSessionInfo_GetPort(PvSessionInfo aInfo)
Parameters
| Type | Name | Description |
|---|---|---|
| PvSessionInfo | aInfo | The session info object. |
Returns
| Type | Description |
|---|---|
| ushort | The session transport port. |
PvSessionInfo_SetAddress(PvSessionInfo, string)
Set the session connection address (IPv4) for a given PvSessionInfo.
Declaration
public static void PvSessionInfo_SetAddress(PvSessionInfo aInfo, string aValue)
Parameters
| Type | Name | Description |
|---|---|---|
| PvSessionInfo | aInfo | The session info object. |
| string | aValue | The address to set. |
PvSessionInfo_SetLocalAddress(PvSessionInfo, string)
Set the local address on which the session was discovered for a given PvSessionInfo.
Declaration
public static void PvSessionInfo_SetLocalAddress(PvSessionInfo aInfo, string aValue)
Parameters
| Type | Name | Description |
|---|---|---|
| PvSessionInfo | aInfo | The session info object. |
| string | aValue | The local address to set. |
PvSessionInfo_SetName(PvSessionInfo, string)
Set the textual session name for a given PvSessionInfo.
Declaration
public static void PvSessionInfo_SetName(PvSessionInfo aInfo, string aValue)
Parameters
| Type | Name | Description |
|---|---|---|
| PvSessionInfo | aInfo | The session info object. |
| string | aValue | The session name to set. |
PvSessionInfo_SetPort(PvSessionInfo, ushort)
Set the session transport port for a given PvSessionInfo.
Declaration
public static void PvSessionInfo_SetPort(PvSessionInfo aInfo, ushort aValue)
Parameters
| Type | Name | Description |
|---|---|---|
| PvSessionInfo | aInfo | The session info object. |
| ushort | aValue | The port to set. |