GSPlayer

https://github.com/wxxsw/gsplayer
Admin
GSPlayer is a highly customizable and easy-to-use video player for iOS and macOS, featuring built-in...
Tokens:2,105
Snippets:10
Trust Score:9.2
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install GSPlayer via CocoaPods

Source: https://github.com/wxxsw/gsplayer/blob/master/README.md

Instructions for adding the GSPlayer library to your project using CocoaPods.

```ruby
pod 'GSPlayer'
```

--------------------------------

### Get and Clean Video Cache

Source: https://github.com/wxxsw/gsplayer/blob/master/README.md

Provides utility functions for managing the video cache, including calculating its total size and clearing all cached content.

```swift
VideoCacheManager.calculateCachedSize()
VideoCacheManager.cleanAllCache()
```

--------------------------------

### Play Video

Source: https://github.com/wxxsw/gsplayer/blob/master/README.md

Initiates video playback for a given URL using the VideoPlayerView.

```swift
playerView.play(for: someURL)
```

--------------------------------

### Configure Video Preloading

Source: https://github.com/wxxsw/gsplayer/blob/master/README.md

Allows setting video URLs for preloading and configuring the amount of data to preload.

```swift
VideoPreloadManager.shared.set(waiting: [URL])
VideoPlayer.preloadByteCount = 1024 * 1024 // = 1M
```

--------------------------------

### PlayerView Methods

Source: https://github.com/wxxsw/gsplayer/blob/master/README.md

Provides core methods for controlling video playback, including playing, pausing, and resuming.

```APIDOC
PlayerView Methods:

play(for url: URL)
  - Play a video of the specified url.

pause(reason: PausedReason)
  - Pause video.

resume()
  - Continue playing video.
```

--------------------------------

### Handle Player State Changes

Source: https://github.com/wxxsw/gsplayer/blob/master/README.md

Sets up a callback to receive updates on the player's state, allowing for dynamic UI adjustments.

```swift
playerView.stateDidChanged = { state in
    switch state {
    case .none:
        print("none")
    case .error(let error):
        print("error - (error.localizedDescription)")
    case .loading:
        print("loading")
    case .paused(let playing, let buffering):
        print("paused - progress (Int(playing * 100))% buffering (Int(buffering * 100))%")
    case .playing:
        print("playing")
    }
}
```

--------------------------------

### PlayerView Callbacks

Source: https://github.com/wxxsw/gsplayer/blob/master/README.md

Defines callbacks for significant playback events, such as state changes and replays.

```APIDOC
PlayerView Callbacks:

stateDidChanged: ((State) -> Void)?
  - Playback status changes, such as from play to pause.

replay: (() -> Void)?
  - Replay after playing to the end.
```

--------------------------------

### Add VideoPlayerView to View

Source: https://github.com/wxxsw/gsplayer/blob/master/README.md

Demonstrates how to add a VideoPlayerView instance to your application's view hierarchy, either programmatically or via Interface Builder.

```swift
let playerView = VideoPlayerView()
view.addSubview(playerView)

// Or in IB, specify the type of custom View as VideoPlayerView.
```

--------------------------------

### Pause and Resume Video

Source: https://github.com/wxxsw/gsplayer/blob/master/README.md

Provides methods to pause and resume video playback, with options to specify the reason for pausing.

```swift
if playerView.state == .playing {
    playerView.pause(reason: .userInteraction)
} else {
    playerView.resume()
}
```

--------------------------------

### PlayerView Properties

Source: https://github.com/wxxsw/gsplayer/blob/master/README.md

Exposes various properties of the PlayerView for accessing playback status, duration, volume, and mute settings.

```APIDOC
PlayerView Properties:

playerLayer: AVPlayerLayer { get }
  - An object that manages a player's visual output.

state: State { get }
  - Get current video status.
  - Possible states: .none, .loading, .playing, .paused(playing: Double, buffering: Double), .error(NSError).

pausedReason: PausedReason { get }
  - The reason the video was paused.
  - Possible reasons: .hidden, .userInteraction, .waitingKeepUp.

replayCount: Int { get }
  - Number of replays.

playing: Double { get }
  - Played progress, value range 0-1.

currentDuration: Double { get }
  - Played length in seconds.

buffering: Double { get }
  - Buffered progress, value range 0-1.

currentBufferDuration: Double { get }
  - Buffered length in seconds.

totalDuration: Double { get }
  - Total video duration in seconds.

watchDuration: Double { get }
  - The total watch time of this video, in seconds.

isMuted: Bool { get set }
  - Whether the video is muted, only for this instance.

volume: Double { get set }
  - Video volume, only for this instance.
```
Tokens:
Raw