README

简介

一个可扩展的插件，可以轻松嵌入自定义音频和视频播放器。

.此插件不使用oembed，它通过自身构建iframe嵌入代码和HTML5播放器，无需任何外部请求，以获得更好的性能。

支持的扩展

据上次插件发布时的信息...

• Abc News: oui_abcnews;
• Archive: oui_archive;
• Bandcamp: oui_bandcamp;
• Dailymotion: oui_dailymotion;
• Giphy: oui_giphy;
• HTML5音频: oui_audio;
• HTML5视频: oui_video;
• Mixcloud: oui_mixcloud;
• Myspace视频: oui_myspace;
• Soundcloud: oui_soundcloud;
• Twitch: oui_twitch;
• Viddsee: oui_viddsee;
• Vimeo: oui_vimeo;
• Vine: oui_vine;
• Youtube: oui_youtube.

插件要求

oui_player的最小要求

• Textpattern CMS 4.6+;
• oui_provider v1+;
• 上述任何与提供程序相关的扩展。

插件管理

安装

从管理界面

在安装所需的oui_player扩展之前或之后，遵循以下说明

1. 下载编译的插件文件.txt或_zip.txt;
2. 通过管理 > 插件选项卡上传其内容；
3. 在预览页面上确认插件安装。
4. 启用插件并点击 选项 链接以设置插件首选项。

通过 Composer（目前不可用）

安装 Composer 后

1. 定位到您的项目目录
   $ cd /path/to/your/textpattern/installation/dir
2. 如果尚未完成，锁定您的 Txp 版本
   $ composer require textpattern/lock:4.6.2，其中 4.6.2 是正在使用的 Txp 版本。
3. 安装 oui_player
   $ composer require nicolasgraph/oui_player
4. 连接到 Txp 管理界面并点击 选项 或访问“管理 > 首选项”：?event=prefs#prefs_group_oui_player 标签页以填写插件首选项。

更新

从管理界面

按照安装说明操作。
如果您是从 v1.* 升级，请务必在访问“管理 > 首选项”：?event=prefs#prefs_group_oui_player 标签页之前安装所有想要的扩展，以保持您的首选项值不变。

通过 Composer（目前不可用）

$ composer update nicolasgraph/oui_player

卸载

从管理界面

1. 在 管理 > 插件 标签页中，勾选相关行左侧的复选框。
2. 在插件列表下方，选择 删除 选项。
3. 确认删除。

通过 Composer（目前不可用）

$ composer remove nicolasgraph/oui_player

首选项/选项

插件首选项可以在 管理 > 首选项 标签页中设置，主要用于作为 <txp:oui_player /> 标签属性的默认值。

全局首选项

默认字段

定义一个用作默认 play 属性值的字段。
提供的字段名必须与其中输入的任何值不同；如果使用 ID 作为 play 属性值，请避免使用数字
默认: article_image
有效: article_image 或任何现有自定义字段

首选提供者

设置默认 provider 属性值。
默认: 首个插拔提供者
有效: 选择列表中的任何插拔提供者

显示提供者玩家首选项

以首选项组的形式显示定义的提供者首选项。
默认: 是
有效: 是或否

提供者首选项

虽然 一些与播放项目相关的玩家参数应该通过属性使用（例如，定义视频开始时间的 YouTube start 参数），但这些用作全局设置的参数应优先通过插件首选项设置，以避免大量使用标签属性。

当然，在需要时，仍然可以通过属性覆盖插件首选项值。

标签

oui_player

嵌入玩家。

<txp:oui_player />

表现属性

label

字符串；默认为空。
视频标签。

labeltag

HTML 容器标签名；默认为空。
HTML 标签用于标签，不带括号。

wraptag

HTML 容器标签名；默认为空。
HTML 标签用作内容包装标签，不带括号。

class

字符串；默认为空。
CSS 类用于 HTML 内容包装标签。

responsive

true 或 false，默认使用相关首选项值。
根据提供的宽度和/或高度和/或比率值调整最终播放器大小以适合容器宽度。
包装播放器并添加一些样式。

主要标签属性

以下大多数属性可以通过 首选项 标签设置；始终首选插件的“全局”首选项而不是与标签相关的属性！

play

有效值因提供者而异，请检查每个扩展。
要播放的项目；如果它不使用插件首选项中选定的自定义字段的值，则为必需（查看每个提供者以了解有效值）。
默认: 自 v1.2.0 更改 最终 play 属性值 <txp:oui_if_play></txp:oui_if_play> 容器标签，或插件首选项中选定的自定义字段的值。

provider

与扩展相关的提供者名称；默认使用相关首选项值。
要使用的提供者；如果 play 属性是一个 ID，则 必需；即使不知道，也建议使用，因为它可以通过跳过提供者猜测来提高插件性能。

与提供者相关的标签属性

请参阅每个提供者相关的扩展。

oui_if_player

将 play 属性值与定义的 URL 方案进行比较。

<txp:oui_if_player>
[…]
</txp:oui_if_player>

属性

play

默认情况下，在插件首选项中选定的自定义字段值。
要播放的项目；如果它不使用插件首选项中选定的自定义字段的值，则为必需（查看每个提供者以了解有效值）。

provider

与扩展相关的提供者名称；默认为空。
将 URL 与定义的提供者的有效 URL 方案进行比较。

示例

显示通过插件首选项收集的默认值中的播放器

<txp:oui_player />

显示手动填写的 URL 中的播放器

<txp:oui_player play="https://vimeo.com/155020267" />

…或者，可能更快…

<txp:oui_player provider="vimeo" play="https://vimeo.com/155020267" />

显示手动填写的 ID 中的播放器

使用在首选项中设置的首选提供者。

<txp:oui_player play="x4l8awd" />

…或者，与 provider 属性一起…

<txp:oui_player provider="dailymotion" play="x4l8awd" />

仅在播放器的 URL 被识别为提供者 URL 方案时显示播放器

使用通过插件首选项收集的默认值…

<txp:oui_if_player>
    <txp:oui_player />
</txp:oui_if_player>

…或者，使用手动填写的 URL…

<txp:oui_if_player play="https://vimeo.com/155020267">
    <txp:oui_player />
</txp:oui_if_player>

您还可以添加提供者属性，以将 URL 与定义的提供者的 URL 方案进行比较。

致谢

作者

尼古拉·莫兰德
感谢 Textpattern 社区和核心团队。

许可

此插件根据 GPL v2.0 分发。

oui_player 版本 2.0.0-BETA3，版权所有 © 2018 尼古拉·莫兰德
此 Textpattern 插件附带 ABSOLUTELY 无 保修。
这是免费软件，您可以根据某些条件重新分发它 。

变更日志

• v2.0.0-BETA3 (2018-08-15)
  • 新增：管理端播放器预览；
  • 更改：摘录字段不再受支持；
  • 新增：响应式嵌入；
    • 更改：默认显示提供者相关首选项；
  • 更改：代码重构；
    • 提供者现在作为可插入的扩展工作；
      • 扩展基础（必需）：oui_provider；任何在作者前缀相关命名空间中扩展 \Oui\Provider 类的插件都将连接到 oui_player；
      • ABC 新闻：oui_abcnews；
      • 存档：oui_archive；
      • Bandcamp：oui_bandcamp；
      • Dailymotion：oui_bandcamp；
      • Giphy：oui_giphy（新）；
      • Mixcloud：oui_mixcloud；
      • MySpace：oui_myspace；
      • HTML5 音频：oui_audio；
      • HTML5 视频：oui_video；
      • Soundcloud：oui_soundcloud；
      • Twitch：oui_twitch；
      • Viddsee：oui_viddsee；
      • Vimeo：oui_vimeo。
      • 葡萄藤: oui_vine;
      • YouTube: oui_youtube;
    • 作者前缀相关命名空间；
    • 新类名（Admin => PlayerAdmin，Main => Player，Player => PlayerBase）；
    • 标签现在注册了与Player类相关的回调方法；
    • 存储提供者时使用与其插件作者相关的前缀/命名空间。
    • 通过Txp::get()创建/获取实例。
• v1.3.1 (2017-07-13)
• v1.3.0 (2017-05-24)
  • 为textpattern/installer添加了对Composer的支持；
  • 修复了多个播放器首选项显示并提高了性能；
  • 改进了脚本嵌入；
  • 添加：YouTube播放器参数enablejsapi和origin；
  • 添加：Dailymotion播放器参数api和origin；
  • 添加：Vimeo播放器参数api并移除badge；
  • 添加：支持
    • Bandcamp;
    • HTML5 audio + video；
• v1.2.1 (2017-01-16)
  • 修复：在没有自定义字段时，修复了“默认字段使用”首选项显示；
  • 修复：修复了Textpack错别字；
  • 更改：通过删除重复的许可证相关注释来减轻编译代码；
• v1.2.0 (2016-12-12)
  • 添加：将自定义字段插件首选项设置为条件标签play属性的默认值；
  • 添加：在条件/容器标签上下文中引入了play属性值继承；
  • 添加：支持
    • Twitch频道,
    • 葡萄藤;
  • 更改：改进了PHP类和方法的使用（参见开发者指南）；
• oui_player v1.1.0 (2016-10-14)
  • 更改：插件/标签名称；
  • 移除：Txp 4.5支持；
  • 更改：属性和播放器参数名称之间的一致性增加；
  • 更改：代码重构以便易于扩展；
  • 添加：支持
    • ABC新闻,
    • 存档,
    • Mixcloud,
    • Myspace视频,
    • Soundcloud,
    • Twitch,
    • Viddsee;
  • （更改）帮助文件样式改进。
• oui_video v0.1.0 (2016-09-13)
• oui_dailymotion v1.3.1（2016-02-25）受arc_youtube和arc_vimeo启发，由Andy Carter制作。