Skip to content

Commit

Permalink
chore: Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Arnaud de Mouhy committed Sep 22, 2020
1 parent 32b4d25 commit 00a5ab6
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,36 @@ Play radio streams in react-native
## Installation

```sh
npm install react-native-radio-player
yarn install react-native-radio-player
```

## Usage

```js
import RadioPlayer from "react-native-radio-player";
import RadioPlayer, {
RadioPlayerEvents,
RadioPlayerMetadata,
} from 'react-native-radio-player';

// ...

const result = await RadioPlayer.multiply(3, 7);
RadioPlayer.radioURL('https://...');
RadioPlayer.stop();
RadioPlayer.play();

// State: loading, loadingFinished
RadioPlayerEvents.addEventListener('stateDidChange', (event) => {
console.log(event.state);
});
// Playback State: playing, paused, stopped
RadioPlayerEvents.addEventListener('PlaybackStateDidChange', (event) => {
console.log(event.playbackState);
});
// Metadata: {"artistName": "Example Artist", "trackName": "Example Title"}
RadioPlayerEvents.addListener('MetadataDidChange', (metadata) => {
console.log(`Artist: ${metadata.artistName}`);
console.log(`Title: ${metadata.trackName}`);
});
```

## Contributing
Expand Down

0 comments on commit 00a5ab6

Please sign in to comment.