JonnyW: XML import

2014-01-16T15:57:58Z

XML import

JonnyW: XML import for latest API

2013-11-12T16:15:25Z

XML import for latest API

New page

<sidebar>API Contents</sidebar>
Adds overlay packets to the stream by decoding the stream contents

<div style="width:25%; float:right" class="toc">
====Class hierarchy====
[[API Scope|Scope]]
:[[API Scope|AddOverlays]]
</div>
__TOC__

==Parameters==
[[Variable Types|HANDLE]] ''StreamH''
:The stream that is to be read

[[Variable Types|LONG]] ''TimeUS''
:The -ve time offset to start the calculation from, in microseconds

[[Variable Types|ULONG]] ''Duration''
:The duration of the overlay packet

[[Variable Types|ULONG]] ''Baud''
:The baud to step through each sample with

[[Variable Types|ULONG]] ''Mask''
:A mask of any bits to include in a decoded packets format value

[[Variable Types|ULONG]] ''Flags''
:A set of flags to help decode the stream
:''Typical values for this parameter:''
::{| class="wikitable" width="65%"
|-
! width="30%" |Name
! width="55%" |Description
|-
|Overlay_LSBF
|Flags least-significant bit first, else most-significant bit first
|-
|Overlay_Invert
|Flags to invert the bits in a packet before calculating the packet value
|}

[[Variable Types|STRING]] ''LabelFmt''
:A format string to use for labeling packets

[[Variable Types|ULONG]] ''ForeRGBA''
:A red, green, blue, alpha value for the text and border
:''The default value for this parameter is: '''''0x000000C0'''

[[Variable Types|ULONG]] ''BackRGBA''
:A red, green, blue, alpha value for the area fill
:''The default value for this parameter is: '''''0x40FFE0A0'''

==Return value==
''This call does not return a value''

==Detailed description==
''<span style="color:red;">No additional information</span>''

==Examples==
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[cpp]">::Scope.AddOverlays(streamh, timeus, duration, baud, mask, ::Scope.Overlay_LSBF, "labelfmt", forergba, backrgba)</pre>

''<span style="color:red;">No additional examples</span>''

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Adds overlay packets to the stream by decoding the stream contents		Adds overlay packets to the stream by decoding the stream contents

API Scope.AddOverlays - Revision history

JonnyW: XML import

JonnyW: XML import for latest API