OpenKatana · List sfx:
OpenKatana_list_sfx lets you browse OpenKatana’s built-in library of synthesized sound effects so you can choose suitable sounds for transitions, accents, and other moments in your edit. The catalog describes available effects, including their names, categories, variants, durations, and default playback levels, and supports browsing a particular category. These sounds are generated deterministically by OpenKatana rather than taken from recordings or downloads, so the catalog does not depend on third-party recorded sound assets or their licenses. This node is a discovery tool: it helps you plan sound design and identify effects to place on a timeline, but browsing the catalog does not itself play sounds or add them to your edit.
OpenKatana · List sfx Input Parameters:
project_id
A required STRING identifying the OpenKatana project context for the tool request. The node passes this value to its argument-preparation helper before calling the catalog tool. The underlying catalog method does not declare a project identifier and browses OpenKatana’s own sound library rather than project-specific recordings. Use the project identifier associated with your workflow to keep the request consistent with your other OpenKatana operations. No default value, permitted identifier format, or minimum or maximum length is specified in the supplied node interface.
arguments
A required STRING containing the tool arguments. For this tool, supply a JSON object such as {} to request the complete catalog, or supply a category property to filter it. The underlying method accepts category as a string or null, with a default of None; omitting it or using {"category":null} therefore requests all categories. A supplied category must exactly match a category returned by the catalog, including capitalization, because filtering uses direct string equality. A category with no matching entries raises an error instead of returning an empty catalog. The category selector belongs inside this string; it is not a separate node input. No default STRING value, length limits, or complete list of category options is provided in the interface.
after
An optional STRING accepted by the node’s execution method. In the supplied implementation, this value is not referenced when preparing arguments or invoking the tool, so no effect on catalog contents, filtering, or returned information is demonstrated. Its Python default is None when omitted, and no string default, allowed options, or length limits are specified. You can leave it unconnected for a standalone catalog request; the provided code does not establish any additional dependency or sequencing behavior for this input.
OpenKatana · List sfx Output Parameters:
result_json
A STRING containing the serialized response returned through OpenKatana’s response helper. The underlying catalog method returns an object with three fields: sfx, the list of catalog entries matching your request; usage, a short example showing how effects are placed in timeline audio cues; and provenance, which identifies the sounds as generated by openkatana/sfx.py through deterministic synthesis. Catalog entries describe effect names, categories, variants, durations, and default levels, helping you choose a valid sound and plan its placement. The supplied usage example is audio: `{"mode":"mix","tracks":[...music...],"cues":[{"sfx":"whoosh","at":1.2}`]}; the ...music... portion is an illustrative placeholder, not valid JSON to paste unchanged. The response helper’s implementation is not provided, so any additional outer response structure cannot be established from this context. This output is catalog information, not an audio file or playback connection.
OpenKatana · List sfx Usage Tips:
- Start with
{}inargumentsto discover the available effects and category names. This avoids guessing category values that may not exist. - To narrow the results, copy a category exactly from the returned catalog and place it in the
categoryproperty of your arguments object. Matching is exact, so preserve capitalization and spacing. - Use the returned effect name when building a timeline’s
audio.cuesentries. For example, the supplied context demonstrates{"sfx":"whoosh","variant":2,"at":1.25,"level_db":-14}; verify the available variants in your catalog before using a particular variant. - Use catalog durations to choose effects that fit the timing of a transition or visual accent. Browsing alone does not position or trim a sound.
- When placing an effect, omit
level_dbif you want its category’s default level, or specify it in the cue when you need a different mix level. Playback-level changes belong to timeline cues, not to this catalog node’s arguments. - Do not expect catalog browsing to generate an audio preview. The supplied sound-effect implementation describes generated files being cached under the project’s
.openkatana/sfx/directory when used as timeline cues.
OpenKatana · List sfx Common Errors and Solutions:
Unknown sfx category '...'
- Explanation: The catalog method raises
ContractErrorwith this message when a supplied category has no matching entries. An empty string also counts as a supplied category and will fail unless an entry actually uses that category. - Solution: Request the full catalog with
{}, then copy an existing category exactly. To remove filtering, omitcategoryor set it tonullrather than using an empty string.
unexpected inputs: ...
- Explanation: The node explicitly raises
TypeErrorwith this message if execution receives additional named inputs not declared by its typed input definitions. The exposed interface does not provide a separate category socket. - Solution: Use only
project_id,arguments, and the optionalafterinput. Put the category filter inside the JSON object supplied througharguments.
Invalid JSON in arguments
- Explanation: This is a troubleshooting description rather than an exact error string shown in the supplied code. An incorrectly formatted arguments string can fail during argument preparation; common causes include single-quoted property names, trailing commas, and copying the illustrative
...music...placeholder. - Solution: Begin with
{}and add only the category filter if needed. Use double quotes around JSON property names and string values, and do not paste timeline examples into this catalog request.
Unsupported tool argument
- Explanation: The underlying
list_sfxmethod accepts only the optionalcategoryargument. Supplying timeline cue properties such assfx,variant,at, orlevel_dbas catalog arguments does not match its signature. The precise error wording depends on the invocation layer, which is not included in the supplied context. - Solution: Keep catalog arguments empty or limited to
category. Use effect-selection, placement, and level properties later in your timeline’saudio.cuesconfiguration.
