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
  26 # Abstraction of a sound
  27 abstract class Sound
  28
  29         # Plays the sound
  30         fun play is abstract
  31
  32         # Pauses the sound
  33         fun pause is abstract
  34
  35         # Resumes the sound
  36         fun resume is abstract
  37 end
  38
  39 redef class App
  40
  41         # Loads a sound from the assets of the app, returns `null` if the loading failed
  42         fun load_sound(name: String): nullable Sound do return null
  43 end