Sends a custom MIP message and optionally awaits the response.
Messaging is a core feature and component of the MIP SDK. Almost all actions and queries are handled through messaging. This cmdlet provides a mechanism for interacting with the messaging framework from PowerShell which gives you a fairly low-level interface into the VMS. As such, it can be complex to use and you should consult the MIP SDK documentation to better understand the available messages and how to use them.
- Requires VMS connection and will attempt to connect automatically
Activates a PTZ preset using the Control.TriggerCommand message. The DestinationEndpoint should be the FQID of a PtzPreset object. To get a list of PtzPreset items for a camera, you could do $presets = $camera.PtzPresetFolder.PtzPresets | Get-VmsVideoOSItem -Kind Preset
Some MessageIds such as those related to PTZ are accompanied by some kind of object. Reference the MIP SDK documentation for more information about expected objects.
Defines the FQID of the destination client or server endpoint for this message.
Defines the FQID of an object on the DestinationEndpoint to receive this message.
MessageId string to send.
Specifies the reason the message is being sent. Not commonly used.
Defines the FQID of the device or item related to the provided MessageId.
Defines the MessageId to listen for as a response to this message. Optional.
Defines the FQID of the sender (or null if the recipients don't care)
Time, in seconds, to wait for a response. If ResponseMessageId is null or whitespace, then a response is not expected and this cmdlet will return immediately after sending the message. Default is 10 seconds.
Specifies that the message should be sent using EnvironmentManager.Instance instead of MessageCommunicationManager. Some MIP SDK messages are only delivered correctly when sent using the EnvironmentManager.
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.