# class ObjectDescription

###

Module | phonon
Namespace | Phonon
Class | ObjectDescription
Inherits |

\class ObjectDescription objectdescription.h Phonon/ObjectDescription Provides a tuple of enduser visible name and description.

Some parts give the enduser choices, e.g. what source to capture audio from. These choices are described by the name and description methods of this class and identified with the id method. Subclasses then define additional information like which audio and video choices belong together.

Author Matthias Kretz <kretz@kde.org>

### methods

- ObjectDescription ( )

  returns ctor

- ObjectDescription (index, properties)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  index | int |
  properties | QHash<QByteArray,QVariant> |

- ObjectDescription (dd)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  dd | QExplicitlySharedDataPointer<Phonon::ObjectDescriptionData> |

- description ( )

  returns QString

  Returns a description of the capture source. This text should make clear what sound source this is, which is sometimes hard to describe or understand from just the name.

  Returns A string describing the capture source.

- fromIndex (index)

  returns ObjectDescription<T>
  static

  Argument | Type | Default
  --- | --- | ---
  index | int |

  Returns a new description object that describes the device/effect/codec/... with the given index.

- index ( )

  returns int

  A unique identifier for this device/. Used internally to distinguish between the devices/.

  Returns An integer that uniquely identifies every device/

- isValid ( )

  returns bool

  Returns true if the Tuple is valid (index != -1); otherwise returns false.

- name ( )

  returns QString

  Returns the name of the capture source.

  Returns A string that should be presented to the user to choose the capture source.

- operator != (otherDescription)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  otherDescription | Phonon.ObjectDescription |

  Returns false if this ObjectDescription describes the same as otherDescription; otherwise returns true.

- operator == (otherDescription)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  otherDescription | Phonon.ObjectDescription |

  Returns true if this ObjectDescription describes the same as otherDescription; otherwise returns false.

- property (name)

  returns QVariant

  Argument | Type | Default
  --- | --- | ---
  name | char |

  Returns a named property.

  If the property is not set an invalid value is returned.

  See also propertyNames()

- propertyNames ( )

  returns QList<QByteArray>

  Returns all names that return valid data when property() is called.

  See also property()