libmpdclient: /usr/src/extras/libmpdclient/libmpdclient-2.11-1.i686/src/libmpdclient-2.11/include/mpd/player.h File Reference

libmpdclient 2.11

Functions
player.h File Reference

MPD client library. More...

Go to the source code of this file.

## Functions
bool | mpd_send_current_song (struct mpd_connection *connection)
mpd_malloc struct mpd_song * | mpd_run_current_song (struct mpd_connection *connection)
bool | mpd_send_play (struct mpd_connection *connection)
bool | mpd_run_play (struct mpd_connection *connection)
bool | mpd_send_play_pos (struct mpd_connection *connection, unsigned song_pos)
bool | mpd_run_play_pos (struct mpd_connection *connection, unsigned song_pos)
bool | mpd_send_play_id (struct mpd_connection *connection, unsigned id)
bool | mpd_run_play_id (struct mpd_connection *connection, unsigned song_id)
bool | mpd_send_stop (struct mpd_connection *connection)
bool | mpd_run_stop (struct mpd_connection *connection)
bool | mpd_send_toggle_pause (struct mpd_connection *connection)
bool | mpd_run_toggle_pause (struct mpd_connection *connection)
bool | mpd_send_pause (struct mpd_connection *connection, bool mode)
bool | mpd_run_pause (struct mpd_connection *connection, bool mode)
bool | mpd_send_next (struct mpd_connection *connection)
bool | mpd_run_next (struct mpd_connection *connection)
bool | mpd_send_previous (struct mpd_connection *connection)
bool | mpd_run_previous (struct mpd_connection *connection)
bool | mpd_send_seek_pos (struct mpd_connection *connection, unsigned song_pos, unsigned t)
bool | mpd_run_seek_pos (struct mpd_connection *connection, unsigned song_pos, unsigned t)
bool | mpd_send_seek_id (struct mpd_connection *connection, unsigned id, unsigned t)
bool | mpd_run_seek_id (struct mpd_connection *connection, unsigned song_id, unsigned t)
bool | mpd_send_repeat (struct mpd_connection *connection, bool mode)
bool | mpd_run_repeat (struct mpd_connection *connection, bool mode)
bool | mpd_send_random (struct mpd_connection *connection, bool mode)
bool | mpd_run_random (struct mpd_connection *connection, bool mode)
bool | mpd_send_single (struct mpd_connection *connection, bool mode)
bool | mpd_run_single (struct mpd_connection *connection, bool mode)
bool | mpd_send_consume (struct mpd_connection *connection, bool mode)
bool | mpd_run_consume (struct mpd_connection *connection, bool mode)
bool | mpd_send_crossfade (struct mpd_connection *connection, unsigned seconds)
bool | mpd_run_crossfade (struct mpd_connection *connection, unsigned seconds)
bool | mpd_send_mixrampdb (struct mpd_connection *connection, float db)
bool | mpd_run_mixrampdb (struct mpd_connection *connection, float db)
bool | mpd_send_mixrampdelay (struct mpd_connection *connection, float seconds)
bool | mpd_run_mixrampdelay (struct mpd_connection *connection, float seconds)
bool | mpd_send_clearerror (struct mpd_connection *connection)
bool | mpd_run_clearerror (struct mpd_connection *connection)

## Detailed Description

MPD client library.

Controlling playback.

Do not include this header directly. Use mpd/client.h instead.

Definition in file player.h.

## Function Documentation

## ◆ mpd_send_current_song()

bool mpd_send_current_song | ( | struct mpd_connection * | connection | ) |

Fetches the currently selected song (the song referenced by status->song and status->songid).

## ◆ mpd_run_current_song()

mpd_malloc struct mpd_song* mpd_run_current_song | ( | struct mpd_connection * | connection | ) |

Shortcut for mpd_send_currentsong() and mpd_recv_song().

Parameters

  connection | the connection to MPD

Returns
  the current song, or NULL on error or if there is no current song

## ◆ mpd_send_play()

bool mpd_send_play | ( | struct mpd_connection * | connection | ) |

Starts playing the current song from the beginning.

Parameters

  connection | the connection to MPD

## ◆ mpd_run_play()

bool mpd_run_play | ( | struct mpd_connection * | connection | ) |

## ◆ mpd_send_play_pos()

bool mpd_send_play_pos | ( | struct mpd_connection * | connection,
|  | unsigned | song_pos
| ) |  |

Starts playing the specified song from the beginning.

Parameters

  song_pos | the position of the song in the queue
  connection | the connection to MPD

Returns
  true on success, false on error

## ◆ mpd_run_play_pos()

bool mpd_run_play_pos | ( | struct mpd_connection * | connection,
|  | unsigned | song_pos
| ) |  |

## ◆ mpd_send_play_id()

bool mpd_send_play_id | ( | struct mpd_connection * | connection,
|  | unsigned | id
| ) |  |

Starts playing the specified song from the beginning.

Parameters

  connection | the connection to MPD
  id | the id of the song

Returns
  true on success, false on error

## ◆ mpd_run_play_id()

bool mpd_run_play_id | ( | struct mpd_connection * | connection,
|  | unsigned | song_id
| ) |  |

## ◆ mpd_send_stop()

bool mpd_send_stop | ( | struct mpd_connection * | connection | ) |

## ◆ mpd_run_stop()

bool mpd_run_stop | ( | struct mpd_connection * | connection | ) |

## ◆ mpd_send_toggle_pause()

bool mpd_send_toggle_pause | ( | struct mpd_connection * | connection | ) |

Toggles the pause mode by sending "pause" without arguments.

Parameters

  connection | the connection to MPD

## ◆ mpd_run_toggle_pause()

bool mpd_run_toggle_pause | ( | struct mpd_connection * | connection | ) |

## ◆ mpd_send_pause()

bool mpd_send_pause | ( | struct mpd_connection * | connection,
|  | bool | mode
| ) |  |

## ◆ mpd_run_pause()

bool mpd_run_pause | ( | struct mpd_connection * | connection,
|  | bool | mode
| ) |  |

## ◆ mpd_send_next()

bool mpd_send_next | ( | struct mpd_connection * | connection | ) |

## ◆ mpd_run_next()

bool mpd_run_next | ( | struct mpd_connection * | connection | ) |

## ◆ mpd_send_previous()

bool mpd_send_previous | ( | struct mpd_connection * | connection | ) |

## ◆ mpd_run_previous()

bool mpd_run_previous | ( | struct mpd_connection * | connection | ) |

## ◆ mpd_send_seek_pos()

bool mpd_send_seek_pos | ( | struct mpd_connection * | connection,
|  | unsigned | song_pos,
|  | unsigned | t
| ) |  |

Seeks the specified song.

Parameters

  connection | the connection to MPD
  song_pos | the position of the song in the queue
  t | the position within the song, in seconds

Returns
  true on success, false on error

## ◆ mpd_run_seek_pos()

bool mpd_run_seek_pos | ( | struct mpd_connection * | connection,
|  | unsigned | song_pos,
|  | unsigned | t
| ) |  |

## ◆ mpd_send_seek_id()

bool mpd_send_seek_id | ( | struct mpd_connection * | connection,
|  | unsigned | id,
|  | unsigned | t
| ) |  |

Seeks the specified song.

Parameters

  connection | the connection to MPD
  id | the id of the song
  t | the position within the song, in seconds

Returns
  true on success, false on error

## ◆ mpd_run_seek_id()

bool mpd_run_seek_id | ( | struct mpd_connection * | connection,
|  | unsigned | song_id,
|  | unsigned | t
| ) |  |

## ◆ mpd_send_repeat()

bool mpd_send_repeat | ( | struct mpd_connection * | connection,
|  | bool | mode
| ) |  |

## ◆ mpd_run_repeat()

bool mpd_run_repeat | ( | struct mpd_connection * | connection,
|  | bool | mode
| ) |  |

## ◆ mpd_send_random()

bool mpd_send_random | ( | struct mpd_connection * | connection,
|  | bool | mode
| ) |  |

## ◆ mpd_run_random()

bool mpd_run_random | ( | struct mpd_connection * | connection,
|  | bool | mode
| ) |  |

## ◆ mpd_send_single()

bool mpd_send_single | ( | struct mpd_connection * | connection,
|  | bool | mode
| ) |  |

## ◆ mpd_run_single()

bool mpd_run_single | ( | struct mpd_connection * | connection,
|  | bool | mode
| ) |  |

## ◆ mpd_send_consume()

bool mpd_send_consume | ( | struct mpd_connection * | connection,
|  | bool | mode
| ) |  |

## ◆ mpd_run_consume()

bool mpd_run_consume | ( | struct mpd_connection * | connection,
|  | bool | mode
| ) |  |

## ◆ mpd_send_crossfade()

bool mpd_send_crossfade | ( | struct mpd_connection * | connection,
|  | unsigned | seconds
| ) |  |

## ◆ mpd_run_crossfade()

bool mpd_run_crossfade | ( | struct mpd_connection * | connection,
|  | unsigned | seconds
| ) |  |

## ◆ mpd_send_mixrampdb()

bool mpd_send_mixrampdb | ( | struct mpd_connection * | connection,
|  | float | db
| ) |  |

Since
  libmpdclient 2.2

## ◆ mpd_run_mixrampdb()

bool mpd_run_mixrampdb | ( | struct mpd_connection * | connection,
|  | float | db
| ) |  |

Since
  libmpdclient 2.2

## ◆ mpd_send_mixrampdelay()

bool mpd_send_mixrampdelay | ( | struct mpd_connection * | connection,
|  | float | seconds
| ) |  |

Since
  libmpdclient 2.2

## ◆ mpd_run_mixrampdelay()

bool mpd_run_mixrampdelay | ( | struct mpd_connection * | connection,
|  | float | seconds
| ) |  |

Since
  libmpdclient 2.2

## ◆ mpd_send_clearerror()

bool mpd_send_clearerror | ( | struct mpd_connection * | connection | ) |

Since
  libmpdclient 2.4

## ◆ mpd_run_clearerror()

bool mpd_run_clearerror | ( | struct mpd_connection * | connection | ) |

Since
  libmpdclient 2.4