lib/app/audio.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   3 # Copyright 2014 Romain Chanoir <romain.chanoir@viacesi.fr>
   4 #
   5 # Licensed under the Apache License, Version 2.0 (the "License");
   6 # you may not use this file except in compliance with the License.
   7 # You may obtain a copy of the License at
   8 #
   9 #     http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 # Unless required by applicable law or agreed to in writing, software
  12 # distributed under the License is distributed on an "AS IS" BASIS,
  13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 # See the License for the specific language governing permissions and
  15 # limitations under the License.
  16
  17 # App audio abstraction
  18 #
  19 # Once the application has started (after `App.setup`)
  20 # use `App.load_sound` to get a sound
  21 # then `Sound.play` to play it
  22 module audio
  23
  24 import app_base
  25 import standard::error
  26
  27 # Abstraction of a playable Audio
  28 abstract class PlayableAudio
  29
  30         # Name of this playable audio
  31         var name: String
  32
  33         # Error which is not null if an error happened
  34         var error: nullable Error = null is writable
  35
  36         # Is this already loaded ?
  37         protected var is_loaded = false is writable
  38
  39         # load this playable audio
  40         fun load is abstract
  41
  42         # Plays the sound
  43         fun play is abstract
  44
  45         # Pauses the sound
  46         fun pause is abstract
  47
  48         # Resumes the sound
  49         fun resume is abstract
  50 end
  51
  52 # Abstraction of a short sound
  53 class Sound
  54         super PlayableAudio
  55 end
  56
  57 # Abstraction of a long song, that can bee looped
  58 class Music
  59         super PlayableAudio
  60 end
  61
  62 redef class App
  63
  64         # Load a sound
  65         fun load_sound(name: String): Sound is abstract
  66
  67         # Load a music
  68         fun load_music(name: String): Music is abstract
  69 end