Class VideoSink
- java.lang.Object
-
- com.azure.resourcemanager.videoanalyzer.models.NodeBase
-
- com.azure.resourcemanager.videoanalyzer.models.SinkNodeBase
-
- com.azure.resourcemanager.videoanalyzer.models.VideoSink
-
public final class VideoSink extends SinkNodeBase
Video sink in a live topology allows for video and audio to be captured, optionally archived, and published via a video resource. If archiving is enabled, this results in a video of type 'archive'. If used in a batch topology, this allows for video and audio to be stored as a file, and published via a video resource of type 'file'.
-
-
Constructor Summary
Constructors Constructor Description VideoSink()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
validate()
Validates the instance.VideoCreationProperties
videoCreationProperties()
Get the videoCreationProperties property: Optional video properties to be used in case a new video resource needs to be created on the service.String
videoName()
Get the videoName property: Name of a new or existing video resource used to capture and publish content.VideoPublishingOptions
videoPublishingOptions()
Get the videoPublishingOptions property: Options to change how the video sink publishes content via the video resource.VideoSink
withInputs(List<NodeInput> inputs)
Set the inputs property: An array of upstream node references within the topology to be used as inputs for this node.VideoSink
withName(String name)
Set the name property: Node name.VideoSink
withVideoCreationProperties(VideoCreationProperties videoCreationProperties)
Set the videoCreationProperties property: Optional video properties to be used in case a new video resource needs to be created on the service.VideoSink
withVideoName(String videoName)
Set the videoName property: Name of a new or existing video resource used to capture and publish content.VideoSink
withVideoPublishingOptions(VideoPublishingOptions videoPublishingOptions)
Set the videoPublishingOptions property: Options to change how the video sink publishes content via the video resource.-
Methods inherited from class com.azure.resourcemanager.videoanalyzer.models.SinkNodeBase
inputs
-
-
-
-
Method Detail
-
videoName
public String videoName()
Get the videoName property: Name of a new or existing video resource used to capture and publish content. Note: if downstream of RTSP source, and if disableArchive is set to true, then no content is archived.- Returns:
- the videoName value.
-
withVideoName
public VideoSink withVideoName(String videoName)
Set the videoName property: Name of a new or existing video resource used to capture and publish content. Note: if downstream of RTSP source, and if disableArchive is set to true, then no content is archived.- Parameters:
videoName
- the videoName value to set.- Returns:
- the VideoSink object itself.
-
videoCreationProperties
public VideoCreationProperties videoCreationProperties()
Get the videoCreationProperties property: Optional video properties to be used in case a new video resource needs to be created on the service.- Returns:
- the videoCreationProperties value.
-
withVideoCreationProperties
public VideoSink withVideoCreationProperties(VideoCreationProperties videoCreationProperties)
Set the videoCreationProperties property: Optional video properties to be used in case a new video resource needs to be created on the service.- Parameters:
videoCreationProperties
- the videoCreationProperties value to set.- Returns:
- the VideoSink object itself.
-
videoPublishingOptions
public VideoPublishingOptions videoPublishingOptions()
Get the videoPublishingOptions property: Options to change how the video sink publishes content via the video resource. This property is only allowed for topologies where "kind" is set to "live".- Returns:
- the videoPublishingOptions value.
-
withVideoPublishingOptions
public VideoSink withVideoPublishingOptions(VideoPublishingOptions videoPublishingOptions)
Set the videoPublishingOptions property: Options to change how the video sink publishes content via the video resource. This property is only allowed for topologies where "kind" is set to "live".- Parameters:
videoPublishingOptions
- the videoPublishingOptions value to set.- Returns:
- the VideoSink object itself.
-
withInputs
public VideoSink withInputs(List<NodeInput> inputs)
Set the inputs property: An array of upstream node references within the topology to be used as inputs for this node.- Overrides:
withInputs
in classSinkNodeBase
- Parameters:
inputs
- the inputs value to set.- Returns:
- the SinkNodeBase object itself.
-
withName
public VideoSink withName(String name)
Set the name property: Node name. Must be unique within the topology.- Overrides:
withName
in classSinkNodeBase
- Parameters:
name
- the name value to set.- Returns:
- the NodeBase object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classSinkNodeBase
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-