TSDuck Version 3.32-2820 (TSDuck - The MPEG Transport Stream Toolkit)
ts::DirectShowFilterCategory Class Reference

A class which instanciates all DirectShow devices in a given category (Windows-specific). More...

Public Member Functions

 DirectShowFilterCategory (const ::GUID &category, Report &report)
 Constructor from a device category. More...
 
 DirectShowFilterCategory (Report &report)
 Constructor. More...
 
 ~DirectShowFilterCategory ()
 Destructor.
 
void clear ()
 Clear all devices instances.
 
bool empty () const
 Check if the set of filters is empty. More...
 
ComPtr<::IBaseFilter > filter (size_t index) const
 Get a pointer to the IBaseFilter of a device. More...
 
bool getAllFiltersInstance (const ::GUID &category)
 Build an instance of all filters of the specified category. More...
 
UString name (size_t index) const
 Get the name of a device. More...
 
size_t size () const
 Get the number of instantiated devices. More...
 

Detailed Description

A class which instanciates all DirectShow devices in a given category (Windows-specific).

Constructor & Destructor Documentation

◆ DirectShowFilterCategory() [1/2]

ts::DirectShowFilterCategory::DirectShowFilterCategory ( Report report)

Constructor.

Parameters
[in,out]reportWhere to report errors.

◆ DirectShowFilterCategory() [2/2]

ts::DirectShowFilterCategory::DirectShowFilterCategory ( const ::GUID &  category,
Report report 
)

Constructor from a device category.

Parameters
[in]categoryGUID of the device category.
[in,out]reportWhere to report errors.

Member Function Documentation

◆ getAllFiltersInstance()

bool ts::DirectShowFilterCategory::getAllFiltersInstance ( const ::GUID &  category)

Build an instance of all filters of the specified category.

Parameters
[in]categoryGUID of the device category.
Returns
True on success, false on error.

◆ empty()

bool ts::DirectShowFilterCategory::empty ( ) const
inline

Check if the set of filters is empty.

Returns
True if there is no filter in the category.

◆ size()

size_t ts::DirectShowFilterCategory::size ( ) const
inline

Get the number of instantiated devices.

Returns
The number of instanciated devices.

◆ name()

UString ts::DirectShowFilterCategory::name ( size_t  index) const
inline

Get the name of a device.

Parameters
[in]indexIndex of the device, from 0 to size()-1.
Returns
The name of the device or an empty string if index is out of range.

◆ filter()

ComPtr<::IBaseFilter> ts::DirectShowFilterCategory::filter ( size_t  index) const
inline

Get a pointer to the IBaseFilter of a device.

Parameters
[in]indexIndex of the device, from 0 to size()-1.
Returns
The pointer to the IBaseFilter of the device or a null pointer if index is out of range.

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