Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

SDK_API::insertChannelField

Creates a missing channel with an initial field value; an existing channel is left unchanged.

This is a no-op for an existing channel, including its storage class. To promote existing storage, use upsertChannelField with Fixed storage during configuration.

Declaration

virtual void insertChannelField(const std::string& channel,
            ChannelField field,
            ChannelValue value,
            ChannelStorage storage = ChannelStorage::Dynamic) = 0;

Parameters

NameDescription
channelFlat channel name.
fieldField to insert.
valueInitial field value.
storageStorage used for a newly created channel; defaults to dynamic.