VideoClientProtocolConfig Object


Description:

Video RTSP protocol client.

Parents: EmulatedDevice

Result children (automatically created): VideoClientResults

Relations:

Side name
(Type)
Relative Description
ClientLoadProfile
(AffiliatedClientLoadProfile)

ClientLoadProfile

ClientProfile
(AffiliatedClientProfile)

ClientProfile

L4L7ProtocolConfigServerBase
(ConnectionDestination)

CifsServerProtocolConfig, DpgServerProtocolConfig, FtpServerProtocolConfig, HttpServerProtocolConfig, IperfServerProtocolConfig, RawTcpServerProtocolConfig, VideoServerProtocolConfig

ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)

ViewControlPlaneMplsBindingResult

ConvergenceConfig
(PrimaryPathProtocolConfig)

ConvergenceConfig, ConvergenceConfig

ResultChild
(ResultChild)

VideoClientResults

Use this to connect a results object to an object.

TimeComparisonPair
(TimeComparisonPairSrcProtocol)

TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair

UsesIf
(UsesIf)

Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf

Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).

VideoClientProtocolConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
ClientName

User-defined name for the client. Relevant only to the user.

Type: string

Default: "" (empty string)

ClipFile

Video clip file name being requested.

Type: string

Default: "" (empty string)

DstIpAddr

Destination IP address for the requested video stream. If this is set to 0.0.0.0 (the default) or ::, the client will request the video be sent to its IP address.

Type: string

Default: 0.0.0.0

DstPort

Destination port number.

Type: u16

Default: 50050

DynamicLoad

Load value in units of the load profile, only used when Use Dynamic Load is true.

Type: s32

Default: 30

Range: 1 - 1000000

EndpointConnectionPattern

Pattern for connection of client endpoints to server/peer endpoints.

Type: enum

Default: PAIR

Possible Values:

Value Description
PAIR

Pair connection(s).

BACKBONE_SRC_FIRST

Backbone connection(s) - varying the source address first.

BACKBONE_DST_FIRST

Backbone connection(s) - varying the destination address first.

BACKBONE_INTERLEAVED

Backbone connection(s) - varying the addresses interleaved.

Loop

Request the video be looped.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Request video to be looped.

FALSE

Do not request video to be looped.

UsePartialBlockState

Unused.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Unused.

FALSE

Unused.

VideoClientProtocolConfig Read-Only Attributes

Read-Only Attribute Description
LoadProfileRunState

Whether the client protocol configuration is running.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Is running.

FALSE

Is not running.