### start_playing

Source: https://docs.cycling74.com/apiref/lom/song

Initiates playback starting from the insert marker.

```APIDOC
## start_playing

### Description
Starts playback from the insert marker.

### Method
POST

### Endpoint
/start_playing
```

--------------------------------

### start_time

Source: https://docs.cycling74.com/apiref/lom/clip

The start time of the clip, relative to the global song time. The value is in beats. For Arrangement View clips, this is the offset within the arrangement. For Session View clips, this is the time the clip was started.

```APIDOC
## start_time

### Description
Get the start time of the clip, relative to the global song time, in beats. For Arrangement View clips, this is the offset within the arrangement. For Session View clips, this is the time the clip was started.

### Method
GET

### Parameters
None

### Response
#### Success Response
- **start_time** (float) - The start time of the clip in beats relative to the song's global time.

### Response Example
```json
{
  "start_time": 128.5
}
```
```

--------------------------------

### Get Live Application Version String

Source: https://docs.cycling74.com/apiref/lom/application

Retrieves the full version string of the Live application.

```python
live_app.get_version_string()
```

--------------------------------

### Sample Path Example

Source: https://docs.cycling74.com/apiref/lom/sample

This snippet shows the hierarchical path to access a sample within a Live Set.

```text
live_set tracks N devices N sample
```

--------------------------------

### get_beats_loop_start

Source: https://docs.cycling74.com/apiref/lom/song

Retrieves the Arrangement loop start position in beats.

```APIDOC
## get_beats_loop_start

### Description
Retrieves the Arrangement loop start position.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response
- **loop_start** (symbol) - The Arrangement loop start position in bars.beats.sixteenths.ticks format.
```

--------------------------------

### Get Current Live Document

Source: https://docs.cycling74.com/apiref/lom/application

Retrieves the current Live Set document.

```python
live_app.get_document()
```

--------------------------------

### Create Audio Clip in Take Lane

Source: https://docs.cycling74.com/apiref/lom/takelane

Creates an audio clip from a file path at a specified start time in the arrangement view. Ensure the file path is absolute and the track is an audio track, not frozen or being recorded.

```python
create_audio_clip(file_path: str, start_time: float)
```

--------------------------------

### Create MIDI Clip in Take Lane

Source: https://docs.cycling74.com/apiref/lom/takelane

Creates an empty MIDI clip with a specified length at a given start time in the arrangement view. The track must be a MIDI track, not frozen or being recorded.

```python
create_midi_clip(start_time: float, length: float)
```

--------------------------------

### create_audio_clip

Source: https://docs.cycling74.com/apiref/lom/takelane

Creates an audio clip in the arrangement view from a given file path and start time. This function is applicable only to audio tracks that are not frozen or being recorded into.

```APIDOC
## create_audio_clip

### Description
Given a valid audio file in a supported format, passing its absolute path creates an audio clip referencing the file in the arrangement view at the specified start time in beats. Prints an error if the track is not an audio track, if the track is frozen or if the track is being recorded into. `start_time` must be within the range `[0., 1576800]`.

### Method
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **file_path** (symbol) - Required - The absolute path to the audio file.
- **start_time** (float) - Required - The start time in beats for the audio clip. Must be within the range [0., 1576800].
```

--------------------------------

### Get Available Main Views

Source: https://docs.cycling74.com/apiref/lom/application_view

Retrieves a list of all available view names that can be used with other view-related functions.

```python
live_app.view.available_main_views()
```

--------------------------------

### set_fire_button_state

Source: https://docs.cycling74.com/apiref/lom/clip

Simulates pressing the clip start button if the state is set to 1, until stopped or the state is reset to 0.

```APIDOC
## set_fire_button_state

### Description
If the state is set to 1, Live simulates pressing the clip start button until the state is set to 0, or until the clip is otherwise stopped.

### Parameters
#### Path Parameters
- **state** (bool) - Required - The desired state (1 for active, 0 for inactive).
```

--------------------------------

### create_midi_clip

Source: https://docs.cycling74.com/apiref/lom/takelane

Creates an empty MIDI clip with a specified length and start time in the arrangement view. This function is only valid for MIDI tracks that are not frozen or currently being recorded into.

```APIDOC
## create_midi_clip

### Description
Creates an empty MIDI clip with the specified length in beats and inserts it into the arrangement at the specified start time in beats. Prints an error if the track is not a MIDI track, if the track is frozen or when the track is currently being recorded into. `start_time` must be within the range `[0., 1576800]`.

### Method
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **start_time** (float) - Required - The start time in beats for the MIDI clip. Must be within the range [0., 1576800].
- **length** (float) - Required - The length of the MIDI clip in beats.
```

--------------------------------

### Get Live Application Minor Version

Source: https://docs.cycling74.com/apiref/lom/application

Retrieves the minor version number of the Live application.

```python
live_app.get_minor_version()
```

--------------------------------

### start_marker

Source: https://docs.cycling74.com/apiref/lom/clip

The start marker of the clip in beats, independent of the loop state. Cannot be set behind the end marker.

```APIDOC
## start_marker

### Description
Get or set the start marker of the clip in beats. This value is independent of the loop state and cannot be set behind the end marker.

### Method
GET, SET

### Parameters
- **start_marker** (float) - Required - The desired start marker position in beats.

### Response
#### Success Response
- **start_marker** (float) - The current start marker position in beats.

### Request Example
```json
{
  "start_marker": 1.0
}
```

### Response Example
```json
{
  "start_marker": 1.0
}
```
```

--------------------------------

### Get Live Application Major Version

Source: https://docs.cycling74.com/apiref/lom/application

Retrieves the major version number of the Live application.

```python
live_app.get_major_version()
```

--------------------------------

### Track Available Input Routing Channels

Source: https://docs.cycling74.com/apiref/lom/track

Get the available input routing channels for a track. This is represented as a dictionary containing a list of dictionaries, each describing an input routing channel. Only available on MIDI and audio tracks.

```Live API
available_input_routing_channels dictionary read-onlyobserve
The list of available source channels for the track's input routing. It's represented as a _dictionary_ with the following key:
`available_input_routing_channels` [list]
The list contains _dictionaries_ as described in _input_routing_channel_.
Only available on MIDI and audio tracks.
```

--------------------------------

### Song Properties

Source: https://docs.cycling74.com/apiref/lom/song

This section details the readable and writable properties of the Song class, allowing users to get and set various aspects of the Live Set.

```APIDOC
## Song Properties

### Description
Properties of the Song class allow for observation and modification of various Live Set parameters.

### Properties
- **appointed_device** (Device) - read-onlyobserve - The appointed device used by a control surface.
- **arrangement_overdub** (bool) - observe - Get/set the state of the MIDI Arrangement Overdub button.
- **back_to_arranger** (bool) - observe - Get/set/observe the current state of the Back to Arrangement button.
- **can_capture_midi** (bool) - read-onlyobserve - Indicates if recently played MIDI material exists to be captured.
- **can_jump_to_next_cue** (bool) - read-onlyobserve - Indicates if there is a cue point to the right.
- **can_jump_to_prev_cue** (bool) - read-onlyobserve - Indicates if there is a cue point to the left.
- **can_redo** (bool) - read-only - Indicates if there is something in the history to redo.
- **can_undo** (bool) - read-only - Indicates if there is something in the history to undo.
- **clip_trigger_quantization** (int) - observe - Reflects the quantization setting in the transport bar.
- **count_in_duration** (int) - read-onlyobserve - The duration of the Metronome's Count-In setting.
- **current_song_time** (float) - observe - The playing position in the Live Set, in beats.
- **exclusive_arm** (bool) - read-only - Current status of the exclusive Arm option.
- **exclusive_solo** (bool) - read-only - Current status of the exclusive Solo option.
- **file_path** (symbol) - read-only - The path to the current Live Set.
- **groove_amount** (float) - observe - The groove amount from the current set's groove pool.
- **is_ableton_link_enabled** (bool) - observe - Enable/disable Ableton Link.
- **is_ableton_link_start_stop_sync_enabled** (bool) - observe - Enable/disable Ableton Link Start Stop Sync.
- **is_counting_in** (bool) - read-onlyobserve - Indicates if the Metronome is currently counting in.
- **is_playing** (bool) - observe - Get/set if Live's transport is running.
- **last_event_time** (float) - read-only - The beat time of the last event in the Arrangement.
- **loop** (bool) - observe - Get/set the enabled state of the Arrangement loop.
- **loop_length** (float) - observe - Arrangement loop length in beats.
- **loop_start** (float) - observe - Arrangement loop start in beats.
- **metronome** (bool) - observe - Get/set the enabled state of the metronome.
- **midi_recording_quantization** (int) - observe - Get/set the current Record Quantization value.
- **name** (symbol) - read-only - The name of the current Live Set.
- **nudge_down** (bool) - observe - Indicates if the Tempo Nudge Down button is pressed.
- **nudge_up** (bool) - observe - Indicates if the Tempo Nudge Up button is pressed.
- **tempo_follower_enabled** (bool) - observe - Indicates if the Tempo Follower controls the tempo.
- **overdub** (bool) - observe - Indicates if MIDI Arrangement Overdub is enabled.
- **punch_in** (bool) - observe - Indicates if the Punch-In button is enabled.
- **punch_out** (bool) - observe - Indicates if the Punch-Out button is enabled.
- **re_enable_automation_enabled** (bool) - read-onlyobserve - Indicates if the Re-Enable Automation button is on.
- **record_mode** (bool) - observe - Indicates if the Arrangement Record button is on.
```

--------------------------------

### Track Available Input Routing Types

Source: https://docs.cycling74.com/apiref/lom/track

Get the available input routing types for a track. This is represented as a dictionary containing a list of dictionaries, each describing an input routing type. Only available on MIDI and audio tracks.

```Live API
available_input_routing_types dictionary read-onlyobserve
The list of available source types for the track's input routing. It's represented as a _dictionary_ with the following key:
`available_input_routing_types` [list]
The list contains _dictionaries_ as described in _input_routing_type_.
Only available on MIDI and audio tracks.
```

--------------------------------

### MeldDevice Properties

Source: https://docs.cycling74.com/apiref/lom/melddevice

This section details the observable properties of the MeldDevice class, allowing users to get and set various parameters of the Meld device.

```APIDOC
## MeldDevice Properties

### selected_engine int observe
Meld's oscillator engine selector. The modes are encoded as follows:
0 = Engine A
1 = Engine B

### unison_voices int observe
Selects the Unison voice count. The modes are encoded as follows:
0 = off
1 = two
2 = three
3 = four

### mono_poly int observe
Selects the polyphony mode. The modes are encoded as follows:
0 = mono
1 = poly

### poly_voices int observe
Selects the polyphony voice count. The modes are encoded as follows:
0 = two
1 = three
2 = four
3 = five
4 = six
5 = eight
6 = twelve
```

--------------------------------

### Track Available Output Routing Channels

Source: https://docs.cycling74.com/apiref/lom/track

Get the available output routing channels for a track. This is represented as a dictionary containing a list of dictionaries, each describing an output routing channel. Not available on the master track.

```Live API
available_output_routing_channels dictionary read-onlyobserve
The list of available target channels for the track's output routing. It's represented as a _dictionary_ with the following key:
`available_output_routing_channels` [list]
The list contains _dictionaries_ as described in _output_routing_channel_.
Not available on the master track.
```

--------------------------------

### trigger_session_record

Source: https://docs.cycling74.com/apiref/lom/song

Starts recording in a Session slot. Optionally specifies a record length in beats. If called during recording, it stops recording and starts clip playback.

```APIDOC
## trigger_session_record

### Description
Starts recording in either the selected slot or the next empty slot, if the track is armed. If `record_length` is provided, the slot will record for the given length in beats. If triggered while already recording, it stops recording and starts clip playback.

### Parameters
#### Query Parameters
- **record_length** (int) - Optional - The length of recording in beats.
```

--------------------------------

### signature_numerator

Source: https://docs.cycling74.com/apiref/lom/clip

Get or set the time signature numerator.

```APIDOC
## signature_numerator

### Description
Get or set the time signature numerator.

### Method
GET, SET

### Parameters
- **signature_numerator** (int) - Required - The numerator of the time signature (e.g., 3 for 3/4 time).

### Response
#### Success Response
- **signature_numerator** (int) - The current time signature numerator.

### Request Example
```json
{
  "signature_numerator": 3
}
```

### Response Example
```json
{
  "signature_numerator": 3
}
```
```

--------------------------------

### Sample Properties

Source: https://docs.cycling74.com/apiref/lom/sample

Provides access to various attributes of a Sample object, including its file path, playback settings, and warping configurations.

```APIDOC
## Sample Properties

### beats_granulation_resolution int observe
Get/set which divisions to preserve in the sample in Beats Mode.
0 = 1 Bar
1 = 1/2
2 = 1/4
3 = 1/8
4 = 1/16
5 = 1/32
6 = Transients

### beats_transient_envelope float observe
Get/set the duration of a volume fade applied to each segment of audio in Beats Mode.
0 = fastest decay
100 = no fade

### beats_transient_loop_mode int observe
Get/set the Transient Loop Mode applied to each segment of audio in Beats Mode.
0 = Off
1 = Loop Forward
2 = Loop Back-and-Forth

### complex_pro_envelope float observe
Get/set the Envelope parameter in Complex Pro Mode.

### complex_pro_formants float observe
Get/set the Formants parameter in Complex Pro Mode.

### end_marker int observe
Get/set the position of the sample's end marker.

### file_path unicode read-only
Get the path of the sample file.

### gain float observe
Get/set the sample gain.

### length int read-only
Get the length of the sample file in sample frames.

### sample_rate int read-only
The sample rate of the loaded sample.
Available since Live 11.0.

### slices list of int read-only
The positions of all playable slices in the sample, in sample frames. Divide these values by the `sample_rate` to get the slice times in seconds.
Available since Live 11.0.

### slicing_sensitivity float observe
Get/set the slicing sensitivity. Values are between 0.0 and 1.0.

### start_marker int observe
Get/set the position of the sample's start marker.

### texture_flux float observe
Get/set the Flux parameter in Texture Mode.

### texture_grain_size float observe
Get/set the Grain Size parameter in Texture Mode.

### tones_grain_size float observe
Get/set the Grain Size parameter in Tones Mode.

### warp_markers dict/bang read-only
The Sample's Warp Markers as a dict. Observing this property bangs when the warp_markers change.
The last Warp Marker in the dict is not visible in the Live interface. This hidden, or "shadow" marker is used to calculate the BPM of the last segment.
Available since Live 11.0.

### warp_mode int observe
Get/set the Warp Mode.
0 = Beats Mode
1 = Tones Mode
2 = Texture Mode
3 = Re-Pitch Mode
4 = Complex Mode
6 = Complex Pro Mode

### warping bool observe
1 = warping is enabled.

### slicing_style int observe
Get/set the Slicing Mode.
0 = Transient
1 = Beat
2 = Region
3 = Manual

### slicing_beat_division int observe
Get/set the slice beat division in Beat Slicing Mode.
0 = 1/16
1 = 1/16T
2 = 1/8
3 = 1/8T
4 = 1/4
5 = 1/4T
6 = 1/2
7 = 1/2T
8 = 1 Bar
9 = 2 Bars
10 = 4 Bars

### slicing_region_count int observe
Get/set the number of slice regions in Region Slicing Mode.
```

--------------------------------

### signature_denominator

Source: https://docs.cycling74.com/apiref/lom/clip

Get or set the time signature denominator.

```APIDOC
## signature_denominator

### Description
Get or set the time signature denominator.

### Method
GET, SET

### Parameters
- **signature_denominator** (int) - Required - The denominator of the time signature (e.g., 4 for 4/4 time).

### Response
#### Success Response
- **signature_denominator** (int) - The current time signature denominator.

### Request Example
```json
{
  "signature_denominator": 4
}
```

### Response Example
```json
{
  "signature_denominator": 4
}
```
```

--------------------------------

### will_record_on_start

Source: https://docs.cycling74.com/apiref/lom/clip

1 for MIDI clips which are in triggered state, with the track armed and MIDI Arrangement Overdub on.

```APIDOC
## will_record_on_start

### Description
Indicates if a MIDI clip is in a triggered state, with the track armed and MIDI Arrangement Overdub enabled, meaning it will record on start.

### Method
GET

### Parameters
None

### Response
#### Success Response
- **will_record_on_start** (bool) - 1 if the clip will record on start, 0 otherwise.

### Response Example
```json
{
  "will_record_on_start": 1
}
```
```

--------------------------------

### sample_rate

Source: https://docs.cycling74.com/apiref/lom/clip

Get the Clip's sample rate.

```APIDOC
## sample_rate

### Description
Get the clip's sample rate.

### Method
GET

### Parameters
None

### Response
#### Success Response
- **sample_rate** (float) - The sample rate of the clip.

### Response Example
```json
{
  "sample_rate": 44100.0
}
```
```

--------------------------------

### create_scene

Source: https://docs.cycling74.com/apiref/lom/song

Creates a new scene at a specified index and returns the new scene.

```APIDOC
## create_scene

### Description
Creates a new scene at the specified index and returns the new scene. The `index` parameter determines where the scene is added. An index of -1 will add the new scene at the end of the list.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
#### Query Parameters
- **index** (int) - Optional - Determines where the scene is added. Valid between 0 and len(song.scenes). -1 adds to the end.

### Response
#### Success Response
- **new_scene** (live object) - The newly created scene.
```

--------------------------------

### Track Color Index

Source: https://docs.cycling74.com/apiref/lom/track

Observe or get the color index of the track.

```Live API
color_index long observe
The color index of the track.
```

--------------------------------

### Canonical Path for TuningSystem

Source: https://docs.cycling74.com/apiref/lom/tuningsystem

This is the canonical path to access the tuning system object within Live.

```maxscript
live_set tuning_system
```

--------------------------------

### Get Parameter Name

Source: https://docs.cycling74.com/apiref/lom/deviceparameter

Retrieves the short name of the parameter as displayed in the automation chooser.

```text
name symbol read-only
```

--------------------------------

### ram_mode

Source: https://docs.cycling74.com/apiref/lom/clip

1 = an audio clip’s RAM switch is enabled.

```APIDOC
## ram_mode

### Description
Indicates whether an audio clip’s RAM switch is enabled.

### Method
GET, SET

### Parameters
- **ram_mode** (bool) - Required - 1 to enable RAM mode, 0 to disable.

### Response
#### Success Response
- **ram_mode** (bool) - 1 if RAM mode is enabled, 0 otherwise.

### Request Example
```json
{
  "ram_mode": 1
}
```

### Response Example
```json
{
  "ram_mode": 1
}
```
```

--------------------------------

### Canonical Path for Live Application

Source: https://docs.cycling74.com/apiref/lom/application

The root path to access the Live application object within the LOM.

```text
live_app
```

--------------------------------

### Get Minimum Parameter Value

Source: https://docs.cycling74.com/apiref/lom/deviceparameter

Retrieves the lowest allowed value for a device parameter.

```text
min float read-only
```

--------------------------------

### Get Maximum Parameter Value

Source: https://docs.cycling74.com/apiref/lom/deviceparameter

Retrieves the largest allowed value for a device parameter.

```text
max float read-only
```

--------------------------------

### remove_notes_extended

Source: https://docs.cycling74.com/apiref/lom/clip

Deletes all notes that start within a specified area defined by pitch and time ranges.

```APIDOC
## remove_notes_extended

### Description
Deletes all notes that start in the given area. `from_time` and `time_span` are given in beats.

### Parameters
#### Path Parameters
- **from_pitch** (int) - Required - The starting pitch of the area.
- **pitch_span** (int) - Required - The span of pitches to consider.
- **from_time** (float) - Required - The starting time in beats.
- **time_span** (float) - Required - The duration in beats.
```

--------------------------------

### create_midi_track

Source: https://docs.cycling74.com/apiref/lom/song

Creates a new MIDI track at a specified index in the song.

```APIDOC
## create_midi_track

### Description
Creates a new MIDI track. The `index` parameter determines where the track is added. An index of -1 will add the new track at the end of the list.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
#### Query Parameters
- **index** (int) - Optional - Determines where the track is added. Valid between 0 and len(song.tracks). -1 adds to the end.
```

--------------------------------

### Get Original Macro Parameter Name

Source: https://docs.cycling74.com/apiref/lom/deviceparameter

Retrieves the original name of a Macro parameter before it was assigned.

```text
original_name symbol read-only
```

--------------------------------

### Create MIDI Clip

Source: https://docs.cycling74.com/apiref/lom/clipslot

Creates an empty MIDI clip in an empty clip slot on a MIDI track. The length of the clip is specified in beats and must be greater than 0.0.

```python
clip_slot.create_clip(length=4.0)
```

--------------------------------

### Show a Specific View

Source: https://docs.cycling74.com/apiref/lom/application_view

Makes a named view visible.

```python
live_app.view.show_view('Detail')
```

--------------------------------

### Get Live Application Bugfix Version

Source: https://docs.cycling74.com/apiref/lom/application

Retrieves the bugfix version number of the Live application.

```python
live_app.get_bugfix_version()
```

--------------------------------

### Track.View.select_instrument

Source: https://docs.cycling74.com/apiref/lom/track_view

Selects the track's instrument or first device, makes it visible, and focuses on it.

```APIDOC
## Track.View.select_instrument

### Description
Selects the track's instrument or first device, makes it visible and focuses on it.

### Returns
bool - 0 = there are no devices to select
```

--------------------------------

### Sample Functions

Source: https://docs.cycling74.com/apiref/lom/sample

Provides methods for manipulating slices within a sample, including insertion, movement, removal, and clearing.

```APIDOC
## Sample Functions

### gain_display_string
Returns: [list of symbols] The sample's gain value as a string, e.g. "0.0 dB".

### insert_slice
Parameters: `slice_time` [int]
Insert a new slice at the specified time if there is none.

### move_slice
Parameters: `source_time` [int] `destination_time` [int]
Move an existing slice to a specified time.

### remove_slice
Parameters: `slice_time` [int]
Remove a slice at the specified time if it exists.

### clear_slices
Clear all slices created in Manual Slicing Mode.

### reset_slices
Reset all edited slices to their original positions.
```

--------------------------------

### create_audio_track

Source: https://docs.cycling74.com/apiref/lom/song

Creates a new audio track at a specified index in the song.

```APIDOC
## create_audio_track

### Description
Creates a new audio track. The `index` parameter determines where the track is added. An index of -1 will add the new track at the end of the list.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
#### Query Parameters
- **index** (int) - Optional - Determines where the track is added. Valid between 0 and len(song.tracks). -1 adds to the end.
```

--------------------------------

### jump_to_prev_cue

Source: https://docs.cycling74.com/apiref/lom/song

Jumps playback to the previous cue point if possible.

```APIDOC
## jump_to_prev_cue

### Description
Jumps playback to the previous cue point, if possible.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Get String Representation of Parameter Value

Source: https://docs.cycling74.com/apiref/lom/deviceparameter

Converts a specified float value into its string representation for the parameter.

```text
str_for_value Parameter: `value` [float] Returns: [symbol] String representation of the specified value.
```

--------------------------------

### undo

Source: https://docs.cycling74.com/apiref/lom/song

Reverts the Live application to the state before the last operation.

```APIDOC
## undo

### Description
Causes the Live application to undo the last operation.

### Method
POST

### Endpoint
/undo
```

--------------------------------

### Get Display Value of Parameter

Source: https://docs.cycling74.com/apiref/lom/deviceparameter

Retrieves the value of a device parameter as it is displayed in the graphical user interface.

```text
display_value float observe
```

--------------------------------

### Application Functions

Source: https://docs.cycling74.com/apiref/lom/application

Utility functions to retrieve Live version information and the current document.

```APIDOC
## Application Functions

### get_bugfix_version

*   **Description**: Returns the 2 in Live 9.1.2.
*   **Returns**: int

### get_document

*   **Description**: Returns the current Live Set.
*   **Returns**: Live Set object

### get_major_version

*   **Description**: Returns the 9 in Live 9.1.2.
*   **Returns**: int

### get_minor_version

*   **Description**: Returns the 1 in Live 9.1.2.
*   **Returns**: int

### get_version_string

*   **Description**: Returns the text 9.1.2 in Live 9.1.2.
*   **Returns**: string

### press_current_dialog_button

*   **Description**: Press the button with the given index in the current dialog box.
*   **Parameters**:
    *   `index` (int) - Required - The index of the button to press.
```

--------------------------------

### Get Default Parameter Value

Source: https://docs.cycling74.com/apiref/lom/deviceparameter

Retrieves the default value for a device parameter. This is only available for parameters that are not quantized.

```text
default_value float read-only
```

--------------------------------

### Registering a MIDI Control for MaxForLive

Source: https://docs.cycling74.com/apiref/lom/controlsurface

Register a custom MIDI control (note, continuous control, or pitchbend) for the MaxForLive control surface. This allows Max for Live to receive and send messages for this control.

```python
register_midi_control(name, status, number)
```

--------------------------------

### warping

Source: https://docs.cycling74.com/apiref/lom/clip

1 = Warp switch is on. Available for audio clips only.

```APIDOC
## warping

### Description
Enable or disable the Warp switch for an audio clip.

Available for audio clips only.

### Method
GET, SET

### Parameters
- **warping** (bool) - Required - 1 to enable Warp, 0 to disable.

### Response
#### Success Response
- **warping** (bool) - 1 if Warp is enabled, 0 otherwise.

### Request Example
```json
{
  "warping": 1
}
```

### Response Example
```json
{
  "warping": 1
}
```
```

--------------------------------

### Track Fold State

Source: https://docs.cycling74.com/apiref/lom/track

Set or get the fold state of a track. This property is only available if the track is foldable.

```Live API
fold_state int
0 = tracks within the Group Track are visible, 1 = Group Track is folded and the tracks within the Group Track are hidden
[only available if `is_foldable` = 1]
```

--------------------------------

### API Objects Reference

Source: https://docs.cycling74.com/apiref/lom

This section provides a reference for the main API objects available in the Live Object Model. Each object represents a distinct element within Ableton Live that can be accessed and manipulated programmatically.

```APIDOC
## API Objects Reference

This section provides a reference for the main API objects available in the Live Object Model. Each object represents a distinct element within Ableton Live that can be accessed and manipulated programmatically.

### Item Descriptions

- **Application**: Represents the Live application itself. Accessible via the `live_app` root path.
- **Application.View**: Represents the viewing aspects of the Live application.
- **Chain**: Represents a group device chain in Live.
- **ChainMixerDevice**: Represents a chain's mixer device.
- **Clip**: Represents a clip (audio or MIDI) in Live's Arrangement View.
- **Clip.View**: Represents the viewing aspects of a Clip.
- **ClipSlot**: Represents an entry in Live's Session View matrix.
- **CompressorDevice**: Represents a Compressor device in Live.
- **ControlSurface**: Represents a Control Surface, accessible via `control_surfaces` or by getting it from a track.
- **CuePoint**: Represents a locator in the Arrangement View.
- **Device**: Represents a MIDI or audio device in Live.
- **Device.View**: Represents the viewing aspects of a Device.
- **DeviceIO**: Represents an input or output bus of a Live device.
- **DeviceParameter**: Represents an automatable parameter within a MIDI or audio device.
- **DriftDevice**: Represents an instance of a Drift device.
- **DrumCellDevice**: Represents an instance of a Drum Sampler device.
- **DrumChain**: Represents a Drum Rack device chain.
- **DrumPad**: Represents a Drum Rack pad.
- **Eq8Device**: Represents an instance of an EQ Eight device.
- **Eq8Device.View**: Represents the viewing aspects of an Eq8Device.
- **Groove**: Represents a groove in Live (available since Live 11.0).
- **GroovePool**: Represents the groove pool in Live.
- **HybridReverbDevice**: Represents an instance of a Hybrid Reverb device.
- **LooperDevice**: Represents an instance of a Looper device.
- **MaxDevice**: Represents a Max for Live device.
- **MeldDevice**: Represents an instance of a Meld device.
- **MixerDevice**: Represents a mixer device, providing access to volume, panning, and other mixer-related properties.
- **PluginDevice**: Represents a plug-in device.
- **RackDevice**: Represents a Live Rack Device.
- **RackDevice.View**: Represents the viewing aspects of a Rack Device.
- **RoarDevice**: Represents an instance of a Roar device.
- **Sample**: Represents a sample file loaded into Simpler.
- **Scene**: Represents a series of clip slots in Live's Session View matrix.
- **ShifterDevice**: Represents an instance of the Shifter audio effect.
- **SimplerDevice**: Represents an instance of Simpler.
- **SimplerDevice.View**: Represents the viewing aspects of a SimplerDevice.
- **Song**: Represents a Live Set. Accessible via the `live_app` root path.
- **Song.View**: Represents the viewing aspects of a Live document (Session and Arrangement Views).
- **SpectralResonatorDevice**: Represents an instance of a Spectral Resonator device.
- **TakeLane**: Represents a take lane in Arrangement View.
- **this_device**: Represents the device containing the live.path object.
- **Track**: Represents an audio, MIDI, or return track in Live.
- **Track.View**: Represents the viewing aspects of a track.
- **TuningSystem**: Represents a tuning system in Live.
- **WavetableDevice**: Represents a Wavetable instrument.
```

--------------------------------

### SpectralResonatorDevice Properties

Source: https://docs.cycling74.com/apiref/lom/spectralresonatordevice

This section details the observable properties of the SpectralResonatorDevice, allowing users to get, set, and observe their values.

```APIDOC
## SpectralResonatorDevice Properties

### frequency_dial_mode int observe

Get, set and observe the Freq control's mode.
0 = Hertz, 1 = MIDI note values.

### midi_gate int observe

Get, set and observe the MIDI gate switch's state.
0 = Off, 1 = On.

### mod_mode int observe

Get, set and observe the Modulation Mode.
0 = None, 1 = Chorus, 2 = Wander, 3 = Granular.

### mono_poly int observe

Get, set and observe the Mono/Poly switch's state.
0 = Mono, 1 = Poly.

### pitch_mode int observe

Get, set and observe the Pitch Mode.
0 = Internal, 1 = MIDI.

### pitch_bend_range int observe

Get, set and observe the Pitch Bend Range.

### polyphony int observe

Get, set and observe the Polyphony.
0 = 2, 1 = 4, 2 = 8, 3 = 16 voices.
```

--------------------------------

### Get String Representation of Current Parameter Value

Source: https://docs.cycling74.com/apiref/lom/deviceparameter

Returns the string representation of the current value of the device parameter.

```text
__str__ Returns: [symbol] String representation of the current parameter value.
```

--------------------------------

### TuningSystem Canonical Path

Source: https://docs.cycling74.com/apiref/lom/tuningsystem

The canonical path to access the tuning system within a Live set.

```APIDOC
## Canonical Path
```
live_set tuning_system
```
```

--------------------------------

### Get Quantized Value Items

Source: https://docs.cycling74.com/apiref/lom/deviceparameter

Retrieves a list of possible string values for a quantized parameter. This is only available if `is_quantized` is true.

```text
value_items StringVector read-only
```

--------------------------------

### Get Parameter State

Source: https://docs.cycling74.com/apiref/lom/deviceparameter

Retrieves the active state of a device parameter. This indicates if the parameter is active, changeable but not audible, or cannot be changed.

```text
state int read-onlyobserve
```

--------------------------------

### HybridReverbDevice Properties

Source: https://docs.cycling74.com/apiref/lom/hybridreverbdevice

This section details the observable properties of the HybridReverbDevice, allowing users to get and set various parameters of the reverb effect.

```APIDOC
## HybridReverbDevice Properties

### ir_attack_time
- **Type**: float
- **Access**: observe
- **Description**: The attack time of the amplitude envelope for the impulse response, in seconds.

### ir_category_index
- **Type**: int
- **Access**: observe
- **Description**: The index of the selected impulse response category.

### ir_category_list
- **Type**: StringVector
- **Access**: read-only
- **Description**: The list of impulse response categories.

### ir_decay_time
- **Type**: float
- **Access**: observe
- **Description**: The decay time of the amplitude envelope for the impulse response, in seconds.

### ir_file_index
- **Type**: int
- **Access**: observe
- **Description**: The index of the selected impulse response files from the current category.

### ir_file_list
- **Type**: StringVector
- **Access**: read-only observe
- **Description**: The list of impulse response files from the selected category.

### ir_size_factor
- **Type**: float
- **Access**: observe
- **Description**: The relative size of the impulse response, ranging from 0.0 to 1.0.

### ir_time_shaping_on
- **Type**: bool
- **Access**: observe
- **Description**: Enables transforming the current selected impulse response with an amplitude envelope and size parameter. A value of 1 means enabled.
```

--------------------------------

### Set Fire Button State

Source: https://docs.cycling74.com/apiref/lom/clipslot

Simulates pressing the Clip Launch button for the clip slot. The state remains active until explicitly set to 0 or until the clip slot is stopped by other means.

```python
clip_slot.set_fire_button_state(True)
# ... later
clip_slot.set_fire_button_state(False)
```

--------------------------------

### Get Parameter Automation State

Source: https://docs.cycling74.com/apiref/lom/deviceparameter

Retrieves the automation state of a device parameter. Use this to check if automation is active, overridden, or disabled.

```text
automation_state int read-onlyobserve
```

--------------------------------

### Toggle Browse Mode

Source: https://docs.cycling74.com/apiref/lom/application_view

Activates or deactivates Hot-Swap Mode, displaying the device chain and browser.

```python
live_app.view.toggle_browse()
```

--------------------------------

### continue_playing

Source: https://docs.cycling74.com/apiref/lom/song

Resumes playback from the current playback position.

```APIDOC
## continue_playing

### Description
Resumes playback from the current playback position.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### crop

Source: https://docs.cycling74.com/apiref/lom/clip

Crops the clip. If the clip is looped, the region outside the loop is removed. Otherwise, the region outside the start and end markers is removed.

```APIDOC
## crop

### Description
Crops the clip: if the clip is looped, the region outside the loop is removed; if it isn't, the region outside the start and end markers.
```

--------------------------------

### capture_midi

Source: https://docs.cycling74.com/apiref/lom/song

Captures recently played MIDI material from audible tracks into a Live Clip. The destination can be specified.

```APIDOC
## capture_midi

### Description
Captures recently played MIDI material from audible tracks into a Live Clip. If `destination` is not set or is 'auto', the Clip is inserted into the currently focused view. Otherwise, it is inserted into the specified view.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
#### Query Parameters
- **destination** (int) - Optional - 0 = auto, 1 = session, 2 = arrangement
```

--------------------------------

### Canonical Path for CuePoint

Source: https://docs.cycling74.com/apiref/lom/cuepoint

This is the canonical path to access cue points within a live set.

```regex
live_set cue_points N
```

--------------------------------

### Song.View Canonical Path

Source: https://docs.cycling74.com/apiref/lom/song_view

The canonical path for accessing the Song.View object within the Live Object Model.

```plaintext
live_set view
```

--------------------------------

### add_new_notes

Source: https://docs.cycling74.com/apiref/lom/clip

Adds new notes to a MIDI clip. Each note can have properties like pitch, start time, duration, velocity, mute status, probability, and deviation.

```APIDOC
## add_new_notes

### Description
Adds new notes to a MIDI clip. Each note can have properties like pitch, start time, duration, velocity, mute status, probability, and deviation.

### Parameters
`dictionary`
Key: `"notes"` [list of note specification dictionaries]
Note specification dictionaries have the following keys:
`pitch` : [int] the MIDI note number, 0...127, 60 is C3.
`start_time` : [float] the note start time in beats of absolute clip time.
`duration` : [float] the note length in beats.
`velocity (optional)` : [float] the note velocity, 0 ... 127 _(100 by default)_.
`mute (optional)` : [bool] 1 = the note is deactivated _(0 by default)_.
`probability (optional)` : [float] the chance that the note will be played: 1.0 = the note is always played, 0.0 = the note is never played _(1.0 by default)_.
`velocity_deviation (optional)` : [float] the range of velocity values at which the note can be played: 0.0 = no deviation; the note will always play at the velocity specified by the _velocity_ property. -127.0 to 127.0 = the note will be assigned a velocity value between _velocity_ and _velocity + velocity_deviation_ , inclusive; if the resulting range exceeds the limits of MIDI velocity (0 to 127), then it will be clamped within those limits _(0.0 by default)_.
`release_velocity (optional)` : [float] the note release velocity _(64 by default)_.

### Returns
A list of note IDs of the added notes.

### Notes
For MIDI clips only.
Available since Live 11.0.
```

--------------------------------

### Application Properties

Source: https://docs.cycling74.com/apiref/lom/application

Access properties of the Live application, such as CPU usage and dialog box information.

```APIDOC
## Application Properties

### current_dialog_button_count

*   **Description**: The number of buttons in the current message box.
*   **Type**: int
*   **Access**: read-only

### current_dialog_message

*   **Description**: The text of the current message box (empty if no message box is currently shown).
*   **Type**: symbol
*   **Access**: read-only

### open_dialog_count

*   **Description**: The number of dialog boxes shown.
*   **Type**: int
*   **Access**: read-only, observe

### average_process_usage

*   **Description**: Reports Live's average CPU load. Note that Live's CPU meter shows the audio processing load but not Live's overall CPU usage.
*   **Type**: float
*   **Access**: read-only, observe

### peak_process_usage

*   **Description**: Reports Live's peak CPU load. Note that Live's CPU meter shows the audio processing load but not Live's overall CPU usage.
*   **Type**: float
*   **Access**: read-only, observe
```

--------------------------------

### Create Audio Clip

Source: https://docs.cycling74.com/apiref/lom/clipslot

Creates an audio clip by referencing an audio file. This function can only be used on clip slots belonging to audio tracks and requires the track not to be frozen. The path must be absolute and point to a supported audio format.

```python
clip_slot.create_audio_clip(path='path/to/your/audio.wav')
```

--------------------------------

### Track Color

Source: https://docs.cycling74.com/apiref/lom/track

Get or set the RGB color of a track. The color is represented as an integer in the format 0x00rrggbb. When setting, Live selects the nearest available color.

```Live API
color int observe
The RGB value of the track's color in the form 0x00rrggbb or (2^16 * red) + (2^8) * green + blue, where red, green and blue are values from 0 (dark) to 255 (light).

When setting the RGB value, the nearest color from the track color chooser is taken.
```

--------------------------------

### position

Source: https://docs.cycling74.com/apiref/lom/clip

Get and set the clip's loop position. The value will always equal loop_start, however setting this property, unlike setting loop_start, preserves the loop length.

```APIDOC
## position

### Description
Get and set the clip's loop position. The value will always equal loop_start, however setting this property, unlike setting loop_start, preserves the loop length.

### Method
GET, SET

### Parameters
- **position** (float) - Required - The desired loop start position in beats.

### Response
#### Success Response
- **position** (float) - The current loop start position in beats.

### Request Example
```json
{
  "position": 4.0
}
```

### Response Example
```json
{
  "position": 4.0
}
```
```

--------------------------------

### force_link_beat_time

Source: https://docs.cycling74.com/apiref/lom/song

Forces the Link timeline to synchronize with Live's current beat time.

```APIDOC
## force_link_beat_time

### Description
Forces the Link timeline to jump to Live's current beat time.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Scene.fire_as_selected

Source: https://docs.cycling74.com/apiref/lom/scene

Fires the currently selected scene and then selects the next scene. This function can also force legato playback for all clips.

```APIDOC
## Scene.fire_as_selected

### Description
Fire the selected scene, then select the next scene. It doesn't matter on which scene you are calling this function.

### Method
N/A (Function within a class)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- `force_legato` (optional) [bool] - If 1 (default 0), launches all clips immediately in Legato, independent of their launch mode.
```

--------------------------------

### warp_markers

Source: https://docs.cycling74.com/apiref/lom/clip

Observing this property outputs a bang when the Warp Markers change. Getting this property returns the Warp Markers in a dict as pairs of sample times and beat times. Available for audio clips only.

```APIDOC
## warp_markers

### Description
Observing this property outputs a bang when the Warp Markers change. Getting this property returns the Warp Markers in a dict as pairs of sample times and beat times.

`sample_time` : [float] the position in seconds in the audio sample file.
`beat_time` : [float] the beat this sample position corresponds to.

Available for audio clips only.

_Getting is available since Live 11.0._

### Parameters
None

### Response
#### Success Response
- **warp_markers** (dict) - A dictionary where keys are sample times (float) and values are corresponding beat times (float).

### Response Example
{
  "warp_markers": {
    "0.0": 0.0,
    "1.234": 1.0,
    "2.468": 2.0
  }
}
```

--------------------------------

### jump_to_next_cue

Source: https://docs.cycling74.com/apiref/lom/song

Jumps playback to the next cue point if possible.

```APIDOC
## jump_to_next_cue

### Description
Jumps playback to the next cue point, if possible.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Track Available Output Routing Types

Source: https://docs.cycling74.com/apiref/lom/track

Get the available output routing types for a track. This is represented as a dictionary containing a list of dictionaries, each describing an output routing type. Not available on the master track.

```Live API
available_output_routing_types dictionary read-onlyobserve
The list of available target types for the track's output routing. It's represented as a _dictionary_ with the following key:
`available_output_routing_types` [list]
The list contains _dictionaries_ as described in _output_routing_type_.
Not available on the master track.
```

--------------------------------

### redo

Source: https://docs.cycling74.com/apiref/lom/song

Reverses the last performed operation in the Live application.

```APIDOC
## redo

### Description
Causes the Live application to redo the last operation.

### Method
POST

### Endpoint
/redo
```

--------------------------------

### Fire Selected Scene and Move to Next

Source: https://docs.cycling74.com/apiref/lom/scene

Fires the currently selected scene and then selects the next scene in the matrix. This can also be configured to use legato playback.

```javascript
scene.fire_as_selected();
scene.fire_as_selected(true); // Force legato
```

--------------------------------

### Canonical Path for Nested Device Chains

Source: https://docs.cycling74.com/apiref/lom/chain

Represents the canonical path to access nested device chains within a Live set.

```path
live_set tracks N devices M chains L devices K chains P ...
```