Microsoft DirectX 8.1 (C++)

IAMTimelineComp::GetRecursiveLayerOfType

The GetRecursiveLayerOfType method performs a depth-first ordering of the virtual tracks contained in this composition, and retrieves the nth virtual track from that ordering.

Syntax

HRESULT GetRecursiveLayerOfType(
    IAMTimelineObj **ppVirtualTrack,
    long WhichLayer,
    TIMELINE_MAJOR_TYPE Type
);

Parameters

ppVirtualTrack

[out] Address of a pointer that receives the virtual track's IAMTimelineObj interface.

WhichLayer

Value that specifies which virtual track to retrieve, indexed from zero.

Type

Member of the TIMELINE_MAJOR_TYPE enumerated type that specifies whether to include tracks in the search.

Return Value

Returns one of the following HRESULT values:

Return code Description
S_OK Success.
E_INVALIDARG No object of the specified type.
E_POINTER NULL pointer argument.

Remarks

Typically, an application will not need to call this method.

If the Type parameter is TIMELINE_MAJOR_TYPE_TRACK, the depth-first ordering includes tracks. If not, it includes only compositions and groups. The object itself is included in the ordering.

For example, in the following arrangement, starting from Composition A, the ordering would be B, C, F, D, E, A.

GetRecursiveLayerofType

If the method succeeds, the IAMTimelineObj interface that it returns has an outstanding reference count. Be sure to release the interface when you are finished using it.

See Also