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 # Services to load and play `Sound` and `Music` from the assets folder
  18 #
  19 # Get a handle to a sound using `new Sound` or `new Music` at any time.
  20 # Call `load` at or after `App::on_create` or leave it to be loaded
  21 # on demand by the first call to `play`.
  22 module audio
  23
  24 import app_base
  25 import core::error
  26
  27 # Platform variations
  28 import linux::audio is conditional(linux)
  29 import android::audio is conditional(android)
  30
  31 # Abstraction of a playable Audio
  32 abstract class PlayableAudio
  33
  34         # Path to the audio file in the assets folder
  35         var path: String
  36
  37         # Last error on this sound, if any
  38         var error: nullable Error = null is writable
  39
  40         # Is `self` already loaded?
  41         protected var is_loaded = false is writable
  42
  43         # Load this playable audio
  44         fun load do end
  45
  46         # Play the sound
  47         fun play do end
  48
  49         # Pause the sound
  50         fun pause do end
  51
  52         # Resume the sound
  53         fun resume do end
  54 end
  55
  56 # Short sound
  57 class Sound
  58         super PlayableAudio
  59 end
  60
  61 # Long sound that can bee looped
  62 class Music
  63         super PlayableAudio
  64 end