Send-MipMessage¶
SYNOPSIS¶
Envía un mensaje MIP personalizado y, opcionalmente, espera la respuesta.
SYNTAX¶
Send-MipMessage [-MessageId] <String> [[-RelatedFqid] <FQID>] [[-Data] <Object>] [[-Reason] <String>]
[[-DestinationEndpoint] <FQID>] [[-DestinationObject] <FQID>] [[-Source] <FQID>]
[[-ResponseMessageId] <String>] [[-Timeout] <Double>] [-UseEnvironmentManager] [<CommonParameters>]
DESCRIPTION¶
La mensajería es una característica central y un componente de MIP SDK. Casi todas las acciones y consultas se manejan a través de la mensajería. Este cmdlet proporciona un mecanismo para interactuar con el marco de mensajería de PowerShell que le brinda una interfaz de nivel bastante bajo en el VMS. Como tal, puede ser complejo de usar y debe consultar la documentación de MIP SDK para comprender mejor los mensajes disponibles y cómo utilizarlos.
REQUIREMENTS
- Requires VMS connection and will attempt to connect automatically
EXAMPLES¶
EXAMPLE 1¶
Send-MipMessage -MessageId Control.TriggerCommand -DestinationEndpoint $presets[0].FQID -UseEnvironmentManager
Activa un ajuste preestablecido de PTZ mediante el mensaje Control.TriggerCommand. El DestinationEndpoint debe ser el FQID de un objeto PtzPreset. Para obtener una lista de elementos PtzPreset para una cámara, puede hacer $ presets = $ camera.PtzPresetFolder.PtzPresets | Get-PlatformItem
PARAMETERS¶
-Data¶
Algunos MessageIds como los relacionados con PTZ van acompañados de algún tipo de objeto. Consulte la documentación del SDK de MIP para obtener más información sobre los objetos esperados.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DestinationEndpoint¶
Define el FQID del cliente de destino o el extremo del servidor para este mensaje.
Type: FQID
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DestinationObject¶
Define el FQID de un objeto en el DestinationEndpoint para recibir este mensaje.
Type: FQID
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MessageId¶
MessageId cadena para enviar.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Reason¶
Especifica el motivo por el que se envía el mensaje. No se usa comúnmente.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RelatedFqid¶
Define el FQID del dispositivo o elemento relacionado con el MessageId proporcionado.
Type: FQID
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ResponseMessageId¶
Define el MessageId que se escuchará como respuesta a este mensaje. Opcional.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Source¶
Define el FQID del remitente (o nulo si a los destinatarios no les importa)
Type: FQID
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Timeout¶
Tiempo, en segundos, para esperar una respuesta. Si ResponseMessageId es nulo o un espacio en blanco, no se espera una respuesta y este cmdlet volverá inmediatamente después de enviar el mensaje. El valor predeterminado es 10 segundos.
Type: Double
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 10
Accept pipeline input: False
Accept wildcard characters: False
-UseEnvironmentManager¶
Especifica que el mensaje debe enviarse mediante EnvironmentManager.Instance en lugar de MessageCommunicationManager. Algunos mensajes MIP SDK solo se entregan correctamente cuando se envían mediante EnvironmentManager.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.