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]	ConverterType	The converter type to use. Example: CVWS_CONVERTER_JPEG
[out]	Converter	The converter for sending image data.

Returns

• CVC_ERROR (CVC_E_OK) No error.
• CVC_ERROR (CVC_E_ERROR) Error creating the converter.

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]	IPAddress	The IP-Address for the server. Example: 169.254.0.1
[in]	Port	The port for the server. Example: 1112
[in]	Converter	The converter to use.
[out]	Server	The streaming server.

Returns

• CVC_ERROR (CVC_E_OK) No error.
• CVC_ERROR (CVC_E_WRONGOBJECT) Server is not a CVWSSERVER.
• CVC_ERROR (CVC_E_MEMORY) IP address could not be converted to string.

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]	IPAddress	The IP-Address for the server. Example: 169.254.0.1
[in]	Port	The port for the server. Example: 1112
[in]	Converter	The converter to use.
[out]	Server	The streaming server.

Returns

• CVC_ERROR (CVC_E_OK) No error.
• CVC_ERROR (CVC_E_WRONGOBJECT) Server is not a CVWSSERVER.
• CVC_ERROR (CVC_E_MEMORY) IP address could not be converted to string.

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]	Converter	The converter to use.
[in]	Property	The property to get the value on.
[out]	Value	The value.

Returns

• CVC_ERROR (CVC_E_OK) No error.
• CVC_ERROR (CVC_E_PARAMETER) Invalid parameter converter type.

CVWSServerGetPropertyAsInteger()

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

Get an info value for a given server.

Parameters

[in]	Server	Server to get the info on.
[in]	ServerInfo	The server info to get the value on.
[out]	Value	The value.

Returns

• CVC_ERROR (CVC_E_OK) No error.
• CVC_ERROR (CVC_E_PARAMETER) Invalid parameter converter type.

CVWSSetPropertyAsInteger()

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

Sets the value for given converter property.

Parameters

[in]	Converter	The converter to use.
[in]	Property	The property to set the value on.
[in]	Value	The value.

Returns

• CVC_ERROR (CVC_E_OK) No error.
• CVC_ERROR (CVC_E_PARAMETER) Invalid parameter.

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]	Server	The server to send the image from.
[in]	InputImage	The CvbImage that is to be sent.

Note

In case of error it is best to consult the logging service.

Returns

• CVC_ERROR (CVC_E_OK) No error.
• CVC_ERROR (CVC_E_WRONGOBJECT) Server is not a CVWSSERVER.

CVWSStreamingSyncSendImage()

cvbres_t CVWSStreamingSyncSendImage	(	CVWSSERVER	Server,
		IMG	InputImage
	)

Synchronously converts and sends a CvbImage to all connected clients.

Parameters

[in]	Server	The server to send the image from.
[in]	InputImage	The CvbImage that is to be sent.

Note

In case of error it is best to consult the logging service.

Returns

• CVC_ERROR (CVC_E_OK) No error.
• CVC_ERROR (CVC_E_WRONGOBJECT) Server is not a CVWSSERVER.
• CVC_ERROR (CVC_E_MEMORY) IP address could not be converted to string.