Libraries.Robots.Spike.AppSound Documentation

The AppSound library is used to play sounds in the SPIKE App. use Libraries.Robots.Spike.AppSound AppSound aSound aSound:Play("Alert", 100, 2, -100)

Inherits from: Libraries.Language.Object

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

Play(text soundName, integer volume, integer pitch, integer pan)

Plays a sound from the SPIKE App (found in Word Blocks sound extension in SPIKE App) using the provided volume, pitch, and pan arguments

Parameters

  • text soundName
  • integer volume: The volume intensity of the sound from 0 to 100
  • integer pitch: The pitch of the sound
  • integer pan: Value that determines which speaker is emitting the sound, with "-100" being only the left speaker, "0" being normal, and "100" being only the right speaker.

Example

use Libraries.Robots.Spike.AppSound
AppSound aSound
aSound:Play("Alert", 100, 2, -100)

Play(text soundName)

Plays a sound from the SPIKE App (found in Word Blocks sound extension in SPIKE App)

Parameters

  • text soundName

SetAttributes(integer volume, integer pitch, integer pan)

Sets the volume, pitch and pan attributes of the noise coming from the SPIKE App

Parameters

  • integer volume: The volume intensity of the sound from 0 to 100
  • integer pitch: The pitch of the sound
  • integer pan: Value that determines which speaker is emitting the sound, with "-100" being only the left speaker, "0" being normal, and "100" being only the right speaker.

Example

use Libraries.Robots.Spike.AppSound
use Libraries.Robots.Spike.Hub
AppSound aSound
Hub hb
aSound:Play("Campfire Music")
hb:Sleep(1000)
aSound:SetAttributes(100, 2, 100)

Stop()

Stops all sound coming from the App

Example

use Libraries.Robots.Spike.AppSound
AppSound aSound
aSound:Play("Bird", 100, 2, -100)
aSound:Stop()