Skip to content

Commit

Permalink
core: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lucienbl committed Sep 15, 2019
1 parent a7afef6 commit e1a95ff
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ class App extends React.Component {
}

export default App;

```
Example app: https://github.com/lucienbl/react-native-vivox-demo
### Connect to the Vivox server
```javascript
Vivox.connect("server", "issuer", "realm"); // returns Promise<>
Expand All @@ -99,7 +99,7 @@ Vivox.leaveChannel(); // returns Promise<>
Vivox.disconnect(); // returns Promise<>
```

### Retrieve the current state int
### Retrieve the current state integer
```javascript
Vivox.getState(); // returns Promise<number>
```
Expand All @@ -108,3 +108,13 @@ Vivox.getState(); // returns Promise<number>
```javascript
Vivox.getStateName(); // returns Promise<string>
```

### Mute the current player
```javascript
Vivox.muteMyself(true); // returns Promise<>
```

### Retrieve if the current player is muted or not
```javascript
Vivox.isMuted(); // returns Promise<boolean>
```

0 comments on commit e1a95ff

Please sign in to comment.