XML API - pdx:addOnlineVideo

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addOnlineVideo

Inserts an online video into your document.

Note

You are reading the XML API documentation. For the PHP API method please go to addOnlineVideo.

Description

Element definition

<pdx:content>
    <pdx:addOnlineVideo pdx:src="" pdx:image="" pdx:height="" pdx:hyperlink="" pdx:width="" />
</pdx:content>

This method allows you to insert an online video into your Word document.

Compatible from MS Word 2013, if older or other DOCX reader set as link.

Attributes and sub-elements

src

URL of the video to be added.

options

The specific options have the following keys and values:

Key	Type	Description
image	Use a custom image as video preview, black color otherwise.
height	In pixels, 315 as default.
hyperlink	Use src if not set.
width	In pixels, 560 as default.

Code samples

Example #1

config.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:config>
        <pdx:output pdx:name="output" pdx:type="docx" />
    </pdx:config>
</pdx:document>

content.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main" >
    <pdx:content>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Add an online video:</pdx:data>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addOnlineVideo pdx:src="https://www.youtube.com/embed/S-nHYzK-BVg" />
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">This is a closing paragraph.</pdx:data>
            </pdx:textRun>
        </pdx:addText>
    </pdx:content>
</pdx:document>

settings.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:settings>
    </pdx:settings>
</pdx:document>

PHP code

require_once 'path_to_phpdocx/classes/CreateDocx.php';

$docx = new XMLAPI('config.xml');
$docx->setDocumentProperties('settings.xml');
$docx->addContent('content.xml');

$docx->render();