Home Units Hierarchy Routines All identifiers

Class unaMsMixerSystem

DescriptionHierarchyFieldsMethodsProperties

Unit

unaMsMixer

Declaration

type unaMsMixerSystem = class(unaObject)

Description

Mixer system. Use to get access to all mixer devices installed on a system.

Hierarchy

Overview

Methods

Public constructor create(enumOnCreate: bool = true);
Public destructor Destroy(); override;
Public function getDeviceId(isInDevice: bool; alsoCheckMapper: bool = false): int;
Public function getLineConnectionByType(iline: unsigned; itype: unsigned; checkControlsNum: bool = true): int;
Public function getLineConnectionCount(iline: unsigned): int;
Public function getLineConnectionName(iline: unsigned; iconn: unsigned; shortName: bool = false): wString;
Public function getLineConnectionType(iline: unsigned; iconn: int): unsigned;
Public function getLineCount(): int;
Public function getLineIndex(isOut: bool = true; recLevel: int = 0): int;
Public function getLineName(iline: unsigned; shortName: bool = false): wString;
Public function getMixerCount(): int;
Public function getMixerId(deviceId: unsigned; isInDevice: bool): int;
Public function getMixerIndex(mixerId: unsigned): int;
Public function getMixerName(): wString;
Public function getMuteControlID(iline: unsigned; iconn: int): int;
Public function getRecSource(): int;
Public function getVolume(iline: unsigned; iconn: int): int;
Public function getVolumeControlID(iline: unsigned; iconn: int): int;
Public function isMutedConnection(iline: unsigned; iconn: int): bool;
Public function muteConnection(iline: unsigned; iconn: int; doMute: bool): bool;
Public function selectMixer(deviceId: unsigned; isInDevice: bool; handle: unsigned = 0): bool; overload;
Public function selectMixer(imixer: int; handle: unsigned = 0): bool; overload;
Public function setRecSource(iconn: unsigned; ensureNotMuted: bool = true): bool;
Public function setVolume(iline: unsigned; iconn: int; value: int): bool;
Public procedure AfterConstruction(); override;
Public procedure enumDevices();
Protected procedure enumMixers(); virtual;

Properties

Public property mixer[index:unsigned]: unaMsMixerDevice read getMixer;
Public property selectedMixer: unaMsMixerDevice read f_selectedMixer;

Description

Methods

Public constructor create(enumOnCreate: bool = true);
 
Public destructor Destroy(); override;
 
Public function getDeviceId(isInDevice: bool; alsoCheckMapper: bool = false): int;
 
Public function getLineConnectionByType(iline: unsigned; itype: unsigned; checkControlsNum: bool = true): int;

returns connection index for specified line with given type. If no connection with specified type exists, returns -1. Example: getLineConnectionByType(0, MIXERLINE_COMPONENTTYPE_DST_WAVEIN)

Public function getLineConnectionCount(iline: unsigned): int;

returns number of connections for specified line.

Public function getLineConnectionName(iline: unsigned; iconn: unsigned; shortName: bool = false): wString;

returns name of specified connection for specified line. Name can be short or full. Valid connection index is from 0 to number returned by getLineConnectionCount() - 1.

Public function getLineConnectionType(iline: unsigned; iconn: int): unsigned;

returns type of specified connection for specified line, or type of line itself when iconn is -1.

Public function getLineCount(): int;

returns number of lines for selected mixer. Usually mixer has only two lines: recording and playback.

Public function getLineIndex(isOut: bool = true; recLevel: int = 0): int;

returns index of output (playback) line when isOut is true, or input (recording) line when isOut is false. Returned value can be passed as iline parameter for other line-related methods. recLevel parameter is internal, do not change it.

Public function getLineName(iline: unsigned; shortName: bool = false): wString;

returns name of specified line. Name can be short of full.

Public function getMixerCount(): int;

returns number of mixers installed on a system.

Public function getMixerId(deviceId: unsigned; isInDevice: bool): int;
 
Public function getMixerIndex(mixerId: unsigned): int;
 
Public function getMixerName(): wString;

returns name of selected mixer.

Public function getMuteControlID(iline: unsigned; iconn: int): int;

returns control ID responsible for mute checkbox of specified connection or line (when iconn = -1). This ID is useful in window messages handler only.

Public function getRecSource(): int;

returns connection index selected as current recording source. If more than one connection can be selected, returns -1.

Public function getVolume(iline: unsigned; iconn: int): int;

returns volume level for specified connection or line (when iconn = -1). Returned value ranges from 0 (lowest) to 100 (highest).

Public function getVolumeControlID(iline: unsigned; iconn: int): int;

returns ID of a control responsible for volume level for specified connection or line (when iconn = -1). This ID is useful in window messages handler only.

Public function isMutedConnection(iline: unsigned; iconn: int): bool;

returns true if specified connection or line (when iconn = -1) is muted. Otherwise returns false.

Public function muteConnection(iline: unsigned; iconn: int; doMute: bool): bool;

mutes or unmutes specified connection or line (when iconn = -1). Returns true if operation was succesfull.

Public function selectMixer(deviceId: unsigned; isInDevice: bool; handle: unsigned = 0): bool; overload;
 
Public function selectMixer(imixer: int; handle: unsigned = 0): bool; overload;

selects and initializes specified mixer. All other methods works with selected mixer only. Valid mixer index is from 0 to number of mixers installed - 1. You can also specify handle of window to receive mixer-related messages.

Public function setRecSource(iconn: unsigned; ensureNotMuted: bool = true): bool;

sets specified connection as current recording source and optionally ensures it is not muted if more than one connection can be selected.

Public function setVolume(iline: unsigned; iconn: int; value: int): bool;

sets volume level for specified control or line (when iconn = -1). Valid values for level are from 0 (lowest) to 100 (highest).

Public procedure AfterConstruction(); override;
 
Public procedure enumDevices();
 
Protected procedure enumMixers(); virtual;
 

Properties

Public property mixer[index:unsigned]: unaMsMixerDevice read getMixer;
 
Public property selectedMixer: unaMsMixerDevice read f_selectedMixer;
 

(c) 2012 Lake of Soft

Generated by PasDoc 0.12.1 on 2012-10-09