Interface

ISimulatorAudio

USI.Core

Simulator-neutral audio output and mixer preferences.

public interface ISimulatorAudio

Events

OutputChanged

public event EventHandler<SimulatorAudioOutputChangedEventArgs> OutputChanged

Raised when the provider reports that simulator-wide audio output became enabled or disabled.

Methods

TryGetAvionicsFanVolumeAsync

public Task<USIResult<Double>> TryGetAvionicsFanVolumeAsync()

TryGetCameraInsideAircraftSoundRegionAsync

public Task<USIResult<Boolean>> TryGetCameraInsideAircraftSoundRegionAsync()

Gets whether the active camera is inside an aircraft-authored sound region.

TryGetCommunicationsRadioVolumeAsync

public Task<USIResult<Double>> TryGetCommunicationsRadioVolumeAsync()

TryGetCopilotRadioVolumeAsync

public Task<USIResult<Double>> TryGetCopilotRadioVolumeAsync()

TryGetCopilotVoiceVolumeAsync

public Task<USIResult<Double>> TryGetCopilotVoiceVolumeAsync()

TryGetEnabledAsync

public Task<USIResult<Boolean>> TryGetEnabledAsync()

Gets whether simulator audio output is enabled.

TryGetEngineEffectsVolumeAsync

public Task<USIResult<Double>> TryGetEngineEffectsVolumeAsync()

TryGetEnvironmentVolumeAsync

public Task<USIResult<Double>> TryGetEnvironmentVolumeAsync()

TryGetExteriorEffectsVolumeAsync

public Task<USIResult<Double>> TryGetExteriorEffectsVolumeAsync()

TryGetGroundContactEffectsVolumeAsync

public Task<USIResult<Double>> TryGetGroundContactEffectsVolumeAsync()

TryGetInteriorEffectsVolumeAsync

public Task<USIResult<Double>> TryGetInteriorEffectsVolumeAsync()

TryGetMasterVolumeAsync

public Task<USIResult<Double>> TryGetMasterVolumeAsync()

TryGetPilotVoiceVolumeAsync

public Task<USIResult<Double>> TryGetPilotVoiceVolumeAsync()

TryGetPropellerEffectsVolumeAsync

public Task<USIResult<Double>> TryGetPropellerEffectsVolumeAsync()

TryGetRadioHeadsetSourceAsync

public Task<USIResult<SimulatorRadioHeadsetSource>> TryGetRadioHeadsetSourceAsync()

Gets which crew audio panel currently feeds radio audio to the user's headset.

TryGetSoundOutputAvailableAsync

public Task<USIResult<Boolean>> TryGetSoundOutputAvailableAsync()

Gets whether the simulator has usable sound output.

TryGetSpeechEnabledAsync

public Task<USIResult<Boolean>> TryGetSpeechEnabledAsync()

Gets whether simulator-generated speech is enabled.

TryGetSpeechSynthesisAvailableAsync

public Task<USIResult<Boolean>> TryGetSpeechSynthesisAvailableAsync()

Gets whether the simulator can synthesize speech.

TryGetUserInterfaceEffectsVolumeAsync

public Task<USIResult<Double>> TryGetUserInterfaceEffectsVolumeAsync()

TryGetWeatherEffectsVolumeAsync

public Task<USIResult<Double>> TryGetWeatherEffectsVolumeAsync()

TrySetAvionicsFanVolumeAsync

public Task<USIResult> TrySetAvionicsFanVolumeAsync(double ratio)

TrySetCommunicationsRadioVolumeAsync

public Task<USIResult> TrySetCommunicationsRadioVolumeAsync(double ratio)

TrySetCopilotRadioVolumeAsync

public Task<USIResult> TrySetCopilotRadioVolumeAsync(double ratio)

TrySetCopilotVoiceVolumeAsync

public Task<USIResult> TrySetCopilotVoiceVolumeAsync(double ratio)

TrySetEnabledAsync

public Task<USIResult> TrySetEnabledAsync(bool enabled)

Explicitly enables or disables simulator audio output.

TrySetEngineEffectsVolumeAsync

public Task<USIResult> TrySetEngineEffectsVolumeAsync(double ratio)

TrySetEnvironmentVolumeAsync

public Task<USIResult> TrySetEnvironmentVolumeAsync(double ratio)

TrySetExteriorEffectsVolumeAsync

public Task<USIResult> TrySetExteriorEffectsVolumeAsync(double ratio)

TrySetGroundContactEffectsVolumeAsync

public Task<USIResult> TrySetGroundContactEffectsVolumeAsync(double ratio)

TrySetInteriorEffectsVolumeAsync

public Task<USIResult> TrySetInteriorEffectsVolumeAsync(double ratio)

TrySetMasterVolumeAsync

public Task<USIResult> TrySetMasterVolumeAsync(double ratio)

TrySetPilotVoiceVolumeAsync

public Task<USIResult> TrySetPilotVoiceVolumeAsync(double ratio)

TrySetPropellerEffectsVolumeAsync

public Task<USIResult> TrySetPropellerEffectsVolumeAsync(double ratio)

TrySetSpeechEnabledAsync

public Task<USIResult> TrySetSpeechEnabledAsync(bool enabled)

Explicitly enables or disables simulator-generated speech.

TrySetUserInterfaceEffectsVolumeAsync

public Task<USIResult> TrySetUserInterfaceEffectsVolumeAsync(double ratio)

TrySetWeatherEffectsVolumeAsync

public Task<USIResult> TrySetWeatherEffectsVolumeAsync(double ratio)

TrySpeakAsync

public Task<USIResult> TrySpeakAsync(string text)

Requests that the simulator present the text and speak it when the user's simulator preferences allow. Success means the request was accepted, not that audible playback was guaranteed.