Packages

  • package o1

    O1Library is a toolkit designed for the course Programming 1 (a.k.a. O1) at Aalto University.

    O1Library is a toolkit designed for the course Programming 1 (a.k.a. O1) at Aalto University. It contains an assortment of tools; most prominently, it provides a framework for simple graphical programming and utilities for playing sound.

    This is the front page of O1Library’s documentation. However, this is probably not the best place to start learning about O1Library as a student. That’s because the relevant content of this library is introduced bit by bit in the chapters of O1’s custom ebook alongside the associated programming concepts and assignments.

    You may still find this documentation useful as a reference. You can also find some optional content here that you may wish to try.

    This front page lists the content available in the top-level package called simply o1. These tools are available with the simple command import o1._ in your Scala programs. Some of them you’ll use a lot; some of them you won’t necessarily need at all.

    The tools listed here are actually implemented in a number of subpackages (o1.gui, o1.sound, etc.); what you see here are just “shortcut aliases” to those actual implementations. The aliases are here to make that convenient import command work and to provide you with this list of links to some of the more commonly used tools in O1Library. The subpackages also contain additional content not listed here.

    O1Library has been developed by Aleksi Lukkarinen and Juha Sorva. Several of the key components in o1.gui and o1.world are built upon Aleksi’s Scala Media Computation Library. Some parts of O1Library draw inspiration from the “teachpacks” of the Racket programming language.

    We are grateful to Riku Autio, Joonatan Honkamaa, Juhani Numminen, Leo Varis, Veera Kahva, and anonymous students for bug reports and fixes. We thank Otto Seppälä for helpful discussions.

    Definition Classes
    root
  • package sound

    Please see one of the two subpackages:

    Please see one of the two subpackages:

    • o1.sound.midi for MIDI sound described in terms of notes, instruments, and other directives
    • o1.sound.sampled for working with recorded sound samples.
    Definition Classes
    o1
  • package sampled

    This is one of O1’s sound packages (the other being o1.sound.midi).

    This is one of O1’s sound packages (the other being o1.sound.midi). This package provides a simple interface for loading recorded sound samples.

    The contents of the package have aliases in the top-level package o1, so they are accessible to students simply via import o1._.

    Definition Classes
    sound
  • Sound

object Sound

This companion object of class Sound provides methods for creating new Sound objects. It has an alias in the top-level package o1, so it’s accessible to students simply via import o1._.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Sound
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def apply(url: URL, volume: Float): Sound

    Loads a sound sample from the given URL.

    Loads a sound sample from the given URL. The sound needs to be in one of these formats: WAV, AIFF, AU, AIFC, SND. Throws an IOException if the URL is inaccessible.

    url

    a URL to a sound sample

    volume

    an adjustment to the sound’s volume: a positive number makes it louder, a negative one quieter. Pass in Mute to make the sound completely silent.

    returns

    the sound; if the system doesn’t support sound, or if sound support is disabled, returns a silent Sound whose isDefined method returns false

  2. def apply(id: String, volume: Float = 0): Sound

    Loads a sound sample from a URL or a local file.

    Loads a sound sample from a URL or a local file. The sound needs to be in one of these formats: WAV, AIFF, AU, AIFC, SND.

    id

    a path or URL that identifies the sound sample; this needs to be a classpath-relative file path or an URL, as specified for the parameter of o1.util.tryForURL

    volume

    an adjustment to the sound’s volume: a positive number makes it louder, a negative one quieter. Pass in Mute to make the sound completely silent.

    returns

    the sound; if a sound matching id could not be located, if the system doesn’t support sound, or if sound support is disabled, returns a silent Sound whose isDefined method returns false