JSON API - replaceVariableVideo

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

replaceVariableVideo

PREMIUM

TRIAL / ADVANCED

Replaces video placeholders with new videos.

Note

You are reading the JSON API documentation. For the PHP API method please go to replaceVariableVideo.

JSON data

{
    "variables": object,
    "options": {
        "activeSlide": boolean,
        "image": {
            "image": "string",
            "mime": "string",
            "usePlaceholderImage": boolean
        },
        "mime": "string",
        "target": "string"
    }
}

Key	Description
variables	The names of the placeholder template variables as keys and the videos that should replace them as values. Video path, Base64 string, or URL.
activeSlide	If true, get only the active slide. Default as false.
image	"image" image to be used as preview. Set a default one if not set. Image path, Base64 string, or URL. "mime" forces a mime (image/jpg, image/jpeg, image/png, image/gif, image/bmp, image/webp). "usePlaceholderImage" if true, do not change the placeholder image. Default as false.
mime	Forces a mime: video/mp4, video/x-msvideo, video/x-ms-wmv, video/unknown.
target	slides (default) slideLayouts slideMasters

Code samples

Example #1

{
    "template": "template.pptx",
    "actions": [
        {
            "action": "replaceVariableVideo",
            "data": {
                "variables": {
                    "VIDEO_1": "video.mp4"
                }
            }
        }
    ]
}

A template can be a local file, a Base64 string, or a remote file.

Release notes

phppptx 5.0:
- new action.