Package com.azure.resourcemanager.mediaservices.models

Class VideoAnalyzerPreset

java.lang.Object
com.azure.resourcemanager.mediaservices.models.Preset
com.azure.resourcemanager.mediaservices.models.AudioAnalyzerPreset
com.azure.resourcemanager.mediaservices.models.VideoAnalyzerPreset
public final class VideoAnalyzerPreset extends AudioAnalyzerPreset
A video analyzer preset that extracts insights (rich metadata) from both audio and video, and outputs a JSON format file.

  • Constructor Details

    • VideoAnalyzerPreset

      public VideoAnalyzerPreset()
      Creates an instance of VideoAnalyzerPreset class.

  • Method Details

    • insightsToExtract

      public InsightsType insightsToExtract()
      Get the insightsToExtract property: Defines the type of insights that you want the service to generate. The allowed values are 'AudioInsightsOnly', 'VideoInsightsOnly', and 'AllInsights'. The default is AllInsights. If you set this to AllInsights and the input is audio only, then only audio insights are generated. Similarly if the input is video only, then only video insights are generated. It is recommended that you not use AudioInsightsOnly if you expect some of your inputs to be video only; or use VideoInsightsOnly if you expect some of your inputs to be audio only. Your Jobs in such conditions would error out.
      Returns:
      the insightsToExtract value.

    • withInsightsToExtract

      public VideoAnalyzerPreset withInsightsToExtract(InsightsType insightsToExtract)
      Set the insightsToExtract property: Defines the type of insights that you want the service to generate. The allowed values are 'AudioInsightsOnly', 'VideoInsightsOnly', and 'AllInsights'. The default is AllInsights. If you set this to AllInsights and the input is audio only, then only audio insights are generated. Similarly if the input is video only, then only video insights are generated. It is recommended that you not use AudioInsightsOnly if you expect some of your inputs to be video only; or use VideoInsightsOnly if you expect some of your inputs to be audio only. Your Jobs in such conditions would error out.
      Parameters:
      insightsToExtract - the insightsToExtract value to set.
      Returns:
      the VideoAnalyzerPreset object itself.

    • withAudioLanguage

      public VideoAnalyzerPreset withAudioLanguage(String audioLanguage)
      Set the audioLanguage property: The language for the audio payload in the input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). If you know the language of your content, it is recommended that you specify it. The language must be specified explicitly for AudioAnalysisMode::Basic, since automatic language detection is not included in basic mode. If the language isn't specified or set to null, automatic language detection will choose the first language detected and process with the selected language for the duration of the file. It does not currently support dynamically switching between languages after the first language is detected. The automatic detection works best with audio recordings with clearly discernable speech. If automatic detection fails to find the language, transcription would fallback to 'en-US'." The list of supported languages is available here: https://go.microsoft.com/fwlink/?linkid=2109463.
      Overrides:
      withAudioLanguage in class AudioAnalyzerPreset
      Parameters:
      audioLanguage - the audioLanguage value to set.
      Returns:
      the AudioAnalyzerPreset object itself.

    • withMode

      public VideoAnalyzerPreset withMode(AudioAnalysisMode mode)
      Set the mode property: Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen.
      Overrides:
      withMode in class AudioAnalyzerPreset
      Parameters:
      mode - the mode value to set.
      Returns:
      the AudioAnalyzerPreset object itself.

    • withExperimentalOptions

      public VideoAnalyzerPreset withExperimentalOptions(Map<String,String> experimentalOptions)
      Set the experimentalOptions property: Dictionary containing key value pairs for parameters not exposed in the preset itself.
      Overrides:
      withExperimentalOptions in class AudioAnalyzerPreset
      Parameters:
      experimentalOptions - the experimentalOptions value to set.
      Returns:
      the AudioAnalyzerPreset object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class AudioAnalyzerPreset
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.