api.video Swift Player
api.video is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.
Project description
Easily integrate a video player for videos from api.video in your Swift application.
Getting started
Installation
Swift Package Manager
In the Project Navigator select your own project. Then select the project in the Project section and click on the Package Dependencies tab. Click on the "+" button at the bottom. Paste the below url on the search bar on the top right. Finaly click on "Add package" button.
https://github.com/apivideo/api.video-swift-player
Or add this in your Package.swift
dependencies: [
.package(url: "https://github.com/apivideo/api.video-swift-player.git", from: "1.1.4"),
],
Cocoapods
Add pod 'ApiVideoPlayer', '1.1.4'
in your Podfile
Run pod install
Retrieve your video Id
At this point, you must have uploaded a least one video to your account. If you haven't see how to upload a video. You'll need a video Id to use this component and play a video from api.video. To get yours, follow these steps:
- Log into your account or create one here.
- Copy your API key (sandbox or production if you are subscribed to one of our plan).
- Go to the official api.video documentation.
- Go to API Reference -> Videos -> List all videos
- Create a
get
request to the/videos
endpoint based on the reference, using a tool like Postman. - Copy the "videoId" value of one of elements of the API response.
Alternatively, you can find your video Id in the video details of your dashboard.
Usage
- Imports the library
import ApiVideoPlayer
- Instantiates the player view
let playerView: ApiVideoPlayerView = ApiVideoPlayerView(frame: .zero, videoOptions: VideoOptions(videoId: , videoType: .vod)) // for private video VideoOptions(videoId: "YOUR_VIDEO_ID", videoType: .vod, token: "YOUR_PRIVATE_VIDEO_TOKEN")
- Adds the player view as a subview of your view controller
override
- Delegates the player events
To be able to use the player delegate, you must implement the PlayerDelegate protocol.
extension YourViewController: PlayerDelegate {
public
public
public
public
public
public
public
public
public
public
public
public
public
}
- Registers the delegate
override
- To use fullscreen, you must pass the view controller to the player view
override
Remote control
If you want to enable the remote control do the following:
override
When you have to remove it set enableRemoteControl
to false
By default the remote control is hidden.
Supported player views
The api.video Swift player comes with a specific view ApiVideoPlayerView
to display the video
and its controller. If you require a customization of this view such as changing a button color,...,
you can contact us.
Otherwise, in the ApiVideoPlayerController
, you can also use the following views:
AVPlayerViewController
: AVKit view
// Create the api.video controller
let controller = ApiVideoPlayerController(
videoOptions: VideoOptions(videoId: , videoType: .vod),
delegates: [],
autoplay: false
)
// Create the AVKit AVPlayerViewController
let viewController = AVPlayerViewController()
/// Pass the api.video controller to the AVKit AVPlayerViewController
viewController.setApiVideoPlayerController(controller)
// Prepare the view
self.addChild(viewController)
view.addSubview(viewController.view)
// Set the AVKit AVPlayerViewController frame size according to your needs (here it's the whole screen)
viewController.view.frame = self.view.frame
// Do what you want with the video controller (play, pause, seek,...)
controller.play()
AVPlayerLayer
. A view that only display the video. It requires more work to be used.
Play an api.video video in your AVPlayer
If you are using AVPlayer directly, you can use the api.video Swift extensions:
- Create a video
let videoOptions = VideoOptions(videoId: , videoType: .vod))
// for private video VideoOptions(videoId: "YOUR_VIDEO_ID", videoType: .vod, token: "YOUR_PRIVATE_VIDEO_TOKEN")
- Pass it to your AVPlayer
val player = AVPlayer() // You already have that in your code
avPlayer.replaceCurrentItem(withHls: videoOptions)
Sample application
A demo application demonstrates how to use player.
See /example
folder.
On the first run, you will have to set your video Id:
- Replace "YOUR_VIDEO_ID" by your video Id
Documentation
Dependencies
We are using external library
Plugin | README |
---|---|
ApiVideoPlayerAnalytics | README.md |
FAQ
If you have any questions, ask us here: https://community.api.video or use Issues.
Was this page helpful?