O1Library Docs
Fall 2026
Docs API

# OctaveShift

o1.sound.midi.OctaveShift
final case class OctaveShift(shift: Int) extends MusicElem

Each instance of this class is a directive that instructs the subsequent notes to play one octave higher or lower.

## Parameters

shift

  the direction of the shift: +1 means one octave higher, -1 one lower

## Attributes

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

## Members list

### Value members

#### Concrete methods

override def toString: String

Returns a string description of the octave shift.

Returns a string description of the octave shift.

## Attributes

Definition Classes
  Any

#### Inherited methods

def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

## Attributes

Inherited from:
  Product

def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

## Attributes

Returns

  in the default implementation, an `Iterator[Any]`

Inherited from:
  Product

#### Concrete fields

val length: Int

an `OctaveShift` is a meta directive; it has no duration, so its length is zero

an `OctaveShift` is a meta directive; it has no duration, so its length is zero

## Attributes