You are here

public function AudioStream::getMetadataAttributes in Media entity audio 8.3

Gets a list of metadata attributes provided by this plugin.

Most media sources have associated metadata, describing attributes such as:

  • dimensions
  • duration
  • encoding
  • date
  • location
  • permalink
  • licensing information
  • ...

This method should list all metadata attributes that a media source MAY offer. In other words: it is possible that a particular media item does not contain a certain attribute. For example: an oEmbed media source can contain both video and images. Images don't have a duration, but videos do.

(The term 'attributes' was chosen because it cannot be confused with 'fields' and 'properties', both of which are concepts in Drupal's Entity Field API.)

Return value

array Associative array with:

  • keys: metadata attribute names
  • values: human-readable labels for those attribute names

Overrides MediaSourceInterface::getMetadataAttributes

File

src/Plugin/media/Source/AudioStream.php, line 38

Class

AudioStream
Provides media type plugin for Audio.

Namespace

Drupal\media_entity_audio\Plugin\media\Source

Code

public function getMetadataAttributes() {
  return [
    'default_name' => $this
      ->t('Name'),
  ];
}