Class Soundpad

Main SoundpadConnector class. Contains all methods for connection handling and requests

Inheritance

System.Object

Soundpad

Implements

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: SoundpadConnector

Assembly: SoundpadConnector.dll

Syntax

public class Soundpad : IDisposable

Constructors

| Improve this Doc View Source

Soundpad()

Declaration

public Soundpad()

Fields

| Improve this Doc View Source

AutoReconnect

Tries to reconnect when ungracefully closed

Declaration

public bool AutoReconnect

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

ConnectionStatus

Indicates the current connection state

Declaration

public ConnectionStatus ConnectionStatus

Field Value

Type	Description
ConnectionStatus

| Improve this Doc View Source

ConnectionTimeout

Defines the connection timeout to Soundpad

Declaration

public int ConnectionTimeout

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

PollingInterval

Defines polling interval to check the connection to Soundpad

Declaration

public int PollingInterval

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

ReconnectInterval

Defines the interval between AutoReconnect retries

Declaration

public int ReconnectInterval

Field Value

Type	Description
System.Int32

Methods

| Improve this Doc View Source

AddSound(String)

Adds a sound to soudlist

Declaration

public Task<NoContentResponse> AddSound(string path)

Parameters

Type	Name	Description
System.String	path	Absolute file path

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

AddSound(String, Int32)

Adds a sound to soudlist at given index

Declaration

public Task<NoContentResponse> AddSound(string path, int index)

Parameters

Type	Name	Description
System.String	path	Absolute file path
System.Int32	index

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

ConnectAsync()

Tries to establich a connection to Soundpad

Declaration

public Task ConnectAsync()

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

Disconnect()

Disconnects from Soundpad

Declaration

public void Disconnect()

| Improve this Doc View Source

Dispose()

Declaration

public void Dispose()

| Improve this Doc View Source

GetMainFrameTitleText()

TODO: Comment

Declaration

public Task<TextResponse> GetMainFrameTitleText()

Returns

Type	Description
System.Threading.Tasks.Task<TextResponse>

| Improve this Doc View Source

GetPlaybackDuration()

Gets current playback duration in milliseconds

Declaration

public Task<NumberResponse> GetPlaybackDuration()

Returns

Type	Description
System.Threading.Tasks.Task<NumberResponse>

| Improve this Doc View Source

GetPlaybackPosition()

Gets current playback position in milliseconds

Declaration

public Task<NumberResponse> GetPlaybackPosition()

Returns

Type	Description
System.Threading.Tasks.Task<NumberResponse>

| Improve this Doc View Source

GetPlayStatus()

Gets Playback status

Declaration

public Task<PlayStatusResponse> GetPlayStatus()

Returns

Type	Description
System.Threading.Tasks.Task<PlayStatusResponse>

| Improve this Doc View Source

GetRecordingPeak()

TODO: Comment

Declaration

public Task<NumberResponse> GetRecordingPeak()

Returns

Type	Description
System.Threading.Tasks.Task<NumberResponse>

| Improve this Doc View Source

GetRecordingPosition()

Gets current recording position in milliseconds

Declaration

public Task<NumberResponse> GetRecordingPosition()

Returns

Type	Description
System.Threading.Tasks.Task<NumberResponse>

| Improve this Doc View Source

GetSoundFileCount()

Gets sum of sounds

Declaration

public Task<NumberResponse> GetSoundFileCount()

Returns

Type	Description
System.Threading.Tasks.Task<NumberResponse>

| Improve this Doc View Source

GetSoundlist()

Gets current soundlist

Declaration

public Task<SoundlistResponse> GetSoundlist()

Returns

Type	Description
System.Threading.Tasks.Task<SoundlistResponse>

| Improve this Doc View Source

GetSoundlist(Int32)

Gets current soundlist

Declaration

public Task<SoundlistResponse> GetSoundlist(int fromIndex)

Parameters

Type	Name	Description
System.Int32	fromIndex

Returns

Type	Description
System.Threading.Tasks.Task<SoundlistResponse>

| Improve this Doc View Source

GetSoundlist(Int32, Int32)

Gets current soundlist

Declaration

public Task<SoundlistResponse> GetSoundlist(int fromIndex, int toIndex)

Parameters

Type	Name	Description
System.Int32	fromIndex
System.Int32	toIndex

Returns

Type	Description
System.Threading.Tasks.Task<SoundlistResponse>

| Improve this Doc View Source

GetStatusBarText()

TODO: Comment

Declaration

public Task<TextResponse> GetStatusBarText()

Returns

Type	Description
System.Threading.Tasks.Task<TextResponse>

| Improve this Doc View Source

GetVersion()

Get Soundpad's remote control version

Declaration

public Task<TextResponse> GetVersion()

Returns

Type	Description
System.Threading.Tasks.Task<TextResponse>

| Improve this Doc View Source

GetVolume()

Gets Soundpad's volume

Declaration

public Task<NumberResponse> GetVolume()

Returns

Type	Description
System.Threading.Tasks.Task<NumberResponse>

| Improve this Doc View Source

IsAlive()

Checks if connections is alive

Declaration

public Task<NoContentResponse> IsAlive()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

IsMuted()

Checks if Soundpad is muted

Declaration

public Task<BooleanResponse> IsMuted()

Returns

Type	Description
System.Threading.Tasks.Task<BooleanResponse>

| Improve this Doc View Source

Jump(Int32)

Jumps fowards or backwards. Use negative value to jump backwards.

Declaration

public Task<NoContentResponse> Jump(int milliseconds)

Parameters

Type	Name	Description
System.Int32	milliseconds

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

PlayNextSound()

Plays next sound

Declaration

public Task<NoContentResponse> PlayNextSound()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

PlayPreviousSound()

Plays previous sound

Declaration

public Task<NoContentResponse> PlayPreviousSound()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

PlaySound(Int32)

Plays sound

Declaration

public Task<NoContentResponse> PlaySound(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

PlaySound(Int32, Boolean, Boolean)

Declaration

public Task<NoContentResponse> PlaySound(int index, bool renderLine, bool captureLine)

Parameters

Type	Name	Description
System.Int32	index
System.Boolean	renderLine	Play on speaker
System.Boolean	captureLine	Play on microphone

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

Redo()

Redo

Declaration

public Task<NoContentResponse> Redo()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

RemoveSelectedEntries(Boolean)

Removes selected sounds from soundlist.

Declaration

public Task<NoContentResponse> RemoveSelectedEntries(bool removeFromDisk = false)

Parameters

Type	Name	Description
System.Boolean	removeFromDisk	If true, Soundpads asks for confirmation

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

ResetSearch()

Resets and hides search in Soundpad

Declaration

public Task<NoContentResponse> ResetSearch()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

SaveSoundlist()

Saves soundlist

Declaration

public Task<NoContentResponse> SaveSoundlist()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

Scroll(Int32)

Scrolls up or down in Soundpad. Use negative value to scroll up;

Declaration

public Task<NoContentResponse> Scroll(int rows)

Parameters

Type	Name	Description
System.Int32	rows

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

ScrollTo(Int32)

Scrolls to a sound in Soundpad.

Declaration

public Task<NoContentResponse> ScrollTo(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

Search(String)

Executes a search in Soundpad

Declaration

public Task<NoContentResponse> Search(string searchTerm)

Parameters

Type	Name	Description
System.String	searchTerm

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

SelectIndex(Int32)

Selects a sound in Soundpad

Declaration

public Task<NoContentResponse> SelectIndex(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

SelectNextHit()

Selects next search hit in Soundpad

Declaration

public Task<NoContentResponse> SelectNextHit()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

SelectPreviousHit()

Selects previous search hit in Soundpad

Declaration

public Task<NoContentResponse> SelectPreviousHit()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

SetVolume(Int32)

Sets volume

Declaration

public Task<NoContentResponse> SetVolume(int volume)

Parameters

Type	Name	Description
System.Int32	volume

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

StartRecording()

Starts recording

Declaration

public Task<NoContentResponse> StartRecording()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

StopRecording()

Stops recording

Declaration

public Task<NoContentResponse> StopRecording()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

StopSound()

Stopps playback

Declaration

public Task<NoContentResponse> StopSound()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

ToggleMute()

Toggles mute

Declaration

public Task<NoContentResponse> ToggleMute()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

TogglePause()

Toggles pause

Declaration

public Task<NoContentResponse> TogglePause()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

| Improve this Doc View Source

Undo()

Undo

Declaration

public Task<NoContentResponse> Undo()

Returns

Type	Description
System.Threading.Tasks.Task<NoContentResponse>

Events

| Improve this Doc View Source

Connected

Fires when connection to Soundpad is established

Declaration

public event EventHandler Connected

Event Type

Type	Description
System.EventHandler

| Improve this Doc View Source

Connecting

Fires when tries reconnect to Soundpad

Declaration

public event EventHandler Connecting

Event Type

Type	Description
System.EventHandler

| Improve this Doc View Source

Disconnected

Fires when connection to Soundpad is closed

Declaration

public event EventHandler<Soundpad.OnDisconnectedEventArgs> Disconnected

Event Type

Type	Description
System.EventHandler<Soundpad.OnDisconnectedEventArgs>

| Improve this Doc View Source

StatusChanged

Fires when the status changes

Declaration

public event EventHandler StatusChanged

Event Type

Type	Description
System.EventHandler

Implements

System.IDisposable