IAMAudioCutListElement Interface

The IAMAudioCutListElement interface provides support for a cutlist element for an audio file stream in a WAV or AVI file.

See About Cutlists and Using Cutlists for more information.

When to Implement

Usually, you don't need to implement this interface because DirectShow provides the CLSID_AudioFileClip object that implements it for you. Implement this interface in your application when you need to change the default behavior of this interface.

When to Use

Use this interface in your filter when you specify an audio-based media clip. Call QueryInterface on the IAMCutListElement interface to determine if the element is an audio type element.

When compiling a cutlist application you must explicitly include the cutlist header file as follows:

#include <cutlist.h>

Methods in Vtable Order

IUnknown methods	Description
QueryInterface	Retrieves pointers to supported interfaces.
AddRef	Increments the reference count.
Release	Decrements the reference count.

IAMAudioCutListElement methods	Description
GetStreamIndex	Retrieves the index to the stream in the AVI file.
HasFadeIn	Determines if the element fades in automatically.
HasFadeOut	Determines if the element fades out automatically.

---

IAMAudioCutListElement::GetStreamIndex

IAMAudioCutListElement Interface

Retrieves the index to the stream in the AVI file.

HRESULT GetStreamIndex(
  DWORD *piStream
  );

Parameters

piStream

[out] Stream number to be opened.

Return Values

Returns an HRESULT value that depends on the implementation of the interface. HRESULT can include one of the following standard constants, or other values not listed.

Value	Meaning
E_FAIL	Failure.
E_INVALIDARG	Argument is invalid.
E_NOTIMPL	Method is not supported.
E_POINTER	Null pointer argument.
S_OK	Success.

Remarks

This method must always retrieve zero for the stream index. For AVI files, only the first audio stream is supported.

---

IAMAudioCutListElement::HasFadeIn

IAMAudioCutListElement Interface

Determines if the element fades in automatically.

HRESULT HasFadeIn(void);

Return Values

Returns S_OK if the element should be automatically faded in, or S_FALSE if not.

Remarks

This method always returns S_OK, but fading in and out is not currently supported.

---

IAMAudioCutListElement::HasFadeOut

IAMAudioCutListElement Interface

Determines if the element fades out automatically.

HRESULT HasFadeOut(void);

Return Values

Returns S_OK if the element should be automatically faded out, or S_FALSE if not.

Remarks

This method always returns S_OK, but fading in and out is not currently supported.

© 1998 Microsoft Corporation. All rights reserved. Terms of Use.

Top of Page