EnhEvent Object

[This is preliminary documentation and subject to change.]

An EnhEvent object contains information about a single enhancement event, such as sending an announcement or downloading a file. Using EnhEvent objects, you can create enhancement authoring tools that programmatically get and set the parameters of events in the enhancement stream.

Each EnhEvent object in the enhancement stream corresponds to a line of stream compiler syntax. In essence, an EnhEvent object wraps a line of syntax, exposing the various keywords and parameters so that they can be easily accessed by applications such as authoring or syntax-validation tools.

The entire set of enhancement events for a show, also known as the enhancement stream, is stored as a set of EnhEvent objects in the EnhEvents collection. An EnhEvent object must be part of an EnhEvents collection. In other words, you do not create stand-alone instances of EnhEvent objects. Instead, you create EnhEvent objects by calling methods of the EnhEvents collection.

For more information on working with EnhEvent objects, see the following topics: