DirectSoundSecondaryBuffer8.GetObjectInPath

The GetObjectInPath method retrieves an object in the audiopath of the buffer. Typically this method is used to retrieve an object representing a sound effect in a buffer or DMO.

Syntax

object.GetObjectinPath( _
  guidFX As String, _
  lIndex As Long, _
  iidInterface As String _
) As Unknown

Parts

object

Resolves to a DirectSoundSecondaryBuffer8 object.

guidFX

String that specifies the unique identifier for the effect class. See Remarks. Can be one of the members of the AUDIOSTRINGCONSTANTS module that begins with DSFX, or a GUID in string form. See Remarks.

lIndex

Value of type Long that specifies the index of the object within objects of that class in the path. This is the index of the object in the array of effects passed to DirectSoundSecondaryBuffer8.SetFX. This is not necessarily the actual position of the object in the effects chain, because some effects might not have been created.

iidInterface

String that specifies the unique identifier of the class of the returned object. Can be one of the members of the AUDIOSTRINGCONSTANTS module that begins with IID, or a GUID in string form. See Remarks.

Return Values

Returns an object representing the effect.

Error Codes

If the method fails, an error is raised. Possible values for Err.Number include DSERR_OBJECTNOTFOUND.

Remarks

The following table shows the standard effects objects that can be retrieved from a buffer on which the effects have been set.

Any DMO that has been set on a buffer by using DirectSoundSecondaryBuffer8.SetFX can be retrieved, even it has not been allocated resources.

See Also

• DirectSoundSecondaryBuffer8.SetFX