Class BinaryReader

Hierarchy

Binary<
    FrozenIntermediaryHeader,
    FrozenIntermediaryNotes,
    FrozenIntermediaryLayers,
    FrozenIntermediaryInstruments,
>
- BinaryReader

Index

Properties

status

status: BinaryStatus = Binary.DEFAULT_BINARY_STATUS

Methods

atHeader

atHeader(): FrozenIntermediaryHeader
Returns FrozenIntermediaryHeader
Overrides Binary.atHeader
- Defined in src/formats/binary/BinaryReader.ts:102

atInstruments

atInstruments(): FrozenIntermediaryInstruments
Returns FrozenIntermediaryInstruments
Overrides Binary.atInstruments
- Defined in src/formats/binary/BinaryReader.ts:120

atLayers

atLayers(): FrozenIntermediaryLayers
Returns FrozenIntermediaryLayers
Overrides Binary.atLayers
- Defined in src/formats/binary/BinaryReader.ts:114

atNotes

atNotes(): FrozenIntermediaryNotes
Returns FrozenIntermediaryNotes
Overrides Binary.atNotes
- Defined in src/formats/binary/BinaryReader.ts:108

toHeader

toHeader(): Header
Returns Header
- Defined in src/formats/binary/BinaryReader.ts:126

toSong

toSong(): Song
Returns Song
- Defined in src/formats/binary/BinaryReader.ts:138

`Protected`ensureStatus

ensureStatus(status: BinaryStatus): void
Parameters
- status: BinaryStatus
Returns void
Inherited from Binary.ensureStatus
- Defined in src/formats/binary/Binary.ts:183

`Protected`findEmptyLayers

findEmptyLayers(layers: BasicLayer[]): LayerActionMap
Parameters
- layers: BasicLayer[]
Returns LayerActionMap
Inherited from Binary.findEmptyLayers
- Defined in src/formats/binary/Binary.ts:139

`Protected`processHeader

processHeader(): void
Returns void
Overrides Binary.processHeader
- Defined in src/formats/binary/BinaryReader.ts:255

`Protected`processInstruments

processInstruments(): void
Returns void
Overrides Binary.processInstruments
- Defined in src/formats/binary/BinaryReader.ts:452

`Protected`processLayers

processLayers(): void
Returns void
Overrides Binary.processLayers
- Defined in src/formats/binary/BinaryReader.ts:371

`Protected`processNotes

processNotes(): void
Returns void
Overrides Binary.processNotes
- Defined in src/formats/binary/BinaryReader.ts:316

`Protected`processUntil

processUntil(status: BinaryStatus): void
Parameters
- status: BinaryStatus
Returns void
Inherited from Binary.processUntil
- Defined in src/formats/binary/Binary.ts:96

Accessors

`Static`DEFAULT_BINARY_STATUS

get DEFAULT_BINARY_STATUS(): BinaryStatus
Returns BinaryStatus
Inherited from Binary.DEFAULT_BINARY_STATUS
- Defined in src/formats/binary/Binary.ts:71

`Static`DEFAULT_HEADER

get DEFAULT_HEADER(): IntermediaryHeader
Returns IntermediaryHeader
- Defined in src/formats/binary/BinaryReader.ts:51

`Static`DEFAULT_INSTRUMENTS

get DEFAULT_INSTRUMENTS(): IntermediaryInstrument[]
Returns IntermediaryInstrument[]
- Defined in src/formats/binary/BinaryReader.ts:85

`Static`DEFAULT_LAYER_TRANSFORMER

get DEFAULT_LAYER_TRANSFORMER(): EmptyLayerOptions
Returns EmptyLayerOptions
Inherited from Binary.DEFAULT_LAYER_TRANSFORMER
- Defined in src/formats/binary/Binary.ts:75

`Static`DEFAULT_LAYERS

get DEFAULT_LAYERS(): IntermediaryLayer[]
Returns IntermediaryLayer[]
- Defined in src/formats/binary/BinaryReader.ts:81

`Static`DEFAULT_NOTES

get DEFAULT_NOTES(): IntermediaryNote[]
Returns IntermediaryNote[]
- Defined in src/formats/binary/BinaryReader.ts:77

Constructors

constructor

new BinaryReader(
file: ArrayBufferLike,
options?: PartialDeep<BinaryReaderOptions>,
): BinaryReader
Parameters
- file: ArrayBufferLike
- options: PartialDeep<BinaryReaderOptions> = {}
Returns BinaryReader
Overrides Binary< FrozenIntermediaryHeader, FrozenIntermediaryNotes, FrozenIntermediaryLayers, FrozenIntermediaryInstruments >.constructor
- Defined in src/formats/binary/BinaryReader.ts:96