Set Instruments

Set Instruments

The set_instruments action adds the requested instrument groups to the timeline (if they were not previously present) and sets their status to active. Additionally, it automatically sets all instruments not in the provided list to inactive. This action is equivalent to using an add_instruments action and a silence_instruments action (given that all unwanted instruments appear in the silence list).

An optional parameter instrumentation_threshold may be provided. This instructs the Composer to use the provided proportion of the instruments, based on the descriptor that is active when the action happens.

Data Item Type Required/ Optional Description
set_instruments array required An array of instrument_group ids
instrumentation_threshold number optional A number between 0.0 - 1.0 specifying the proportion of the provided “instrument groups” which should play. NOTE: If instrumentation_threshold is not provided, a value of 1.0 is assumed, meaning that all provided instrument_groups will play.

Example:

{
    "time": 11,
    "set_instruments": [
        "grand_piano",
        "rhodes"
    ]
}

Optionally asking for half of the list of instruments to play. The exact result depends on the descriptor which is active at the specified time.

{
    "time": 11,
    "set_instruments": [
        "grand_piano",
        "rhodes"
    ],
    "instrumentation_threshold": 0.5
}