Class Xmms::Client
In: rb_xmmsclient_main.c
Parent: Object

if it’s not an array, it must be a string

Methods

bindata_add   bindata_list   bindata_remove   bindata_retrieve   broadcast_coll_changed   broadcast_config_value_changed   broadcast_mediainfo_reader_status   broadcast_medialib_entry_added   broadcast_medialib_entry_changed   broadcast_playback_current_id   broadcast_playback_status   broadcast_playback_volume_changed   broadcast_playlist_changed   broadcast_playlist_current_pos   broadcast_playlist_loaded   broadcast_quit   coll_find   coll_get   coll_idlist_from_playlist_file   coll_list   coll_query_ids   coll_query_info   coll_remove   coll_rename   coll_save   config_get_value   config_list_values   config_register_value   config_set_value   connect   io_disconnect   io_fd   io_in_handle   io_on_need_out   io_out_handle   io_want_out   last_error   main_stats   medialib_add_entry   medialib_entry_move   medialib_entry_property_remove   medialib_entry_property_set   medialib_entry_remove   medialib_get_id   medialib_get_info   medialib_path_import   medialib_rehash   new   on_disconnect   playback_current_id   playback_pause   playback_playtime   playback_seek_ms   playback_seek_ms_rel   playback_seek_samples   playback_seek_samples_rel   playback_start   playback_status   playback_stop   playback_tickle   playback_volume_get   playback_volume_set   playlist   playlist_current_active   playlist_list   playlist_set_next   playlist_set_next_rel   plugin_list   quit   signal_mediainfo_reader_unindexed   signal_playback_playtime   xform_media_browse  

Classes and Modules

Class Xmms::Client::ClientError
Class Xmms::Client::DisconnectedError

Constants

PLAY = INT2FIX (XMMS_PLAYBACK_STATUS_PLAY)
STOP = INT2FIX (XMMS_PLAYBACK_STATUS_STOP)
PAUSE = INT2FIX (XMMS_PLAYBACK_STATUS_PAUSE)
IDLE = INT2FIX (XMMS_MEDIAINFO_READER_STATUS_IDLE)
RUNNING = INT2FIX (XMMS_MEDIAINFO_READER_STATUS_RUNNING)
ALL_PLUGINS = INT2FIX (XMMS_PLUGIN_TYPE_ALL)
XFORM = INT2FIX (XMMS_PLUGIN_TYPE_XFORM)
OUTPUT = INT2FIX (XMMS_PLUGIN_TYPE_OUTPUT)
ENTRY_STATUS_NEW = INT2FIX (XMMS_MEDIALIB_ENTRY_STATUS_NEW)
ENTRY_STATUS_OK = INT2FIX (XMMS_MEDIALIB_ENTRY_STATUS_OK)
ENTRY_STATUS_RESOLVING = INT2FIX (XMMS_MEDIALIB_ENTRY_STATUS_RESOLVING)
ENTRY_STATUS_NOT_AVAILABLE = INT2FIX (XMMS_MEDIALIB_ENTRY_STATUS_NOT_AVAILABLE)
ENTRY_STATUS_REHASH = INT2FIX (XMMS_MEDIALIB_ENTRY_STATUS_REHASH)

Public Class methods

Public Instance methods

Stores binary data on the server.

List all bindata hashes stored on the server.

Remove a datafile from the server.

Retrieves the bindata entry specified by hash (hex string) from the server.

The collection_changed broadcast, if requested, is called anytime a collection is altered.

Retrieves configuration properties as a broadcast.

Requests the status of the mediainfo reader.

Retrieves the id of an added medialib entry as a broadcast.

Retrieves the id of a changed medialib entry as a broadcast.

Retrieves the media id of the currently played track as a broadcast.

Retrieves the playback status as a broadcast.

Registers a broadcast handler that’s evoked when the playback volume changes.

Retrieves a hash describing the change to the playlist as a broadcast.

Retrieves the current playlist position as a broadcast. See playlist_current_pos.

Will be called when a playlist has been loaded.

Will be called when the server is terminating.

Find all collections in the given namespace ns which contain id.

Returns a result containing an Xmms::Collection object referencing the collection named name. The namespace ns is searched or all namespaces if unspecified.

Returns a collection of the idlist type from the playlist file at path. path must be an unencoded string.

Retrieves an array of the names of all the collections stored in the medialib under the namespace ns. If ns is not specified, it defaults to ALL.

Retrieves a list of all the ids of media matched by the collection. order specifies a list of properties to order by or no order if omitted. start and len determine the offset at which to start retrieving ids and the maximum number of ids to retrieve, respectively.

Retrieves media info of media matched by the collection. fetch should contain an array of properties to retrieve from the collection. order specifies a list of properties to order by or no order if omitted. start and len determine the offset at which to start retrieving info and the maximum number of ids to retrieve, respectively. group defines a list of properties to group by or no grouping if omitted.

Remove the collection named name from the media library. The collection is removed from the namespace ns or all namespaces if unspecified.

Rename the saved collection from old to new within the namespace ns or all namespaces.

Save the collection coll named name under the namespace ns to the media library.

Retrieves the value of the configuration property at key.

Retrieves a list of all config values.

Registers a configuration property at key with the given default value.

Sets the value of the configuration property at key to value.

Connects xc to the XMMS2 daemon listening at path. If path isn’t given, the default path is used.

Disconnects the IPC socket. This should only be used by event loop implementations.

Returns the file descriptor of the Xmms::Client IPC socket.

Retrieves one incoming (from server) clientlib command if there are any in the buffer.

Sets the block that’s called when the output socket state changes.

Sends one outgoing (to server) clientlib command. You should check Xmms::Client#io_want_out before calling this method.

Returns true if an outgoing (to server) clientlib command is pending, false otherwise.

Returns the last error that occured in xc or nil, if no error occured yet.

Retrieves a hash containing statistics about the daemon.

Adds url to the medialib.

Moves the entry specified by id to a new URL without changing mediainfo.

Remove a custom field in the medialib associated with the entry id. source is an optional argument that describes where to write the mediainfo. If source is omitted, “client/” is used, where is the name you specified in _Xmms::Client.new(name)_.

Write info to the medialib at id. source is an optional argument that describes where to write the mediainfo. If source is omitted, the mediainfo is written to “client/” where is the name you specified in _Xmms::Client.new(name)_.

Removes the entry specified by id from the medialib.

Retrieves the id corresponding to url.

Retrieves medialib info for id.

Recursively imports all media files under path to the medialib.

Rehashes the medialib entry at id or the whole medialib if id == 0.

Sets the block that’s executed when xc is disconnected from the XMMS2 daemon.

Retrieves the media id of the currently played track.

Retrieves the playtime.

Seek to the song position given in ms.

Seek in the song by the offset given in ms.

Seek to the song position given in samples.

Seek in the song position by the offset given in samples.

Retrieves the playback status.

Advances to the next playlist entry.

Gets the current playback volume.

Sets playback volume for channel to volume.

Shortcut for Xmms::Playlist#new(xc, [name]). Creates a new Xmms::Playlist object tied to the current Xmms::Client instance. name is is the name of the playlist and the active playlist will be used if it is not specified. Raises PlaylistError if the playlist name is invalid.

Retrieves the name of the active playlist.

Retrieves a list of all saved playlists from the medialib. Note that clients should treat internally used playlists (marked with a leading underscore) carefully.

Sets the next song to be played to pos (an absolute position).

Sets the next song to be played based on the current position where pos is a value relative to the current position.

Retrieves an array containing a hash of information for each plugin.

Shuts down the XMMS2 daemon.

Requests the number of unindexed entries in the medialib.

Retrieves the playtime as a signal.

returns a list of files from the server

[Validate]