Session view¶

zcx can be configured to show an interactive representation of Live's session view, as found on controllers like the Launchpad, Push, and APC.

Session ring

Session view shows clips within the session ring. See the session ring lesson to learn about configuring and controlling the session ring.

Configuration¶

The zcx session view is actually a specialized matrix section. To configure it, add a new section called __session_view to your matrix_sections.yaml:

matrix_sections.yaml

__session_view:
  row_start: 0
  row_end: 7
  col_start: 0
  col_end: 7

There is no need to create the file matrix_sections/__session_view.yaml.

Once the section is created, add it to a page.

Note

The __session_view section's dimensions must be no greater than the height and width of your session ring.

Commands¶

The session view comes with some default functionality: pressing a pad will fire the corresponding clip slot. Pressing a pad with a select mode active will select the corresponding clip slot.

This is achieved with ClyphX Pro action lists:

gestures:
  pressed: >
    ${track_name}" / SVIEW ${scene_number} PRESS
  pressed__select: >
    "${track_name}" / SEL ${scene_number}

Template strings

To understand this syntax, see the template reference

SVIEW action¶

By default, pressing a session view pad will fire the action SVIEW. For an un-armed track, pressing a pad will fire the associated clip slot.

For an armed track, pressing a pad will fire the ClyphX Pro action RECFIX, starting a fixed-length recording in the clip.

RECFIX will use the ClyphX Pro variable called %zcx_fixed_record% as the record length. If you have not set this variable, it will default to 0, starting a non-fixed-length recording.

By setting this variable, like with the action list %zcx_fixed_record% = 4, you can set the length of the recording (in this case 4 bars). By setting the variable back to 0, you can disable fixed-length recording.

If you would like the fixed record length to be set when zcx loads, consider setting it via a startup command, or in ClyphX Pro via Variables.txt or Preferences.txt.

The variable %zcx_fixed_record% is shared across all running zcx scripts.

Warning

Nothing happening when you press a session view control?

The most likely reason is that you haven't installed the user action ZcxSessionView.py which is bundled with your zcx download. See here for installation instructions.

Extending defaults¶

We can extend the default functionality by adding a section template:

matrix_sections.yaml

__session_view:
  row_start: 0
  row_end: 7
  col_start: 0
  col_end: 7
  template:
    gestures:
      released_delayed: >
        "{track_name}" / STOPNQ

In addition to the two previous commands, releasing after a long press will immediately stop the playing clip.

Special properties¶

You can use several unique properties in session view commands:

track_name

The name of the track to which the control belongs. Good for use with track actions.

Example:

"${track_name}" / MUTE

scene_number

The one-indexed scene number to which the control belongs.

Example:

"${track_name}" / PLAY ${scene_number}

clip_target

A convenience property for use with clip actions.

Example:

${clip_target} DEL

# evaluates to something like:
"my cool track" / CLIP(6) DEL

user_clip_target

As above, but for use with user clip actions, which require a special syntax.

Example:

${user_clip_target} MY_USER_ACTION

# evaluates to something like:
"my cool track" / USER_CLIP(6) MY_USER_ACTION

Overwriting defaults¶

In the section template, simply define new commands for the gesture pressed and/or pressed__select:

matrix_sections.yaml

__session_view:
  row_start: 0
  row_end: 7
  col_start: 0
  col_end: 7
  template:
    gestures:
      pressed: >
        ${clip_target} COLOR 1
      pressed__select: >
        "${track_target}" / SOLO

Or to disable a default:

matrix_sections.yaml

  template:
    gestures:
      pressed__select: DUMMY # do nothing

Additional options¶

clip_color_is_play_color¶

matrix_sections.yaml

__session_view:
  row_start: 0
  row_end: 7
  col_start: 0
  col_end: 7
  clip_color_is_play_color: true

When false, a playing clip will pulse green. When true, a playing clip will pulse with the clip color from bright to dark. The true option does not look good on many controllers.