Return-Path: From: Lucas De Marchi To: linux-bluetooth@vger.kernel.org Cc: Lucas De Marchi Subject: [PATCH v4 22/22] Update Control documentation Date: Thu, 11 Aug 2011 12:53:33 -0300 Message-Id: <1313078013-19103-23-git-send-email-lucas.demarchi@profusion.mobi> In-Reply-To: <1313078013-19103-1-git-send-email-lucas.demarchi@profusion.mobi> References: <1313078013-19103-1-git-send-email-lucas.demarchi@profusion.mobi> Sender: linux-bluetooth-owner@vger.kernel.org List-ID: Move methods and signal to an experimental interface named MediaPlayer as currently implemented. --- doc/control-api.txt | 94 +++++++++++++++++++++++++------------------------- 1 files changed, 47 insertions(+), 47 deletions(-) diff --git a/doc/control-api.txt b/doc/control-api.txt index 1a42846..a7e5cbb 100644 --- a/doc/control-api.txt +++ b/doc/control-api.txt @@ -45,44 +45,6 @@ Methods void Connect() Metadata or Events defined in the AVRCP+Metadata specification. - void ChangePlayback(string status, uint32 elapsed) - - The status can be "playing", "stopped", "paused", - "forward-seek", "reverse-seek" or "error". Elapsed is - the position within the track in milliseconds. - - void ChangeTrack(dict metadata) - - Called to send the mandated TrackChange event and - potential metadata information. - - Current defined metadata information are represented - with the following keys: - - Title string (mandatory) - Artist string - Album string - Genre string - NumberOfTracks uint32 - TrackNumber uint32 - TrackDuration uint32 (in milliseconds) - - void ChangeSetting(string setting, variant value) - - Called to transmit Application Settings, CT Status - and the like. - - Currenet defined settings are represented with the - following keys: - - Equalizer off, on - Repeat off, singletrack, alltracks, group - Shuffle off, alltracks, group - Scan off, alltracks, group - Battery normal, warning, critical, external, fullcharge - System powered, unpowered, unplugged - Volume uint8 - Signals Connected() Sent when a successful AVRCP connection has been made @@ -112,15 +74,6 @@ Signals Connected() connected device (except for Metadata defined in Bluetooth SIG AVRCP+Metadata spec). - TrackChanged(dict metadata) - - Called when Metadata is received from connected device. - May be multiple meta attribute/element pairs. - - PlaybackChanged(string status, uint32 elapsed) - - SettingChanged(string setting, variant value) - Properties uint8 SubUnitID [readonly] The three-bit Subunit ID from the connected device. @@ -140,3 +93,50 @@ Properties uint8 SubUnitID [readonly] array{string} Capabilities [readonly] List of Capabilities provided by the connected device. + + +MediaPlayer hierarchy [experimental] +===================== + +Service org.bluez +Interface org.bluez.MediaPlayer +Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX + +Methods void ChangePlayback(string status, uint32 elapsed) + + The status can be "playing", "stopped", "paused", + "forward-seek", "reverse-seek" or "error". Elapsed is + the position within the track in milliseconds. + + void ChangeTrack(dict metadata) + + Called to send the mandated TrackChange event and + potential metadata information. + + Current defined metadata information are represented + with the following keys: + + Title string (mandatory) + Artist string + Album string + Genre string + NumberOfTracks uint32 + TrackNumber uint32 + TrackDuration uint32 (in milliseconds) + + void SetProperty(string property, variant value) + + Called to set the media-player's properties + + Current defined properties are represented with the + following keys and values: + + Equalizer off, on + Repeat off, singletrack, alltracks, group + Shuffle off, alltracks, group + Scan off, alltracks, group + +Signals PropertyChanged(string setting, variant value) + + Called when one of the settings are changed by the + remote device or to inform its battery status. -- 1.7.6