IEffect

public interface IEffect

Represents animation effect.

Methods

Method Description
getSequence() Returns a sequence for an effect.
getTextAnimation() Returns text animation.
getPresetClassType() Defines class of effect.
setPresetClassType(int value) Defines class of effect.
getType() Defines type of effect.
setType(int value) Defines type of effect.
getSubtype() Defines subtype of effect.
setSubtype(int value) Defines subtype of effect.
getBehaviors() Returns collection of behavior for effect.
setBehaviors(IBehaviorCollection value) Returns collection of behavior for effect.
getTiming() Defines timing value for effect.
setTiming(ITiming value) Defines timing value for effect.
getTargetShape() Returns target shape for effect.
getSound() Defined embedded sound for effect.
setSound(IAudio value) Defined embedded sound for effect.

getSequence()

public abstract ISequence getSequence()

Returns a sequence for an effect. Read-only ISequence.

Returns: ISequence

getTextAnimation()

public abstract ITextAnimation getTextAnimation()

Returns text animation. Read-only ITextAnimation.

Returns: ITextAnimation

getPresetClassType()

public abstract int getPresetClassType()

Defines class of effect. Read/write EffectPresetClassType.

Returns: int

setPresetClassType(int value)

public abstract void setPresetClassType(int value)

Defines class of effect. Read/write EffectPresetClassType.

Parameters:

Parameter Type Description
value int

getType()

public abstract int getType()

Defines type of effect. Read/write EffectType.

Returns: int

setType(int value)

public abstract void setType(int value)

Defines type of effect. Read/write EffectType.

Parameters:

Parameter Type Description
value int

getSubtype()

public abstract int getSubtype()

Defines subtype of effect. Read/write EffectSubtype.

Returns: int

setSubtype(int value)

public abstract void setSubtype(int value)

Defines subtype of effect. Read/write EffectSubtype.

Parameters:

Parameter Type Description
value int

getBehaviors()

public abstract IBehaviorCollection getBehaviors()

Returns collection of behavior for effect. Read/write IBehaviorCollection.

Returns: IBehaviorCollection

setBehaviors(IBehaviorCollection value)

public abstract void setBehaviors(IBehaviorCollection value)

Returns collection of behavior for effect. Read/write IBehaviorCollection.

Parameters:

Parameter Type Description
value IBehaviorCollection

getTiming()

public abstract ITiming getTiming()

Defines timing value for effect. Read/write ITiming.

Returns: ITiming

setTiming(ITiming value)

public abstract void setTiming(ITiming value)

Defines timing value for effect. Read/write ITiming.

Parameters:

Parameter Type Description
value ITiming

getTargetShape()

public abstract IShape getTargetShape()

Returns target shape for effect. Read-only IShape.

Returns: IShape

getSound()

public abstract IAudio getSound()

Defined embedded sound for effect. Read/write IAudio.


Presentation presentation = new Presentation("demo.pptx");
 try {
     ISlide slide = presentation.getSlides().get_Item(0);

     // Gets the effects sequence for the slide
     ISequence effectsSequence = slide.getTimeline().getMainSequence();

     for (IEffect effect : effectsSequence)
     {
         if (effect.getSound() == null)
             continue;

         // Extracts the effect sound in byte array
         byte[] audio = effect.getSound().getBinaryData();
     }
 } finally {
     if (presentation != null) presentation.dispose();
 }

Returns: IAudio

setSound(IAudio value)

public abstract void setSound(IAudio value)

Defined embedded sound for effect. Read/write IAudio.


Presentation presentation = new Presentation("demo.pptx");
 try {
     ISlide slide = presentation.getSlides().get_Item(0);

     // Gets the effects sequence for the slide
     ISequence effectsSequence = slide.getTimeline().getMainSequence();

     for (IEffect effect : effectsSequence)
     {
         if (effect.getSound() == null)
             continue;

         // Extracts the effect sound in byte array
         byte[] audio = effect.getSound().getBinaryData();
     }
 } finally {
     if (presentation != null) presentation.dispose();
 }

Parameters:

Parameter Type Description
value IAudio