# VR-Player

**Repository Path**: zwgit/VR-Player

## Basic Information

- **Project Name**: VR-Player
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-09
- **Last Updated**: 2024-07-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# VrPlayer

<p align="center">
  <a href="https://flutter.wtf/">
    <img alt="What the Flutter" src="https://static.tildacdn.com/tild6330-3461-4139-a163-666435336663/Group_13.svg" height=140/>
  </a>
</p>

<p align="center">
  <h3 align="center">Crafted with passion by
    <a href="https://flutter.wtf/">
    What the Flutter
    </a> 🦜
  </h3>
</p>

<p align="center">
  <a href="https://pub.dev/packages/vr_player">
    <img alt="Pub" src="https://img.shields.io/pub/v/vr_player" />
  </a>
  <a href="https://github.com/What-the-Flutter/Vr-Player/actions/workflows/analyze.yml">
    <img alt="Build Status" src="https://github.com/What-the-Flutter/Vr-Player/actions/workflows/analyze.yml/badge.svg"/>
  </a>
  <a href="https://www.codefactor.io/repository/github/what-the-flutter/vr-player">
    <img alt="CodeFactor" src="https://www.codefactor.io/repository/github/what-the-flutter/vr-player/badge"/>
  </a>
</p>

---

## Getting Started

Based on Kaltura Playkit SDK:
  * [Android](https://github.com/kaltura/playkit-android)
  * [IOS](https://github.com/kaltura/playkit-ios)

The `VrPlayer` plugin lets you play 360° and VR videos smoothly on Android and iOS platforms, delivering an immersive viewing experience with touch and device motion controls. These types of videos, commonly referred to as immersive, 360, or spherical videos, are captured by utilizing an omnidirectional camera or multiple cameras to record the entire panoramic view simultaneously.
## Usage

```dart
VrPlayer(
  x: 0,
  y: 0,
  onCreated: onViewPlayerCreated,
  width: playerWidth,
  height: playerHeight,
),
```
You should implement `onViewPlayerCreated` to receive player events.

```dart
void onViewPlayerCreated(
  VrPlayerController controller,
  VrPlayerObserver observer,
) {
  _viewPlayerController = controller;
  observer
    ..onStateChange = onReceiveState
    ..onDurationChange = onReceiveDuration
    ..onPositionChange = onChangePosition
    ..onFinishedChange = onReceiveEnded;
  _viewPlayerController.loadVideo(
    videoUrl:
        'https://cdn.bitmovin.com/content/assets/playhouse-vr/m3u8s/105560.m3u8',
  );
}
```

### VrPlayerController

The `VrPlayerController` can be used to change the state of a `VrPlayer`. Note that the methods can only be used after the `VrPlayer` has been created.

 Method | Description 
--- | ---
`loadVideo({String? videoUrl, String? videoPath})` | Initializes video based on configuration. Invoke actions which need to be run on player start. Pass `videoPath` to load local files, or `videoUrl` to play files from network. *Local files supports only Android.*
`isPlaying()` | Check current player state.
`play()` | Play video.
`pause()` | Pause video.
`seekTo()` | Seek to position.
`setVolume()` | Set video volume level from 0 (no sound) to 1 (max).
`fullScreen()` | *(Android only)* Enable/disable fullscreen mode.  On IOS  you need to pass new width and height to VrPlayer widget
`toggleVRMode()` | Switch between 360° mode and VR mode. 
`onSizeChanged()` | *(Android only)* Reload player when you need to change size of nativeView.
`onPause()` | *(Android only)* Dispose player on pause.
`onResume()` | *(Android only)* Reload player.
`onOrientationChanged()` | *(Android only)* Notily player when orientation changed.

### Local Files Guide *(Android only)*

Working with video from storage is a bit difficult than from the Internet. Follow the instructions bellow to launch local files correctly.

1. Add `<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>` to the file `AndroidmManifest.xml`.
2. Request permission to read external storage from user.
3. Call `loadVideo()` with correct `videoPath`.


## License Information  

All code in this project is released under the [AGPLv3 license](https://www.gnu.org/licenses/agpl-3.0.html) unless a different license for a particular library is specified in the applicable library path.   

## Contribution

This repository welcomes contributions from the community! Whether you're looking to fix bugs, improve existing features, or add new ones, we would be happy to review and merge your contributions.