https://github.com/apivideo/api.video-reactnative-player
React Native video player
https://github.com/apivideo/api.video-reactnative-player
player react-native video video-player
Last synced: 10 months ago
JSON representation
React Native video player
- Host: GitHub
- URL: https://github.com/apivideo/api.video-reactnative-player
- Owner: apivideo
- License: mit
- Created: 2021-05-31T07:36:16.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T12:38:11.000Z (over 1 year ago)
- Last Synced: 2025-03-23T19:44:41.930Z (over 1 year ago)
- Topics: player, react-native, video, video-player
- Language: TypeScript
- Homepage: https://api.video
- Size: 1.87 MB
- Stars: 17
- Watchers: 2
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://twitter.com/intent/follow?screen_name=api_video) [](https://github.com/apivideo/api.video-reactnative-player) [](https://community.api.video)
 
api.video React Native video player
[api.video](https://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.
## Table of contents
- [Table of contents](#table-of-contents)
- [Project description](#project-description)
- [Getting started](#getting-started)
- [Installation](#installation)
- [Limitations](#limitations)
- [Code sample](#code-sample)
- [Documentation](#documentation)
- [Props & Methods](#props--methods)
- [Using methods](#using-methods)
- [FAQ](#faq)
## Project description
React Native video player to play vod and lives from api.video
## Getting started
### Installation
```sh
npm install @api.video/react-native-player
```
or
```sh
yarn add @api.video/react-native-player
```
_Note: if you are on iOS, you will need this extra step:_
Install the native dependencies with Cocoapods
```sh
cd ios && pod install
```
### Limitations
For the moment, this player component is based on the api.video's javascript player (displayed in a [react-native-webview](https://github.com/react-native-webview/react-native-webview)), and therefore it suffers from the same limitation as every players displayed in browsers.
We plan to base the player component on natives video players in a further release to avoid this kind of limitation. Stay tuned!
### Code sample
```jsx
import React from 'react';
import ApiVideoPlayer from '@api.video/react-native-player';
const App = () =>
export default App;
```
## Documentation
### Props & Methods
```ts
// props:
type PlayerProps = {
// the id of the video (required)
videoId: string;
// if the video is private, the private token of the video
privateToken?: string;
// if the video is private, the session token for the video (avh)
sessionToken?: string;
// whether the video is vod or live (default is 'vod')
type?: 'vod' | 'live';
// the controls are hidden (default false)
hideControls?: boolean;
// the video title is hidden (default false)
hideTitle?: boolean;
// start playing the video as soon as it is loaded (default false)
autoplay?: boolean;
// once the video is finished it automatically starts again (default false)
loop?: boolean;
// the video is muted (default false)
muted?: boolean;
// style to apply to the player component
style?: StyleProp;
onControlsDisabled?: () => void;
onControlsEnabled?: () => void;
onEnded?: () => void;
onError?: () => void;
onFirstPlay?: () => void;
onFullScreenChange?: (isFullScreen: boolean) => void;
onPause?: () => void;
onPlay?: () => void;
onPlayerResize?: () => void;
onQualityChange?: (resolution: { height: number, width: number }) => void;
onRateChange?: () => void;
onReady?: () => void;
onResize?: () => void;
onSeeking?: () => void;
onTimeUpdate?: ( currentTime: number ) => void;
onUserActive?: () => void;
onUserInactive?: () => void;
onVolumeChange?: ( volume: number ) => void;
}
// methods:
play(): void;
pause(): void;
requestFullscreen(): void;
seek(time: number): void;
setCurrentTime(time: number): void;
setPlaybackRate(rate: number): void;
setVolume(volume: number): void;
```
### Using methods
```jsx
import React, { Component } from 'react';
import ApiVideoPlayer from '@api.video/react-native-player';
import { Button, View } from 'react-native';
export default class App extends Component {
render() {
return (
(this.player = r)}
muted={true}
videoId="vi2G6Qr8ZVE67dWLNymk7qbc" />
this.player.play()} title="Play" />
this.player.pause()} title="Pause" />
)
}
}
```
## FAQ
If you have any questions, ask us here: https://community.api.video .
Or use [Issues].
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)
[Issues]: