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 09c60a7 commit bc1771c
Show file tree
Hide file tree
Showing 80 changed files with 40 additions and 40 deletions.
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.
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.
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-resample-mode]
== Resample mode

image:generated/screenshots/elements/inspector/clip/resample-mode.png[Resample mode, role="related thumb right"]
image::generated/screenshots/elements/inspector/clip/resample-mode.png[Resample mode]

This overrides the resample mode defined in the column or matrix settings.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-source-fades]
== Source fades

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

By default, Playtime adds a fade-in/fade-out of just a few milliseconds at the start and the end of an audio clip. It does this in order to make loops sound smooth (= no clicks at the loop bounds). However, sometimes you deal with pre-produced samples that are *already* cut into perfect loops. In that case, you can disable this option to preserve the transients of the original audio material.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-clip-tempo]
== Tempo

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

The original tempo in which the audio material has been recorded.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-clip-time-stretch-mode]
== Time stretch mode

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

This overrides the time stretch mode defined in the column or matrix settings.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-column-custom-name]
== Custom name

image:generated/screenshots/elements/inspector/column/custom-name.png[Custom name, role="related thumb right"]
image::generated/screenshots/elements/inspector/column/custom-name.png[Custom name]

Makes it possible to assign the column a custom name.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-column-exclusive-mode]
== Exclusive mode

image:generated/screenshots/elements/inspector/column/exclusive-mode.png[Exclusive mode, role="related thumb right"]
image::generated/screenshots/elements/inspector/column/exclusive-mode.png[Exclusive mode]

If exclusive mode is enabled, only one slot at a time in this column can be playing. That's good for switching between different variations.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-column-follow-scenes]
== Follow scenes

image:generated/screenshots/elements/inspector/column/follow-scenes.png[Follow scenes, role="related thumb right"]
image::generated/screenshots/elements/inspector/column/follow-scenes.png[Follow scenes]

If the column follows scenes, playing a scene (= pressing the play button of the row) will trigger playback of the corresponding slot in this column. This is great for sketching out parts of a song.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-column-origin]
== Origin

image:generated/screenshots/elements/inspector/column/origin.png[Origin, role="related thumb right"]
image::generated/screenshots/elements/inspector/column/origin.png[Origin]

This decides from where to capture audio input during recording.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-column-playback-track]
== Playback track

image:generated/screenshots/elements/inspector/column/playback-track.png[Playback track, role="related thumb right"]
image::generated/screenshots/elements/inspector/column/playback-track.png[Playback track]

Lets you choose the REAPER track on which this column plays its clips.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-column-resample-mode]
== Resample mode

image:generated/screenshots/elements/inspector/column/resample-mode.png[Resample mode, role="related thumb right"]
image::generated/screenshots/elements/inspector/column/resample-mode.png[Resample mode]

This overrides the resample mode (defined in the matrix settings) for all clips in this column.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-column-start-timing]
== Start timing

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

This overrides the start timing (defined in the matrix settings) for all clips in this column.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-column-stop-timing]
== Stop timing

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

This overrides the stop timing (defined in the matrix settings) for all clips in this column.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-column-time-stretch-mode]
== Time stretch mode

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

This overrides the time stretch mode (defined in the matrix settings) for all clips in this column.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-column-trigger-mode]
== Trigger mode

image:generated/screenshots/elements/inspector/column/trigger-mode.png[Trigger mode, role="related thumb right"]
image::generated/screenshots/elements/inspector/column/trigger-mode.png[Trigger mode]

This overrides the trigger mode defined in the matrix settings for all clips in this column.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-column-velocity-sensitivity]
== Velocity sensitivity

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

This overrides the velocity sensitivity (defined in the matrix settings) for all clips in this column.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-matrix-activate-slot-on-trigger]
== Activate slot on trigger

image:generated/screenshots/elements/inspector/matrix/activate-slot-on-trigger.png[Activate slot on trigger, role="related thumb right"]
image::generated/screenshots/elements/inspector/matrix/activate-slot-on-trigger.png[Activate slot on trigger]

When slot triggered via controller, also make it the active one.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-matrix-limit-recording-length]
== Limit recording length

image:generated/screenshots/elements/inspector/matrix/limit-recording-length.png[Limit recording length, role="related thumb right"]
image::generated/screenshots/elements/inspector/matrix/limit-recording-length.png[Limit recording length]

If enabled, recording a clip will automatically end after a certain amount of time. This is great if you know in advance that you want to record, let's say, 2 bars only at a maximum. Then you don't have to reach for the stop button manually.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-matrix-midi-quantization-grid]
== MIDI quantization grid

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

Which grid to use when quantizing MIDI clips using the "Quantize" button.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-matrix-recording-auto-quantize]
== Auto-quantize

image:generated/screenshots/elements/inspector/matrix/recording-auto-quantize.png[Auto-quantize, role="related thumb right"]
image::generated/screenshots/elements/inspector/matrix/recording-auto-quantize.png[Auto-quantize]

If you enable this, Playtime will automatically quantize a newly recorded MIDI clip after it has been recorded. It will do so using the global matrix quantization grid setting.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-matrix-recording-detect-downbeat]
== Detect downbeat

image:generated/screenshots/elements/inspector/matrix/recording-detect-downbeat.png[Detect downbeat, role="related thumb right"]
image::generated/screenshots/elements/inspector/matrix/recording-detect-downbeat.png[Detect downbeat]

If you enable this, Playtime will record even MIDI notes that you play *before* the scheduled recording start (e.g. before the next bar). It will interpret those notes as pickup beat and adjust the downbeat setting accordingly.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-matrix-recording-length]
== Length

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

Defines the length to be used when limiting the clip recording length.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-matrix-recording-looped]
== Looped

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

If this is enabled, a clip will immediately start playing after it has been recorded and it will be looped.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-matrix-recording-midi-reset-behavior]
== MIDI reset behavior

image:generated/screenshots/elements/inspector/matrix/recording-midi-reset-behavior.png[MIDI reset behavior, role="related thumb right"]
image::generated/screenshots/elements/inspector/matrix/recording-midi-reset-behavior.png[MIDI reset behavior]

MIDI reset behavior that will be assigned to new clips: Recorded clips, imported clips and empty clips created by double-clicking a slot.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-matrix-recording-play-start-timing-override]
== Play start timing override

image:generated/screenshots/elements/inspector/matrix/recording-play-start-timing-override.png[Play start timing override, role="related thumb right"]
image::generated/screenshots/elements/inspector/matrix/recording-play-start-timing-override.png[Play start timing override]

null
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-matrix-recording-play-stop-timing-override]
== Play stop timing override

image:generated/screenshots/elements/inspector/matrix/recording-play-stop-timing-override.png[Play stop timing override, role="related thumb right"]
image::generated/screenshots/elements/inspector/matrix/recording-play-stop-timing-override.png[Play stop timing override]

null
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-matrix-recording-start-timing]
== Start timing

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

null
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-matrix-recording-stop-timing]
== Stop timing

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

null
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-matrix-recording-sync-to-project-tempo]
== Sync to project tempo

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

Determines whether playback of the recorded clip (after its recording) should synchronize to the project tempo.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-matrix-resample-mode]
== Resample mode

image:generated/screenshots/elements/inspector/matrix/resample-mode.png[Resample mode, role="related thumb right"]
image::generated/screenshots/elements/inspector/matrix/resample-mode.png[Resample mode]

Defines which kind of resampling algorithm to use on audio clips.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-matrix-start-timing]
== Start timing

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

Decides when a clip actually starts playing after you have triggered its playback.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-matrix-stop-timing]
== Stop timing

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

Decides when a clip actually stops playing after you have triggered its stop.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-matrix-tempo-detection-range]
== Tempo detection range

image:generated/screenshots/elements/inspector/matrix/tempo-detection-range.png[Tempo detection range, role="related thumb right"]
image::generated/screenshots/elements/inspector/matrix/tempo-detection-range.png[Tempo detection range]

This influences how Playtime detects tempo of imported or recorded audio material.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-matrix-time-stretch-mode]
== Time stretch mode

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

Defines which kind of time stretching algorithm to use on audio clips.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-matrix-transport-sync]
== Transport synchronization

image:generated/screenshots/elements/inspector/matrix/transport-sync.png[Transport synchronization, role="related thumb right"]
image::generated/screenshots/elements/inspector/matrix/transport-sync.png[Transport synchronization]

The default is "Partial transport synchronization", indicated by an arrow pointing to the left. It means that starting playback in Playtime (via the button on the left side or pressing space) doesn't start playback of REAPER's arrangement.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#inspector-matrix-trigger-mode]
== Trigger mode

image:generated/screenshots/elements/inspector/matrix/trigger-mode.png[Trigger mode, role="related thumb right"]
image::generated/screenshots/elements/inspector/matrix/trigger-mode.png[Trigger mode]

Choose between different modes of triggering slots.

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

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

Adjusts how much the velocity affects the clip volume when triggering a slot.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#inspector-row-name]
== Name

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

Name of the row.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#tempo-settings-click-volume]
== Click volume

image:generated/screenshots/elements/tempo-settings/click-volume.png[Click volume, role="related thumb right"]
image::generated/screenshots/elements/tempo-settings/click-volume.png[Click volume]

Allows you to set the volume of the metronome click.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#tempo-settings-count-in]
== Count-in

image:generated/screenshots/elements/tempo-settings/count-in.png[Count-in, role="related thumb right"]
image::generated/screenshots/elements/tempo-settings/count-in.png[Count-in]

Allows you to set the number of count-in bars used when doing pre-roll recording from stopped state.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#tempo-settings-tap-volume]
== Tap volume

image:generated/screenshots/elements/tempo-settings/tap-volume.png[Tap volume, role="related thumb right"]
image::generated/screenshots/elements/tempo-settings/tap-volume.png[Tap volume]

Allows you to set the volume of the tempo tap sound.

0 comments on commit bc1771c

Please sign in to comment.