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

Class FileSink

java.lang.Object

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

com.azure.media.videoanalyzer.edge.models.FileSink

public final class FileSink
extends SinkNodeBase

File sink allows for video and audio content to be recorded on the file system on the edge device.

Constructor Summary

Constructors

Constructor	Description
FileSink(String name, List<NodeInput> inputs, String baseDirectoryPath, String fileNamePattern, String maximumSizeMiB)	Creates an instance of FileSink class.

Method Summary

Modifier and Type	Method	Description
String	getBaseDirectoryPath()	Get the baseDirectoryPath property: Absolute directory path where media files will be stored.
String	getFileNamePattern()	Get the fileNamePattern property: File name pattern for creating new files when performing event based recording.
String	getMaximumSizeMiB()	Get the maximumSizeMiB property: Maximum amount of disk space that can be used for storing files from this sink.

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

FileSink

public FileSink(String name,
                List<NodeInput> inputs,
                String baseDirectoryPath,
                String fileNamePattern,
                String maximumSizeMiB)

Creates an instance of FileSink class.

Parameters:

name - the name value to set.

inputs - the inputs value to set.

baseDirectoryPath - the baseDirectoryPath value to set.

fileNamePattern - the fileNamePattern value to set.

maximumSizeMiB - the maximumSizeMiB value to set.

Method Detail

getBaseDirectoryPath

public String getBaseDirectoryPath()

Get the baseDirectoryPath property: Absolute directory path where media files will be stored.

Returns:

the baseDirectoryPath value.

getFileNamePattern

public String getFileNamePattern()

Get the fileNamePattern property: File name pattern for creating new files when performing event based recording. The pattern must include at least one system variable.

Returns:

the fileNamePattern value.

getMaximumSizeMiB

public String getMaximumSizeMiB()

Get the maximumSizeMiB property: Maximum amount of disk space that can be used for storing files from this sink. Once this limit is reached, the oldest files from this sink will be automatically deleted.

Returns:

the maximumSizeMiB value.