Skip to content

Commit dac0265

Browse files
committed
Added view getStartTime() and getEndTime() methods
1 parent dab5907 commit dac0265

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

doc/API.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ This document describes the Peaks.js API, including configuration options, funct
2828
- [instance.views.destroyZoomview()](#instanceviewsdestroyzoomview)
2929
- [instance.views.destroyOverview()](#instanceviewsdestroyoverview)
3030
- [View API](#view-api)
31+
3132
- [view.setAmplitudeScale()](#viewsetamplitudescalescale)
3233
- [view.setWaveformColor()](#viewsetwaveformcolorcolor)
3334
- [view.setPlayedWaveformColor()](#viewsetplayedwaveformcolorcolor)
@@ -1104,6 +1105,17 @@ view.setZoom({ seconds: 5.0 });
11041105
view.setZoom({ seconds: 'auto' });
11051106
```
11061107

1108+
### `view.getStartTime()`
1109+
1110+
Returns the start time, in seconds, of the overview or zoomable waveform view.
1111+
1112+
Note that the start time may not be exactly the same value you set when calling [`view.setStartTime()`](#viewsetstarttimetime). This is because the time is rounded to a number of pixels at the view's zoom level.
1113+
1114+
```js
1115+
const view = instance.views.getView('zoomview');
1116+
const startTime = view.getStartTime(); // seconds
1117+
```
1118+
11071119
### `view.setStartTime(time)`
11081120

11091121
Changes the start time, in seconds, of the zoomable waveform view.
@@ -1115,6 +1127,15 @@ const view = instance.views.getView('zoomview');
11151127
view.setStartTime(6.0); // seconds
11161128
```
11171129

1130+
### `view.getEndTime()`
1131+
1132+
Returns the end time, in seconds, of the overview or zoomable waveform view.
1133+
1134+
```js
1135+
const view = instance.views.getView('zoomview');
1136+
const endTime = view.getEndTime(); // seconds
1137+
```
1138+
11181139
### `view.scrollWaveform(options)`
11191140

11201141
Changes the start time of the zoomable waveform view, by the given amount.

peaks.js.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -496,6 +496,8 @@ declare module 'peaks.js' {
496496
}
497497

498498
interface WaveformView {
499+
getStartTime: () => number;
500+
getEndTime: () => number;
499501
setAmplitudeScale: (scale: number) => void;
500502
setWaveformColor: (color: WaveformColor) => void;
501503
setPlayedWaveformColor: (color: WaveformColor | null) => void;

0 commit comments

Comments
 (0)