Argus::IRequest Class Reference

Detailed Description

Interface to the core Request settings.

Definition at line 74 of file Request.h.

Inheritance diagram for Argus::IRequest:

Collaboration diagram for Argus::IRequest:

Public Member Functions
virtual Status	enableOutputStream (OutputStream *stream)=0
	Enables the specified output stream. More...
virtual Status	disableOutputStream (OutputStream *stream)=0
	Disables the specified output stream. More...
virtual Status	clearOutputStreams ()=0
	Disables all output streams. More...
virtual Status	getOutputStreams (std::vector< OutputStream * > *streams) const =0
	Returns all enabled output streams. More...
virtual InterfaceProvider *	getStreamSettings (const OutputStream *stream)=0
	Returns the Stream settings for a particular stream in the request. More...
virtual InterfaceProvider *	getAutoControlSettings (const AutoControlId acId=0)=0
	Returns the capture control settings for a given AC. More...
virtual InterfaceProvider *	getSourceSettings ()=0
	Returns the source settings for the request. More...
virtual Status	setClientData (uint32_t data)=0
	Sets the client data for the request. More...
virtual uint32_t	getClientData () const =0
	Gets the client data for the request. More...
virtual Status	setPixelFormatType (const PixelFormatType &pixelFormatType)=0
	Set this if need 2 simultaneous outputs i.e. More...
virtual PixelFormatType	getPixelFormatType () const =0
	Check if 2 simultaneous outputs are needed. More...
virtual Status	setCVOutput (const CVOutput &cvOutput)=0
	Set the output port for RGBA output. More...
virtual CVOutput	getCVOutput () const =0
	Get output port for RGBA output. More...

Static Public Member Functions
static const InterfaceID &	id ()

Protected Member Functions
	~IRequest ()

Constructor & Destructor Documentation

~IRequest()

Argus::IRequest::~IRequest ( )

inlineprotected

Definition at line 161 of file Request.h.

Member Function Documentation

clearOutputStreams()

virtual Status Argus::IRequest::clearOutputStreams ( )

pure virtual

Disables all output streams.

disableOutputStream()

virtual Status Argus::IRequest::disableOutputStream ( OutputStream *  stream )

pure virtual

Disables the specified output stream.

enableOutputStream()

virtual Status Argus::IRequest::enableOutputStream ( OutputStream *  stream )

pure virtual

Enables the specified output stream.

Captures made with this Request will produce output on that stream.

getAutoControlSettings()

virtual InterfaceProvider* Argus::IRequest::getAutoControlSettings ( const AutoControlId  acId = 0 )

pure virtual

Returns the capture control settings for a given AC.

The returned object will have the same lifespan as this object, and expose the IAutoControlSettings interface.

Parameters

[in]

acId

The id of the AC component for which the settings are requested. (Currently unused)

getClientData()

virtual uint32_t Argus::IRequest::getClientData ( ) const

pure virtual

Gets the client data for the request.

getCVOutput()

virtual CVOutput Argus::IRequest::getCVOutput ( ) const

pure virtual

Get output port for RGBA output.

getOutputStreams()

virtual Status Argus::IRequest::getOutputStreams ( std::vector< OutputStream * > *  streams ) const

pure virtual

Returns all enabled output streams.

Parameters

[out]

streams

A vector that will be populated with the enabled streams.

Returns

success/status of the call.

getPixelFormatType()

virtual PixelFormatType Argus::IRequest::getPixelFormatType ( ) const

pure virtual

Check if 2 simultaneous outputs are needed.

getSourceSettings()

virtual InterfaceProvider* Argus::IRequest::getSourceSettings ( )

pure virtual

Returns the source settings for the request.

The returned object will have the same lifespan as this object, and expose the ISourceSettings interface.

getStreamSettings()

virtual InterfaceProvider* Argus::IRequest::getStreamSettings ( const OutputStream *  stream )

pure virtual

Returns the Stream settings for a particular stream in the request.

The returned object will have the same lifespan as this object, and expose the IStreamSettings interface.

Parameters

[in]

stream

The stream for which the settings are requested.

id()

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

inlinestatic

Definition at line 77 of file Request.h.

setClientData()

virtual Status Argus::IRequest::setClientData ( uint32_t  data )

pure virtual

Sets the client data for the request.

This value is passed through to and queryable from the CaptureMetadata generated for any captures completed using this Request. Default value is 0.

Parameters

[in]

data

The client data.

setCVOutput()

virtual Status Argus::IRequest::setCVOutput ( const CVOutput &  cvOutput )

pure virtual

Set the output port for RGBA output.

setPixelFormatType()

virtual Status Argus::IRequest::setPixelFormatType ( const PixelFormatType &  pixelFormatType )

pure virtual

Set this if need 2 simultaneous outputs i.e.

YUV and RGBA

---

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

• Argus/Request.h