Class: StoryboardSample

Defined in: src/beatmap/storyboard/elements.ts:167

import { FileRef, StoryboardSample } from 'osu-files'

const sample = new StoryboardSample(
  new FileRef('audio.mp3', { hash: 'a'.repeat(64) }),
  500,
)

return { path: sample.path, startTime: sample.startTime }

Constructors

new StoryboardSample(fileRef, startTime, volume?, source?): StoryboardSample

Defined in: src/beatmap/storyboard/elements.ts:181

Parameters

Parameter	Type	Default value
fileRef	FileRef	undefined
startTime	number	undefined
volume	number	100
source?	StoryboardElementSource	undefined

Returns

StoryboardSample

import { FileRef, StoryboardSample } from 'osu-files'

const sample = new StoryboardSample(
  new FileRef('audio.mp3', { hash: 'a'.repeat(64) }),
  500,
)

return { path: sample.path, startTime: sample.startTime }

Properties

file

file: FileRef

Defined in: src/beatmap/storyboard/elements.ts:169

---

source

source: StoryboardElementSource = 'beatmap'

Defined in: src/beatmap/storyboard/elements.ts:168

---

startTime

startTime: number

Defined in: src/beatmap/storyboard/elements.ts:170

---

volume

volume: number

Defined in: src/beatmap/storyboard/elements.ts:171

Accessors

path

get path(): string

Defined in: src/beatmap/storyboard/elements.ts:173

Returns

string

import { FileRef, StoryboardSample } from 'osu-files'

const sample = new StoryboardSample(
  new FileRef('audio.mp3', { hash: 'a'.repeat(64) }),
  500,
)

return { path: sample.path, startTime: sample.startTime }