summaryrefslogtreecommitdiffstats
path: root/bindings/python/gpod_doc.i.in
blob: fa25c122ee8cfdb2c71de65ecc1436472ebb0f66 (plain)
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
82
83
84
85
86
%feature("autodoc", "1");

%feature("autodoc", "sw_get_tracks(Itdb_iTunesDB itdb) -> [Itdb_Track, ...]") sw_get_tracks;
%feature("docstring", "
Get tracks in itdb.

Parameters
itdb: an Itdb_iTunesDB
Returns: a list of Itdb_Track objects
") sw_get_tracks;

%feature("autodoc", "sw_get_track(GList list, gint index) -> Itdb_Track") sw_get_track;
%feature("docstring", "
Get a track

Parameters
list: a GList
index: position of the track
Returns: an Itdb_Track
") sw_get_track;

%feature("autodoc", "sw_get_rule(GList list, gint index) -> SPLRule") sw_get_rule;
%feature("docstring", "
Get a rule

Parameters
list: a GList
index: position of the rule
Returns: an SPLRule
") sw_get_rule;

%feature("autodoc", "sw_get_playlist(GList list, gint index) -> Itdb_Playlist") sw_get_playlist;
%feature("docstring", "
Get a playlist

Parameters
list: a GList
index: position of the playlist
Returns: an Itdb_Playlist
") sw_get_playlist;

%feature("autodoc", "sw_get_list_len(GList list) -> Int") sw_get_list_len;
%feature("docstring", "
Get the length of list

Parameters
list: a GList
Returns: length of list
") sw_get_list_len;

%feature("autodoc", "sw_get_playlists(Itdb_iTunesDB itdb) -> [Itdb_Playlist, ...]") sw_get_playlists;
%feature("docstring", "
Get playlists

Parameters
itdb: an Itdb_iTunesDB
Returns: a list of Itdb_Playlist objects
") sw_get_playlists;

%feature("autodoc", "sw_get_playlist_tracks(Itdb_Playlist pl) -> [Itdb_Track, ...]") sw_get_playlist_tracks;
%feature("docstring", "
Get tracks in playlist

pl: an Itdb_Playlist
Returns: a list of Itdb_Track objects
") sw_get_playlist_tracks;

%feature("autodoc", "sw_set_track_userdata(Itdb_Track track, Dictionary userdata)") sw_set_track_userdata;
%feature("docstring", "
Set a tracks userdata

Parameters
track: an Itdb_Track
userdata: a dictionary.  Note that userdata can be None, in order to
clear all userdata.
") sw_set_track_userdata;

%feature("autodoc", "sw_get_track_userdata(Itdb_Track track) -> Dictionary") sw_get_track_userdata;
%feature("docstring", "
Get track userdata

Parameters
track: an Itdb_Track
Returns: a dictionary containing any userdata for track
") sw_get_track_userdata;