ModernAVPlayer
ModernAVPlayer is a persistence AVPlayer wrapper
++ Cool features ++
- Get 9 nice and relevant player states (playing, buffering, loading, loaded...)
- Persistence player to resume playback after bad network connection
even in background mode(bug from version 1.5.1) - Manage headphone interactions, call & siri interruptions, now playing informations
- Add your own plug-in to manage tracking, events...
- RxSwift compatible
- Loop mode
- Log available by domain
Known issue
From version 1.5.1, resume playback from background mode failed. If you have any suggestion, please help.
Use of mixWithOther AVAudiosession CategoryOptions is not a solution.
Menu
Requirements
- iOS 10.0+
- tvOS 10.0+
In order to support background mode, append the following to your
Info.plist:
UIBackgroundModes
audio
Installation
Swift Package Manager
Supported version: swift-tools-version:5.0
// Package.swift
import PackageDescription
let package = Package(
name: "Sample",
dependencies: [
.package(url: "https://github.com/noreasonprojects/ModernAVPlayer", from: "X.X.X")
],
targets: [
.target(name: "Sample", dependencies: ["ModernAVPlayer"])
]
)
CocoaPods
CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:
$ gem install cocoapods
CocoaPods 1.3+ is required to build ModernAVPlayer.
To integrate ModernAVPlayer into your Xcode project using CocoaPods, specify it in your Podfile:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!
target '' do
pod 'ModernAVPlayer'
end
Then, run the following command:
$ pod install
Getting started
Create media from URL
let media = ModernAVPlayerMedia(url: URL, type: MediaType)
Create media from AVPlayerItem
let media = ModernAVPlayerMediaItem(item: AVPlayerItem, type: MediaType, metadata: PlayerMediaMetadata)
Instanciate the wrapper
let player = ModernAVPlayer()
Load and play the media
player.load(media: media, autostart: true)
Track on repeat
player.loopMode = true
| ↓ State / Command → | loadMedia | play | pause | stop | seek |
|---|---|---|---|---|---|
| Init | O | X | O | O | X |
| Loading | O | X | O | O | X |
| Loaded | O | O | O | O | O |
| Buffering | O | X | O | O | O |
| Playing | O | X | O | O | O |
| Paused | O | O | X | O | O |
| Stopped | O | O | O | X | O |
| WaitingNetwork | O | X | O | O | X |
| Failed | O | O | X | X | X |
Advanced
Custom configuration
All player configuration are available from PlayerConfiguration protocol.
A default implementation ModernAVPlayerConfiguration is provided with documentation
Remote command
If using default configuration file ( swift useDefaultRemoteCommand = true), ModernAVPlayer use automatically all commands created by ModernAVPlayerRemoteCommandFactory class Documention available in ModernAVPlayerRemoteCommandFactory.swift file
Custom command
Use your own
PlayerConfigurationimplementation with
...
useDefaultRemoteCommand = false
...
Create an array of commands conforming to
ModernAVPlayerRemoteCommandprotocol.
let player = ModernAVPlayer(config: YourConfigImplementation())
let commands: [ModernAVPlayerRemoteCommand] = YourRemoteCommandFactory.commands
player.remoteCommands = commands
You can use existing commands from public ModernAVPlayerRemoteCommandFactory class.
Plugin
Use PlayerPlugin protocol to create your own plugin system, like tracking Plugin.
RxSwift
Instead of using delegate pattern, you can use rx to bind player attributes.
Setup
Use pod 'ModernAVPlayer/RxSwift' in the Podfile
Usage
let player = ModernAVPlayer()
let state: Observable = player.rx.state
Communication
- If you found a bug, make a pull request using
Simple Audiotemplate in the example section to demonstrate. - If you have a feature request, open an issue.
- If you want to contribute, submit a pull request.
2.6k Jan 8, 2023
2.1k Dec 29, 2022
280 May 11, 2022
16 Jun 2, 2022
676 Dec 25, 2022
1.8k Jan 4, 2023
131 Oct 25, 2022
148 Dec 18, 2022
0 Dec 15, 2021
270 Nov 23, 2022
13 Dec 21, 2022
23 Dec 29, 2022
167 Mar 13, 2022
149 Dec 15, 2022
620 Dec 3, 2022
4k Jan 8, 2023
22 Aug 15, 2022