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()
Assembly: SoundpadConnector.dll
Syntax
public class Soundpad : IDisposable
Constructors
|
Improve this Doc
View Source
Soundpad()
Declaration
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
|
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)
Declaration
public Task<NoContentResponse> AddSound(string path)
Parameters
Type |
Name |
Description |
System.String |
path |
Absolute file path
|
Returns
|
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
|
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
|
Improve this Doc
View Source
Dispose()
Declaration
|
Improve this Doc
View Source
GetMainFrameTitleText()
Declaration
public Task<TextResponse> GetMainFrameTitleText()
Returns
|
Improve this Doc
View Source
GetPlaybackDuration()
Gets current playback duration in milliseconds
Declaration
public Task<NumberResponse> GetPlaybackDuration()
Returns
|
Improve this Doc
View Source
GetPlaybackPosition()
Gets current playback position in milliseconds
Declaration
public Task<NumberResponse> GetPlaybackPosition()
Returns
|
Improve this Doc
View Source
GetPlayStatus()
Declaration
public Task<PlayStatusResponse> GetPlayStatus()
Returns
|
Improve this Doc
View Source
GetRecordingPeak()
Declaration
public Task<NumberResponse> GetRecordingPeak()
Returns
|
Improve this Doc
View Source
GetRecordingPosition()
Gets current recording position in milliseconds
Declaration
public Task<NumberResponse> GetRecordingPosition()
Returns
|
Improve this Doc
View Source
GetSoundFileCount()
Declaration
public Task<NumberResponse> GetSoundFileCount()
Returns
|
Improve this Doc
View Source
GetSoundlist()
Declaration
public Task<SoundlistResponse> GetSoundlist()
Returns
|
Improve this Doc
View Source
GetSoundlist(Int32)
Declaration
public Task<SoundlistResponse> GetSoundlist(int fromIndex)
Parameters
Type |
Name |
Description |
System.Int32 |
fromIndex |
|
Returns
|
Improve this Doc
View Source
GetSoundlist(Int32, Int32)
Declaration
public Task<SoundlistResponse> GetSoundlist(int fromIndex, int toIndex)
Parameters
Type |
Name |
Description |
System.Int32 |
fromIndex |
|
System.Int32 |
toIndex |
|
Returns
|
Improve this Doc
View Source
GetStatusBarText()
Declaration
public Task<TextResponse> GetStatusBarText()
Returns
|
Improve this Doc
View Source
GetVersion()
Get Soundpad's remote control version
Declaration
public Task<TextResponse> GetVersion()
Returns
|
Improve this Doc
View Source
GetVolume()
Declaration
public Task<NumberResponse> GetVolume()
Returns
|
Improve this Doc
View Source
IsAlive()
Checks if connections is alive
Declaration
public Task<NoContentResponse> IsAlive()
Returns
|
Improve this Doc
View Source
IsMuted()
Checks if Soundpad is muted
Declaration
public Task<BooleanResponse> IsMuted()
Returns
|
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
|
Improve this Doc
View Source
PlayNextSound()
Declaration
public Task<NoContentResponse> PlayNextSound()
Returns
|
Improve this Doc
View Source
PlayPreviousSound()
Declaration
public Task<NoContentResponse> PlayPreviousSound()
Returns
|
Improve this Doc
View Source
PlaySound(Int32)
Declaration
public Task<NoContentResponse> PlaySound(int index)
Parameters
Type |
Name |
Description |
System.Int32 |
index |
|
Returns
|
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
|
Improve this Doc
View Source
Redo()
Declaration
public Task<NoContentResponse> Redo()
Returns
|
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
|
Improve this Doc
View Source
ResetSearch()
Resets and hides search in Soundpad
Declaration
public Task<NoContentResponse> ResetSearch()
Returns
|
Improve this Doc
View Source
SaveSoundlist()
Declaration
public Task<NoContentResponse> SaveSoundlist()
Returns
|
Improve this Doc
View Source
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
|
Improve this Doc
View Source
Scrolls to a sound in Soundpad.
Declaration
public Task<NoContentResponse> ScrollTo(int index)
Parameters
Type |
Name |
Description |
System.Int32 |
index |
|
Returns
|
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
|
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
|
Improve this Doc
View Source
SelectNextHit()
Selects next search hit in Soundpad
Declaration
public Task<NoContentResponse> SelectNextHit()
Returns
|
Improve this Doc
View Source
SelectPreviousHit()
Selects previous search hit in Soundpad
Declaration
public Task<NoContentResponse> SelectPreviousHit()
Returns
|
Improve this Doc
View Source
SetVolume(Int32)
Declaration
public Task<NoContentResponse> SetVolume(int volume)
Parameters
Type |
Name |
Description |
System.Int32 |
volume |
|
Returns
|
Improve this Doc
View Source
StartRecording()
Declaration
public Task<NoContentResponse> StartRecording()
Returns
|
Improve this Doc
View Source
StopRecording()
Declaration
public Task<NoContentResponse> StopRecording()
Returns
|
Improve this Doc
View Source
StopSound()
Declaration
public Task<NoContentResponse> StopSound()
Returns
|
Improve this Doc
View Source
ToggleMute()
Declaration
public Task<NoContentResponse> ToggleMute()
Returns
|
Improve this Doc
View Source
TogglePause()
Declaration
public Task<NoContentResponse> TogglePause()
Returns
|
Improve this Doc
View Source
Undo()
Declaration
public Task<NoContentResponse> Undo()
Returns
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
|
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