/// <summary> /// Creates and configures a submix voice. /// </summary> /// <param name="inputChannels"> /// Number of channels in the input audio data of the submix voice. The /// <paramref name="inputChannels" /> must be less than or equal to <see cref="MaxAudioChannels" />. /// </param> /// <param name="inputSampleRate"> /// Sample rate of the input audio data of submix voice. This rate must be a multiple of /// <see cref="QuantumDenominator" />. InputSampleRate must be between <see cref="MinimumSampleRate" /> and /// <see cref="MaximumSampleRate" />. /// </param> /// <param name="flags"> /// Flags that specify the behavior of the submix voice. It can be <see cref="VoiceFlags.None" /> or /// <see cref="VoiceFlags.UseFilter" />. /// </param> /// <param name="processingStage"> /// An arbitrary number that specifies when this voice is processed with respect to other /// submix voices, if the XAudio2 engine is running other submix voices. The voice is processed after all other voices /// that include a smaller <paramref name="processingStage" /> value and before all other voices that include a larger /// <paramref name="processingStage" /> value. Voices that include the same <paramref name="processingStage" /> value /// are /// processed in any order. A submix voice cannot send to another submix voice with a lower or equal /// <paramref name="processingStage" /> value. This prevents audio being lost due to a submix cycle. /// </param> /// <param name="sendList"> /// List of <see cref="VoiceSends" /> structures that describe the set of destination voices for the /// submix voice. If <paramref name="sendList" /> is NULL, the send list will default to a single output to the first /// mastering voice created. /// </param> /// <param name="effectChain"> /// List of <see cref="EffectChain" /> structures that describe an effect chain to use in the /// submix voice. This parameter is optional and can be null. /// </param> /// <returns>On success, returns a pointer to the new <see cref="XAudio2SubmixVoice" /> object.</returns> public IntPtr CreateSubmixVoicePtr(int inputChannels, int inputSampleRate, VoiceFlags flags, int processingStage, VoiceSends?sendList, EffectChain?effectChain) { IntPtr ptr; int result = CreateSubmixVoiceNative(out ptr, inputChannels, inputSampleRate, flags, processingStage, sendList, effectChain); XAudio2Exception.Try(result, N, "CreateSubmixVoiceNative"); return(ptr); }
/// <summary> /// Returns the volume levels for the voice, per channel. /// These settings are applied after the effect chain is applied. /// This method is valid only for source and submix voices, because mastering voices do not specify volume per channel. /// </summary> /// <param name="channelCount">Confirms the channel count of the voice.</param> /// <returns> /// Returns the current volume level of each channel in the voice. The has at least <paramref name="channelCount" /> /// elements. /// </returns> /// <remarks> /// The master volume level is applied at different times depending on the type of voice. /// For submix and mastering voices the volume level is applied just before the voice's built in filter and effect /// chain is applied. /// For source voices the master volume level is applied after the voice's filter and effect /// chain is applied. Volume levels are expressed as floating-point amplitude multipliers /// between -2^24 and 2^24, with a maximum /// gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. /// Negative levels can be used to invert the audio's phase. /// </remarks> public float[] GetChannelVolumes(int channelCount) { if (channelCount <= 0) { throw new ArgumentOutOfRangeException("channelCount"); } var volumes = new float[channelCount]; XAudio2Exception.Try(GetChannelVolumesNative(channelCount, volumes), InterfaceName, "GetChannelVolumes"); return(volumes); }
/// <summary> /// Sets the volume levels for the voice, per channel. This method is valid only for source and submix voices, because /// mastering voices do not specify volume per channel. /// </summary> /// <param name="channelCount">Number of channels in the voice.</param> /// <param name="volumes"> /// Array containing the new volumes of each channel in the voice. The array must have /// <paramref name="channelCount" /> elements. See Remarks for more information on volume levels. /// </param> /// <param name="operationSet"> /// Identifies this call as part of a deferred batch. For more information see /// http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. /// </param> /// <remarks> /// The master volume level is applied at different times depending on the type of voice. /// For submix and mastering voices the volume level is applied just before the voice's built in filter and effect /// chain is applied. /// For source voices the master volume level is applied after the voice's filter and effect /// chain is applied. Volume levels are expressed as floating-point amplitude multipliers /// between -2^24 and 2^24, with a maximum /// gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. /// Negative levels can be used to invert the audio's phase. /// </remarks> public void SetChannelVolumes(int channelCount, float[] volumes, int operationSet) { if (volumes == null) { throw new ArgumentNullException("volumes"); } if (volumes.Length != channelCount) { throw new ArgumentException( "The length of the volumes argument has to be equal to the channelCount argument."); } XAudio2Exception.Try(SetChannelVolumesNative(volumes.Length, volumes, operationSet), InterfaceName, "SetChannelVolumes"); }
/// <summary> /// Designates a new set of submix or mastering voices to receive the output of the voice. /// </summary> /// <param name="voiceSendDescriptors"> /// Array of <see cref="VoiceSendDescriptor" />s. if <paramref name="voiceSendDescriptors" /> is null, the voice will send /// its output to the current mastering voice. /// All voices in the <paramref name="voiceSendDescriptors" /> must have the same input sample rate. /// </param> public unsafe void SetOutputVoices(VoiceSendDescriptor[] voiceSendDescriptors) { if (voiceSendDescriptors == null) { XAudio2Exception.Try(SetOutputVoicesNative(null), InterfaceName, "SetOutputVoices"); } else { fixed(void *ptr = &voiceSendDescriptors[0]) { var p = new VoiceSends { SendCount = voiceSendDescriptors.Length, SendsPtr = new IntPtr(ptr) }; XAudio2Exception.Try(SetOutputVoicesNative(p), InterfaceName, "SetOutputVoices"); } } }
/// <summary> /// Sets the overall volume level for the voice. /// </summary> /// <param name="volume">Overall volume level to use. See Remarks for more information on volume levels.</param> /// <param name="operationSet"> /// Identifies this call as part of a deferred batch. For more information see /// http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. /// </param> /// <remarks> /// The master volume level is applied at different times depending on the type of voice. /// For submix and mastering voices the volume level is applied just before the voice's built in filter and effect /// chain is applied. /// For source voices the master volume level is applied after the voice's filter and effect /// chain is applied. Volume levels are expressed as floating-point amplitude multipliers /// between -2^24 and 2^24, with a maximum /// gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. /// Negative levels can be used to invert the audio's phase. /// </remarks> public void SetVolume(float volume, int operationSet) { XAudio2Exception.Try(SetVolumeNative(volume, operationSet), InterfaceName, "SetVolume"); }
/// <summary> /// Sets the filter parameters on one of this voice's sends. /// </summary> /// <param name="destinationVoice">The destination voice of the send whose filter parameters will be set.</param> /// <param name="filterParameters"> /// <see cref="AudioSharp.XAudio2.FilterParameters" /> structure containing the filter /// information. /// </param> /// <param name="operationSet"> /// Identifies this call as part of a deferred batch. For more information see /// http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. /// </param> public void SetOutputFilterParameters(XAudio2Voice destinationVoice, FilterParameters filterParameters, int operationSet) { XAudio2Exception.Try(SetOutputFilterParametersNative(destinationVoice, filterParameters, operationSet), InterfaceName, "SetOutputFilterParameters"); }
/// <summary> /// Sets the voice's filter parameters. /// </summary> /// <param name="filterParameters"> /// <see cref="AudioSharp.XAudio2.FilterParameters" /> structure containing the filter /// information. /// </param> /// <param name="operationSet"> /// Identifies this call as part of a deferred batch. For more information see /// http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. /// </param> public void SetFilterParameters(FilterParameters filterParameters, int operationSet) { XAudio2Exception.Try(SetFilterParametersNative(filterParameters, operationSet), InterfaceName, "SetFilterParameters"); }
/// <summary> /// Disables the effect at a given position in the effect chain of the voice. /// </summary> /// <param name="effectIndex">Zero-based index of an effect in the effect chain of the voice.</param> /// <param name="operationSet"> /// Identifies this call as part of a deferred batch. For more information see /// http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. /// </param> public void DisableEffect(int effectIndex, int operationSet) { XAudio2Exception.Try(DisableEffectNative(effectIndex, operationSet), InterfaceName, "DisableEffect"); }
/// <summary> /// Atomically applies a set of operations that are tagged with a given identifier. /// </summary> /// <param name="operationSet"> /// Identifier of the set of operations to be applied. To commit all pending operations, pass /// <see cref="CommitAll" />. /// </param> public void CommitChanges(int operationSet) { XAudio2Exception.Try(CommitChangesNative(operationSet), N, "CommitChanges"); }
/// <summary> /// Notifies an XAudio2 voice that no more buffers are coming after the last one that is currently in its queue. /// </summary> public void Discontinuity() { XAudio2Exception.Try(DiscontinuityNative(), N, "Discontinuity"); }
/// <summary> /// Adds a new audio buffer to the voice queue. /// </summary> /// <param name="buffer"><see cref="XAudio2Buffer" /> structure to queue.</param> /// <remarks> /// See /// http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2sourcevoice.ixaudio2sourcevoice.submitsourcebuffer(v=vs.85).aspx. /// </remarks> public unsafe void SubmitSourceBuffer(XAudio2Buffer buffer) { XAudio2Exception.Try(SubmitSourceBufferNative(new IntPtr(&buffer), IntPtr.Zero), N, "SubmitSourceBuffer"); }
/// <summary> /// Adds an <see cref="IXAudio2EngineCallback" /> from the <see cref="XAudio2" /> engine callback list. /// </summary> /// <param name="callback"> /// <see cref="IXAudio2EngineCallback" /> object to add to the <see cref="XAudio2" /> engine /// callback list. /// </param> public void RegisterForCallbacks(IXAudio2EngineCallback callback) { XAudio2Exception.Try(RegisterForCallbacksNative(callback), N, "RegisterForCallbacks"); }
/// <summary> /// Sets XAudio2 parameters and prepares XAudio2 for use. /// </summary> /// <param name="flags">Flags that specify the behavior of the XAudio2 object. This value must be 0.</param> /// <param name="processor"> /// Specifies which CPU to use. Use <see cref="XAudio2Processor.XAudio27DefaultProcessor" /> as default value. /// </param> public void Initialize(int flags, XAudio2Processor processor) { XAudio2Exception.Try(InitializeNative(flags, processor), N, "Initialize"); }
/// <summary> /// Starts consumption and processing of audio by the voice. Delivers the result to any connected submix or mastering /// voices, or to the output device. /// </summary> /// <param name="flags">Flags that control how the voice is started. Must be 0.</param> /// <param name="operationSet"> /// Identifies this call as part of a deferred batch. For more details see /// http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. /// </param> public void Start(int flags, int operationSet) { XAudio2Exception.Try(StartNative(flags, operationSet), N, "Start"); }
/// <summary> /// Reconfigures the voice to consume source data at a different sample rate than the rate specified when the voice was /// created. /// </summary> /// <param name="newSourceSampleRate"> /// The new sample rate the voice should process submitted data at. Valid sample rates /// are 1kHz to 200kHz. /// </param> public void SetSourceSampleRate(int newSourceSampleRate) { XAudio2Exception.Try(SetSourceSampleRateNative(newSourceSampleRate), N, "SetSourceSampleRate"); }
/// <summary> /// Sets the frequency adjustment ratio of the voice. /// </summary> /// <param name="ratio"> /// Frequency adjustment ratio. This value must be between <see cref="XAudio2.MinFrequencyRatio" /> and /// the MaxFrequencyRatio parameter specified when the voice was created /// <see /// cref="XAudio2.CreateSourceVoice(AudioSharp.WaveFormat,AudioSharp.XAudio2.VoiceFlags,float,AudioSharp.XAudio2.IXAudio2VoiceCallback,System.Nullable{AudioSharp.XAudio2.VoiceSends},System.Nullable{AudioSharp.XAudio2.EffectChain})" /> /// . /// </param> /// <param name="operationSet"> /// Identifies this call as part of a deferred batch. For more details see /// http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. /// </param> public void SetFrequencyRatio(float ratio, int operationSet) { XAudio2Exception.Try(SetFrequencyRatioNative(ratio, operationSet), N, "SetFrequencyRatio"); }
/// <summary> /// Stops looping the voice when it reaches the end of the current loop region. /// </summary> /// <param name="operationSet"> /// Identifies this call as part of a deferred batch. For more details see /// http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. /// </param> public void ExitLoop(int operationSet) { XAudio2Exception.Try(ExitLoopNative(operationSet), N, "ExitLoop"); }
/// <summary> /// Starts the audio processing thread. /// </summary> public void StartEngine() { XAudio2Exception.Try(StartEngineNative(), N, "StartEngine"); }
/// <summary> /// Stops consumption of audio by the current voice. /// </summary> /// <param name="flags"> /// Flags that control how the voice is stopped. Can be <see cref="SourceVoiceStopFlags.None" /> or /// <see cref="SourceVoiceStopFlags.PlayTails" />. /// </param> /// <param name="operationSet"> /// Identifies this call as part of a deferred batch. For more details see /// http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. /// </param> public void Stop(SourceVoiceStopFlags flags, int operationSet) { XAudio2Exception.Try(StopNative(flags, operationSet), N, "Stop"); }
/// <summary> /// Removes all pending audio buffers from the voice queue. If the voice is started, the buffer that is currently /// playing is not removed from the queue. /// </summary> /// <remarks> /// See /// http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2sourcevoice.ixaudio2sourcevoice.flushsourcebuffers(v=vs.85).aspx. /// </remarks> public void FlushSourceBuffers() { XAudio2Exception.Try(FlushSourceBuffersNative(), N, "FlushSourceBuffers"); }