Skip to content

Commit 179b99a

Browse files
authored
Update README.md
1 parent 3bae639 commit 179b99a

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,12 @@ you can find demo here: https://github.com/oney/RCTWebRTCDemo
2020

2121
## Installation:
2222

23-
old versions (RN < 0.40) please use version `1.5.4`
23+
24+
#### BREAKING NOTE:
25+
26+
for old RN versions (RN < 0.40) please use version `1.5.4`
27+
28+
2429
**from npm package**: `npm install react-native-incall-manager`
2530
**from git package**: `npm install git://github.com/zxcpoiu/react-native-incall-manager.git`
2631

@@ -251,6 +256,9 @@ note: ios only supports `auto` currently.
251256
| async checkRecordPermission() | :smile: | :smile: | check record permission without promt. return Promise. see **about permission** section above |
252257
| async requestRecordPermission() | :smile: | :smile: | request record permission to user. return Promise. see **about permission** section above |
253258
| async getAudioUriJS() | :smile: | :smile: | get audio Uri path. this would be useful when you want to pass Uri into another module. |
259+
| startRingtone(`ringtone: string, ?vibrate_pattern: array, ?ios_category: string, ?seconds: number`) | :smile: | :smile: | play ringtone. </br>`ringtone`: '_DEFAULT_' or '_BUNDLE_'</br>`vibrate_pattern`: same as RN, but does not support repeat</br>`ios_category`: ios only, if you want to use specific audio category</br>`seconds`: android only, specify how long do you want to play rather than play once nor repeat. in sec.|
260+
| stopRingtone() | :smile: | :smile: | stop play ringtone if previous started via `startRingtone()` |
261+
| stopRingback() | :smile: | :smile: | stop play ringback if previous started via `start()` |
254262

255263
**Events**
256264

0 commit comments

Comments
 (0)