C# Class OpenRA.Sound

Inheritance: IDisposable

Show file Open project: OpenRA/OpenRA Class Usage Examples

Private Properties

Property	Type	Description
LoadSound	ISoundSource
Play	ISound

Public Methods

Method	Description
AvailableDevices ( ) : OpenRA.SoundDevice[]
Dispose ( ) : void
Initialize ( ISoundLoader loaders, IReadOnlyFileSystem fileSystem ) : void
MuteAudio ( ) : void
PauseMusic ( ) : void
PauseVideo ( ) : void
Play ( string name ) : ISound
Play ( string name, OpenRA.WPos pos ) : ISound
Play ( string name, OpenRA.WPos pos, float volumeModifier ) : ISound
Play ( string name, float volumeModifier ) : ISound
PlayLooped ( string name ) : ISound
PlayLooped ( string name, OpenRA.WPos pos ) : ISound
PlayMusic ( ) : void
PlayMusic ( OpenRA.GameRules.MusicInfo m ) : void
PlayMusicThen ( OpenRA.GameRules.MusicInfo m, System.Action then ) : void
PlayNotification ( OpenRA.Ruleset rules, Player player, string type, string notification, string variant ) : bool
PlayPredefined ( OpenRA.Ruleset ruleset, Player p, OpenRA.Actor voicedActor, string type, string definition, string variant, bool relative, OpenRA.WPos pos, float volumeModifier, bool attenuateVolume ) : bool
PlayToPlayer ( Player player, string name ) : ISound
PlayToPlayer ( Player player, string name, OpenRA.WPos pos ) : ISound
PlayVideo ( ) : void
PlayVideo ( byte raw, int channels, int sampleBits, int sampleRate ) : void
SetListenerPosition ( OpenRA.WPos position ) : void
Sound ( IPlatform platform, SoundSettings soundSettings ) : System
StopAudio ( ) : void
StopMusic ( ) : void
StopSound ( ISound sound ) : void
StopVideo ( ) : void
Tick ( ) : void
UnmuteAudio ( ) : void

Private Methods

Method	Description
LoadSound ( ISoundLoader loaders, IReadOnlyFileSystem fileSystem, string filename ) : ISoundSource
Play ( Player player, string name, bool headRelative, OpenRA.WPos pos, float volumeModifier = 1f, bool loop = false ) : ISound

Method Details

AvailableDevices() public method

public AvailableDevices ( ) : OpenRA.SoundDevice[]
return	OpenRA.SoundDevice[]

Dispose() public method

public Dispose ( ) : void
return	void

Initialize() public method

public Initialize ( ISoundLoader loaders, IReadOnlyFileSystem fileSystem ) : void
loaders	ISoundLoader
fileSystem	IReadOnlyFileSystem
return	void

MuteAudio() public method

public MuteAudio ( ) : void
return	void

PauseMusic() public method

public PauseMusic ( ) : void
return	void

PauseVideo() public method

public PauseVideo ( ) : void
return	void

Play() public method

public Play ( string name ) : ISound
name	string
return	ISound

Play() public method

public Play ( string name, OpenRA.WPos pos ) : ISound
name	string
pos	OpenRA.WPos
return	ISound

Play() public method

public Play ( string name, OpenRA.WPos pos, float volumeModifier ) : ISound
name	string
pos	OpenRA.WPos
volumeModifier	float
return	ISound

Play() public method

public Play ( string name, float volumeModifier ) : ISound
name	string
volumeModifier	float
return	ISound

PlayLooped() public method

public PlayLooped ( string name ) : ISound
name	string
return	ISound

PlayLooped() public method

public PlayLooped ( string name, OpenRA.WPos pos ) : ISound
name	string
pos	OpenRA.WPos
return	ISound

PlayMusic() public method

public PlayMusic ( ) : void
return	void

PlayMusic() public method

public PlayMusic ( OpenRA.GameRules.MusicInfo m ) : void
m	OpenRA.GameRules.MusicInfo
return	void

PlayMusicThen() public method

public PlayMusicThen ( OpenRA.GameRules.MusicInfo m, System.Action then ) : void
m	OpenRA.GameRules.MusicInfo
then	System.Action
return	void

PlayNotification() public method

public PlayNotification ( OpenRA.Ruleset rules, Player player, string type, string notification, string variant ) : bool
rules	OpenRA.Ruleset
player	Player
type	string
notification	string
variant	string
return	bool

PlayPredefined() public method

public PlayPredefined ( OpenRA.Ruleset ruleset, Player p, OpenRA.Actor voicedActor, string type, string definition, string variant, bool relative, OpenRA.WPos pos, float volumeModifier, bool attenuateVolume ) : bool
ruleset	OpenRA.Ruleset
p	Player
voicedActor	OpenRA.Actor
type	string
definition	string
variant	string
relative	bool
pos	OpenRA.WPos
volumeModifier	float
attenuateVolume	bool
return	bool

PlayToPlayer() public method

public PlayToPlayer ( Player player, string name ) : ISound
player	Player
name	string
return	ISound

PlayToPlayer() public method

public PlayToPlayer ( Player player, string name, OpenRA.WPos pos ) : ISound
player	Player
name	string
pos	OpenRA.WPos
return	ISound

PlayVideo() public method

public PlayVideo ( ) : void
return	void

PlayVideo() public method

public PlayVideo ( byte raw, int channels, int sampleBits, int sampleRate ) : void
raw	byte
channels	int
sampleBits	int
sampleRate	int
return	void

SetListenerPosition() public method

public SetListenerPosition ( OpenRA.WPos position ) : void
position	OpenRA.WPos
return	void

Sound() public method

public Sound ( IPlatform platform, SoundSettings soundSettings ) : System
platform	IPlatform
soundSettings	SoundSettings
return	System

StopAudio() public method

public StopAudio ( ) : void
return	void

StopMusic() public method

public StopMusic ( ) : void
return	void

StopSound() public method

public StopSound ( ISound sound ) : void
sound	ISound
return	void

StopVideo() public method

public StopVideo ( ) : void
return	void

Tick() public method

public Tick ( ) : void
return	void

UnmuteAudio() public method

public UnmuteAudio ( ) : void
return	void