Class SoxAudioUtility

Soxi (sound exchange information) Audio utility.

Inheritance

Object

AbstractUtility

AbstractAudioUtility

SoxAudioUtility

Implements

IAudioUtility

Inherited Members

AbstractAudioUtility.ExecutableModify

AbstractAudioUtility.ExecutableInfo

AbstractAudioUtility.TemporaryFilesDirectory

AbstractAudioUtility.Modify(FileInfo, String, FileInfo, String, AudioUtilityRequest)

AbstractAudioUtility.Info(FileInfo)

AbstractUtility.Log

AbstractUtility.MimeTypeExtensionErrorFormatString

AbstractUtility.ProcessRunnerMaxRetries

AbstractUtility.ProcessRunnerTimeout

AbstractUtility.CheckMimeTypeExtension(FileInfo, String)

AbstractUtility.ValidateMimeTypeExtension(FileInfo, String, FileInfo, String)

AbstractUtility.ValidateMimeTypeExtension(FileInfo, String)

AbstractUtility.CanProcess(FileInfo, IEnumerable<String>, IEnumerable<String>)

AbstractUtility.GetExtension(FileInfo)

AbstractUtility.CheckExe(FileInfo, String)

AbstractUtility.BuildFileDebuggingOutput(FileInfo)

AbstractUtility.OutputContains(ProcessRunner, String)

AbstractUtility.RunExe(ProcessRunner, String, String)

AbstractUtility.CheckFile(FileInfo)

AbstractUtility.CheckMp3BitRate(Int32)

AbstractUtility.CheckMp3SampleRate(Int32)

AbstractUtility.CheckRequestValidForMediaType(FileInfo, String, AudioUtilityRequest)

AbstractUtility.ParseIntStringWithException(String, String, IEnumerable<String>)

AbstractUtility.ParseLongStringWithException(String, String, IEnumerable<String>)

AbstractUtility.ParseDoubleStringWithException(String, String, IEnumerable<String>)

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Acoustics.Tools.Audio

Assembly: Acoustics.Tools.dll

Syntax

public class SoxAudioUtility : AbstractAudioUtility, IAudioUtility

Constructors

SoxAudioUtility(FileInfo)

Initializes a new instance of the SoxAudioUtility class.

Declaration

public SoxAudioUtility(FileInfo soxExe)

Parameters

Type	Name	Description
FileInfo	soxExe	The exe file.

Exceptions

Type	Condition
FileNotFoundException	Could not find exe.
ArgumentNullException	soxExe is null.

SoxAudioUtility(FileInfo, DirectoryInfo, Boolean)

Initializes a new instance of the SoxAudioUtility class.

Declaration

public SoxAudioUtility(FileInfo soxExe, DirectoryInfo temporaryFilesDirectory, bool enableShortNameHack = true)

Parameters

Type	Name	Description
FileInfo	soxExe	The exe file.
DirectoryInfo	temporaryFilesDirectory	Which directory should hold temporary files.
Boolean	enableShortNameHack	Whether or not filenames with unicode characters should be shortened to 8.3 filenames on Windows.

Exceptions

Type	Condition
FileNotFoundException	Could not find exe.
ArgumentNullException	soxExe is null.

Fields

Mp3NotSupportedOnOSX

Declaration

public const string Mp3NotSupportedOnOSX = "Working with MP3 in SoX is not supported on OSX."

Field Value

Type	Description
String

Properties

InvalidOutputMediaTypes

Gets the invalid output media types.

Declaration

protected override IEnumerable<string> InvalidOutputMediaTypes { get; }

Property Value

Type	Description
IEnumerable<String>

Overrides

AbstractAudioUtility.InvalidOutputMediaTypes

InvalidSourceMediaTypes

Gets the invalid source media types.

Declaration

protected override IEnumerable<string> InvalidSourceMediaTypes { get; }

Property Value

Type	Description
IEnumerable<String>

Overrides

AbstractAudioUtility.InvalidSourceMediaTypes

ResampleQuality

Gets ResampleQuality.

Declaration

public SoxAudioUtility.SoxResampleQuality? ResampleQuality { get; }

Property Value

Type	Description
Nullable<SoxAudioUtility.SoxResampleQuality>

SupportsMp3

Declaration

public bool SupportsMp3 { get; }

Property Value

Type	Description
Boolean

ValidOutputMediaTypes

Gets the valid output media types.

Declaration

protected override IEnumerable<string> ValidOutputMediaTypes { get; }

Property Value

Type	Description
IEnumerable<String>

Overrides

AbstractAudioUtility.ValidOutputMediaTypes

ValidSourceMediaTypes

Gets the valid source media types.

Declaration

protected override IEnumerable<string> ValidSourceMediaTypes { get; }

Property Value

Type	Description
IEnumerable<String>

Overrides

AbstractAudioUtility.ValidSourceMediaTypes

Methods

CheckRequestValid(FileInfo, String, FileInfo, String, AudioUtilityRequest)

Declaration

protected override void CheckRequestValid(FileInfo source, string sourceMimeType, FileInfo output, string outputMediaType, AudioUtilityRequest request)

Parameters

Type	Name	Description
FileInfo	source
String	sourceMimeType
FileInfo	output
String	outputMediaType
AudioUtilityRequest	request

Overrides

AbstractAudioUtility.CheckRequestValid(FileInfo, String, FileInfo, String, AudioUtilityRequest)

ConstructInfoArgs(FileInfo)

The construct info args.

Declaration

protected override string ConstructInfoArgs(FileInfo source)

Parameters

Type	Name	Description
FileInfo	source	The source.

Returns

Type	Description
String	The System.String.

Overrides

AbstractAudioUtility.ConstructInfoArgs(FileInfo)

ConstructModifyArgs(FileInfo, FileInfo, AudioUtilityRequest)

The construct modify args.

Declaration

protected override string ConstructModifyArgs(FileInfo source, FileInfo output, AudioUtilityRequest request)

Parameters

Type	Name	Description
FileInfo	source	The source.
FileInfo	output	The output.
AudioUtilityRequest	request	The request.

Returns

Type	Description
String	The System.String.

Overrides

AbstractAudioUtility.ConstructModifyArgs(FileInfo, FileInfo, AudioUtilityRequest)

GetInfo(FileInfo, ProcessRunner)

The get info.

Declaration

protected override AudioUtilityInfo GetInfo(FileInfo source, ProcessRunner process)

Parameters

Type	Name	Description
FileInfo	source	The source.
ProcessRunner	process	The process.

Returns

Type	Description
AudioUtilityInfo	The Acoustics.Tools.AudioUtilityInfo.

Overrides

AbstractAudioUtility.GetInfo(FileInfo, ProcessRunner)

Implements

IAudioUtility

Extension Methods

ObjectExtensions.NotNull(Object)

ObjectExtensions.AsArray<T>(T)

ObjectExtensions.AsList<T>(T)

ObjectExtensions.Wrap<T>(T)

SystemExtensions.BinarySerialize(Object)

ConfigFileExtensions.NotNull(Object, FileInfo, String, String)

ConfigFileExtensions.ValidateNotNull(Object, String, String)

ConfigFileExtensions.ValidateLessThan<T>(Object, Nullable<T>, String, Nullable<T>, String, String)

ExtensionsXml.SerializeObject<T>(T)