Class AudioProfile

Namespace

Microsoft.Xna.Framework.Content.Pipeline.Audio

Assembly

MonoGame.Framework.Content.Pipeline.dll

Provides a base class for handling audio profiles.

public abstract class AudioProfile

Inheritance

object

AudioProfile

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

ConvertAudio(TargetPlatform, ConversionQuality, AudioContent)

Converts the audio content to work on targeted platform.

public abstract ConversionQuality ConvertAudio(TargetPlatform platform, ConversionQuality quality, AudioContent content)

Parameters

platform TargetPlatform

The platform to build the audio content for.

quality ConversionQuality

The suggested audio quality level.

content AudioContent

The audio content to convert.

Returns

ConversionQuality

The quality used for conversion which could be different from the suggested quality.

ConvertStreamingAudio(TargetPlatform, ConversionQuality, AudioContent, ref string)

Converts the audio content to a streaming format that works on targeted platform.

public abstract ConversionQuality ConvertStreamingAudio(TargetPlatform platform, ConversionQuality quality, AudioContent content, ref string outputFileName)

Parameters

platform TargetPlatform

The platform to build the audio content for.

quality ConversionQuality

The suggested audio quality level.

content AudioContent

he audio content to convert.

outputFileName string

Returns

ConversionQuality

The quality used for conversion which could be different from the suggested quality.

ForPlatform(TargetPlatform)

Find the profile for this target platform.

public static AudioProfile ForPlatform(TargetPlatform platform)

Parameters

platform TargetPlatform

The platform target for audio.

Returns

AudioProfile

QualityToBitRate(ConversionQuality)

protected static int QualityToBitRate(ConversionQuality quality)

Parameters

quality ConversionQuality

Returns

int

QualityToSampleRate(ConversionQuality, int)

Calculates the sample rate based on the conversion quality and the source sample rate.

protected static int QualityToSampleRate(ConversionQuality quality, int sourceSampleRate)

Parameters

quality ConversionQuality

The target ConversionQuality

sourceSampleRate int

The source sample rate.

Returns

int

The calculated sample rate.

Supports(TargetPlatform)

Returns true if this profile supports audio processing for this platform.

public abstract bool Supports(TargetPlatform platform)

Parameters

platform TargetPlatform

Returns

bool