addOnlineVideo

WORD CONTENTS

LAYOUT & SETTINGS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

BULK PROCESSING

TRACKING

CRYPTOPHPDOCX

DIGITAL SIGNATURE

ARTIFICIAL INTELLIGENCE

XLSXUTILITIES

PPTXUTILITIES

BLOCKCHAIN

VARIANT

addOnlineVideo

ADVANCED / PREMIUM

TRIAL

Inserts an online video into your document.

Description

public addOnlineVideo ( string $src [, array $options] )

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.

Parameters

src

URL of the video to be added.

options

The specific options have the following keys and values:

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

Exceptions

Method not available.

Image does not exist.

Image format not supported.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$docx->addText('Add an online video with a custom image:');
$options = array(
    'image' => 'image.png',
    'width' => 400,
);

$docx->addOnlineVideo('https://www.youtube.com/embed/S-nHYzK-BVg', $options);

$docx->addText('This is a closing paragraph.');

// set MS Word compatibility from MS Word 2013
$settings = array(
    'compat' => array(
        'compatibilityMode' => array('val' => '15'),
    )
);
$docx->docxSettings($settings);

$docx->createDocx('output');

Release notes

phpdocx 10.0:
- new method.