Image Manager (CVWebstreaming.dll) 15.0
Streaming Functions

Functions

cvbres_t CVWSCreateConverter (CVWSConverterType ConverterType, CVWSSERVER &Converter)
 Creates a converter for sending image data depending on type. More...
 
cvbres_t CVWSCreateServer (const char *IPAddress, cvbval_t Port, CVWSCONVERTER Converter, CVWSSERVER &Server)
 Creates a WebSocket server for sending image data depending on converter type. More...
 
cvbres_t CVWSCreateServerW (const wchar_t *IPAddress, cvbval_t Port, CVWSCONVERTER Converter, CVWSSERVER &Server)
 Creates a WebSocket server for sending image data depending on converter type. More...
 
cvbres_t CVWSGetPropertyAsInteger (CVWSCONVERTER Converter, CVWSConverterProperty Property, cvbint64_t &Value)
 Get the value for given converter property. More...
 
cvbres_t CVWSServerGetPropertyAsInteger (CVWSSERVER Server, CVWSServerProperty ServerInfo, cvbint64_t &Value)
 Get an info value for a given server. More...
 
cvbres_t CVWSSetPropertyAsInteger (CVWSCONVERTER Converter, CVWSConverterProperty Property, cvbint64_t Value)
 Sets the value for given converter property. More...
 
cvbres_t CVWSStreamingAsyncSendImage (CVWSSERVER Server, IMG InputImage)
 Asynchronously sends a CvbImage to all connected clients. More...
 
cvbres_t CVWSStreamingSyncSendImage (CVWSSERVER Server, IMG InputImage)
 Synchronously converts and sends a CvbImage to all connected clients. More...
 

Detailed Description

Function Documentation

◆ CVWSCreateConverter()

cvbres_t CVWSCreateConverter ( CVWSConverterType  ConverterType,
CVWSSERVER Converter 
)

Creates a converter for sending image data depending on type.

Parameters
[in]ConverterTypeThe converter type to use. Example: CVWS_CONVERTER_JPEG
[out]ConverterThe converter for sending image data.
Returns

◆ CVWSCreateServer()

cvbres_t CVWSCreateServer ( const char *  IPAddress,
cvbval_t  Port,
CVWSCONVERTER  Converter,
CVWSSERVER Server 
)

Creates a WebSocket server for sending image data depending on converter type.

Parameters
[in]IPAddressThe IP-Address for the server. Example: 169.254.0.1
[in]PortThe port for the server. Example: 1112
[in]ConverterThe converter to use.
[out]ServerThe streaming server.
Returns
Note
Call ReleaseObject() on the returned server if no longer needed.
A missing license might flip the data.

◆ CVWSCreateServerW()

cvbres_t CVWSCreateServerW ( const wchar_t *  IPAddress,
cvbval_t  Port,
CVWSCONVERTER  Converter,
CVWSSERVER Server 
)

Creates a WebSocket server for sending image data depending on converter type.

Parameters
[in]IPAddressThe IP-Address for the server. Example: 169.254.0.1
[in]PortThe port for the server. Example: 1112
[in]ConverterThe converter to use.
[out]ServerThe streaming server.
Returns
Note
Call ReleaseObject() on the returned server if no longer needed.
A missing license might flip the data.

◆ CVWSGetPropertyAsInteger()

cvbres_t CVWSGetPropertyAsInteger ( CVWSCONVERTER  Converter,
CVWSConverterProperty  Property,
cvbint64_t &  Value 
)

Get the value for given converter property.

Parameters
[in]ConverterThe converter to use.
[in]PropertyThe property to get the value on.
[out]ValueThe value.
Returns

◆ CVWSServerGetPropertyAsInteger()

cvbres_t CVWSServerGetPropertyAsInteger ( CVWSSERVER  Server,
CVWSServerProperty  ServerInfo,
cvbint64_t &  Value 
)

Get an info value for a given server.

Parameters
[in]ServerServer to get the info on.
[in]ServerInfoThe server info to get the value on.
[out]ValueThe value.
Returns

◆ CVWSSetPropertyAsInteger()

cvbres_t CVWSSetPropertyAsInteger ( CVWSCONVERTER  Converter,
CVWSConverterProperty  Property,
cvbint64_t  Value 
)

Sets the value for given converter property.

Parameters
[in]ConverterThe converter to use.
[in]PropertyThe property to set the value on.
[in]ValueThe value.
Returns

◆ CVWSStreamingAsyncSendImage()

cvbres_t CVWSStreamingAsyncSendImage ( CVWSSERVER  Server,
IMG  InputImage 
)

Asynchronously sends a CvbImage to all connected clients.

Note
This also synchronously converts the image. I.e. will not return immediately.
Parameters
[in]ServerThe server to send the image from.
[in]InputImageThe CvbImage that is to be sent.
Note
In case of error it is best to consult the logging service.
Returns

◆ CVWSStreamingSyncSendImage()

cvbres_t CVWSStreamingSyncSendImage ( CVWSSERVER  Server,
IMG  InputImage 
)

Synchronously converts and sends a CvbImage to all connected clients.

Parameters
[in]ServerThe server to send the image from.
[in]InputImageThe CvbImage that is to be sent.
Note
In case of error it is best to consult the logging service.
Returns