Microsoft DirectX 8.0 |
Provides methods for adding effects to a timeline object in Microsoft® DirectShow® Editing Services (DES), and for manipulating the effects on an object. Applies to timeline objects that can have effects applied to them, such as sources, tracks, and compositions.
Methods
EffectGetCount Retrieves the number of effects applied to this object. EffectInsBefore Inserts an effect into the object at the specified priority level. EffectSwapPriorities Switches the priority levels of two effects. GetEffect Retrieves the effect at the specified priority level.
Retrieves the number of effects applied to this object.
Syntax
object.EffectGetCount( pCount As Long )
Parts
- object
- Object expression that evaluates to an IAMTimelineEffectable object.
- pCount
- Variable that receives the number of effects.
Error Codes
If the method fails, an error is raised.
IAMTimelineEffectable Interface
Inserts an effect into the object at the specified priority level.
Syntax
object.EffectInsBefore( pFX As AMTimelineObj, Priority As Long )
Parts
- object
- Object expression that evaluates to an IAMTimelineEffectable object.
- pFX
- The AMTimelineObj object that specifies the effect.
- Priority
- Priority level at which to insert the effect. Use the value 1 to insert the effect at the end of the priority list.
Error Codes
If the method fails, an error is raised, and Err.Number can be set to the following value:
E_NOTIMPL The object specified by pFX is not an effect.
Remarks
The start and stop times of the effect are clipped within the bounds of the object's time range, if necessary.
If there is already an effect at the specified priority level, all the effects from that point on move down the priority list to make room for the new effect.
IAMTimelineEffectable Interface
Switches the priority levels of two effects.
Given two priority values, this method swaps the effects at those priorities. When the method returns, the effect that was at the first priority level is at the second priority level, and vice versa.
Syntax
object.EffectSwapPriorities( PriorityA As Long, PriorityB As Long )
Parts
- object
- Object expression that evaluates to an IAMTimelineEffectable object.
- PriorityA
- First priority level at which to swap effects.
- PriorityB
- Second priority level at which to swap effects.
Error Codes
If the method fails, an error is raised, and Err.Number can be set the following value:
E_INVALIDARG Invalid argument.
IAMTimelineEffectable Interface
Retrieves the effect at the specified priority level.
Syntax
object.GetEffect( ppFx As AMTimelineObj, Which As Long )
Parts
- object
- Object expression that evaluates to an IAMTimelineEffectable object.
- ppFX
- The AMTimelineObj object that receives the effect.
- Which
- Priority level of the effect to retrieve.
Error Codes
If the method fails, an error is raised.