FreePlay 内容提供商
FreePlay 是 ChurchApps 的媒体播放器,用于在手机、平板电脑和电视上流式传输课程和其他视频内容。如果您有一个课程内容库并希望在 FreePlay 中提供它,本指南涵盖了您需要提供的所有内容。
品牌
在集成开始之前,我们需要:
- Logo -- 16:9 宽高比的徽标图像(用于 FreePlay UI 中的提供商卡片)
- Brand name -- 在 FreePlay 中为您的组织显示的首选名称
API 端点
FreePlay 通过一小组 REST 端点与您的服务通信。我们为每个提供商编写自定义适配器,因此确切的 URL 结构是灵活的 -- 但以下是我们需要的信息。
身份验证
选择适合您内容的模型:
| 模型 | 何时使用 | 我们需要什么 |
|---|---|---|
| None | 公共内容,无需登录 | 无 -- 我们直接调用您的目录端点 |
| OAuth (PKCE) | Web/移动登录 | 授权 URL、令牌交换端点、客户端 ID、范围 |
| Device Flow | 首选用于电视应用(用户在手机上输入短代码) | 设备授权端点、令牌轮询端点、客户端 ID |
提示
如果您的内容需要身份验证,身份验证端点将返回一个 用户令牌,FreePlay 会将其传递给浏览和课程端点以授权访问。
浏览/目录
返回所有可用课程的 文件夹树 的端点(或一组端点)。
- 这可以是返回整个树的 单个调用,也可以是 多个调用,其中每个调用在用户导航更深时返回一个级别。
- 树中的每个项目都应包括:
| 字段 | 必需 | 描述 |
|---|---|---|
id | 是 | 文件夹的唯一标识符 |
name | 是 | 文件夹的显示名称 |
thumbnail | 推荐 | 16:9 缩略图 URL |
课程播放列表
返回单个课程的 媒体文件播放列表 的端点。
播放列表中的每个项目都应包括:
| 字段 | 必需 | 描述 |
|---|---|---|
title | 是 | 媒体项目的显示标题 |
mediaType | 是 | video 或 image |
url | 是 | 文件的直接下载链接(请参阅下面的媒体格式) |
duration | 推荐 | 持续时间(以秒为单位)(用于视频) |
媒体格式
FreePlay 直接下载文件,因此每个媒体项目都必须有一个 直接链接(没有嵌入式播放器或页面重定向)。
| 类型 | 接受的格式 |
|---|---|
| 视频 | MP4(在 Apple 和 Android 设备上跨平台播放所需) |
| 图像 | JPG、PNG 或 GIF |