GetMuteState / SetMuteState / RNtfMuteState

GetMuteState

The GetPosition method is used to query the MuteState property of the OCA object. If the query was successful, the result is output in the property stMuteState.

	Cyclic method call Since several PLC cycles may pass between sending and the response from the device, this method should be executed cyclically.

Syntax

VAR_INPUT
   pLink    : POINTER TO ST_Link; 
   bExecute : BOOL; 
END_VAR

Inputs

Name	Type	Description
pLink	POINTER TO ST_Link	Pointer for establishing a connection between OCA objects and the OCA device
bExecute	BOOL	The method is executed with a positive edge at the bExecute input.

SetMuteState

The SetMuteState method can be used to set the muting feature of an OCA object. If the method was executed successfully, the result is output in the property stMuteState.

	Cyclic method call Since several PLC cycles may pass between sending and the response from the device, this method should be executed cyclically.

Syntax

VAR_INPUT
   pLink      : POINTER TO ST_Link;
   bExecute   : BOOL;
   eMuteState : E_OcaMuteState;
   eCmdMode   : E_OcaMessageTypeCmd;
END_VAR

Inputs

Name	Type	Description
pLink	POINTER TO ST_Link	Pointer for establishing a connection between OCA objects and the OCA device
bExecute	BOOL	The method is executed with a positive edge at the bExecute input.
eMuteState	E_OcaMuteState	Muting setting (muted/unmuted) to be assigned to the OCA object.
eCmdMode	OcaMessageTypeCmd	Depending on whether confirmation is required or not, this input variable is set to E_OcaMessageTypeCmd.OcaCmdRrq or E_OcaMessageTypeCmd.OcaCmd.

RNtfMuteState

If the OCA object was prompted to notify changes (using the Subscription method), incoming notifications are read using the RNtfMuteState method.

	Cyclic method call Since several PLC cycles may pass between sending and the response from the device, this method should be executed cyclically.

Syntax

VAR_INPUT
   pLink           : POINTER TO ST_Link;
   bEnable         : BOOL;
   nSubscribtionNo : UDINT;
END_VAR

Inputs

Name	Type	Description
pLink	POINTER TO ST_Link	Pointer for establishing a connection between OCA objects and the OCA device.
bExecute	BOOL	The method is executed with a positive edge at the bExecute input.
nSubscribtionNo	UDINT	Unique number for localizing the respective subscription.