Skip to content

UseSonoscopeOptions

Options for initializing a Sonoscope coordinator inside React.

PropertyTypeDescription
array?| number[] | Float32Array<ArrayBufferLike> | Float32Array<ArrayBufferLike>[] | number[][]Raw PCM samples.
audio?HTMLAudioElementHTML audio element to synchronize playback with.
blob?BlobAudio Blob or File.
buffer?ArrayBuffer | Uint8Array<ArrayBufferLike>Encoded audio file in an ArrayBuffer or Uint8Array.
endTime?numberInitial viewport end time in seconds.
followPlayback?FollowPlaybackModePlayback follow mode (page, smooth, or off).
maxDuration?numberMaximum zoom duration in seconds.
maxFrequency?numberInitial maximum frequency in Hz.
minDuration?numberMinimum zoom duration in seconds.
minFrequency?numberInitial minimum frequency in Hz.
sampleRate?numberSample rate in Hz when passing raw PCM samples.
smoothAnchor?numberScreen anchor ratio (0 to 1) for smooth playback follow.
source?AudioSourcePre-constructed AudioSource instance.
startTime?numberInitial viewport start time in seconds.
url?stringURL of an audio file to load.