KSPROPERTY_DIRECTSOUND3DLISTENER_BATCH

The KSPROPERTY_DIRECTSOUND3DLISTENER_BATCH property specifies the batch-mode setting for a 3D listener.

The property value (operation data) is of type BOOL and specifies the batch-mode setting:

• When the value of this property is TRUE, the miniport driver should cache all changes to the listener properties and all associated buffer properties.
• When the value is FALSE, changes to the listener properties and buffer properties take effect immediately.

Return Value

A KSPROPERTY_DIRECTSOUND3DLISTENER_BATCH property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate error status code.

Headers

Declared in ksmedia.h. Include ksmedia.h.

Comments

When this property transitions from TRUE to FALSE the miniport driver should put all cached properties into effect immediately. If possible, any cached properties should be put into effect simultaneously.

For more information on batch-mode settings for 3D listeners, see the description of the IDirectSound3DListener::CommitDeferredSettings method in the Platform SDK documentation.

See Also

KSNODEPROPERTY