← Back to branch summary

~cyphermox/bluez/5.23

« back to all changes in this revision

Viewing changes to doc/media-api.txt

  • Committer: Package Import Robot
  • Author(s): Nobuhiro Iwamatsu
  • Date: 2012-01-24 05:35:09 UTC
  • mfrom: (1.5.11) (7.1.6 experimental)
  • Revision ID: package-import@ubuntu.com-20120124053509-uwpwqi783lz08wm3
Tags: 4.98-1
* New upstream release.
* Update debian/bluetooth-dbus.conf.
* Update debian/control.
  Add Multi-Arch: foreign to bluez.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/media-api.txt
44
44
 
45
45
                        Unregister sender end point.
46
46
 
 
47
                void RegisterPlayer(object player, dict properties,
 
48
                                                                dict metadata)
 
49
 
 
50
                        Register a media player object to sender, the sender
 
51
                        can register as many objets as it likes.
 
52
 
 
53
                        Note: If the sender disconnects its objects are
 
54
                        automatically unregistered.
 
55
 
 
56
                        Properties:
 
57
 
 
58
                                string Equalizer:
 
59
 
 
60
                                        Possible values: "off" or "on"
 
61
 
 
62
                                string Repeat:
 
63
 
 
64
                                        Possible values: "off", "singletrack",
 
65
                                                        "alltracks" or "group"
 
66
 
 
67
                                string Shuffle:
 
68
 
 
69
                                        Possible values: "off", "alltracks" or
 
70
                                                        "group"
 
71
 
 
72
                                string Scan:
 
73
 
 
74
                                        Possible values: "off", "alltracks" or
 
75
                                                        "group"
 
76
 
 
77
                                string Status:
 
78
 
 
79
                                        Possible values: "playing", "stopped",
 
80
                                                        "paused",
 
81
                                                        "forward-seek",
 
82
                                                        "reverse-seek" or
 
83
                                                        "error"
 
84
 
 
85
                                uint32 Position
 
86
 
 
87
                                        Playback position in milliseconds
 
88
 
 
89
                        Metadata:
 
90
 
 
91
                                string Title:
 
92
 
 
93
                                        Track title name
 
94
 
 
95
                                string Artist:
 
96
 
 
97
                                        Track artist name
 
98
 
 
99
                                string Album:
 
100
 
 
101
                                        Track album name
 
102
 
 
103
                                string Genre:
 
104
 
 
105
                                        Track genre name
 
106
 
 
107
                                uint32 NumberOfTracks:
 
108
 
 
109
                                        Number of tracks in total
 
110
 
 
111
                                uint32 Number:
 
112
 
 
113
                                        Track number
 
114
 
 
115
                                uint32 Duration:
 
116
 
 
117
                                        Track duration in milliseconds
 
118
 
 
119
                        Possible Errors: org.bluez.Error.InvalidArguments
 
120
                                         org.bluez.Error.NotSupported
 
121
 
 
122
                void UnregisterPlayer(object player)
 
123
 
 
124
                        Unregister sender media player.
 
125
 
 
126
MediaPlayer hierarchy
 
127
=====================
 
128
 
 
129
Service         unique name
 
130
Interface       org.bluez.MediaPlayer
 
131
Object path     freely definable
 
132
 
 
133
Methods         void SetProperty(string property, variant value)
 
134
 
 
135
                        Changes the value of the specified property. Only
 
136
                        properties that are listed as read-write can be changed.
 
137
 
 
138
                        On success this will emit a PropertyChanged signal.
 
139
 
 
140
                void Release()
 
141
 
 
142
                        This method gets called when the service daemon
 
143
                        unregisters the player which can then perform
 
144
                        cleanup tasks. There is no need to unregister the
 
145
                        player, because when this method gets called it has
 
146
                        already been unregistered.
 
147
 
 
148
Signals         PropertyChanged(string setting, variant value)
 
149
 
 
150
                        This signal indicates a changed value of the given
 
151
                        property.
 
152
 
 
153
                TrackChanged(dict metadata)
 
154
 
 
155
                        This signal indicates that current track has changed.
 
156
                        All available metadata for the new track shall be set
 
157
                        at once in the metadata argument. Metadata cannot be
 
158
                        updated in parts, otherwise it will be interpreted as
 
159
                        multiple track changes.
 
160
 
 
161
                        Possible values:
 
162
 
 
163
                                string Title:
 
164
 
 
165
                                        Track title name
 
166
 
 
167
                                string Artist:
 
168
 
 
169
                                        Track artist name
 
170
 
 
171
                                string Album:
 
172
 
 
173
                                        Track album name
 
174
 
 
175
                                string Genre:
 
176
 
 
177
                                        Track genre name
 
178
 
 
179
                                uint32 NumberOfTracks:
 
180
 
 
181
                                        Number of tracks in total
 
182
 
 
183
                                uint32 Number:
 
184
 
 
185
                                        Track number
 
186
 
 
187
                                uint32 Duration:
 
188
 
 
189
                                        Track duration in milliseconds
 
190
 
 
191
Properties      string Equalizer [readwrite]
 
192
 
 
193
                        Possible values: "off" or "on"
 
194
 
 
195
                string Repeat [readwrite]
 
196
 
 
197
                        Possible values: "off", "singletrack", "alltracks" or
 
198
                                        "group"
 
199
 
 
200
                string Shuffle [readwrite]
 
201
 
 
202
                        Possible values: "off", "alltracks" or "group"
 
203
 
 
204
                string Scan [readwrite]
 
205
 
 
206
                        Possible values: "off", "alltracks" or "group"
 
207
 
 
208
                string Status [readonly]
 
209
 
 
210
                        Possible status: "playing", "stopped", "paused",
 
211
                                        "forward-seek", "reverse-seek" or
 
212
                                        "error"
 
213
 
 
214
                uint32 Position [readonly]
 
215
 
 
216
                        Playback position in milliseconds. Changing the
 
217
                        position may generate additional events that will be
 
218
                        sent to the remote device. When position is 0 it means
 
219
                        the track is starting and when it's greater than or
 
220
                        equal to track's duration the track has ended. Note
 
221
                        that even if duration is not available in metadata it's
 
222
                        possible to signal its end by setting position to the
 
223
                        maximum uint32 value.
 
224
 
47
225
MediaEndpoint hierarchy
48
226
=======================
49
227