wireplumber/docs/rst/lua_api/lua_object_interest_api.rst

 .. _lua_object_interest_api:

Object Interest
===============

Constructors
~~~~~~~~~~~~

.. function:: Interest(decl)

   :param table decl: an interest declaration
   :returns: the interest
   :rtype: ObjectInterest

Methods
~~~~~~~

.. function:: Interest.matches(self, obj)

   :param self: the interest
   :param obj: an object to check for a match
   :type obj: GObject or table
   :returns: whether the object matches the interest
   :rtype: boolean
docs: Add Lua API documentation 2021-05-13 17:53:51 +03:00			`.. _lua_object_interest_api:`

docs: convert lua api docs to pure rst Not all the docs are there yet, this is WIP 2021-05-25 13:46:20 +03:00			`Object Interest`
			`===============`
docs: Add Lua API documentation 2021-05-13 17:53:51 +03:00
docs: convert lua api docs to pure rst Not all the docs are there yet, this is WIP 2021-05-25 13:46:20 +03:00			`Constructors`
			`~~~~~~~~~~~~`

			`.. function:: Interest(decl)`

			`:param table decl: an interest declaration`
			`:returns: the interest`
			`:rtype: ObjectInterest`

			`Methods`
			`~~~~~~~`

			`.. function:: Interest.matches(self, obj)`

			`:param self: the interest`
			`:param obj: an object to check for a match`
			`:type obj: GObject or table`
			`:returns: whether the object matches the interest`
			`:rtype: boolean`