Package com.azure.media.videoanalyzer.edge.models

Class VideoSink

java.lang.Object

com.azure.media.videoanalyzer.edge.models.SinkNodeBase

com.azure.media.videoanalyzer.edge.models.VideoSink

public final class VideoSink
extends SinkNodeBase

Video sink allows for video and audio to be recorded to the Video Analyzer service. The recorded video can be played from anywhere and further managed from the cloud. Due to security reasons, a given Video Analyzer edge module instance can only record content to new video entries, or existing video entries previously recorded by the same module. Any attempt to record content to an existing video which has not been created by the same module instance will result in failure to record.

Constructor Summary

Constructors

Constructor	Description
VideoSink(String name, List<NodeInput> inputs, String videoName, String localMediaCachePath, String localMediaCacheMaximumSizeMiB)	Creates an instance of VideoSink class.

Method Summary

Modifier and Type	Method	Description
String	getLocalMediaCacheMaximumSizeMiB()	Get the localMediaCacheMaximumSizeMiB property: Maximum amount of disk space that can be used for caching of temporary media files.
String	getLocalMediaCachePath()	Get the localMediaCachePath property: Path to a local file system directory for caching of temporary media files.
VideoCreationProperties	getVideoCreationProperties()	Get the videoCreationProperties property: Optional video properties to be used in case a new video resource needs to be created on the service.
String	getVideoName()	Get the videoName property: Name of a new or existing Video Analyzer video resource used for the media recording.
VideoPublishingOptions	getVideoPublishingOptions()	Get the videoPublishingOptions property: Optional video publishing options to be used for changing publishing behavior of the output video.
VideoSink	setVideoCreationProperties(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	setVideoPublishingOptions(VideoPublishingOptions videoPublishingOptions)	Set the videoPublishingOptions property: Optional video publishing options to be used for changing publishing behavior of the output video.

Methods inherited from class com.azure.media.videoanalyzer.edge.models.SinkNodeBase

getInputs, getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VideoSink

public VideoSink(String name,
                 List<NodeInput> inputs,
                 String videoName,
                 String localMediaCachePath,
                 String localMediaCacheMaximumSizeMiB)

Creates an instance of VideoSink class.

Parameters:

name - the name value to set.

inputs - the inputs value to set.

videoName - the videoName value to set.

localMediaCachePath - the localMediaCachePath value to set.

localMediaCacheMaximumSizeMiB - the localMediaCacheMaximumSizeMiB value to set.

Method Detail

getVideoName

public String getVideoName()

Get the videoName property: Name of a new or existing Video Analyzer video resource used for the media recording.

Returns:

the videoName value.

getVideoCreationProperties

public VideoCreationProperties getVideoCreationProperties()

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.

setVideoCreationProperties

public VideoSink setVideoCreationProperties(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.

getVideoPublishingOptions

public VideoPublishingOptions getVideoPublishingOptions()

Get the videoPublishingOptions property: Optional video publishing options to be used for changing publishing behavior of the output video.

Returns:

the videoPublishingOptions value.

setVideoPublishingOptions

public VideoSink setVideoPublishingOptions(VideoPublishingOptions videoPublishingOptions)

Set the videoPublishingOptions property: Optional video publishing options to be used for changing publishing behavior of the output video.

Parameters:

videoPublishingOptions - the videoPublishingOptions value to set.

Returns:

the VideoSink object itself.

getLocalMediaCachePath

public String getLocalMediaCachePath()

Get the localMediaCachePath property: Path to a local file system directory for caching of temporary media files. This will also be used to store content which cannot be immediately uploaded to Azure due to Internet connectivity issues.

Returns:

the localMediaCachePath value.

getLocalMediaCacheMaximumSizeMiB

public String getLocalMediaCacheMaximumSizeMiB()

Get the localMediaCacheMaximumSizeMiB property: Maximum amount of disk space that can be used for caching of temporary media files. Once this limit is reached, the oldest segments of the media archive will be continuously deleted in order to make space for new media, thus leading to gaps in the cloud recorded content.

Returns:

the localMediaCacheMaximumSizeMiB value.