Skip to content

fix: align AudioParam scheduling methods with spec #773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: align AudioParam scheduling methods with spec #773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions packages/audiodocs/docs/core/audio-param.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ as they are more efficient for continuous changes. For more specific use cases,
| Parameter | Type | Description |
| :---: | :---: | :---- |
| `value` | `number` | A float representing the value the `AudioParam` will be set at given time |
| `startTime` | `number` | The time, in seconds, at which the change in value is going to happen. |
| `startTime` | `number` | The time, in seconds, at which the change in value is going to happen. If it's smaller than [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties), it will be clamped to [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties). |

#### Errors:

Expand All @@ -61,7 +61,7 @@ The change begins at the time designated for the previous event. It follows a li
| Parameter | Type | Description |
| :---: | :---: | :---- |
| `value` | `number` | A float representing the value, the `AudioParam` will ramp to by given time. |
| `endTime` | `number` | The time, in seconds, at which the value ramp will end. |
| `endTime` | `number` | The time, in seconds, at which the value ramp will end. If it's smaller than [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties), it will be clamped to [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties). |

#### Errors

Expand All @@ -81,7 +81,7 @@ The change begins at the time designated for the previous event. It follows an e
| Parameter | Type | Description |
| :---: | :---: | :---- |
| `value` | `number` | A float representing the value the `AudioParam` will ramp to by given time. |
| `endTime` | `number` | The time, in seconds, at which the value ramp will end. |
| `endTime` | `number` | The time, in seconds, at which the value ramp will end. If it's smaller than [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties), it will be clamped to [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties).|

#### Errors

Expand All @@ -101,7 +101,7 @@ This method is useful for decay or release portions of [ADSR envelopes](/docs/ef
| Parameter | Type | Description |
| :---: | :---: | :---- |
| `target` | `number` | A float representing the value to which the `AudioParam` will start transitioning. |
| `startTime` | `number` | The time, in seconds, at which exponential transition will begin. |
| `startTime` | `number` | The time, in seconds, at which exponential transition will begin. If it's smaller than [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties), it will be clamped to [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties). |
| `timeConstant` | `number` | A double representing the time-constant value of an exponential approach to the `target`. |

#### Errors
Expand All @@ -122,7 +122,7 @@ Schedules the parameters's value change following a curve defined by given array
| Parameter | Type | Description |
| :---: | :---: | :---- |
| `values` | `Float32Array` | The array of values defining a curve, which change will follow. |
| `startTime` | `number` | The time, in seconds, at which change will begin. |
| `startTime` | `number` | The time, in seconds, at which change will begin. If it's smaller than [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties), it will be clamped to [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties). |
| `duration` | `number` | A double representing total time over which the change will happen. |

#### Errors
Expand All @@ -139,7 +139,7 @@ Cancels all scheduled changes after given cancel time.

| Parameter | Type | Description |
| :---: | :---: | :---- |
| `cancelTime` | `number` | The time, in seconds, after which all scheduled changes will be cancelled. |
| `cancelTime` | `number` | The time, in seconds, after which all scheduled changes will be cancelled. If it's smaller than [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties), it will be clamped to [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties). |

#### Errors

Expand All @@ -155,7 +155,7 @@ Cancels all scheduled changes after given cancel time, but holds its value at gi

| Parameter | Type | Description |
| :---: | :---: | :---- |
| `cancelTime` | `number` | The time, in seconds, after which all scheduled changes will be cancelled. |
| `cancelTime` | `number` | The time, in seconds, after which all scheduled changes will be cancelled. If it's smaller than [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties), it will be clamped to [`currentTime`](https://docs.swmansion.com/react-native-audio-api/docs/core/base-audio-context#properties).|

#### Errors

Expand Down
29 changes: 18 additions & 11 deletions packages/react-native-audio-api/src/core/AudioParam.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ export default class AudioParam {
);
}

this.audioParam.setValueAtTime(value, startTime);
const clampedTime = Math.max(startTime, this.context.currentTime);
this.audioParam.setValueAtTime(value, clampedTime);

return this;
}
Expand All @@ -45,7 +46,8 @@ export default class AudioParam {
);
}

this.audioParam.linearRampToValueAtTime(value, endTime);
const clampedTime = Math.max(endTime, this.context.currentTime);
this.audioParam.linearRampToValueAtTime(value, clampedTime);

return this;
}
Expand All @@ -54,13 +56,14 @@ export default class AudioParam {
value: number,
endTime: number
): AudioParam {
if (endTime < 0) {
if (endTime <= 0) {
throw new RangeError(
`endTime must be a finite non-negative number: ${endTime}`
);
}

this.audioParam.exponentialRampToValueAtTime(value, endTime);
const clampedTime = Math.max(endTime, this.context.currentTime);
this.audioParam.exponentialRampToValueAtTime(value, clampedTime);

return this;
}
Expand All @@ -78,11 +81,12 @@ export default class AudioParam {

if (timeConstant < 0) {
throw new RangeError(
`timeConstant must be a finite non-negative number: ${startTime}`
`timeConstant must be a finite non-negative number: ${timeConstant}`
);
}

this.audioParam.setTargetAtTime(target, startTime, timeConstant);
const clampedTime = Math.max(startTime, this.context.currentTime);
this.audioParam.setTargetAtTime(target, clampedTime, timeConstant);

return this;
}
Expand All @@ -98,17 +102,18 @@ export default class AudioParam {
);
}

if (duration < 0) {
if (duration <= 0) {
throw new RangeError(
`duration must be a finite non-negative number: ${startTime}`
`duration must be a finite strictly-positive number: ${duration}`
);
}

if (values.length < 2) {
throw new InvalidStateError(`values must contain at least two values`);
}

this.audioParam.setValueCurveAtTime(values, startTime, duration);
const clampedTime = Math.max(startTime, this.context.currentTime);
this.audioParam.setValueCurveAtTime(values, clampedTime, duration);

return this;
}
Expand All @@ -120,7 +125,8 @@ export default class AudioParam {
);
}

this.audioParam.cancelScheduledValues(cancelTime);
const clampedTime = Math.max(cancelTime, this.context.currentTime);
this.audioParam.cancelScheduledValues(clampedTime);

return this;
}
Expand All @@ -132,7 +138,8 @@ export default class AudioParam {
);
}

this.audioParam.cancelAndHoldAtTime(cancelTime);
const clampedTime = Math.max(cancelTime, this.context.currentTime);
this.audioParam.cancelAndHoldAtTime(clampedTime);

return this;
}
Expand Down