ApiVideoPlayer 1.3.0

ApiVideoPlayer 1.3.0

×

由 api.video 生态系统团队 维护。

ApiVideoPlayer 1.3.0

  • 由
  • 生态系统

badge   badge   badge

api.video Swift 播放器

api.video 是产品构建者的视频基础设施。提供快速的视频 API，以便在您的应用中集成、扩展和管理按需和低延迟实时流。

目录

项目描述

轻松将 api.video 的视频播放器集成到您的 iOS 应用中。

入门指南

安装

Swift 包管理器

在项目导航器中选择您自己的项目。然后在项目部分选择该项目，并点击 "包依赖" 选项卡。在底部点击 "+" 按钮。将以下 url 剪切贴到右上角的搜索栏上。最后点击 "添加包" 按钮。

 https://github.com/apivideo/api.video-swift-player

或者，在您的 Package.swift 中添加以下内容

  dependencies: [
        .package(url: "https://github.com/apivideo/api.video-swift-player.git", from: "1.1.4"),
    ],

CocoaPods

在您的 Podfile 中添加 pod 'ApiVideoPlayer', '1.1.4'

运行 pod install

获取您的视频 Id

在这之后，您至少需要在您的帐户中上传一个视频。如果您还没有，请查看如何上传视频。您需要一个视频 Id 来使用此组件并播放 api.video 中的视频。要获取您的 Id，请按照以下步骤操作

  1. 登录您的帐户 或 在此处创建一个。
  2. 复制您的 API 密钥（沙盒或生产，如果您订阅了我们的其中一个 计划）。
  3. 转到 官方 api.video 文档。
  4. 在右上角登录您的帐户。如果已经登录，请确保它是您想要使用的帐户。
  5. 转到 API 参考 -> 视频 -> 列出所有视频
  6. 确保右侧的 "认证" 部分包含您想要使用的 API 密钥。
  7. 通过点击右侧部分的 "试用!" 按钮生成您的上传令牌。
  8. 复制右侧响应元素中的“videoId”值。

或者，您可以在仪表板的视频详情中找到您的视频ID。

代码示例

  1. 导入库
import ApiVideoPlayer
  1. 实例化播放器视图
let playerView: ApiVideoPlayerView = ApiVideoPlayerView(frame: .zero, videoOptions: VideoOptions(videoId: "YOUR_VIDEO_ID", videoType: .vod)) // for private video VideoOptions(videoId: "YOUR_VIDEO_ID", videoType: .vod, token: "YOUR_PRIVATE_VIDEO_TOKEN")
  1. 将播放器视图添加为视图控制器的一个子视图
override func viewDidLoad() {
    ...
    self.addSubview(playerView)
}
  1. 委派播放器事件

要使用播放器代表，您必须实现PlayerDelegate协议。

extension YourViewController: PlayerDelegate {
    public func didPrepare() {
        // Do what you want when didPrepare is called
    }

    public func didReady() {
        // Do what you want when didReady is called
    }

    public func didPause() {
        // Do what you want when didPause is called
    }

    public func didPlay() {
        // Do what you want when didPlay is called
    }

    public func didReplay() {
        // Do what you want when didReplay is called
    }

    public func didMute() {
        // Do what you want when didMute is called
    }

    public func didUnMute() {
        // Do what you want when didUnMute is called
    }

    public func didLoop() {
        // Do what you want when didLoop is called
    }

    public func didSetVolume(_: Float) {
        // Do what you want when didSetVolume is called
    }

    public func didSeek(_: CMTime, _: CMTime) {
        // Do what you want when didSeek is called
    }

    public func didEnd() {
        // Do what you want when didEnd is called
    }

    public func didError(_: Error) {
        // Do what you want when didError is called
    }

    public func didVideoSizeChanged(_: CGSize) {
        // Do what you want when didVideoSizeChanged is called
    }
}
  1. 注册代表
override func viewDidLoad() {
    ...
    self.playerView.addDelegate(self)
}
  1. 要使用全屏，您必须将视图控制器传递给播放器视图
override func viewDidAppear(_ animated: Bool) {
    ...
    playerView.viewController = self
}

遥控器

如果您想启用遥控器，请执行以下操作

override func viewDidLoad() {
    ...
    self.playerView.enableRemoteControl = true
}

当需要移除它时，设置enableRemoteControl为false

默认情况下，遥控器是隐藏的。

示例应用

一个示例应用程序展示了如何使用播放器。参看/example文件夹。

首次运行时，您需要设置您的视频ID

  1. 将“YOUR_VIDEO_ID”替换为您自己的视频ID

文档

依赖

我们正在使用外部库

插件 README
ApiVideoPlayerAnalytics README.md

常见问题解答

如果您有任何问题，请在此询问：[https://community.api.video] 或使用 [问题。