CaptureGetFrameCommand Object


Description:

Get the capture frame and populate packet frame object.

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

CaptureGetFrameCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
CaptureProxyId

Capture proxy ID (handle).

Type: handle

Default: 0

FrameIndex

Frame index to be retrieved.

Type: u32

Default: 0

CaptureGetFrameCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status
DataLength

Retrieved frame's length of data in bytes.

Type: u32

Default: 0

PacketData

Retrieved frame's data in hex format.

Type: string

Default: "" (empty string)

PreambleLength

Retrieved frame's length of preamble in bytes.

Type: u32

Default: 0

RawTimestamp

Retrieved frame arrival time in hardware timestamp format.

Type: string

Default: "" (empty string)

Timestamp

Retrieved frame timestamp.

Type: string

Default: "" (empty string)