BackgroundAudioTrack Class

Reference

Definition

Namespace:: Windows.Media.Editing

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents a single audio track for accompanying a video clip.

public ref class BackgroundAudioTrack sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.GCPressure]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class BackgroundAudioTrack final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.GCPressure]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class BackgroundAudioTrack

Public NotInheritable Class BackgroundAudioTrack

Inheritance: Object Platform::Object IInspectable BackgroundAudioTrack

Attributes: ContractVersionAttribute GCPressureAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

Add background audio tracks to a composition by adding them to a MediaComposition object's BackgroundAudioTracks collection.

For how-to guidance on adding media editing to your app, see Media compositions and editing.

Properties

AudioEffectDefinitions	Gets the list of audio effect definitions for processing the background audio track.
Delay	Specifies how long to wait before starting background audio playback.
OriginalDuration	Original playback time of the background audio track, without the effects of the TrimTimeFromStart and TrimTimeFromEnd properties.
TrimmedDuration	Duration of the background audio track with TrimTimeFromStart and TrimTimeFromEnd applied to playback.
TrimTimeFromEnd	The amount of time to trim from the end of the background audio track.
TrimTimeFromStart	The amount of time to trim from the beginning of the background audio track.
UserData	An associative collection for storing custom properties associated with the background audio track.
Volume	Gets or sets the volume of the background audio track.

Methods

Clone()	Creates a BackgroundAudioTrack object that is identical to this instance.
CreateFromEmbeddedAudioTrack(EmbeddedAudioTrack)	Creates a background audio track object with audio content copied from an embedded audio track object.
CreateFromFileAsync(IStorageFile)	Creates a background audio track from an audio file.
GetAudioEncodingProperties()	Gets the AudioEncodingProperties for the background audio track.

Applies to