eSDK Pro System Class

This topic describes the System class in the eSDK Pro API.
‍

System Class

Namespace: eSdkPro  Header: eSdkPro/system.h

Represents the state of the current system. To use eSDK Pro, you must first create a system instance. Owns a list of servers used within the eSDK Pro application.

‍

Create()

static eSdkPro::System Create()

Instantiates a new system. Usually a single instance is enough for the current process. Destroy() must be called to release resources.‍

Returns: The newly instantiated system.

‍

Destroy()

void eSdkPro::System::Destroy()

Releases this system instance. All active eSDK Pro objects using this system instance will be destroyed.

‍

ConnectServer() — IP only

Server eSdkPro::System::ConnectServer(const std::string ip)

Connects to a remote server with the specified IP address to the default eSDK Pro port.‍

Parameter: ip — The server IP address.

Returns: The connected server.

‍

ConnectServer() — IP + Port

Server eSdkPro::System::ConnectServer(const std::string ip, uint16_t port)

Connects to a remote server with the specified IP address and port.‍

Parameters:

• ‍‍ip — The server IP address.
• ‍port — The server port.

Returns: The connected server.

‍

CreateLocalServer()

Server eSdkPro::System::CreateLocalServer()

Creates a local server to run within the current process. Only one local server can be active at a time. Sudo/Admin permissions may be needed to access all features of eSDK Pro.‍

Returns: The local server.

‍

RemoveServer()

void eSdkPro::System::RemoveServer(Server& server)

Removes a server from the system.‍

Parameter: server — The server to remove.

‍

GetServers()

std::vector<Server> eSdkPro::System::GetServers() const

Return the list of all servers connected/created to this system.‍

Returns: The list of active servers.

‍

GetCameras()

std::vector<Camera> eSdkPro::System::GetCameras() const

Return the list of all cameras in this system.‍

Returns: The list of active cameras.

‍

GetPipeline()

Pipeline eSdkPro::System::GetPipeline()

Returns the global pipeline representing the processing done by the system. There is a single pipeline for an eSDK Pro system.‍

Returns: The pipeline used by the system.

‍

SetPreviewQuality()

void eSdkPro::System::SetPreviewQuality(PreviewQuality quality)

Sets the quality of image preview for the entire system. Images are downsampled on the servers before being sent to the eSDKPro application. Reducing quality can reduce CPU and network load.‍

Parameter: quality — The quality to set.

‍

See Also

• Server Class
• ‍Pipeline Class
• Task Classes

‍