AudioNodeEmitter AudioNodeEmitter AudioNodeEmitter AudioNodeEmitter Class

Definition

Describes the position and other physical characteristics of an emitter from which the audio of an AudioGraph node is emitted when spatial audio processing is used.

public : sealed class AudioNodeEmitter : IAudioNodeEmitter, IAudioNodeEmitter2public sealed class AudioNodeEmitter : IAudioNodeEmitter, IAudioNodeEmitter2Public NotInheritable Class AudioNodeEmitter Implements IAudioNodeEmitter, IAudioNodeEmitter2// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Constructors

AudioNodeEmitter() AudioNodeEmitter() AudioNodeEmitter() AudioNodeEmitter()

Initializes a new instance of the AudioNodeEmitter class.

public : AudioNodeEmitter()public AudioNodeEmitter()Public Sub New()// You can use this method in JavaScript.

Remarks

If the constructor with no parameters is used, the default emitter shape is omnidirectional, the default decay model is natural, and doppler processing is enabled.

See Also

AudioNodeEmitter(AudioNodeEmitterShape, AudioNodeEmitterDecayModel, AudioNodeEmitterSettings) AudioNodeEmitter(AudioNodeEmitterShape, AudioNodeEmitterDecayModel, AudioNodeEmitterSettings) AudioNodeEmitter(AudioNodeEmitterShape, AudioNodeEmitterDecayModel, AudioNodeEmitterSettings) AudioNodeEmitter(AudioNodeEmitterShape, AudioNodeEmitterDecayModel, AudioNodeEmitterSettings)

Initializes a new instance of the AudioNodeEmitter class with the specified emitter characteristics.

public : AudioNodeEmitter(AudioNodeEmitterShape shape, AudioNodeEmitterDecayModel decayModel, AudioNodeEmitterSettings settings)public AudioNodeEmitter(AudioNodeEmitterShape shape, AudioNodeEmitterDecayModel decayModel, AudioNodeEmitterSettings settings)Public Sub New(shape As AudioNodeEmitterShape, decayModel As AudioNodeEmitterDecayModel, settings As AudioNodeEmitterSettings)// You can use this method in JavaScript.
Parameters
shape
AudioNodeEmitterShape AudioNodeEmitterShape AudioNodeEmitterShape AudioNodeEmitterShape

An object describing the shape in which audio is emitted.

decayModel
AudioNodeEmitterDecayModel AudioNodeEmitterDecayModel AudioNodeEmitterDecayModel AudioNodeEmitterDecayModel

An object describing the decay model for emitted audio.

settings
AudioNodeEmitterSettings AudioNodeEmitterSettings AudioNodeEmitterSettings AudioNodeEmitterSettings

Flags specifying additional settings for the emitter.

Properties

DecayModel DecayModel DecayModel DecayModel

Gets an object describing the decay model for the AudioNodeEmitter.

public : AudioNodeEmitterDecayModel DecayModel { get; }public AudioNodeEmitterDecayModel DecayModel { get; }Public ReadOnly Property DecayModel As AudioNodeEmitterDecayModel// You can use this property in JavaScript.

Remarks

Create an AudioNodeEmitter with a decay model by using the overload of the AudioNodeEmitter constructor.

Direction Direction Direction Direction

A vector expressing the direction in which audio is emitted from the AudioNodeEmitter.

public : Vector3 Direction { get; set; }public Vector3 Direction { get; set; }Public ReadWrite Property Direction As Vector3// You can use this property in JavaScript.
Value
Vector3 Vector3 Vector3 Vector3

The direction in which audio is emitted from the emitter.

DistanceScale DistanceScale DistanceScale DistanceScale

Gets or sets the scale of the position of the emitter. All distances used when calculating spatial audio effects are expressed in meters. Setting this value allows you to automatically scale the calculations to use some other unit.

public : double DistanceScale { get; set; }public double DistanceScale { get; set; }Public ReadWrite Property DistanceScale As double// You can use this property in JavaScript.
Value
double double double double

The scale of the position of the emitter.

DopplerScale DopplerScale DopplerScale DopplerScale

Gets or sets the scale of the doppler velocity of the emitter. The DopplerVelocity of an emitter is expressed in meters per second. Setting this value allows you to automatically scale the velocity to some other unit.

public : double DopplerScale { get; set; }public double DopplerScale { get; set; }Public ReadWrite Property DopplerScale As double// You can use this property in JavaScript.
Value
double double double double

The scale of the doppler velocity of the emitter.

DopplerVelocity DopplerVelocity DopplerVelocity DopplerVelocity

Gets or sets a Vector3 expressing the velocity at which the emitter is moving in 3D space, expressed in meters per second.

public : Vector3 DopplerVelocity { get; set; }public Vector3 DopplerVelocity { get; set; }Public ReadWrite Property DopplerVelocity As Vector3// You can use this property in JavaScript.
Value
Vector3 Vector3 Vector3 Vector3

A Vector3 expressing the velocity at which the emitter is moving.

Remarks

By default, the doppler velocity is expressed in meters per second. Set the DopplerScale property to scale the value to use other units.

Gain Gain Gain Gain

Gets or sets a value indicating the gain applied to the signal by the emitter.

public : double Gain { get; set; }public double Gain { get; set; }Public ReadWrite Property Gain As double// You can use this property in JavaScript.
Value
double double double double

A value indicating the gain applied to the signal by the emitter.

IsDopplerDisabled IsDopplerDisabled IsDopplerDisabled IsDopplerDisabled

Gets a value indicating whether Doppler processing is disabled for the emitter.

public : PlatForm::Boolean IsDopplerDisabled { get; }public bool IsDopplerDisabled { get; }Public ReadOnly Property IsDopplerDisabled As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if Doppler processing is disabled; otherwise, false.

Position Position Position Position

Gets or sets a vector representing the position of the emitter in 3D space, expressed in meters.

public : Vector3 Position { get; set; }public Vector3 Position { get; set; }Public ReadWrite Property Position As Vector3// You can use this property in JavaScript.
Value
Vector3 Vector3 Vector3 Vector3

A vector representing the position of the emitter in 3D space

Shape Shape Shape Shape

Gets an object describing the shape in which the emitter emits audio.

public : AudioNodeEmitterShape Shape { get; }public AudioNodeEmitterShape Shape { get; }Public ReadOnly Property Shape As AudioNodeEmitterShape// You can use this property in JavaScript.
Value
AudioNodeEmitterShape AudioNodeEmitterShape AudioNodeEmitterShape AudioNodeEmitterShape

An object describing the shape in which the emitter emits audio.

Remarks

Create an AudioNodeEmitter with a particular shape by using the overload of the AudioNodeEmitter constructor.

SpatialAudioModel SpatialAudioModel SpatialAudioModel SpatialAudioModel

Gets or sets a value that specifies the spatial audio processing model used by the emitter.

public : SpatialAudioModel SpatialAudioModel { get; set; }public SpatialAudioModel SpatialAudioModel { get; set; }Public ReadWrite Property SpatialAudioModel As SpatialAudioModel// You can use this property in JavaScript.
Value
SpatialAudioModel SpatialAudioModel SpatialAudioModel SpatialAudioModel

A value that specifies the spatial audio processing model used by the emitter.