api.video-ios-player-analytics

api.video iOS 播放器分析模块

api.video 是构建产品的视频基础设施。轻轻松松的视频 API，用于集成、扩展和管理在您的应用中按需和低延迟实时流功能。

目录

• 目录
• 项目描述
• 入门指南
  • 安装
    • Swift 包管理器
    • CocoaPods
• 示例应用程序
• 文档
  • 选项
  • 播放器分析 API
    • play(completion: @escaping (Result) -> Void)
    • resume(completion: @escaping (Result) -> Void)
    • ready(completion: @escaping (Result) -> Void)
    • end(completion: @escaping (Result) -> Void)
    • seek(from:Float, to: Float, completion : @escaping (Result) -> Void)
    • pause(completion: @escaping (Result) -> Void)
    • destroy(completion: @escaping (Result) -> Void)
    • currentTime

项目描述

iOS 库，用于手动调用 api.video 分析收集器。

如果您正在使用我们没有提供现成监控模块的视频播放器，这将很有用。

入门指南

安装

Swift 包管理器

在项目导航器中选择您自己的项目。然后选择项目部分中的项目，并点击“包依赖关系”标签。在底部点击“+”按钮。将以下 URL 粘贴到右上角的搜索栏中。最终点击“添加包”按钮。

 https://github.com/apivideo/api.video-ios-player-analytics

或者在您的 Package.swift 中添加此内容

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

CocoaPods

在您的 Podfile 中添加 pod 'ApiVideoPlayerAnalytics', '1.1.1'

运行 pod install

示例应用程序

一个演示应用程序展示了如何使用玩家分析库。查看 /Example 文件夹。

文档

选项

分析模块构造函数接受一个 Options 参数，其中包含以下选项：

通过mediaUrl或videoInfo创建Options实例。

模块实例化后，必须调用以下方法来监控播放事件。

播放器分析 API

play(completion: @escaping (Result) -> Void)

视频第一次开始播放时应调用的方法（如果是在暂停后恢复，请使用resume()）

resume(completion: @escaping (Result) -> Void)

在暂停后恢复视频播放时应调用的方法

ready(completion: @escaping (Result) -> Void)

播放器准备播放媒体时应调用的方法

end(completion: @escaping (Result) -> Void)

视频结束时调用的方法

seek(from:Float, to: Float, completion : @escaping (Result) -> Void)

发生seek事件时调用的方法，必须包含from和to参数，它们应该包含以秒为单位开始和结束时间

pause(completion: @escaping (Result) -> Void)

视频暂停时调用的方法

destroy(completion: @escaping (Result) -> Void)

视频玩家销毁时调用（例如，当用户关闭导航标签）时调用的方法

currentTime

每次播放时间变化时调用（应该经常调用，收集数据的准确性取决于此）