Multimedia API Reference

November 16, 2016 | 24.2.1 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Argus::IRequest Class Referenceabstract

Detailed Description

Defines the interface to a capture Request.

Definition at line 71 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 InterfaceProvidergetStreamSettings (const OutputStream *stream)=0
 Returns the Stream settings for a particular stream in the request. More...
 
virtual InterfaceProvidergetAutoControlSettings (const AutoControlId acId=0)=0
 Returns the capture control settings for a given AC. More...
 
virtual InterfaceProvidergetSourceSettings ()=0
 Returns the source settings for the request. More...
 

Static Public Member Functions

static const InterfaceIDid ()
 

Protected Member Functions

 ~IRequest ()
 

Constructor & Destructor Documentation

Argus::IRequest::~IRequest ( )
inlineprotected

Definition at line 126 of file Request.h.

Member Function Documentation

virtual Status Argus::IRequest::clearOutputStreams ( )
pure virtual

Disables all output streams.

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

Disables the specified output stream.

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.

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]acIdThe id of the AC component for which the settings are requested. (Currently unused)
virtual Status Argus::IRequest::getOutputStreams ( std::vector< OutputStream * > *  streams) const
pure virtual

Returns all enabled output streams.

Parameters
[out]streamsA vector that will be populated with the enabled streams.
Returns
success/status of the call.
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.

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]streamThe stream for which the settings are requested.
static const InterfaceID& Argus::IRequest::id ( )
inlinestatic

Definition at line 74 of file Request.h.


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