Home Units Hierarchy Routines All identifiers

Class unaMsAcm

Description

Hierarchy

Fields

Methods

Properties

Unit

unaMsAcmClasses

Declaration

type unaMsAcm = class(unaObject)

Description

This class holds a list of drivers installed on the system. Driver usually corresponds to one specific audio format and may contain converters, codecs and filters. You should explicitly call enumDrivers() method to enumerate installed drivers.

Every installed driver has unique manufacturer and product identifiers (MID and PID). You can use these identifiers to locate specific driver. Use getDriver() method to retrieve driver by index or MID/PID pair.

Hierarchy

TObject
unaObject
unaMsAcm

Overview

Methods

	`constructor create();`
	`destructor Destroy(); override;`
	`function getDriver(mid, pid: unsigned): unaMsAcmDriver; overload;`
	`function getDriver(index: unsigned): unaMsAcmDriver; overload;`
	`function getDriverByFormatTag(formatTag: unsigned): unaMsAcmDriver;`
	`function getDriverCount(): unsigned;`
	`function openDriver(const driverLibrary: wString): unaMsAcmDriver;`
	`function preparePafd(var pafd: ACMFORMATDETAILS; tag: unsigned = 0; index: unsigned = 0; driver: unsigned = 0): bool;`
	`procedure closeDriver(driver: unaMsAcmDriver);`
	`procedure enumDrivers(flags: uint = 0);`
	`procedure addEnumedDriver(id: HACMDRIVERID; support: unsigned); virtual;`

Properties

	`property countCodecs : unsigned index ACM_METRIC_COUNT_CODECS read getACMCount;`
	`property countConverters: unsigned index ACM_METRIC_COUNT_CONVERTERS read getACMCount;`
	`property countDisabled : unsigned index ACM_METRIC_COUNT_DISABLED read getACMCount;`
	`property countDrivers : unsigned index ACM_METRIC_COUNT_DRIVERS read getACMCount;`
	`property countFilters : unsigned index ACM_METRIC_COUNT_FILTERS read getACMCount;`
	`property countHardware : unsigned index ACM_METRIC_COUNT_HARDWARE read getACMCount;`
	`property countLocalCodecs : unsigned index ACM_METRIC_COUNT_LOCAL_CODECS read getACMCount;`
	`property countLocalConverters: unsigned index ACM_METRIC_COUNT_LOCAL_CONVERTERS read getACMCount;`
	`property countLocalDisabled : unsigned index ACM_METRIC_COUNT_LOCAL_DISABLED read getACMCount;`
	`property countLocalDrivers : unsigned index ACM_METRIC_COUNT_LOCAL_DRIVERS read getACMCount;`
	`property countLocalFilters : unsigned index ACM_METRIC_COUNT_LOCAL_FILTERS read getACMCount;`
	`property version: unsigned read f_version;`

Description

Methods

	`constructor create();`
Allocates internal structures needed for class instance.

	`destructor Destroy(); override;`

	`function getDriver(mid, pid: unsigned): unaMsAcmDriver; overload;`
Searches the list of drivers for driver with specified mid and pid values.

	`function getDriver(index: unsigned): unaMsAcmDriver; overload;`
Returns driver from the list of drivers. Driver is specified by the index in the list (starting from 0).

	`function getDriverByFormatTag(formatTag: unsigned): unaMsAcmDriver;`
Returns driver from the list of drivers. Driver is specified by the format tag supported by driver.

	`function getDriverCount(): unsigned;`
Returns number of drivers enumerated by enumDrivers() method.

	`function openDriver(const driverLibrary: wString): unaMsAcmDriver;`
Opens installable ACM driver.

	`function preparePafd(var pafd: ACMFORMATDETAILS; tag: unsigned = 0; index: unsigned = 0; driver: unsigned = 0): bool;`
Allocates given ACMFORMATDETAILS structure.

	`procedure closeDriver(driver: unaMsAcmDriver);`
Closes installable ACM driver opened previously with openDriver();

procedure enumDrivers(flags: uint = 0);

Enumerates installed ACM drivers. The following values are defined for flags parameter:

(ACM_DRIVERENUMF_DISABLED - Disabled ACM drivers should be included in the enumeration)
(ACM_DRIVERENUMF_NOLOCAL - Only global drivers should be included in the enumeration)

Enumerated drivers are stored in driver list. You can access them using the getDriver() method.

	`procedure addEnumedDriver(id: HACMDRIVERID; support: unsigned); virtual;`
Adds driver to the list of drivers.

Properties

	`property countCodecs : unsigned index ACM_METRIC_COUNT_CODECS read getACMCount;`
Number of global ACM compressor or decompressor drivers in the system.

	`property countConverters: unsigned index ACM_METRIC_COUNT_CONVERTERS read getACMCount;`
Number of global ACM converter drivers in the system.

	`property countDisabled : unsigned index ACM_METRIC_COUNT_DISABLED read getACMCount;`
Number of global disabled ACM drivers (of all support types) in the system.

	`property countDrivers : unsigned index ACM_METRIC_COUNT_DRIVERS read getACMCount;`
Total number of enabled global ACM drivers (of all support types) in the system.

	`property countFilters : unsigned index ACM_METRIC_COUNT_FILTERS read getACMCount;`
Number of global ACM filter drivers in the system.

	`property countHardware : unsigned index ACM_METRIC_COUNT_HARDWARE read getACMCount;`
Number of global ACM hardware drivers in the system.

	`property countLocalCodecs : unsigned index ACM_METRIC_COUNT_LOCAL_CODECS read getACMCount;`
Number of local ACM compressor drivers, ACM decompressor drivers, or both for the calling task.

	`property countLocalConverters: unsigned index ACM_METRIC_COUNT_LOCAL_CONVERTERS read getACMCount;`
Number of local ACM converter drivers for the calling task.

	`property countLocalDisabled : unsigned index ACM_METRIC_COUNT_LOCAL_DISABLED read getACMCount;`
Total number of local disabled ACM drivers, of all support types, for the calling task.

	`property countLocalDrivers : unsigned index ACM_METRIC_COUNT_LOCAL_DRIVERS read getACMCount;`
Total number of enabled local ACM drivers (of all support types) for the calling task.

	`property countLocalFilters : unsigned index ACM_METRIC_COUNT_LOCAL_FILTERS read getACMCount;`
Number of local ACM filter drivers for the calling task.

	`property version: unsigned read f_version;`
Version of ACM.

Generated by PasDoc 0.12.1 on 2012-10-09