From patchwork Thu Sep 12 17:49:21 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?q?Fr=C3=A9d=C3=A9ric_Danis?= X-Patchwork-Id: 13802398 Received: from bali.collaboradmins.com (bali.collaboradmins.com [148.251.105.195]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 82B801BF816 for ; Thu, 12 Sep 2024 17:49:33 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=148.251.105.195 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726163375; cv=none; b=LLNgxcOArc+lJvDyKKaz7ZrcOSJ0mOQKy+4W3fN7ryxBf2O94X2VX65v9nsA6Jhj9lThcGu3oRGy+kvEseNKi08AzcNN9Ha2WrcUvNqz//1cq8nwB5qfOa7BJIWn5qRaOvkCII32YB7uZz28JJdjjo1mUIGN1Xb1/klBsfNFUnE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726163375; c=relaxed/simple; bh=+2E/LBspo2lEbn9xn4wjGnU8xzAnWjQXYvtZIfdyxnk=; h=From:To:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version:Content-Type; b=FUlx8MlnElz6vQpGnTyEEM2LjaKtS4OAnE5uIY0xsINqSih75nfy+PE48sFxV9MpkQe3rPk665vwxj4t5ZJssuU2TQca45kSoCheCgtVgaynsvN6jDosG2beXxjCAcYLWzs6OetzeKoy88DuuHnRnofzXcv4mMkuFF14WHaAfKo= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=collabora.com; spf=pass smtp.mailfrom=collabora.com; dkim=pass (2048-bit key) header.d=collabora.com header.i=@collabora.com header.b=m6U1swF6; arc=none smtp.client-ip=148.251.105.195 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=collabora.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=collabora.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=collabora.com header.i=@collabora.com header.b="m6U1swF6" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1726163369; bh=+2E/LBspo2lEbn9xn4wjGnU8xzAnWjQXYvtZIfdyxnk=; h=From:To:Subject:Date:In-Reply-To:References:From; b=m6U1swF6LADtaKzLGcQ9894uUsdRJ+LZl1yBuKqQ7vSTrbt2Vljam00QK3s9xO5n+ SOozNjPmZD0GkxI5NO7D9iGpj/8crYW+fLPtEIp969KT5aQfkL37r2FBcrygDbWPC4 81okOnq5FimymbXvOAPWkTRK8dUGxj0EKIsOzLzgUlRfDri1agk+tdWxvouSNSvABo woUpKZRwWlZwd76ydyiooWcEZxlOriq+45OO0hSOHK641At+hva+O/rVWlM7NvI2Qk I00pDtV84sHlKH2gp0mz9cb1FiGXDHSWtcWvcWZ0WOc3EY4rZtKNBWzTQ9JbI208QD 9en9F3Uv8aTvg== Received: from fdanis-XPS-13-9370.. (67.227.121.78.rev.sfr.net [78.121.227.67]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: fdanis) by bali.collaboradmins.com (Postfix) with ESMTPSA id 58B0B17E3607 for ; Thu, 12 Sep 2024 19:49:29 +0200 (CEST) From: =?utf-8?q?Fr=C3=A9d=C3=A9ric_Danis?= To: linux-bluetooth@vger.kernel.org Subject: [PATCH BlueZ v2 7/7] doc: Add description of org.bluez.obex.BipAvrcp Date: Thu, 12 Sep 2024 19:49:21 +0200 Message-Id: <20240912174921.386856-8-frederic.danis@collabora.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240912174921.386856-1-frederic.danis@collabora.com> References: <20240912174921.386856-1-frederic.danis@collabora.com> Precedence: bulk X-Mailing-List: linux-bluetooth@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 This new interface allows to get the image referenced in the audio metadata ImgHandle available in org.bluez.MediaPlayer track properties. The image handle is only available in track info if an OBEX session is connected to the ObexPort port provided in org.bluez.MediaPlayer properties. --- v1 -> v2: Set new interface as experimental Makefile.am | 9 +++-- doc/org.bluez.obex.BipAvrcp.rst | 72 +++++++++++++++++++++++++++++++++ doc/org.bluez.obex.Client.rst | 1 + 3 files changed, 79 insertions(+), 3 deletions(-) create mode 100644 doc/org.bluez.obex.BipAvrcp.rst diff --git a/Makefile.am b/Makefile.am index 88044aa05..3a9728782 100644 --- a/Makefile.am +++ b/Makefile.am @@ -382,7 +382,8 @@ man_MANS += doc/org.bluez.obex.Client.5 doc/org.bluez.obex.Session.5 \ doc/org.bluez.obex.PhonebookAccess.5 \ doc/org.bluez.obex.MessageAccess.5 \ doc/org.bluez.obex.Message.5 \ - doc/org.bluez.obex.AgentManager.5 doc/org.bluez.obex.Agent.5 + doc/org.bluez.obex.AgentManager.5 doc/org.bluez.obex.Agent.5 \ + doc/org.bluez.obex.BipAvrcp.5 endif manual_pages += src/bluetoothd.8 manual_pages += doc/l2cap.7 doc/rfcomm.7 @@ -415,7 +416,8 @@ manual_pages += doc/org.bluez.obex.Client.5 doc/org.bluez.obex.Session.5 \ doc/org.bluez.obex.PhonebookAccess.5 \ doc/org.bluez.obex.MessageAccess.5 \ doc/org.bluez.obex.Message.5 \ - doc/org.bluez.obex.AgentManager.5 doc/org.bluez.obex.Agent.5 + doc/org.bluez.obex.AgentManager.5 doc/org.bluez.obex.Agent.5 \ + doc/org.bluez.obex.BipAvrcp.5 EXTRA_DIST += src/genbuiltin src/bluetooth.conf \ src/main.conf profiles/network/network.conf \ @@ -497,7 +499,8 @@ EXTRA_DIST += doc/org.bluez.obex.Client.rst doc/org.bluez.obex.Session.rst \ doc/org.bluez.obex.PhonebookAccess.rst \ doc/org.bluez.obex.MessageAccess.rst \ doc/org.bluez.obex.Message.rst \ - doc/org.bluez.obex.AgentManager.rst doc/org.bluez.obex.Agent.rst + doc/org.bluez.obex.AgentManager.rst doc/org.bluez.obex.Agent.rst \ + doc/org.bluez.obex.BipAvrcp.rst EXTRA_DIST += doc/pics-opp.txt doc/pixit-opp.txt \ doc/pts-opp.txt diff --git a/doc/org.bluez.obex.BipAvrcp.rst b/doc/org.bluez.obex.BipAvrcp.rst new file mode 100644 index 000000000..46b12f645 --- /dev/null +++ b/doc/org.bluez.obex.BipAvrcp.rst @@ -0,0 +1,72 @@ +======================= +org.bluez.obex.BipAvrcp +======================= + +-------------------------------------------------- +BlueZ D-Bus OBEX BipAvrcp API documentation +-------------------------------------------------- + +:Version: BlueZ +:Date: August 2024 +:Manual section: 5 +:Manual group: Linux System Administration + +Interface +========= + +:Service: org.bluez.obex +:Interface: org.bluez.obex.BipAvrcp1 [experimental] +:Object path: [Session object path] + +Methods +------- + +object, dict GetImage(string targetfile, string handle, dict description) +````````````````````````````````````````````````````````````````````````` + + Retrieves the image corresponding to the handle and the description, as + one of the descriptions retrieved by GetImageProperties, and store it in + a local file. + + If the "transform" property description exists it should be set to one + of the value listed by GetImageProperties for this description. + + If description is an empty dict, the native image will be retrieved; + + Possible errors: + + :org.bluez.obex.Error.InvalidArguments: + :org.bluez.obex.Error.Failed: + +array{dict} GetImageproperties(string handle) +````````````````````````````````````````````` + + Retrieves the image properties corresponding to the handle. + + The first dict entry is mandatory and correspond to 'handle' and 'name' + of the image. + + The second dict entry is mandatory and correspond to the native description + ('type':'native') of the image. + + The following dict entries are optional and correspond to variant + descriptions of the image. If the 'transform' entry exists in the + description, it lists the available possible image transformations and + should be set to one of them before using the description as parameter + to GetImage. + + Possible errors: + + :org.bluez.obex.Error.InvalidArguments: + :org.bluez.obex.Error.Failed: + +object, dict GetImageThumbnail(string targetfile, string handle) +```````````````````````````````````````````````````````````````` + + Retrieves the image thumbnail corresponding to the handle and store it in + a local file. + + Possible errors: + + :org.bluez.obex.Error.InvalidArguments: + :org.bluez.obex.Error.Failed: diff --git a/doc/org.bluez.obex.Client.rst b/doc/org.bluez.obex.Client.rst index 5ae7cc5e8..f20dd5baa 100644 --- a/doc/org.bluez.obex.Client.rst +++ b/doc/org.bluez.obex.Client.rst @@ -43,6 +43,7 @@ object CreateSession(string destination, dict args) :"opp": :"pbap": :"sync": + :"bip-avrcp": :string Source: