alphaTab.model.JsonConverter

This class can convert a full Score instance to a simple JavaScript object and back for further JSON serialization.

 class JsonConverter

Methods

jsObjectToMidiEvent

Converts the given JavaScript object into a MidiEvent object.

JavaScript

static jsObjectToMidiEvent(midiEvent: unknown): MidiEvent

C#

static MidiEvent JsObjectToMidiEvent(object midiEvent)

Kotlin

fun jsObjectToMidiEvent(midiEvent: Any): MidiEvent

Parameter	Summary
midiEventAll	(no description)

Returns

The converted MidiEvent.

jsObjectToMidiFile

Converts the given JavaScript object into a MidiFile object.

JavaScript

static jsObjectToMidiFile(jsObject: unknown): MidiFile

C#

static MidiFile JsObjectToMidiFile(object jsObject)

Kotlin

fun jsObjectToMidiFile(jsObject: Any): MidiFile

Parameter	Summary
jsObjectAll	The javascript object to deserialize.

Returns

The converted MidiFile.

jsObjectToScore

Converts the given JavaScript object into a score object.

JavaScript

static jsObjectToScore(jsObject: unknown, settings?: Settings): Score

C#

static Score JsObjectToScore(object jsObject, Settings? settings)

Kotlin

fun jsObjectToScore(jsObject: Any, settings: Settings?): Score

Parameter	Summary
jsObjectAll	The javascript object created via Score
settingsAll	The settings to use during conversion.

Returns

The converted score object.

jsObjectToSettings

Converts the given JavaScript object into a settings object.

JavaScript

static jsObjectToSettings(jsObject: unknown): Settings

C#

static Settings JsObjectToSettings(object jsObject)

Kotlin

fun jsObjectToSettings(jsObject: Any): Settings

Parameter	Summary
jsObjectAll	The javascript object created via Settings

Returns

The converted Settings object.

jsonToScore

Converts the given JSON string back to a Score object.

static jsonToScore(json: string, settings?: Settings): Score

Parameter	Summary
jsonAll	The JSON string
settingsAll	The settings to use during conversion.

Returns

The converted score object.

jsonToSettings

Converts the given JSON string back to a Score object.

static jsonToSettings(json: string): Settings

Parameter	Summary
jsonAll	The JSON string

Returns

The converted settings object.

midiEventToJsObject

Converts the given MidiEvent object into a serialized JavaScript object.

JavaScript

static midiEventToJsObject(midiEvent: MidiEvent): Map<string, unknown>

C#

static Map<string, object> MidiEventToJsObject(MidiEvent midiEvent)

Kotlin

fun midiEventToJsObject(midiEvent: MidiEvent): alphaTab.collections.StringAnyMap<String, Any>

Parameter	Summary
midiEventAll	(no description)

Returns

A serialized MidiEvent object without ciruclar dependencies that can be used for further serializations.

midiFileToJsObject

Converts the given MidiFile object into a serialized JavaScript object.

JavaScript

static midiFileToJsObject(midi: MidiFile): Map<string, unknown>

C#

static Map<string, object> MidiFileToJsObject(MidiFile midi)

Kotlin

fun midiFileToJsObject(midi: MidiFile): alphaTab.collections.StringAnyMap<String, Any>

Parameter	Summary
midiAll	The midi file to convert.

Returns

A serialized MidiFile object without ciruclar dependencies that can be used for further serializations.

scoreToJsObject

Converts the score into a JavaScript object without circular dependencies.

JavaScript

static scoreToJsObject(score: Score): unknown

C#

static object ScoreToJsObject(Score score)

Kotlin

fun scoreToJsObject(score: Score): Any

Parameter	Summary
scoreAll	The score object to serialize

Returns

A serialized score object without ciruclar dependencies that can be used for further serializations.

scoreToJson

Converts the given score into a JSON encoded string.

static scoreToJson(score: Score): string

Parameter	Summary
scoreAll	The score to serialize.

Returns

A JSON encoded string.

settingsToJsObject

Converts the settings object into a JavaScript object for transmission between components or saving purposes.

JavaScript

static settingsToJsObject(settings: Settings): Map<string, unknown> | null

C#

static Map<string, object>? SettingsToJsObject(Settings settings)

Kotlin

fun settingsToJsObject(settings: Settings): alphaTab.collections.StringAnyMap<String, Any>?

Parameter	Summary
settingsAll	The settings object to serialize

Returns

A serialized settings object without ciruclar dependencies that can be used for further serializations.

settingsToJson

Converts the given settings into a JSON encoded string.

static settingsToJson(settings: Settings): string

Parameter	Summary
settingsAll	The settings to serialize.

Returns

A JSON encoded string.