Interface IMusicPlayer
Interface for a music player.
Namespace: Evergine.Common.Media
Assembly: Evergine.Common.dll
Syntax
public interface IMusicPlayer
Properties
IsMuted
Gets or sets a value indicating whether this instance is muted.
Declaration
bool IsMuted { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
|
IsRepeat
Gets or sets a value indicating whether this instance is repeated.
Declaration
bool IsRepeat { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
|
MusicEnabled
Gets or sets a value indicating whether [music is enabled].
Declaration
bool MusicEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
|
State
Gets the state.
Declaration
MusicState State { get; }
Property Value
| Type | Description |
|---|---|
| MusicState |
Volume
Gets or sets the volume.
Declaration
float Volume { get; set; }
Property Value
| Type | Description |
|---|---|
| float | The volume. |
Methods
OnActivated()
Called when the service is activated.
Declaration
void OnActivated()
OnDeactivated()
Called when the service is deactivated.
Declaration
void OnDeactivated()
Pause()
Pauses the instance.
Declaration
void Pause()
Play(MusicInfo)
Plays the specified music.
Declaration
void Play(MusicInfo music)
Parameters
| Type | Name | Description |
|---|---|---|
| MusicInfo | music | The music. |
Resume()
Resumes this instance.
Declaration
void Resume()
Stop()
Stops the instance.
Declaration
void Stop()