mlreportgen.ppt.Video 类

命名空间: mlreportgen.ppt

要插入演示文稿的视频

自 R2026a 起

描述

使用 mlreportgen.ppt.Video 类的实例，将视频插入到演示文稿中。

mlreportgen.ppt.Video 类是一个 handle 类。

类属性

`HandleCompatible`	`true`
`ConstructOnLoad`	`true`

有关类属性的信息，请参阅类属性。

创建对象

描述

videoObj = mlreportgen.ppt.Video 创建一个空 Video 对象。

videoObj = mlreportgen.ppt.Video(videoPath) 会创建一个 Video 对象，其中包含由 videoPath 指定的视频。

videoObj = mlreportgen.ppt.Video(videoPath,thumbnailPath) 会创建一个 Video 对象，其中包含由 thumbnailPath 指定的缩略图。

示例

注意

关闭 mlreportgen.ppt.Presentation 对象会将指定视频文件的内容复制到输出的演示文稿中。在复制过程完成之前，请勿删除或覆盖该视频文件。

输入参量

全部展开

`videoPath` — 视频文件的路径和名称
字符向量 | 字符串标量

视频文件的路径和名称，指定为字符向量或字符串标量。PPT API 支持以下视频格式：

视频格式	文件扩展名
高级系统格式	`.asf`
音视频交错	`.avi`
MPEG-4 第 14 部分	`.mp4`
MPEG 基本流视频	`.mpv`
MPEG-1 或 MPEG-2	`.mpg`
动态图像专家组	`.mpeg`
Windows Media 视频	`.wmv`（仅限 Windows^®）
QuickTime 文件格式	`.mov`（仅限 macOS）

注意

要查看您所使用的 PowerPoint^® 版本支持哪些文件格式，请参阅 Microsoft^® 网站上的 PowerPoint 支持的文件格式。

该参量用于设置 Path 和 Name 属性。

数据类型: char | string

`thumbnailPath` — 缩略图文件的路径和名称
字符向量 | 字符串标量

缩略图文件的路径和名称，指定为字符向量或字符串标量。PPT API 支持以下图像格式：

图像格式	文件扩展名
Windows 增强型图元文件	`.emf`
封装的 PostScript^®	`.eps`
图形交换格式	`.gif`
联合图像专家组	`.jpeg`, `.jpg`
可移植网络图形	`.png`
可缩放矢量图	`.svg`
标记图像文件格式	`.tif`, `.tiff`

注意

要查看您所使用的 PowerPoint 版本支持哪些文件格式，请参阅 Microsoft 网站上的 PowerPoint 支持的文件格式。

此参量设置 PosterFrame 属性。

数据类型: char | string

属性

全部展开

`Path` — 视频文件路径
字符向量 | 字符串标量

视频文件路径，指定为字符向量或字符串标量。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Name` — 视频名称
字符向量 | 字符串标量

视频名称，指定为字符向量或字符串标量。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`PosterFrame` — 缩略图文件的路径
字符向量 | 字符串标量

缩略图文件的路径和名称，指定为字符向量或字符串标量。PPT API 支持以下图像格式：

图像格式	文件扩展名
Windows 增强型图元文件	`.emf`
封装的 PostScript	`.eps`
图形交换格式	`.gif`
联合图像专家组	`.jpeg`, `.jpg`
可移植网络图形	`.png`
可缩放矢量图	`.svg`
标记图像文件格式	`.tif`, `.tiff`

注意

要查看您所使用的 PowerPoint 版本支持哪些文件格式，请参阅 Microsoft 网站上的 PowerPoint 支持的文件格式。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Caption` — 字幕文件的路径
字符向量 | 字符串标量

字幕文件的路径，指定为字符向量或字符串标量。有关为演示文稿创建字幕文件的更多信息，请参阅 Microsoft 网站上的为视频创建隐藏式字幕。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`X` — 左上角 x 坐标位置
`[]` (默认) | 字符向量 | 字符串标量

左上角 x 坐标位置，指定为字符向量或字符串标量，其中包含一个数字，后跟一个计量单位的缩写。例如，"5in" 指定五英寸。有效的缩写是：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

您也可以通过省略单位来指定像素值。例如，"5" 指定 5 像素。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Y` — 左上角 y 坐标位置
`[]` (默认) | 字符向量 | 字符串标量

左上角 y 坐标位置，指定为字符向量或字符串标量，其中包含一个数字，后跟一个计量单位的缩写。例如，"5in" 指定五英寸。有效的缩写是：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

您也可以通过省略单位来指定像素值。例如，"5" 指定 5 像素。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Width` — 视频宽度
字符向量 | 字符串标量

视频宽度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个计量单位的缩写。例如，"5in" 指定五英寸。有效的缩写是：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

您也可以通过省略单位来指定像素值。例如，"5" 指定 5 像素。

注意

当您将幻灯片中的 mlreportgen.ppt.ContentPlaceholder 对象替换为 mlreportgen.ppt.Video 对象时，mlreportgen.ppt.Video 对象的维度将受 ContentPlaceholder 对象维度的限制。如果 Width 或 Height 属性的值大于 ContentPlaceholder 对象的相应属性值，则演示文稿会自动调整 Width 和 Height 属性的大小，使其适应 ContentPlaceholder 的维度，同时保持媒体的宽高比。如果您将 mlreportgen.ppt.Video 对象直接添加到幻灯片中，则媒体的大小将受限于幻灯片的大小。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Height` — 视频高度
字符向量 | 字符串标量

视频的高度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个计量单位的缩写。例如，"5in" 指定五英寸。有效的缩写是：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

您也可以通过省略单位来指定像素值。例如，"5" 指定 5 像素。

注意

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Style` — 忽略此属性
不适用

该类忽略此属性。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Parent` — 此对象的父对象
PPT API 对象

此对象的父级，指定为 PPT API 对象。一个 PPT API 对象只能有一个父对象。

属性：

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Children` — 忽略此属性
不适用

该类忽略此属性。

属性：

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Tag` — 标签
字符向量 | 字符串标量

标记，指定为字符向量或字符串标量。PPT API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值可帮助确定在生成演示文稿的过程中问题发生的位置。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Id` — 目标标识符
字符向量 | 字符串标量

目标标识符，指定为字符向量或字符串标量。PPT API 在创建演示文稿元素对象时，会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

方法

全部展开

公共方法

replace

objReplace = replace(originalObj,replacementObj) 将原始对象替换为另一个同类型的对象。

输入参量

originalObj - 待替换的对象，指定为 mlreportgen.ppt.Video 对象
replacementObj - 用作替换的对象，指定为 mlreportgen.ppt.Video 对象

返回值

objReplace - 被替换的对象，以 mlreportgen.ppt.Video 对象形式返回

有关详细信息，请参阅 mlreportgen.ppt.TextBox 类的 replace 方法。

clone

objCopy = clone(obj) 返回 obj 指定的 mlreportgen.ppt.Video 对象的副本。副本包含源对象的子级，但不包含父级。

输入参量

obj - 要克隆的对象，指定为 mlreportgen.ppt.Video 对象

返回值

objCopy - 对象副本，以 mlreportgen.ppt.Video 对象形式返回

有关详细信息，请参阅 mlreportgen.ppt.Paragraph 类的 clone 方法。

示例

全部折叠

将视频添加到演示文稿中

打开实时脚本

本示例演示了如何将带有自定义缩略图和字幕文件的视频添加到演示文稿中。

导入 PPT API 命名空间，这样您就无需使用完全限定类名了。

import mlreportgen.ppt.*;

创建演示文稿。

ppt = Presentation("MyPresentation.pptx");

打开演示文稿，并添加一个标题幻灯片。

open(ppt);
slide1 = add(ppt,"Title Slide");

请将标题和副标题替换为您的内容。

replace(slide1,"Title","Pedestrian Tracking");
replace(slide1,"Subtitle",string(datetime('now','Format','d-MMM-y')));

添加视频并自定义其大小和位置。X 和 Y 分别表示距内容占位符左上角的距离。

video = Video("vippedtracking.mp4");
video.Height = "3in";
video.Width = "5.3in";
video.X = "2in";
video.Y = "2in";

为视频添加自定义缩略图。

video.PosterFrame = "vippedtrackingThumbnail.png";

向视频中添加字幕文件。

video.Caption = "vippedtrackingCaptions.vtt";

添加第二张幻灯片，并将内容占位符替换为视频。

slide2 = add(ppt,"Title and Content");
replace(slide2,"Title","Street Video 1");
replace(slide2,"Content",video);

关闭并查看演示文稿。关闭演示文稿时，系统会将指定视频文件的内容复制到输出演示文稿中。在复制过程完成之前，请勿删除或覆盖该视频文件。

close(ppt);
rptview(ppt);

这张图片展示了生成的 PPT。

Two Powerpoint slides showing the title on the first slide and the street video embedded on the second slide.

提示

在设置 Video 对象的 Width 或 Height 属性时，PPT API 会重新调整 Video 对象的维度，使其适应包含视频的占位符。

版本历史记录

在 R2026a 中推出

另请参阅

mlreportgen.ppt.Presentation | mlreportgen.ppt.Slide | mlreportgen.ppt.ContentPlaceholder

mlreportgen.ppt.Video 类

描述

类属性

创建对象

描述

输入参量

videoPath — 视频文件的路径和名称 字符向量 | 字符串标量

thumbnailPath — 缩略图文件的路径和名称 字符向量 | 字符串标量

属性

Path — 视频文件路径 字符向量 | 字符串标量

属性：

Name — 视频名称 字符向量 | 字符串标量

属性：

PosterFrame — 缩略图文件的路径 字符向量 | 字符串标量

属性：

Caption — 字幕文件的路径 字符向量 | 字符串标量

属性：

X — 左上角 x 坐标位置 [] (默认) | 字符向量 | 字符串标量

属性：

Y — 左上角 y 坐标位置 [] (默认) | 字符向量 | 字符串标量

属性：

Width — 视频宽度 字符向量 | 字符串标量

属性：

Height — 视频高度 字符向量 | 字符串标量

属性：

Style — 忽略此属性 不适用

属性：

Parent — 此对象的父对象 PPT API 对象

属性：

Children — 忽略此属性 不适用

属性：

Tag — 标签 字符向量 | 字符串标量

属性：

Id — 目标标识符 字符向量 | 字符串标量

属性：

方法

公共方法

示例

将视频添加到演示文稿中

提示

版本历史记录

另请参阅

`videoPath` — 视频文件的路径和名称
字符向量 | 字符串标量

`thumbnailPath` — 缩略图文件的路径和名称
字符向量 | 字符串标量

`Path` — 视频文件路径
字符向量 | 字符串标量

`Name` — 视频名称
字符向量 | 字符串标量

`PosterFrame` — 缩略图文件的路径
字符向量 | 字符串标量

`Caption` — 字幕文件的路径
字符向量 | 字符串标量

`X` — 左上角 x 坐标位置
`[]` (默认) | 字符向量 | 字符串标量

`Y` — 左上角 y 坐标位置
`[]` (默认) | 字符向量 | 字符串标量

`Width` — 视频宽度
字符向量 | 字符串标量

`Height` — 视频高度
字符向量 | 字符串标量

`Style` — 忽略此属性
不适用

`Parent` — 此对象的父对象
PPT API 对象

`Children` — 忽略此属性
不适用

`Tag` — 标签
字符向量 | 字符串标量

`Id` — 目标标识符
字符向量 | 字符串标量