openrv-web / AudioAPI
Class: AudioAPI
Defined in: api/AudioAPI.ts:11
Extends
DisposableAPI
Constructors
Constructor
new AudioAPI(
session):AudioAPI
Defined in: api/AudioAPI.ts:14
Parameters
session
Session
Returns
AudioAPI
Overrides
DisposableAPI.constructor
Methods
disableAudioScrub()
disableAudioScrub():
void
Defined in: api/AudioAPI.ts:167
Disable audio scrubbing (silent frame stepping/timeline drag).
Returns
void
Example
openrv.audio.disableAudioScrub();dispose()
dispose():
void
Defined in: api/Disposable.ts:19
Mark this sub-API as disposed. After this call, assertNotDisposed() will throw on every subsequent invocation.
Returns
void
Inherited from
DisposableAPI.dispose
enableAudioScrub()
enableAudioScrub():
void
Defined in: api/AudioAPI.ts:154
Enable audio scrubbing (play audio snippets during frame stepping/timeline drag).
Returns
void
Example
openrv.audio.enableAudioScrub();getPreservesPitch()
getPreservesPitch():
boolean
Defined in: api/AudioAPI.ts:141
Check if pitch correction is enabled.
Returns
boolean
true if pitch is preserved during speed changes, false otherwise.
Example
const preserved = openrv.audio.getPreservesPitch();getVolume()
getVolume():
number
Defined in: api/AudioAPI.ts:51
Get the current audio volume level.
Returns
number
The current volume as a number between 0.0 and 1.0.
Example
const vol = openrv.audio.getVolume();isAudioScrubEnabled()
isAudioScrubEnabled():
boolean
Defined in: api/AudioAPI.ts:182
Check if audio scrubbing is enabled.
Returns
boolean
true if audio scrub is enabled, false otherwise.
Example
const scrubbing = openrv.audio.isAudioScrubEnabled();isMuted()
isMuted():
boolean
Defined in: api/AudioAPI.ts:92
Check if audio is currently muted.
Returns
boolean
true if muted, false otherwise.
Example
if (openrv.audio.isMuted()) { openrv.audio.unmute(); }mute()
mute():
void
Defined in: api/AudioAPI.ts:64
Mute audio output.
Returns
void
Example
openrv.audio.mute();setAudioScrubEnabled()
setAudioScrubEnabled(
enabled):void
Defined in: api/AudioAPI.ts:198
Set audio scrubbing enabled state.
Parameters
enabled
boolean
true to enable audio scrub, false to disable.
Returns
void
Throws
If enabled is not a boolean.
Example
openrv.audio.setAudioScrubEnabled(false);setPreservesPitch()
setPreservesPitch(
preserve):void
Defined in: api/AudioAPI.ts:123
Enable or disable pitch correction for non-1x playback speeds. When enabled, audio pitch stays the same regardless of playback speed.
Parameters
preserve
boolean
true to preserve pitch (default behavior), false for natural pitch shift proportional to speed.
Returns
void
Throws
If preserve is not a boolean.
Example
openrv.audio.setPreservesPitch(false); // allow pitch to shift with speedsetVolume()
setVolume(
volume):void
Defined in: api/AudioAPI.ts:31
Set the audio volume level.
Parameters
volume
number
A number between 0.0 (mute) and 1.0 (max). Values outside this range are clamped.
Returns
void
Throws
If volume is not a valid number or is NaN.
Example
openrv.audio.setVolume(0.75);toggleMute()
toggleMute():
void
Defined in: api/AudioAPI.ts:105
Toggle the mute state (mute if unmuted, unmute if muted).
Returns
void
Example
openrv.audio.toggleMute();unmute()
unmute():
void
Defined in: api/AudioAPI.ts:77
Unmute audio output.
Returns
void
Example
openrv.audio.unmute();