CreateHighResolutionStreamBlockConfigCommand Object


Description:

Command to create high resolution stream block sampling configuration.

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

CreateHighResolutionStreamBlockConfigCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
BaselineSampleCount

Number of samples used to calculate the trigger value.

Type: u8

Default: 3

Range: 1 - 255

EnableTrigger

Whether triggering should be enabled or disabled.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable triggering.

FALSE

Disable triggering.

NamePrefix

Prefix name to use for high resolution sampling objects.

Type: string

Default: StreamBlockSample

PortHandleList

Handle of Rx ports for high resolution sampling.

Type: handle

Default: 0

StreamBlockHandleList

Handle of stream block for high resolution sampling.

Type: handle

Default: 0

TotalSamples

Total number of samples supported for high resolution sampling.

Type: u16

Default: 1000

Range: 1 - 1000

TriggerCondition

Condition to apply the statistic.

Type: enum

Default: LESS_THAN

Possible Values:

Value Description
LESS_THAN

Less than condition.

LESS_THAN_OR_EQUAL

Less than or equal condition.

GREATER_THAN

Greater than condition.

GREATER_THAN_OR_EQUAL

Greater than or equal condition.

EQUAL

Equal condition.

NOT_EQUAL

Not equal condition.

TriggerLocation

Trigger location.

Type: u8

Default: 20

Range: 0 - 99

TriggerStat

What statistic to use for triggering.

Type: string

Default: FrameRate

TriggerValue

Value to use for trigger condition.

Type: double

Default: 95

TriggerValueUnitMode

Type of trigger value.

Type: enum

Default: PERCENT_BASELINE

Possible Values:

Value Description
PERCENT_BASELINE

Percent of baseline as trigger unit.

ABSOLUTE

Absolute value as trigger unit.

KILOBITS_PER_SECOND

Kbps as trigger unit.

MEGABITS_PER_SECOND

Mbps as trigger unit.

GIGABITS_PER_SECOND

Gbps as trigger unit.

CreateHighResolutionStreamBlockConfigCommand Read-Only Attributes

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