set_clip_property

Instructions

Implementation Reference

• src/tools/clip-tools.ts:170-173 (handler)

  The handler function for the 'set_clips_property' tool (note: tool name uses plural 'clips'). It batches the property modifications across multiple clips using the helper function.

  async setClipProperty({ clips }: { clips: { clip_id: string, property: z.infer<typeof ClipSettableProp> }[] }) {
      await batchModifyClipProp(clips)
      return Result.ok()
  }

• src/tools/clip-tools.ts:160-173 (registration)

  Tool registration via @tool decorator, defining name 'set_clips_property', description, and params schema.

  @tool({
      name: 'set_clips_property',
      description: 'batch set clip property',
      paramsSchema: {
          clips: z.array(z.object({
              clip_id: z.string(),
              property: ClipSettableProp,
          }))
      }
  })
  async setClipProperty({ clips }: { clips: { clip_id: string, property: z.infer<typeof ClipSettableProp> }[] }) {
      await batchModifyClipProp(clips)
      return Result.ok()
  }

• src/types/zod-types.ts:158-197 (schema)

  Zod schema defining the settable properties for clips, used in the tool's params.

  export const ClipSettableProp = z.object({
      name: z.string().optional(),
      color: commomProp.color,
      // color_index: commomProp.color_index,
      end_marker: z.number().optional(),
      gain: z.number().optional(),
      is_playing: z.boolean().optional(),
      launch_mode: z.number().optional(),
      launch_quantization: z.number().optional(),
      loop_end: z.number().optional().describe('[float] For looped clips: loop end. For unlooped clips: clip end.'),
      loop_start: z.number().optional().describe(`[float] For looped clips: loop start.
          loop_start and loop_end are in absolute clip beat time if clip is MIDI or warped. 
          The 1.1.1 position has beat time 0. If the clip is unwarped audio, they are given in seconds, 
          0 is the time of the first sample in the audio material.`),
      looping: z.boolean().optional().describe('true = clip is looped. Unwarped audio cannot be looped.'),
      muted: z.boolean().optional(),
      pitch_coarse: z.number().optional().describe(`[int] Pitch shift in semitones ("Transpose"), -48 ... 48.
  Available for audio clips only.`),
      pitch_fine: z.number().optional().describe(`[float] Extra pitch shift in cents ("Detune"), -50 ... 49.
  Available for audio clips only.`),
      position: z.number().optional().describe(`[float] 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`),
      ram_mode: z.boolean().optional(),
      signature_denominator: z.number().optional(),
      signature_numerator: z.number().optional(),
      start_marker: z.number().optional().describe(`[float] The start marker of the clip in beats, 
          independent of the loop state. Cannot be set behind the end marker`),
      velocity_amount: z.number().optional(),
      warp_mode: z.number().optional().describe(`[int] The Warp Mode of the clip as an integer index. Available Warp Modes are:
          0 = Beats Mode
          1 = Tones Mode
          2 = Texture Mode
          3 = Re-Pitch Mode
          4 = Complex Mode
          5 = REX Mode
          6 = Complex Pro Mode
          Available for audio clips only.`),
      warping: z.boolean().optional().describe('Available for audio clips only.')
  })

• src/utils/obj-utils.ts:154-160 (helper)

  Core helper function that performs the batch modification of clip properties by resolving clips and calling modifyClipProp.

  export async function batchModifyClipProp(clips: { clip_id: string, property: z.infer<typeof ClipSettableProp> }[]) {
      const promises = clips.map(async ({ clip_id, property }) => {
          const clip = await getClipById(clip_id)
          await modifyClipProp(clip, property)
      })
      await Promise.all(promises)
  }

• src/utils/obj-utils.ts:150-152 (helper)

  Helper that modifies a single clip's properties using the generic modifyObjProps function.

  export function modifyClipProp(clip: Clip, property: z.infer<typeof ClipSettableProp>) {
      return modifyObjProps(clip, property, ClipSettableProp)
  }