API Scope.AddOverlay

<sidebar>API Contents</sidebar> Adds a packet overlay to the stream at a given offset from the current time

Parameters

HANDLE StreamH

The stream that is to be read

LONG TimeUS

The -ve time offset to start the calculation from, in microseconds

ULONG Duration

The duration of the overlay packet

STRING Label

The label to display on the overlay

ULONG ForeRGBA

A red, green, blue, alpha value for the text and border

ULONG BackRGBA

A red, green, blue, alpha value for the area fill

Return value

This call does not return a value

Detailed description

No additional information

Examples

Calling in a calculation

• Add to a calculation icon:

  ::Scope.AddOverlay(streamh, timeus, duration, "label", forergba, backrgba)

No additional examples