LV2UI_Request_Value Struct Reference

#include <ui.h>

Public Attributes
LV2UI_Feature_Handle	handle
LV2UI_Request_Value_Status(*	request )(LV2UI_Feature_Handle handle, LV2_URID key, LV2_URID type, const LV2_Feature *const *features)

Detailed Description

A feature to request a new parameter value from the host.

Member Data Documentation

handle

LV2UI_Feature_Handle LV2UI_Request_Value::handle

Pointer to opaque data which must be passed to request().

request

LV2UI_Request_Value_Status(* LV2UI_Request_Value::request)(LV2UI_Feature_Handle handle, LV2_URID key, LV2_URID type, const LV2_Feature *const *features)

Request a value for a parameter from the host.

This is mainly used by UIs to request values for complex parameters that don't change often, such as file paths, but it may be used to request any parameter value.

This function returns immediately, and the return value indicates whether the host can fulfill the request. The host may notify the plugin about the new parameter value, for example when a file is selected by the user, via the usual mechanism. Typically, the host will send a message to the plugin that sets the new parameter value, and the plugin will notify the UI via a message as usual for any other parameter change.

To provide an appropriate UI, the host can determine details about the parameter from the plugin data as usual. The additional parameters of this function provide support for more advanced use cases, but in the simple common case, the plugin will simply pass the key of the desired parameter and zero for everything else.

Parameters

handle	The handle field of this struct.
key	The URID of the parameter.
type	The optional type of the value to request. This can be used to request a specific value type for parameters that support several. If non-zero, it must be the URID of an instance of rdfs:Class or rdfs:Datatype.
features	Additional features for this request, or NULL.

Returns

A status code which is 0 on success.

---

The documentation for this struct was generated from the following files:

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/lv2/ui.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/format_types/LV2_SDK/lv2/lv2/ui/ui.h