TriEngine  v0.0.16
General-purpose engine in C#/OpenGL
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events
TriDevs.TriEngine.Audio.ISong Interface Reference

A song that will be streamed in the audio player. More...

Inheritance diagram for TriDevs.TriEngine.Audio.ISong:
[legend]
Collaboration diagram for TriDevs.TriEngine.Audio.ISong:
[legend]

Public Member Functions

void Play ()
 Starts playback of the song. More...
 
void Stop ()
 Stops playback of the song. More...
 
void Pause ()
 Pauses playback of the song. More...
 
void Resume ()
 Resumes playback of a paused song. More...
 

Properties

string File [get]
 Gets the file this song was loaded from. More...
 
float Volume [get, set]
 Gets or sets the song volume. More...
 
bool IsLooped [get, set]
 Gets or sets a value indicating that the song should be looped once it reaches the end. More...
 
- Properties inherited from TriDevs.TriEngine.Resources.IResource
string Name [get]
 Gets the name associated with this resource. More...
 

Detailed Description

A song that will be streamed in the audio player.

Member Function Documentation

void TriDevs.TriEngine.Audio.ISong.Pause ( )

Pauses playback of the song.

Call the Resume or Play method to resume playback.

Implemented in TriDevs.TriEngine.Audio.Song, and TriDevs.TriEngine.Audio.NullSong.

void TriDevs.TriEngine.Audio.ISong.Play ( )

Starts playback of the song.

Implemented in TriDevs.TriEngine.Audio.Song, and TriDevs.TriEngine.Audio.NullSong.

void TriDevs.TriEngine.Audio.ISong.Resume ( )

Resumes playback of a paused song.

Implemented in TriDevs.TriEngine.Audio.Song, and TriDevs.TriEngine.Audio.NullSong.

void TriDevs.TriEngine.Audio.ISong.Stop ( )

Stops playback of the song.

Implemented in TriDevs.TriEngine.Audio.Song, and TriDevs.TriEngine.Audio.NullSong.

Property Documentation

string TriDevs.TriEngine.Audio.ISong.File
get

Gets the file this song was loaded from.

bool TriDevs.TriEngine.Audio.ISong.IsLooped
getset

Gets or sets a value indicating that the song should be looped once it reaches the end.

float TriDevs.TriEngine.Audio.ISong.Volume
getset

Gets or sets the song volume.


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