Index

Package: Audio_Players

Description

package Audio_Players is

Classes

Audio_Player

type Audio_Player is new Object and Process and Event_Listener with private;

Ancestors:

Primitive operations:

Adjust (overriding Objects.Adjust)
Construct
Delete (overriding Objects.Delete)
Events.Listeners.To_String (Inherited)
Get_Process_Name (overriding Processes.Get_Process_Name)
Handle_Event (overriding Events.Listeners.Handle_Event)
Objects.Construct (Inherited)
Objects.Object_Read (Inherited)
Objects.Object_Write (Inherited)
Objects.To_String (Inherited)
Tick (overriding Processes.Tick)

References:

audio_players.ads:16:10 (declaration)
audio_players.adb:89:47 (reference)
audio_players.adb:98:37 (reference)
audio_players.adb:108:40 (reference)
audio_players.adb:122:37 (reference)
audio_players.adb:132:46 (reference)
audio_players.adb:141:43 (reference)
audio_players.adb:157:50 (reference)
audio_players.adb:176:50 (reference)
audio_players.adb:193:45 (reference)
audio_players.adb:206:44 (reference)
audio_players.adb:234:50 (reference)
audio_players.adb:246:35 (reference)
audio_players.ads:17:39 (reference)
audio_players.ads:25:45 (reference)
audio_players.ads:29:44 (reference)
audio_players.ads:54:10 (full declaration)
audio_players.ads:66:37 (reference)
audio_players.ads:68:40 (reference)
audio_players.ads:70:37 (reference)
audio_players.ads:72:46 (reference)
audio_players.ads:75:43 (reference)
audio_players.ads:80:50 (reference)
audio_players.ads:83:50 (reference)
audio_players.ads:86:50 (reference)
audio_players.ads:88:35 (reference)
Audio_Player objects listen for certain audio events and play sound effects or music on command. The player contains an internal task for playing audio in the background.

Types

A_Audio_Player

type A_Audio_Player is access all Audio_Player'Class;

References:

audio_players.ads:17:10 (declaration)
audio_players.adb:59:40 (reference)
audio_players.adb:88:71 (reference)
audio_players.adb:89:25 (reference)
audio_players.adb:116:28 (reference)
audio_players.adb:254:37 (reference)
audio_players.adb:355:20 (reference)
audio_players.adb:362:41 (reference)
audio_players.ads:20:71 (reference)
audio_players.ads:32:37 (reference)
game_views.ads:100:27 (reference)

Subprograms & Entries

Create_Audio_Player

function Create_Audio_Player
( corral: not null A_Corral )
return A_Audio_Player;

References:

audio_players.ads:20:14 (declaration)
audio_players.adb:88:14 (body)
audio_players.adb:93:9 (label)
audio_players.ads:21:27 (reference)
game_views.adb:54:29 (reference)

Called by:

Game_Views.Construct defined at game_views.ads:110:15

Calls:

Construct defined at audio_players.ads:68:15
Creates a new Audio_Player that will listen for events in 'corral'.

Start

procedure Start
( this: not null access Audio_Player'Class );

References:

audio_players.ads:25:15 (declaration)
audio_players.adb:193:15 (body)
audio_players.adb:202:9 (label)
game_views.adb:271:30 (reference)

Called by:

Game_Views.Start defined at game_views.ads:61:15

Calls:

Audio_Players.Polling_Task.Start defined at audio_players.adb:62:15
Events.Corrals.Add_Listener defined at events-corrals.ads:25:15
Starts the Audio_Player's internals. This must be called before any audio can be played.

Stop

procedure Stop
( this: not null access Audio_Player'Class );

References:

audio_players.ads:29:15 (declaration)
audio_players.adb:206:15 (body)
audio_players.adb:230:9 (label)
game_views.adb:287:30 (reference)

Called by:

Game_Views.Stop defined at game_views.ads:65:15

Calls:

Audio_Players.Polling_Task.Stop defined at audio_players.adb:65:15
Debugging.Dbg defined at debugging.ads:58:15
Debugging.Dbg defined at debugging.ads:68:15
Events.Corrals.Remove_Listener defined at events-corrals.ads:42:15
Is_Terminated defined at a-taside.ads:62:13
To_Duration defined at a-reatim.ads:82:13
Stops the audio player's internals. This must be called after Start and before deleting the object.

Delete

procedure Delete
( this: in out A_Audio_Player );

References:

audio_players.ads:32:15 (declaration)
audio_players.adb:254:15 (body)
audio_players.adb:257:9 (label)
game_views.adb:66:9 (reference)

Called by:

Game_Views.Delete defined at game_views.ads:112:15

Calls:

Objects.Delete defined at objects.ads:46:15
Deletes the Audio_Player.