https://github.com/aws/amazon-ivs-react-native-player

A React Native wrapper for the Amazon IVS iOS and Android player SDKs.
https://github.com/aws/amazon-ivs-react-native-player

amazon-ivs react-native

Last synced: about 1 month ago
JSON representation

A React Native wrapper for the Amazon IVS iOS and Android player SDKs.

• Host: GitHub
• URL: https://github.com/aws/amazon-ivs-react-native-player
• Owner: aws
• License: apache-2.0
• Created: 2021-08-17T19:48:45.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-08T21:22:37.000Z (4 months ago)
• Last Synced: 2024-10-07T03:33:26.377Z (about 1 month ago)
• Topics: amazon-ivs, react-native
• Language: TypeScript
• Homepage:
• Size: 2.88 MB
• Stars: 297
• Watchers: 31
• Forks: 31
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Amazon IVS React Native Player

This package implements native binding for Amazon IVS Player for iOS and Android.

## Installation

- install `amazon-ivs-react-native-player` dependency using yarn or npm

```sh

npm install amazon-ivs-react-native-player

```

- install pods for your ios project. Go to `ios` directory and run

```sh

pod install

```

## Usage

```tsx

import IVSPlayer from 'amazon-ivs-react-native-player';

const URL =

  'https://fcc3ddae59ed.us-west-2.playback.live-video.net/api/video/v1/us-west-2.893648527354.channel.DmumNckWFTqz.m3u8';

function App() {

  return ;

}

```

A more detailed guide about usage can be found [here](./docs/usage-guide.md)

## IVSPlayer component

`IVSPlayer` is a component that can render a video stream based on the passed URL.

- [Props documentation](./docs/ivs-player-reference.md#props)

- [Ref methods documentation](./docs/ivs-player-reference.md#ref-methods)

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## Troubleshooting

To hide Home Indicator on iOS when video is in full screen, use this library:

https://github.com/flowkey/react-native-home-indicator

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

## License

This project is licensed under the Apache-2.0 License.