Skip to content

Commit

Permalink
Update documentation comments
Browse files Browse the repository at this point in the history
  • Loading branch information
dsafa committed Dec 2, 2018
1 parent 0843e5c commit 1b23e9d
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions src/AudioBand.AudioSource/IAudioSource.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,21 @@
namespace AudioBand.AudioSource
{
/// <summary>
/// Provides information from an audio source and exposes controls
/// Provides information and notifies changes from an audio source and exposes playback controls.
/// </summary>
[InheritedExport(typeof(IAudioSource))]
public interface IAudioSource
{
/// <summary>
/// Name of the audio source which is displayed
/// Gets the name of the audio source.
/// </summary>
/// <value>The name of the audio source.</value>
string Name { get; }

/// <summary>
/// Audio source logger that will be injected
/// Gets or sets the <see cref="IAudioSourceLogger"/> used for logging.
/// </summary>
/// <value>Audio source logger that will be injected.</value>
IAudioSourceLogger Logger { get; set; }

/// <summary>
Expand All @@ -27,52 +29,52 @@ public interface IAudioSource
event EventHandler<SettingChangedEventArgs> SettingChanged;

/// <summary>
/// Track information has changed
/// Occurs when track information has changed.
/// </summary>
event EventHandler<TrackInfoChangedEventArgs> TrackInfoChanged;

/// <summary>
/// Track is now playing
/// Occurs when the playback state has changed to playing.
/// </summary>
event EventHandler TrackPlaying;

/// <summary>
/// Track is paused
/// Occurs when the playback state has changed to paused.
/// </summary>
event EventHandler TrackPaused;

/// <summary>
/// Track progress has changed to the current song duration
/// Occurs when the current track progress has changed.
/// </summary>
event EventHandler<TimeSpan> TrackProgressChanged;

/// <summary>
/// This audio source has been selected
/// Called when the audio source is active.
/// </summary>
Task ActivateAsync(CancellationToken cancellationToken = default(CancellationToken));

/// <summary>
/// The audio source is no longer active
/// Called when the audio source is no longer active.
/// </summary>
Task DeactivateAsync(CancellationToken cancellationToken = default(CancellationToken));

/// <summary>
/// User requested to play the track. This should trigger <see cref="TrackPlaying"/> if successful
/// Called when there is a request to start playback.
/// </summary>
Task PlayTrackAsync(CancellationToken cancellationToken = default(CancellationToken));

/// <summary>
/// User requested to pause the track. This should trigger <see cref="TrackPaused"/> if successful
/// Called when there is a request to stop playback.
/// </summary>
Task PauseTrackAsync(CancellationToken cancellationToken = default(CancellationToken));

/// <summary>
/// User requested the previous track
/// Called when there is a request to skip to the previous track.
/// </summary>
Task PreviousTrackAsync(CancellationToken cancellationToken = default(CancellationToken));

/// <summary>
/// User requested the next track
/// Called when there is a request to skip to the next track.
/// </summary>
Task NextTrackAsync(CancellationToken cancellationToken = default(CancellationToken));
}
Expand Down

0 comments on commit 1b23e9d

Please sign in to comment.