You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| mode\*| - | ✅ | ✅ | 'live' or 'static' | Type of waveform. It can be either `static` for the resource file or `live` if you want to record audio |
133
-
| ref\*| - | ✅ | ✅ | IWaveformRef | Type of ref provided to waveform component. If waveform mode is `static`, some methods from ref will throw error and same for `live`.<br> Check [IWaveformRef](#iwaveformref-methods) for more details about which methods these refs provides. |
134
-
| path\*| - | ✅ | ❌ | string | Used for `static` type. It is the resource path of an audio source file. |
135
-
| playbackSpeed | 1.0 | ✅ | ❌ | 1.0 / 1.5 / 2.0 | The playback speed of the audio player. Note: Currently playback speed only supports, Normal (1x) Faster(1.5x) and Fastest(2.0x), any value passed to playback speed greater than 2.0 will be automatically adjusted to normal playback speed |
136
-
| candleSpace | 2 | ✅ | ✅ | number | Space between two candlesticks of waveform |
137
-
| candleWidth | 5 | ✅ | ✅ | number | Width of single candlestick of waveform |
138
-
| candleHeightScale | 3 | ✅ | ✅ | number | Scaling height of candlestick of waveform |
139
-
| maxCandlesToRender | 300 | ❌ | ✅ | number | Number of candlestick in waveform |
140
-
| containerStyle | - | ✅ | ✅ |`StyleProp<ViewStyle>`| style of the container |
141
-
| waveColor |#545454| ✅ | ✅ | string | color of candlestick of waveform |
142
-
| scrubColor | #7b7b7b | ✅ | ❌ | string | color of candlestick of waveform which has played |
143
-
| onPlayerStateChange | - | ✅ | ❌ | ( playerState : PlayerState ) => void | callback function, which returns player state whenever player state changes. |
144
-
| onPanStateChange | - | ✅ | ❌ | ( panMoving : boolean ) => void | callback function which returns boolean indicating whether audio seeking is active or not. |
145
-
| onRecorderStateChange | - | ❌ | ✅ | ( recorderState : RecorderState ) => void | callback function which returns the recorder state whenever the recorder state changes. Check RecorderState for more details |
146
-
| onCurrentProgressChange | - | ✅ | ❌ | ( currentProgress : number, songDuration: number ) => void | callback function, which returns current progress of audio and total song duration. |
147
-
| onChangeWaveformLoadState | - | ✅ | ❌ | ( state : boolean ) => void | callback function which returns the loading state of waveform candlestick. |
148
-
| onError | - | ✅ | ❌ | ( error : Error ) => void | callback function which returns the error for static audio waveform |
| mode\*| - | ✅ | ✅ | 'live' or 'static' | Type of waveform. It can be either `static` for the resource file or `live` if you want to record audio |
133
+
| ref\*| - | ✅ | ✅ | IWaveformRef | Type of ref provided to waveform component. If waveform mode is `static`, some methods from ref will throw error and same for `live`.<br> Check [IWaveformRef](#iwaveformref-methods) for more details about which methods these refs provides. |
134
+
| path\*| - | ✅ | ❌ | string | Used for `static` type. It is the resource path of an audio source file. |
135
+
| playbackSpeed | 1.0 | ✅ | ❌ | 1.0 / 1.5 / 2.0 | The playback speed of the audio player. Note: Currently playback speed only supports, Normal (1x) Faster(1.5x) and Fastest(2.0x), any value passed to playback speed greater than 2.0 will be automatically adjusted to normal playback speed |
136
+
| candleSpace | 2 | ✅ | ✅ | number | Space between two candlesticks of waveform |
137
+
| candleWidth | 5 | ✅ | ✅ | number | Width of single candlestick of waveform |
138
+
| candleHeightScale | 3 | ✅ | ✅ | number | Scaling height of candlestick of waveform |
139
+
| maxCandlesToRender | 300 | ❌ | ✅ | number | Number of candlestick in waveform |
140
+
| containerStyle | - | ✅ | ✅ |`StyleProp<ViewStyle>`| style of the container |
141
+
| waveColor |#545454| ✅ | ✅ | string | color of candlestick of waveform |
142
+
| scrubColor | #7b7b7b | ✅ | ❌ | string | color of candlestick of waveform which has played |
143
+
| onPlayerStateChange | - | ✅ | ❌ | ( playerState : PlayerState ) => void | callback function, which returns player state whenever player state changes. |
144
+
| onPanStateChange | - | ✅ | ❌ | ( panMoving : boolean ) => void | callback function which returns boolean indicating whether audio seeking is active or not. |
145
+
| onRecorderStateChange | - | ❌ | ✅ | ( recorderState : RecorderState ) => void | callback function which returns the recorder state whenever the recorder state changes. Check RecorderState for more details |
146
+
| onCurrentProgressChange | - | ✅ | ❌ | ( currentProgress : number, songDuration: number ) => void | callback function, which returns current progress of audio and total song duration. |
147
+
| onChangeWaveformLoadState | - | ✅ | ❌ | ( state : boolean ) => void | callback function which returns the loading state of waveform candlestick. |
148
+
| onError | - | ✅ | ❌ | ( error : Error ) => void | callback function which returns the error for static audio waveform |
149
+
| showsHorizontalScrollIndicator | false | ❌ | ✅ | boolean | whether to show scroll indicator when live waveform is being recorded and total width is more than parent view width |
149
150
150
151
##### Know more about [ViewStyle](https://reactnative.dev/docs/view-style-props), [PlayerState](#playerstate), and [RecorderState](#recorderstate)
0 commit comments