BoxCast 0.5.3

BoxCast 0.5.3

×

测试已测试✓
语言语言 SwiftSwift
许可证 MIT
发布日期最新发布2020年12月
SPM支持 SPM✗

由 camdenfullmer 维护。

BoxCast 0.5.3

BoxCast SDK for Apple Platforms

Travis Status Image

官方 BoxCast SDK，用于在 Apple 平台上与 BoxCast API 集成。

功能

  • 列出直播和存档广播
  • 查看详细广播
  • 观看广播
  • 文档

要求

  • iOS 9.0+ | macOS 10.12+ | tvOS 9.0+
  • Xcode 11.0+
  • Swift 5.0+

安装

Cocoapods

CocoaPods 是 Cocoa 项目的依赖管理器。您可以使用以下命令安装它：

$ gem install cocoapods

要使用 CocoaPods 将 BoxCast SDK 集成到您的 Xcode 项目中，请在 Podfile 中指定它

platform :ios, '13.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'BoxCast', '~> 0.5'
end

然后，运行以下命令

$ pod install

Carthage

Carthage 是一个分布式的依赖管理器，用于构建您的依赖项并为您提供二进制框架。

  1. 使用以下命令通过 Homebrew 安装 Carthage：

    $ brew update
$ brew install carthage

  2. 编辑您的 Cartfile 以将 BoxCast 集成到您的 Xcode 项目中

    github "boxcast/boxcast-sdk-apple" ~> 0.5

  3. 运行 carthage update。这会将 BoxCast 拖入 Carthage/Checkouts 文件夹，并构建框架。

  4. 在您的应用程序目标的“常规”设置选项卡的“链接的框架和库”部分，从 Carthage/Build 文件夹拖放 BoxCast.framework。

  5. 在您的应用程序目标的“构建阶段”设置选项卡的“+”图标上单击，选择“新建运行脚本阶段”。创建一个运行脚本，在下面的脚本区域指定您的 shell（例如：/bin/sh），并将以下内容添加到 shell 以下的脚本区域

    /usr/local/bin/carthage copy-frameworks

    并在“输入文件”下添加您要使用的框架的路径，例如

    $(SRCROOT)/Carthage/Build/iOS/BoxCast.framework

用法

在开始之前，请确保获取您要获取广播的频道的 id。这可以在您的 BoxCast 控制台 中找到。

设置

在你的 AppDelegate 中，确保调用 BoxCastClient 上的 setUp 函数。这将为您创建一个 sharedClient，以便您使用。

import BoxCast

application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

    BoxCastClient.setUp()

    return true
}

访问资源

获取实时直播

import BoxCast

BoxCastClient.sharedClient?.getLiveBroadcasts(channelId: "YOUR_CHANNEL_ID") { broadcasts, error in
    if let broadcasts = broadcasts {
        // Do something special with the live broadcasts.
    } else {
        // Handle the error.
    }
}

获取存档直播

import BoxCast

BoxCastClient.sharedClient?.getArchivedBroadcasts(channelId: "YOUR_CHANNEL_ID") { broadcasts, error in
    if let broadcasts = broadcasts {
        // Do something special with the archived broadcasts.
    } else {
        // Handle the error.
    }
}

获取直播

import BoxCast

BoxCastClient.sharedClient?.getBroadcast(broadcastId: "BROADCAST_ID") { broadcast, error in
    if let broadcast = broadcast {
        // Do something special with the broadcast.
    } else {
        // Handle the error.
    }
}

获取直播预览

import BoxCast

BoxCastClient.sharedClient?.getBroadcastView(broadcastId: "BROADCAST_ID") { broadcastView, error in
    if let broadcastView = broadcastView {
        // Do something special with the broadcast view.
    } else {
        // Handle error.
    }
}

回放

在获取了详细的直播和预览后，您可以利用这两个资源来创建一个BoxCastPlayer对象。该对象是AVPlayer的一个简单子类，可以以类似的方式使用。

以下是一个创建播放器然后向其中呈现一个AVPlayerViewController实例的示例。

import BoxCast

let player = BoxCastPlayer(broadcast: broadcast, broadcastView: broadcastView)
let controller = AVPlayerViewController()
controller.player = player
present(controller, animated: true) {
    player?.play()
}

演示

本项目中包含一个演示应用，可以帮助您了解此 SDK 的使用方法。只需打开 BoxCast.xcodeproj，选择 演示 方案，然后运行它。

您的机器上必须安装 Carthage，否则项目无法构建。

文档

文档可在 此处 找到。

授权

BoxCast SDK 采用 MIT 授权发布。有关详细信息，请参阅 LICENSE。