UizaSDK
(下拉以阅读越南语)
UizaSDK 是一个连接到 Uiza 系统的框架
兼容性
UizaSDK 需要 Swift 4.0+ 和 iOS 8+
安装
CocoaPods
要使用 CocoaPods 将 UizaSDK 整合到您的 Xcode 项目中,在您的 Podfile
中指定它:
pod 'UizaSDK'
然后,运行以下命令:
$ pod install
使用
框架初始化
在调用任何API函数之前,请始终使用以下行初始化框架
import UizaSDK
UizaSDK.initWith(appId: YOUR_APP_ID, token: TOKEN, api: YOUR_DOMAIN, version: API_VERSION)
YOUR_APP_ID和YOUR_DOMAIN:从注册电子邮件中获取
TOKEN:从https://docs.uiza.io/#get-api-key生成
API_VERSION:目标API的版本,设置为.v3或.v4(默认为.v3)
调用API
UZContentServices().loadDetail(entityId: ENTITY_ID, completionBlock: { (videoItem, error) in
if error != nil {
print("Error: \(error)")
}
else {
print("Video: \(videoItem)")
}
})
如何播放视频
let playerViewController = UZPlayerViewController()
playerViewController.player.loadVideo(entityId: ENTITY_ID)
present(playerViewController, animated: true, completion: nil)
你可能需要在Info.plist
中添加这些行来禁用App Transport Security (ATS)以能够播放视频
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key><true/>
</dict>
如何直播
let viewController = UZLiveStreamViewController()
viewController.liveEventId = ENTITY_ID
self.present(viewController, animated: true, completion: nil)
请记住向Info.plist
文件中添加这些使用描述键
<key>NSCameraUsageDescription</key>
<string>App needs access to camera for livestream</string>
<key>NSMicrophoneUsageDescription</key>
<string>App needs access to microphone for livestream</string>
更改播放器主题
let playerViewController = UZPlayerViewController()
playerViewController.player.theme = UZTheme1()
UizaPlayer当前有7种内置主题
创建自定义主题
你可以通过创建一个继承自UZPlayerTheme协议的类来创建自己的自定义主题,按照以下模板: UZCustomTheme
你还可以通过继承UZEndscreenView
来创建自己的自定义结束屏幕,然后将一个实例设置为player.controlView.endscreenView
self.playerViewController.player.controlView.endscreenView = MyCustomEndScreen()
创建具有悬浮模式的玩家
您可以通过继承UZFloatingPlayerViewController来创建“拖动到悬浮模式”的玩家,就像Facebook或Youtube一样,然后您可以添加更多UI来显示视频细节并将它们添加到detailsContainerView
然后使用以下代码进行展示
UZFloatingPlayerViewController().present(with: videoItem, playlist: playlist)
请参考示例
有关API的详细信息,请检查API文档
Google ChromeCast支持
如果使用Xcode 10开发并针对运行iOS 12或更高版本iOS设备的设备,则需要“访问WiFi信息”功能以便发现和连接到Cast设备
支持
许可
UizaSDK在BSD许可下发布。有关详细信息,请参阅LICENSE
UizaSDK
UizaSDK是支持连接到Uiza系统API的Framework
相容
UizaSDK 要求 Swift 4.0_ 和 iOS 8+
安装
CocoaPods
通过 CocoaPods 安装
在 Podfile
中添加以下行
pod 'UizaSDK'
然后运行这个命令
$ pod install
使用方法
初始化
在使用任何函数API之前,请先启动该框架,使用以下命令:
import UizaSDK
UizaSDK.initWith(appId: YOUR_APP_ID, token: TOKEN, api: YOUR_DOMAIN, version: API_VERSION)
YOUR_APP_ID 和 YOUR_DOMAIN : 从注册邮件的详细信息中获取
TOKEN: 从https://docs.uiza.io/#get-api-key 页面生成的令牌
API_VERSION: 使用的API版本,传输 .v3 或 .v4(如果没有传输,默认为 .v3)
调用 API 函数
UZContentServices().loadDetail(entityId: ENTITY_ID, completionBlock: { (videoItem, error) in
if error != nil {
print("Error: \(error)")
}
else {
print("Video: \(videoItem)")
}
})
播放视频的方法
let playerViewController = UZPlayerViewController()
playerViewController.player.loadVideo(entityId: ENTITY_ID)
present(playerViewController, animated: true, completion: nil)
如果遇到由于App Transport Security (ATS)问题导致的无法播放视频,您必须在Info.plist
文件中添加以下行才能播放视频:
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key><true/>
</dict>
发布直播的方法
let viewController = UZLiveStreamViewController()
viewController.liveEventId = [ENTITY_ID]
self.present(viewController, animated: true, completion: nil)
记得在Info.plist
文件中添加访问相机和麦克风的描述要求。
<key>NSCameraUsageDescription</key>
<string>App cần truy cập camera để phát livestream</string>
<key>NSMicrophoneUsageDescription</key>
<string>App cần truy cập micro để thu tiếng khi phát livestream</string>
更改界面
let playerViewController = UZPlayerViewController()
playerViewController.player.theme = UZTheme1()
UizaPlayer提供了以下7种预定义界面:
自定义界面(CustomTheme)
您可以通过创建继承自UZPlayerTheme协议的类来自定义界面,根据以下示例代码: UZCustomTheme
您还可以通过创建继承自UZEndscreenView
的类来更改结束屏幕的界面,然后将它设置到player.controlView.endscreenView
中。
self.playerViewController.player.controlView.endscreenView = MyCustomEndScreen()
使用浮动模式创建Player
您可以通过创建类继承自UZFloatingPlayerViewController来创建具有“拖动至屏幕角落”功能的Player,类似于Facebook或YouTube,您可以在其中添加视频的详细UI并将其放入detailsContainerView
之后使用以下命令呈现
UZFloatingPlayerViewController().present(with: videoItem, playlist: playlist)
参考示例
谷歌Chromecast支持
如果您使用Xcode 10并且为iOS 12及以上版本开发,需要打开“访问WiFi信息”,才能使搜索新的Cast设备的功能正常工作
查看详情 API文档