Index

Package: Audio

Description

package Events.Audio is

Classes

Play_Music_Event

type Play_Music_Event is new Event with private;

Ancestors:

Primitive operations:

Construct (overriding Events.Construct)
Objects.Adjust (Inherited)
Objects.Construct (Inherited)
Objects.Delete (Inherited)
Objects.Object_Read (Inherited)
Objects.Object_Write (Inherited)
To_String (overriding Events.To_String)
A command to begin playing a looped music track.

Play_Sound_Event

type Play_Sound_Event is new Event with private;

Ancestors:

Primitive operations:

Construct (overriding Events.Construct)
Objects.Adjust (Inherited)
Objects.Construct (Inherited)
Objects.Delete (Inherited)
Objects.Object_Read (Inherited)
Objects.Object_Write (Inherited)
To_String (overriding Events.To_String)
A command to play a sound effect once through.

Stop_Music_Event

type Stop_Music_Event is new Event with private;

Ancestors:

Primitive operations:

Events.Construct (Inherited)
Events.To_String (Inherited)
Objects.Adjust (Inherited)
Objects.Construct (Inherited)
Objects.Delete (Inherited)
Objects.Object_Read (Inherited)
Objects.Object_Write (Inherited)
A command to stop any music currently playing.

Types

A_Play_Music_Event

type A_Play_Music_Event is access all Play_Music_Event'Class;

A_Play_Sound_Event

type A_Play_Sound_Event is access all Play_Sound_Event'Class;

A_Stop_Music_Event

type A_Stop_Music_Event is access all Stop_Music_Event'Class;

Constants & Global variables

PLAY_MUSIC_ID (Events.Event_Id)

PLAY_MUSIC_ID : constant Event_Id := To_Event_Id( "Play_Music" );

PLAY_SOUND_ID (Events.Event_Id)

PLAY_SOUND_ID : constant Event_Id := To_Event_Id( "Play_Sound" );

STOP_MUSIC_ID (Events.Event_Id)

STOP_MUSIC_ID : constant Event_Id := To_Event_Id( "Stop_Music" );

Subprograms & Entries

Get_Music_Name

function Get_Music_Name
( this: not null access Play_Music_Event'Class ) return String;
Returns the filename of the music to play.

Get_Sound_Name

function Get_Sound_Name
( this: not null access Play_Sound_Event'Class ) return String;
Returns the name of the sound effect to play.

Queue_Play_Music

procedure Queue_Play_Music
( name: String );
Queues a Play_Music_Event.

Queue_Play_Sound

procedure Queue_Play_Sound
( name: String );
Queues a Play_Sound_Event.

Queue_Stop_Music

procedure Queue_Stop_Music;
Queues a Stop_Music_Event.