Documentation > nControl > API Reference
Sound Tile
nControl™ 2021.0
This tile allows you to play sounds.
Introduction
When you click on the tile it performs the play() function. You can use the API functions to pilot the sound tile from the event scripts of other tiles.
Event Scripts
Sound tiles don't support any event scripts.
API Functions
Tile Specific Functions
nSoundTile.isPlaying()
Returns whether the sound is playing (True) or not (False).
nSoundTile.play()
Plays the sound associated with the tile. If the sound is playing it will stop the sound and restart if from the beginning.
nSoundTile.stop()
Stops the playback of the sound.
Inherited from nTile
nSoundTile.clearScreen()
Clear all the text in the console window.
nSoundTile.getTile(label)
Returns the tile object specified by label. If there is no tile with the specified label, the function returns a None value.
nSoundTile.print(text)
Prints text in the console window. If the console window it not yet visible, printing text will make it visible.
nSoundTile.showConsole(mode)
Shows (mode = True) or hides (mode = False) the console window.
nSoundTile.sleep(duration)
Stops the execution of the script for the the given number of seconds. Note that duration can be a floating point number, e.g. to suspend the script for half a seconds use self.sleep(0.5).
nSoundTile.timestamp()
Returns the number of seconds that passed since nControl™ was launched. It returns a floating point value with the highest possible time resolution supported by your system. The difference between two time stamps provides the number of seconds elapsed between those two events.
nSoundTile.localVars
Base property to which you can add local variables that retain their value after the event script finishes. For example self.localVars.myVar = 5 adds a new property myVar to self.localVars and gives it the value 5. The localVars property is local to the current tile meaning that each tile has its own independent localVars property.
nSoundTile.globalVars
Base property to which you can add global variables that retain their value after the event script finishes. For example self.globalVars.myVar = 5 adds a new property myVar to self.globalVars and gives it the value 5. The globalVars property is global to nControl meaning that all tiles use the same globalVars property. As such globalVars can be used to exchange information between the tiles.