LMMS
Loading...
Searching...
No Matches
_LV2_URID_Unmap Struct Reference

#include <urid.h>

Public Attributes

LV2_URID_Unmap_Handle handle
const char *(* unmap )(LV2_URID_Unmap_Handle handle, LV2_URID urid)

Detailed Description

URI Unmap Feature (LV2_URID__unmap)

Member Data Documentation

◆ handle

LV2_URID_Unmap_Handle _LV2_URID_Unmap::handle

Opaque pointer to host data.

This MUST be passed to unmap() whenever it is called. Otherwise, it must not be interpreted in any way.

◆ unmap

const char *(* _LV2_URID_Unmap::unmap)(LV2_URID_Unmap_Handle handle, LV2_URID urid)

Get the URI for a previously mapped numeric ID.

Returns NULL if URID is not yet mapped. Otherwise, the corresponding URI is returned in a canonical form. This MAY not be the exact same string that was originally passed to LV2_URID_Map::map(), but it MUST be an identical URI according to the URI syntax specification (RFC3986). A non-NULL return for a given URID will always be the same for the life of the plugin. Plugins that intend to perform string comparison on unmapped URIs SHOULD first canonicalise URI strings with a call to map_uri() followed by a call to unmap_uri().

Parameters
handleMust be the callback_data member of this struct.
URIDThe ID to be mapped back to the URI string.

Get the URI for a previously mapped numeric ID.

Returns NULL if urid is not yet mapped. Otherwise, the corresponding URI is returned in a canonical form. This MAY not be the exact same string that was originally passed to LV2_URID_Map::map(), but it MUST be an identical URI according to the URI syntax specification (RFC3986). A non-NULL return for a given urid will always be the same for the life of the plugin. Plugins that intend to perform string comparison on unmapped URIs SHOULD first canonicalise URI strings with a call to map_uri() followed by a call to unmap_uri().

Parameters
handleMust be the callback_data member of this struct.
URIDThe ID to be mapped back to the URI string.

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