Format Class

Reference

Package:: com.azure.resourcemanager.mediaservices.models

Maven Artifact:: com.azure.resourcemanager:azure-resourcemanager-mediaservices:2.3.0

java.lang.Object
- com.azure.resourcemanager.mediaservices.models.Format

public class Format

Base class for output.

Constructor Summary

Constructor	Description
Format()	Creates an instance of Format class.

Method Summary

Modifier and Type	Method and Description
String	filenamePattern() Get the filenamePattern property: The file naming pattern used for the creation of output files.
void	validate() Validates the instance.
Format	withFilenamePattern(String filenamePattern) Set the filenamePattern property: The file naming pattern used for the creation of output files.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

Format

public Format()

Creates an instance of Format class.

Method Details

filenamePattern

public String filenamePattern()

Get the filenamePattern property: The file naming pattern used for the creation of output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {AudioStream} - string "Audio" plus audio stream number(start from 1). {Bitrate} - The audio/video bitrate in kbps. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename.

Returns:

the filenamePattern value.

validate

public void validate()

Validates the instance.

withFilenamePattern

public Format withFilenamePattern(String filenamePattern)

Set the filenamePattern property: The file naming pattern used for the creation of output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {AudioStream} - string "Audio" plus audio stream number(start from 1). {Bitrate} - The audio/video bitrate in kbps. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename.

Parameters:

filenamePattern - the filenamePattern value to set.