com.pulumi.azurenative.media.inputs.VideoAnalyzerPresetArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azurenative.media.inputs;
import com.pulumi.azurenative.media.enums.AudioAnalysisMode;
import com.pulumi.azurenative.media.enums.InsightsType;
import com.pulumi.core.Either;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.core.internal.Codegen;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* A video analyzer preset that extracts insights (rich metadata) from both audio and video, and outputs a JSON format file.
*
*/
public final class VideoAnalyzerPresetArgs extends com.pulumi.resources.ResourceArgs {
public static final VideoAnalyzerPresetArgs Empty = new VideoAnalyzerPresetArgs();
/**
* 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
*
*/
@Import(name="audioLanguage")
private @Nullable Output audioLanguage;
/**
* @return 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
*
*/
public Optional> audioLanguage() {
return Optional.ofNullable(this.audioLanguage);
}
/**
* Dictionary containing key value pairs for parameters not exposed in the preset itself
*
*/
@Import(name="experimentalOptions")
private @Nullable Output> experimentalOptions;
/**
* @return Dictionary containing key value pairs for parameters not exposed in the preset itself
*
*/
public Optional>> experimentalOptions() {
return Optional.ofNullable(this.experimentalOptions);
}
/**
* 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.
*
*/
@Import(name="insightsToExtract")
private @Nullable Output> insightsToExtract;
/**
* @return 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.
*
*/
public Optional>> insightsToExtract() {
return Optional.ofNullable(this.insightsToExtract);
}
/**
* Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen.
*
*/
@Import(name="mode")
private @Nullable Output> mode;
/**
* @return Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen.
*
*/
public Optional>> mode() {
return Optional.ofNullable(this.mode);
}
/**
* The discriminator for derived types.
* Expected value is '#Microsoft.Media.VideoAnalyzerPreset'.
*
*/
@Import(name="odataType", required=true)
private Output odataType;
/**
* @return The discriminator for derived types.
* Expected value is '#Microsoft.Media.VideoAnalyzerPreset'.
*
*/
public Output odataType() {
return this.odataType;
}
private VideoAnalyzerPresetArgs() {}
private VideoAnalyzerPresetArgs(VideoAnalyzerPresetArgs $) {
this.audioLanguage = $.audioLanguage;
this.experimentalOptions = $.experimentalOptions;
this.insightsToExtract = $.insightsToExtract;
this.mode = $.mode;
this.odataType = $.odataType;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(VideoAnalyzerPresetArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private VideoAnalyzerPresetArgs $;
public Builder() {
$ = new VideoAnalyzerPresetArgs();
}
public Builder(VideoAnalyzerPresetArgs defaults) {
$ = new VideoAnalyzerPresetArgs(Objects.requireNonNull(defaults));
}
/**
* @param audioLanguage 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
*
* @return builder
*
*/
public Builder audioLanguage(@Nullable Output audioLanguage) {
$.audioLanguage = audioLanguage;
return this;
}
/**
* @param audioLanguage 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
*
* @return builder
*
*/
public Builder audioLanguage(String audioLanguage) {
return audioLanguage(Output.of(audioLanguage));
}
/**
* @param experimentalOptions Dictionary containing key value pairs for parameters not exposed in the preset itself
*
* @return builder
*
*/
public Builder experimentalOptions(@Nullable Output> experimentalOptions) {
$.experimentalOptions = experimentalOptions;
return this;
}
/**
* @param experimentalOptions Dictionary containing key value pairs for parameters not exposed in the preset itself
*
* @return builder
*
*/
public Builder experimentalOptions(Map experimentalOptions) {
return experimentalOptions(Output.of(experimentalOptions));
}
/**
* @param insightsToExtract 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.
*
* @return builder
*
*/
public Builder insightsToExtract(@Nullable Output> insightsToExtract) {
$.insightsToExtract = insightsToExtract;
return this;
}
/**
* @param insightsToExtract 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.
*
* @return builder
*
*/
public Builder insightsToExtract(Either insightsToExtract) {
return insightsToExtract(Output.of(insightsToExtract));
}
/**
* @param insightsToExtract 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.
*
* @return builder
*
*/
public Builder insightsToExtract(String insightsToExtract) {
return insightsToExtract(Either.ofLeft(insightsToExtract));
}
/**
* @param insightsToExtract 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.
*
* @return builder
*
*/
public Builder insightsToExtract(InsightsType insightsToExtract) {
return insightsToExtract(Either.ofRight(insightsToExtract));
}
/**
* @param mode Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen.
*
* @return builder
*
*/
public Builder mode(@Nullable Output> mode) {
$.mode = mode;
return this;
}
/**
* @param mode Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen.
*
* @return builder
*
*/
public Builder mode(Either mode) {
return mode(Output.of(mode));
}
/**
* @param mode Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen.
*
* @return builder
*
*/
public Builder mode(String mode) {
return mode(Either.ofLeft(mode));
}
/**
* @param mode Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen.
*
* @return builder
*
*/
public Builder mode(AudioAnalysisMode mode) {
return mode(Either.ofRight(mode));
}
/**
* @param odataType The discriminator for derived types.
* Expected value is '#Microsoft.Media.VideoAnalyzerPreset'.
*
* @return builder
*
*/
public Builder odataType(Output odataType) {
$.odataType = odataType;
return this;
}
/**
* @param odataType The discriminator for derived types.
* Expected value is '#Microsoft.Media.VideoAnalyzerPreset'.
*
* @return builder
*
*/
public Builder odataType(String odataType) {
return odataType(Output.of(odataType));
}
public VideoAnalyzerPresetArgs build() {
$.odataType = Codegen.stringProp("odataType").output().arg($.odataType).require();
return $;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy