JSON API - replaceVariableAudio

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

replaceVariableAudio

PREMIUM

TRIAL / ADVANCED

Replaces audio placeholders with new audios.

Note

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

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 audios that should replace them as values. Audio 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: audio/mpeg, audio/x-wav, audio/x-ms-wma, audio/unknown.
target	slides (default) slideLayouts slideMasters

Code samples

Example #1

{
    "template": "template.pptx",
    "actions": [
        {
            "action": "replaceVariableAudio",
            "data": {
                "variables": {
                    "AUDIO_1": "audio.mp3"
                }
            }
        }
    ]
}

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

Release notes

phppptx 5.0:
- new action.