Configurable Parameters

Enumerations:

 

Type

SDK Name

Protobuf Name

Default Value

Updateable

Description

Stream Source Configuration

string

Url

string

 

false

Stream input URL. Supports the following:

  • Video files
  • Image sequence (img_%02d.jpg)
  • Video streams
  • GStreamer pipelines

Stream Preprocessor Configuration

uint32

RotateAngle

uint32

0

false

Input stream rotation. Must be a multiple of 90 between 0 to 360

uint32

Roi.X

roi.x

0

false

ROI to extract from the image before further processing

uint32

Roi.Y

roi.y

0

false

uint32

Roi.Width

roi.width

0

false

uint32

Roi.Height

roi.height

0

false

Stream Detector Configuration

float

ScoreThreshold

float

0.5

true

Detections with a score below this threshold will be ignored

float

Groups.[N/A].MinWidth

groups.[N/A].min_width

0

true

  • Groups with bounding boxes limits
  • Group names should match in global settings

float

Groups.[N/A].MaxWidth

groups.[N/A].max_width

400

true

float

Groups.[N/A].MinHeight

groups.[N/A].min_height

0

true

floaft

Groups.[N/A].MaxHeight

groups.[N/A].max_height

400

true

float

Groups.[N/A].MinAspectRatio

groups.[N/A].min_aspect_ratio

0

true

float

Groups.[N/A].MaxAspectRatio

groups.[N/A].max_aspect_ratio

100

true

Stream Tracker Configuration

uint32

MaxTimeSinceUpdateToReport

uint32

1000

true

  • The maximum number of frames from which to report updated tracks.
  • When 0, only assigned tracks are reported
Stream Renderer Configuration

Type

SDK name

Protobuf name

Default value

Updatable

bool

SkipAllRendering

bool

false

true

bool

DrawDetections

bool

false

true

bool

DrawTracks

bool

true

true

bool

PrintClass

bool

true

true

bool

PrintScore

bool

false

true

bool

PrintTrackId

bool

true

true

bool

ColorTrack

bool

true

true

bool

DrawTrackVelocity

bool

true

true

float

TrackVelocityFactor

float

10

true

uint32

BoundingBoxes.others.BoxColor

bounding_boxes.others.box_color

255

true

uint32

BoundingBoxes.others.LineThickness

bounding_boxes.others.line_thickness

1

true

int32

BoundingBoxes.others.TextOffsetX

bounding_boxes.others.text_offset_x

0

true

int32

BoundingBoxes.others.TextOffsetY

bounding_boxes.others.text_offset_y

-5

true

uint32

BoundingBoxes.others.FontColor

bounding_boxes.others.font_color

0

true

float

BoundingBoxes.others.FontScale

bounding_boxes.others.font_scale

0.5

true

uint32

BoundingBoxes.others.FontThickness

bounding_boxes.others.font_thickness

1

true

uint32

BoundingBoxes.people.BoxColor

bounding_boxes.people.box_color

16711680

true

uint32

BoundingBoxes.people.LineThickness

bounding_boxes.people.line_thickness

1

true

int32

BoundingBoxes.people.TextOffsetX

bounding_boxes.people.text_offset_x

0

true

int32

BoundingBoxes.people.TextOffsetY

bounding_boxes.people.text_offset_y

-5

true

uint32

BoundingBoxes.people.FontColor

bounding_boxes.people.font_color

0

true

float

BoundingBoxes.people.FontScale

bounding_boxes.people.font_scale

0.5

true

uint32

BoundingBoxes.people.FontThickness

bounding_boxes.people.font_thickness

1

true

uint32

BoundingBoxes.vehicles.BoxColor

bounding_boxes.vehicles.box_color

65280

true

uint32

BoundingBoxes.vehicles.LineThickness

bounding_boxes.vehicles.line_thickness

1

true

int32

BoundingBoxes.vehicles.TextOffsetX

bounding_boxes.vehicles.text_offset_x

0

true

int32

BoundingBoxes.vehicles.TextOffsetY

bounding_boxes.vehicles.text_offset_y

-5

true

uint32

BoundingBoxes.vehicles.FontColor

bounding_boxes.vehicles.font_color

0

true

float

BoundingBoxes.vehicles.FontScale

bounding_boxes.vehicles.font_scale

0.5

true

uint32

BoundingBoxes.vehicles.FontThickness

bounding_boxes.vehicles.font_thickness

1

true

Corner

Osd.Corner

osd.corner

TopLeft

true

OsdValue

Osd.Values[0]

osd.values[0]

StreamId

true

OsdValue

Osd.Values[1]

osd.values[1]

FrameId

true

OsdValue

Osd.Values[2]

osd.values[2]

Pts

true

OsdValue

Osd.Values[3]

osd.values[3]

Fps

true

OsdValue

Osd.Values[4]

osd.values[4]

Latency

true

OsdValue

Osd.Values[5]

osd.values[5]

Tracks

true

uint32

Osd.MarginX

osd.margin_x

10

true

uint32

Osd.MarginY

osd.margin_y

10

true

uint32

Osd.LineDistance

osd.line_distance

10

true

uint32

Osd.FontColor

osd.font_color

16777215

true

float

Osd.FontScale

osd.font_scale

0.5

true

uint32

Osd.FontThickness

osd.font_thickness

1

true

 

Code Example

#python3
stream1_id =
stub.StartStream(stream.StartStreamRequest(configuration=StartStreamConfiguration())).stream_id
stream2_id =
stub.StartStream(stream.StartStreamRequest(configuration=StartStreamConfiguration())).stream_id
print(f"all streams: {stub.GetStreams().stream_ids}")
stub.StopAllStreams()