Skip to content

Commit

Permalink
Improve inspector docs
Browse files Browse the repository at this point in the history
  • Loading branch information
helgoboss committed Nov 27, 2024
1 parent 6b548b1 commit 8176cd1
Show file tree
Hide file tree
Showing 106 changed files with 250 additions and 80 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.
29 changes: 21 additions & 8 deletions doc/playtime/modules/ROOT/pages/user-interface/inspector/clip.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
= Clip inspector

include::partial$generated/elements/inspector/clip/quick-actions.adoc[]

include::partial$generated/elements/inspector/clip/overdub.adoc[]

include::partial$generated/elements/inspector/clip/quantize.adoc[]
Expand All @@ -16,6 +18,8 @@ Vice versa, Playtime detects correctly if a clip has been quantized in REAPER's
That means you can use both quantization methods interchangeably!
====

include::partial$generated/elements/inspector/clip/basics.adoc[]

include::partial$generated/elements/inspector/clip/name.adoc[]

TIP: Another way to change the sanem is to press kbd:[F2] when the slot is selected.
Expand All @@ -42,6 +46,8 @@ TIP: Right-clicking this area opens the xref:user-interface/menus/source-menu.ad

include::partial$generated/elements/inspector/clip/color.adoc[]

include::partial$generated/elements/inspector/clip/triggering.adoc[]

include::partial$generated/elements/inspector/clip/start-timing.adoc[]

See xref:key-concepts.adoc#clip-start-timing[].
Expand All @@ -62,6 +68,8 @@ include::partial$generated/elements/inspector/clip/stop-timing/immediately.adoc[
include::partial$generated/elements/inspector/clip/stop-timing/custom.adoc[]


include::partial$generated/elements/inspector/clip/synchronization.adoc[]

include::partial$generated/elements/inspector/clip/sync-to-project-tempo.adoc[]

TIP: This alone doesn't guarantee yet that your clip will be played in time.
Expand All @@ -85,11 +93,14 @@ include::partial$generated/elements/inspector/clip/downbeat.adoc[]
TIP: This can be used to realize an link:https://en.wikipedia.org/wiki/Anacrusis[Anacrusis] (or pick-up beat).
See xref:user-interface/inspector/matrix/recording.adoc#inspector-matrix-recording-detect-downbeat[].

include::partial$generated/elements/inspector/clip/start-position.adoc[]
include::partial$generated/elements/inspector/clip/section.adoc[]

TIP: This setting works for both audio and MIDI clips.
When using it on MIDI clips, be aware that the REAPER MIDI editor doesn't indicate the start position in any way, which can be confusing.
If you want to permanently change the start position permanently, it's usually better to adjust the underlying MIDI data.
.Usage with MIDI clips
CAUTION: These properties work for both audio and MIDI clips.
When using it on MIDI clips, be aware that the REAPER MIDI editor doesn't indicate the start position or length in any way, which can be confusing.
If you want to change the start position and length permanently, it's usually better to adjust the underlying MIDI data.

include::partial$generated/elements/inspector/clip/start-position.adoc[]

include::partial$user-interface/clip-prop-adjust-in-beats.adoc[]

Expand All @@ -101,14 +112,12 @@ The value **Original** means that the source will end at the original end of the

Use the ÷2 and ×2 buttons to halve or double the current length.

TIP: This setting works for both audio and MIDI clips.
When using it on MIDI clips, be aware that the REAPER MIDI editor doesn't indicate the length in any way, which can be confusing.
If you want to permanently change the start position permanently, it's usually better to adjust the underlying MIDI data.

include::partial$user-interface/clip-prop-adjust-in-beats.adoc[]

include::partial$clip-prop-applied-quantized.adoc[]

include::partial$generated/elements/inspector/clip/midi.adoc[]

include::partial$generated/elements/inspector/clip/midi-reset-behavior.adoc[]

include::partial$generated/elements/inspector/clip/midi-reset-behavior/none.adoc[]
Expand All @@ -119,6 +128,8 @@ include::partial$generated/elements/inspector/clip/midi-reset-behavior/extreme-r

include::partial$generated/elements/inspector/clip/midi-channel.adoc[]

include::partial$generated/elements/inspector/clip/audio.adoc[]

include::partial$generated/elements/inspector/clip/source-fades.adoc[]

include::partial$generated/elements/inspector/clip/time-stretch-mode.adoc[]
Expand All @@ -144,6 +155,8 @@ You can choose between all resample modes that are supported by REAPER.

include::partial$clip-prop-applied-quantized.adoc[]

include::partial$generated/elements/inspector/clip/expert-settings.adoc[]

include::partial$generated/elements/inspector/clip/source-cut-start.adoc[]

include::partial$clip-prop-applied-quantized.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

You will see this when selecting a xref:user-interface/matrix-area.adoc#column-cell[].

include::partial$generated/elements/inspector/column/basics.adoc[]

include::partial$generated/elements/inspector/column/playback-track.adoc[]

See xref:key-concepts.adoc#column-track[].
Expand All @@ -12,6 +14,8 @@ include::partial$generated/elements/inspector/column/exclusive-mode.adoc[]

include::partial$generated/elements/inspector/column/follow-scenes.adoc[]

include::partial$generated/elements/inspector/column/more.adoc[]

include::partial$generated/elements/inspector/column/start-timing.adoc[]

See xref:user-interface/inspector/clip.adoc#inspector-clip-start-timing[].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

You will see this when selecting the xref:user-interface/matrix-area.adoc#matrix-cell[].

include::partial$generated/elements/inspector/matrix/playback-basics.adoc[]

include::partial$generated/elements/inspector/matrix/start-timing.adoc[]

See xref:user-interface/inspector/clip.adoc#inspector-clip-start-timing[].
Expand All @@ -28,6 +30,8 @@ See xref:user-interface/inspector/clip.adoc#inspector-clip-quantize[].

TIP: If you want more advanced quantization options, do quantization in REAPER's MIDI editor instead.

include::partial$generated/elements/inspector/matrix/playback-more.adoc[]

include::partial$generated/elements/inspector/matrix/time-stretch-mode.adoc[]

See xref:user-interface/inspector/clip.adoc#inspector-clip-time-stretch-mode[].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

You will see this when selecting the xref:user-interface/matrix-area.adoc#matrix-cell[].

include::partial$generated/elements/inspector/matrix/recording-basics.adoc[]

include::partial$generated/elements/inspector/matrix/recording-looped.adoc[]

include::partial$generated/elements/inspector/matrix/limit-recording-length.adoc[]


include::partial$generated/elements/inspector/matrix/recording-length.adoc[]

include::partial$generated/elements/inspector/matrix/recording-midi.adoc[]

include::partial$generated/elements/inspector/matrix/recording-detect-downbeat.adoc[]

See xref:user-interface/inspector/clip.adoc#inspector-clip-downbeat[].
Expand All @@ -17,6 +21,8 @@ include::partial$generated/elements/inspector/matrix/recording-auto-quantize.ado

See xref:user-interface/inspector/clip.adoc#inspector-clip-quantize[] and xref:user-interface/inspector/matrix/playback.adoc#inspector-matrix-midi-quantization-grid[].

include::partial$generated/elements/inspector/matrix/recording-settings-for-new-clips.adoc[]

include::partial$generated/elements/inspector/matrix/recording-sync-to-project-tempo.adoc[]

See xref:user-interface/inspector/clip.adoc#inspector-clip-sync-to-project-tempo[].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

You will see this when selecting a xref:user-interface/matrix-area.adoc#row-cell[].

include::partial$generated/elements/inspector/row/basics.adoc[]

include::partial$generated/elements/inspector/row/name.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ You will see this when selecting a xref:user-interface/matrix-area.adoc#slot-cel

include::partial$generated/elements/inspector/slot/clip-picker.adoc[]

include::partial$generated/elements/inspector/slot/clip.adoc[]

For details about the actual clip, see xref:user-interface/inspector/clip.adoc[].

TIP: Right-clicking one of the clips opens the xref:user-interface/menus/clip-menu.adoc[].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

You will see this when selecting a xref:user-interface/track-area.adoc[track panel].

include::partial$generated/elements/inspector/track/basics.adoc[]

include::partial$generated/elements/inspector/track/name.adoc[]

include::partial$generated/elements/inspector/track/color.adoc[]
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
NOTE: If the clip is currently playing and configured to xref:user-interface/inspector/clip.adoc#inspector-clip-sync-to-project-tempo[synchronize to the project tempo], changes of this clip property will not be applied immediately. Instead, Playtime applies them at the next quantization interval, according to the xref:user-interface/inspector/matrix/playback.adoc#inspector-matrix-start-timing[matrix start timing]. This ensures that the clip will keep playing perfectly in time.
.Quantized application
NOTE: If the clip is currently playing and configured to xref:user-interface/inspector/clip.adoc#inspector-clip-sync-to-project-tempo[synchronize to the project tempo], changes of this clip property will not be applied immediately. Instead, Playtime applies them at the next quantization interval, according to the xref:user-interface/inspector/matrix/playback.adoc#inspector-matrix-start-timing[matrix start timing]. This ensures that the clip will keep playing in time.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[inspector-clip,Clip]]]
ifndef::pdf-theme[[[inspector-clip,Clip image:playtime::generated/screenshots/elements/inspector/clip.png[width=50, pdfwidth=8mm]]]]
== Clip

image::playtime::generated/screenshots/elements/inspector/clip.png[Clip, role="related thumb right", float=right]

This is one of the clips in this slot. Clicking on it will reveal its settings in the area below. Double-clicking on it opens the clip in the waveform view or MIDI editor.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[inspector-clip-audio,Audio ⊖]]]
ifndef::pdf-theme[[[inspector-clip-audio,Audio ⊖]]]
== Audio ⊖





Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[inspector-clip-basics,Basics ⊖]]]
ifndef::pdf-theme[[[inspector-clip-basics,Basics ⊖]]]
== Basics ⊖





Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-color,Color]]]
ifndef::pdf-theme[[[inspector-clip-color,Color]]]
== Color
=== Color

image::playtime::generated/screenshots/elements/inspector/clip/color.png[Color]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
ifdef::pdf-theme[[[inspector-clip-expert-settings,Expert settings ⊖]]]
ifndef::pdf-theme[[[inspector-clip-expert-settings,Expert settings ⊖ image:playtime::generated/screenshots/elements/inspector/clip/expert-settings.png[width=50, pdfwidth=8mm]]]]
ifndef::pdf-theme[[[inspector-clip-expert-settings,Expert settings ⊖]]]
== Expert settings ⊖

image::playtime::generated/screenshots/elements/inspector/clip/expert-settings.png[Expert settings ⊖, role="related thumb right", float=right]


It's usually not necessary to touch the settings in this section.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-length,Length]]]
ifndef::pdf-theme[[[inspector-clip-length,Length]]]
== Length
=== Length

image::playtime::generated/screenshots/elements/inspector/clip/length.png[Length]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-looped,Looped]]]
ifndef::pdf-theme[[[inspector-clip-looped,Looped]]]
== Looped
=== Looped

image::playtime::generated/screenshots/elements/inspector/clip/looped.png[Looped]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-midi-channel,MIDI channel]]]
ifndef::pdf-theme[[[inspector-clip-midi-channel,MIDI channel]]]
== MIDI channel
=== MIDI channel

image::playtime::generated/screenshots/elements/inspector/clip/midi-channel.png[MIDI channel]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-midi-reset-behavior,Reset behavior]]]
ifndef::pdf-theme[[[inspector-clip-midi-reset-behavior,Reset behavior]]]
== Reset behavior
=== Reset behavior



Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[inspector-clip-midi,MIDI ⊖]]]
ifndef::pdf-theme[[[inspector-clip-midi,MIDI ⊖]]]
== MIDI ⊖





Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-name,Name]]]
ifndef::pdf-theme[[[inspector-clip-name,Name]]]
== Name
=== Name

image::playtime::generated/screenshots/elements/inspector/clip/name.png[Name]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-overdub,Overdub]]]
ifndef::pdf-theme[[[inspector-clip-overdub,Overdub image:playtime::generated/screenshots/elements/inspector/clip/overdub.png[width=50, pdfwidth=8mm]]]]
== Overdub
=== Overdub

image::playtime::generated/screenshots/elements/inspector/clip/overdub.png[Overdub, role="related thumb right", float=right]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-pitch,Pitch]]]
ifndef::pdf-theme[[[inspector-clip-pitch,Pitch]]]
== Pitch
=== Pitch

image::playtime::generated/screenshots/elements/inspector/clip/pitch.png[Pitch]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-quantize,Quantize]]]
ifndef::pdf-theme[[[inspector-clip-quantize,Quantize image:playtime::generated/screenshots/elements/inspector/clip/quantize.png[width=50, pdfwidth=8mm]]]]
== Quantize
=== Quantize

image::playtime::generated/screenshots/elements/inspector/clip/quantize.png[Quantize, role="related thumb right", float=right]

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[inspector-clip-quick-actions,Quick actions]]]
ifndef::pdf-theme[[[inspector-clip-quick-actions,Quick actions]]]
== Quick actions



Provides quick access to popular clip actions.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-resample-mode,Resample mode]]]
ifndef::pdf-theme[[[inspector-clip-resample-mode,Resample mode]]]
== Resample mode
=== Resample mode



Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
ifdef::pdf-theme[[[inspector-clip-section,Section ⊖]]]
ifndef::pdf-theme[[[inspector-clip-section,Section ⊖ image:playtime::generated/screenshots/elements/inspector/clip/section.png[width=50, pdfwidth=8mm]]]]
ifndef::pdf-theme[[[inspector-clip-section,Section ⊖]]]
== Section ⊖

image::playtime::generated/screenshots/elements/inspector/clip/section.png[Section ⊖, role="related thumb right", float=right]


Here you can define which part of the audio or MIDI clip you want to play.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-source-cut-length,Source cut: Length]]]
ifndef::pdf-theme[[[inspector-clip-source-cut-length,Source cut: Length]]]
== Source cut: Length
=== Source cut: Length

image::playtime::generated/screenshots/elements/inspector/clip/source-cut-length.png[Source cut: Length]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-source-cut-start,Source cut: Start]]]
ifndef::pdf-theme[[[inspector-clip-source-cut-start,Source cut: Start]]]
== Source cut: Start
=== Source cut: Start

image::playtime::generated/screenshots/elements/inspector/clip/source-cut-start.png[Source cut: Start]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-source-fades,Source fades]]]
ifndef::pdf-theme[[[inspector-clip-source-fades,Source fades]]]
== Source fades
=== Source fades

image::playtime::generated/screenshots/elements/inspector/clip/source-fades.png[Source fades]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-source-info,Source info]]]
ifndef::pdf-theme[[[inspector-clip-source-info,Source info]]]
== Source info
=== Source info

image::playtime::generated/screenshots/elements/inspector/clip/source-info.png[Source info]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-start-position,Start position]]]
ifndef::pdf-theme[[[inspector-clip-start-position,Start position]]]
== Start position
=== Start position

image::playtime::generated/screenshots/elements/inspector/clip/start-position.png[Start position]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-start-timing,Start timing]]]
ifndef::pdf-theme[[[inspector-clip-start-timing,Start timing]]]
== Start timing
=== Start timing



Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-stop-timing,Stop timing]]]
ifndef::pdf-theme[[[inspector-clip-stop-timing,Stop timing]]]
== Stop timing
=== Stop timing



Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::pdf-theme[[[inspector-clip-sync-to-project-tempo,Sync to project tempo]]]
ifndef::pdf-theme[[[inspector-clip-sync-to-project-tempo,Sync to project tempo]]]
== Sync to project tempo
=== Sync to project tempo

image::playtime::generated/screenshots/elements/inspector/clip/sync-to-project-tempo.png[Sync to project tempo]

Expand Down
Loading

0 comments on commit 8176cd1

Please sign in to comment.