Class default

constructor

• new default(options?): default

• Parameters

  • options: Partial<Options> = ...

  Returns default

connectionAwaiter

isConnected

addCategory

• addCategory(name, parentCategoryIndex?): Promise<boolean>

• Parameters

  • name: string
  • parentCategoryIndex: number = -1

  Returns Promise<boolean>

addSound

• addSound(url): Promise<boolean>

• Adds a sound to the sound list.

  Parameters

  • url: string

    full path and file name, e.g. C:\mysounds\sound.mp3

  Returns Promise<boolean>

  true on success
• addSound(url, index?): Promise<boolean>

• Adds a sound to the sound list.

  Parameters

  • url: string

    full path and file name, e.g. C:\mysounds\sound.mp3
  • Optional index: number

    The index to add the sound to in the default category.

  Returns Promise<boolean>

  true on success
• addSound(url, index, insertAtPosition): Promise<boolean>

• Adds a sound to the sound list.

  Parameters

  • url: string

    full path and file name, e.g. C:\mysounds\sound.mp3
  • index: number

    The category to add the sound to.
  • insertAtPosition: number

    The index to add the sound to.

  Returns Promise<boolean>

  true on success

connect

• connect(dataDriver?): Promise<boolean>

• Parameters

  • dataDriver: ((query) => Promise<string>) = ...
    • • (query): Promise<string>

      • Parameters

        • query: string

        Returns Promise<string>

  Returns Promise<boolean>

disconnect

• disconnect(): void

• Returns void

getCategories

• getCategories(withSounds?, withIcons?): Promise<string>

• Get the category tree.

  Parameters

  • Optional withSounds: boolean = false

    includes all sound entries of each category into the response
  • Optional withIcons: boolean = false

    base64 encoded PNGs

  Returns Promise<string>

  xml formatted category list

getCategoriesJSON

• getCategoriesJSON(withSounds?, withIcons?): Promise<Category[]>

• Get the category tree.

  Parameters

  • Optional withSounds: boolean = false

    includes all sound entries of each category into the response
  • Optional withIcons: boolean = false

    base64 encoded PNGs

  Returns Promise<Category[]>

  category list

getCategory

• getCategory(categoryIndex, withSounds, withIcons): Promise<string>

• Get a category identified by its index. Use getCategories to get the index.

  Parameters

  • categoryIndex: number
  • withSounds: boolean

    includes all sound entries associated to that category
  • withIcons: boolean

    base64 encoded PNG

  Returns Promise<string>

  xml formatted category list

getCategoryJSON

• getCategoryJSON(categoryIndex, withSounds, withIcons): Promise<null | Category>

• Get a category identified by its index. Use getCategoriesJSON to get the index.

  Parameters

  • categoryIndex: number
  • withSounds: boolean

    includes all sound entries of each category into the response
  • withIcons: boolean

    base64 encoded PNGs

  Returns Promise<null | Category>

  category list

getMainFrameTitleText

• getMainFrameTitleText(): Promise<string>

• Returns Promise<string>

getPlayStatus

• getPlayStatus(): Promise<PlayStatus>

• Returns Promise<PlayStatus>

getPlaybackDuration

• getPlaybackDuration(): Promise<number>

• Returns duration of currently played sound file in milliseconds.

  Returns Promise<number>

getPlaybackPosition

• getPlaybackPosition(): Promise<number>

• Returns playback position of currently played sound file in milliseconds.

  Returns Promise<number>

getRecordingPeak

• getRecordingPeak(): Promise<number>

• Returns current recording peak.

  Returns Promise<number>

getRecordingPosition

• getRecordingPosition(): Promise<number>

• Returns recording position in milliseconds.

  Returns Promise<number>

getRemoteControlVersion

• getRemoteControlVersion(): Promise<string>

• Returns Promise<string>

getSoundFileCount

• getSoundFileCount(): Promise<number>

• Returns the total amount of sounds over all categories independent of currently selected category.

  Returns Promise<number>

getSoundListJSON

• getSoundListJSON(): Promise<Sound[]>

• Returns Promise<Sound[]>

getSoundlist

• getSoundlist(fromIndex?, toIndex?): Promise<string>

• Get a section of the sound list.

  Parameters

  • Optional fromIndex: number

    starts with 1
  • Optional toIndex: number

    the sound file at toIndex is included in the response

  Returns Promise<string>

  xml formatted sound list

  See

  getSoundlist()

getStatusBarText

• getStatusBarText(): Promise<string>

• Returns Promise<string>

getVersion

• getVersion(): Promise<string>

• Returns the version of Soundpad. Not the version of the remote control interface.

  Returns Promise<string>

getVolume

• getVolume(): Promise<number>

• Returns Promise<number>

  volume between 0 and 100.

isAlive

• isAlive(): Promise<boolean>

• Returns Promise<boolean>

  true if Soundpad is running and the remote control interface is accessible.

isMuted

• isMuted(): Promise<boolean>

• Returns Promise<boolean>

  true if the volume of the speakers is 0 or muted.

isTrial

• isTrial(): Promise<null | boolean>

• Returns Promise<null | boolean>

  true if the client is using the trial version, false if it is the full version or null if undermined.

jump

• jump(timeMillis): Promise<boolean>

• Use negative values to jump backwards.

  Parameters

  • timeMillis: number

    e.g. 5000 to jump 5 seconds forward.

  Returns Promise<boolean>

playCurrentSoundAgain

• playCurrentSoundAgain(): Promise<boolean>

• Returns Promise<boolean>

playNextSound

• playNextSound(): Promise<boolean>

• Returns Promise<boolean>

  See

  playPreviousSound()

playPreviousSound

• playPreviousSound(): Promise<boolean>

• Play previous sound in the list. The play mode is the same as it was for the last played file. Means, if a sound was played on speakers only, then this function will play on speakers only as well.

  Returns Promise<boolean>

playPreviouslyPlayedSound

• playPreviouslyPlayedSound(): Promise<boolean>

• Returns Promise<boolean>

playRandomSound

• playRandomSound(renderLine, captureLine): Promise<boolean>

• Let Soundpad play a random sound from any category.

  Parameters

  • renderLine: boolean

    set to true to play on speakers so you hear it.
  • captureLine: boolean

    set to true to play on microphone so others hear it.

  Returns Promise<boolean>

  true on success

playRandomSoundFromCategory

• playRandomSoundFromCategory(categoryIndex, renderLine, captureLine): Promise<boolean>

• Let Soundpad play a random sound from a particular category.

  Parameters

  • categoryIndex: number

    set to -1 to play a random sound from the currently selected category or use #getCategories(boolean, boolean) to find the index of a category.
  • renderLine: boolean

    set to true to play on speakers so you hear it.
  • captureLine: boolean

    set to true to play on microphone so others hear it.

  Returns Promise<boolean>

  true on success

playSelectedSound

• playSelectedSound(): Promise<boolean>

• Returns Promise<boolean>

playSound

• playSound(index): Promise<boolean>

• Play a sound by index.

  Parameters

  • index: number

    Get the index by calling getSoundlist first.

  Returns Promise<boolean>

  true on success
• playSound(index, renderLine, captureLine): Promise<boolean>

• Play a sound by index.

  Parameters

  • index: number

    Get the index by calling getSoundlist first.
  • renderLine: boolean

    set to true to play on speakers so you hear it.
  • captureLine: boolean

    set to true to play on microphone so others hear it.

  Returns Promise<boolean>

  true on success

playSoundFromCategory

• playSoundFromCategory(categoryIndex, soundIndex, renderLine, captureLine): Promise<boolean>

• Let Soundpad play a sound from a particular category.

  Parameters

  • categoryIndex: number

    set to -1 to play a sound from the currently selected category or use getCategories to find the index of a category.
  • soundIndex: number

    it's not the index as used in playSound, but the position in the category, e.g. 5 = 5th sound in the category.
  • renderLine: boolean

    set to true to play on speakers so you hear it.
  • captureLine: boolean

    set to true to play on microphone so others hear it.

  Returns Promise<boolean>

  true on success

redo

• redo(): Promise<boolean>

• Redo last action. Same as Edit > Redo in Soundpad.

  Returns Promise<boolean>

removeCategory

• removeCategory(categoryIndex): Promise<boolean>

• Remove a category identified by its index. Use getCategories to get the index.

  Parameters

  • categoryIndex: number

    The index of the category to be removed.

  Returns Promise<boolean>

  true on success

removeSelectedEntries

• removeSelectedEntries(removeOnDiskToo?): Promise<boolean>

• Parameters

  • removeOnDiskToo: boolean = false

  Returns Promise<boolean>

resetSearch

• resetSearch(): Promise<boolean>

• Closes search panel.

  Returns Promise<boolean>

saveSoundlist

• saveSoundlist(): Promise<boolean>

• Shows file selection dialog if sound list was never saved before.

  Returns Promise<boolean>

scrollBy

• scrollBy(rows): Promise<boolean>

• Scroll down or up by this many rows. Use negative values to scroll upwards.

  Parameters

  • rows: number

  Returns Promise<boolean>

scrollTo

• scrollTo(row): Promise<boolean>

• Scroll to a particular row.

  Parameters

  • row: number

  Returns Promise<boolean>

search

• search(searchTerm): Promise<boolean>

• Uses Soundpad's instant search to highlight sounds.

  Parameters

  • searchTerm: string

  Returns Promise<boolean>

seek

• seek(timeMillis): Promise<boolean>

• Jump to a particular position in the currently played sound.

  Parameters

  • timeMillis: number

    e.g. 5000 to jump to the 5th second of the sound.

  Returns Promise<boolean>

selectCategory

• selectCategory(categoryIndex): Promise<boolean>

• Select the category identified by its index. Use getCategories to get the index.

  Parameters

  • categoryIndex: number

    The index of the category to be selected.

  Returns Promise<boolean>

  true on success

selectNextCategory

• selectNextCategory(): Promise<boolean>

• Returns Promise<boolean>

selectNextHit

• selectNextHit(): Promise<boolean>

• Returns Promise<boolean>

  See

  selectPreviousHit()

selectPreviousCategory

• selectPreviousCategory(): Promise<boolean>

• Returns Promise<boolean>

selectPreviousHit

• selectPreviousHit(): Promise<boolean>

• Select previous search hit. Search is always wrapped. Means it starts again at the first hit if the last hit is reached.

  Returns Promise<boolean>

selectRow

• selectRow(row): Promise<boolean>

• Select the sound at the given row in the list. This method was created before categories were introduced, as such the row is not the sound index, but the position in the currently selected category.

  Parameters

  • row: number

  Returns Promise<boolean>

sendQuery

• sendQuery(query): Promise<string>

• Parameters

  • query: string

  Returns Promise<string>

setOptions

• setOptions(options): void

• Parameters

  • options: Partial<Options>

  Returns void

setVolume

• setVolume(volume): Promise<boolean>

• Change volume of the speakers.

  Parameters

  • volume: number

    a value between 0 and 100.

  Returns Promise<boolean>

startRecording

• startRecording(): Promise<boolean>

• Start recording. This call is handled the same way as if a recording is started by hotkeys, which means a notification sound is played. This is the default behavior, but the notification sound can be turned off in Soundpad.

  Returns Promise<boolean>

startRecordingMicrophone

• startRecordingMicrophone(): Promise<boolean>

• Start recording of the microphone. Method might fail if the speakers are currently being recorded. This call is handled the same way as if a recording is started by hotkeys, which means a notification sound is played. This is the default behavior, but the notification sound can be turned off in Soundpad.

  Returns Promise<boolean>

  true if recording was started or was already running

startRecordingSpeakers

• startRecordingSpeakers(): Promise<boolean>

• Start recording of the speakers. Method might fail if the microphone is currently being recorded. This call is handled the same way as if a recording is started by hotkeys, which means a notification sound is played. This is the default behavior, but the notification sound can be turned off in Soundpad.

  Returns Promise<boolean>

  true if recording was started or was already running

stopRecording

• stopRecording(): Promise<boolean>

• Returns Promise<boolean>

stopSound

• stopSound(): Promise<boolean>

• Returns Promise<boolean>

toggleMute

• toggleMute(): Promise<boolean>

• Mutes or unmutes speakers in Soundpad.

  Returns Promise<boolean>

togglePause

• togglePause(): Promise<boolean>

• Returns Promise<boolean>

undo

• undo(): Promise<boolean>

• Undo last action. Same as Edit > Undo in Soundpad.

  Returns Promise<boolean>

waitForStatus

• waitForStatus(status?, pollInterval?): Promise<void>

• Parameters

  • status: PlayStatus = PlayStatus.STOPPED

    The status to wait for (default: STOPPED)
  • pollInterval: number = 100

    The interval to poll the status (default: 100ms)

  Returns Promise<void>

  A promise that resolves when the status is reached