Class AudioCutter.Arguments

Inheritance
Object
SubCommandBase
AudioCutter.Arguments
Inherited Members
Namespace: AnalysisPrograms
Assembly: AnalysisPrograms.dll
Syntax
[Command("AudioCutter", Description = "[BETA] Cuts audio into segments of desired length and format")]
public class Arguments : SubCommandBase

Properties

| Improve this Doc View Source

EndOffset

Declaration
[Option(Description = "The offset to stop creating segmented audio files (in seconds, defaults to end of original file).")]
[InRange(0, 1.7976931348623157E+308)]
public double? EndOffset { get; set; }
Property Value
Type Description
Nullable<Double>
| Improve this Doc View Source

InputFile

Declaration
[Argument(0, Description = "The audio file to segment.")]
[Required]
[FileExists]
[LegalFilePath]
public string InputFile { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

MixDownToMono

Declaration
[Option(CommandOptionType.SingleValue, Description = "Whether to mix all channels down to mono (defaults to true).")]
public bool MixDownToMono { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

OutputDir

Declaration
[Argument(1, Description = "The directory to create segmented audio files.")]
[DirectoryExistsOrCreate(true, true)]
[Required]
[LegalFilePath]
public string OutputDir { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

Parallel

Declaration
[Option(CommandOptionType.SingleValue, Description = "Whether to create segments in parallel or sequentially (defaults to true - parallel).", ShortName = "p")]
public bool Parallel { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

SampleRate

Declaration
[Option(Description = "The sample rate for segmented audio files (in hertz, defaults to 22050; valid values are 8000, 17640, 22050, 44100, 48000, 96000).", ShortName = "r")]
[InRange(8000, 96000)]
public int SampleRate { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

SegmentDuration

Declaration
[Option(Description = "The duration of a segmented audio file (in seconds, defaults to 60; must be within [1, 43200]).", ShortName = "d")]
[InRange(1, 43200)]
public double SegmentDuration { get; set; }
Property Value
Type Description
Double
| Improve this Doc View Source

SegmentDurationMinimum

Declaration
[Option(Description = "The minimum duration of a segmented audio file (in seconds, defaults to 5; must be within [1, 3600]).", ShortName = "")]
[InRange(1, 3600)]
public double SegmentDurationMinimum { get; set; }
Property Value
Type Description
Double
| Improve this Doc View Source

SegmentFileExtension

Declaration
[Option(Description = "The file type (file extension) of segmented audio files (defaults to wav; some possible values are wav, mp3, ogg, webm).", ShortName = "")]
[OneOfThese(new string[]{"wav", "mp3", "ogg", "webm"})]
public string SegmentFileExtension { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

SegmentOverlap

Declaration
[Option(Description = "The duration of overlap between segmented audio files (in seconds, defaults to 0; must be within [0, 43200]).", ShortName = "")]
[InRange(0, 43200)]
public double SegmentOverlap { get; set; }
Property Value
Type Description
Double
| Improve this Doc View Source

StartOffset

Declaration
[Option(Description = "The offset to start creating segmented audio files (in seconds, defaults to start of original file).")]
[InRange(0, 1.7976931348623157E+308)]
public double StartOffset { get; set; }
Property Value
Type Description
Double
| Improve this Doc View Source

TemporaryFilesDir

Declaration
[Option(Description = "The directory for temporary files.", ShortName = "t")]
[DirectoryExistsOrCreate(true, true)]
[LegalFilePath]
public string TemporaryFilesDir { get; set; }
Property Value
Type Description
String

Methods

| Improve this Doc View Source

Execute(CommandLineApplication)

Declaration
public override Task<int> Execute(CommandLineApplication app)
Parameters
Type Name Description
McMaster.Extensions.CommandLineUtils.CommandLineApplication app
Returns
Type Description
Task<Int32>
Overrides
| Improve this Doc View Source

OnValidate(ValidationContext, CommandLineContext)

Declaration
protected override ValidationResult OnValidate(ValidationContext context, CommandLineContext appContext)
Parameters
Type Name Description
ValidationContext context
McMaster.Extensions.CommandLineUtils.Abstractions.CommandLineContext appContext
Returns
Type Description
ValidationResult
Overrides

Extension Methods