Class IPvStreamingChannelSource

Interface that is used by #PvSoftDeviceGEV to query and report information from a streaming source implemented by your application.

Inheritance

object

IPvStreamingChannelSource

Implements

IPvStreamingChannelSourceSwigInterface

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNetEdge

Assembly: eBUSDotNetEdge.dll

Syntax

public class IPvStreamingChannelSource : IPvStreamingChannelSourceSwigInterface, IDisposable

Constructors

IPvStreamingChannelSource()

Constructor

Declaration

public IPvStreamingChannelSource()

Fields

swigCMemOwn

Determines who is responsible for deleting the underlying C++ object.

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Methods

CreateGenApiFeatures(IPvRegisterMap, IPvGenApiFactory)

When called, the streaming channel source should create its custom GenApi parameters if they are needed.

Declaration

public virtual void CreateGenApiFeatures(IPvRegisterMap aRegisterMap, IPvGenApiFactory aFactory)

Parameters

Type	Name	Description
IPvRegisterMap	aRegisterMap	The register map of the device.
IPvGenApiFactory	aFactory	GenApi factory used to create the new GenApi features.

CreateRegisters(IPvRegisterMap, IPvRegisterFactory)

When called, the streaming channel source should create its custom registers if they are needed.

Declaration

public virtual void CreateRegisters(IPvRegisterMap aRegisterMap, IPvRegisterFactory aFactory)

Parameters

Type	Name	Description
IPvRegisterMap	aRegisterMap	The register map of the device.
IPvRegisterFactory	aFactory	Register factory used to create the new registers.

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~IPvStreamingChannelSource()

Destructor.

Declaration

protected ~IPvStreamingChannelSource()

GetChunkEnable(uint)

Returns the current chunk enabled state.

Declaration

public virtual bool GetChunkEnable(uint aChunkID)

Parameters

Type	Name	Description
uint	aChunkID	Chunk ID.

Returns

Type	Description
bool	True if the chunk specified by aChunk ID is enabled for this streaming source.

GetChunkModeActive()

Indicates whether the current master chunk mode is active.

Declaration

public virtual bool GetChunkModeActive()

Returns

Type	Description
bool	True if chunk mode is enabled for this streaming source.

GetChunksSize()

Gets the stream channel chunk size attributes.

Declaration

public virtual uint GetChunksSize()

Returns

Type	Description
uint	Chunk data size as currently configured.

GetGevSCPSPacketSizeInfo(out uint)

Get the customized max value for GevSCPSPacketSize. Used at #PvSoftDeviceGEV::Start time to create the GenICam XML of the device.

Declaration

public virtual PvResult GetGevSCPSPacketSizeInfo(out uint aMax)

Parameters

Type	Name	Description
uint	aMax	GevSCPSPacketSize maximum.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK if the default aMax have been changed. #PvResult::Code::NOT_IMPLEMENTED or any other error code if to keep the default settings.

GetHeight()

Returns the current image height.

Declaration

public virtual uint GetHeight()

Returns

Type	Description
uint	Current image height.

GetHeightInfo(out uint, out uint, out uint)

Returns the stream channel height attributes.

Declaration

public virtual void GetHeightInfo(out uint aMin, out uint aMax, out uint aInc)

Parameters

Type	Name	Description
uint	aMin	Height minimum.
uint	aMax	Height maximum.
uint	aInc	Height increment.

GetOffsetX()

Returns the current image offset X.

Declaration

public virtual uint GetOffsetX()

Returns

Type	Description
uint	Current image offset X.

GetOffsetY()

Returns the current image offset Y.

Declaration

public virtual uint GetOffsetY()

Returns

Type	Description
uint	Current image offset Y.

GetPayloadSize()

Stream channel payload size in bytes. Return zero to have it inferred from width, height and pixel format.

Declaration

public virtual uint GetPayloadSize()

Returns

Type	Description
uint	Payload size to use or 0.

GetPixelType()

Returns the current pixel type.

Declaration

public virtual PvPixelType GetPixelType()

Returns

Type	Description
PvPixelType	Current pixel type.

GetScanType()

Returns the scan type that is used by the streaming source.

Declaration

public virtual PvScanType GetScanType()

Returns

Type	Description
PvScanType	Scan type of the streaming source.

GetSupportedChunk(int, out uint, out string)

Returns the indexed supported chunk type. Used at #PvSoftDeviceGEV::Start time to create the GenICam XML of the device.

Declaration

public virtual PvResult GetSupportedChunk(int aIndex, out uint aID, out string aName)

Parameters

Type	Name	Description
int	aIndex	Index of the chunk type to return.
uint	aID	ID of the chunk type requested by aIndex.
string	aName	Name of the chunk type requested by aIndex. Should always use the "Chunk" prefix for GenICam SFNC compliance.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK if aIndex represents a valid index and aPixelType has been set. #PvResult::Code::INVALID_PARAMETER or any other error code if aIndex is not valid.

GetSupportedPixelType(int, out PvPixelType)

Obtains an index of supported pixel types. Used at #PvSoftDeviceGEV::Start time to create the GenICam XML of the device.

Declaration

public virtual PvResult GetSupportedPixelType(int aIndex, out PvPixelType aPixelType)

Parameters

Type	Name	Description
int	aIndex	Index of the pixel type to return.
PvPixelType	aPixelType	PvPixelType requested by aIndex.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK if aIndex represents a valid index and aPixelType has been set. #PvResult::Code::INVALID_PARAMETER or any other error code if aIndex is not valid.

GetWidth()

Returns the current image width.

Declaration

public virtual uint GetWidth()

Returns

Type	Description
uint	Current image width.

GetWidthInfo(out uint, out uint, out uint)

Returns the stream channel width attributes.

Declaration

public virtual void GetWidthInfo(out uint aMin, out uint aMax, out uint aInc)

Parameters

Type	Name	Description
uint	aMin	Width minimum.
uint	aMax	Width maximum.
uint	aInc	Width increment.

IsPayloadTypeSupported(PvPayloadType)

When called, the streaming source has to return whether the specificed payload type is supported or not.

Declaration

public virtual bool IsPayloadTypeSupported(PvPayloadType aPayloadType)

Parameters

Type	Name	Description
PvPayloadType	aPayloadType	The payload type for which support is queried.

Returns

Type	Description
bool	Return true if the payload type is supported, false if not.

OnClose()

Notification from the PvSoftDeviceGEV that this streaming channel has been closed.

Declaration

public virtual void OnClose()

OnOpen(string, ushort)

Notification from the #PvSoftDeviceGEV that this streaming channel has been opened.

Declaration

public virtual void OnOpen(string aDestIP, ushort aDestPort)

Parameters

Type	Name	Description
string	aDestIP	IP address of the stream destination as a string in the "192.168.138.115" format (SCDA).
ushort	aDestPort	UDP port of the stream destination (SCP).

OnStreamingStart()

Notification that the GigE Vision controller has requested that the device start streaming on this channel.

Declaration

public virtual void OnStreamingStart()

OnStreamingStop()

Notification that the GigE Vision controller has requested that the device stop streaming on this channel.

Declaration

public virtual void OnStreamingStop()

SetChunkEnable(uint, bool)

Sets the chunk enabled state for a specific chunk type.

Declaration

public virtual PvResult SetChunkEnable(uint aChunkID, bool aEnabled)

Parameters

Type	Name	Description
uint	aChunkID	Chunk ID of the chunk type to enable or disable.
bool	aEnabled	True to enable the chunk type, false to disable it.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK to accept the new setting. #PvResult::Code::GENERIC_ERROR or another error code to refuse the new setting.

SetChunkModeActive(bool)

Set the master chunk mode active state.

Declaration

public virtual PvResult SetChunkModeActive(bool aEnabled)

Parameters

Type	Name	Description
bool	aEnabled	True to enable chunk mode for this streaming channel, false to disable it.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK to accept the new setting. #PvResult::Code::GENERIC_ERROR or another error code to refuse the new setting.

SetHeight(uint)

Request from the PvSoftDeviceGEV to change the image height.

Declaration

public virtual PvResult SetHeight(uint aHeight)

Parameters

Type	Name	Description
uint	aHeight	New image height.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK when accepting the new height. #PvResult::Code::GENERIC_ERROR or another error code to refuse the new height.

SetLargeLeaderTrailerEnabled(bool, uint)

Sets whether the streaming source which transmit multi-part data uses large data leader and trailer packets.

Declaration

public virtual void SetLargeLeaderTrailerEnabled(bool aEnabled, uint aMaxMultiPartCount)

Parameters

Type	Name	Description
bool	aEnabled	True if Large Leader Trailer is enabled.
uint	aMaxMultiPartCount	The number of maximum allowed Multi parts calculated from the value allowed by the SCPSx register.

SetMultiPartAllowed(bool)

Sets whether the streaming source is allowed or not, but not forced, to transmit multi-part data.

Declaration

public virtual void SetMultiPartAllowed(bool aAllowed)

Parameters

Type	Name	Description
bool	aAllowed	True if multi-part is allowed.

SetOffsetX(uint)

Request from the #PvSoftDeviceGEV to change the image offset X.

Declaration

public virtual PvResult SetOffsetX(uint aOffsetX)

Parameters

Type	Name	Description
uint	aOffsetX	New image offset X.

Returns

Type	Description
PvResult	Includes: - #PvResult::Code::OK when accepting the new value. - #PvResult::Code::GENERIC_ERROR or another error code to refuse the new value.

SetOffsetY(uint)

Request from the PvSoftDeviceGEV to change the image offset Y.

Declaration

public virtual PvResult SetOffsetY(uint aOffsetY)

Parameters

Type	Name	Description
uint	aOffsetY	New image offset Y.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK when accepting the new value. #PvResult::Code::GENERIC_ERROR or another error code to refuse the new value.

SetPixelType(PvPixelType)

Request from the #PvSoftDeviceGEV to change the image pixel type.

Declaration

public virtual PvResult SetPixelType(PvPixelType aPixelType)

Parameters

Type	Name	Description
PvPixelType	aPixelType	New image pixel type.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK when accepting the new pixel type. #PvResult::Code::GENERIC_ERROR or another error code to refuse the new pixel type.

SetTestPayloadFormatMode(PvPayloadType)

When called, the streaming source has to ensure it can stream buffers of the specified payload type.

Declaration

public virtual PvResult SetTestPayloadFormatMode(PvPayloadType aPayloadType)

Parameters

Type	Name	Description
PvPayloadType	aPayloadType	Payload type to prepare test for. PvPayloadTypeNone sets the device back in normal operation mode.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. Any error code can be returned to indicate failure.

SetWidth(uint)

Request from the #PvSoftDeviceGEV to change the image width.

Declaration

public virtual PvResult SetWidth(uint aWidth)

Parameters

Type	Name	Description
uint	aWidth	New image width.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK when accepting the new width. #PvResult::Code::GENERIC_ERROR or another error code to refuse the new width.

Implements

IPvStreamingChannelSourceSwigInterface

IDisposable