Switchboard Extension SDK
Loading...
Searching...
No Matches
switchboard::SwitchboardObjectResolver Class Reference

Resolves Switchboard objects by their id. More...

#include <SwitchboardObjectResolver.hpp>

Public Member Functions

 SwitchboardObjectResolver (const SwitchboardObjectResolver &)=delete
SwitchboardObjectResolver & operator= (const SwitchboardObjectResolver &)=delete
SwitchboardObjectgetObject (const std::string &objectID)
 Resolves an object by its id (or URI).

Static Public Member Functions

static SwitchboardObjectResolver & getInstance ()
 Returns the shared resolver instance.

Detailed Description

Resolves Switchboard objects by their id.

Part of the extension-facing API. Lets extension code obtain a pointer to another object managed by the SDK (for example, a sibling node that an audio player should synchronize with) without depending on internal SDK headers.

Member Function Documentation

◆ getObject()

SwitchboardObject * switchboard::SwitchboardObjectResolver::getObject ( const std::string & objectID)

Resolves an object by its id (or URI).

Parameters
objectIDThe id (or URI) of the object to resolve.
Returns
The object if found, nullptr otherwise.

The documentation for this class was generated from the following file: