tdv::nuitrack::device::NuitrackDevice Class Reference

Contains information and settings for a device. More...

#include <NuitrackDevice.h>

Public Types
typedef std::shared_ptr < NuitrackDevice >	Ptr

Public Member Functions
	NuitrackDevice (NuitrackDeviceData *pimpl)
	For internal use only.
std::string	getInfo (DeviceInfoType info_type)
	Provides device info by type. More...
std::vector< VideoMode >	getAvailableVideoModes (StreamType stream_type)
	Provides all available video modes for a current StreamType. More...
VideoMode	getSelectedVideoMode (StreamType stream_type)
	Provides selected video mode for a current StreamType. More...
void	setVideoMode (StreamType stream_type, VideoMode video_mode)
	Sets video mode for a current StreamType. More...
ActivationStatus	getActivationStatus ()
	Get license activation status. More...
void	activate (std::string activation_key)
	Activate the current device. More...

Friends
class	tdv::nuitrack::Nuitrack

Detailed Description

Contains information and settings for a device.

Member Function Documentation

void tdv::nuitrack::device::NuitrackDevice::activate ( std::string  activation_key )

inline

Activate the current device.

Parameters

[in]

activation_key

License key for Nuitrack.

Exceptions

tdv::nuitrack::Exception

ActivationStatus tdv::nuitrack::device::NuitrackDevice::getActivationStatus ( )

inline

Get license activation status.

Returns

License activation status.

std::vector<VideoMode> tdv::nuitrack::device::NuitrackDevice::getAvailableVideoModes ( StreamType  stream_type )

inline

Provides all available video modes for a current StreamType.

Parameters

[in]

stream_type

Stream type of VideoMode.

Returns

Vector of available video modes.

std::string tdv::nuitrack::device::NuitrackDevice::getInfo ( DeviceInfoType  info_type )

inline

Provides device info by type.

Parameters

[in]

info_type

Type of device info.

Returns

Info about a device.

VideoMode tdv::nuitrack::device::NuitrackDevice::getSelectedVideoMode ( StreamType  stream_type )

inline

Provides selected video mode for a current StreamType.

Parameters

[in]

stream_type

Stream type of VideoMode.

Returns

Selected VideoMode.

void tdv::nuitrack::device::NuitrackDevice::setVideoMode ( StreamType  stream_type, VideoMode  video_mode  )

inline

Sets video mode for a current StreamType.

Parameters

[in]	stream_type	Stream type of VideoMode.
[in]	video_mode	Video mode.