diff --git a/docs/alphatex/staff-metadata.mdx b/docs/alphatex/staff-metadata.mdx index 7a7b25d..7085921 100644 --- a/docs/alphatex/staff-metadata.mdx +++ b/docs/alphatex/staff-metadata.mdx @@ -427,7 +427,7 @@ export function ArticulationTable({list}) { {list.map(i => ( - + {i[1]} {i[0]} {i[0].replace(/[^a-zA-Z0-9]/g, '')} diff --git a/docs/alphatex/structural-metadata.mdx b/docs/alphatex/structural-metadata.mdx index bcb5480..a25a87a 100644 --- a/docs/alphatex/structural-metadata.mdx +++ b/docs/alphatex/structural-metadata.mdx @@ -362,7 +362,7 @@ export function GeneralMidiList() { return ( {items.map((x, i) => { - return ( + return ( {i} {x} ); @@ -374,7 +374,7 @@ export function GeneralMidiList() { Refer to the following list of names you can use.
- +
diff --git a/docs/guides/exporter.mdx b/docs/guides/exporter.mdx index 0c0bd1b..a939922 100644 --- a/docs/guides/exporter.mdx +++ b/docs/guides/exporter.mdx @@ -64,7 +64,7 @@ using(var fs = new System.IO.FileStream(fileName, System.IO.FileMode.Create)) Starting with 1.7.0 alphaTab can also export the data model to its own music notation language [alphaTex](/docs/alphatex/introduction). The exporter supports all features which the importer can also handle. If you find something, please open a feature request. -Via the exporter settings [`settings.exporter`](/docs/reference/settings#Exporter) the format of the exported code can be adjusted. +Via the exporter settings [`settings.exporter`](/docs/reference/settings.mdx#Exporter) the format of the exported code can be adjusted. Especially the `comments` can be quite useful for alphaTex beginners to learn about the syntax. While you can use the standard `export` to export the code into a byte array, you can also use `exportToString` to get the alphaTex code diff --git a/docs/reference/_apiTable.mdx b/docs/reference/_apiTable.mdx new file mode 100644 index 0000000..9dcd26d --- /dev/null +++ b/docs/reference/_apiTable.mdx @@ -0,0 +1,801 @@ +import { CodeBadge } from "@site/src/components/CodeBadge"; +import { Signature } from "@site/src/components/Signature"; + +
Number
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSummary
Events - Core
+ + + + + This event is fired when an error within alphatab occurred. +
+ + + + + This event is fired when the rendering of the whole music sheet is finished, and all handlers of `renderFinished` ran. +
+ + + + + This event is fired when the rendering of the whole music sheet is finished. +
+ + + + + This event is fired when the rendering of the whole music sheet is starting. +
+ + + + + This event is fired when alphaTab was resized and is about to rerender the music notation. +
+ + + + + This event is fired whenever a new song is loaded. +
+ + + + + This event is fired when a settings update was requested. +
Events - Player
+ + + + + This event is fired when the currently active beats across all tracks change. +
+ + + + + This event is fired whenever a the user presses the mouse button on a beat. +
+ + + + + This event is fired whenever the user moves the mouse over a beat after the user already pressed the button on a beat. +
+ + + + + This event is fired whenever the user releases the mouse after a mouse press on a beat. +
+ + + + + This event is fired when the synthesizer played certain midi events. +
+ + + + + This event is fired when a Midi file is being loaded. +
+ + + + + This event is fired when the Midi file needed for playback was loaded. +
+ + + + + This event is fired whenever a the user presses the mouse button on a note head/number. +
+ + + + + This event is fired whenever the user moves the mouse over a note after the user already pressed the button on a note. +
+ + + + + This event is fired whenever the user releases the mouse after a mouse press on a note. +
+ + + + + This event is fired when the playback range changed. +
+ + + + + This event is fired when the played beat changed. +
+ + + + + This event is fired when the playback of the whole song finished. +
+ + + + + This event is fired when the current playback position of the song changed. +
+ + + + + This event is fired when all required data for playback is loaded and ready. +
+ + + + + This event is fired when the playback state changed. +
+ + + + + This event is fired when the SoundFont is being loaded. +
+ + + + + This event is fired when the SoundFont needed for playback was loaded. +
Methods - Core
+ + + + + Destroys the alphaTab control and restores the initial state of the UI. +
+ + + + + Generates an SMF1.0 file and downloads it +
+ + + + + Opens a popup window with the rendered music notation for printing. +
+ + + + + Initiates a re-rendering of the current setup. +
+ + + + + Initiates a rendering of the given score. +
+ + + + + Renders the given list of tracks. +
+ + + + + Tells alphaTab to render the given alphaTex. +
+ + + + + Applies any changes that were done to the settings object. +
Methods - Player
+ + + + + Changes the given tracks to be muted or not. +
+ + + + + Changes the given tracks to be played solo or not. +
+ + + + + Changes the pitch transpose applied to the given tracks. +
+ + + + + Changes the volume of the given tracks. +
+ + + + + Loads and lists the available output devices which can be used by the player. +
+ + + + + Starts the audio export for the currently loaded song. +
+ + + + + The currently configured output device if changed via . +
+ + + + + Initiates a load of the score using the given data. +
+ + + + + Re-creates the midi for the current score and loads it. +
+ + + + + Triggers a load of the soundfont from the given data. +
+ + + + + Triggers a load of the soundfont from the given URL. +
+ + + + + Pauses the playback of the current song. +
+ + + + + Starts the playback of the current song. +
+ + + + + Triggers the play of the given beat. +
+ + + + + Triggers the play of the given note. +
+ + + + + Toggles between play/pause depending on the current player state. +
+ + + + + Unloads all presets from previously loaded SoundFonts. +
+ + + + + Initiates a scroll to the cursor. +
+ + + + + Changes the output device which should be used for playing the audio (player must be enabled). +
+ + + + + Stops the playback of the current song, and moves the playback position back to the start. +
+ + + + + Triggers an update of the sync points for the current score after modification within the data model +
Properties - Core
+ + + + + The tick cache allowing lookup of midi ticks to beats. +
+ + + + + The UI container that will hold all rendered results. +
+ + + + + The UI container that holds the whole alphaTab control. +
+ + + + + The score renderer used for rendering the music sheet. +
+ + + + + The score holding all information about the song being rendered +
+ + + + + The settings that are used for rendering the music notation. +
+ + + + + The list of the tracks that are currently rendered. +
+ + + + + The UI facade used for interacting with the user interface (like the browser). +
Properties - Player
+ + + + + The actual player mode which is currently active. +
+ + + + + The volume of the count-in metronome ticks. +
+ + + + + The total length of the song in midi ticks. +
+ + + + + The total length of the song in milliseconds. +
+ + + + + Whether the playback should automatically restart after it finished. +
+ + + + + Whether the player is ready for starting the playback. +
+ + + + + The current master volume as percentage (0-1). +
+ + + + + The metronome volume as percentage (0-1). +
+ + + + + The midi events which will trigger the `midiEventsPlayed` event +
+ + + + + The range of the song that should be played. +
+ + + + + The current playback speed as percentage +
+ + + + + The alphaSynth player used for playback. +
+ + + + + The current player state. +
+ + + + + The tick cache allowing lookup of midi ticks to beats. +
+ + + + + The position within the song in midi ticks. +
+ + + + + The position within the song in milliseconds +
+ diff --git a/docs/reference/_settingsTable.mdx b/docs/reference/_settingsTable.mdx new file mode 100644 index 0000000..7f93c06 --- /dev/null +++ b/docs/reference/_settingsTable.mdx @@ -0,0 +1,753 @@ +import { CodeBadge } from "@site/src/components/CodeBadge"; +import { Signature } from "@site/src/components/Signature"; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertySummary
Core
+ + + + + Enables lazy loading of the rendered music sheet chunks. +
+ + + + + The engine which should be used to render the the tablature. +
+ + + + + Whether in the also the position and area of each individual note is provided. +
+ + + + + The log level to use within alphaTab +
+ + + + + Whether the rendering should be done in a worker if possible. +
Core - JavaScript Specific
+ + + + + The full URL to the input file to be loaded. +
+ + + + + The full URL to the alphaTab font directory. +
+ + + + + The full URL to the alphaTab JavaScript file. +
+ + + + + Defines the URLs from which to load the SMuFL compliant font files. +
+ + + + + Whether the contents of the DOM element should be loaded as alphaTex. +
+ + + + + The tracks to display for the initally loaded file. +
Display
+ + + + + The padding between the accolade bar and the start of the bar itself. +
+ + + + + The total number of bars that should be rendered from the song. (-1 for all bars) +
+ + + + + The number of bars that should be placed within one partial render. +
+ + + + + Limit the displayed bars per system (row). (-1 for automatic mode) +
+ + + + + The padding between individual effect bands. +
+ + + + + The bottom padding applied to effect annotation staffs. +
+ + + + + The top padding applied to effect annotation staffs. +
+ + + + + The left padding applied between the left line and the first glyph in the first staff in a system. +
+ + + + + The top padding applied to first system. +
+ + + + + Whether to justify also the last system in page layouts. +
+ + + + + The bottom padding applied to the last system. +
+ + + + + The layouting mode used to arrange the the notation. +
+ + + + + The bottom padding applied to main notation staves (standard, tabs, numbered, slash). +
+ + + + + The bottom padding applied to main notation staves (standard, tabs, numbered, slash). +
+ + + + + Adjusts the padding between the music notation and the border. +
+ + + + + Allows adjusting of the used fonts and colors for rendering. +
+ + + + + The zoom level of the rendered notation. +
+ + + + + The left padding applied between the left line and the first glyph in the following staff in a system. +
+ + + + + The bar start index to start layouting with. +
+ + + + + The stave profile defining which staves are shown for the music sheet. +
+ + + + + The default stretch force to use for layouting. +
+ + + + + The padding left to the track name label of the system. +
+ + + + + The padding left to the track name label of the system. +
+ + + + + The bottom padding applied to systems beside the last one. +
+ + + + + The top padding applied systems beside the first one. +
+ + + + + The mode used to arrange staves and systems. +
Exporter
+ + + + + Whether to write extended comments into the exported file (e.g. to in alphaTex to mark where certain metadata or bars starts) +
+ + + + + How many characters should be indented on formatted outputs. If set to negative values +
Importer
+ + + + + Enables detecting lyrics from beat texts +
+ + + + + The text encoding to use when decoding strings. +
+ + + + + If part-groups should be merged into a single track (MusicXML). +
Notation
+ + + + + The transposition pitch offsets for the individual tracks used for rendering only. +
+ + + + + Whether music notation elements are visible or not. +
+ + + + + If set to true bend arrows expand to the end of the last tied note of the string. Otherwise they end on the next beat. +
+ + + + + If set to true, line effects like w/bar and let-ring are drawn until the end of the beat instead of the start +
+ + + + + The fingering mode to use. +
+ + + + + The mode to use for display and play music notation elements. +
+ + + + + Controls how high the ryhthm notation is rendered below the tab staff +
+ + + + + Controls how the rhythm notation is rendered for tab staves. +
+ + + + + The height scale factor for slurs +
+ + + + + If set to true the guitar tabs on grace beats are rendered smaller. +
+ + + + + The transposition pitch offsets for the individual tracks used for rendering and playback. +
Player
+ + + + + The number of milliseconds the player should buffer. +
+ + + + + Whether the beat cursor should be animated or just ticking. +
+ + + + + Whether playback cursors should be displayed. +
+ + + + + Whether the notation elements of the currently played beat should be highlighted. +
+ + + + + Whether the player should be enabled. +
+ + + + + Whether the default user interaction behavior should be active or not. +
+ + + + + Whether the native browser smooth scroll mechanism should be used over a custom animation. +
+ + + + + Whether the triplet feel should be played or only displayed. +
+ + + + + Whether the player should be enabled and which mode it should use. +
+ + + + + The mode how to scroll. +
+ + + + + The X-offset to add when scrolling. +
+ + + + + The Y-offset to add when scrolling. +
+ + + + + How fast the scrolling to the new position should happen. +
+ + + + + The slide settings allow control how the different slide types are generated for audio. +
+ + + + + The bend duration in milliseconds for songbook bends. +
+ + + + + The duration of whammy dips in milliseconds for songbook whammys. +
+ + + + + The Vibrato settings allow control how the different vibrato types are generated for audio. +
Player - JavaScript Specific
+ + + + + The mode used for playing audio samples +
+ + + + + The element to apply the scrolling on. +
+ + + + + The sound font file to load for the player. +
+ diff --git a/docs/reference/api.mdx b/docs/reference/api.mdx index 2ca9b65..c2755dd 100644 --- a/docs/reference/api.mdx +++ b/docs/reference/api.mdx @@ -2,12 +2,10 @@ title: API --- -import { ReferenceTable } from '@site/src/components/ReferenceTable'; - On many platforms an alphaTab API object can be used to bootstrap alphaTab within your UI. It takes over all responsibilities of linking your actions to the UI. Namely this object is called `AlphaTabApi` (Web) or `AlphaTabApiBase<>` (.net). This page describes all methods, properties and events exposed by this API object. -import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; +import ReferenceTable from "./_apiTable.mdx"; - \ No newline at end of file + \ No newline at end of file diff --git a/docs/reference/api/activebeatschanged.mdx b/docs/reference/api/activebeatschanged.mdx index f630298..6fd5ba4 100644 --- a/docs/reference/api/activebeatschanged.mdx +++ b/docs/reference/api/activebeatschanged.mdx @@ -1,37 +1,23 @@ --- title: activeBeatsChanged -description: "This event is fired when the currently active beats across all tracks change." sidebar_custom_props: kind: event category: Events - Player since: 1.2.3 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description -This event is fired when the currently active beats across all tracks change. Unlike the {"playedBeatChanged"} event this event contains the beats of all tracks and voices independent of them being rendered. +This event is fired when the currently active beats across all tracks change. Unlike the event this event contains the beats of all tracks and voices independent of them being rendered. - - -
{"activeBeatsChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"ActiveBeatsChangedEventArgs"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"ActiveBeatsChangedEventArgs"}{">"}{" "}{"ActiveBeatsChanged"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"activeBeatsChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"ActiveBeatsChangedEventArgs"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","ActiveBeatsChangedEventArgs","/docs/reference/types/synth/activebeatschangedeventargs"],["token",">"],["whitespace"," "],["identifier","ActiveBeatsChanged"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","activeBeatsChanged"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","ActiveBeatsChangedEventArgs","/docs/reference/types/synth/activebeatschangedeventargs"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/actualplayermode.mdx b/docs/reference/api/actualplayermode.mdx index 58d0502..14ec5e6 100644 --- a/docs/reference/api/actualplayermode.mdx +++ b/docs/reference/api/actualplayermode.mdx @@ -1,38 +1,22 @@ --- title: actualPlayerMode -description: "The actual player mode which is currently active." sidebar_custom_props: kind: property category: Properties - Player since: 1.6.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The actual player mode which is currently active. Allows determining whether a backing track or the synthesizer is active in case automatic detection is enabled. - - -
{"readonly"}{" "}{"actualPlayerMode"}{":"}{" "}{"PlayerMode"}{";"}
- - -
{"PlayerMode"}{" "}{"ActualPlayerMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"actualPlayerMode"}{":"}{" "}{"PlayerMode"}
- - + diff --git a/docs/reference/api/beatmousedown.mdx b/docs/reference/api/beatmousedown.mdx index 7509805..1dcd930 100644 --- a/docs/reference/api/beatmousedown.mdx +++ b/docs/reference/api/beatmousedown.mdx @@ -1,37 +1,23 @@ --- title: beatMouseDown -description: "This event is fired whenever a the user presses the mouse button on a beat." sidebar_custom_props: kind: event category: Events - Player since: 0.9.7 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired whenever a the user presses the mouse button on a beat. - - -
{"beatMouseDown"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{" "}{"BeatMouseDown"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"beatMouseDown"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Beat","/docs/reference/types/model/beat"],["token",">"],["whitespace"," "],["identifier","BeatMouseDown"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","beatMouseDown"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Beat","/docs/reference/types/model/beat"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/beatmousemove.mdx b/docs/reference/api/beatmousemove.mdx index e668b6a..7697ce1 100644 --- a/docs/reference/api/beatmousemove.mdx +++ b/docs/reference/api/beatmousemove.mdx @@ -1,37 +1,23 @@ --- title: beatMouseMove -description: "This event is fired whenever the user moves the mouse over a beat after the user already pressed the button on a beat." sidebar_custom_props: kind: event category: Events - Player since: 0.9.7 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired whenever the user moves the mouse over a beat after the user already pressed the button on a beat. - - -
{"beatMouseMove"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{" "}{"BeatMouseMove"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"beatMouseMove"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Beat","/docs/reference/types/model/beat"],["token",">"],["whitespace"," "],["identifier","BeatMouseMove"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","beatMouseMove"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Beat","/docs/reference/types/model/beat"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/beatmouseup.mdx b/docs/reference/api/beatmouseup.mdx index 9ba2ef0..6ab3682 100644 --- a/docs/reference/api/beatmouseup.mdx +++ b/docs/reference/api/beatmouseup.mdx @@ -1,20 +1,12 @@ --- title: beatMouseUp -description: "This event is fired whenever the user releases the mouse after a mouse press on a beat." sidebar_custom_props: kind: event category: Events - Player since: 0.9.7 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -22,17 +14,11 @@ import Link from '@docusaurus/Link'; This event is fired whenever the user releases the mouse after a mouse press on a beat. This event is fired regardless of whether the mouse was released on a beat. The parameter is null if the mouse was released somewhere beside the beat. - - -
{"beatMouseUp"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{" "}{"|"}{" "}{"null"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"Beat"}{"?"}{">"}{" "}{"BeatMouseUp"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"beatMouseUp"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{"?"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Beat","/docs/reference/types/model/beat"],["token","?"],["token",">"],["whitespace"," "],["identifier","BeatMouseUp"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","beatMouseUp"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Beat","/docs/reference/types/model/beat"],["token","?"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/boundslookup.mdx b/docs/reference/api/boundslookup.mdx index c6ffa31..33d664d 100644 --- a/docs/reference/api/boundslookup.mdx +++ b/docs/reference/api/boundslookup.mdx @@ -1,32 +1,22 @@ --- title: boundsLookup -description: "The tick cache allowing lookup of midi ticks to beats." sidebar_custom_props: kind: property category: Properties - Core since: 1.5.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description -The tick cache allowing lookup of midi ticks to beats. In older versions of alphaTab you can access the `boundsLookup` via {"boundsLookup"} on {"renderer"}. +The tick cache allowing lookup of midi ticks to beats. In older versions of alphaTab you can access the `boundsLookup` via on . After the rendering completed alphaTab exposes via this lookup the location of the individual notation elements. The lookup provides fast access to the bars and beats at a given location. -If the {"CoreSettings.includeNoteBounds"} option was activated also the location of the individual notes can be obtained. +If the option was activated also the location of the individual notes can be obtained. The property contains a `BoundsLookup` instance which follows a hierarchical structure that represents the tree of rendered elements. @@ -47,17 +37,11 @@ Each bounds hierarchy have a `visualBounds` and `realBounds`. You can check out the individual sizes and regions. - - -
{"readonly"}{" "}{"boundsLookup"}{":"}{" "}{"BoundsLookup"}{" "}{"|"}{" "}{"null"}{";"}
- - -
{"BoundsLookup"}{"?"}{" "}{"BoundsLookup"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"boundsLookup"}{":"}{" "}{"BoundsLookup"}{"?"}
- - + import ManualDocs from './_boundslookup.mdx'; diff --git a/docs/reference/api/canvaselement.mdx b/docs/reference/api/canvaselement.mdx index 208927b..16ff2b2 100644 --- a/docs/reference/api/canvaselement.mdx +++ b/docs/reference/api/canvaselement.mdx @@ -1,38 +1,22 @@ --- title: canvasElement -description: "The UI container that will hold all rendered results." sidebar_custom_props: kind: property category: Properties - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The UI container that will hold all rendered results. - - -
{"readonly"}{" "}{"canvasElement"}{":"}{" "}{"IContainer"}{";"}
- - -
{"IContainer"}{" "}{"CanvasElement"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"canvasElement"}{":"}{" "}{"IContainer"}
- - + diff --git a/docs/reference/api/changetrackmute.mdx b/docs/reference/api/changetrackmute.mdx index 3ae33ec..0cc1f57 100644 --- a/docs/reference/api/changetrackmute.mdx +++ b/docs/reference/api/changetrackmute.mdx @@ -1,20 +1,12 @@ --- title: changeTrackMute -description: "Changes the given tracks to be muted or not." sidebar_custom_props: kind: method category: Methods - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -22,28 +14,38 @@ import Link from '@docusaurus/Link'; Changes the given tracks to be muted or not. This will result in a muting of the primary and secondary midi channel that the track uses for playback. If the track shares the channels with another track, all tracks will be muted as during playback they cannot be distinguished. - - -
{"changeTrackMute"}{"("}{"tracks"}{":"}{" "}{"Track"}{"[]"}{","}{" "}{"mute"}{":"}{" "}{"boolean"}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"ChangeTrackMute"}{"("}{"IList"}{"<"}{"Track"}{">"}{" "}{"tracks"}{","}{" "}{"bool"}{" "}{"mute"}{")"}
- - -
{"fun"}{" "}{"changeTrackMute"}{"("}{"tracks"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"Track"}{">"}{","}{" "}{"mute"}{":"}{" "}{"Boolean"}{")"}{":"}{" "}{"Unit"}
- - - - - - - The list of track to mute or unmute. - - - If set to true, the tracks will be muted. If false they are unmuted. - - +"],["whitespace"," "],["identifier","tracks"],["token",","],["whitespace"," "],["identifier","bool"],["whitespace"," "],["identifier","mute"],["token",")"]]} + kotlin={[["identifier","fun"],["whitespace"," "],["identifier","changeTrackMute"],["token","("],["identifier","tracks"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.List"],["token","<"],["identifier","Track","/docs/reference/types/model/track"],["token",">"],["token",","],["whitespace"," "],["identifier","mute"],["token",":"],["whitespace"," "],["identifier","Boolean"],["token",")"],["token",":"],["whitespace"," "],["identifier","Unit"]]} +/> + + + + + + + + + + + + + + + + + +
ParameterSummary
+ + + The list of track to mute or unmute. +
+ + + If set to true, the tracks will be muted. If false they are unmuted. +
## Examples diff --git a/docs/reference/api/changetracksolo.mdx b/docs/reference/api/changetracksolo.mdx index 37f5334..f025c6c 100644 --- a/docs/reference/api/changetracksolo.mdx +++ b/docs/reference/api/changetracksolo.mdx @@ -1,20 +1,12 @@ --- title: changeTrackSolo -description: "Changes the given tracks to be played solo or not." sidebar_custom_props: kind: method category: Methods - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -23,28 +15,38 @@ Changes the given tracks to be played solo or not. If any track is set to solo, This will result in a solo playback of the primary and secondary midi channel that the track uses for playback. If the track shares the channels with another track, all related tracks will be played as they cannot be distinguished. - - -
{"changeTrackSolo"}{"("}{"tracks"}{":"}{" "}{"Track"}{"[]"}{","}{" "}{"solo"}{":"}{" "}{"boolean"}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"ChangeTrackSolo"}{"("}{"IList"}{"<"}{"Track"}{">"}{" "}{"tracks"}{","}{" "}{"bool"}{" "}{"solo"}{")"}
- - -
{"fun"}{" "}{"changeTrackSolo"}{"("}{"tracks"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"Track"}{">"}{","}{" "}{"solo"}{":"}{" "}{"Boolean"}{")"}{":"}{" "}{"Unit"}
- - - - - - - The list of tracks to play solo or not. - - - If set to true, the tracks will be added to the solo list. If false, they are removed. - - +"],["whitespace"," "],["identifier","tracks"],["token",","],["whitespace"," "],["identifier","bool"],["whitespace"," "],["identifier","solo"],["token",")"]]} + kotlin={[["identifier","fun"],["whitespace"," "],["identifier","changeTrackSolo"],["token","("],["identifier","tracks"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.List"],["token","<"],["identifier","Track","/docs/reference/types/model/track"],["token",">"],["token",","],["whitespace"," "],["identifier","solo"],["token",":"],["whitespace"," "],["identifier","Boolean"],["token",")"],["token",":"],["whitespace"," "],["identifier","Unit"]]} +/> + + + + + + + + + + + + + + + + + +
ParameterSummary
+ + + The list of tracks to play solo or not. +
+ + + If set to true, the tracks will be added to the solo list. If false, they are removed. +
## Examples diff --git a/docs/reference/api/changetracktranspositionpitch.mdx b/docs/reference/api/changetracktranspositionpitch.mdx index a26b3e5..5de5004 100644 --- a/docs/reference/api/changetracktranspositionpitch.mdx +++ b/docs/reference/api/changetracktranspositionpitch.mdx @@ -1,48 +1,50 @@ --- title: changeTrackTranspositionPitch -description: "Changes the pitch transpose applied to the given tracks." sidebar_custom_props: kind: method category: Methods - Player since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Changes the pitch transpose applied to the given tracks. These pitches are additional to the ones applied to the song via the settings and data model and allows a more live-update via a UI. - - -
{"changeTrackTranspositionPitch"}{"("}{"tracks"}{":"}{" "}{"Track"}{"[]"}{","}{" "}{"semitones"}{":"}{" "}{"number"}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"ChangeTrackTranspositionPitch"}{"("}{"IList"}{"<"}{"Track"}{">"}{" "}{"tracks"}{","}{" "}{"double"}{" "}{"semitones"}{")"}
- - -
{"fun"}{" "}{"changeTrackTranspositionPitch"}{"("}{"tracks"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"Track"}{">"}{","}{" "}{"semitones"}{":"}{" "}{"Double"}{")"}{":"}{" "}{"Unit"}
- - - - - - - The list of tracks to change. - - - The number of semitones to apply as pitch offset. - - +"],["whitespace"," "],["identifier","tracks"],["token",","],["whitespace"," "],["identifier","double"],["whitespace"," "],["identifier","semitones"],["token",")"]]} + kotlin={[["identifier","fun"],["whitespace"," "],["identifier","changeTrackTranspositionPitch"],["token","("],["identifier","tracks"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.List"],["token","<"],["identifier","Track","/docs/reference/types/model/track"],["token",">"],["token",","],["whitespace"," "],["identifier","semitones"],["token",":"],["whitespace"," "],["identifier","Double"],["token",")"],["token",":"],["whitespace"," "],["identifier","Unit"]]} +/> + + + + + + + + + + + + + + + + + +
ParameterSummary
+ + + The list of tracks to change. +
+ + + The number of semitones to apply as pitch offset. +
## Examples diff --git a/docs/reference/api/changetrackvolume.mdx b/docs/reference/api/changetrackvolume.mdx index dd54ef9..626506f 100644 --- a/docs/reference/api/changetrackvolume.mdx +++ b/docs/reference/api/changetrackvolume.mdx @@ -1,20 +1,12 @@ --- title: changeTrackVolume -description: "Changes the volume of the given tracks." sidebar_custom_props: kind: method category: Methods - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -22,28 +14,38 @@ import Link from '@docusaurus/Link'; Changes the volume of the given tracks. This will result in a volume change of the primary and secondary midi channel that the track uses for playback. If the track shares the channels with another track, all related tracks will be changed as they cannot be distinguished. - - -
{"changeTrackVolume"}{"("}{"tracks"}{":"}{" "}{"Track"}{"[]"}{","}{" "}{"volume"}{":"}{" "}{"number"}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"ChangeTrackVolume"}{"("}{"IList"}{"<"}{"Track"}{">"}{" "}{"tracks"}{","}{" "}{"double"}{" "}{"volume"}{")"}
- - -
{"fun"}{" "}{"changeTrackVolume"}{"("}{"tracks"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"Track"}{">"}{","}{" "}{"volume"}{":"}{" "}{"Double"}{")"}{":"}{" "}{"Unit"}
- - - - - - - The tracks for which the volume should be changed. - - - The volume to set for all tracks in percent (0-1) - - +"],["whitespace"," "],["identifier","tracks"],["token",","],["whitespace"," "],["identifier","double"],["whitespace"," "],["identifier","volume"],["token",")"]]} + kotlin={[["identifier","fun"],["whitespace"," "],["identifier","changeTrackVolume"],["token","("],["identifier","tracks"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.List"],["token","<"],["identifier","Track","/docs/reference/types/model/track"],["token",">"],["token",","],["whitespace"," "],["identifier","volume"],["token",":"],["whitespace"," "],["identifier","Double"],["token",")"],["token",":"],["whitespace"," "],["identifier","Unit"]]} +/> + + + + + + + + + + + + + + + + + +
ParameterSummary
+ + + The tracks for which the volume should be changed. +
+ + + The volume to set for all tracks in percent (0-1) +
## Examples diff --git a/docs/reference/api/container.mdx b/docs/reference/api/container.mdx index 60c98fc..f98ec54 100644 --- a/docs/reference/api/container.mdx +++ b/docs/reference/api/container.mdx @@ -1,40 +1,24 @@ --- title: container -description: "The UI container that holds the whole alphaTab control." sidebar_custom_props: kind: property category: Properties - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The UI container that holds the whole alphaTab control. Gets the UI container that represents the element on which alphaTab was initialized. Note that this is not the raw instance, but a UI framework specific wrapper for alphaTab. - - -
{"readonly"}{" "}{"container"}{":"}{" "}{"IContainer"}{";"}
- - -
{"IContainer"}{" "}{"Container"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"container"}{":"}{" "}{"IContainer"}
- - + ## Examples diff --git a/docs/reference/api/countinvolume.mdx b/docs/reference/api/countinvolume.mdx index d399b21..2e72514 100644 --- a/docs/reference/api/countinvolume.mdx +++ b/docs/reference/api/countinvolume.mdx @@ -1,40 +1,24 @@ --- title: countInVolume -description: "The volume of the count-in metronome ticks." sidebar_custom_props: kind: property category: Properties - Player since: 1.1.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The volume of the count-in metronome ticks. Gets or sets the volume of the metronome during the count-in of the song. By default the count-in is disabled but can be enabled by setting the volume different. - - -
{"countInVolume"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}
- - -
{"double"}{" "}{"CountInVolume"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}
- - -
{"var"}{" "}{"countInVolume"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}
- - + ## Examples diff --git a/docs/reference/api/destroy.mdx b/docs/reference/api/destroy.mdx index fbc1535..d09f0ce 100644 --- a/docs/reference/api/destroy.mdx +++ b/docs/reference/api/destroy.mdx @@ -1,20 +1,12 @@ --- title: destroy -description: "Destroys the alphaTab control and restores the initial state of the UI." sidebar_custom_props: kind: method category: Methods - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -23,17 +15,11 @@ Destroys the alphaTab control and restores the initial state of the UI. This fun our website is quite dynamic and you need to uninitialize alphaTab from an element again. After destroying alphaTab it cannot be used anymore. Any further usage leads to unexpected behavior. - - -
{"destroy"}{"("}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"Destroy"}{"("}{")"}
- - -
{"fun"}{" "}{"destroy"}{"("}{")"}{":"}{" "}{"Unit"}
- - + ## Examples diff --git a/docs/reference/api/downloadmidi.mdx b/docs/reference/api/downloadmidi.mdx index 9d1a71c..d95332d 100644 --- a/docs/reference/api/downloadmidi.mdx +++ b/docs/reference/api/downloadmidi.mdx @@ -1,6 +1,5 @@ --- title: downloadMidi -description: "Generates an SMF1.0 file and downloads it" sidebar_custom_props: kind: method javaScriptOnly: true @@ -8,14 +7,7 @@ sidebar_custom_props: since: 1.3.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -24,15 +16,28 @@ Generates an SMF1.0 file and downloads it Generates a SMF1.0 compliant MIDI file Please be aware that SMF1.0 does not support bends per note which might result in wrong bend effects in case multiple bends are applied on the same beat (e.g. two notes bending or vibrato + bends). -
{"downloadMidi"}{"("}{"format"}{"?"}{":"}{" "}{"MidiFileFormat"}{")"}{":"}{" "}{"void"}
- - - - - (no description) - - - + + + + + + + + + + + + + + + +
ParameterSummary
+ + + (no description) +
## Example - JavaScript diff --git a/docs/reference/api/endtick.mdx b/docs/reference/api/endtick.mdx new file mode 100644 index 0000000..42df27b --- /dev/null +++ b/docs/reference/api/endtick.mdx @@ -0,0 +1,22 @@ +--- +title: endTick +sidebar_custom_props: + kind: property + category: Properties - Player + since: 1.6.2 +--- + +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' + + + + +### Description +The total length of the song in midi ticks. + + + diff --git a/docs/reference/api/endtime.mdx b/docs/reference/api/endtime.mdx new file mode 100644 index 0000000..e68a36b --- /dev/null +++ b/docs/reference/api/endtime.mdx @@ -0,0 +1,22 @@ +--- +title: endTime +sidebar_custom_props: + kind: property + category: Properties - Player + since: 1.6.2 +--- + +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' + + + + +### Description +The total length of the song in milliseconds. + + + diff --git a/docs/reference/api/enumerateoutputdevices.mdx b/docs/reference/api/enumerateoutputdevices.mdx index c87f820..2f15004 100644 --- a/docs/reference/api/enumerateoutputdevices.mdx +++ b/docs/reference/api/enumerateoutputdevices.mdx @@ -1,42 +1,28 @@ --- title: enumerateOutputDevices -description: "Loads and lists the available output devices which can be used by the player." sidebar_custom_props: kind: method category: Methods - Player since: 1.5.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Loads and lists the available output devices which can be used by the player. Will request permissions if needed. -The values provided, can be passed into {"setOutputDevice"} to change dynamically the output device on which +The values provided, can be passed into to change dynamically the output device on which the sound is played. In the web version this functionality relies on experimental APIs and might not yet be available in all browsers. https://caniuse.com/mdn-api_audiocontext_sinkid - - -
{"enumerateOutputDevices"}{"("}{")"}{":"}{" "}{"Promise"}{"<"}{"ISynthOutputDevice"}{"[]"}{">"}
- - -
{"System.Threading.Task"}{"<"}{"IList"}{"<"}{"ISynthOutputDevice"}{">"}{">"}{" "}{"EnumerateOutputDevices"}{"("}{")"}
- - -
{"suspend"}{" "}{"fun"}{" "}{"enumerateOutputDevices"}{"("}{")"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"ISynthOutputDevice"}{">"}
- - +"]]} + csharp={[["identifier","System.Threading.Task","https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1"],["token","<"],["identifier","IList","https://learn.microsoft.com/en-us/dotnet/api/system.collections.ilist"],["token","<"],["identifier","ISynthOutputDevice","/docs/reference/types/synth/isynthoutputdevice"],["token",">"],["token",">"],["whitespace"," "],["identifier","EnumerateOutputDevices"],["token","("],["token",")"]]} + kotlin={[["identifier","suspend"],["whitespace"," "],["identifier","fun"],["whitespace"," "],["identifier","enumerateOutputDevices"],["token","("],["token",")"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.List"],["token","<"],["identifier","ISynthOutputDevice","/docs/reference/types/synth/isynthoutputdevice"],["token",">"]]} +/> ### Returns the list of available devices or an empty list if there are no permissions, or the player is not enabled. diff --git a/docs/reference/api/error.mdx b/docs/reference/api/error.mdx index 27063a0..469a7f3 100644 --- a/docs/reference/api/error.mdx +++ b/docs/reference/api/error.mdx @@ -1,20 +1,12 @@ --- title: error -description: "This event is fired when an error within alphatab occurred." sidebar_custom_props: kind: event category: Events - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -23,17 +15,11 @@ This event is fired when an error within alphatab occurred. This event is fired to end-users. Due to the asynchronous nature of alphaTab, no call to the API will directly throw an error if it fails. Instead a signal to this error handlers will be sent. - - -
{"error"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Error"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"System.Exception"}{">"}{" "}{"Error"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"error"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"kotlin.Throwable"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","System.Exception","https://learn.microsoft.com/en-us/dotnet/api/system.exception"],["token",">"],["whitespace"," "],["identifier","Error"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","error"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","kotlin.Throwable","https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/exportaudio.mdx b/docs/reference/api/exportaudio.mdx index eee6438..4eb50a8 100644 --- a/docs/reference/api/exportaudio.mdx +++ b/docs/reference/api/exportaudio.mdx @@ -1,20 +1,12 @@ --- title: exportAudio -description: "Starts the audio export for the currently loaded song." sidebar_custom_props: kind: method category: Methods - Player since: 1.6.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -24,25 +16,30 @@ This method works with any PlayerMode active but changing the mode during export See [Audio Export](/docs/guides/audio-export) for further guidance how to use this feature. - - -
{"exportAudio"}{"("}{"options"}{":"}{" "}{"AudioExportOptions"}{")"}{":"}{" "}{"Promise"}{"<"}{"IAudioExporter"}{">"}
- - -
{"System.Threading.Task"}{"<"}{"IAudioExporter"}{">"}{" "}{"ExportAudio"}{"("}{"AudioExportOptions"}{" "}{"options"}{")"}
- - -
{"suspend"}{" "}{"fun"}{" "}{"exportAudio"}{"("}{"options"}{":"}{" "}{"AudioExportOptions"}{")"}{":"}{" "}{"IAudioExporter"}
- - - - - - - The export options. - - - +"]]} + csharp={[["identifier","System.Threading.Task","https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1"],["token","<"],["identifier","IAudioExporter","/docs/reference/types/synth/iaudioexporter"],["token",">"],["whitespace"," "],["identifier","ExportAudio"],["token","("],["identifier","AudioExportOptions","/docs/reference/types/synth/audioexportoptions"],["whitespace"," "],["identifier","options"],["token",")"]]} + kotlin={[["identifier","suspend"],["whitespace"," "],["identifier","fun"],["whitespace"," "],["identifier","exportAudio"],["token","("],["identifier","options"],["token",":"],["whitespace"," "],["identifier","AudioExportOptions","/docs/reference/types/synth/audioexportoptions"],["token",")"],["token",":"],["whitespace"," "],["identifier","IAudioExporter","/docs/reference/types/synth/iaudioexporter"]]} +/> + + + + + + + + + + + + + + +
ParameterSummary
+ + + The export options. +
### Returns An exporter instance to export the audio in a streaming fashion. diff --git a/docs/reference/api/getoutputdevice.mdx b/docs/reference/api/getoutputdevice.mdx index a19ff27..f0986ec 100644 --- a/docs/reference/api/getoutputdevice.mdx +++ b/docs/reference/api/getoutputdevice.mdx @@ -1,41 +1,27 @@ --- title: getOutputDevice -description: "The currently configured output device if changed via {\"setOutputDevice\"}." sidebar_custom_props: kind: method category: Methods - Player since: 1.5.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description -The currently configured output device if changed via {"setOutputDevice"}. Assumes {"setOutputDevice"} has been used. +The currently configured output device if changed via . Assumes has been used. In the web version this functionality relies on experimental APIs and might not yet be available in all browsers. https://caniuse.com/mdn-api_audiocontext_sinkid - - -
{"getOutputDevice"}{"("}{")"}{":"}{" "}{"Promise"}{"<"}{"ISynthOutputDevice"}{" "}{"|"}{" "}{"null"}{">"}
- - -
{"System.Threading.Task"}{"<"}{"ISynthOutputDevice"}{"?"}{">"}{" "}{"GetOutputDevice"}{"("}{")"}
- - -
{"suspend"}{" "}{"fun"}{" "}{"getOutputDevice"}{"("}{")"}{":"}{" "}{"ISynthOutputDevice"}{"?"}
- - +"]]} + csharp={[["identifier","System.Threading.Task","https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1"],["token","<"],["identifier","ISynthOutputDevice","/docs/reference/types/synth/isynthoutputdevice"],["token","?"],["token",">"],["whitespace"," "],["identifier","GetOutputDevice"],["token","("],["token",")"]]} + kotlin={[["identifier","suspend"],["whitespace"," "],["identifier","fun"],["whitespace"," "],["identifier","getOutputDevice"],["token","("],["token",")"],["token",":"],["whitespace"," "],["identifier","ISynthOutputDevice","/docs/reference/types/synth/isynthoutputdevice"],["token","?"]]} +/> ### Returns -The custom configured output device which was set via {"setOutputDevice"} or `null` +The custom configured output device which was set via or `null` if the default outputDevice is used. The output device might change dynamically if devices are connected/disconnected (e.g. bluetooth headset). diff --git a/docs/reference/api/islooping.mdx b/docs/reference/api/islooping.mdx index 028fb28..807ab52 100644 --- a/docs/reference/api/islooping.mdx +++ b/docs/reference/api/islooping.mdx @@ -1,40 +1,24 @@ --- title: isLooping -description: "Whether the playback should automatically restart after it finished." sidebar_custom_props: kind: property category: Properties - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description Whether the playback should automatically restart after it finished. This setting controls whether the playback should automatically restart after it finished to create a playback loop. - - -
{"isLooping"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}
- - -
{"bool"}{" "}{"IsLooping"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}
- - -
{"var"}{" "}{"isLooping"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}
- - + ## Examples diff --git a/docs/reference/api/isreadyforplayback.mdx b/docs/reference/api/isreadyforplayback.mdx index 32197f9..a6c8fff 100644 --- a/docs/reference/api/isreadyforplayback.mdx +++ b/docs/reference/api/isreadyforplayback.mdx @@ -1,41 +1,25 @@ --- title: isReadyForPlayback -description: "Whether the player is ready for starting the playback." sidebar_custom_props: kind: property category: Properties - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description Whether the player is ready for starting the playback. Gets whether the synthesizer is ready for playback. The player is ready for playback when all background workers are started, the audio output is initialized, a soundfont is loaded, and a song was loaded into the player as midi file. - - -
{"readonly"}{" "}{"isReadyForPlayback"}{":"}{" "}{"boolean"}{";"}
- - -
{"bool"}{" "}{"IsReadyForPlayback"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"isReadyForPlayback"}{":"}{" "}{"Boolean"}
- - + ## Examples diff --git a/docs/reference/api/load.mdx b/docs/reference/api/load.mdx index 8ce4d30..8cbb92c 100644 --- a/docs/reference/api/load.mdx +++ b/docs/reference/api/load.mdx @@ -1,53 +1,55 @@ --- title: load -description: "Initiates a load of the score using the given data." sidebar_custom_props: kind: method category: Methods - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Initiates a load of the score using the given data. - - -
{"load"}{"("}{"scoreData"}{":"}{" "}{"unknown"}{","}{" "}{"trackIndexes"}{"?"}{":"}{" "}{"number"}{"[]"}{")"}{":"}{" "}{"boolean"}
- - -
{"bool"}{" "}{"Load"}{"("}{"object"}{" "}{"scoreData"}{","}{" "}{"IList"}{"<"}{"double"}{">"}{"?"}{" "}{"trackIndexes"}{")"}
- - -
{"fun"}{" "}{"load"}{"("}{"scoreData"}{":"}{" "}{"Any"}{","}{" "}{"trackIndexes"}{":"}{" "}{"alphaTab.collections.DoubleList"}{"?"}{")"}{":"}{" "}{"Boolean"}
- - - - - - - The data container supported by {"IUiFacade"}. The supported types is depending on the platform: - - * A `alphaTab.model.Score` instance (all platforms) - * A `ArrayBuffer` or `Uint8Array` containing one of the supported file formats (all platforms, native byte array or input streams on other platforms) - * A url from where to download the binary data of one of the supported file formats (browser only) - - - The indexes of the tracks from the song that should be rendered. If not provided, the first track of the - song will be shown. - - +"],["token","?"],["whitespace"," "],["identifier","trackIndexes"],["token",")"]]} + kotlin={[["identifier","fun"],["whitespace"," "],["identifier","load"],["token","("],["identifier","scoreData"],["token",":"],["whitespace"," "],["identifier","Any"],["token",","],["whitespace"," "],["identifier","trackIndexes"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.DoubleList"],["token","?"],["token",")"],["token",":"],["whitespace"," "],["identifier","Boolean"]]} +/> + + + + + + + + + + + + + + + + + +
ParameterSummary
+ + + The data container supported by . The supported types is depending on the platform: + + * A `alphaTab.model.Score` instance (all platforms) + * A `ArrayBuffer` or `Uint8Array` containing one of the supported file formats (all platforms, native byte array or input streams on other platforms) + * A url from where to download the binary data of one of the supported file formats (browser only) +
+ + + The indexes of the tracks from the song that should be rendered. If not provided, the first track of the + song will be shown. +
### Returns true if the data object is supported and a load was initiated, otherwise false diff --git a/docs/reference/api/loadmidiforscore.mdx b/docs/reference/api/loadmidiforscore.mdx index 7e502f9..c71f98b 100644 --- a/docs/reference/api/loadmidiforscore.mdx +++ b/docs/reference/api/loadmidiforscore.mdx @@ -1,35 +1,21 @@ --- title: loadMidiForScore -description: "Re-creates the midi for the current score and loads it." sidebar_custom_props: kind: method category: Methods - Player since: 1.6.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Re-creates the midi for the current score and loads it. This will result in the player to stop playback. Some setting changes require re-genration of the midi song. - - -
{"loadMidiForScore"}{"("}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"LoadMidiForScore"}{"("}{")"}
- - -
{"fun"}{" "}{"loadMidiForScore"}{"("}{")"}{":"}{" "}{"Unit"}
- - + diff --git a/docs/reference/api/loadsoundfont.mdx b/docs/reference/api/loadsoundfont.mdx index 92558f8..ecc2de1 100644 --- a/docs/reference/api/loadsoundfont.mdx +++ b/docs/reference/api/loadsoundfont.mdx @@ -1,51 +1,53 @@ --- title: loadSoundFont -description: "Triggers a load of the soundfont from the given data." sidebar_custom_props: kind: method category: Methods - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Triggers a load of the soundfont from the given data. AlphaTab only supports SoundFont2 and SoundFont3 encoded soundfonts for loading. To load a soundfont the player must be enabled in advance. - - -
{"loadSoundFont"}{"("}{"data"}{":"}{" "}{"unknown"}{","}{" "}{"append"}{"?"}{":"}{" "}{"boolean"}{")"}{":"}{" "}{"boolean"}
- - -
{"bool"}{" "}{"LoadSoundFont"}{"("}{"object"}{" "}{"data"}{","}{" "}{"bool"}{"?"}{" "}{"append"}{")"}
- - -
{"fun"}{" "}{"loadSoundFont"}{"("}{"data"}{":"}{" "}{"Any"}{","}{" "}{"append"}{":"}{" "}{"Boolean"}{"?"}{")"}{":"}{" "}{"Boolean"}
- - - - - - - The data object to decode. The supported data types is depending on the platform. - - * A `ArrayBuffer` or `Uint8Array` (all platforms, native byte array or input streams on other platforms) - * A url from where to download the binary data of one of the supported file formats (browser only) - - - Whether to fully replace or append the data from the given soundfont. - - + + + + + + + + + + + + + + + + + + +
ParameterSummary
+ + + The data object to decode. The supported data types is depending on the platform. + + * A `ArrayBuffer` or `Uint8Array` (all platforms, native byte array or input streams on other platforms) + * A url from where to download the binary data of one of the supported file formats (browser only) +
+ + + Whether to fully replace or append the data from the given soundfont. +
### Returns `true` if the passed in object is a supported format and loading was initiated, otherwise `false`. diff --git a/docs/reference/api/loadsoundfontfromurl.mdx b/docs/reference/api/loadsoundfontfromurl.mdx index 4bf6450..f9b8712 100644 --- a/docs/reference/api/loadsoundfontfromurl.mdx +++ b/docs/reference/api/loadsoundfontfromurl.mdx @@ -1,6 +1,5 @@ --- title: loadSoundFontFromUrl -description: "Triggers a load of the soundfont from the given URL." sidebar_custom_props: kind: method javaScriptOnly: true @@ -8,29 +7,40 @@ sidebar_custom_props: since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Triggers a load of the soundfont from the given URL. -
{"loadSoundFontFromUrl"}{"("}{"url"}{":"}{" "}{"string"}{","}{" "}{"append"}{":"}{" "}{"boolean"}{")"}{":"}{" "}{"void"}
- - - - - The URL from which to load the soundfont - - - Whether to fully replace or append the data from the given soundfont. - - + + + + + + + + + + + + + + + + + + +
ParameterSummary
+ + + The URL from which to load the soundfont +
+ + + Whether to fully replace or append the data from the given soundfont. +
diff --git a/docs/reference/api/mastervolume.mdx b/docs/reference/api/mastervolume.mdx index f5f96be..9a7abce 100644 --- a/docs/reference/api/mastervolume.mdx +++ b/docs/reference/api/mastervolume.mdx @@ -1,40 +1,24 @@ --- title: masterVolume -description: "The current master volume as percentage (0-1)." sidebar_custom_props: kind: property category: Properties - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The current master volume as percentage (0-1). Gets or sets the master volume of the overall audio being played. The volume is annotated in percentage where 1.0 would be the normal volume and 0.5 only 50%. - - -
{"masterVolume"}{":"}{" "}{"number"}{";"}
- - -
{"double"}{" "}{"MasterVolume"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"masterVolume"}{":"}{" "}{"Double"}
- - + ## Examples diff --git a/docs/reference/api/metronomevolume.mdx b/docs/reference/api/metronomevolume.mdx index 38c7bdb..6c1aab8 100644 --- a/docs/reference/api/metronomevolume.mdx +++ b/docs/reference/api/metronomevolume.mdx @@ -1,40 +1,24 @@ --- title: metronomeVolume -description: "The metronome volume as percentage (0-1)." sidebar_custom_props: kind: property category: Properties - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The metronome volume as percentage (0-1). Gets or sets the volume of the metronome. By default the metronome is disabled but can be enabled by setting the volume different. - - -
{"metronomeVolume"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}
- - -
{"double"}{" "}{"MetronomeVolume"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}
- - -
{"var"}{" "}{"metronomeVolume"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}
- - + ## Examples diff --git a/docs/reference/api/midieventsplayed.mdx b/docs/reference/api/midieventsplayed.mdx index 6858a13..ecc8e69 100644 --- a/docs/reference/api/midieventsplayed.mdx +++ b/docs/reference/api/midieventsplayed.mdx @@ -1,20 +1,12 @@ --- title: midiEventsPlayed -description: "This event is fired when the synthesizer played certain midi events." sidebar_custom_props: kind: event category: Events - Player since: 1.2.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -27,17 +19,11 @@ Refer to the [related guide](/docs/guides/handling-midi-events) to learn more ab Also note that the provided data models changed significantly in `{@version 1.3.0}`. We try to provide backwards compatibility until some extend but highly encourage changing to the new models in case of problems. - - -
{"readonly"}{" "}{"midiEventsPlayed"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"MidiEventsPlayedEventArgs"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"MidiEventsPlayedEventArgs"}{">"}{" "}{"MidiEventsPlayed"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"midiEventsPlayed"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"MidiEventsPlayedEventArgs"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","MidiEventsPlayedEventArgs","/docs/reference/types/synth/midieventsplayedeventargs"],["token",">"],["whitespace"," "],["identifier","MidiEventsPlayed"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","midiEventsPlayed"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","MidiEventsPlayedEventArgs","/docs/reference/types/synth/midieventsplayedeventargs"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/midieventsplayedfilter.mdx b/docs/reference/api/midieventsplayedfilter.mdx index c85635e..1db8f30 100644 --- a/docs/reference/api/midieventsplayedfilter.mdx +++ b/docs/reference/api/midieventsplayedfilter.mdx @@ -1,24 +1,14 @@ --- title: midiEventsPlayedFilter -description: "The midi events which will trigger the `midiEventsPlayed` event" sidebar_custom_props: kind: property category: Properties - Player since: 1.2.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description @@ -28,17 +18,11 @@ audio playback elements like notes/rests played or metronome ticks. Refer to the [related guide](/docs/guides/handling-midi-events) to learn more about this feature. - - -
{"midiEventsPlayedFilter"}{":"}{" "}{"MidiEventType"}{"[]"}{" "}{"="}{" "}{"[]"}{";"}
- - -
{"IList"}{"<"}{"MidiEventType"}{">"}{" "}{"MidiEventsPlayedFilter"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"[]"}
- - -
{"var"}{" "}{"midiEventsPlayedFilter"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"MidiEventType"}{">"}{" "}{"="}{" "}{"[]"}
- - +"],["whitespace"," "],["identifier","MidiEventsPlayedFilter"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["keyword","set"],["token",";"],["whitespace"," "],["token","}"],["whitespace"," "],["token","="],["whitespace"," "],["identifier","[]"]]} + kotlin={[["keyword","var"],["whitespace"," "],["identifier","midiEventsPlayedFilter"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.List"],["token","<"],["identifier","MidiEventType","/docs/reference/types/midi/midieventtype"],["token",">"],["whitespace"," "],["token","="],["whitespace"," "],["identifier","[]"]]} +/> ## Examples diff --git a/docs/reference/api/midiload.mdx b/docs/reference/api/midiload.mdx index 705d446..65d781c 100644 --- a/docs/reference/api/midiload.mdx +++ b/docs/reference/api/midiload.mdx @@ -1,20 +1,12 @@ --- title: midiLoad -description: "This event is fired when a Midi file is being loaded." sidebar_custom_props: kind: event category: Events - Player since: 1.2.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -28,17 +20,11 @@ of the song. > The generated midi file will NOT contain any metronome and count-in related events. The metronome and > count-in ticks are handled within the synthesizer. - - -
{"midiLoad"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"MidiFile"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"MidiFile"}{">"}{" "}{"MidiLoad"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"midiLoad"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"MidiFile"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","MidiFile","/docs/reference/types/midi/midifile"],["token",">"],["whitespace"," "],["identifier","MidiLoad"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","midiLoad"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","MidiFile","/docs/reference/types/midi/midifile"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/midiloaded.mdx b/docs/reference/api/midiloaded.mdx index 943d989..f15eaea 100644 --- a/docs/reference/api/midiloaded.mdx +++ b/docs/reference/api/midiloaded.mdx @@ -1,37 +1,23 @@ --- title: midiLoaded -description: "This event is fired when the Midi file needed for playback was loaded." sidebar_custom_props: kind: event category: Events - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired when the Midi file needed for playback was loaded. - - -
{"midiLoaded"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PositionChangedEventArgs"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"PositionChangedEventArgs"}{">"}{" "}{"MidiLoaded"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"midiLoaded"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PositionChangedEventArgs"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","PositionChangedEventArgs","/docs/reference/types/synth/positionchangedeventargs"],["token",">"],["whitespace"," "],["identifier","MidiLoaded"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","midiLoaded"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","PositionChangedEventArgs","/docs/reference/types/synth/positionchangedeventargs"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/notemousedown.mdx b/docs/reference/api/notemousedown.mdx index 59e9155..5cbbc73 100644 --- a/docs/reference/api/notemousedown.mdx +++ b/docs/reference/api/notemousedown.mdx @@ -1,39 +1,25 @@ --- title: noteMouseDown -description: "This event is fired whenever a the user presses the mouse button on a note head/number." sidebar_custom_props: kind: event category: Events - Player since: 1.2.3 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired whenever a the user presses the mouse button on a note head/number. This event is fired whenever a the user presses the mouse button on a note. -It is only fired if {"CoreSettings.includeNoteBounds"} was set to `true` because -only then this hit detection can be done. A click on a note is considered if the note head or the note number on tabs are clicked as documented in {"boundsLookup"}. +It is only fired if was set to `true` because +only then this hit detection can be done. A click on a note is considered if the note head or the note number on tabs are clicked as documented in . - - -
{"noteMouseDown"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Note"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"Note"}{">"}{" "}{"NoteMouseDown"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"noteMouseDown"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Note"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Note","/docs/reference/types/model/note"],["token",">"],["whitespace"," "],["identifier","NoteMouseDown"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","noteMouseDown"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Note","/docs/reference/types/model/note"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/notemousemove.mdx b/docs/reference/api/notemousemove.mdx index 4f1835c..fcb8216 100644 --- a/docs/reference/api/notemousemove.mdx +++ b/docs/reference/api/notemousemove.mdx @@ -1,39 +1,25 @@ --- title: noteMouseMove -description: "This event is fired whenever the user moves the mouse over a note after the user already pressed the button on a note." sidebar_custom_props: kind: event category: Events - Player since: 1.2.3 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired whenever the user moves the mouse over a note after the user already pressed the button on a note. This event is fired whenever the user moves the mouse over a note after the user already pressed the button on a note. -It is only fired if {"CoreSettings.includeNoteBounds"} was set to `true` because -only then this hit detection can be done. A click on a note is considered if the note head or the note number on tabs are clicked as documented in {"boundsLookup"} +It is only fired if was set to `true` because +only then this hit detection can be done. A click on a note is considered if the note head or the note number on tabs are clicked as documented in - - -
{"noteMouseMove"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Note"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"Note"}{">"}{" "}{"NoteMouseMove"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"noteMouseMove"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Note"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Note","/docs/reference/types/model/note"],["token",">"],["whitespace"," "],["identifier","NoteMouseMove"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","noteMouseMove"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Note","/docs/reference/types/model/note"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/notemouseup.mdx b/docs/reference/api/notemouseup.mdx index 07ee64c..d6da8d4 100644 --- a/docs/reference/api/notemouseup.mdx +++ b/docs/reference/api/notemouseup.mdx @@ -1,20 +1,12 @@ --- title: noteMouseUp -description: "This event is fired whenever the user releases the mouse after a mouse press on a note." sidebar_custom_props: kind: event category: Events - Player since: 1.2.3 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -22,20 +14,14 @@ import Link from '@docusaurus/Link'; This event is fired whenever the user releases the mouse after a mouse press on a note. This event is fired whenever a the user presses the mouse button on a note. This event is fired regardless of whether the mouse was released on a note. The parameter is null if the mouse was released somewhere beside the note. -It is only fired if {"CoreSettings.includeNoteBounds"} was set to `true` because -only then this hit detection can be done. A click on a note is considered if the note head or the note number on tabs are clicked as documented in the {"boundsLookup"}. +It is only fired if was set to `true` because +only then this hit detection can be done. A click on a note is considered if the note head or the note number on tabs are clicked as documented in the . - - -
{"noteMouseUp"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Note"}{" "}{"|"}{" "}{"null"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"Note"}{"?"}{">"}{" "}{"NoteMouseUp"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"noteMouseUp"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Note"}{"?"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Note","/docs/reference/types/model/note"],["token","?"],["token",">"],["whitespace"," "],["identifier","NoteMouseUp"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","noteMouseUp"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Note","/docs/reference/types/model/note"],["token","?"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/pause.mdx b/docs/reference/api/pause.mdx index efd4e99..6fa8f1d 100644 --- a/docs/reference/api/pause.mdx +++ b/docs/reference/api/pause.mdx @@ -1,37 +1,23 @@ --- title: pause -description: "Pauses the playback of the current song." sidebar_custom_props: kind: method category: Methods - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Pauses the playback of the current song. - - -
{"pause"}{"("}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"Pause"}{"("}{")"}
- - -
{"fun"}{" "}{"pause"}{"("}{")"}{":"}{" "}{"Unit"}
- - + ## Examples diff --git a/docs/reference/api/play.mdx b/docs/reference/api/play.mdx index 8f21c6a..ad0ac86 100644 --- a/docs/reference/api/play.mdx +++ b/docs/reference/api/play.mdx @@ -1,37 +1,23 @@ --- title: play -description: "Starts the playback of the current song." sidebar_custom_props: kind: method category: Methods - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Starts the playback of the current song. - - -
{"play"}{"("}{")"}{":"}{" "}{"boolean"}
- - -
{"bool"}{" "}{"Play"}{"("}{")"}
- - -
{"fun"}{" "}{"play"}{"("}{")"}{":"}{" "}{"Boolean"}
- - + ### Returns true if the playback was started, otherwise false. Reasons for not starting can be that the player is not ready or already playing. diff --git a/docs/reference/api/playbackrange.mdx b/docs/reference/api/playbackrange.mdx index 5a264b1..db75fa1 100644 --- a/docs/reference/api/playbackrange.mdx +++ b/docs/reference/api/playbackrange.mdx @@ -1,40 +1,24 @@ --- title: playbackRange -description: "The range of the song that should be played." sidebar_custom_props: kind: property category: Properties - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The range of the song that should be played. Gets or sets the range of the song that should be played. The range is defined in midi ticks or the whole song is played if the range is set to null - - -
{"playbackRange"}{":"}{" "}{"PlaybackRange"}{" "}{"|"}{" "}{"null"}{" "}{"="}{" "}{"null"}{";"}
- - -
{"PlaybackRange"}{"?"}{" "}{"PlaybackRange"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"null"}
- - -
{"var"}{" "}{"playbackRange"}{":"}{" "}{"PlaybackRange"}{"?"}{" "}{"="}{" "}{"null"}
- - + ## Examples diff --git a/docs/reference/api/playbackrangechanged.mdx b/docs/reference/api/playbackrangechanged.mdx index 8df677d..e1c04eb 100644 --- a/docs/reference/api/playbackrangechanged.mdx +++ b/docs/reference/api/playbackrangechanged.mdx @@ -1,37 +1,23 @@ --- title: playbackRangeChanged -description: "This event is fired when the playback range changed." sidebar_custom_props: kind: event category: Events - Player since: 1.2.3 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired when the playback range changed. - - -
{"readonly"}{" "}{"playbackRangeChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PlaybackRangeChangedEventArgs"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"PlaybackRangeChangedEventArgs"}{">"}{" "}{"PlaybackRangeChanged"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"playbackRangeChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PlaybackRangeChangedEventArgs"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","PlaybackRangeChangedEventArgs","/docs/reference/types/synth/playbackrangechangedeventargs"],["token",">"],["whitespace"," "],["identifier","PlaybackRangeChanged"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","playbackRangeChanged"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","PlaybackRangeChangedEventArgs","/docs/reference/types/synth/playbackrangechangedeventargs"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/playbackspeed.mdx b/docs/reference/api/playbackspeed.mdx index 55ddf5e..fa41a16 100644 --- a/docs/reference/api/playbackspeed.mdx +++ b/docs/reference/api/playbackspeed.mdx @@ -1,40 +1,24 @@ --- title: playbackSpeed -description: "The current playback speed as percentage" sidebar_custom_props: kind: property category: Properties - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The current playback speed as percentage Controls the current playback speed as percentual value. Normal speed is 1.0 (100%) and 0.5 would be 50%. - - -
{"playbackSpeed"}{":"}{" "}{"number"}{" "}{"="}{" "}{"1"}{";"}
- - -
{"double"}{" "}{"PlaybackSpeed"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"1"}
- - -
{"var"}{" "}{"playbackSpeed"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"1"}
- - + ## Examples diff --git a/docs/reference/api/playbeat.mdx b/docs/reference/api/playbeat.mdx index 7fb7852..d1ae8c7 100644 --- a/docs/reference/api/playbeat.mdx +++ b/docs/reference/api/playbeat.mdx @@ -1,20 +1,12 @@ --- title: playBeat -description: "Triggers the play of the given beat." sidebar_custom_props: kind: method category: Methods - Player since: 1.1.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -24,25 +16,30 @@ This method can be used in applications when individual beats need to be played The player will not report any change in state or playback position during the playback of the requested beat. It is a playback of audio separate to the main song playback. - - -
{"playBeat"}{"("}{"beat"}{":"}{" "}{"Beat"}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"PlayBeat"}{"("}{"Beat"}{" "}{"beat"}{")"}
- - -
{"fun"}{" "}{"playBeat"}{"("}{"beat"}{":"}{" "}{"Beat"}{")"}{":"}{" "}{"Unit"}
- - - - - - - the single beat to play - - + + + + + + + + + + + + + + +
ParameterSummary
+ + + the single beat to play +
### Returns true if the playback was started, otherwise false. Reasons for not starting can be that the player is not ready or already playing. diff --git a/docs/reference/api/playedbeatchanged.mdx b/docs/reference/api/playedbeatchanged.mdx index e796c9d..8b09eda 100644 --- a/docs/reference/api/playedbeatchanged.mdx +++ b/docs/reference/api/playedbeatchanged.mdx @@ -1,37 +1,23 @@ --- title: playedBeatChanged -description: "This event is fired when the played beat changed." sidebar_custom_props: kind: event category: Events - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired when the played beat changed. - - -
{"playedBeatChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}{" "}{"PlayedBeatChanged"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"playedBeatChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Beat"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Beat","/docs/reference/types/model/beat"],["token",">"],["whitespace"," "],["identifier","PlayedBeatChanged"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","playedBeatChanged"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Beat","/docs/reference/types/model/beat"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/player.mdx b/docs/reference/api/player.mdx index a3c79f3..eb36e5d 100644 --- a/docs/reference/api/player.mdx +++ b/docs/reference/api/player.mdx @@ -1,41 +1,25 @@ --- title: player -description: "The alphaSynth player used for playback." sidebar_custom_props: kind: property category: Properties - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The alphaSynth player used for playback. This is the low-level API to the Midi synthesizer used for playback. -Gets access to the underling {"IAlphaSynth"} that is used for the audio playback. +Gets access to the underling that is used for the audio playback. - - -
{"readonly"}{" "}{"player"}{":"}{" "}{"IAlphaSynth"}{" "}{"|"}{" "}{"null"}{";"}
- - -
{"IAlphaSynth"}{"?"}{" "}{"Player"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"player"}{":"}{" "}{"IAlphaSynth"}{"?"}
- - + ## Examples diff --git a/docs/reference/api/playerfinished.mdx b/docs/reference/api/playerfinished.mdx index e40181c..d1af608 100644 --- a/docs/reference/api/playerfinished.mdx +++ b/docs/reference/api/playerfinished.mdx @@ -1,37 +1,23 @@ --- title: playerFinished -description: "This event is fired when the playback of the whole song finished." sidebar_custom_props: kind: event category: Events - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired when the playback of the whole song finished. This event is finished regardless on whether looping is enabled or not. - - -
{"readonly"}{" "}{"playerFinished"}{":"}{" "}{"IEventEmitter"}{";"}
- - -
{"IEventEmitter"}{" "}{"PlayerFinished"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"playerFinished"}{":"}{" "}{"IEventEmitter"}
- - + ## Examples diff --git a/docs/reference/api/playerpositionchanged.mdx b/docs/reference/api/playerpositionchanged.mdx index 611424a..7d60078 100644 --- a/docs/reference/api/playerpositionchanged.mdx +++ b/docs/reference/api/playerpositionchanged.mdx @@ -1,37 +1,23 @@ --- title: playerPositionChanged -description: "This event is fired when the current playback position of the song changed." sidebar_custom_props: kind: event category: Events - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired when the current playback position of the song changed. - - -
{"readonly"}{" "}{"playerPositionChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PositionChangedEventArgs"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"PositionChangedEventArgs"}{">"}{" "}{"PlayerPositionChanged"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"playerPositionChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PositionChangedEventArgs"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","PositionChangedEventArgs","/docs/reference/types/synth/positionchangedeventargs"],["token",">"],["whitespace"," "],["identifier","PlayerPositionChanged"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","playerPositionChanged"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","PositionChangedEventArgs","/docs/reference/types/synth/positionchangedeventargs"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/playerready.mdx b/docs/reference/api/playerready.mdx index 98dcc77..a6a7f5f 100644 --- a/docs/reference/api/playerready.mdx +++ b/docs/reference/api/playerready.mdx @@ -1,20 +1,12 @@ --- title: playerReady -description: "This event is fired when all required data for playback is loaded and ready." sidebar_custom_props: kind: event category: Events - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -22,17 +14,11 @@ import Link from '@docusaurus/Link'; This event is fired when all required data for playback is loaded and ready. This event is fired when all required data for playback is loaded and ready. The player is ready for playback when all background workers are started, the audio output is initialized, a soundfont is loaded, and a song was loaded into the player as midi file. - - -
{"readonly"}{" "}{"playerReady"}{":"}{" "}{"IEventEmitter"}{";"}
- - -
{"IEventEmitter"}{" "}{"PlayerReady"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"playerReady"}{":"}{" "}{"IEventEmitter"}
- - + ## Examples diff --git a/docs/reference/api/playerstate.mdx b/docs/reference/api/playerstate.mdx index 3bf4a17..ae56c24 100644 --- a/docs/reference/api/playerstate.mdx +++ b/docs/reference/api/playerstate.mdx @@ -1,40 +1,24 @@ --- title: playerState -description: "The current player state." sidebar_custom_props: kind: property category: Properties - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The current player state. Gets the current player state, meaning whether it is paused or playing. - - -
{"readonly"}{" "}{"playerState"}{":"}{" "}{"PlayerState"}{";"}
- - -
{"PlayerState"}{" "}{"PlayerState"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"playerState"}{":"}{" "}{"PlayerState"}
- - + ## Examples diff --git a/docs/reference/api/playerstatechanged.mdx b/docs/reference/api/playerstatechanged.mdx index 6aba476..fcdcd46 100644 --- a/docs/reference/api/playerstatechanged.mdx +++ b/docs/reference/api/playerstatechanged.mdx @@ -1,37 +1,23 @@ --- title: playerStateChanged -description: "This event is fired when the playback state changed." sidebar_custom_props: kind: event category: Events - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired when the playback state changed. - - -
{"readonly"}{" "}{"playerStateChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PlayerStateChangedEventArgs"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"PlayerStateChangedEventArgs"}{">"}{" "}{"PlayerStateChanged"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"playerStateChanged"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"PlayerStateChangedEventArgs"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","PlayerStateChangedEventArgs","/docs/reference/types/synth/playerstatechangedeventargs"],["token",">"],["whitespace"," "],["identifier","PlayerStateChanged"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","playerStateChanged"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","PlayerStateChangedEventArgs","/docs/reference/types/synth/playerstatechangedeventargs"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/playnote.mdx b/docs/reference/api/playnote.mdx index aec6bfa..ae3f643 100644 --- a/docs/reference/api/playnote.mdx +++ b/docs/reference/api/playnote.mdx @@ -1,20 +1,12 @@ --- title: playNote -description: "Triggers the play of the given note." sidebar_custom_props: kind: method category: Methods - Player since: 1.1.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -24,25 +16,30 @@ This method can be used in applications when individual notes need to be played The player will not report any change in state or playback position during the playback of the requested note. It is a playback of audio separate to the main song playback. - - -
{"playNote"}{"("}{"note"}{":"}{" "}{"Note"}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"PlayNote"}{"("}{"Note"}{" "}{"note"}{")"}
- - -
{"fun"}{" "}{"playNote"}{"("}{"note"}{":"}{" "}{"Note"}{")"}{":"}{" "}{"Unit"}
- - - - - - - the single note to play - - + + + + + + + + + + + + + + +
ParameterSummary
+ + + the single note to play +
## Examples diff --git a/docs/reference/api/playpause.mdx b/docs/reference/api/playpause.mdx index c02303c..43af287 100644 --- a/docs/reference/api/playpause.mdx +++ b/docs/reference/api/playpause.mdx @@ -1,37 +1,23 @@ --- title: playPause -description: "Toggles between play/pause depending on the current player state." sidebar_custom_props: kind: method category: Methods - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Toggles between play/pause depending on the current player state. If the player was playing, it will pause. If it is paused, it will initiate a play. - - -
{"playPause"}{"("}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"PlayPause"}{"("}{")"}
- - -
{"fun"}{" "}{"playPause"}{"("}{")"}{":"}{" "}{"Unit"}
- - + ## Examples diff --git a/docs/reference/api/postrenderfinished.mdx b/docs/reference/api/postrenderfinished.mdx index 1708e5a..d94cb5a 100644 --- a/docs/reference/api/postrenderfinished.mdx +++ b/docs/reference/api/postrenderfinished.mdx @@ -1,41 +1,27 @@ --- title: postRenderFinished -description: "This event is fired when the rendering of the whole music sheet is finished, and all handlers of `renderFinished` ran." sidebar_custom_props: kind: event category: Events - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description -This event is fired when the rendering of the whole music sheet is finished, and all handlers of `renderFinished` ran. If {"CoreSettings.enableLazyLoading"} is enabled not all partial images of the music sheet might be rendered. +This event is fired when the rendering of the whole music sheet is finished, and all handlers of `renderFinished` ran. If is enabled not all partial images of the music sheet might be rendered. In this case the `renderFinished` event rather represents that the whole music sheet has been layouted and arranged and every partial image can be requested for rendering. If you neeed more fine-grained access -to the actual layouting and rendering progress, you need to look at the low-level apis {"partialLayoutFinished"} and -{"partialRenderFinished"} accessible via {"renderer"}. +to the actual layouting and rendering progress, you need to look at the low-level apis and + accessible via . - - -
{"postRenderFinished"}{":"}{" "}{"IEventEmitter"}{";"}
- - -
{"IEventEmitter"}{" "}{"PostRenderFinished"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"postRenderFinished"}{":"}{" "}{"IEventEmitter"}
- - + ## Examples diff --git a/docs/reference/api/print.mdx b/docs/reference/api/print.mdx index 44e4ec7..7cda270 100644 --- a/docs/reference/api/print.mdx +++ b/docs/reference/api/print.mdx @@ -1,6 +1,5 @@ --- title: print -description: "Opens a popup window with the rendered music notation for printing." sidebar_custom_props: kind: method javaScriptOnly: true @@ -8,14 +7,7 @@ sidebar_custom_props: since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -29,18 +21,36 @@ This function opens a popup window which is filled with a by-default A4 optimize * The stretch force is reduced to 0.8 * The width is optimized to A4. Portrait if the page-layout is used, landscape if the horizontal-layout is used. -
{"print"}{"("}{"width"}{"?"}{":"}{" "}{"string"}{","}{" "}{"additionalSettings"}{"?"}{":"}{" "}{"unknown"}{")"}{":"}{" "}{"void"}
- - - - - An optional custom width as CSS width that should be used. Best is to use a CSS width that is suitable for your preferred page size. - - - An optional parameter to specify additional setting values which should be respected during printing () - - - + + + + + + + + + + + + + + + + + + + +
ParameterSummary
+ + + An optional custom width as CSS width that should be used. Best is to use a CSS width that is suitable for your preferred page size. +
+ + + An optional parameter to specify additional setting values which should be respected during printing () +
## Example - JavaScript diff --git a/docs/reference/api/render.mdx b/docs/reference/api/render.mdx index 2255c8a..a43023f 100644 --- a/docs/reference/api/render.mdx +++ b/docs/reference/api/render.mdx @@ -1,37 +1,23 @@ --- title: render -description: "Initiates a re-rendering of the current setup." sidebar_custom_props: kind: method category: Methods - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Initiates a re-rendering of the current setup. If rendering is not yet possible, it will be deferred until the UI changes to be ready for rendering. - - -
{"render"}{"("}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"Render"}{"("}{")"}
- - -
{"fun"}{" "}{"render"}{"("}{")"}{":"}{" "}{"Unit"}
- - + ## Examples diff --git a/docs/reference/api/renderer.mdx b/docs/reference/api/renderer.mdx index e614270..834e5e5 100644 --- a/docs/reference/api/renderer.mdx +++ b/docs/reference/api/renderer.mdx @@ -1,39 +1,23 @@ --- title: renderer -description: "The score renderer used for rendering the music sheet." sidebar_custom_props: kind: property category: Properties - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The score renderer used for rendering the music sheet. This is the low-level API responsible for the actual rendering engine. -Gets access to the underling {"IScoreRenderer"} that is used for the rendering. +Gets access to the underling that is used for the rendering. - - -
{"readonly"}{" "}{"renderer"}{":"}{" "}{"IScoreRenderer"}{";"}
- - -
{"IScoreRenderer"}{" "}{"Renderer"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"renderer"}{":"}{" "}{"IScoreRenderer"}
- - + diff --git a/docs/reference/api/renderfinished.mdx b/docs/reference/api/renderfinished.mdx index 3724e69..076cbdb 100644 --- a/docs/reference/api/renderfinished.mdx +++ b/docs/reference/api/renderfinished.mdx @@ -1,20 +1,12 @@ --- title: renderFinished -description: "This event is fired when the rendering of the whole music sheet is finished." sidebar_custom_props: kind: event category: Events - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -22,17 +14,11 @@ import Link from '@docusaurus/Link'; This event is fired when the rendering of the whole music sheet is finished. This event is fired when the rendering of the whole music sheet is finished from the render engine side. There might be still tasks open for the display component to visually display the rendered components when this event is notified (e.g. resizing of DOM elements are done). - - -
{"renderFinished"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"RenderFinishedEventArgs"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"RenderFinishedEventArgs"}{">"}{" "}{"RenderFinished"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"renderFinished"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"RenderFinishedEventArgs"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","RenderFinishedEventArgs","/docs/reference/types/rendering/renderfinishedeventargs"],["token",">"],["whitespace"," "],["identifier","RenderFinished"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","renderFinished"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","RenderFinishedEventArgs","/docs/reference/types/rendering/renderfinishedeventargs"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/renderscore.mdx b/docs/reference/api/renderscore.mdx index 8ddb3dd..c95b685 100644 --- a/docs/reference/api/renderscore.mdx +++ b/docs/reference/api/renderscore.mdx @@ -1,49 +1,51 @@ --- title: renderScore -description: "Initiates a rendering of the given score." sidebar_custom_props: kind: method category: Methods - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Initiates a rendering of the given score. - - -
{"renderScore"}{"("}{"score"}{":"}{" "}{"Score"}{","}{" "}{"trackIndexes"}{"?"}{":"}{" "}{"number"}{"[]"}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"RenderScore"}{"("}{"Score"}{" "}{"score"}{","}{" "}{"IList"}{"<"}{"double"}{">"}{"?"}{" "}{"trackIndexes"}{")"}
- - -
{"fun"}{" "}{"renderScore"}{"("}{"score"}{":"}{" "}{"Score"}{","}{" "}{"trackIndexes"}{":"}{" "}{"alphaTab.collections.DoubleList"}{"?"}{")"}{":"}{" "}{"Unit"}
- - - - - - - The score containing the tracks to be rendered. - - - The indexes of the tracks from the song that should be rendered. If not provided, the first track of the - song will be shown. - - +"],["token","?"],["whitespace"," "],["identifier","trackIndexes"],["token",")"]]} + kotlin={[["identifier","fun"],["whitespace"," "],["identifier","renderScore"],["token","("],["identifier","score"],["token",":"],["whitespace"," "],["identifier","Score","/docs/reference/types/model/score"],["token",","],["whitespace"," "],["identifier","trackIndexes"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.DoubleList"],["token","?"],["token",")"],["token",":"],["whitespace"," "],["identifier","Unit"]]} +/> + + + + + + + + + + + + + + + + + +
ParameterSummary
+ + + The score containing the tracks to be rendered. +
+ + + The indexes of the tracks from the song that should be rendered. If not provided, the first track of the + song will be shown. +
## Examples diff --git a/docs/reference/api/renderstarted.mdx b/docs/reference/api/renderstarted.mdx index ddd0a09..95959e4 100644 --- a/docs/reference/api/renderstarted.mdx +++ b/docs/reference/api/renderstarted.mdx @@ -1,37 +1,23 @@ --- title: renderStarted -description: "This event is fired when the rendering of the whole music sheet is starting." sidebar_custom_props: kind: event category: Events - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired when the rendering of the whole music sheet is starting. All preparations are completed and the layout and render sequence is about to start. - - -
{"renderStarted"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"boolean"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"bool"}{">"}{" "}{"RenderStarted"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"renderStarted"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Boolean"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","bool"],["token",">"],["whitespace"," "],["identifier","RenderStarted"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","renderStarted"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Boolean"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/rendertracks.mdx b/docs/reference/api/rendertracks.mdx index b1becbf..bdb0c56 100644 --- a/docs/reference/api/rendertracks.mdx +++ b/docs/reference/api/rendertracks.mdx @@ -1,45 +1,42 @@ --- title: renderTracks -description: "Renders the given list of tracks." sidebar_custom_props: kind: method category: Methods - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Renders the given list of tracks. - - -
{"renderTracks"}{"("}{"tracks"}{":"}{" "}{"Track"}{"[]"}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"RenderTracks"}{"("}{"IList"}{"<"}{"Track"}{">"}{" "}{"tracks"}{")"}
- - -
{"fun"}{" "}{"renderTracks"}{"("}{"tracks"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"Track"}{">"}{")"}{":"}{" "}{"Unit"}
- - - - - - - The tracks to render. They must all belong to the same score. - - +"],["whitespace"," "],["identifier","tracks"],["token",")"]]} + kotlin={[["identifier","fun"],["whitespace"," "],["identifier","renderTracks"],["token","("],["identifier","tracks"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.List"],["token","<"],["identifier","Track","/docs/reference/types/model/track"],["token",">"],["token",")"],["token",":"],["whitespace"," "],["identifier","Unit"]]} +/> + + + + + + + + + + + + + +
ParameterSummary
+ + + The tracks to render. They must all belong to the same score. +
## Examples diff --git a/docs/reference/api/resetsoundfonts.mdx b/docs/reference/api/resetsoundfonts.mdx index cb6b79f..3130724 100644 --- a/docs/reference/api/resetsoundfonts.mdx +++ b/docs/reference/api/resetsoundfonts.mdx @@ -1,20 +1,12 @@ --- title: resetSoundFonts -description: "Unloads all presets from previously loaded SoundFonts." sidebar_custom_props: kind: method category: Methods - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -23,17 +15,11 @@ Unloads all presets from previously loaded SoundFonts. This function resets the if multiple partial SoundFonts are loaded via `loadSoundFont(..., true)`. Depending on the workflow you might also just want to use `loadSoundFont(..., false)` once instead of unloading the previous SoundFonts. - - -
{"resetSoundFonts"}{"("}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"ResetSoundFonts"}{"("}{")"}
- - -
{"fun"}{" "}{"resetSoundFonts"}{"("}{")"}{":"}{" "}{"Unit"}
- - + ## Examples diff --git a/docs/reference/api/resize.mdx b/docs/reference/api/resize.mdx index 000c859..ab7287b 100644 --- a/docs/reference/api/resize.mdx +++ b/docs/reference/api/resize.mdx @@ -1,20 +1,12 @@ --- title: resize -description: "This event is fired when alphaTab was resized and is about to rerender the music notation." sidebar_custom_props: kind: event category: Events - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' @@ -23,17 +15,11 @@ This event is fired when alphaTab was resized and is about to rerender the music the settings will be updated in the related components. This means that any changes to the layout options or other display settings are considered. This allows to implement scenarios where maybe the scale or the layout mode dynamically changes along the resizing. - - -
{"resize"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"ResizeEventArgs"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"ResizeEventArgs"}{">"}{" "}{"Resize"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"resize"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"ResizeEventArgs"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","ResizeEventArgs","/docs/reference/types/resizeeventargs"],["token",">"],["whitespace"," "],["identifier","Resize"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","resize"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","ResizeEventArgs","/docs/reference/types/resizeeventargs"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/score.mdx b/docs/reference/api/score.mdx index edb5813..8b25460 100644 --- a/docs/reference/api/score.mdx +++ b/docs/reference/api/score.mdx @@ -1,40 +1,24 @@ --- title: score -description: "The score holding all information about the song being rendered" sidebar_custom_props: kind: property category: Properties - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The score holding all information about the song being rendered - - -
{"readonly"}{" "}{"score"}{":"}{" "}{"Score"}{" "}{"|"}{" "}{"null"}{";"}
- - -
{"Score"}{"?"}{" "}{"Score"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"score"}{":"}{" "}{"Score"}{"?"}
- - + ## Examples diff --git a/docs/reference/api/scoreloaded.mdx b/docs/reference/api/scoreloaded.mdx index 4884564..c1c0f61 100644 --- a/docs/reference/api/scoreloaded.mdx +++ b/docs/reference/api/scoreloaded.mdx @@ -1,39 +1,25 @@ --- title: scoreLoaded -description: "This event is fired whenever a new song is loaded." sidebar_custom_props: kind: event category: Events - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description -This event is fired whenever a new song is loaded. This event is fired whenever a new song is loaded or changing due to {"renderScore"} or {"renderTracks"} calls. +This event is fired whenever a new song is loaded. This event is fired whenever a new song is loaded or changing due to or calls. It is fired after the transposition midi pitches from the settings were applied, but before any midi is generated or rendering is started. This allows any modification of the score before further processing. - - -
{"scoreLoaded"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Score"}{">"}{";"}
- - -
{"IEventEmitterOfT"}{"<"}{"Score"}{">"}{" "}{"ScoreLoaded"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"scoreLoaded"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"Score"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Score","/docs/reference/types/model/score"],["token",">"],["whitespace"," "],["identifier","ScoreLoaded"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","scoreLoaded"],["token",":"],["whitespace"," "],["identifier","IEventEmitterOfT","/docs/reference/types/ieventemitteroft"],["token","<"],["identifier","Score","/docs/reference/types/model/score"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/scrolltocursor.mdx b/docs/reference/api/scrolltocursor.mdx index 5021da6..af6e90f 100644 --- a/docs/reference/api/scrolltocursor.mdx +++ b/docs/reference/api/scrolltocursor.mdx @@ -1,35 +1,21 @@ --- title: scrollToCursor -description: "Initiates a scroll to the cursor." sidebar_custom_props: kind: method category: Methods - Player since: 1.2.3 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Initiates a scroll to the cursor. - - -
{"scrollToCursor"}{"("}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"ScrollToCursor"}{"("}{")"}
- - -
{"fun"}{" "}{"scrollToCursor"}{"("}{")"}{":"}{" "}{"Unit"}
- - + diff --git a/docs/reference/api/setoutputdevice.mdx b/docs/reference/api/setoutputdevice.mdx index 78c1fac..9472850 100644 --- a/docs/reference/api/setoutputdevice.mdx +++ b/docs/reference/api/setoutputdevice.mdx @@ -1,47 +1,44 @@ --- title: setOutputDevice -description: "Changes the output device which should be used for playing the audio (player must be enabled)." sidebar_custom_props: kind: method category: Methods - Player since: 1.5.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description -Changes the output device which should be used for playing the audio (player must be enabled). Use {"enumerateOutputDevices"} to load the list of available devices. +Changes the output device which should be used for playing the audio (player must be enabled). Use to load the list of available devices. In the web version this functionality relies on experimental APIs and might not yet be available in all browsers. https://caniuse.com/mdn-api_audiocontext_sinkid - - -
{"setOutputDevice"}{"("}{"device"}{":"}{" "}{"ISynthOutputDevice"}{" "}{"|"}{" "}{"null"}{")"}{":"}{" "}{"Promise"}{"<"}{"void"}{">"}
- - -
{"System.Threading.Task"}{"<"}{"void"}{">"}{" "}{"SetOutputDevice"}{"("}{"ISynthOutputDevice"}{"?"}{" "}{"device"}{")"}
- - -
{"suspend"}{" "}{"fun"}{" "}{"setOutputDevice"}{"("}{"device"}{":"}{" "}{"ISynthOutputDevice"}{"?"}{")"}{":"}{" "}{"Unit"}
- - - - - - - The output device to use, or null to switch to the default device. - - +"]]} + csharp={[["identifier","System.Threading.Task","https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1"],["token","<"],["keyword","void"],["token",">"],["whitespace"," "],["identifier","SetOutputDevice"],["token","("],["identifier","ISynthOutputDevice","/docs/reference/types/synth/isynthoutputdevice"],["token","?"],["whitespace"," "],["identifier","device"],["token",")"]]} + kotlin={[["identifier","suspend"],["whitespace"," "],["identifier","fun"],["whitespace"," "],["identifier","setOutputDevice"],["token","("],["identifier","device"],["token",":"],["whitespace"," "],["identifier","ISynthOutputDevice","/docs/reference/types/synth/isynthoutputdevice"],["token","?"],["token",")"],["token",":"],["whitespace"," "],["identifier","Unit"]]} +/> + + + + + + + + + + + + + +
ParameterSummary
+ + + The output device to use, or null to switch to the default device. +
## Examples diff --git a/docs/reference/api/settings.mdx b/docs/reference/api/settings.mdx index b2096c9..562f66b 100644 --- a/docs/reference/api/settings.mdx +++ b/docs/reference/api/settings.mdx @@ -1,40 +1,24 @@ --- title: settings -description: "The settings that are used for rendering the music notation." sidebar_custom_props: kind: property category: Properties - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description -The settings that are used for rendering the music notation. Gets access to the underling {"Settings"} object that is currently used by alphaTab. +The settings that are used for rendering the music notation. Gets access to the underling object that is currently used by alphaTab. - - -
{"settings"}{":"}{" "}{"Settings"}{";"}
- - -
{"Settings"}{" "}{"Settings"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"settings"}{":"}{" "}{"Settings"}
- - + ## Examples diff --git a/docs/reference/api/settingsupdated.mdx b/docs/reference/api/settingsupdated.mdx index 621deab..ac22e9d 100644 --- a/docs/reference/api/settingsupdated.mdx +++ b/docs/reference/api/settingsupdated.mdx @@ -1,37 +1,23 @@ --- title: settingsUpdated -description: "This event is fired when a settings update was requested." sidebar_custom_props: kind: event category: Events - Core since: 1.6.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired when a settings update was requested. - - -
{"settingsUpdated"}{":"}{" "}{"IEventEmitter"}{";"}
- - -
{"IEventEmitter"}{" "}{"SettingsUpdated"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"settingsUpdated"}{":"}{" "}{"IEventEmitter"}
- - + ## Examples diff --git a/docs/reference/api/soundfontload.mdx b/docs/reference/api/soundfontload.mdx index 8714d5a..fc43611 100644 --- a/docs/reference/api/soundfontload.mdx +++ b/docs/reference/api/soundfontload.mdx @@ -1,6 +1,5 @@ --- title: soundFontLoad -description: "This event is fired when the SoundFont is being loaded." sidebar_custom_props: kind: event javaScriptOnly: true @@ -8,21 +7,16 @@ sidebar_custom_props: since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired when the SoundFont is being loaded. This event is fired when the SoundFont is being loaded and reports the progress accordingly. -
{"soundFontLoad"}{":"}{" "}{"IEventEmitterOfT"}{"<"}{"ProgressEventArgs"}{">"}{";"}
+"],["token",";"]]} +/> ## Example - JavaScript diff --git a/docs/reference/api/soundfontloaded.mdx b/docs/reference/api/soundfontloaded.mdx index 785845e..9de8fe2 100644 --- a/docs/reference/api/soundfontloaded.mdx +++ b/docs/reference/api/soundfontloaded.mdx @@ -1,37 +1,23 @@ --- title: soundFontLoaded -description: "This event is fired when the SoundFont needed for playback was loaded." sidebar_custom_props: kind: event category: Events - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description This event is fired when the SoundFont needed for playback was loaded. - - -
{"readonly"}{" "}{"soundFontLoaded"}{":"}{" "}{"IEventEmitter"}{";"}
- - -
{"IEventEmitter"}{" "}{"SoundFontLoaded"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"soundFontLoaded"}{":"}{" "}{"IEventEmitter"}
- - + ## Examples diff --git a/docs/reference/api/stop.mdx b/docs/reference/api/stop.mdx index 955737d..e51f12c 100644 --- a/docs/reference/api/stop.mdx +++ b/docs/reference/api/stop.mdx @@ -1,37 +1,23 @@ --- title: stop -description: "Stops the playback of the current song, and moves the playback position back to the start." sidebar_custom_props: kind: method category: Methods - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Stops the playback of the current song, and moves the playback position back to the start. If a dedicated playback range is selected, it will move the playback position to the start of this range, not the whole song. - - -
{"stop"}{"("}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"Stop"}{"("}{")"}
- - -
{"fun"}{" "}{"stop"}{"("}{")"}{":"}{" "}{"Unit"}
- - + ## Examples diff --git a/docs/reference/api/tex.mdx b/docs/reference/api/tex.mdx index 399b5b8..e846b00 100644 --- a/docs/reference/api/tex.mdx +++ b/docs/reference/api/tex.mdx @@ -1,48 +1,50 @@ --- title: tex -description: "Tells alphaTab to render the given alphaTex." sidebar_custom_props: kind: method category: Methods - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Tells alphaTab to render the given alphaTex. - - -
{"tex"}{"("}{"tex"}{":"}{" "}{"string"}{","}{" "}{"tracks"}{"?"}{":"}{" "}{"number"}{"[]"}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"Tex"}{"("}{"string"}{" "}{"tex"}{","}{" "}{"IList"}{"<"}{"double"}{">"}{"?"}{" "}{"tracks"}{")"}
- - -
{"fun"}{" "}{"tex"}{"("}{"tex"}{":"}{" "}{"String"}{","}{" "}{"tracks"}{":"}{" "}{"alphaTab.collections.DoubleList"}{"?"}{")"}{":"}{" "}{"Unit"}
- - - - - - - The alphaTex code to render. - - - If set, the given tracks will be rendered, otherwise the first track only will be rendered. - - +"],["token","?"],["whitespace"," "],["identifier","tracks"],["token",")"]]} + kotlin={[["identifier","fun"],["whitespace"," "],["identifier","tex"],["token","("],["identifier","tex"],["token",":"],["whitespace"," "],["identifier","String"],["token",","],["whitespace"," "],["identifier","tracks"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.DoubleList"],["token","?"],["token",")"],["token",":"],["whitespace"," "],["identifier","Unit"]]} +/> + + + + + + + + + + + + + + + + + +
ParameterSummary
+ + + The alphaTex code to render. +
+ + + If set, the given tracks will be rendered, otherwise the first track only will be rendered. +
## Examples diff --git a/docs/reference/api/tickcache.mdx b/docs/reference/api/tickcache.mdx index 2019c06..19b6b74 100644 --- a/docs/reference/api/tickcache.mdx +++ b/docs/reference/api/tickcache.mdx @@ -1,44 +1,28 @@ --- title: tickCache -description: "The tick cache allowing lookup of midi ticks to beats." sidebar_custom_props: kind: property category: Properties - Player since: 1.2.3 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The tick cache allowing lookup of midi ticks to beats. Gets the tick cache allowing lookup of midi ticks to beats. If the player is enabled, a midi file will be generated -for the loaded {"Score"} for later playback. During this generation this tick cache is filled with the +for the loaded for later playback. During this generation this tick cache is filled with the exact midi ticks when beats are played. -The {"findBeat"} method allows a lookup of the beat related to a given input midi tick. +The method allows a lookup of the beat related to a given input midi tick. - - -
{"readonly"}{" "}{"tickCache"}{":"}{" "}{"MidiTickLookup"}{" "}{"|"}{" "}{"null"}{";"}
- - -
{"MidiTickLookup"}{"?"}{" "}{"TickCache"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"tickCache"}{":"}{" "}{"MidiTickLookup"}{"?"}
- - + ## Examples diff --git a/docs/reference/api/tickposition.mdx b/docs/reference/api/tickposition.mdx index 3e6f250..b3e6f35 100644 --- a/docs/reference/api/tickposition.mdx +++ b/docs/reference/api/tickposition.mdx @@ -1,40 +1,24 @@ --- title: tickPosition -description: "The position within the song in midi ticks." sidebar_custom_props: kind: property category: Properties - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The position within the song in midi ticks. - - -
{"tickPosition"}{":"}{" "}{"number"}{";"}
- - -
{"double"}{" "}{"TickPosition"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"tickPosition"}{":"}{" "}{"Double"}
- - + ## Examples diff --git a/docs/reference/api/timeposition.mdx b/docs/reference/api/timeposition.mdx index c4aa66b..83985b4 100644 --- a/docs/reference/api/timeposition.mdx +++ b/docs/reference/api/timeposition.mdx @@ -1,40 +1,24 @@ --- title: timePosition -description: "The position within the song in milliseconds" sidebar_custom_props: kind: property category: Properties - Player since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The position within the song in milliseconds - - -
{"timePosition"}{":"}{" "}{"number"}{";"}
- - -
{"double"}{" "}{"TimePosition"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}
- - -
{"var"}{" "}{"timePosition"}{":"}{" "}{"Double"}
- - + ## Examples diff --git a/docs/reference/api/tracks.mdx b/docs/reference/api/tracks.mdx index e0ae573..c6ea29b 100644 --- a/docs/reference/api/tracks.mdx +++ b/docs/reference/api/tracks.mdx @@ -1,40 +1,24 @@ --- title: tracks -description: "The list of the tracks that are currently rendered." sidebar_custom_props: kind: property category: Properties - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The list of the tracks that are currently rendered. - - -
{"readonly"}{" "}{"tracks"}{":"}{" "}{"Track"}{"[]"}{";"}
- - -
{"IList"}{"<"}{"Track"}{">"}{" "}{"Tracks"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"tracks"}{":"}{" "}{"alphaTab.collections.List"}{"<"}{"Track"}{">"}
- - +"],["whitespace"," "],["identifier","Tracks"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","tracks"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.List"],["token","<"],["identifier","Track","/docs/reference/types/model/track"],["token",">"]]} +/> ## Examples diff --git a/docs/reference/api/uifacade.mdx b/docs/reference/api/uifacade.mdx index 8b39341..2695d31 100644 --- a/docs/reference/api/uifacade.mdx +++ b/docs/reference/api/uifacade.mdx @@ -1,38 +1,22 @@ --- title: uiFacade -description: "The UI facade used for interacting with the user interface (like the browser)." sidebar_custom_props: kind: property category: Properties - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { PropertyDescription } from '@site/src/components/PropertyDescription'; - ### Description The UI facade used for interacting with the user interface (like the browser). The implementation depends on the platform alphaTab is running in (e.g. the web version in the browser, WPF in .net etc.) - - -
{"readonly"}{" "}{"uiFacade"}{":"}{" "}{"IUiFacade"}{"<"}{"TSettings"}{">"}{";"}
- - -
{"IUiFacade"}{"<"}{"TSettings"}{">"}{" "}{"UiFacade"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"uiFacade"}{":"}{" "}{"IUiFacade"}{"<"}{"TSettings"}{">"}
- - +"],["token",";"]]} + csharp={[["identifier","IUiFacade","/docs/reference/types/platform/iuifacade"],["token","<"],["identifier","TSettings"],["token",">"],["whitespace"," "],["identifier","UiFacade"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["token","}"]]} + kotlin={[["keyword","val"],["whitespace"," "],["identifier","uiFacade"],["token",":"],["whitespace"," "],["identifier","IUiFacade","/docs/reference/types/platform/iuifacade"],["token","<"],["identifier","TSettings"],["token",">"]]} +/> diff --git a/docs/reference/api/updatesettings.mdx b/docs/reference/api/updatesettings.mdx index 94f79a7..5e587c3 100644 --- a/docs/reference/api/updatesettings.mdx +++ b/docs/reference/api/updatesettings.mdx @@ -1,39 +1,25 @@ --- title: updateSettings -description: "Applies any changes that were done to the settings object." sidebar_custom_props: kind: method category: Methods - Core since: 0.9.4 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description -Applies any changes that were done to the settings object. It also informs the {"renderer"} about any new values to consider. +Applies any changes that were done to the settings object. It also informs the about any new values to consider. By default alphaTab will not trigger any re-rendering or settings update just if the settings object itself was changed. This method must be called -to trigger an update of the settings in all components. Then a re-rendering can be initiated using the {"render"} method. +to trigger an update of the settings in all components. Then a re-rendering can be initiated using the method. - - -
{"updateSettings"}{"("}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"UpdateSettings"}{"("}{")"}
- - -
{"fun"}{" "}{"updateSettings"}{"("}{")"}{":"}{" "}{"Unit"}
- - + ## Examples diff --git a/docs/reference/api/updatesyncpoints.mdx b/docs/reference/api/updatesyncpoints.mdx index 4ba7fcc..f612a6b 100644 --- a/docs/reference/api/updatesyncpoints.mdx +++ b/docs/reference/api/updatesyncpoints.mdx @@ -1,35 +1,21 @@ --- title: updateSyncPoints -description: "Triggers an update of the sync points for the current score after modification within the data model" sidebar_custom_props: kind: method category: Methods - Player since: 1.6.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature } from '@site/src/reference-commons' ### Description Triggers an update of the sync points for the current score after modification within the data model - - -
{"updateSyncPoints"}{"("}{")"}{":"}{" "}{"void"}
- - -
{"void"}{" "}{"UpdateSyncPoints"}{"("}{")"}
- - -
{"fun"}{" "}{"updateSyncPoints"}{"("}{")"}{":"}{" "}{"Unit"}
- - + diff --git a/docs/reference/settings.mdx b/docs/reference/settings.mdx index 7123647..2cc0b4c 100644 --- a/docs/reference/settings.mdx +++ b/docs/reference/settings.mdx @@ -2,8 +2,6 @@ title: Settings --- -import { ReferenceTable } from '@site/src/components/ReferenceTable'; - This section contains a list of all properties that allow configuration of the alphaTab behavior. There are multiple ways how settings in alphaTab can be specified. For .net, the normal classes are used and @@ -33,6 +31,7 @@ The following table contains all the properties as they can be set on the genera For take of simplicity the table lists the properties with the JavaScript naming convention, but if properties are listed with `all` they are available on all platforms (e.g. in C# with PascalCase). -import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; - \ No newline at end of file +import ReferenceTable from './_settingsTable.mdx' + + \ No newline at end of file diff --git a/docs/reference/settings/core/enablelazyloading.mdx b/docs/reference/settings/core/enablelazyloading.mdx index 2a19a9f..eb0dc5f 100644 --- a/docs/reference/settings/core/enablelazyloading.mdx +++ b/docs/reference/settings/core/enablelazyloading.mdx @@ -1,24 +1,15 @@ --- title: core.enableLazyLoading -description: "Enables lazy loading of the rendered music sheet chunks." sidebar_custom_props: jsOnParent: true category: Core since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Enables lazy loading of the rendered music sheet chunks. AlphaTab renders the music sheet in smaller sub-chunks to have fast UI feedback. Not all of those sub-chunks are immediately @@ -27,15 +18,9 @@ appends those elements to the DOM. This reduces the load of the browser heavily This setting set to false, ensures that all rendered items are instantly appended to the DOM. The lazy rendering of partial might not be available on all platforms. - - -
{"enableLazyLoading"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}
- - -
{"bool"}{" "}{"EnableLazyLoading"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}
- - -
{"var"}{" "}{"enableLazyLoading"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}
- - + diff --git a/docs/reference/settings/core/engine.mdx b/docs/reference/settings/core/engine.mdx index f2e4793..ab1a85c 100644 --- a/docs/reference/settings/core/engine.mdx +++ b/docs/reference/settings/core/engine.mdx @@ -1,24 +1,15 @@ --- title: core.engine -description: "The engine which should be used to render the the tablature." sidebar_custom_props: jsOnParent: true category: Core since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The engine which should be used to render the the tablature. AlphaTab can use various render engines to draw the music notation. The available render engines is specific to the platform. Please refer to the table below to find out which engines are available on which platform. @@ -29,15 +20,9 @@ The engine which should be used to render the the tablature. AlphaTab can use va - `gdi` - Uses [GDI+](https://docs.microsoft.com/en-us/dotnet/framework/winforms/advanced/graphics-and-drawing-in-windows-forms) for rendering (only on .net) - `android` - Uses [android.graphics.Canvas](https://developer.android.com/reference/android/graphics/Canvas) for rendering (only on Android) - - -
{"engine"}{":"}{" "}{"string"}{" "}{"="}{" "}{"\"default\""}{";"}
- - -
{"string"}{" "}{"Engine"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"\"default\""}
- - -
{"var"}{" "}{"engine"}{":"}{" "}{"String"}{" "}{"="}{" "}{"\"default\""}
- - + diff --git a/docs/reference/settings/core/file.mdx b/docs/reference/settings/core/file.mdx index b51b17e..4605a92 100644 --- a/docs/reference/settings/core/file.mdx +++ b/docs/reference/settings/core/file.mdx @@ -1,6 +1,5 @@ --- title: core.file -description: "The full URL to the input file to be loaded." sidebar_custom_props: javaScriptOnly: true jsOnParent: true @@ -8,23 +7,17 @@ sidebar_custom_props: since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The full URL to the input file to be loaded. AlphaTab can automatically load and render a file after initialization. This eliminates the need of manually calling one of the load methods which are available. alphaTab will automatically initiate an `XMLHttpRequest` after initialization to load and display the provided url of this setting. Note that this setting is only interpreted once on initialization. -
{"file"}{":"}{" "}{"string"}{" "}{"|"}{" "}{"null"}{" "}{"="}{" "}{"null"}{";"}
+ diff --git a/docs/reference/settings/core/fontdirectory.mdx b/docs/reference/settings/core/fontdirectory.mdx index 653fc12..42fdc72 100644 --- a/docs/reference/settings/core/fontdirectory.mdx +++ b/docs/reference/settings/core/fontdirectory.mdx @@ -1,6 +1,5 @@ --- title: core.fontDirectory -description: "The full URL to the alphaTab font directory." sidebar_custom_props: javaScriptOnly: true jsOnParent: true @@ -8,18 +7,10 @@ sidebar_custom_props: since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The full URL to the alphaTab font directory. AlphaTab will generate some dynamic CSS that is needed for displaying the music symbols correctly. For this it needs to know @@ -27,7 +18,9 @@ where the Web Font files of [Bravura](https://github.com/steinbergmedia/bravura) them to be in a `font` subfolder beside the script file. If this is not the case, this setting must be used to configure the path. Alternatively also a global variable `ALPHATAB_FONT` can be set on the page before initializing alphaTab. -Use {"smuflFontSources"} for more flexible font configuration. +Use for more flexible font configuration. -
{"fontDirectory"}{":"}{" "}{"string"}{" "}{"|"}{" "}{"null"}{" "}{"="}{" "}{"\"${AlphaTabScriptFolder}/font/\""}{";"}
+ diff --git a/docs/reference/settings/core/includenotebounds.mdx b/docs/reference/settings/core/includenotebounds.mdx index e7e0e86..e73bc2e 100644 --- a/docs/reference/settings/core/includenotebounds.mdx +++ b/docs/reference/settings/core/includenotebounds.mdx @@ -1,40 +1,25 @@ --- title: core.includeNoteBounds -description: "Whether in the {\"BoundsLookup\"} also the position and area of each individual note is provided." sidebar_custom_props: jsOnParent: true category: Core since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description -Whether in the {"BoundsLookup"} also the position and area of each individual note is provided. AlphaTab collects the position of the rendered music notation elements during the rendering process. This way some level of interactivity can be provided like the feature that seeks to the corresponding position when clicking on a beat. +Whether in the also the position and area of each individual note is provided. AlphaTab collects the position of the rendered music notation elements during the rendering process. This way some level of interactivity can be provided like the feature that seeks to the corresponding position when clicking on a beat. By default the position of the individual notes is not collected due to performance reasons. If access to note position information is needed, this setting can enable it. - - -
{"includeNoteBounds"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}
- - -
{"bool"}{" "}{"IncludeNoteBounds"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}
- - -
{"var"}{" "}{"includeNoteBounds"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}
- - + ## Example - JavaScript diff --git a/docs/reference/settings/core/loglevel.mdx b/docs/reference/settings/core/loglevel.mdx index 94e02f8..762b08c 100644 --- a/docs/reference/settings/core/loglevel.mdx +++ b/docs/reference/settings/core/loglevel.mdx @@ -1,37 +1,22 @@ --- title: core.logLevel -description: "The log level to use within alphaTab" sidebar_custom_props: jsOnParent: true category: Core since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The log level to use within alphaTab AlphaTab internally does quite a bit of logging for debugging and informational purposes. The log level of alphaTab can be controlled via this setting. - - -
{"logLevel"}{":"}{" "}{"LogLevel"}{" "}{"="}{" "}{"LogLevel.Info"}{";"}
- - -
{"LogLevel"}{" "}{"LogLevel"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"LogLevel.Info"}
- - -
{"var"}{" "}{"logLevel"}{":"}{" "}{"LogLevel"}{" "}{"="}{" "}{"LogLevel.Info"}
- - + diff --git a/docs/reference/settings/core/scriptfile.mdx b/docs/reference/settings/core/scriptfile.mdx index 0f7735e..f39b13e 100644 --- a/docs/reference/settings/core/scriptfile.mdx +++ b/docs/reference/settings/core/scriptfile.mdx @@ -1,6 +1,5 @@ --- title: core.scriptFile -description: "The full URL to the alphaTab JavaScript file." sidebar_custom_props: javaScriptOnly: true jsOnParent: true @@ -8,18 +7,10 @@ sidebar_custom_props: since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The full URL to the alphaTab JavaScript file. AlphaTab needs to know the full URL to the script file it is contained in to launch the web workers. AlphaTab will do its best to auto-detect @@ -28,5 +19,7 @@ be defined before initializing. Please be aware that bundling alphaTab together in case those scripts are not suitable for web workers. e.g. if there is a script bundled together with alphaTab that accesses the DOM, this will cause an error when alphaTab starts this script as worker. -
{"scriptFile"}{":"}{" "}{"string"}{" "}{"|"}{" "}{"null"}{" "}{"="}{" "}{"Absolute url to JavaScript file containing alphaTab. (auto detected)"}{";"}
+ diff --git a/docs/reference/settings/core/smuflfontsources.mdx b/docs/reference/settings/core/smuflfontsources.mdx index 8e35b08..e812203 100644 --- a/docs/reference/settings/core/smuflfontsources.mdx +++ b/docs/reference/settings/core/smuflfontsources.mdx @@ -1,6 +1,5 @@ --- title: core.smuflFontSources -description: "Defines the URLs from which to load the SMuFL compliant font files." sidebar_custom_props: javaScriptOnly: true jsOnParent: true @@ -8,18 +7,10 @@ sidebar_custom_props: since: 1.6.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Defines the URLs from which to load the SMuFL compliant font files. These sources will be used to load and register the webfonts on the page so @@ -29,7 +20,9 @@ See https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src#url If you customize the SmuFL font used in alphaTab, you will also need to provide the respective SMuFL Metadata information to alphaTab. -Set the metadata via {"fillFromSmufl"} on the rendering resources. +Set the metadata via on the rendering resources. -
{"smuflFontSources"}{":"}{" "}{"Map"}{"<"}{"FontFileFormat"}{","}{" "}{"string"}{">"}{" "}{"|"}{" "}{"null"}{" "}{"="}{" "}{"Bravura files located at {\"fontDirectory\"} ."}{";"}
+"],["whitespace"," "],["token","|"],["whitespace"," "],["keyword","null"],["whitespace"," "],["token","="],["whitespace"," "],["identifier","Bravura files located at ."],["token",";"]]} +/> diff --git a/docs/reference/settings/core/tex.mdx b/docs/reference/settings/core/tex.mdx index 3725ce9..e86987d 100644 --- a/docs/reference/settings/core/tex.mdx +++ b/docs/reference/settings/core/tex.mdx @@ -1,6 +1,5 @@ --- title: core.tex -description: "Whether the contents of the DOM element should be loaded as alphaTex." sidebar_custom_props: javaScriptOnly: true jsOnParent: true @@ -8,24 +7,18 @@ sidebar_custom_props: since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether the contents of the DOM element should be loaded as alphaTex. This setting allows you to fill alphaTex code into the DOM element and make alphaTab automatically load it when initializing. Note that this setting is only interpreted once on initialization. -
{"tex"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}
+ ## Example - JavaScript diff --git a/docs/reference/settings/core/tracks.mdx b/docs/reference/settings/core/tracks.mdx index 9ad34d0..a870eab 100644 --- a/docs/reference/settings/core/tracks.mdx +++ b/docs/reference/settings/core/tracks.mdx @@ -1,6 +1,5 @@ --- title: core.tracks -description: "The tracks to display for the initally loaded file." sidebar_custom_props: javaScriptOnly: true jsOnParent: true @@ -8,22 +7,16 @@ sidebar_custom_props: since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description -The tracks to display for the initally loaded file. This setting can be used in combinition with the {"file"} or {"tex"} option. It controls which of the tracks +The tracks to display for the initally loaded file. This setting can be used in combinition with the or option. It controls which of the tracks of the initially loaded file should be displayed. -
{"tracks"}{":"}{" "}{"number"}{" "}{"|"}{" "}{"number"}{"[]"}{" "}{"|"}{" "}{"'all'"}{" "}{"="}{" "}{"null"}{";"}
+ diff --git a/docs/reference/settings/core/useworkers.mdx b/docs/reference/settings/core/useworkers.mdx index 5e646ba..e4dda32 100644 --- a/docs/reference/settings/core/useworkers.mdx +++ b/docs/reference/settings/core/useworkers.mdx @@ -1,38 +1,23 @@ --- title: core.useWorkers -description: "Whether the rendering should be done in a worker if possible." sidebar_custom_props: jsOnParent: true category: Core since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether the rendering should be done in a worker if possible. AlphaTab normally tries to render the music sheet asynchronously in a worker. This reduces the load on the UI side and avoids hanging. However sometimes it might be more desirable to have a synchronous rendering behavior. This setting can be set to false to synchronously render the music sheet on the UI side. - - -
{"useWorkers"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}
- - -
{"bool"}{" "}{"UseWorkers"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}
- - -
{"var"}{" "}{"useWorkers"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}
- - + diff --git a/docs/reference/settings/display/accoladebarpaddingright.mdx b/docs/reference/settings/display/accoladebarpaddingright.mdx index d629991..7c49398 100644 --- a/docs/reference/settings/display/accoladebarpaddingright.mdx +++ b/docs/reference/settings/display/accoladebarpaddingright.mdx @@ -1,37 +1,22 @@ --- title: display.accoladeBarPaddingRight -description: "The padding between the accolade bar and the start of the bar itself." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The padding between the accolade bar and the start of the bar itself. - - -
{"accoladeBarPaddingRight"}{":"}{" "}{"number"}{" "}{"="}{" "}{"3"}{";"}
- - -
{"double"}{" "}{"AccoladeBarPaddingRight"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"3"}
- - -
{"var"}{" "}{"accoladeBarPaddingRight"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"3"}
- - + diff --git a/docs/reference/settings/display/barcount.mdx b/docs/reference/settings/display/barcount.mdx index e85cbc7..59c1020 100644 --- a/docs/reference/settings/display/barcount.mdx +++ b/docs/reference/settings/display/barcount.mdx @@ -1,39 +1,24 @@ --- title: display.barCount -description: "The total number of bars that should be rendered from the song. (-1 for all bars)" sidebar_custom_props: jsOnParent: true category: Display since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The total number of bars that should be rendered from the song. (-1 for all bars) This setting sets the number of bars that should be rendered from the overall song. This setting can be used to achieve a paging system or to only show partial bars of the same file. By this a tutorial alike display can be achieved that explains various parts of the song. [Demo](/docs/showcase/layouts) - - -
{"barCount"}{":"}{" "}{"number"}{" "}{"="}{" "}{"-1"}{";"}
- - -
{"double"}{" "}{"BarCount"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"-1"}
- - -
{"var"}{" "}{"barCount"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"-1"}
- - + diff --git a/docs/reference/settings/display/barcountperpartial.mdx b/docs/reference/settings/display/barcountperpartial.mdx index da3d805..64c82f1 100644 --- a/docs/reference/settings/display/barcountperpartial.mdx +++ b/docs/reference/settings/display/barcountperpartial.mdx @@ -1,39 +1,24 @@ --- title: display.barCountPerPartial -description: "The number of bars that should be placed within one partial render." sidebar_custom_props: jsOnParent: true category: Display since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The number of bars that should be placed within one partial render. AlphaTab renders the whole music sheet in smaller chunks named "partials". This is to reduce the risk of encountering browser performance restrictions and it gives faster visual feedback to the user. This setting controls how many bars are placed within such a partial. - - -
{"barCountPerPartial"}{":"}{" "}{"number"}{" "}{"="}{" "}{"10"}{";"}
- - -
{"double"}{" "}{"BarCountPerPartial"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"10"}
- - -
{"var"}{" "}{"barCountPerPartial"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"10"}
- - + diff --git a/docs/reference/settings/display/barsperrow.mdx b/docs/reference/settings/display/barsperrow.mdx index dec3dbe..93a29f4 100644 --- a/docs/reference/settings/display/barsperrow.mdx +++ b/docs/reference/settings/display/barsperrow.mdx @@ -1,38 +1,23 @@ --- title: display.barsPerRow -description: "Limit the displayed bars per system (row). (-1 for automatic mode)" sidebar_custom_props: jsOnParent: true category: Display since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Limit the displayed bars per system (row). (-1 for automatic mode) This setting sets the number of bars that should be put into one row during layouting. This setting is only respected -when using the {"Page"} where bars are aligned in systems. [Demo](/docs/showcase/layouts#page-layout-5-bars-per-row). +when using the where bars are aligned in systems. [Demo](/docs/showcase/layouts#page-layout-5-bars-per-row). - - -
{"barsPerRow"}{":"}{" "}{"number"}{" "}{"="}{" "}{"-1"}{";"}
- - -
{"double"}{" "}{"BarsPerRow"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"-1"}
- - -
{"var"}{" "}{"barsPerRow"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"-1"}
- - + diff --git a/docs/reference/settings/display/effectbandpaddingbottom.mdx b/docs/reference/settings/display/effectbandpaddingbottom.mdx index b238c85..c754c88 100644 --- a/docs/reference/settings/display/effectbandpaddingbottom.mdx +++ b/docs/reference/settings/display/effectbandpaddingbottom.mdx @@ -1,37 +1,22 @@ --- title: display.effectBandPaddingBottom -description: "The padding between individual effect bands." sidebar_custom_props: jsOnParent: true category: Display since: 1.7.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The padding between individual effect bands. - - -
{"effectBandPaddingBottom"}{":"}{" "}{"number"}{" "}{"="}{" "}{"2"}{";"}
- - -
{"double"}{" "}{"EffectBandPaddingBottom"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"2"}
- - -
{"var"}{" "}{"effectBandPaddingBottom"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"2"}
- - + diff --git a/docs/reference/settings/display/effectstaffpaddingbottom.mdx b/docs/reference/settings/display/effectstaffpaddingbottom.mdx index fc9577e..94c7cf0 100644 --- a/docs/reference/settings/display/effectstaffpaddingbottom.mdx +++ b/docs/reference/settings/display/effectstaffpaddingbottom.mdx @@ -1,37 +1,22 @@ --- title: display.effectStaffPaddingBottom -description: "The bottom padding applied to effect annotation staffs." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The bottom padding applied to effect annotation staffs. - - -
{"effectStaffPaddingBottom"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}
- - -
{"double"}{" "}{"EffectStaffPaddingBottom"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}
- - -
{"var"}{" "}{"effectStaffPaddingBottom"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}
- - + diff --git a/docs/reference/settings/display/effectstaffpaddingtop.mdx b/docs/reference/settings/display/effectstaffpaddingtop.mdx index 0e393d2..0f8a234 100644 --- a/docs/reference/settings/display/effectstaffpaddingtop.mdx +++ b/docs/reference/settings/display/effectstaffpaddingtop.mdx @@ -1,37 +1,22 @@ --- title: display.effectStaffPaddingTop -description: "The top padding applied to effect annotation staffs." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The top padding applied to effect annotation staffs. - - -
{"effectStaffPaddingTop"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}
- - -
{"double"}{" "}{"EffectStaffPaddingTop"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}
- - -
{"var"}{" "}{"effectStaffPaddingTop"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}
- - + diff --git a/docs/reference/settings/display/firststaffpaddingleft.mdx b/docs/reference/settings/display/firststaffpaddingleft.mdx index 5f96b36..7f697f8 100644 --- a/docs/reference/settings/display/firststaffpaddingleft.mdx +++ b/docs/reference/settings/display/firststaffpaddingleft.mdx @@ -1,37 +1,22 @@ --- title: display.firstStaffPaddingLeft -description: "The left padding applied between the left line and the first glyph in the first staff in a system." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The left padding applied between the left line and the first glyph in the first staff in a system. - - -
{"firstStaffPaddingLeft"}{":"}{" "}{"number"}{" "}{"="}{" "}{"6"}{";"}
- - -
{"double"}{" "}{"FirstStaffPaddingLeft"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"6"}
- - -
{"var"}{" "}{"firstStaffPaddingLeft"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"6"}
- - + diff --git a/docs/reference/settings/display/firstsystempaddingtop.mdx b/docs/reference/settings/display/firstsystempaddingtop.mdx index 617656c..5f21023 100644 --- a/docs/reference/settings/display/firstsystempaddingtop.mdx +++ b/docs/reference/settings/display/firstsystempaddingtop.mdx @@ -1,37 +1,22 @@ --- title: display.firstSystemPaddingTop -description: "The top padding applied to first system." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The top padding applied to first system. - - -
{"firstSystemPaddingTop"}{":"}{" "}{"number"}{" "}{"="}{" "}{"5"}{";"}
- - -
{"double"}{" "}{"FirstSystemPaddingTop"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"5"}
- - -
{"var"}{" "}{"firstSystemPaddingTop"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"5"}
- - + diff --git a/docs/reference/settings/display/justifylastsystem.mdx b/docs/reference/settings/display/justifylastsystem.mdx index ff5653a..9b461fc 100644 --- a/docs/reference/settings/display/justifylastsystem.mdx +++ b/docs/reference/settings/display/justifylastsystem.mdx @@ -1,24 +1,15 @@ --- title: display.justifyLastSystem -description: "Whether to justify also the last system in page layouts." sidebar_custom_props: jsOnParent: true category: Display since: 1.3.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether to justify also the last system in page layouts. Setting this option to `true` tells alphaTab to also justify the last system (row) like it @@ -27,15 +18,9 @@ already does for the systems which are full. |--------------------------------------------------------------|-------------------------------------------------------| | ![Disabled](/img/reference/property/justify-last-system-false.png) | ![Enabled](/img/reference/property/justify-last-system-true.png) | - - -
{"justifyLastSystem"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}
- - -
{"bool"}{" "}{"JustifyLastSystem"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}
- - -
{"var"}{" "}{"justifyLastSystem"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}
- - + diff --git a/docs/reference/settings/display/lastsystempaddingbottom.mdx b/docs/reference/settings/display/lastsystempaddingbottom.mdx index 93f148d..d24d705 100644 --- a/docs/reference/settings/display/lastsystempaddingbottom.mdx +++ b/docs/reference/settings/display/lastsystempaddingbottom.mdx @@ -1,37 +1,22 @@ --- title: display.lastSystemPaddingBottom -description: "The bottom padding applied to the last system." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The bottom padding applied to the last system. - - -
{"lastSystemPaddingBottom"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}
- - -
{"double"}{" "}{"LastSystemPaddingBottom"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}
- - -
{"var"}{" "}{"lastSystemPaddingBottom"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}
- - + diff --git a/docs/reference/settings/display/layoutmode.mdx b/docs/reference/settings/display/layoutmode.mdx index d9a8d75..9f6d5da 100644 --- a/docs/reference/settings/display/layoutmode.mdx +++ b/docs/reference/settings/display/layoutmode.mdx @@ -1,37 +1,22 @@ --- title: display.layoutMode -description: "The layouting mode used to arrange the the notation." sidebar_custom_props: jsOnParent: true category: Display since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The layouting mode used to arrange the the notation. AlphaTab has various layout engines that arrange the rendered bars differently. This setting controls which layout mode is used. - - -
{"layoutMode"}{":"}{" "}{"LayoutMode"}{" "}{"="}{" "}{"LayoutMode.Page"}{";"}
- - -
{"LayoutMode"}{" "}{"LayoutMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"LayoutMode.Page"}
- - -
{"var"}{" "}{"layoutMode"}{":"}{" "}{"LayoutMode"}{" "}{"="}{" "}{"LayoutMode.Page"}
- - + diff --git a/docs/reference/settings/display/notationstaffpaddingbottom.mdx b/docs/reference/settings/display/notationstaffpaddingbottom.mdx index 43cf8de..b9d162a 100644 --- a/docs/reference/settings/display/notationstaffpaddingbottom.mdx +++ b/docs/reference/settings/display/notationstaffpaddingbottom.mdx @@ -1,37 +1,22 @@ --- title: display.notationStaffPaddingBottom -description: "The bottom padding applied to main notation staves (standard, tabs, numbered, slash)." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The bottom padding applied to main notation staves (standard, tabs, numbered, slash). - - -
{"notationStaffPaddingBottom"}{":"}{" "}{"number"}{" "}{"="}{" "}{"5"}{";"}
- - -
{"double"}{" "}{"NotationStaffPaddingBottom"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"5"}
- - -
{"var"}{" "}{"notationStaffPaddingBottom"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"5"}
- - + diff --git a/docs/reference/settings/display/notationstaffpaddingtop.mdx b/docs/reference/settings/display/notationstaffpaddingtop.mdx index d3a6481..6100eca 100644 --- a/docs/reference/settings/display/notationstaffpaddingtop.mdx +++ b/docs/reference/settings/display/notationstaffpaddingtop.mdx @@ -1,37 +1,22 @@ --- title: display.notationStaffPaddingTop -description: "The bottom padding applied to main notation staves (standard, tabs, numbered, slash)." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The bottom padding applied to main notation staves (standard, tabs, numbered, slash). - - -
{"notationStaffPaddingTop"}{":"}{" "}{"number"}{" "}{"="}{" "}{"5"}{";"}
- - -
{"double"}{" "}{"NotationStaffPaddingTop"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"5"}
- - -
{"var"}{" "}{"notationStaffPaddingTop"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"5"}
- - + diff --git a/docs/reference/settings/display/padding.mdx b/docs/reference/settings/display/padding.mdx index d95ae97..3137e64 100644 --- a/docs/reference/settings/display/padding.mdx +++ b/docs/reference/settings/display/padding.mdx @@ -1,24 +1,15 @@ --- title: display.padding -description: "Adjusts the padding between the music notation and the border." sidebar_custom_props: jsOnParent: true category: Display since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Adjusts the padding between the music notation and the border. Adjusts the padding between the music notation and the outer border of the container element. @@ -26,15 +17,9 @@ The array is either: * 2 elements: `[left-right, top-bottom]` * 4 elements: ``[left, top, right, bottom]`` - - -
{"padding"}{":"}{" "}{"number"}{"[]"}{" "}{"="}{" "}{"[35, 35]"}{";"}
- - -
{"IList"}{"<"}{"double"}{">"}{" "}{"Padding"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"[35, 35]"}
- - -
{"var"}{" "}{"padding"}{":"}{" "}{"alphaTab.collections.DoubleList"}{" "}{"="}{" "}{"[35, 35]"}
- - +"],["whitespace"," "],["identifier","Padding"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["keyword","set"],["token",";"],["whitespace"," "],["token","}"],["whitespace"," "],["token","="],["whitespace"," "],["identifier","[35, 35]"]]} + kotlin={[["keyword","var"],["whitespace"," "],["identifier","padding"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.DoubleList"],["whitespace"," "],["token","="],["whitespace"," "],["identifier","[35, 35]"]]} +/> diff --git a/docs/reference/settings/display/resources.mdx b/docs/reference/settings/display/resources.mdx index 2ba998f..25ffe86 100644 --- a/docs/reference/settings/display/resources.mdx +++ b/docs/reference/settings/display/resources.mdx @@ -1,25 +1,15 @@ --- title: display.resources -description: "Allows adjusting of the used fonts and colors for rendering." sidebar_custom_props: - domWildcard: true jsOnParent: true category: Display since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Allows adjusting of the used fonts and colors for rendering. AlphaTab allows configuring the colors and fonts used for rendering via the rendering resources settings. Please note that as of today @@ -53,17 +43,11 @@ For JavaScript you can use any CSS font property compliant string. (#RGB, #RGBA, On .net simply construct the `Color` object to configure your desired color. - - -
{"resources"}{":"}{" "}{"RenderingResources"}{" "}{"="}{" "}{"false"}{";"}
- - -
{"RenderingResources"}{" "}{"Resources"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}
- - -
{"var"}{" "}{"resources"}{":"}{" "}{"RenderingResources"}{" "}{"="}{" "}{"false"}
- - + import ManualDocs from './_resources.mdx'; diff --git a/docs/reference/settings/display/scale.mdx b/docs/reference/settings/display/scale.mdx index ce599ad..367cc68 100644 --- a/docs/reference/settings/display/scale.mdx +++ b/docs/reference/settings/display/scale.mdx @@ -1,38 +1,23 @@ --- title: display.scale -description: "The zoom level of the rendered notation." sidebar_custom_props: jsOnParent: true category: Display since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The zoom level of the rendered notation. AlphaTab can scale up or down the rendered music notation for more optimized display scenarios. By default music notation is rendered at 100% scale (value 1) and can be scaled up or down by percental values. - - -
{"scale"}{":"}{" "}{"number"}{" "}{"="}{" "}{"1.0"}{";"}
- - -
{"double"}{" "}{"Scale"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"1.0"}
- - -
{"var"}{" "}{"scale"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"1.0"}
- - + diff --git a/docs/reference/settings/display/staffpaddingleft.mdx b/docs/reference/settings/display/staffpaddingleft.mdx index d7ce7d1..6d93836 100644 --- a/docs/reference/settings/display/staffpaddingleft.mdx +++ b/docs/reference/settings/display/staffpaddingleft.mdx @@ -1,37 +1,22 @@ --- title: display.staffPaddingLeft -description: "The left padding applied between the left line and the first glyph in the following staff in a system." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The left padding applied between the left line and the first glyph in the following staff in a system. - - -
{"staffPaddingLeft"}{":"}{" "}{"number"}{" "}{"="}{" "}{"2"}{";"}
- - -
{"double"}{" "}{"StaffPaddingLeft"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"2"}
- - -
{"var"}{" "}{"staffPaddingLeft"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"2"}
- - + diff --git a/docs/reference/settings/display/startbar.mdx b/docs/reference/settings/display/startbar.mdx index e085791..fd0c7e1 100644 --- a/docs/reference/settings/display/startbar.mdx +++ b/docs/reference/settings/display/startbar.mdx @@ -1,24 +1,15 @@ --- title: display.startBar -description: "The bar start index to start layouting with." sidebar_custom_props: jsOnParent: true category: Display since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The bar start index to start layouting with. This setting sets the index of the first bar that should be rendered from the overall song. This setting can be used to @@ -26,15 +17,9 @@ achieve a paging system or to only show partial bars of the same file. By this a that explains various parts of the song. Please note that this is the bar number as shown in the music sheet (1-based) not the array index (0-based). [Demo](/docs/showcase/layouts#page-layout-bar-5-to-8) - - -
{"startBar"}{":"}{" "}{"number"}{" "}{"="}{" "}{"1"}{";"}
- - -
{"double"}{" "}{"StartBar"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"1"}
- - -
{"var"}{" "}{"startBar"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"1"}
- - + diff --git a/docs/reference/settings/display/staveprofile.mdx b/docs/reference/settings/display/staveprofile.mdx index 8172bde..a2d58d4 100644 --- a/docs/reference/settings/display/staveprofile.mdx +++ b/docs/reference/settings/display/staveprofile.mdx @@ -1,38 +1,23 @@ --- title: display.staveProfile -description: "The stave profile defining which staves are shown for the music sheet." sidebar_custom_props: jsOnParent: true category: Display since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The stave profile defining which staves are shown for the music sheet. AlphaTab has various stave profiles that define which staves will be shown in for the rendered tracks. Its recommended -to keep this on {"Default"} and rather rely on the options available ob {"Staff"} level +to keep this on and rather rely on the options available ob level - - -
{"staveProfile"}{":"}{" "}{"StaveProfile"}{" "}{"="}{" "}{"StaveProfile.Default"}{";"}
- - -
{"StaveProfile"}{" "}{"StaveProfile"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"StaveProfile.Default"}
- - -
{"var"}{" "}{"staveProfile"}{":"}{" "}{"StaveProfile"}{" "}{"="}{" "}{"StaveProfile.Default"}
- - + diff --git a/docs/reference/settings/display/stretchforce.mdx b/docs/reference/settings/display/stretchforce.mdx index 6e88bf8..8270760 100644 --- a/docs/reference/settings/display/stretchforce.mdx +++ b/docs/reference/settings/display/stretchforce.mdx @@ -1,24 +1,15 @@ --- title: display.stretchForce -description: "The default stretch force to use for layouting." sidebar_custom_props: jsOnParent: true category: Display since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The default stretch force to use for layouting. The stretch force is a setting that controls the spacing of the music notation. AlphaTab uses a varaint of the Gourlay algorithm for spacing which has springs and rods for @@ -28,15 +19,9 @@ aligning elements. This setting controls the "strength" of the springs. The stro |--------------------------------------------------------------|-------------------------------------------------------| | ![Default](/img/reference/property/stretchforce-default.png) | ![0.5](/img/reference/property/stretchforce-half.png) | - - -
{"stretchForce"}{":"}{" "}{"number"}{" "}{"="}{" "}{"1"}{";"}
- - -
{"double"}{" "}{"StretchForce"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"1"}
- - -
{"var"}{" "}{"stretchForce"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"1"}
- - + diff --git a/docs/reference/settings/display/systemlabelpaddingleft.mdx b/docs/reference/settings/display/systemlabelpaddingleft.mdx index 2ef07cb..78ef00c 100644 --- a/docs/reference/settings/display/systemlabelpaddingleft.mdx +++ b/docs/reference/settings/display/systemlabelpaddingleft.mdx @@ -1,37 +1,22 @@ --- title: display.systemLabelPaddingLeft -description: "The padding left to the track name label of the system." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The padding left to the track name label of the system. - - -
{"systemLabelPaddingLeft"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}
- - -
{"double"}{" "}{"SystemLabelPaddingLeft"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}
- - -
{"var"}{" "}{"systemLabelPaddingLeft"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}
- - + diff --git a/docs/reference/settings/display/systemlabelpaddingright.mdx b/docs/reference/settings/display/systemlabelpaddingright.mdx index 980e0d0..4287eda 100644 --- a/docs/reference/settings/display/systemlabelpaddingright.mdx +++ b/docs/reference/settings/display/systemlabelpaddingright.mdx @@ -1,37 +1,22 @@ --- title: display.systemLabelPaddingRight -description: "The padding left to the track name label of the system." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The padding left to the track name label of the system. - - -
{"systemLabelPaddingRight"}{":"}{" "}{"number"}{" "}{"="}{" "}{"3"}{";"}
- - -
{"double"}{" "}{"SystemLabelPaddingRight"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"3"}
- - -
{"var"}{" "}{"systemLabelPaddingRight"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"3"}
- - + diff --git a/docs/reference/settings/display/systempaddingbottom.mdx b/docs/reference/settings/display/systempaddingbottom.mdx index e7f09ee..8e66329 100644 --- a/docs/reference/settings/display/systempaddingbottom.mdx +++ b/docs/reference/settings/display/systempaddingbottom.mdx @@ -1,37 +1,22 @@ --- title: display.systemPaddingBottom -description: "The bottom padding applied to systems beside the last one." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The bottom padding applied to systems beside the last one. - - -
{"systemPaddingBottom"}{":"}{" "}{"number"}{" "}{"="}{" "}{"20"}{";"}
- - -
{"double"}{" "}{"SystemPaddingBottom"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"20"}
- - -
{"var"}{" "}{"systemPaddingBottom"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"20"}
- - + diff --git a/docs/reference/settings/display/systempaddingtop.mdx b/docs/reference/settings/display/systempaddingtop.mdx index 4e66e97..07cfc17 100644 --- a/docs/reference/settings/display/systempaddingtop.mdx +++ b/docs/reference/settings/display/systempaddingtop.mdx @@ -1,37 +1,22 @@ --- title: display.systemPaddingTop -description: "The top padding applied systems beside the first one." sidebar_custom_props: jsOnParent: true category: Display since: 1.4.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The top padding applied systems beside the first one. - - -
{"systemPaddingTop"}{":"}{" "}{"number"}{" "}{"="}{" "}{"10"}{";"}
- - -
{"double"}{" "}{"SystemPaddingTop"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"10"}
- - -
{"var"}{" "}{"systemPaddingTop"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"10"}
- - + diff --git a/docs/reference/settings/display/systemslayoutmode.mdx b/docs/reference/settings/display/systemslayoutmode.mdx index eb48e74..c361c6f 100644 --- a/docs/reference/settings/display/systemslayoutmode.mdx +++ b/docs/reference/settings/display/systemslayoutmode.mdx @@ -1,24 +1,15 @@ --- title: display.systemsLayoutMode -description: "The mode used to arrange staves and systems." sidebar_custom_props: jsOnParent: true category: Display since: 1.3.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The mode used to arrange staves and systems. By default alphaTab uses an own (automatic) mode to arrange and scale the bars when @@ -78,15 +69,9 @@ The horizontal layout uses the `displayWidth` to scale the bars to size the bars * Comparing files against each other (top/bottom comparison) * Aligning the playback of multiple files on one screen assuming the same tempo (e.g. one file per track). - - -
{"systemsLayoutMode"}{":"}{" "}{"SystemsLayoutMode"}{" "}{"="}{" "}{"1"}{";"}
- - -
{"SystemsLayoutMode"}{" "}{"SystemsLayoutMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"1"}
- - -
{"var"}{" "}{"systemsLayoutMode"}{":"}{" "}{"SystemsLayoutMode"}{" "}{"="}{" "}{"1"}
- - + diff --git a/docs/reference/settings/exporter/comments.mdx b/docs/reference/settings/exporter/comments.mdx index 235173c..059de8d 100644 --- a/docs/reference/settings/exporter/comments.mdx +++ b/docs/reference/settings/exporter/comments.mdx @@ -1,36 +1,21 @@ --- title: exporter.comments -description: "Whether to write extended comments into the exported file (e.g. to in alphaTex to mark where certain metadata or bars starts)" sidebar_custom_props: category: Exporter since: 1.7.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether to write extended comments into the exported file (e.g. to in alphaTex to mark where certain metadata or bars starts) - - -
{"comments"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}
- - -
{"bool"}{" "}{"Comments"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}
- - -
{"var"}{" "}{"comments"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}
- - + diff --git a/docs/reference/settings/exporter/indent.mdx b/docs/reference/settings/exporter/indent.mdx index 7c81c80..cba5640 100644 --- a/docs/reference/settings/exporter/indent.mdx +++ b/docs/reference/settings/exporter/indent.mdx @@ -1,37 +1,22 @@ --- title: exporter.indent -description: "How many characters should be indented on formatted outputs. If set to negative values" sidebar_custom_props: category: Exporter since: 1.7.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description How many characters should be indented on formatted outputs. If set to negative values formatted outputs are disabled. - - -
{"indent"}{":"}{" "}{"number"}{" "}{"="}{" "}{"2"}{";"}
- - -
{"double"}{" "}{"Indent"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"2"}
- - -
{"var"}{" "}{"indent"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"2"}
- - + diff --git a/docs/reference/settings/importer/beattextaslyrics.mdx b/docs/reference/settings/importer/beattextaslyrics.mdx index 663329c..7fa28c4 100644 --- a/docs/reference/settings/importer/beattextaslyrics.mdx +++ b/docs/reference/settings/importer/beattextaslyrics.mdx @@ -1,23 +1,14 @@ --- title: importer.beatTextAsLyrics -description: "Enables detecting lyrics from beat texts" sidebar_custom_props: category: Importer since: 1.2.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Enables detecting lyrics from beat texts On various old Guitar Pro 3-5 files tab authors often used the "beat text" feature to add lyrics to the individual tracks. @@ -43,15 +34,9 @@ Enable this option for input files which suffer from this practice. ![Disabled](/img/reference/property/beattextaslyrics-disabled.png) - - -
{"beatTextAsLyrics"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}
- - -
{"bool"}{" "}{"BeatTextAsLyrics"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}
- - -
{"var"}{" "}{"beatTextAsLyrics"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}
- - + diff --git a/docs/reference/settings/importer/encoding.mdx b/docs/reference/settings/importer/encoding.mdx index d70e04f..cef72dc 100644 --- a/docs/reference/settings/importer/encoding.mdx +++ b/docs/reference/settings/importer/encoding.mdx @@ -1,23 +1,14 @@ --- title: importer.encoding -description: "The text encoding to use when decoding strings." sidebar_custom_props: category: Importer since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The text encoding to use when decoding strings. By default strings are interpreted as UTF-8 from the input files. This is sometimes not the case and leads to strong display @@ -29,15 +20,9 @@ encodings depend on the browser or operating system. This setting is considered * Guitar Pro 3-5 * MusicXML - - -
{"encoding"}{":"}{" "}{"string"}{" "}{"="}{" "}{"utf-8"}{";"}
- - -
{"string"}{" "}{"Encoding"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"utf-8"}
- - -
{"var"}{" "}{"encoding"}{":"}{" "}{"String"}{" "}{"="}{" "}{"utf-8"}
- - + diff --git a/docs/reference/settings/importer/mergepartgroupsinmusicxml.mdx b/docs/reference/settings/importer/mergepartgroupsinmusicxml.mdx index 8940b0f..02f2776 100644 --- a/docs/reference/settings/importer/mergepartgroupsinmusicxml.mdx +++ b/docs/reference/settings/importer/mergepartgroupsinmusicxml.mdx @@ -1,36 +1,21 @@ --- title: importer.mergePartGroupsInMusicXml -description: "If part-groups should be merged into a single track (MusicXML)." sidebar_custom_props: category: Importer since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description If part-groups should be merged into a single track (MusicXML). This setting controls whether multiple `part-group` tags will result into a single track with multiple staves. - - -
{"mergePartGroupsInMusicXml"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}
- - -
{"bool"}{" "}{"MergePartGroupsInMusicXml"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}
- - -
{"var"}{" "}{"mergePartGroupsInMusicXml"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}
- - + diff --git a/docs/reference/settings/notation/displaytranspositionpitches.mdx b/docs/reference/settings/notation/displaytranspositionpitches.mdx index f435c11..4acd30d 100644 --- a/docs/reference/settings/notation/displaytranspositionpitches.mdx +++ b/docs/reference/settings/notation/displaytranspositionpitches.mdx @@ -1,23 +1,14 @@ --- title: notation.displayTranspositionPitches -description: "The transposition pitch offsets for the individual tracks used for rendering only." sidebar_custom_props: category: Notation since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The transposition pitch offsets for the individual tracks used for rendering only. For some instruments the pitch shown on the standard notation has an additional transposition. One example is the Guitar. @@ -29,15 +20,9 @@ The `DisplayTranspositionPitch` setting allows defining an additional pitch offs This setting does not affect the playback of the instrument in any way. Despite the 2 different standard notations in the above example, they both play the same note height. The transposition is defined as number of semitones and one value per track of the song can be defined. - - -
{"displayTranspositionPitches"}{":"}{" "}{"number"}{"[]"}{" "}{"="}{" "}{"[]"}{";"}
- - -
{"IList"}{"<"}{"double"}{">"}{" "}{"DisplayTranspositionPitches"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"[]"}
- - -
{"var"}{" "}{"displayTranspositionPitches"}{":"}{" "}{"alphaTab.collections.DoubleList"}{" "}{"="}{" "}{"[]"}
- - +"],["whitespace"," "],["identifier","DisplayTranspositionPitches"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["keyword","set"],["token",";"],["whitespace"," "],["token","}"],["whitespace"," "],["token","="],["whitespace"," "],["identifier","[]"]]} + kotlin={[["keyword","var"],["whitespace"," "],["identifier","displayTranspositionPitches"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.DoubleList"],["whitespace"," "],["token","="],["whitespace"," "],["identifier","[]"]]} +/> diff --git a/docs/reference/settings/notation/elements.mdx b/docs/reference/settings/notation/elements.mdx index eb4c5bc..595f438 100644 --- a/docs/reference/settings/notation/elements.mdx +++ b/docs/reference/settings/notation/elements.mdx @@ -1,23 +1,14 @@ --- title: notation.elements -description: "Whether music notation elements are visible or not." sidebar_custom_props: category: Notation since: 0.9.8 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether music notation elements are visible or not. AlphaTab has quite a set of notation elements that are usually shown by default or only shown when using @@ -27,17 +18,11 @@ song information or the track names. For each element you can configure whether it is visible or not. The setting is a Map/Dictionary where the key is the element to configure and the value is a boolean value whether it should be visible or not. - - -
{"elements"}{":"}{" "}{"Map"}{"<"}{"NotationElement"}{","}{" "}{"boolean"}{">"}{" "}{"="}{" "}{"[[NotationElement.ZerosOnDiveWhammys, false]]"}{";"}
- - -
{"Map"}{"<"}{"NotationElement"}{","}{" "}{"bool"}{">"}{" "}{"Elements"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"[[NotationElement.ZerosOnDiveWhammys, false]]"}
- - -
{"var"}{" "}{"elements"}{":"}{" "}{"alphaTab.collections.ObjectBooleanMap"}{"<"}{"NotationElement"}{","}{" "}{"Boolean"}{">"}{" "}{"="}{" "}{"[[NotationElement.ZerosOnDiveWhammys, false]]"}
- - +"],["whitespace"," "],["token","="],["whitespace"," "],["identifier","[[NotationElement.ZerosOnDiveWhammys, false]]"],["token",";"]]} + csharp={[["identifier","Map","/docs/reference/types/notationelement"],["token","<"],["identifier","NotationElement","/docs/reference/types/notationelement"],["token",","],["whitespace"," "],["identifier","bool"],["token",">"],["whitespace"," "],["identifier","Elements"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["keyword","set"],["token",";"],["whitespace"," "],["token","}"],["whitespace"," "],["token","="],["whitespace"," "],["identifier","[[NotationElement.ZerosOnDiveWhammys, false]]"]]} + kotlin={[["keyword","var"],["whitespace"," "],["identifier","elements"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.ObjectBooleanMap"],["token","<"],["identifier","NotationElement","/docs/reference/types/notationelement"],["token",","],["whitespace"," "],["identifier","Boolean"],["token",">"],["whitespace"," "],["token","="],["whitespace"," "],["identifier","[[NotationElement.ZerosOnDiveWhammys, false]]"]]} +/> ## Examples @@ -51,7 +36,7 @@ the key is the element to configure and the value is a boolean value whether it ]} > -Internally the setting is a [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) where the key must be a {"NotationElement"} enumeration value. +Internally the setting is a [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) where the key must be a enumeration value. For JSON input the usual enumeration serialization applies where also the names can be used. The names are case insensitive. diff --git a/docs/reference/settings/notation/extendbendarrowsontiednotes.mdx b/docs/reference/settings/notation/extendbendarrowsontiednotes.mdx index 464a14a..f50f3dd 100644 --- a/docs/reference/settings/notation/extendbendarrowsontiednotes.mdx +++ b/docs/reference/settings/notation/extendbendarrowsontiednotes.mdx @@ -1,23 +1,14 @@ --- title: notation.extendBendArrowsOnTiedNotes -description: "If set to true bend arrows expand to the end of the last tied note of the string. Otherwise they end on the next beat." sidebar_custom_props: category: Notation since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description If set to true bend arrows expand to the end of the last tied note of the string. Otherwise they end on the next beat. By default the arrows and lines on bend effects are extended to the space of tied notes. This behavior is the Guitar Pro default but some applications and songbooks practice it different. @@ -26,15 +17,9 @@ There the bend only is drawn to the next beat. |-----------------------------------------------------------------------------|-------------------------------------------------------------------------------| | ![Enabled](/img/reference/property/extendbendarrowsontiednotes-enabled.png) | ![Disabled](/img/reference/property/extendbendarrowsontiednotes-disabled.png) | - - -
{"extendBendArrowsOnTiedNotes"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}
- - -
{"bool"}{" "}{"ExtendBendArrowsOnTiedNotes"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}
- - -
{"var"}{" "}{"extendBendArrowsOnTiedNotes"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}
- - + diff --git a/docs/reference/settings/notation/extendlineeffectstobeatend.mdx b/docs/reference/settings/notation/extendlineeffectstobeatend.mdx index 6e7c844..e5759d8 100644 --- a/docs/reference/settings/notation/extendlineeffectstobeatend.mdx +++ b/docs/reference/settings/notation/extendlineeffectstobeatend.mdx @@ -1,23 +1,14 @@ --- title: notation.extendLineEffectsToBeatEnd -description: "If set to true, line effects like w/bar and let-ring are drawn until the end of the beat instead of the start" sidebar_custom_props: category: Notation since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description If set to true, line effects like w/bar and let-ring are drawn until the end of the beat instead of the start By default effect annotations that render a line above the staff, stop on the beat. This is the typical display of Guitar Pro. In songbooks and some other tools @@ -26,15 +17,9 @@ these effects are drawn to the end of this beat. |-----------------------------------------------------------------------------|-------------------------------------------------------------------------------| | ![Enabled](/img/reference/property/extendlineeffectstobeatend-enabled.png) | ![Disabled](/img/reference/property/extendlineeffectstobeatend-disabled.png) | - - -
{"extendLineEffectsToBeatEnd"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}
- - -
{"bool"}{" "}{"ExtendLineEffectsToBeatEnd"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}
- - -
{"var"}{" "}{"extendLineEffectsToBeatEnd"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}
- - + diff --git a/docs/reference/settings/notation/fingeringmode.mdx b/docs/reference/settings/notation/fingeringmode.mdx index 97dbdc9..fdfce89 100644 --- a/docs/reference/settings/notation/fingeringmode.mdx +++ b/docs/reference/settings/notation/fingeringmode.mdx @@ -1,23 +1,14 @@ --- title: notation.fingeringMode -description: "The fingering mode to use." sidebar_custom_props: category: Notation since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The fingering mode to use. AlphaTab supports multiple modes on how to display fingering information in the music sheet. This setting controls how they should be displayed. The default behavior is to show the finger information @@ -27,15 +18,9 @@ directly in the score along the notes. For some use cases of training courses an |-------------------------------------------------------------|-------------------------------------------------------------------| | ![Enabled](/img/reference/property/fingeringmode-score.png) | ![Disabled](/img/reference/property/fingeringmode-effectband.png) | - - -
{"fingeringMode"}{":"}{" "}{"FingeringMode"}{" "}{"="}{" "}{"FingeringMode.ScoreDefault"}{";"}
- - -
{"FingeringMode"}{" "}{"FingeringMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"FingeringMode.ScoreDefault"}
- - -
{"var"}{" "}{"fingeringMode"}{":"}{" "}{"FingeringMode"}{" "}{"="}{" "}{"FingeringMode.ScoreDefault"}
- - + diff --git a/docs/reference/settings/notation/notationmode.mdx b/docs/reference/settings/notation/notationmode.mdx index 8d53bfe..0b99e95 100644 --- a/docs/reference/settings/notation/notationmode.mdx +++ b/docs/reference/settings/notation/notationmode.mdx @@ -1,23 +1,14 @@ --- title: notation.notationMode -description: "The mode to use for display and play music notation elements." sidebar_custom_props: category: Notation since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The mode to use for display and play music notation elements. AlphaTab provides 2 main music notation display modes `GuitarPro` and `SongBook`. @@ -55,15 +46,9 @@ Following default setting values are applied: } ``` - - -
{"notationMode"}{":"}{" "}{"NotationMode"}{" "}{"="}{" "}{"NotationMode.GuitarPro"}{";"}
- - -
{"NotationMode"}{" "}{"NotationMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"NotationMode.GuitarPro"}
- - -
{"var"}{" "}{"notationMode"}{":"}{" "}{"NotationMode"}{" "}{"="}{" "}{"NotationMode.GuitarPro"}
- - + diff --git a/docs/reference/settings/notation/rhythmheight.mdx b/docs/reference/settings/notation/rhythmheight.mdx index 8bfae50..183916a 100644 --- a/docs/reference/settings/notation/rhythmheight.mdx +++ b/docs/reference/settings/notation/rhythmheight.mdx @@ -1,36 +1,21 @@ --- title: notation.rhythmHeight -description: "Controls how high the ryhthm notation is rendered below the tab staff" sidebar_custom_props: category: Notation since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description -Controls how high the ryhthm notation is rendered below the tab staff This setting can be used in combination with the {"rhythmMode"} setting to control how high the rhythm notation should be rendered below the tab staff. +Controls how high the ryhthm notation is rendered below the tab staff This setting can be used in combination with the setting to control how high the rhythm notation should be rendered below the tab staff. - - -
{"rhythmHeight"}{":"}{" "}{"number"}{" "}{"="}{" "}{"15"}{";"}
- - -
{"double"}{" "}{"RhythmHeight"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"15"}
- - -
{"var"}{" "}{"rhythmHeight"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"15"}
- - + diff --git a/docs/reference/settings/notation/rhythmmode.mdx b/docs/reference/settings/notation/rhythmmode.mdx index 0107c54..0ef63c0 100644 --- a/docs/reference/settings/notation/rhythmmode.mdx +++ b/docs/reference/settings/notation/rhythmmode.mdx @@ -1,37 +1,22 @@ --- title: notation.rhythmMode -description: "Controls how the rhythm notation is rendered for tab staves." sidebar_custom_props: category: Notation since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Controls how the rhythm notation is rendered for tab staves. This setting enables the display of rhythm notation on tab staffs. [Demo](/docs/showcase/guitar-tabs) its automatically detected whether rhythm notation should be shown on tabs (based on the visibility of other staves). - - -
{"rhythmMode"}{":"}{" "}{"TabRhythmMode"}{" "}{"="}{" "}{"TabRhythmMode.Automatic"}{";"}
- - -
{"TabRhythmMode"}{" "}{"RhythmMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"TabRhythmMode.Automatic"}
- - -
{"var"}{" "}{"rhythmMode"}{":"}{" "}{"TabRhythmMode"}{" "}{"="}{" "}{"TabRhythmMode.Automatic"}
- - + diff --git a/docs/reference/settings/notation/slurheight.mdx b/docs/reference/settings/notation/slurheight.mdx index 5226637..9f2b625 100644 --- a/docs/reference/settings/notation/slurheight.mdx +++ b/docs/reference/settings/notation/slurheight.mdx @@ -1,23 +1,14 @@ --- title: notation.slurHeight -description: "The height scale factor for slurs" sidebar_custom_props: category: Notation since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The height scale factor for slurs Slurs and ties currently calculate their height based on the distance they have from start to end note. Most music notation software do some complex collision detection to avoid a slur to overlap with other elements, alphaTab @@ -26,15 +17,9 @@ only has a simplified version of the slur positioning as of today. This setting |------------------------------------------------------------------------|--------------------------------------------------------------| | ![Slur Height Default](/img/reference/property/slurheight-default.png) | ![Slur Height 14](/img/reference/property/slurheight-14.png) | - - -
{"slurHeight"}{":"}{" "}{"number"}{" "}{"="}{" "}{"5"}{";"}
- - -
{"double"}{" "}{"SlurHeight"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"5"}
- - -
{"var"}{" "}{"slurHeight"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"5"}
- - + diff --git a/docs/reference/settings/notation/smallgracetabnotes.mdx b/docs/reference/settings/notation/smallgracetabnotes.mdx index f04bba0..3819757 100644 --- a/docs/reference/settings/notation/smallgracetabnotes.mdx +++ b/docs/reference/settings/notation/smallgracetabnotes.mdx @@ -1,23 +1,14 @@ --- title: notation.smallGraceTabNotes -description: "If set to true the guitar tabs on grace beats are rendered smaller." sidebar_custom_props: category: Notation since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description If set to true the guitar tabs on grace beats are rendered smaller. By default, grace notes are drawn smaller on the guitar tabs than the other numbers. With this setting alphaTab can be configured to show grace tab notes with normal text size. @@ -25,15 +16,9 @@ If set to true the guitar tabs on grace beats are rendered smaller. By default, |--------------------------------------------------------------------|----------------------------------------------------------------------| | ![Enabled](/img/reference/property/smallgracetabnotes-enabled.png) | ![Disabled](/img/reference/property/smallgracetabnotes-disabled.png) | - - -
{"smallGraceTabNotes"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}
- - -
{"bool"}{" "}{"SmallGraceTabNotes"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}
- - -
{"var"}{" "}{"smallGraceTabNotes"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}
- - + diff --git a/docs/reference/settings/notation/transpositionpitches.mdx b/docs/reference/settings/notation/transpositionpitches.mdx index 08042b3..3e86ebc 100644 --- a/docs/reference/settings/notation/transpositionpitches.mdx +++ b/docs/reference/settings/notation/transpositionpitches.mdx @@ -1,37 +1,22 @@ --- title: notation.transpositionPitches -description: "The transposition pitch offsets for the individual tracks used for rendering and playback." sidebar_custom_props: category: Notation since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The transposition pitch offsets for the individual tracks used for rendering and playback. This setting allows transposing of tracks for display and playback. The `transpositionPitches` setting allows defining an additional pitch offset per track, that is then considered when displaying the music sheet. - - -
{"transpositionPitches"}{":"}{" "}{"number"}{"[]"}{" "}{"="}{" "}{"[]"}{";"}
- - -
{"IList"}{"<"}{"double"}{">"}{" "}{"TranspositionPitches"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"[]"}
- - -
{"var"}{" "}{"transpositionPitches"}{":"}{" "}{"alphaTab.collections.DoubleList"}{" "}{"="}{" "}{"[]"}
- - +"],["whitespace"," "],["identifier","TranspositionPitches"],["whitespace"," "],["token","{"],["whitespace"," "],["keyword","get"],["token",";"],["whitespace"," "],["keyword","set"],["token",";"],["whitespace"," "],["token","}"],["whitespace"," "],["token","="],["whitespace"," "],["identifier","[]"]]} + kotlin={[["keyword","var"],["whitespace"," "],["identifier","transpositionPitches"],["token",":"],["whitespace"," "],["identifier","alphaTab.collections.DoubleList"],["whitespace"," "],["token","="],["whitespace"," "],["identifier","[]"]]} +/> diff --git a/docs/reference/settings/player/buffertimeinmilliseconds.mdx b/docs/reference/settings/player/buffertimeinmilliseconds.mdx index b330deb..1895bd5 100644 --- a/docs/reference/settings/player/buffertimeinmilliseconds.mdx +++ b/docs/reference/settings/player/buffertimeinmilliseconds.mdx @@ -1,23 +1,14 @@ --- title: player.bufferTimeInMilliseconds -description: "The number of milliseconds the player should buffer." sidebar_custom_props: category: Player since: 1.2.3 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The number of milliseconds the player should buffer. Gets or sets how many milliseconds of audio samples should be buffered in total. @@ -27,15 +18,9 @@ The number of milliseconds the player should buffer. Gets or sets how many milli This buffer size can be changed whenever needed. - - -
{"bufferTimeInMilliseconds"}{":"}{" "}{"number"}{" "}{"="}{" "}{"500"}{";"}
- - -
{"double"}{" "}{"BufferTimeInMilliseconds"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"500"}
- - -
{"var"}{" "}{"bufferTimeInMilliseconds"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"500"}
- - + diff --git a/docs/reference/settings/player/enableanimatedbeatcursor.mdx b/docs/reference/settings/player/enableanimatedbeatcursor.mdx index e078a22..16f0513 100644 --- a/docs/reference/settings/player/enableanimatedbeatcursor.mdx +++ b/docs/reference/settings/player/enableanimatedbeatcursor.mdx @@ -1,37 +1,22 @@ --- title: player.enableAnimatedBeatCursor -description: "Whether the beat cursor should be animated or just ticking." sidebar_custom_props: category: Player since: 1.2.3 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether the beat cursor should be animated or just ticking. This setting configures whether the beat cursor is animated smoothly or whether it is ticking from beat to beat. The animation of the cursor might not be available on all targets so it might not have any effect. - - -
{"enableAnimatedBeatCursor"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}
- - -
{"bool"}{" "}{"EnableAnimatedBeatCursor"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}
- - -
{"var"}{" "}{"enableAnimatedBeatCursor"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}
- - + diff --git a/docs/reference/settings/player/enablecursor.mdx b/docs/reference/settings/player/enablecursor.mdx index d0f8975..0c7e636 100644 --- a/docs/reference/settings/player/enablecursor.mdx +++ b/docs/reference/settings/player/enablecursor.mdx @@ -1,36 +1,21 @@ --- title: player.enableCursor -description: "Whether playback cursors should be displayed." sidebar_custom_props: category: Player since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether playback cursors should be displayed. This setting configures whether the playback cursors are shown or not. In case a developer decides to built an own cursor system the default one can be disabled with this setting. Enabling the cursor also requires the player to be active. - - -
{"enableCursor"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"`true` (if player is not disabled)"}{";"}
- - -
{"bool"}{" "}{"EnableCursor"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"`true` (if player is not disabled)"}
- - -
{"var"}{" "}{"enableCursor"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"`true` (if player is not disabled)"}
- - + diff --git a/docs/reference/settings/player/enableelementhighlighting.mdx b/docs/reference/settings/player/enableelementhighlighting.mdx index 295f0f4..a08b70d 100644 --- a/docs/reference/settings/player/enableelementhighlighting.mdx +++ b/docs/reference/settings/player/enableelementhighlighting.mdx @@ -1,37 +1,22 @@ --- title: player.enableElementHighlighting -description: "Whether the notation elements of the currently played beat should be highlighted." sidebar_custom_props: category: Player since: 1.2.3 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether the notation elements of the currently played beat should be highlighted. This setting configures whether the note elements are highlighted during playback. The highlighting of elements might not be available on all targets and render engine, so it might not have any effect. - - -
{"enableElementHighlighting"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}
- - -
{"bool"}{" "}{"EnableElementHighlighting"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}
- - -
{"var"}{" "}{"enableElementHighlighting"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}
- - + diff --git a/docs/reference/settings/player/enableplayer.mdx b/docs/reference/settings/player/enableplayer.mdx index 07430d7..68d4c2e 100644 --- a/docs/reference/settings/player/enableplayer.mdx +++ b/docs/reference/settings/player/enableplayer.mdx @@ -1,23 +1,14 @@ --- title: player.enablePlayer -description: "Whether the player should be enabled." sidebar_custom_props: category: Player since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether the player should be enabled. This setting configures whether the player feature is enabled or not. Depending on the platform enabling the player needs some additional actions of the developer. @@ -26,15 +17,9 @@ For .net manually the soundfont must be loaded. AlphaTab does not ship a default UI for the player. The API must be hooked up to some UI controls to allow the user to interact with the player. - - -
{"enablePlayer"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"false"}{";"}
- - -
{"bool"}{" "}{"EnablePlayer"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"false"}
- - -
{"var"}{" "}{"enablePlayer"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"false"}
- - + diff --git a/docs/reference/settings/player/enableuserinteraction.mdx b/docs/reference/settings/player/enableuserinteraction.mdx index 0627393..7f9df78 100644 --- a/docs/reference/settings/player/enableuserinteraction.mdx +++ b/docs/reference/settings/player/enableuserinteraction.mdx @@ -1,37 +1,22 @@ --- title: player.enableUserInteraction -description: "Whether the default user interaction behavior should be active or not." sidebar_custom_props: category: Player since: 0.9.7 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether the default user interaction behavior should be active or not. This setting configures whether alphaTab provides the default user interaction features like selection of the playback range and "seek on click". By default users can select the desired playback range with the mouse and also jump to individual beats by click. This behavior can be contolled with this setting. - - -
{"enableUserInteraction"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}
- - -
{"bool"}{" "}{"EnableUserInteraction"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}
- - -
{"var"}{" "}{"enableUserInteraction"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}
- - + diff --git a/docs/reference/settings/player/nativebrowsersmoothscroll.mdx b/docs/reference/settings/player/nativebrowsersmoothscroll.mdx index 562f7fc..7a2be7f 100644 --- a/docs/reference/settings/player/nativebrowsersmoothscroll.mdx +++ b/docs/reference/settings/player/nativebrowsersmoothscroll.mdx @@ -1,29 +1,22 @@ --- title: player.nativeBrowserSmoothScroll -description: "Whether the native browser smooth scroll mechanism should be used over a custom animation." sidebar_custom_props: javaScriptOnly: true category: Player since: 1.2.3 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether the native browser smooth scroll mechanism should be used over a custom animation. This setting configures whether the [native browser feature](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollTo) for smooth scrolling should be used over a custom animation. -If this setting is enabled, options like {"scrollSpeed"} will not have an effect anymore. +If this setting is enabled, options like will not have an effect anymore. -
{"nativeBrowserSmoothScroll"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}
+ diff --git a/docs/reference/settings/player/outputmode.mdx b/docs/reference/settings/player/outputmode.mdx index 3f7136c..cd65397 100644 --- a/docs/reference/settings/player/outputmode.mdx +++ b/docs/reference/settings/player/outputmode.mdx @@ -1,27 +1,20 @@ --- title: player.outputMode -description: "The mode used for playing audio samples" sidebar_custom_props: javaScriptOnly: true category: Player - JavaScript Specific since: 1.3.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The mode used for playing audio samples Controls how alphaTab will play the audio samples in the browser. -
{"outputMode"}{":"}{" "}{"PlayerOutputMode"}{" "}{"="}{" "}{"PlayerOutputMode.WebAudioAudioWorklets"}{";"}
+ diff --git a/docs/reference/settings/player/playermode.mdx b/docs/reference/settings/player/playermode.mdx index 40d8851..d114db5 100644 --- a/docs/reference/settings/player/playermode.mdx +++ b/docs/reference/settings/player/playermode.mdx @@ -1,30 +1,21 @@ --- title: player.playerMode -description: "Whether the player should be enabled and which mode it should use." sidebar_custom_props: category: Player since: 1.6.0 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether the player should be enabled and which mode it should use. This setting configures whether the player feature is enabled or not. Depending on the platform enabling the player needs some additional actions of the developer. **Synthesizer** -If the synthesizer is used (via {"EnabledAutomatic"} or {"EnabledSynthesizer"}) a sound font is needed so that the midi synthesizer can produce the audio samples. +If the synthesizer is used (via or ) a sound font is needed so that the midi synthesizer can produce the audio samples. For the JavaScript version the [player.soundFont](/docs/reference/settings/player/soundfont) property must be set to the URL of the sound font that should be used or it must be loaded manually via API. For .net manually the soundfont must be loaded. @@ -44,15 +35,9 @@ to update the playback state and exterrnal audio position during playback. AlphaTab does not ship a default UI for the player. The API must be hooked up to some UI controls to allow the user to interact with the player. - - -
{"playerMode"}{":"}{" "}{"PlayerMode"}{" "}{"="}{" "}{"PlayerMode.Disabled"}{";"}
- - -
{"PlayerMode"}{" "}{"PlayerMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"PlayerMode.Disabled"}
- - -
{"var"}{" "}{"playerMode"}{":"}{" "}{"PlayerMode"}{" "}{"="}{" "}{"PlayerMode.Disabled"}
- - + diff --git a/docs/reference/settings/player/playtripletfeel.mdx b/docs/reference/settings/player/playtripletfeel.mdx index 9d256f2..a6d883b 100644 --- a/docs/reference/settings/player/playtripletfeel.mdx +++ b/docs/reference/settings/player/playtripletfeel.mdx @@ -1,36 +1,21 @@ --- title: player.playTripletFeel -description: "Whether the triplet feel should be played or only displayed." sidebar_custom_props: category: Player since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description Whether the triplet feel should be played or only displayed. If this setting is enabled alphaTab will play the triplet feels accordingly, if it is disabled the triplet feel is only displayed but not played. - - -
{"playTripletFeel"}{":"}{" "}{"boolean"}{" "}{"="}{" "}{"true"}{";"}
- - -
{"bool"}{" "}{"PlayTripletFeel"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"true"}
- - -
{"var"}{" "}{"playTripletFeel"}{":"}{" "}{"Boolean"}{" "}{"="}{" "}{"true"}
- - + diff --git a/docs/reference/settings/player/scrollelement.mdx b/docs/reference/settings/player/scrollelement.mdx index b8d6918..b279cd2 100644 --- a/docs/reference/settings/player/scrollelement.mdx +++ b/docs/reference/settings/player/scrollelement.mdx @@ -1,29 +1,22 @@ --- title: player.scrollElement -description: "The element to apply the scrolling on." sidebar_custom_props: javaScriptOnly: true category: Player - JavaScript Specific since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The element to apply the scrolling on. When the player is active, it by default automatically scrolls the browser window to the currently played bar. This setting defines which elements should be scrolled to bring the played bar into the view port. By default scrolling happens on the `html,body` selector. -
{"scrollElement"}{":"}{" "}{"string"}{" "}{"|"}{" "}{"HTMLElement"}{" "}{"="}{" "}{"html,body"}{";"}
+ diff --git a/docs/reference/settings/player/scrollmode.mdx b/docs/reference/settings/player/scrollmode.mdx index be69845..5276996 100644 --- a/docs/reference/settings/player/scrollmode.mdx +++ b/docs/reference/settings/player/scrollmode.mdx @@ -1,36 +1,21 @@ --- title: player.scrollMode -description: "The mode how to scroll." sidebar_custom_props: category: Player since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The mode how to scroll. This setting controls how alphaTab behaves for scrolling. - - -
{"scrollMode"}{":"}{" "}{"ScrollMode"}{" "}{"="}{" "}{"ScrollMode.Continuous"}{";"}
- - -
{"ScrollMode"}{" "}{"ScrollMode"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"ScrollMode.Continuous"}
- - -
{"var"}{" "}{"scrollMode"}{":"}{" "}{"ScrollMode"}{" "}{"="}{" "}{"ScrollMode.Continuous"}
- - + diff --git a/docs/reference/settings/player/scrolloffsetx.mdx b/docs/reference/settings/player/scrolloffsetx.mdx index 7d68f61..49e1a7b 100644 --- a/docs/reference/settings/player/scrolloffsetx.mdx +++ b/docs/reference/settings/player/scrolloffsetx.mdx @@ -1,38 +1,23 @@ --- title: player.scrollOffsetX -description: "The X-offset to add when scrolling." sidebar_custom_props: category: Player since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The X-offset to add when scrolling. When alphaTab does an auto-scrolling to the displayed bar, it will try to align the view port to the displayed bar. If due to some layout specifics or for aesthetics a small padding is needed, this setting allows an additional X-offset that is added to the scroll position. - - -
{"scrollOffsetX"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}
- - -
{"double"}{" "}{"ScrollOffsetX"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}
- - -
{"var"}{" "}{"scrollOffsetX"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}
- - + diff --git a/docs/reference/settings/player/scrolloffsety.mdx b/docs/reference/settings/player/scrolloffsety.mdx index 8147d1e..2849755 100644 --- a/docs/reference/settings/player/scrolloffsety.mdx +++ b/docs/reference/settings/player/scrolloffsety.mdx @@ -1,38 +1,23 @@ --- title: player.scrollOffsetY -description: "The Y-offset to add when scrolling." sidebar_custom_props: category: Player since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The Y-offset to add when scrolling. When alphaTab does an auto-scrolling to the displayed bar, it will try to align the view port to the displayed bar. If due to some layout specifics or for aesthetics a small padding is needed, this setting allows an additional Y-offset that is added to the scroll position. - - -
{"scrollOffsetY"}{":"}{" "}{"number"}{" "}{"="}{" "}{"0"}{";"}
- - -
{"double"}{" "}{"ScrollOffsetY"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"0"}
- - -
{"var"}{" "}{"scrollOffsetY"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"0"}
- - + diff --git a/docs/reference/settings/player/scrollspeed.mdx b/docs/reference/settings/player/scrollspeed.mdx index 45d1bfa..c7a03d0 100644 --- a/docs/reference/settings/player/scrollspeed.mdx +++ b/docs/reference/settings/player/scrollspeed.mdx @@ -1,38 +1,23 @@ --- title: player.scrollSpeed -description: "How fast the scrolling to the new position should happen." sidebar_custom_props: category: Player since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description How fast the scrolling to the new position should happen. If possible from the platform, alphaTab will try to do a smooth scrolling to the played bar. This setting defines the speed of scrolling in milliseconds. -Note that {"nativeBrowserSmoothScroll"} must be set to `false` for this to have an effect. +Note that must be set to `false` for this to have an effect. - - -
{"scrollSpeed"}{":"}{" "}{"number"}{" "}{"="}{" "}{"300"}{";"}
- - -
{"double"}{" "}{"ScrollSpeed"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"300"}
- - -
{"var"}{" "}{"scrollSpeed"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"300"}
- - + diff --git a/docs/reference/settings/player/slide.mdx b/docs/reference/settings/player/slide.mdx index c4a5a28..76ed84a 100644 --- a/docs/reference/settings/player/slide.mdx +++ b/docs/reference/settings/player/slide.mdx @@ -1,24 +1,14 @@ --- title: player.slide -description: "The slide settings allow control how the different slide types are generated for audio." sidebar_custom_props: - domWildcard: true category: Player since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The slide settings allow control how the different slide types are generated for audio. AlphaTab supports various types of slides which can be grouped into 3 types: @@ -42,17 +32,11 @@ as there is no mechanism yet in alphaTab to play pick slides to make them sound For the first group only the duration or start point of the slide can be configured while for the second group the duration/start-point and the pitch offset can be configured. - - -
{"readonly"}{" "}{"slide"}{":"}{" "}{"SlidePlaybackSettings"}{";"}
- - -
{"SlidePlaybackSettings"}{" "}{"Slide"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"slide"}{":"}{" "}{"SlidePlaybackSettings"}
- - + import ManualDocs from './_slide.mdx'; diff --git a/docs/reference/settings/player/songbookbendduration.mdx b/docs/reference/settings/player/songbookbendduration.mdx index dc7af6b..9139d59 100644 --- a/docs/reference/settings/player/songbookbendduration.mdx +++ b/docs/reference/settings/player/songbookbendduration.mdx @@ -1,38 +1,23 @@ --- title: player.songBookBendDuration -description: "The bend duration in milliseconds for songbook bends." sidebar_custom_props: category: Player since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The bend duration in milliseconds for songbook bends. If the display mode `songbook` is enabled, this has an effect on the way bends are played. For songbook bends the bend is done very quickly at the end or start of the beat. This setting defines the play duration for those bends in milliseconds. This duration is in milliseconds unlike some other settings which are in midi ticks. The reason is that on songbook bends, the bends should always be played in the same speed, regardless of the song tempo. Midi ticks are tempo dependent. - - -
{"songBookBendDuration"}{":"}{" "}{"number"}{" "}{"="}{" "}{"75"}{";"}
- - -
{"double"}{" "}{"SongBookBendDuration"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"75"}
- - -
{"var"}{" "}{"songBookBendDuration"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"75"}
- - + diff --git a/docs/reference/settings/player/songbookdipduration.mdx b/docs/reference/settings/player/songbookdipduration.mdx index 28dfb2f..a765953 100644 --- a/docs/reference/settings/player/songbookdipduration.mdx +++ b/docs/reference/settings/player/songbookdipduration.mdx @@ -1,38 +1,23 @@ --- title: player.songBookDipDuration -description: "The duration of whammy dips in milliseconds for songbook whammys." sidebar_custom_props: category: Player since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The duration of whammy dips in milliseconds for songbook whammys. If the display mode `songbook` is enabled, this has an effect on the way whammy dips are played. For songbook dips the whammy is pressed very quickly at the start of the beat. This setting defines the play duration for those whammy bars in milliseconds. This duration is in milliseconds unlike some other settings which are in midi ticks. The reason is that on songbook dips, the whammy should always be pressed in the same speed, regardless of the song tempo. Midi ticks are tempo dependent. - - -
{"songBookDipDuration"}{":"}{" "}{"number"}{" "}{"="}{" "}{"150"}{";"}
- - -
{"double"}{" "}{"SongBookDipDuration"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"set"}{";"}{" "}{"}"}{" "}{"="}{" "}{"150"}
- - -
{"var"}{" "}{"songBookDipDuration"}{":"}{" "}{"Double"}{" "}{"="}{" "}{"150"}
- - + diff --git a/docs/reference/settings/player/soundfont.mdx b/docs/reference/settings/player/soundfont.mdx index f9f6d0d..44eff83 100644 --- a/docs/reference/settings/player/soundfont.mdx +++ b/docs/reference/settings/player/soundfont.mdx @@ -1,27 +1,20 @@ --- title: player.soundFont -description: "The sound font file to load for the player." sidebar_custom_props: javaScriptOnly: true category: Player - JavaScript Specific since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The sound font file to load for the player. When the player is enabled the soundfont from this URL will be loaded automatically after the player is ready. -
{"soundFont"}{":"}{" "}{"string"}{" "}{"|"}{" "}{"null"}{" "}{"="}{" "}{"null"}{";"}
+ diff --git a/docs/reference/settings/player/vibrato.mdx b/docs/reference/settings/player/vibrato.mdx index 58fdb1f..54b3fb4 100644 --- a/docs/reference/settings/player/vibrato.mdx +++ b/docs/reference/settings/player/vibrato.mdx @@ -1,23 +1,14 @@ --- title: player.vibrato -description: "The Vibrato settings allow control how the different vibrato types are generated for audio." sidebar_custom_props: category: Player since: 0.9.6 --- -import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable'; -import CodeBlock from '@theme/CodeBlock'; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { CodeBadge } from '@site/src/components/CodeBadge'; -import { SinceBadge } from '@site/src/components/SinceBadge'; -import DynHeading from '@site/src/components/DynHeading'; -import Link from '@docusaurus/Link'; +import { Tabs, TabItem, CodeBadge, SinceBadge, DynHeading, Link, Signature, PropertyDescription } from '@site/src/reference-commons' -import { SettingsHeader } from '@site/src/components/SettingsHeader'; - - + + ### Description The Vibrato settings allow control how the different vibrato types are generated for audio. AlphaTab supports 4 types of vibratos, for each vibrato the amplitude and the wavelength can be configured. The amplitude controls how many semitones @@ -29,17 +20,11 @@ The 4 vibrato types are: 3. Note Slight - A fast vibrato on a single note. This vibrato is usually done with the finger on the fretboard. 4. Note Wide - A slow vibrato on a single note. This vibrato is usually done with the finger on the fretboard. - - -
{"readonly"}{" "}{"vibrato"}{":"}{" "}{"VibratoPlaybackSettings"}{";"}
- - -
{"VibratoPlaybackSettings"}{" "}{"Vibrato"}{" "}{"{"}{" "}{"get"}{";"}{" "}{"}"}
- - -
{"val"}{" "}{"vibrato"}{":"}{" "}{"VibratoPlaybackSettings"}
- - + import ManualDocs from './_vibrato.mdx'; diff --git a/docs/showcase/special-tracks.mdx b/docs/showcase/special-tracks.mdx index 0801db8..d66b7bd 100644 --- a/docs/showcase/special-tracks.mdx +++ b/docs/showcase/special-tracks.mdx @@ -9,12 +9,12 @@ AlphaTab uses the same drum tab notation as Guitar Pro 5. Since the guitar tab s percussion track, it's hidden in case a drum tab is displayed. -## Numbered musical notation (jiǎnpǔ) since 1.4.0 +## Numbered musical notation (jiǎnpǔ) since 1.4.0 A notation system mainly used in Asian countries like China. -## Slash notation since 1.4.0 +## Slash notation since 1.4.0 A notation system focusing on rhythmic aspects. @@ -23,7 +23,7 @@ A notation system focusing on rhythmic aspects. With Guitar Pro 6 files also grand staffs can be rendered. -## Percussion since 1.1.0 +## Percussion since 1.1.0 Percussion tracks are similar to drum tabs but might have less lines than a normal staff. \ No newline at end of file diff --git a/docs/tutorials.mdx b/docs/tutorials.mdx index e27b3f3..d897578 100644 --- a/docs/tutorials.mdx +++ b/docs/tutorials.mdx @@ -19,5 +19,5 @@ ultimately up to you to plan and design how your application should look like an These tutorials are meant to learn all the required steps to configure and interact with alphaTab. - - + + diff --git a/scripts/generate-alphatabdoc.mts b/scripts/generate-alphatabdoc.mts index 9c548aa..5f64ad4 100644 --- a/scripts/generate-alphatabdoc.mts +++ b/scripts/generate-alphatabdoc.mts @@ -2,9 +2,9 @@ import path from "path"; import url from "url"; import ts, { JSDocParsingMode } from "typescript"; import { generateSettings } from "./generate-settings.mjs"; -import { GenerateContext } from "./typeschema.mjs"; +import { GenerateContext, repositoryRoot } from "./typeschema.mjs"; import { generateTypeDocs } from "./generate-typedocs.mjs"; -import { cconsole } from "./generate-common.mjs"; +import { cconsole, TypeReferencedCodeToken } from "./generate-common.mjs"; import { generateApiDocs } from "./generate-api.mjs"; const alphaTabEntryFile = url.fileURLToPath( @@ -140,7 +140,7 @@ for (const { d, identifier } of exports) { ts.isEnumDeclaration(d) || ts.isClassDeclaration(d) || ts.isInterfaceDeclaration(d) || - ts.isTypeAliasDeclaration(d) + ts.isTypeAliasDeclaration(d) ) { context.flatExports.set(e, d); context.nameToExportName.set(i, e); @@ -157,3 +157,69 @@ context.emptyFiles = process.argv.includes("--empty"); await generateSettings(context); await generateTypeDocs(context); await generateApiDocs(context); + +// styles for syntax highlighting +import { PrismTheme, PrismThemeEntry, themes as prismThemes } from "prism-react-renderer"; +import { openFileStream } from "./util.mjs"; + +await using styles = await openFileStream(path.join( + repositoryRoot, + 'src', + 'css', + 'highlight.scss' +)); + +function toKebabCase(s: string): string { + return s.replaceAll(/[A-Z]/g, (m) => `-${m.toLowerCase()}`) +} +function prismToCss(entry: PrismThemeEntry): [string, string][] { + return Object.entries(entry).map(e => ([toKebabCase(e[0]), e[1]]) as [string, string]); +} + +async function writeStyles(theme: string, prismTheme: PrismTheme) { + await styles.writeLine(`[data-theme=${JSON.stringify(theme)}] {`) + + const themeLookup = new Map(); + + themeLookup.set("identifier", prismTheme.plain); + themeLookup.set("token", prismTheme.plain); + themeLookup.set("keyword", prismTheme.plain); + themeLookup.set("whitespace", prismTheme.plain); + + for (const styles of prismTheme.styles) { + if (styles.types.includes("variable")) { + themeLookup.set("identifier", styles.style); + } + if (styles.types.includes("punctuation")) { + themeLookup.set("token", styles.style); + } + if (styles.types.includes("keyword")) { + themeLookup.set("keyword", styles.style); + } + } + + await styles.writeLine(` code.codeBlockLines.generated, code.codeBlockLinesInline {`) + // plain style on container + for (const [k, v] of prismToCss(prismTheme.plain)) { + await styles.writeLine(` ${k}: ${v};`) + } + await styles.writeLine() + + // specific token kinds + for (const [kind, style] of themeLookup) { + await styles.writeLine(` .${kind} {`) + for (const [k, v] of prismToCss(style)) { + await styles.writeLine(` ${k}: ${v};`) + } + await styles.writeLine(` }`) + } + + await styles.writeLine(` }`) + await styles.writeLine(`}`) +} + +// aligned with "docusaurus.config.ts" +await writeStyles('light', prismThemes.github); +await writeStyles('dark', prismThemes.dracula); + + diff --git a/scripts/generate-api.mts b/scripts/generate-api.mts index cfdaf93..3a2b6eb 100644 --- a/scripts/generate-api.mts +++ b/scripts/generate-api.mts @@ -8,10 +8,13 @@ import { getSummary, isEvent, isTargetWeb, + ReferencePage, + ReferenceTableData, writeCommonImports, writeEventDetails, writeMethodDetails, writePropertyDetails, + writeReferenceTable, } from "./generate-common.mjs"; import ts from "typescript"; import { FileStream, openFileStream } from "./util.mjs"; @@ -42,6 +45,9 @@ export async function generateApiDocs(context: GenerateContext) { "alphaTab.AlphaTabApi" ) as ts.ClassDeclaration, false); + const categories = new ReferenceTableData(); + + for (const m of Array.from(members.values())) { if (isEvent(context, m)) { events.push(m as (typeof events)[0]); @@ -56,9 +62,19 @@ export async function generateApiDocs(context: GenerateContext) { } } - await writeProperties(context, basePath, properties); - await writeMethods(context, basePath, methods); - await writeEvents(context, basePath, events); + await writeProperties(context, basePath, properties, categories); + await writeMethods(context, basePath, methods, categories); + await writeEvents(context, basePath, events, categories); + + await writeReferenceTable( + path.join(repositoryRoot, + "docs", + "reference", + "_apiTable.mdx" + ), + 'Name', + categories + ) } async function writeProperties( @@ -68,20 +84,22 @@ async function writeProperties( | ts.PropertyDeclaration | ts.PropertySignature | ts.GetAccessorDeclaration - )[] + )[], + referenceTable: ReferenceTableData ) { for (const member of properties) { - await writePropertyPage(context, basePath, member); + await writePropertyPage(context, basePath, member, referenceTable); } } async function writeMethods( context: GenerateContext, basePath: string, - methods: (ts.MethodDeclaration | ts.MethodSignature)[] + methods: (ts.MethodDeclaration | ts.MethodSignature)[], + referenceTable: ReferenceTableData ) { for (const member of methods) { - await writeMethodPage(context, basePath, member); + await writeMethodPage(context, basePath, member, referenceTable); } } @@ -92,10 +110,11 @@ async function writeEvents( | ts.PropertyDeclaration | ts.PropertySignature | ts.GetAccessorDeclaration - )[] + )[], + referenceTable: ReferenceTableData ) { for (const member of events) { - await writeEventPage(context, basePath, member); + await writeEventPage(context, basePath, member, referenceTable); } } @@ -104,23 +123,33 @@ async function writeFrontMatter( fileStream: FileStream, memberName: string, member: ts.ClassElement | ts.TypeElement, - kind: string + kind: string, + referenceTable: ReferenceTableData, + additionalDependencies: string[] = [] ) { + const page: ReferencePage = { + title: memberName, + description: getSummary(context, member, false), + javaScriptOnly: isTargetWeb(context, member), + url: '/' + path.relative( + repositoryRoot, + fileStream.path + ).replaceAll('\\', '/').replaceAll('.mdx', '') + }; + const category = getCategory(context, member, " - Core"); + referenceTable.addPage(category, page); + await fileStream.write("---\n"); - await fileStream.write(`title: ${memberName}\n`); - await fileStream.write( - `description: ${JSON.stringify(getSummary(context, member, false))}\n` - ); + await fileStream.write(`title: ${page.title}\n`); await fileStream.write(`sidebar_custom_props:\n`); await fileStream.write(` kind: ${kind}\n`); - const isWebOnly = isTargetWeb(context, member); - if (isWebOnly) { + if (page.javaScriptOnly) { await fileStream.write(` javaScriptOnly: true\n`); } await fileStream.write( - ` category: ${getCategory(context, member, " - Core")}\n` + ` category: ${category}\n` ); const since = getJsDocTagText(context, member, "since"); @@ -130,11 +159,10 @@ async function writeFrontMatter( await fileStream.write("---\n"); - if(context.emptyFiles) { - return; - } - await writeCommonImports(fileStream); - + fileStream.suspend = context.emptyFiles; + + await writeCommonImports(fileStream, additionalDependencies); + if (since) { await fileStream.write(`\n`); } @@ -146,7 +174,8 @@ async function writePropertyPage( member: | ts.PropertyDeclaration | ts.PropertySignature - | ts.GetAccessorDeclaration + | ts.GetAccessorDeclaration, + referenceTable: ReferenceTableData ) { let memberName = member.name!.getText(); let fileName = memberName.toLowerCase(); @@ -158,14 +187,9 @@ async function writePropertyPage( await using fileStream = await openFileStream(filePath); - await writeFrontMatter(context, fileStream, memberName, member, "property"); - - if(context.emptyFiles){ - return; - } - - await fileStream.write( - "import { PropertyDescription } from '@site/src/components/PropertyDescription';\n\n" + await writeFrontMatter(context, fileStream, memberName, member, "property", + referenceTable, + ['PropertyDescription'] ); await fileStream.write("\n"); @@ -179,35 +203,30 @@ async function writeEventPage( member: | ts.PropertyDeclaration | ts.PropertySignature - | ts.GetAccessorDeclaration + | ts.GetAccessorDeclaration, + referenceTable: ReferenceTableData ) { const memberName = member.name!.getText(); const filePath = path.join(basePath, memberName.toLocaleLowerCase() + ".mdx"); await using fileStream = await openFileStream(filePath); - await writeFrontMatter(context, fileStream, memberName, member, "event"); - if(context.emptyFiles){ - return; - } - + await writeFrontMatter(context, fileStream, memberName, member, "event", referenceTable); await writeEventDetails(context, fileStream, member); } async function writeMethodPage( context: GenerateContext, basePath: string, - member: ts.MethodDeclaration | ts.MethodSignature + member: ts.MethodDeclaration | ts.MethodSignature, + referenceTable: ReferenceTableData ) { const memberName = member.name!.getText(); const filePath = path.join(basePath, memberName.toLocaleLowerCase() + ".mdx"); await using fileStream = await openFileStream(filePath); - await writeFrontMatter(context, fileStream, memberName, member, "method"); - if(context.emptyFiles){ - return; - } + await writeFrontMatter(context, fileStream, memberName, member, "method", referenceTable); await writeMethodDetails(context, fileStream, member); } diff --git a/scripts/generate-common.mts b/scripts/generate-common.mts index b73627f..3aa6891 100644 --- a/scripts/generate-common.mts +++ b/scripts/generate-common.mts @@ -1,4 +1,3 @@ -import { PrismThemeEntry, themes as prismThemes } from "prism-react-renderer"; import path from "path"; import fs from "fs"; import ts from "typescript"; @@ -9,7 +8,7 @@ import { valueOrFirstDeclarationInDts, } from "./typeschema.mjs"; import { styleText } from "util"; -import { FileStream, toPascalCase } from "./util.mjs"; +import { FileStream, openFileStream, toPascalCase } from "./util.mjs"; function toExampleKey(title: string) { return title @@ -78,13 +77,84 @@ export function isTargetWeb(context: GenerateContext, node: ts.Node): boolean { return isWebOnly; } -export function isDomWildcard( - context: GenerateContext, - node: ts.Node -): boolean { - return !!getJSDocTags(context, node).find( - (t) => t.tagName.text === "domWildcard" - ); +export type ReferencePage = { + title: string, + description: string, + javaScriptOnly: boolean, + url: string +}; + +export class ReferenceTableData { + public readonly categories = new Map(); + + public addPage(category: string, page: ReferencePage) { + let items = this.categories.get(category); + if (!items) { + items = []; + this.categories.set(category, items); + } + items.push(page); + + } +} + +export async function writeReferenceTable( + path: string, + type: string, + categories: ReferenceTableData) { + + await using table = await openFileStream(path); + + + await table.writeLine(`import { CodeBadge } from "@site/src/components/CodeBadge";`); + await table.writeLine(`import { Signature } from "@site/src/components/Signature";`); + await table.writeLine(); + await table.writeLine(``); + await table.writeLine(` `); + await table.writeLine(` `); + await table.writeLine(` `); + await table.writeLine(` `); + await table.writeLine(` `); + await table.writeLine(` `); + await table.writeLine(` `); + + const categoriesSorted = Array.from(categories.categories.entries()) + .sort((a, b) => { + return a[0].localeCompare(b[0]); + }); + + + for (const [category, pages] of categoriesSorted) { + await table.writeLine(` `); + + const sorted = pages + .sort((a, b) => { + const at = a.title; + const bt = b.title; + + if (at < bt) return -1; + if (at > bt) return 1; + + return 0; + }); + + for (const v of sorted) { + await table.writeLine(``); + await table.writeLine(` `); + await table.writeLine(` `); + await table.writeLine(``); + } + } + + await table.writeLine(` \n`); + await table.writeLine(`
${type}Summary
${category}
`); + await table.writeLine(` `); + await table.writeLine(` `); + await table.writeLine(` `); + await table.writeLine(` `); + await table.writeLine(` ${v.description}`); + await table.writeLine(`
\n`); + } export function getCategory( @@ -515,7 +585,7 @@ function getDeclarationReferenceUrl( case ts.SyntaxKind.PropertyDeclaration: case ts.SyntaxKind.PropertySignature: let page = (element as ts.ClassElement).name!.getText().toLowerCase(); - if(page === "index") { + if (page === "index") { page = "index_"; } return ( @@ -728,30 +798,61 @@ export async function writeMethodReturn( } } +export async function beginParameterTable( + fileStream: FileStream +) { + await fileStream.write(`\n`); + await fileStream.write(` \n`); + await fileStream.write(` \n`); + await fileStream.write(` \n`); + await fileStream.write(` \n`); + await fileStream.write(` \n`); + await fileStream.write(` \n`); + await fileStream.write(` \n`); +} + +export async function writeParameterRow( + fileStream: FileStream, + name: string, + description: string, +) { + await fileStream.write(`\n`); + await fileStream.write(` \n`); + await fileStream.write(` \n`); + await fileStream.write(`\n`); +} + +export async function endParameterTable( + fileStream: FileStream +) { + await fileStream.write(` \n`); + await fileStream.write(`
ParameterSummary
\n`); + await fileStream.write(` \n`); + await fileStream.write(` \n`); + for (const l of description.split('\n')) { + await fileStream.write(` ${l}\n`); + } + await fileStream.write(`
\n`); +} + export async function writeMethodParameters( context: GenerateContext, fileStream: FileStream, m: ts.MethodDeclaration | ts.MethodSignature ) { if (m.parameters.length > 0) { - await fileStream.write(`\n\n`); + await beginParameterTable(fileStream); for (let i = 0; i < m.parameters.length; i++) { - await fileStream.write( - ` \n` + ].name.getText(), + getFullDescription(context, m.parameters[i]) ); - - for (const line of getFullDescription(context, m.parameters[i]).split( - "\n" - )) { - await fileStream.write(` ${line}\n`); - } - - await fileStream.write(` \n`); } - await fileStream.write(`\n\n`); + + await endParameterTable(fileStream); } } @@ -761,15 +862,13 @@ export async function writeMethodSignatures( m: ts.MethodDeclaration | ts.MethodSignature ) { const isWebOnly = isTargetWeb(context, m); + const builder = new TypeReferencedCodeBuilder(context); + + await fileStream.writeLine( + `` - ); - await fileStream.writeLine(``); - } - const builder = new TypeReferencedCodeBuilder(context); if (m.modifiers) { for (const mod of m.modifiers) { builder.keyword(mod.getText()); @@ -810,12 +909,11 @@ export async function writeMethodSignatures( builder.whitespace(" "); builder.type(getTypeWithNullableInfo(context, m.type, true, false)); - await fileStream.writeLine(builder.toMdx("js", "block")); + await fileStream.writeLine( + ` js={${builder.toJSON("js")}}` + ); if (!isWebOnly) { - await fileStream.writeLine(``); - await fileStream.writeLine(``); - builder.reset(); if (m.modifiers) { for (const mod of m.modifiers) { @@ -861,10 +959,9 @@ export async function writeMethodSignatures( } builder.token(")"); - await fileStream.writeLine(builder.toMdx("c#", "block")); - - await fileStream.writeLine(``); - await fileStream.writeLine(``); + await fileStream.writeLine( + ` csharp={${builder.toJSON("c#")}}` + ); builder.reset(); @@ -902,33 +999,33 @@ export async function writeMethodSignatures( builder.whitespace(" "); builder.type(getTypeWithNullableInfo(context, m.type, false, false)); - await fileStream.writeLine(builder.toMdx("kotlin", "block")); - - await fileStream.writeLine(``); - await fileStream.writeLine(``); + await fileStream.writeLine( + ` kotlin={${builder.toJSON("kotlin")}}` + ); } + await fileStream.writeLine( + `/>` + ); + await fileStream.writeLine(); } -export async function writeCommonImports(fileStream: FileStream) { +export async function writeCommonImports(fileStream: FileStream, additionals: string[] = []) { await fileStream.writeLine(); - await fileStream.writeLine( - "import { ParameterTable, ParameterRow } from '@site/src/components/ParameterTable';" - ); - await fileStream.writeLine("import CodeBlock from '@theme/CodeBlock';"); - await fileStream.writeLine('import Tabs from "@theme/Tabs";'); - await fileStream.writeLine('import TabItem from "@theme/TabItem";'); - await fileStream.writeLine( - "import { CodeBadge } from '@site/src/components/CodeBadge';" - ); - await fileStream.writeLine( - "import { SinceBadge } from '@site/src/components/SinceBadge';" - ); - await fileStream.writeLine( - "import DynHeading from '@site/src/components/DynHeading';" - ); - await fileStream.writeLine("import Link from '@docusaurus/Link';"); + const imports = [ + 'Tabs', + 'TabItem', + 'CodeBadge', + 'SinceBadge', + 'DynHeading', + 'Link', + 'Signature', + ...additionals + ]; + + await fileStream.writeLine(`import { ${imports.join(', ')} } from '@site/src/reference-commons'`); + await fileStream.writeLine(); } @@ -1092,16 +1189,12 @@ async function writePropertySignatures( m: ts.PropertySignature | ts.PropertyDeclaration | ts.GetAccessorDeclaration ) { const isWebOnly = isTargetWeb(context, m); - - if (!isWebOnly) { - await fileStream.writeLine( - `` - ); - await fileStream.writeLine(``); - } - const builder = new TypeReferencedCodeBuilder(context); + await fileStream.writeLine( + ``); - await fileStream.writeLine(``); - const isReadonly = m.modifiers?.some((mod) => mod.kind === ts.SyntaxKind.ReadonlyKeyword) || (ts.isGetAccessor(m) && @@ -1210,10 +1302,10 @@ async function writePropertySignatures( builder.identifier(defaultValue); } - await fileStream.writeLine(builder.toMdx("c#", "block")); + await fileStream.writeLine( + ` csharp={${builder.toJSON("c#")}}` + ); - await fileStream.writeLine(``); - await fileStream.writeLine(``); builder.reset(); if (isStatic) { @@ -1249,17 +1341,19 @@ async function writePropertySignatures( builder.token("}"); } - await fileStream.writeLine(builder.toMdx("kotlin", "block")); - - await fileStream.writeLine(``); - await fileStream.writeLine(``); + await fileStream.writeLine( + ` kotlin={${builder.toJSON("kotlin")}}` + ); } + await fileStream.writeLine( + `/>` + ); await fileStream.writeLine(); } type TypeReferencedCodeLink = { link: string; linkText: string }; -type TypeReferencedCodeToken = { +export type TypeReferencedCodeToken = { kind: "identifier" | "token" | "keyword" | "whitespace" | "type" | "link"; content: string | TypeWithNullableInfo | TypeReferencedCodeLink; }; @@ -1269,7 +1363,7 @@ type TypeReferencedCodeLanguage = "js" | "c#" | "kotlin"; export class TypeReferencedCodeBuilder { private chunks: TypeReferencedCodeToken[] = []; - public constructor(private context: GenerateContext) {} + public constructor(private context: GenerateContext) { } public identifier(s: string) { this.chunks.push({ kind: "identifier", content: s }); @@ -1346,75 +1440,49 @@ export class TypeReferencedCodeBuilder { this.chunks = []; } - public toMdx( - language: TypeReferencedCodeLanguage, - style: "block" | "inline" - ) { - // NOTE: no dark theme - const theme = prismThemes.github; - const lookup = new Map(); - - lookup.set("identifier", theme.plain); - lookup.set("token", theme.plain); - lookup.set("keyword", theme.plain); - lookup.set("whitespace", theme.plain); - - for (const styles of theme.styles) { - if (styles.types.includes("variable")) { - lookup.set("identifier", styles.style); - } - if (styles.types.includes("punctuation")) { - lookup.set("token", styles.style); - } - if (styles.types.includes("keyword")) { - lookup.set("keyword", styles.style); - } - } - - let code = ""; - - switch (style) { - case "inline": - code += ``; - break; - case "block": - code += `
`;
-        code += ``;
-        break;
-    }
-
+  public toJSON(language: TypeReferencedCodeLanguage) {
     const translated = this.translateChunks(this.chunks, language);
 
+    const json: any[] = [];
     for (const chunk of translated) {
       switch (chunk.kind) {
         case "identifier":
         case "token":
         case "keyword":
         case "whitespace":
-          code +=
-            `{` +
-            JSON.stringify(chunk.content as string) +
-            `}`;
+          json.push([chunk.kind, chunk.content.toString()]);
           break;
 
         // case "type": // rewritten during translateChunks
         //   break;
         case "link":
           const link = chunk.content as TypeReferencedCodeLink;
-          code += `{${JSON.stringify(link.linkText)}}`;
+          json.push(['identifier', link.linkText, link.link]);
           break;
       }
     }
 
-    switch (style) {
-      case "inline":
-        code += "";
+    return JSON.stringify(json);
+  }
+
+
+  public toMdx(
+    language: TypeReferencedCodeLanguage,
+    style: "block" | "inline"
+  ) {
+    let code = `
`; + case "kotlin": + code += 'kotlin'; break; } - + code += '={' + this.toJSON(language) + '} />'; return code; } @@ -1894,3 +1962,23 @@ export class TypeReferencedCodeBuilder { } } } + + +export function escapeHtmlEntities(input: string): string { + if (input === null || input === undefined) return ""; + const map: Record = { + "&": "&", + "<": "<", + ">": ">", + '"': """, + "'": "'", + "/": "/", + "`": "`", + "{": "\\{", + "}": "\\}", + }; + + return input.replace(/[\u00A0-\u9999<>&"'\/`\{\}]/g, (ch) => { + return map[ch] ?? `&#${ch.charCodeAt(0)};`; + }); +} \ No newline at end of file diff --git a/scripts/generate-settings.mts b/scripts/generate-settings.mts index c904f8f..042f240 100644 --- a/scripts/generate-settings.mts +++ b/scripts/generate-settings.mts @@ -7,12 +7,14 @@ import { getCategory, getJsDocTagText, getSummary, - isDomWildcard, isJsonOnParent, isTargetWeb, + ReferencePage, + ReferenceTableData, repositoryRoot, writeCommonImports, writePropertyDetails, + writeReferenceTable, } from "./generate-common.mjs"; import { GenerateContext } from "./typeschema.mjs"; import { openFileStream } from "./util.mjs"; @@ -28,15 +30,21 @@ export async function generateSettings(context: GenerateContext) { return ts.isPropertyDeclaration(m) && !isStatic; }) as ts.PropertyDeclaration[]; + + const categories = new ReferenceTableData(); for (const m of allProps) { - const basePath = path.join( - repositoryRoot, + const basePathRelative = path.join( "docs", "reference", "settings", m.name.getText().toLowerCase() ); + const basePath = path.join( + repositoryRoot, + basePathRelative + ); + const subSettingType = context.checker.getTypeAtLocation(m).symbol.valueDeclaration; if (subSettingType && ts.isClassDeclaration(subSettingType)) { @@ -48,41 +56,43 @@ export async function generateSettings(context: GenerateContext) { ); if (ts.isPropertyDeclaration(member) && !isSubSettingPropStatic) { + const settingFileName = member.name.getText().toLowerCase() + ".mdx"; const settingFile = path.join( basePath, - member.name.getText().toLowerCase() + ".mdx" + settingFileName ); await fs.promises.mkdir(basePath, { recursive: true }); await using fileStream = await openFileStream(settingFile); await fileStream.write("---\n"); - await fileStream.write( - `title: ${m.name.getText()}.${member.name.getText()}\n` - ); + + const page: ReferencePage = { + title: `${m.name.getText()}.${member.name.getText()}`, + description: getSummary(context, member, false), + javaScriptOnly: isTargetWeb(context, member), + url: '/' + path.join(basePathRelative, settingFileName).replaceAll('\\', '/').replaceAll('.mdx', '') + }; + + const category = getCategory(context, member, ""); + categories.addPage(category, page); await fileStream.write( - `description: ${JSON.stringify( - getSummary(context, member, false) - )}\n` + `title: ${page.title}\n` ); + await fileStream.write(`sidebar_custom_props:\n`); - const isWebOnly = isTargetWeb(context, member); - if (isWebOnly) { + if (page.javaScriptOnly) { await fileStream.write(` javaScriptOnly: true\n`); } - if (isDomWildcard(context, member)) { - await fileStream.write(` domWildcard: true\n`); - } - if (isJsonOnParent(context, m)) { await fileStream.write(` jsOnParent: true\n`); } await fileStream.write( - ` category: ${getCategory(context, member, "")}\n` + ` category: ${category}\n` ); const since = getJsDocTagText(context, member, "since"); @@ -90,22 +100,28 @@ export async function generateSettings(context: GenerateContext) { await fileStream.write("---\n"); - if (context.emptyFiles) { - continue; - } + fileStream.suspend = context.emptyFiles; + await writeCommonImports(fileStream, ['PropertyDescription']); - await writeCommonImports(fileStream); + if (since) { + await fileStream.write(`\n`); + } - await fileStream.write( - "import { SettingsHeader } from '@site/src/components/SettingsHeader';\n\n" - ); - await fileStream.write(`\n`); + await fileStream.write(`\n`); await writePropertyDetails(context, fileStream, member); } } } } + + await writeReferenceTable(path.join( + repositoryRoot, + "docs", + "reference", + "_settingsTable.mdx" + ), 'Property', categories); + } finally { disableWarningsOnMissingDocs(); } diff --git a/scripts/generate-typedocs.mts b/scripts/generate-typedocs.mts index e629655..d79f492 100644 --- a/scripts/generate-typedocs.mts +++ b/scripts/generate-typedocs.mts @@ -45,10 +45,7 @@ export async function generateTypeDocs(context: GenerateContext) { await fileStream.write(`title: ${exportedName}\n`); await fileStream.write("---\n"); - if(context.emptyFiles){ - fileStream.suspend = true; - } - + fileStream.suspend = context.emptyFiles; await writeCommonImports(fileStream); await fileStream.write( @@ -440,10 +437,7 @@ async function writeFrontMatter( await fileStream.write("---\n"); - if(context.emptyFiles){ - return; - } - + fileStream.suspend = context.emptyFiles; await writeCommonImports(fileStream); if (since) { @@ -470,10 +464,6 @@ async function writePropertyPage( await using fileStream = await openFileStream(filePath); await writeFrontMatter(context, fileStream, memberName, member, "property"); - if(context.emptyFiles){ - return; - } - await writePropertyDetails(context, fileStream, member); } @@ -491,10 +481,6 @@ async function writeEventPage( await using fileStream = await openFileStream(filePath); await writeFrontMatter(context, fileStream, memberName, member, "event"); - if(context.emptyFiles){ - return; - } - await writeEventDetails(context, fileStream, member); } @@ -509,10 +495,6 @@ async function writeMethodPage( await using fileStream = await openFileStream(filePath); await writeFrontMatter(context, fileStream, memberName, member, "method"); - if(context.emptyFiles){ - return; - } - await writeMethodDetails(context, fileStream, member); } diff --git a/scripts/util.mts b/scripts/util.mts index ad2763b..af5fdbc 100644 --- a/scripts/util.mts +++ b/scripts/util.mts @@ -12,9 +12,10 @@ export async function openFileStream(path: string): Promise { let _suspended = false; const write = async (s: string) => { - if(!_suspended) { - await fileStream.write(s); + if (_suspended) { + return; } + await fileStream.write(s); }; const writeLine = (s?: string) => { if (s) { @@ -33,9 +34,9 @@ export async function openFileStream(path: string): Promise { writeLine, [Symbol.asyncDispose]: asyncDispose, get suspend() { - return _suspended + return _suspended }, - set suspend(v:boolean){ + set suspend(v: boolean) { _suspended = v; } }; diff --git a/src/components/ParameterTable/index.tsx b/src/components/ParameterTable/index.tsx deleted file mode 100644 index cd7d22f..0000000 --- a/src/components/ParameterTable/index.tsx +++ /dev/null @@ -1,58 +0,0 @@ -import React from "react"; -import { CodeBadge, Platform } from "../CodeBadge"; -import { SinceBadge } from "../SinceBadge"; -import { MarkdownString } from "../MarkdownString"; - -function renderChild(child: React.ReactNode): React.ReactNode { - if (typeof child === "string") { - return ; - } else { - return child; - } -} - -export type ParameterRowProps = { - children: React.ReactNode; - platform: Platform; - name: string; - since?: string; -}; - -export const ParameterRow: React.FC = ({ - children, - platform, - name, - since, -}) => { - return ( - - - - - - {Array.isArray(children) - ? React.Children.map(children, renderChild) - : renderChild(children as any)} - {since && } - - - ); -}; - -export type ParameterTableProps = { - children: React.ReactNode; -}; - -export const ParameterTable: React.FC = ({ children }) => { - return ( - - - - - - - - {children} -
ParameterSummary
- ); -}; diff --git a/src/components/RasgueadoPatterns/index.tsx b/src/components/RasgueadoPatterns/index.tsx index b5ddfbf..0c7d476 100644 --- a/src/components/RasgueadoPatterns/index.tsx +++ b/src/components/RasgueadoPatterns/index.tsx @@ -405,7 +405,7 @@ export function RasgueadoPatterns() { return (
{patterns.map((p) => ( - + ))}
); diff --git a/src/components/ReferenceTable/index.tsx b/src/components/ReferenceTable/index.tsx deleted file mode 100644 index 620cc79..0000000 --- a/src/components/ReferenceTable/index.tsx +++ /dev/null @@ -1,160 +0,0 @@ -import React, { useEffect, useState } from "react"; -import { Page } from "@site/src/page"; -import { buildNames } from "@site/src/names"; -import { CodeBadge } from "../CodeBadge"; -import { - PropSidebarItem, - PropSidebarItemCategory, -} from "@docusaurus/plugin-content-docs"; -import { useDocById } from "@docusaurus/plugin-content-docs/client"; -import { MarkdownString } from "../MarkdownString"; -import { useLocation } from "@docusaurus/router"; - -function buildPropertyUrl(property: Page) { - let url = ""; - if (property.prop("todo", false)) { - url = "#todo"; - } else { - url = property.prop("link", ""); - } - return url; -} - -type ReferenceRowProps = { property: Page; showJson: boolean }; - -const ReferenceRow: React.FC = ({ property, showJson }) => { - const { mainName, javaScriptOnly } = - buildNames(property); - - return ( - - - - - - - - - ); -}; - -type ReferenceCategoryProps = { - name: string; - pages: Page[]; - showJson: boolean; -}; - -const ReferenceCategory: React.FC = ({ - name, - pages, - showJson, -}) => { - const rows = pages - .sort((a, b) => { - const ao = a.prop("order", 1000); - const bo = b.prop("order", 1000); - - if (ao < bo) return -1; - if (ao > bo) return 1; - - const at = a.prop("title", ""); - const bt = b.prop("title", ""); - - if (at < bt) return -1; - if (at > bt) return 1; - - return 0; - }) - .map((p, i) => ( - - )); - return ( - <> - - {name} - - {rows} - - ); -}; - -function collectPages(target: PropSidebarItem[], items: PropSidebarItem[]) { - for (const item of items) { - if (item.type === "category") { - collectPages(target, item.items); - } else if (item.type === "link") { - target.push(item); - } - } -} - -export interface ReferenceTableProps { - currentSidebarCategory: PropSidebarItemCategory; - type: string; - showJson: boolean; -} - -export const ReferenceTable: React.FC = ({ - currentSidebarCategory, - type, - showJson, -}: ReferenceTableProps) => { - const allPages: PropSidebarItem[] = []; - collectPages(allPages, currentSidebarCategory.items); - const existingKeys = new Map(); - const pages: { key: string; items: Page[] }[] = []; - for (const page of allPages) { - if (page.type === "link" && page.docId?.startsWith('_') === true) { - continue; - } - - const category = (page.customProps?.category as string) ?? ""; - let items = existingKeys.get(category); - if (!items) { - items = []; - existingKeys.set(category, items); - pages.push({ key: category, items: items }); - } - - const doc = page.type === "link" ? useDocById(page.docId) : undefined; - items.push(new Page(page, doc)); - } - pages.sort((a, b) => { - return a.key.localeCompare(b.key); - }); - - const categories = pages.map((p) => ( - - )); - - const { hash } = useLocation(); - useEffect(() => { - const id = hash.replace('#', ''); - const element = document.getElementById(id); - if (element) { - setTimeout(() => { - element.scrollIntoView({ - behavior: 'auto', - block: 'center', - }); - }, 100); - } - }, []); - - return ( - - - - - - - - {categories} -
{type}Summary
- ); -}; diff --git a/src/components/SettingsHeader/index.tsx b/src/components/SettingsHeader/index.tsx deleted file mode 100644 index eda818f..0000000 --- a/src/components/SettingsHeader/index.tsx +++ /dev/null @@ -1,15 +0,0 @@ -import React from "react"; -import { useDoc } from "@docusaurus/plugin-content-docs/client"; -import { SinceBadge } from "../SinceBadge"; -import { PropertyDescription } from "../PropertyDescription"; - -export const SettingsHeader: React.FC = () => { - const doc = useDoc(); - const since = doc.frontMatter.sidebar_custom_props?.since; - return ( - <> - {since && } - - - ); -}; diff --git a/src/components/Signature/index.tsx b/src/components/Signature/index.tsx new file mode 100644 index 0000000..4cc33ef --- /dev/null +++ b/src/components/Signature/index.tsx @@ -0,0 +1,96 @@ +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import { FC } from "react"; +import Link from "@docusaurus/Link"; + +export type SignatureToken = + [string, string] | [string, string, string]; + +export type SignatureProps = { + style: 'block' | 'inline', + js: SignatureToken[], + csharp?: SignatureToken[], + kotlin?: SignatureToken[], +} + + +type SignatureItemTokenProps = { + token: SignatureToken, +}; + +export const SignatureItemToken: FC = ({ token }) => { + if (token.length === 2) { + return ( + {token[1]} + ) + } else { + return ( + {token[1]} + ) + } +} + +type SignatureItemProps = { + style: 'block' | 'inline', + tokens: SignatureToken[], +}; + + +export const SignatureItem: FC = ({ style, tokens }) => { + switch (style) { + case "inline": + return ( + + {tokens.map((t, i) => )} + + ) + break; + case "block": + return ( +
+
+ 
+                            
+                                {tokens.map((t, i) => )}
+                            
+
+
+
+ ) + } +} + +export const Signature: FC = ({ style, js, csharp, kotlin }) => { + const items = [ + { + label: 'JavaScript', + value: 'js', + tokens: js + }, + { + label: 'C#', + value: 'cs', + tokens: csharp + }, + { + label: 'Kotlin', + value: 'kt', + tokens: kotlin + } + ].filter(i => i.tokens !== undefined); + + if (items.length === 1) { + return (); + } + else { + return ({ label: i.label, value: i.value }))}> + {items.map(i => ( + + + + ))} + + } + +}; diff --git a/src/components/TypeTable/index.tsx b/src/components/TypeTable/index.tsx deleted file mode 100644 index 9336d1f..0000000 --- a/src/components/TypeTable/index.tsx +++ /dev/null @@ -1,105 +0,0 @@ -import React from "react"; -import { CodeBadge, Platform } from "../CodeBadge"; -import styles from "./styles.module.scss"; -import { MarkdownString } from "../MarkdownString"; - -function renderChild(child) { - if (typeof child === "string") { - return ; - } else { - return child; - } -} - -export type TypeRowProps = { - children: React.ReactNode; - type: Platform; - name: string; - link?: string; -}; - -export const TypeRow: React.FC = ({ - children, - type, - name, - link, -}) => { - if (children && type && name) { - return ( - - - {link ? ( - - - - ) : ( - - )} - - - {Array.isArray(children) - ? React.Children.map(children, renderChild) - : children} - - - ); - } else if (type && name) { - return ( - - - - - - ); - } else if (name) { - return ( - - - - - - ); - } -}; - -export type TypeTableProps = { - children: React.ReactNode; -}; - -export const TypeTable: React.FC = ({ children }) => { - var hasAnyRowValues = false; - if (Array.isArray(children)) { - for (let row of children) { - if ("props" in row && row.props.children) { - hasAnyRowValues = true; - break; - } - } - } else if ("props" in (children as any) && (children as any).props.children) { - hasAnyRowValues = true; - } - - if (hasAnyRowValues) { - return ( - - - - - - - - {children} -
TypeValues
- ); - } else { - return ( - - {children} -
- ); - } -}; diff --git a/src/components/TypeTable/styles.module.scss b/src/components/TypeTable/styles.module.scss deleted file mode 100644 index 1c4d219..0000000 --- a/src/components/TypeTable/styles.module.scss +++ /dev/null @@ -1,11 +0,0 @@ -table.type-table { - display: table; -} - -table.type-table td { - border: none; -} - -table.type-table td > p { - margin-bottom: 0.5em; -} diff --git a/src/css/custom.scss b/src/css/custom.scss index ba7fe24..09cfafc 100644 --- a/src/css/custom.scss +++ b/src/css/custom.scss @@ -3,6 +3,7 @@ * bundles Infima by default. Infima is a CSS framework designed to * work well for content-centric websites. */ +@use './highlight.scss'; @import "@fontsource/noto-sans/300.css"; @import "@fontsource/noto-sans/400.css"; @@ -275,4 +276,5 @@ body.playground { } -} \ No newline at end of file +} + diff --git a/src/css/highlight.scss b/src/css/highlight.scss new file mode 100644 index 0000000..85e7034 --- /dev/null +++ b/src/css/highlight.scss @@ -0,0 +1,42 @@ +[data-theme="light"] { + code.codeBlockLines.generated, code.codeBlockLinesInline { + color: #393A34; + background-color: #f6f8fa; + + .identifier { + color: #36acaa; + } + .token { + color: #393A34; + } + .keyword { + color: #00009f; + } + .whitespace { + color: #393A34; + background-color: #f6f8fa; + } + } +} +[data-theme="dark"] { + code.codeBlockLines.generated, code.codeBlockLinesInline { + color: #F8F8F2; + background-color: #282A36; + + .identifier { + color: rgb(189, 147, 249); + font-style: italic; + } + .token { + color: rgb(248, 248, 242); + } + .keyword { + color: rgb(189, 147, 249); + font-style: italic; + } + .whitespace { + color: #F8F8F2; + background-color: #282A36; + } + } +} diff --git a/src/names.ts b/src/names.ts index 13c2b81..6b4d30f 100644 --- a/src/names.ts +++ b/src/names.ts @@ -46,7 +46,6 @@ export function toDomEventNames(jsNames: string[]) { export function buildNames(property: Page) { const javaScriptOnly = property.prop("javaScriptOnly", false); - const domWildcard = property.prop("domWildcard", false); const category = property.prop("category", ""); let jsNames = property.props("title"); @@ -67,19 +66,6 @@ export function buildNames(property: Page) { jsNames.push(jsNames[0].split(".")[1]); } - let domNames = property.props("domName"); - if (property.prop("dom", true) && domNames.length === 0) { - if (category.startsWith("Events")) { - domNames = toDomEventNames(jsNames); - } else if (category.startsWith("Methods")) { - // no DOM method names on API - } else if (category.startsWith("Properties")) { - // no DOM properties on API - } else { - domNames = toDomSettingNames(jsNames, domWildcard); - } - } - if (category.startsWith("Methods")) { jsNames = jsNames.map((v) => `${v}()`); csNames = csNames.map((v) => `${v}()`); @@ -91,7 +77,6 @@ export function buildNames(property: Page) { javaScriptOnly, jsNames, csNames, - domNames, androidNames }; } diff --git a/src/reference-commons.tsx b/src/reference-commons.tsx new file mode 100644 index 0000000..a30b1b5 --- /dev/null +++ b/src/reference-commons.tsx @@ -0,0 +1,19 @@ +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import { CodeBadge } from './components/CodeBadge'; +import { SinceBadge } from './components/SinceBadge'; +import DynHeading from './components/DynHeading' +import { PropertyDescription } from './components/PropertyDescription' +import { Signature } from './components/Signature' +import Link from '@docusaurus/Link'; + +export { + Tabs, + TabItem, + CodeBadge, + SinceBadge, + DynHeading, + Link, + PropertyDescription, + Signature +} \ No newline at end of file