O1Library Docs
Fall 2023
Docs API

# Pitch

o1.sound.midi.Pitch
See the Pitch companion object
final case class Pitch(name: Char, accidental: Accidental, octave: Option[Int])

A `Pitch` is a frequency for a note to be played at.

## Parameters

accidental

  an adjustment to the base frequency

name

  the name of the corresponding note, which provides the base frequency; one of "cdefgah" or their upper-case equivalents

octave

  the number of the octave relative to `DefaultOctave`; e.g., -2 means two octaves lower than the default; passing in `None` has the same effect as passing in zero

## Attributes

Companion
  object
Graph
Supertypes
  trait Serializable
  trait Product
  trait Equals
  class Object
  trait Matchable
  class Any
  Show all

## Members list

### Value members

#### Concrete methods

override def toString: String

Returns a string description of the pitch.

Returns a string description of the pitch.

## Attributes

Definition Classes
  Any

#### Inherited methods

def productElementNames: Iterator[String]

## Attributes

Inherited from:
  Product

def productIterator: Iterator[Any]

## Attributes

Inherited from:
  Product