JSON API - addAudio

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

addAudio

PREMIUM

TRIAL / ADVANCED

Inserts an audio into the PowerPoint presentation.

Note

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

JSON data

{
    "audio": "string",
    "position": {
        "coordinateX": number,
        "coordinateY": number,
        "sizeX": number,
        "sizeY": number,
        "name": "string",
        "order": number
    },
    "audioStyles": {
        "image": {
            "image": "string",
            "mime": "string"
        },
        "mime": "string"
    },
    "options": {
        "descr": "string"
    }
}

Key	Description
audio	Audio path, Base64 string, or URL. Audio formats: flac, mp3, wav, wma.
coordinateX	EMUs (English Metric Unit).
coordinateY	EMUs (English Metric Unit).
sizeX	EMUs (English Metric Unit).
sizeY	EMUs (English Metric Unit).
name	Internal name. If not set, a random name is generated.
order	Set the display order. Default after existing contents. 0 is the first order position. If the order position doesn't exist add after existing contents.
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).
mime	Forces a mime (audio/mpeg, audio/x-wav, audio/x-ms-wma, audio/unknown).
descr	Placeholder alt text (descr) value.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addAudio",
            "data": {
                "audio": "audio.mp3",
                "position": {
                    "coordinateX": 1400000,
                    "coordinateY": 4500000,
                    "sizeX": 2000000,
                    "sizeY": 2000000
                }
            }
        }
    ]
}

Release notes

phppptx 5.0:
- new action.