Package org.bluez

Interface Media1

All Superinterfaces:
org.freedesktop.dbus.interfaces.DBusInterface
public interface Media1 extends org.freedesktop.dbus.interfaces.DBusInterface
File generated - 2023-02-20.
Based on bluez Documentation: media-api.txt.

Service: org.bluez
Interface: org.bluez.Media1

Object path:
[variable prefix]/{hci0,hci1,...}

Supported properties:

array{string} SupportedUUIDs [readonly]:

List of 128-bit UUIDs that represents the supported
Endpoint registration.


  • Method Summary

    Modifier and Type
    Method
    Description
    void
    RegisterApplication(org.freedesktop.dbus.DBusPath _root, Map<String,org.freedesktop.dbus.types.Variant<?>> _options)
    From bluez documentation:

    Register endpoints an player objects within root
    object which must implement ObjectManager.

    The application object path together with the D-Bus
    system bus connection ID define the identification of
    the application.

    void
    RegisterEndpoint(org.freedesktop.dbus.DBusPath _endpoint, Map<String,org.freedesktop.dbus.types.Variant<?>> _properties)
    From bluez documentation:

    Register a local end point to sender, the sender can
    register as many end points as it likes.

    Note: If the sender disconnects the end points are
    automatically unregistered.

    possible properties:

    string UUID:

    UUID of the profile which the endpoint
    is for.

    UUID must be in the list of
    SupportedUUIDS.

    byte Codec:

    Assigned number of codec that the
    endpoint implements.
    void
    RegisterPlayer(org.freedesktop.dbus.DBusPath _player, Map<String,org.freedesktop.dbus.types.Variant<?>> _properties)
    From bluez documentation:

    Register a media player object to sender, the sender
    can register as many objects as it likes.

    Object must implement at least
    org.mpris.MediaPlayer2.Player as defined in MPRIS 2.2
    spec:

    http://specifications.freedesktop.org/mpris-spec/latest/

    Note: If the sender disconnects its objects are
    automatically unregistered.

    void
    UnregisterApplication(org.freedesktop.dbus.DBusPath _application)
    From bluez documentation:

    This unregisters the services that has been
    previously registered.
    void
    UnregisterEndpoint(org.freedesktop.dbus.DBusPath _endpoint)
    From bluez documentation:

    Unregister sender end point.

    void
    UnregisterPlayer(org.freedesktop.dbus.DBusPath _player)
    From bluez documentation:

    Unregister sender media player.

    Methods inherited from interface org.freedesktop.dbus.interfaces.DBusInterface

    getObjectPath, isRemote

  • Method Details

    • RegisterEndpoint

      void RegisterEndpoint(org.freedesktop.dbus.DBusPath _endpoint, Map<String,org.freedesktop.dbus.types.Variant<?>> _properties) throws BluezInvalidArgumentsException
      From bluez documentation:

      Register a local end point to sender, the sender can
      register as many end points as it likes.

      Note: If the sender disconnects the end points are
      automatically unregistered.

      possible properties:

      string UUID:

      UUID of the profile which the endpoint
      is for.

      UUID must be in the list of
      SupportedUUIDS.

      byte Codec:

      Assigned number of codec that the
      endpoint implements. The values should
      match the profile specification which
      is indicated by the UUID.

      array{byte} Capabilities:

      Capabilities blob, it is used as it is
      so the size and byte order must match.

      Parameters:
      _endpoint - endpoint
      _properties - properties
      Throws:
      BluezInvalidArgumentsException - when argument is invalid

    • UnregisterEndpoint

      void UnregisterEndpoint(org.freedesktop.dbus.DBusPath _endpoint)
      From bluez documentation:

      Unregister sender end point.

      Parameters:
      _endpoint - endpoint

    • RegisterPlayer

      void RegisterPlayer(org.freedesktop.dbus.DBusPath _player, Map<String,org.freedesktop.dbus.types.Variant<?>> _properties) throws BluezInvalidArgumentsException, BluezNotSupportedException
      From bluez documentation:

      Register a media player object to sender, the sender
      can register as many objects as it likes.

      Object must implement at least
      org.mpris.MediaPlayer2.Player as defined in MPRIS 2.2
      spec:

      http://specifications.freedesktop.org/mpris-spec/latest/

      Note: If the sender disconnects its objects are
      automatically unregistered.

      Parameters:
      _player - player
      _properties - properties
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezNotSupportedException - when operation not supported

    • UnregisterPlayer

      void UnregisterPlayer(org.freedesktop.dbus.DBusPath _player)
      From bluez documentation:

      Unregister sender media player.

      Parameters:
      _player - player

    • RegisterApplication

      void RegisterApplication(org.freedesktop.dbus.DBusPath _root, Map<String,org.freedesktop.dbus.types.Variant<?>> _options) throws BluezInvalidArgumentsException, BluezAlreadyExistsException
      From bluez documentation:

      Register endpoints an player objects within root
      object which must implement ObjectManager.

      The application object path together with the D-Bus
      system bus connection ID define the identification of
      the application.

      Parameters:
      _root - root
      _options - options
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezAlreadyExistsException - when item already exists

    • UnregisterApplication

      void UnregisterApplication(org.freedesktop.dbus.DBusPath _application) throws BluezInvalidArgumentsException, BluezDoesNotExistException
      From bluez documentation:

      This unregisters the services that has been
      previously registered. The object path parameter
      must match the same value that has been used
      on registration.

      Parameters:
      _application - application
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezDoesNotExistException - when item does not exist