Skip to content

Commit e265827

Browse files
Danielku15Danielku15
committed
Some docs adjusted and events modified
1 parent 6843175 commit e265827

File tree

18 files changed

+381
-86
lines changed

18 files changed

+381
-86
lines changed

‎Documentation/input/reference/events/playedbeatchanged.cshtml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
Title: PlayedBeatChanged
2+
JsName: addPlayedBeatChanged();removePlayedBeatChanged()
3+
DomName: alphaTab.playedBeatChanged
4+
Category: Events - Player
5+
Description: This event is fired when the played beat changed.
6+
ShowInSideBar: false
7+
Since: 0.9.4
8+
---
9+
10+
<h2>Description</h2>
11+
<p>
12+
This event is fired when the played beat changed.
13+
</p>
14+
15+
<h2>Types</h2>
16+
17+
<table class="table table-striped table-condensed type-table">
18+
<tbody>
19+
<tr>
20+
<td><code>Action&lt;Beat&gt; <span class="code-badge">.net</span></code></td>
21+
</tr>
22+
<tr>
23+
<td><code>function(e) <span class="code-badge">JavaScript</span></code></td>
24+
</tr>
25+
</tbody>
26+
</table>
27+
28+
<h2>Parameters</h2>
29+
30+
<table class="table table-striped table-condensed type-table">
31+
<thead>
32+
<tr>
33+
<th>Parameters</th>
34+
<th>Type</th>
35+
<th>Summary</th>
36+
</tr>
37+
</thead>
38+
<tbody>
39+
<tr>
40+
<td><code>args <span class="code-badge">All</span></code></td>
41+
<td><code>AlphaTab.Model.Beat</code></td>
42+
<td>
43+
The new beat that is now being played.
44+
</td>
45+
</tr>
46+
</tbody>
47+
</table>
48+
49+
<h2>Example - C#</h2>
50+
51+
<pre>
52+
<code class="language-csharp line-numbers">
53+
var api = new AlphaTabApi<MyControl>(...);
54+
api.PlayedBeatChanged += beat =>
55+
{
56+
UpdateFretboard(args);
57+
};
58+
</code>
59+
</pre>
60+
61+
62+
<h2>Example - JavaScript</h2>
63+
64+
<pre>
65+
<code class="language-javascript line-numbers">
66+
var api = new alphaTab.platform.javaScript.AlphaTabApi(document.querySelector('#alphaTab'));
67+
api.addPlayedBeatChanged(function(args) {
68+
updateFretboard(beat);
69+
});
70+
</code>
71+
</pre>
72+
73+
<h2>Example - jQuery</h2>
74+
75+
<pre>
76+
<code class="language-javascript line-numbers">
77+
$('#alphaTab').on('alphaTab.playedBeatChanged', function(e, beat) {
78+
updateFretboard(beat);
79+
});
80+
</code>
81+
</pre>
82+
83+
<h2>Example - HTML</h2>
84+
85+
<pre>
86+
<code class="language-javaScript line-numbers">
87+
document.querySelector('#alphaTab').addEventListener('alphaTab.playedBeatChanged', function(e) {
88+
var beat = e.detail;
89+
updateFretboard(beat);
90+
}, false);
91+
</code>
92+
</pre>

‎Documentation/input/reference/events/playerpositionchanged.cshtml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ $('#alphaTab').on('alphaTab.positionChanged', function(e, args) {
139139
<pre>
140140
<code class="language-javaScript line-numbers">
141141
document.querySelector('#alphaTab').addEventListener('alphaTab.positionChanged', function(e) {
142-
var args = e.details;
142+
var args = e.detail;
143143
updatePlayerPosition(args);
144144
}, false);
145145
</code>

‎Documentation/input/reference/events/playerstatechanged.cshtml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ Since: 0.9.4
3838
<tbody>
3939
<tr>
4040
<td><code>args <span class="code-badge">All</span></code></td>
41-
<td><code>AlphaTab.PlayerStateChangedEventArgs</code></td>
41+
<td><code>AlphaTab.Audio.Synth.PlayerStateChangedEventArgs</code></td>
4242
<td>
4343
The information about the player state change event.
4444
</td>
4545
</tr>
4646
</tbody>
4747
</table>
4848

49-
<h2>AlphaTab.ResizeEventArgs Properties</h2>
49+
<h2>AlphaTab.Audio.Synth.PlayerStateChangedEventArgs Properties</h2>
5050

5151
<table class="table table-striped table-condensed type-table">
5252
<thead>
@@ -131,7 +131,7 @@ $('#alphaTab').on('alphaTab.playerStateChanged', function(e, args) {
131131
<pre>
132132
<code class="language-javaScript line-numbers">
133133
document.querySelector('#alphaTab').addEventListener('alphaTab.playerStateChanged', function(e) {
134-
var args = e.details;
134+
var args = e.detail;
135135
updatePlayerControls(args.State, args.Stopped);
136136
}, false);
137137
</code>

‎Documentation/input/reference/events/renderstarted.cshtml‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
Title: RenderStarted
2+
JsName: addRenderStarted();removeRenderStarted()
3+
DomName: alphaTab.render
4+
Category: Events - Core
5+
Description: This event is fired when the rendering of the whole music sheet is starting.
6+
ShowInSideBar: false
7+
Since: 0.9.4
8+
---
9+
10+
<h2>Description</h2>
11+
<p>
12+
This event is fired when the rendering of the whole music sheet is starting. All
13+
preparations are completed and the layout and render sequence is about to start.
14+
</p>
15+
16+
<h2>Types</h2>
17+
18+
<table class="table table-striped table-condensed type-table">
19+
<tbody>
20+
<tr>
21+
<td><code>Action <span class="code-badge">.net</span></code></td>
22+
</tr>
23+
<tr>
24+
<td><code>function() <span class="code-badge">JavaScript</span></code></td>
25+
</tr>
26+
</tbody>
27+
</table>
28+
29+
<h2>Parameters</h2>
30+
<table class="table table-striped table-condensed type-table">
31+
<thead>
32+
<tr>
33+
<th>Parameters</th>
34+
<th>Type</th>
35+
<th>Summary</th>
36+
</tr>
37+
</thead>
38+
<tbody>
39+
<tr>
40+
<td><code>resize <span class="code-badge">All</span></code></td>
41+
<td><code>bool</code></td>
42+
<td>
43+
Whether the rendering is triggered from a resize
44+
</td>
45+
</tr>
46+
</tbody>
47+
</table>
48+
49+
50+
<h2>Example - C#</h2>
51+
52+
<pre>
53+
<code class="language-csharp line-numbers">
54+
var api = new AlphaTabApi<MyControl>(...);
55+
api.RenderStarted += () =>
56+
{
57+
UpdateProgressBar("Rendering");
58+
};
59+
</code>
60+
</pre>
61+
62+
<h2>Example - JavaScript</h2>
63+
64+
<pre>
65+
<code class="language-javascript line-numbers">
66+
var api = new alphaTab.platform.javaScript.AlphaTabApi(document.querySelector('#alphaTab'));
67+
api.addRenderStarted(function() {
68+
updateProgressBar("Rendering");
69+
});
70+
</code>
71+
</pre>
72+
73+
<h2>Example - jQuery</h2>
74+
75+
<pre>
76+
<code class="language-javascript line-numbers">
77+
$('#alphaTab').on('alphaTab.render', function() {
78+
updateProgressBar("Rendering");
79+
});
80+
</code>
81+
</pre>
82+
83+
<h2>Example - HTML</h2>
84+
85+
<pre>
86+
<code class="language-javaScript line-numbers">
87+
document.querySelector('#alphaTab').addEventListener('alphaTab.render', function(e) {
88+
updateProgressBar("Rendering");
89+
}, false);
90+
</code>
91+
</pre>

‎Documentation/input/reference/events/resize.cshtml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ $('#alphaTab').on('alphaTab.resize', function(e, args) {
137137
<pre>
138138
<code class="language-javaScript line-numbers">
139139
document.querySelector('#alphaTab').addEventListener('alphaTab.resize', function(e) {
140-
var args = e.details;
140+
var args = e.detail;
141141
args.Settings.Scale = args.NewWidth > 1300
142142
? 1.5f
143143
: (args.NewWidth > 800) ? 1.3f : 1;

‎Documentation/input/reference/events/soundfontload.cshtml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
Title: SoundFontLoad
2+
JsName: addSoundFontLoad();removeSoundFontLoad()
3+
DomName: alphaTab.soundFontLoad
4+
Category: Events - Player
5+
Description: This event is fired when the SoundFont is being loaded.
6+
ShowInSideBar: false
7+
Since: 0.9.4
8+
---
9+
10+
<h2>Description</h2>
11+
<p>
12+
This event is fired when the SoundFont is being loaded and reports the progress accordingly.
13+
</p>
14+
15+
<h2>Types</h2>
16+
17+
18+
<table class="table table-striped table-condensed type-table">
19+
<tbody>
20+
<tr>
21+
<td><code>function(e) <span class="code-badge">JavaScript</span></code></td>
22+
</tr>
23+
</tbody>
24+
</table>
25+
26+
<h2>Parameters</h2>
27+
<table class="table table-striped table-condensed type-table">
28+
<thead>
29+
<tr>
30+
<th>Parameters</th>
31+
<th>Type</th>
32+
<th>Summary</th>
33+
</tr>
34+
</thead>
35+
<tbody>
36+
<tr>
37+
<td><code>args <span class="code-badge">All</span></code></td>
38+
<td><code>AlphaTab.ProgressEventArgs</code></td>
39+
<td>
40+
The information about the load progress of the file.
41+
</td>
42+
</tr>
43+
</tbody>
44+
</table>
45+
46+
<h2>Example - JavaScript</h2>
47+
48+
<pre>
49+
<code class="language-javascript line-numbers">
50+
var api = new alphaTab.platform.javaScript.AlphaTabApi(document.querySelector('#alphaTab'));
51+
api.addSoundFontLoad(function(e) {
52+
updateProgress(e.loaded, e.total);
53+
});
54+
</code>
55+
</pre>
56+
57+
<h2>Example - jQuery</h2>
58+
59+
<pre>
60+
<code class="language-javascript line-numbers">
61+
$('#alphaTab').on('alphaTab.soundFontLoad', function(e, score) {
62+
updateProgress(e.loaded, e.total);
63+
});
64+
</code>
65+
</pre>
66+
67+
68+
<h2>Example - HTML</h2>
69+
70+
<pre>
71+
<code class="language-javaScript line-numbers">
72+
document.querySelector('#alphaTab').addEventListener('alphaTab.soundFontLoad', function() {
73+
updateProgress(e.detail.loaded, e.detail.total);
74+
}, false);
75+
</code>
76+
</pre>

‎Source/AlphaTab.CSharp/Platform/CSharp/ManagedThreadScoreRenderer.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ private void Initialize(Settings settings)
5959
_renderer.PartialRenderFinished += result => _uiInvoke(() => OnPartialRenderFinished(result));
6060
_renderer.RenderFinished += result => _uiInvoke(() => OnRenderFinished(result));
6161
_renderer.PostRenderFinished += () => _uiInvoke(() => OnPostFinished(_renderer.BoundsLookup));
62-
_renderer.PreRender += () => _uiInvoke(OnPreRender);
62+
_renderer.PreRender += resize => _uiInvoke(()=>OnPreRender(resize));
6363
_renderer.Error += (s, e) => _uiInvoke(() => OnError(s, e));
6464
}
6565

@@ -145,14 +145,14 @@ public void RenderScore(Score score, int[] trackIndexes)
145145
}
146146
}
147147

148-
public event Action PreRender;
148+
public event Action<bool> PreRender;
149149

150-
protected virtual void OnPreRender()
150+
protected virtual void OnPreRender(bool isResize)
151151
{
152152
var handler = PreRender;
153153
if (handler != null)
154154
{
155-
handler();
155+
handler(isResize);
156156
}
157157
}
158158

‎Source/AlphaTab.CSharp/Platform/CSharp/ManagedUiFacade.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public IAlphaSynth CreateWorkerPlayer()
6565

6666
public virtual void InitialRender()
6767
{
68-
Api.Renderer.PreRender += () =>
68+
Api.Renderer.PreRender += resize =>
6969
{
7070
TotalResultCount.Enqueue(new Counter());
7171
};

‎Source/AlphaTab.JavaScript/Platform/JavaScript/AlphaTabWebWorker.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,10 @@ private void HandleMessage(Event e)
4949
cmd = "alphaTab.postRenderFinished",
5050
boundsLookup = _renderer.BoundsLookup.ToJson()
5151
});
52-
_renderer.PreRender += () => _main.PostMessage(new
52+
_renderer.PreRender += resize => _main.PostMessage(new
5353
{
54-
cmd = "alphaTab.preRender"
54+
cmd = "alphaTab.preRender",
55+
resize = resize
5556
});
5657
_renderer.Error += Error;
5758
break;

‎Source/AlphaTab.JavaScript/Platform/JavaScript/AlphaTabWorkerScoreRenderer.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ private void HandleWorkerMessage(Event e)
101101
switch (cmd)
102102
{
103103
case "alphaTab.preRender":
104-
OnPreRender();
104+
OnPreRender(data.resize);
105105
break;
106106
case "alphaTab.partialRenderFinished":
107107
OnPartialRenderFinished(data.result);
@@ -130,14 +130,14 @@ public void RenderScore(Score score, int[] trackIndexes)
130130
});
131131
}
132132

133-
public event Action PreRender;
133+
public event Action<bool> PreRender;
134134

135-
protected virtual void OnPreRender()
135+
protected virtual void OnPreRender(bool resize)
136136
{
137137
var handler = PreRender;
138138
if (handler != null)
139139
{
140-
handler();
140+
handler(resize);
141141
}
142142
}
143143

0 commit comments

Comments
 (0)