byteblowerll.byteblower.FrameTagTx

class byteblowerll.byteblower.FrameTagTx(*args, **kwargs)

The FrameTagTx class describes the transmit configuration of a Tag in a Frame.

ByteBlower supports optional tagging of frames. Such a tag can have different formats, locations, … These parameters can be set and retrieved using this class.

Currently, two different types of FrameTags are supported:

SequenceTag

is used for out of sequence detection and contains a frame counter value. The server automatically increments it for each frame sent in the stream.

TimeTag

is used for latency measurements and contains a timestamp value. The server automatically determines it by looking at its clock for each frame sent in the stream.

Adding tags is a very powerful and flexible feature of ByteBlower. Please have a look at ByteBlower API Knowledgebase: Background: Adding FrameTags to your ByteBlower frame - structure and behaviour for a very detailed explanation.

To perform latency measurements or out of sequence detection, configuration needs to be done both at TX and RX side:

• At the TX side

  we need to add the FrameTag(s) to the Frame object.

• At the RX side

  we need to create the appropriate receiver(s) on the incoming packets. This causes the server to read a tag from the received frames and interpret them (e.g. by calculating latency based on the timestamps).

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

DescriptionGet(*args)	Gets a textual description for the current object
Enable(set)	Method to enable the tag on the Frame.
FormatDestroy()
FormatGet()
FormatStringGet()
IsEnabled()	Method which will return whether a tag is activated or not.
MetricsDestroy()
MetricsGet()
ParentGet()	Returns the parent object.
PositionAutomaticSet()	This method will use the automatic position for the tag.
PositionGet()	The current configured location of the tag within the Frame.
PositionSet(newPosition)	Sets the location of the tag in the Frame.
Refresh()	Retrieves the latest data from the server for this object.
TypeGet()
__init__(*args, **kwargs)	Initialize self.

Attributes

thisown

The membership flag