Scripting API

btkSetEventDescription

Module BTKEventModifier

Description#

Modifies the description of all events which have the required label.

Parameters#

hHandle pointing to a C++ btk::Acquisition object.
labelString with the label of the event to modify.
newdescString containing the new description.

Returned Values#

eventsA dictionnary with the same format than in the function btkGetEvents
eventsInfoA dictionnary with the same format than in the function btkGetEvents

Detailed Description#

Notes#

See also#

btkSetEventId

Syntax#

(events, eventsInfo) = btkSetEventDescription(h, label, newdesc)

Examples#