{"id":1426,"url":"https://github.com/noreasonprojects/ModernAVPlayer","last_synced_at":"2025-08-06T13:32:44.156Z","repository":{"id":31700146,"uuid":"128545885","full_name":"noreasonprojects/ModernAVPlayer","owner":"noreasonprojects","description":"ModernAVPlayer is a persistence AVPlayer wrapper","archived":false,"fork":false,"pushed_at":"2022-10-06T03:32:27.000Z","size":53346,"stargazers_count":281,"open_issues_count":24,"forks_count":46,"subscribers_count":8,"default_branch":"develop","last_synced_at":"2024-07-24T17:49:10.234Z","etag":null,"topics":["audio","avaudiosession","avplayer","avplayeritem","cocoapods","persistence","pod","rxswift","spm","state-machine","swift","swiftpackagemanager","wrapper"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/noreasonprojects.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-07T16:14:11.000Z","updated_at":"2024-07-20T05:01:29.000Z","dependencies_parsed_at":"2022-09-20T11:24:35.468Z","dependency_job_id":null,"html_url":"https://github.com/noreasonprojects/ModernAVPlayer","commit_stats":null,"previous_names":["raphrel/modernavplayer"],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noreasonprojects%2FModernAVPlayer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noreasonprojects%2FModernAVPlayer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noreasonprojects%2FModernAVPlayer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noreasonprojects%2FModernAVPlayer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/noreasonprojects","download_url":"https://codeload.github.com/noreasonprojects/ModernAVPlayer/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":215780271,"owners_count":15929791,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["audio","avaudiosession","avplayer","avplayeritem","cocoapods","persistence","pod","rxswift","spm","state-machine","swift","swiftpackagemanager","wrapper"],"created_at":"2024-01-05T20:15:46.189Z","updated_at":"2024-08-17T16:30:39.873Z","avatar_url":"https://github.com/noreasonprojects.png","language":"Swift","funding_links":[],"categories":["Media","Libs","Video Players \u0026 Playback Libraries","HarmonyOS","Media and Graphics","Audio [🔝](#readme)"],"sub_categories":["Audio","Mobile Players","Windows Manager"],"readme":"# ModernAVPlayer\n![Swift 4.2](https://img.shields.io/badge/Swift-5-orange.svg)\n[![Build Status](https://travis-ci.org/noreasonprojects/ModernAVPlayer.svg?branch=develop)](https://travis-ci.com/noreasonprojects/ModernAVPlayer)\n![CocoaPods](https://img.shields.io/cocoapods/v/ModernAVPlayer.svg)\n![CocoaPods](https://img.shields.io/cocoapods/l/ModernAVPlayer.svg)\n\n``ModernAVPlayer`` is a persistence ``AVPlayer`` wrapper\n\n#### ++ Cool features ++\n- Get 9 nice and relevant player states (playing, buffering, loading, loaded...)\n- Persistence player to resume playback after bad network connection ~~even in background mode~~  (bug from version 1.5.1)\n- Manage headphone interactions, call \u0026 siri interruptions, now playing informations\n- Add your own plug-in to manage tracking, events...\n- RxSwift compatible\n- Loop mode\n- Log available by domain\n***\n\n### Known issue\nFrom version 1.5.1, resume playback from background mode failed. If you have any suggestion, please help. \n\n``Use of  mixWithOther AVAudiosession CategoryOptions is not a solution.``\n***\n\n## Menu\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Getting started](#getting-started)\n- [Advanced](#advanced)\n    - [Custom Configuration](#custom-configuration)\n    - [Remote Command](#remote-command)\n    - [Plugin](#plugin)\n    - [RxSwift](#rxswift)\n- [Communication](#communication)\n\n## Requirements\n\n- iOS 10.0+\n- tvOS 10.0+\n\n\u003e In order to support background mode, append the following to your ``Info.plist``:\n```\n\u003ckey\u003eUIBackgroundModes\u003c/key\u003e\n\u003carray\u003e\n    \u003cstring\u003eaudio\u003c/string\u003e\n\u003c/array\u003e\n```\n\n## Installation\n\n### Swift Package Manager\n\nSupported version: ``swift-tools-version:5.0``\n\n```swift\n// Package.swift\n\nimport PackageDescription\n\nlet package = Package(\n    name: \"Sample\",\n    dependencies: [\n        .package(url: \"https://github.com/noreasonprojects/ModernAVPlayer\", from: \"X.X.X\")\n    ],\n    targets: [\n        .target(name: \"Sample\", dependencies: [\"ModernAVPlayer\"])\n    ]\n)\n```\n\n### CocoaPods\n\n[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:\n\n```bash\n$ gem install cocoapods\n```\n\n\u003e CocoaPods 1.3+ is required to build ModernAVPlayer.\n\nTo integrate ``ModernAVPlayer`` into your Xcode project using CocoaPods, specify it in your `Podfile`:\n\n```ruby\nsource 'https://github.com/CocoaPods/Specs.git'\nplatform :ios, '10.0'\nuse_frameworks!\n\ntarget '\u003cYour Target Name\u003e' do\n    pod 'ModernAVPlayer'\nend\n```\n\nThen, run the following command:\n\n```bash\n$ pod install\n```\n\n## Getting started\n\n\u003e Create media from URL\n```swift\nlet media = ModernAVPlayerMedia(url: URL, type: MediaType)\n```\n\u003e Create media from AVPlayerItem\n```swift\nlet media = ModernAVPlayerMediaItem(item: AVPlayerItem, type: MediaType, metadata: PlayerMediaMetadata)\n```\n\n\u003e Instanciate the wrapper\n```swift\nlet player = ModernAVPlayer()\n```\n\u003e Load and play the media\n```swift\nplayer.load(media: media, autostart: true)\n```\n\u003e Track on repeat\n```swift\nplayer.loopMode = true\n```\n\n| ↓ State / Command → | loadMedia | play | pause | stop | seek |\n|:---------|:---------:|:--------:|:--------:|:--------:|:--------:|\n| Init  | O | X | O | O | X\n| Loading  | O | X | O | O | X\n| Loaded  | O | O | O | O | O\n| Buffering  | O | X | O | O | O\n| Playing  | O | X | O | O | O\n| Paused  | O | O | X | O | O\n| Stopped  | O | O | O | X | O\n| WaitingNetwork  | O | X | O | O | X\n| Failed  | O | O | X | X | X\n\n## Advanced \n\n### Custom configuration\n\nAll player configuration are available from `PlayerConfiguration` protocol.  \nA default implementation `ModernAVPlayerConfiguration` is provided with documentation\n\n---\n\n### Remote command\n\nIf using default configuration file ( `swift useDefaultRemoteCommand = true`), ModernAVPlayer use **automatically** all commands created by `ModernAVPlayerRemoteCommandFactory` class\nDocumention available in  `ModernAVPlayerRemoteCommandFactory.swift` file\n\n#### Custom command\n\n\u003e Use your own `PlayerConfiguration` implementation with \n```swift\n...\nuseDefaultRemoteCommand = false\n...\n```\n\n\u003e Create an array of  commands conforming to  `ModernAVPlayerRemoteCommand` protocol. \n```swift\nlet player = ModernAVPlayer(config: YourConfigImplementation())\nlet commands: [ModernAVPlayerRemoteCommand] = YourRemoteCommandFactory.commands\nplayer.remoteCommands = commands\n```\n\nYou can use existing commands from public `ModernAVPlayerRemoteCommandFactory` class.\n\n---\n\n### Plugin\n\nUse `PlayerPlugin` protocol to create your own plugin system, like tracking Plugin.\n\n---\n\n### RxSwift\n\nInstead of using delegate pattern, you can use rx to bind player attributes.\n\n\u003e Setup\n\nUse `pod 'ModernAVPlayer/RxSwift'` in the Podfile\n\n\u003e Usage\n```swift\nlet player = ModernAVPlayer()\nlet state: Observable\u003cModernAVPlayer.State\u003e = player.rx.state\n```\n\n## Communication\n\n- If you **found a bug**, make a pull request using `Simple Audio` template in the example section to demonstrate.\n- If you **have a feature request**, open an issue.\n- If you **want to contribute**, submit a pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoreasonprojects%2FModernAVPlayer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnoreasonprojects%2FModernAVPlayer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoreasonprojects%2FModernAVPlayer/lists"}