Skip to content

Send-UserDefinedEvent

SYNOPSIS

SYNTAX

FromObject

Send-UserDefinedEvent [-UserDefinedEvent] <UserDefinedEvent> [[-Cameras] <Camera[]>]
 [[-Microphones] <Microphone[]>] [[-Speakers] <Speaker[]>] [[-Metadatas] <Metadata[]>]
 [[-Inputs] <InputEvent[]>] [[-Outputs] <Output[]>] [<CommonParameters>]

FromId

Send-UserDefinedEvent [-Id] <String> [[-Cameras] <Camera[]>] [[-Microphones] <Microphone[]>]
 [[-Speakers] <Speaker[]>] [[-Metadatas] <Metadata[]>] [[-Inputs] <InputEvent[]>] [[-Outputs] <Output[]>]
 [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

REQUIREMENTS

  • Requires VMS connection and will attempt to connect automatically

EXAMPLES

Example 1

{{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-Cameras

{{ Fill Cameras Description }}

Type: Camera[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

{{ Fill Id Description }}

Type: String
Parameter Sets: FromId
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Inputs

{{ Fill Inputs Description }}

Type: InputEvent[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Metadatas

{{ Fill Metadatas Description }}

Type: Metadata[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Microphones

{{ Fill Microphones Description }}

Type: Microphone[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Outputs

{{ Fill Outputs Description }}

Type: Output[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Speakers

{{ Fill Speakers Description }}

Type: Speaker[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UserDefinedEvent

{{ Fill UserDefinedEvent Description }}

Type: UserDefinedEvent
Parameter Sets: FromObject
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
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.

INPUTS

VideoOS.Platform.ConfigurationItems.UserDefinedEvent

VideoOS.Platform.ConfigurationItems.UserDefinedEvent

OUTPUTS

NOTES