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 # Default behaviour is loading the audio from the `assets` folder of the project with its name and extension
  19 # Platforms implementations can modify this comportement
  20 #
  21 # Once the application has started (after `App.setup`)
  22 # use `App.load_sound` to get a sound
  23 # then `Sound.play` to play it
  24 module audio
  25
  26 import app_base
  27 import core::error
  28
  29 # Platform variations
  30 import linux::audio is conditional(linux)
  31 import android::audio is conditional(android)
  32
  33 # Abstraction of a playable Audio
  34 abstract class PlayableAudio
  35
  36         # Name of this playable audio
  37         var name: String
  38
  39         # Error which is not null if an error happened
  40         var error: nullable Error = null is writable
  41
  42         # Is this already loaded ?
  43         protected var is_loaded = false is writable
  44
  45         # Load this playable audio
  46         fun load is abstract
  47
  48         # Plays the sound
  49         fun play is abstract
  50
  51         # Pauses the sound
  52         fun pause is abstract
  53
  54         # Resumes the sound
  55         fun resume is abstract
  56 end
  57
  58 # Abstraction of a short sound
  59 class Sound
  60         super PlayableAudio
  61 end
  62
  63 # Abstraction of a long song, that can bee looped
  64 class Music
  65         super PlayableAudio
  66 end
  67
  68 redef class App
  69
  70         # Load a sound
  71         fun load_sound(name: String): Sound is abstract
  72
  73         # Load a music
  74         fun load_music(name: String): Music is abstract
  75 end