Methods
Top  Previous  Next

The following methods are available in the CGevCamera class:

GigE Vision Server Control

GetInterfaceCount
Returns the number of network interfaces available in the system
GetInterfaceAtIndex
Returns the IP address of the network interface in the system interface list
GetInterfaceInfoAtIndex
Returns the parameters of the network interface in the system interface list
SetDeviceInfo
Sets the device information fields and assigns the name to the XML information file
SetUserDefinedName
Sets the user-defined name of the virtual camera device
SetMacAddress
Assigns the specified MAC address to the virtual camera
SetIpAddress
Sets the IP configuration of the virtual camera device
GetIpAddress
Returns the current IP configuration of the virtual camera device
SetGevMode
Sets the version of the GigE Vision standard for the virtual camera
SetTimerMode
Sets the operational mode of the virtual camera timer
SetMaxImageSize
Sets the maximum horizontal and vertical size of outgoing images
SetStreamChannelCount
Sets the amount of stream channels in the virtual camera
SetActionCount
Sets the amount of action signals supported by the virtual camera
SetAdvancedOptions
Sets advanced operational parameters for the virtual camera
Connect
Brings the virtual camera online and binds it to the specified network interface
Disconnect
Disconnects the virtual camera from the currently selected interface and brings it offline
IsConnected
Return the network connection state of the virtual camera
GetTimer
Returns the current value of the virtual camera timer in nanoseconds
ResetTimer
Resets the internal timer of the virtual camera to zero
ReadRegister
Returns the value of the specified virtual camera register
WriteRegister
Sets the value of the specified virtual camera register
ReadMemory
Reads a block of data from the internal camera memory
WriteMemory
Writes the block of data to the internal camera memory



Image Format and Streaming Control

SetImageSize
Sets the horizontal and vertical size of outgoing images
GetWidth
Returns the current horizontal size of outgoing images
GetHeight
Returns the current vertical size of outgoing images
AddPixelFormat
Adds the specified pixel format to the list of formats supported by the virtual camera
SetPixelFormat
Sets the specified pixel format for outgoing images
GetPixelFormatString
Returns the string value of the current pixel format of outgoing images
GetPixelFormatValue
Returns the numerical value of the current pixel format of outgoing images
GetFormatStringFromValue
Returns the name of the pixel format specified by its numerical ID
GetFormatValueFromString
Returns the numerical ID of the specified pixel format
GetPayloadSize
Returns the current payload size of outgoing images
PixelFormatConvert
Converts image data from a plain pixel format to the specified output format
SetImageCompression
Sets the image compression mode
SetCompressionQuality
Sets the compression quality and bitrate for JPEG and H.264 compressed streams
LockFormat
Synchronizes the image streaming thread with a client application
SendImage
Streams the specified image frame to the network


GenICam Feature Control

CreateCategory
Creates a GenICam category with the specified name
CreateFeature
Creates a GenICam feature with the specified name, type and access mode
CreateAdvancedFeature
Creates a custom GenICam feature with advanced functionality
DeleteFeature
Deletes the existing feature and frees the memory associated with it
AddEnumEntry
Adds an entry to the specified enumerated feature and sets up the parameters of the entry
DeleteEnumEntry
Deletes the specified entry from the enumerated feature
SetFeatureIntValue
Sets the integer value of the specified feature
SetFeatureFloatValue
Sets the value of the specified floating point feature
SetFeatureStingValue
Sets the string of the specified feature
GetFeatureIntValue
Returns the integer value of the specified feature
GetFeatureFloatValue
Returns the value of the specified floating point feature
GetFeatureStringValue
Returns the string value of the specified feature
GetFeatureEnumList
Returns the array of string values representing the specified enumerated feature
SetFeatureIntRange
Assigns the minimum, maximum and increment attributes to the specified feature
SetFeatureRange
Assigns the minimum and maximum attributes to the specified feature
GetFeatureIntRange
Returns the minimum, maximum and increment attributes of the specified feature
GetFeatureRange
Returns the minimum and maximum attributes of the specified feature
SetFeatureAccess
Sets the access mode for the specified feature
SetFeatureDescription
Assigns a description to the specified feature
SetFeatureElement
Sets the value of the specified element associated with the feature
GetFeatureElement
Returns the value of the specified element associated with the feature
DeleteFeatureElement
Deletes the specified element associated with the feature
CreateElementAttribute
Creates an attribute associated with the specified element
GetFeatureRegister
Returns the address of the virtual hardware register associated with the specified feature


Event and Chunk Data Control

CreateEventCategory
Creates the a GenICam category under which event-related features will be grouped
CreateEvent
Creates a GenICam event sub-category with related features, registers and ports
CreateEventFeature
Creates a GenICam feature associated with a data field in the specified event
SendEvent
Sends the specified event message to the network
SendEventData
Sends the specified data event message to the network
SendEvents
Sends multiple event messages to the network
CreateChunkCategory
Creates the a GenICam category under which chunk-related features will be grouped
CreateChunkFeature
Creates a GenICam feature associated with the chunk data field
AddChunkData
Adds a chunk data field to the frame buffer
SetChunkMode
Enables/disables the chunk streaming mode and sets the size of the chunk data block