ref_vfmethod_fssProc

VirtualDub Plugin SDK 1.2

fssProc video filter method

fssProc

Generates a script command to configure the filter to its current state.

void fssProc(VDXFilterActivation *fa, const VDXFilterFunctions *ff, char *buf, int buflen);

Parameters

fa	Pointer to filter activation structure.
ff	Pointer to callback function structure.
buf	Pointer to buffer to receive configuration command.
buflen	Maximum number of bytes to write to the buffer, including any null terminator.

Thread safety

This method is not thread-safe.

Exceptions

This function must not throw exceptions (see Except()).

Return value

True if the string should be included, false otherwise.

Default behavior

If omitted, no default action is taken. This means that the filters settings would not be restored in a script job.

Remarks

This function is the only method by which filters can store configuration parameters between the time a job entry is saved, and when that entry is executed.The string returned by fssProc is appended onto a configuration string of the form:

VirtualDub.video.filters.instance[0].

and thus the filter provides only the method call part of the string. Use _snprintf() or _vsnprintf() to generate the string, in case you might overflow the buffer. If you return false from the function, VirtualDub simply omits the script line entirely. Note that VirtualDub only has a 512 character buffer when executing script lines, so you can only count on 450 characters of space for your string even though there is usually 2K or so available to this function.

---

Copyright (C) 2007-2012 Avery Lee.