IAudioCutListElement Interface


IAudioCutListElement supports a cutlist element for an audio (.WAV or .AVI) file stream.

See IStandardCutList for information about other cutlist interfaces.

When to Implement

Normally you don't need to implement this interface because DirectShow provides the CLSID_AudioFileClip object which implements it for you. Implement this interface in your application if 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 ICutListElement to determine if the element is an audio type element.

Methods in Vtable Order
IUnknown methods Description
QueryInterface Retrieves pointers to supported interfaces.
AddRef Increments the reference count.
Release Decrements the reference count.
IAudioCutListElement methods Description
GetStreamIndex Returns 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.


IAudioCutListElement::GetStreamIndex

Returns the index to the stream in the AVI file

HRESULT GetStreamIndex(
  DWORD *piStream
  );

Parameters
piStream
[out] the 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 (0) for the stream index. For AVI files, only the first audio stream is supported.


IAudioCutListElement::HasFadeIn

Determines if the element should be faded in.

HRESULT HasFadeIn(void);

Return Values

Returns S_TRUE if the element should be automatically faded in.

Remarks

This method returns S_TRUE to tell the cutlist filter to tell downstream filters to fade the sample if possible. Use this to eliminate "clicking" noise between audio cuts.


IAudioCutListElement::HasFadeOut

Determines if the element should be faded out automatically.

HRESULT HasFadeOut(void);

Return Values

Returns S_TRUE if the element should be automatically faded out.

Remarks

This method returns S_TRUE to tell the cutlist filter to tell downstream filters to fade the sample if possible. Use this to eliminate "clicking" noise between audio cuts.

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