/* 
    P/P   *  Method: com.dmdirc.addons.nowplaying.MediaSource__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.addons.nowplaying;
    24  
    25  /**
    26   * The media source describes one source of "now playing" information
    27   * (i.e., one method of getting information from one media player).
    28   * 
    29   * @author chris
    30   */
    31  public interface MediaSource {
    32      /**
    33       * Get the state of this media source
    34       *
    35       * @return State for this media source.
    36       * @since 0.6.3m1
    37       */
    38      MediaSourceState getState();
    39      
    40      /**
    41       * Retrieves the name of the application that this source is for.
    42       * 
    43       * @return This source's application name
    44       */
    45      String getAppName();
    46      
    47      /**
    48       * Retrieves the artist of the curently loaded track.
    49       *
    50       * @return Current track artist
    51       */
    52      String getArtist();
    53      
    54      /**
    55       * Retrieves the title of the currently loaded track.
    56       *
    57       * @return Current track title
    58       */
    59      String getTitle();
    60      
    61      /**
    62       * Retrieves the album of the currently loaded track.
    63       *
    64       * @return Current track album
    65       */
    66      String getAlbum();
    67      
    68      /**
    69       * Retrieves the length of the currently loaded track ([h:]mm:ss).
    70       *
    71       * @return Current track length
    72       */
    73      String getLength();
    74      
    75      /**
    76       * Retrieves the time of the currently loaded track ([h:]mm:ss).
    77       *
    78       * @return Current track time
    79       */
    80      String getTime();
    81      
    82      /**
    83       * Retrives the format of the currently loaded track.
    84       *
    85       * @return Current track format
    86       */
    87      String getFormat();
    88      
    89      /**
    90       * Retrieves the bitrate of the currently loaded track.
    91       *
    92       * @return Current track bitrate
    93       */
    94      String getBitrate();
    95  
    96  }