DirectShow Animated Header -- IAMVideoCutListElement Interface DirectShow Animated Header -- IAMVideoCutListElement Interface* Microsoft DirectShow SDK
*Index  *Topic Contents
*Previous Topic: IAMVideoControl Interface
*Next Topic: IAMVideoProcAmp Interface

IAMVideoCutListElement Interface


IAMVideoCutListElement provides support for a cutlist element from an AVI video file stream.

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_VideoFileClip object that implements it for you. Implement this interface in your application when you need to change the default behavior of this interface to include support for interlaced video.

When to Use

Use this interface in your filter when you specify a video-based media clip. Call QueryInterface on the IAMCutListElement interface to determine if the element is a video 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.
IAMVideoCutListElement methods Description
IsSingleFrame Determines if the element is a single frame with repeating fields.
GetStreamIndex Retrieves the index to the specified stream in the AVI file.


IAMVideoCutListElement::GetStreamIndex

IAMVideoCutListElement Interface

Retrieves the index to the specified stream in the AVI file.

HRESULT GetStreamIndex(
  DWORD *piStream
  );

Parameters
piStream
[out] Pointer to the stream number to open.
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

The stream number must always be zero. The only supported video stream in an AVI file is the first video stream.


IAMVideoCutListElement::IsSingleFrame

IAMVideoCutListElement Interface

Determines if the element is a single frame with repeating fields.

HRESULT IsSingleFrame(void);

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_FALSE No, element is not a single frame with repeating fields.
S_OK Yes, element is a single frame with repeating fields.

Remarks

This method must always return S_FALSE because repeating fields are not supported.

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

*Top of Page