Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
helgoboss committed Nov 19, 2024
1 parent 858b2a6 commit 09c60a7
Show file tree
Hide file tree
Showing 99 changed files with 30 additions and 78 deletions.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#info-panel-stats-pre-buffer-fallback-count]
=== Pre-buffer fallbacks so far

image:generated/screenshots/elements/info-panel/stats/pre-buffer-fallback-count.png[Pre-buffer fallbacks so far, role="related thumb right"]
image::generated/screenshots/elements/info-panel/stats/pre-buffer-fallback-count.png[Pre-buffer fallbacks so far]

The number of times in which any audio clip's dynamic pre-buffer couldn't provide the desired pre-rendered audio content, but the static pre-buffer was able to provide it instead.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#info-panel-stats-pre-buffer-miss-count]
=== Pre-buffer misses so far

image:generated/screenshots/elements/info-panel/stats/pre-buffer-miss-count.png[Pre-buffer misses so far, role="related thumb right"]
image::generated/screenshots/elements/info-panel/stats/pre-buffer-miss-count.png[Pre-buffer misses so far]

The number of times in which any audio clip's dynamic pre-buffer couldn't provide the desired pre-rendered audio content and even the static pre-buffer failed to provide it.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#info-panel-stats-pre-buffered-blocks-playing-avg]
=== Pre-buffered blocks playing (avg)

image:generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-avg.png[Pre-buffered blocks playing (avg), role="related thumb right"]
image::generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-avg.png[Pre-buffered blocks playing (avg)]

The average number of pre-buffered blocks among currently playing audio clips.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#info-panel-stats-pre-buffered-blocks-playing-max]
=== Pre-buffered blocks playing (max)

image:generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-max.png[Pre-buffered blocks playing (max), role="related thumb right"]
image::generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-max.png[Pre-buffered blocks playing (max)]

The largest encountered number of pre-buffered blocks among currently playing audio clips.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#info-panel-stats-pre-buffered-blocks-playing-min]
=== Pre-buffered blocks playing (min)

image:generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-min.png[Pre-buffered blocks playing (min), role="related thumb right"]
image::generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-min.png[Pre-buffered blocks playing (min)]

The smallest encountered number of pre-buffered blocks among currently playing audio clips.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#info-panel-stats-tempo-buffer-size]
=== Tempo buffer size (in blocks)

image:generated/screenshots/elements/info-panel/stats/tempo-buffer-size.png[Tempo buffer size (in blocks), role="related thumb right"]
image::generated/screenshots/elements/info-panel/stats/tempo-buffer-size.png[Tempo buffer size (in blocks)]

The current size of the tempo buffer in blocks.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-clip-color]
== Color

image:generated/screenshots/elements/inspector/clip/color.png[Color, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/color.png[Color]

Lets you pick a color for this clip from the matrix color palette.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-clip-downbeat]
== Downbeat

image:generated/screenshots/elements/inspector/clip/downbeat.png[Downbeat, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/downbeat.png[Downbeat]

Which beat within the material can be considered the first downbeat.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-clip-length]
== Length

image:generated/screenshots/elements/inspector/clip/length.png[Length, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/length.png[Length]

Crops the clip to a specific length, starting from the start position.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-looped]
== Looped

image:generated/screenshots/elements/inspector/clip/looped.png[Looped, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/looped.png[Looped]

If enabled, the clip will loop until you stop it. If disabled, it will become a "One shot".
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-midi-channel]
== MIDI channel

image:generated/screenshots/elements/inspector/clip/midi-channel.png[MIDI channel, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/midi-channel.png[MIDI channel]

Allows you to re-route the MIDI events in this clip to a MIDI channel of your choice.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-name]
== Name

image:generated/screenshots/elements/inspector/clip/name.png[Name, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/name.png[Name]

Give your clip a descriptive name!
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-pitch]
== Pitch

image:generated/screenshots/elements/inspector/clip/pitch.png[Pitch, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/pitch.png[Pitch]

Allows you to adjust the pitch of this clip. In case of MIDI, only integers are supported.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-reset-behavior]
== Reset behavior

image:generated/screenshots/elements/inspector/clip/reset-behavior.png[Reset behavior, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/reset-behavior.png[Reset behavior]

Determines which MIDI reset messages Playtime sends before and/or after playing the clip.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-clip-source-cut-length]
== Source cut: Length

image:generated/screenshots/elements/inspector/clip/source-cut-length.png[Source cut: Length, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/source-cut-length.png[Source cut: Length]

Crops the source material to a specific length, starting from the start position. If the length exceeds the end of the source, Playtime will insert silence.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-clip-source-cut-start]
== Source cut: Start

image:generated/screenshots/elements/inspector/clip/source-cut-start.png[Source cut: Start, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/source-cut-start.png[Source cut: Start]

Sets the start position within the source material.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-source-info]
== Source info

image:generated/screenshots/elements/inspector/clip/source-info.png[Source info, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/source-info.png[Source info]

Displays information about the source of this clip, e.g. the audio file.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-start-position]
== Start position

image:generated/screenshots/elements/inspector/clip/start-position.png[Start position, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/start-position.png[Start position]

Sets the start position within the clip.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-start-timing]
== Start timing

image:generated/screenshots/elements/inspector/clip/start-timing.png[Start timing, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/start-timing.png[Start timing]

This overrides the start timing defined in the column or matrix settings.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-stop-timing]
== Stop timing

image:generated/screenshots/elements/inspector/clip/stop-timing.png[Stop timing, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/stop-timing.png[Stop timing]

This overrides the stop timing defined in the column or matrix settings.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-clip-sync-to-project-tempo]
== Sync to project tempo

image:generated/screenshots/elements/inspector/clip/sync-to-project-tempo.png[Sync to project tempo, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/sync-to-project-tempo.png[Sync to project tempo]

Whether to adjust the playback tempo of the clip to the project tempo. You usually want to have this enabled for rhythmic material.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-clip-time-signature]
== Time signature

image:generated/screenshots/elements/inspector/clip/time-signature.png[Time signature, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/time-signature.png[Time signature]

The original time signature in which the material has been recorded.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-velocity-sensitivity]
== Velocity sensitivity

image:generated/screenshots/elements/inspector/clip/velocity-sensitivity.png[Velocity sensitivity, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/velocity-sensitivity.png[Velocity sensitivity]

This overrides the velocity sensitivity defined in the column or matrix settings.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-volume]
== Volume

image:generated/screenshots/elements/inspector/clip/volume.png[Volume, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/volume.png[Volume]

Allows you to set the volume of this clip. In case of MIDI, it will adjust the velocity of played MIDI notes.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#settings-controller-color]
== Color

image:generated/screenshots/elements/settings/controller/color.png[Color, role="related thumb right"]
image::generated/screenshots/elements/settings/controller/color.png[Color]

Pick a color for this controller.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#settings-controller-connection]
== Connection

image:generated/screenshots/elements/settings/controller/connection.png[Connection, role="related thumb right"]
image::generated/screenshots/elements/settings/controller/connection.png[Connection]

How the controller is connected to this machine.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#settings-controller-default-controller-preset]
== Default controller preset

image:generated/screenshots/elements/settings/controller/default-controller-preset.png[Default controller preset, role="related thumb right"]
image::generated/screenshots/elements/settings/controller/default-controller-preset.png[Default controller preset]

In general, ReaLearn will figure out the correct controller preset based on the main preset's needs and the connected controller.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#settings-controller-enabled]
== Enabled

image:generated/screenshots/elements/settings/controller/enabled.png[Enabled, role="related thumb right"]
image::generated/screenshots/elements/settings/controller/enabled.png[Enabled]

If disabled, the controller will not have any effect.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#settings-controller-main-preset]
== Main preset

image:generated/screenshots/elements/settings/controller/main-preset.png[Main preset, role="related thumb right"]
image::generated/screenshots/elements/settings/controller/main-preset.png[Main preset]

This preset decides how your controller will be used, i.e. what exactly it should control.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#settings-controller-name]
== Name

image:generated/screenshots/elements/settings/controller/name.png[Name, role="related thumb right"]
image::generated/screenshots/elements/settings/controller/name.png[Name]

Descriptive name of the controller.

Expand Down

0 comments on commit 09c60a7

Please sign in to comment.