Name

kOfxPropParamSetNeedsSyncing — States whether the plugin needs to resync its private data

Synopsis

#include "/ofxParam.h"
#define kOfxPropParamSetNeedsSyncing "OfxPropParamSetNeedsSyncing"

Type

kOfxPropParamSetNeedsSyncing is of type int, and has only a single dimension.

Property Set

This is a property that belongs to the param set instance (read/write).

Default

The default value is 0.

Valid Values

  • 0 - no need to sync
  • 1 - paramset is not synced

Description

States whether the plugin needs to resync its private data

The plugin should set this flag to true whenever any internal state has not been flushed to the set of params.

The host will examine this property each time it does a copy or save operation on the instance. If it is set to 1, the host will call SyncPrivateData and then set it to zero before doing the copy/save. If it is set to 0, the host will assume that the param data correctly represents the private state, and will not call SyncPrivateData before copying/saving. If this property is not set, the host will always call SyncPrivateData before copying or saving the effect (as if the property were set to 1 -- but the host will not create or modify the property).