[This is preliminary documentation and subject to change.]
The EnhEvents object is a collection of EnhEvent objects. Using the methods and properties of the EnhEvents interface you can create or parse an enhancement stream.
The EnhEvents object has the following properties and methods.
| Property | Description |
|---|---|
| Bandwidth | Bandwidth of the transmission medium, in bits per second. |
| Count | Number of EnhEvent objects in the collection. This property is read-only. |
| DependLength | Length of a file and its dependencies, in bytes. |
| ErrorCount | Number of syntax errors in the enhancement stream. |
| ErrorList | Retrieves a syntax error from the error array. |
| FindHandle | Returns the event associated with the specified handle. |
| FindTime | Returns the event starting at the specified time. |
| FPS | Frames per second of the enhancement stream. |
| FrameName | Retrieves a name from frame name array. |
| HRef | Indicates when HTML hyperlink dependencies should be resolved. |
| Item | Retrieves the specified event from the collection. |
| LastAdd | Retrieves the event last added to the collection. |
| LeadTime | Specifies the amount of time, in seconds, to wait between downloading the last dependency of an trigger event before firing the trigger. |
| LoadBias | Specifies the time offset to use when loading or merging a file. |
| Overhead | FTS overhead for file transmission, in bytes. |
| ParseTime | Converts an extended time string in Society of Motion Picture and Television Engineers (SMPTE) format into a Double. |
| Priority | Default transmission priority for the enhancement stream. This property is not yet implemented. |
| Redundancy | FTS redundancy, stored as the reciprocal of the extra duration. |
| ShowLength | Length of the show associated with this enhancement stream, in seconds. |
| ShowName | Name of the show or episode associated with the enhancement stream. |
| Style | This property is reserved for future use. |
| TimeOut | Default time-out interval for the enhancement stream. |
| TimeStr | Converts a Double into an extended SMPTE time string. |
| Title | Title of the enhancement stream. |
| Method | Description |
|---|---|
| Add | Add a new event object to the enhancement stream. |
| AddEvent | Adds the specified event object to the enhancement stream. |
| AddText | Add an event to the enhancement stream by specifying stream language text. |
| Clear | Remove all objects from the enhancement stream. |
| Flatten | Convert the enhancement stream events from high-level syntax to low-level syntax. |
| Load | Load an enhancement stream from a file. |
| Store | Save the enhancement stream to a file. |
| UnFlatten | Convert a previously flattened stream back into high-level events. |
Windows NT: Unsupported.
Windows: Requires Windows 98.
Windows CE: Unsupported.
Header: Declared in stream.idl.
Import Library: Included as a resource in stream.dll.
Unicode: Yes.