Events (1) Methods (5) Properties (3)
Namespace: CSCore.SoundOut

Syntax

public interface ISoundOut : IDisposable

Implements

  • System.IDisposable

Summary

Defines a interface for audio playbacks.

Events

Stopped

Occurs when the playback stops.

public Stopped

Methods

Initialize(IWaveSource source)

Initializes the ISoundOut for playing a source.

public abstract void Initialize(IWaveSource source)

Parameters

source

IWaveSource

IWaveSource which provides waveform-audio data to play.

Pause()

Pauses the audio playback.

public abstract void Pause()

Play()

Starts the audio playback.

public abstract void Play()

Resume()

Resumes the audio playback.

public abstract void Resume()

Stop()

Stops the audio playback.

public abstract void Stop()

Properties

PlaybackState

Gets the PlaybackState of the ISoundOut. The playback state indicates whether the playback is currently playing, paused or stopped.

public abstract PlaybackState PlaybackState { get; }

Volume

Gets or sets the volume of the playback. The value of this property must be within the range from 0.0 to 1.0 where 0.0 equals 0% (muted) and 1.0 equals 100%.

public abstract Single Volume { get; set; }

WaveSource

Gets the IWaveSource which provides the waveform-audio data and was used to Initialize the ISoundOut.

public abstract IWaveSource WaveSource { get; }

Class Diagram

save

reset

Drag to pan - Use Mousewheel + Ctrl to zoom