Add an Effect to an Interactive Sequence

Introduction

Aspose.Slides Cloud API enables you to manipulate animations within PowerPoint presentations, including reading, adding, modifying, and deleting them. You can add effects to interactive animation sequences on special slides (Master, Layout, or Notes) in presentations using the following method.

CreateSpecialSlideAnimationInteractiveSequenceEffect

API Information

API	Type	Description	Resource
/slides/{name}/slides/{slideIndex}/{slideType}/animation/interactiveSequences/{sequenceIndex}	POST	Adds an effect to an interactive animation sequence on a special slide in a presentation saved in a storage.	CreateSpecialSlideAnimationInteractiveSequenceEffect

Request Parameters

Name	Type	Location	Required	Description
name	string	path	true	The name of a presentation file.
slideIndex	integer	path	true	The 1-based index of a regular slide.
slideType	`SpecialSlideType`	path	true	The type of a special slide.
sequenceIndex	integer	path	true	The 1-based index of an interactive animation sequence.
effect	`Effect`	body	true	The data transfer object with effect parameters.
password	string	header	false	The password to open the presentation.
folder	string	query	false	The folder where the presentation file is located.
storage	string	query	false	The storage where the folder is located.

Example

The document MyPresentation.pptx saved in the default storage contains two interactive animation sequences on the Layout of the first slide, each with a single effect (Fly and Split, for example). Add a Fade effect for the fourth shape into the first interactive sequence.

cURL Solution

Request

Get an Access Token

curl POST "https://api.aspose.cloud/connect/token" \
     -d "grant_type=client_credentials&client_id=MyClientId&client_secret=MyClientSecret" \
     -H "Content-Type: application/x-www-form-urlencoded"

Add the Effect

curl -X POST "/slides/MyPresentation.pptx/slides/1/LayoutSlide/animation/interactiveSequences/1" \
     -H "authorization: Bearer MyAccessToken" \
     -H "Content-Type: application/json" \
     -d @Effect.json

Effect.json content:

{
  "ShapeIndex": 4,
  "Type": "Fade",
  "TriggerType": "AfterPrevious"
}

Response

Response Example

{
  "mainSequence": [],
  "interactiveSequences": [
    {
      "effects": [
        {
          "type": "Fly",
          "subtype": "Bottom",
          "presetClassType": "Entrance",
          "shapeIndex": 2,
          "duration": 0.5,
          "triggerDelayTime": 0.0
        }
      ],
      "triggerShapeIndex": 1
    },
    {
      "effects": [
        {
          "type": "Split",
          "subtype": "HorizontalIn",
          "presetClassType": "Entrance",
          "shapeIndex": 3,
          "duration": 0.5,
          "triggerDelayTime": 0.0
        },
        {
          "type": "Fade",
          "subtype": "None",
          "presetClassType": "Entrance",
          "shapeIndex": 4,
          "duration": 0.5,
          "triggerDelayTime": 0.0
        }
      ],
      "triggerShapeIndex": 2
    }
  ],
  "selfUri": {
    "href": "https://api.aspose.cloud/v3.0/slides/MyPresentation.pptx/layoutSlides/1/animation",
    "relation": "self"
  }
}

SDK Solutions

using System;
using Aspose.Slides.Cloud.Sdk;
using Aspose.Slides.Cloud.Sdk.Model;

class Application
{
    static void Main(string[] args)
    {
        SlidesApi slidesApi = new SlidesApi("MyClientId", "MyClientSecret");

        string fileName = "MyPresentation.pptx";
        int slideIndex = 1;
        SpecialSlideType slideType = SpecialSlideType.LayoutSlide;
        int sequenceIndex = 1;
        
        Effect animationEffect = new Effect
        {
            ShapeIndex = 4,
            Type = Effect.TypeEnum.Fade,
            TriggerType = Effect.TriggerTypeEnum.AfterPrevious
        };

        SlideAnimation slideAnimation = slidesApi.CreateSpecialSlideAnimationInteractiveSequenceEffect(fileName, slideIndex, slideType, sequenceIndex, animationEffect);

        int effectCount = slideAnimation.InteractiveSequences[sequenceIndex - 1].Effects.Count;
        Console.WriteLine("Number of effects in the 2nd interactive sequence: " + effectCount); // 2
    }
}

Java

import com.aspose.slides.ApiException;
import com.aspose.slides.api.SlidesApi;
import com.aspose.slides.model.SpecialSlideType;
import com.aspose.slides.model.Effect;
import com.aspose.slides.model.SlideAnimation;

public class Application {
    public static void main(String[] args) throws ApiException {
        SlidesApi slidesApi = new SlidesApi("MyClientId", "MyClientSecret");

        String fileName = "MyPresentation.pptx";
        int slideIndex = 1;
        SpecialSlideType slideType = SpecialSlideType.LAYOUTSLIDE;
        int sequenceIndex = 1;

        Effect animationEffect = new Effect();
        animationEffect.setShapeIndex(4);
        animationEffect.setType(Effect.TypeEnum.FADE);
        animationEffect.setTriggerType(Effect.TriggerTypeEnum.AFTERPREVIOUS);

        SlideAnimation slideAnimation = slidesApi.createSpecialSlideAnimationInteractiveSequenceEffect(fileName, slideIndex, slideType, sequenceIndex, animationEffect, null, null, null);

        int effectCount = slideAnimation.getInteractiveSequences().get(sequenceIndex - 1).getEffects().size();
        System.out.println("Number of effects in the 2nd interactive sequence: " + effectCount); // 2
    }
}

PHP

use Aspose\Slides\Cloud\Sdk\Api\Configuration;
use Aspose\Slides\Cloud\Sdk\Api\SlidesApi;
use Aspose\Slides\Cloud\Sdk\Model\SpecialSlideType;
use Aspose\Slides\Cloud\Sdk\Model\Effect;
use Aspose\Slides\Cloud\Sdk\Model\SlideAnimation;

$configuration = new Configuration();
$configuration->setAppSid("MyClientId");
$configuration->setAppKey("MyClientSecret");

$slidesApi = new SlidesApi(null, $configuration);

$fileName = "MyPresentation.pptx";
$slideIndex = 1;
$slideType = SpecialSlideType::LAYOUT_SLIDE;
$sequenceIndex = 1;

$animationEffect = new Effect();
$animationEffect->setShapeIndex(4);
$animationEffect->setType(Effect::TYPE_FADE);
$animationEffect->setTriggerType(Effect::TRIGGER_TYPE_AFTER_PREVIOUS);

$slideAnimation = $slidesApi->createSpecialSlideAnimationInteractiveSequenceEffect($fileName, $slideIndex, $slideType, $sequenceIndex, $animationEffect);

$effectCount = count($slideAnimation->getInteractiveSequences()[$sequenceIndex - 1]->getEffects());
echo "Number of effects in the 2nd interactive sequence: ", $effectCount; // 2

Ruby

require "aspose_slides_cloud"

include AsposeSlidesCloud

configuration = Configuration.new
configuration.app_sid = "MyClientId"
configuration.app_key = "MyClientSecret"

slides_api = SlidesApi.new(configuration)

file_name = "MyPresentation.pptx"
slide_index = 1
slide_type = SpecialSlideType::LAYOUT_SLIDE
sequence_index = 1

animation_effect = Effect.new
animation_effect.shape_index = 4
animation_effect.type = "Fade"
animation_effect.trigger_type = "AfterPrevious"

slide_animation = slides_api.create_special_slide_animation_interactive_sequence_effect(file_name, slide_index, slide_type, sequence_index, animation_effect)

effect_count = slide_animation.interactive_sequences[sequence_index - 1].effects.length()
print "Number of effects in the 2nd interactive sequence: ", effect_count # 2

Python

from asposeslidescloud.apis import SlidesApi
from asposeslidescloud.models import SpecialSlideType
from asposeslidescloud.models import Effect

slides_api = SlidesApi(None, "MyClientId", "MyClientSecret")

file_name = "MyPresentation.pptx"
slide_index = 1
slide_type = SpecialSlideType.LAYOUTSLIDE
sequence_index = 1

animation_effect = Effect()
animation_effect.shape_index = 4
animation_effect.type = "Fade"
animation_effect.trigger_type = "AfterPrevious"

slide_animation = slides_api.create_special_slide_animation_interactive_sequence_effect(file_name, slide_index, slide_type, sequence_index, animation_effect)

effect_count = len(slide_animation.interactive_sequences[sequence_index - 1].effects)
print("Number of effects in the 2nd interactive sequence:", effect_count)  # 2

Node.js

const cloudSdk = require("asposeslidescloud");

const slidesApi = new cloudSdk.SlidesApi("MyClientId", "MyClientSecret");

fileName = "MyPresentation.pptx";
slideIndex = 1;
slideType = cloudSdk.SpecialSlideType.LayoutSlide;
sequenceIndex = 1;

animationEffect = new cloudSdk.Effect();
animationEffect.shapeIndex = 4;
animationEffect.type = cloudSdk.Effect.TypeEnum.Fade;
animationEffect.triggerType = cloudSdk.Effect.TriggerTypeEnum.AfterPrevious;

slidesApi.createSpecialSlideAnimationInteractiveSequenceEffect(fileName, slideIndex, slideType, sequenceIndex, animationEffect).then(slideAnimation => {
    effectCount = slideAnimation.body.interactiveSequences[sequenceIndex - 1].effects.length;
    console.log("Number of effects in the 2nd interactive sequence:", effectCount); // 2
});

C++

#include "asposeslidescloud/api/SlidesApi.h"

using namespace asposeslidescloud::api;

int main()
{
    std::shared_ptr<SlidesApi> slidesApi = std::make_shared<SlidesApi>(L"MyClientId", L"MyClientSecret");

    const wchar_t* fileName = L"MyPresentation.pptx";
    int slideIndex = 1;
    const wchar_t* slideType = L"LayoutSlide";
    int sequenceIndex = 1;

    std::shared_ptr<Effect> animationEffect = std::make_shared<Effect>();
    animationEffect->setShapeIndex(4);
    animationEffect->setType(L"Fade");
    animationEffect->setTriggerType(L"AfterPrevious");

    std::shared_ptr<SlideAnimation> slideAnimation = slidesApi->createSpecialSlideAnimationInteractiveSequenceEffect(fileName, slideIndex, slideType, sequenceIndex, animationEffect).get();

    int effectCount = slideAnimation->getInteractiveSequences()[sequenceIndex - 1]->getEffects().size();
    std::wcout << L"Number of effects in the 2nd interactive sequence: " << effectCount; // 2
}

Perl

use AsposeSlidesCloud::Configuration;
use AsposeSlidesCloud::SlidesApi;
use AsposeSlidesCloud::Object::Effect;

my $config = AsposeSlidesCloud::Configuration->new();
$config->{app_sid} = "MyClientId";
$config->{app_key} = "MyClientSecret";

my $slides_api = AsposeSlidesCloud::SlidesApi->new(config => $config);

my $file_name = "MyPresentation.pptx";
my $slide_index = 1;
my $slide_type = "LayoutSlide";
my $sequence_index = 1;

my $animation_effect = AsposeSlidesCloud::Object::Effect->new();
$animation_effect->{shape_index} = 4;
$animation_effect->{type} = "Fade";
$animation_effect->{trigger_type} = "AfterPrevious";

my $slide_animation = $slides_api->create_special_slide_animation_interactive_sequence_effect(
    name => $file_name, slide_index => $slide_index, slide_type => $slide_type, sequence_index => $sequence_index, effect => $animation_effect);

my $effect_count = @{$slide_animation->{interactive_sequences}[$sequence_index - 1]->{effects}};
print("Number of effects in the 2nd interactive sequence: ", $effect_count);  # 2

Swift

import (
	"fmt"

	asposeslidescloud "github.com/aspose-slides-cloud/aspose-slides-cloud-go/v24"
)

func main() {
	configuration := asposeslidescloud.NewConfiguration()
	configuration.AppSid = "MyClientId"
	configuration.AppKey = "MyClientSecret"

	slidesApi := asposeslidescloud.NewAPIClient(configuration).SlidesApi

	fileName := "MyPresentation.pptx"
	var slideIndex int32 = 1
  slideType := string(asposeslidescloud.SpecialSlideType_LayoutSlide)
	var sequenceIndex int32 = 1

	animationEffect := asposeslidescloud.NewEffect()
	animationEffect.ShapeIndex = 4
	animationEffect.Type_ = "Fade"
	animationEffect.TriggerType = "AfterPrevious"

	slideAnimation, _, _ := slidesApi.CreateSpecialSlideAnimationInteractiveSequenceEffect(fileName, slideIndex, slideType, sequenceIndex, animationEffect, "", "", "")

	effectCount := len(slideAnimation.GetInteractiveSequences()[sequenceIndex-1].GetEffects())
	fmt.Println("Number of effects in the 2nd interactive sequence:", effectCount) // 2
}

SDKs

Check Available SDKs to learn how to add an SDK to your project.

Delete Animations Update an Effect in an Interactive Sequence