summaryrefslogtreecommitdiff
path: root/libmpd/playbackcontrol.rb
blob: 1e7a9c4bc6a304031cc5c01e84bff74870ab249d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
#!/usr/bin/env ruby
#
#--
# Copyright 2009 David Vazgenovich Shakaryan <dvshakaryan@gmail.com>
# Distributed under the terms of the GNU General Public License v3.
# See http://www.gnu.org/licenses/gpl.txt for the full license text.
#++
#
# *Author*:: David Vazgenovich Shakaryan
# *License*:: GNU General Public License v3

# Collection of methods related to playback control.
module MPDPlaybackControl
  # Plays the next song in the playlist.
  def next
    return send_request('next')
  end

  # Sets pause state.
  #
  # Accepts an argument of +true+ to enable or +false+ to disable.
  # If no argument is given, defaults to +true+.
  def pause(state=true)
    return send_request('pause %s' % state.to_i)
  end

  # Returns +true+ if paused.
  # Otherwise, returns +false+.
  def paused?
    return true if status[:state] == 'pause'
    return false
  end

  # Begins playing the playlist. If an argument is given, begins at the
  # specified song position.
  def play(songpos=nil)
    command = 'play'
    command << ' %s' % songpos if songpos

    return send_request(command)
  end

  # Begins playing the playlist. If an argument is given, begins at the
  # specified song id.
  def playid(songid=nil)
    command = 'playid'
    command << ' %s' % songid if songid

    return send_request(command)
  end

  # Returns +true+ if playing.
  # Otherwise, returns +false+.
  def playing?
    return true if status[:state] == 'play'
    return false
  end

  # Plays the previous song in the playlist.
  def previous
    return send_request('previous')
  end

  # Seeks to the given position of the current song.
  # Accepts an argument of seconds.
  def seek(time)
    return send_request('seek %s %s' % [status[:song], time])
  end

  # Stops playing.
  def stop
    return send_request('stop')
  end

  # Returns +true+ if stopped.
  # Otherwise, returns +false+.
  def stopped?
    return true if status[:state] == 'stop'
    return false
  end
end