Xeno-rat
Loading...
Searching...
No Matches
NAudio.Wave.IWavePlayer Interface Reference

Represents the interface to a device that can play a WaveFile. More...

Inheritance diagram for NAudio.Wave.IWavePlayer:
Collaboration diagram for NAudio.Wave.IWavePlayer:

Public Member Functions

void Play ()
 Begin playback.
 
void Stop ()
 Stop playback.
 
void Pause ()
 Pause Playback.
 
void Init (IWaveProvider waveProvider)
 Initialise playback.
 

Properties

float Volume [get, set]
 The volume 1.0f is full scale Note that not all implementations necessarily support volume changes.
 
PlaybackState PlaybackState [get]
 Current playback state.
 
WaveFormat OutputWaveFormat [get]
 The WaveFormat this device is using for playback.
 

Events

EventHandler< StoppedEventArgsPlaybackStopped
 Indicates that playback has gone into a stopped state due to reaching the end of the input stream or an error has been encountered during playback.
 

Detailed Description

Represents the interface to a device that can play a WaveFile.

Member Function Documentation

◆ Init()

void NAudio.Wave.IWavePlayer.Init ( IWaveProvider waveProvider)

Initialise playback.

Parameters
waveProviderThe waveprovider to be played

Implemented in NAudio.Wave.AsioOut, NAudio.Wave.DirectSoundOut, NAudio.Wave.WasapiOut, NAudio.Wave.WaveOut, and NAudio.Wave.WaveOutEvent.

Here is the caller graph for this function:

◆ Pause()

void NAudio.Wave.IWavePlayer.Pause ( )

◆ Play()

void NAudio.Wave.IWavePlayer.Play ( )

◆ Stop()

void NAudio.Wave.IWavePlayer.Stop ( )

Property Documentation

◆ OutputWaveFormat

WaveFormat NAudio.Wave.IWavePlayer.OutputWaveFormat
get

The WaveFormat this device is using for playback.

Implemented in NAudio.Wave.AsioOut, NAudio.Wave.DirectSoundOut, NAudio.Wave.WasapiOut, NAudio.Wave.WaveOut, and NAudio.Wave.WaveOutEvent.

◆ PlaybackState

PlaybackState NAudio.Wave.IWavePlayer.PlaybackState
get

◆ Volume

float NAudio.Wave.IWavePlayer.Volume
getset

The volume 1.0f is full scale Note that not all implementations necessarily support volume changes.

Implemented in NAudio.Wave.AsioOut, NAudio.Wave.DirectSoundOut, NAudio.Wave.WasapiOut, NAudio.Wave.WaveOut, and NAudio.Wave.WaveOutEvent.

Event Documentation

◆ PlaybackStopped

EventHandler<StoppedEventArgs> NAudio.Wave.IWavePlayer.PlaybackStopped

Indicates that playback has gone into a stopped state due to reaching the end of the input stream or an error has been encountered during playback.


The documentation for this interface was generated from the following file: