Argus::IStreamSettings Class Reference

Detailed Description

Interface to per-stream settings (provided by IRequest::getStreamSettings()).

Definition at line 549 of file Settings.h.

Inheritance diagram for Argus::IStreamSettings:

Collaboration diagram for Argus::IStreamSettings:

Public Member Functions
virtual Status	setSourceClipRect (const Rectangle< float > &clipRect)=0
	Sets the clip rectangle for the stream. More...
virtual Rectangle< float >	getSourceClipRect () const =0
	Returns the clip rectangle for the stream. More...
virtual void	setPostProcessingEnable (bool enable)=0
	Sets whether or not post-processing is enabled for this stream. More...
virtual bool	getPostProcessingEnable () const =0
	Returns the post-processing enable for the stream. More...

Static Public Member Functions
static const InterfaceID &	id ()

Protected Member Functions
	~IStreamSettings ()

Constructor & Destructor Documentation

~IStreamSettings()

Argus::IStreamSettings::~IStreamSettings ( )

inlineprotected

Definition at line 586 of file Settings.h.

Member Function Documentation

getPostProcessingEnable()

virtual bool Argus::IStreamSettings::getPostProcessingEnable ( ) const

pure virtual

Returns the post-processing enable for the stream.

getSourceClipRect()

virtual Rectangle<float> Argus::IStreamSettings::getSourceClipRect ( ) const

pure virtual

Returns the clip rectangle for the stream.

id()

static const InterfaceID& Argus::IStreamSettings::id ( )

inlinestatic

Definition at line 552 of file Settings.h.

setPostProcessingEnable()

virtual void Argus::IStreamSettings::setPostProcessingEnable ( bool  enable )

pure virtual

Sets whether or not post-processing is enabled for this stream.

Post-processing features are controlled on a per-Request basis and all streams share the same post-processing control values, but this enable allows certain streams to be excluded from all post-processing. The current controls defined to be a part of "post-processing" includes (but may not be limited to):

• Denoise Default value is true.

setSourceClipRect()

virtual Status Argus::IStreamSettings::setSourceClipRect ( const Rectangle< float > &  clipRect )

pure virtual

Sets the clip rectangle for the stream.

A clip rectangle is a normalized rectangle with valid coordinates contained in the [0.0,1.0] range.

Parameters

[in]

clipRect

The clip rectangle.

Returns

success/status of the call.

---

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

• Argus/Settings.h