Detailed Description

A Device represents a physical device that may provide one or more Encoder instances.

Available in version 7.4 of Decoder SDK. Requires a server version greater than 7.4

#include <Device.h>

Public Member Functions
DB_EDGEVIS_SDK std::wstring	Name () const
	Gets the name of the Device. More...

DB_EDGEVIS_SDK std::wstring	UniqueID () const
	Gets the Device's unique identifier. More...

DB_EDGEVIS_SDK std::vector< Encoder >	GetEncoders () const
	Gets a list of Encoders that are available on the Device. More...

DB_EDGEVIS_SDK Encoder	GetEncoder (const std::wstring &uuid) const
	Gets the Encoder object with the specified UUID. More...

DB_EDGEVIS_SDK int32_t	GetMaxEncoders () const
	Gets the maximum number of Encoders supported by this Device. More...

DB_EDGEVIS_SDK bool	IsConnectedToServer () const
	Determine if this Device is currently connected to the EdgeVis server. More...

Member Function Documentation

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Device::Name ( ) const

Gets the name of the Device.

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Device::UniqueID ( ) const

Gets the Device's unique identifier.

DB_EDGEVIS_SDK std::vector<Encoder> EdgeVisDecoderSDK::Device::GetEncoders ( ) const

Gets a list of Encoders that are available on the Device.

Returns: Vector containing Encoder objects representing the encoder instances available on the physical device.

DB_EDGEVIS_SDK Encoder EdgeVisDecoderSDK::Device::GetEncoder ( const std::wstring & uuid ) const

Gets the Encoder object with the specified UUID.

Parameters

uuid	The UUID of the encoder to search for.

Returns: The Encoder object found. The Encoder object will be invalid if no encoder is found.

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::Device::GetMaxEncoders ( ) const

Gets the maximum number of Encoders supported by this Device.

Returns: The maximum number of Encoders supported by the physical device. This may be more than the number of Encoders currently returned by GetEncoders() depending on how many output streams are configured for the device. If the Device is not connected to the Server the return value will be 0.

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Device::IsConnectedToServer ( ) const

Determine if this Device is currently connected to the EdgeVis server.

The documentation for this class was generated from the following file: