class AudioFile

Media source wrapping around an audio file.

Plugin annotation

@MediaSource(
  id = "audio_file",
  label = @Translation("Audio file"),
  description = @Translation("Use audio files for reusable media."),
  allowed_field_types = {"file"},
  default_thumbnail_filename = "audio.png"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\media\MediaSourceBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\media\MediaSourceInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
      • class \Drupal\media\Plugin\media\Source\File extends \Drupal\media\MediaSourceBase
        • class \Drupal\media\Plugin\media\Source\AudioFile extends \Drupal\media\Plugin\media\Source\File

Expanded class hierarchy of AudioFile

See also

\Drupal\file\FileInterface

File

core/modules/media/src/Plugin/media/Source/AudioFile.php, line 21

Namespace

class AudioFile extends File {
    
    /**
     * {@inheritdoc}
     */
    public function createSourceField(MediaTypeInterface $type) {
        return parent::createSourceField($type)->set('settings', [
            'file_extensions' => 'mp3 wav aac',
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function prepareViewDisplay(MediaTypeInterface $type, EntityViewDisplayInterface $display) {
        $display->setComponent($this->getSourceFieldDefinition($type)
            ->getName(), [
            'type' => 'file_audio',
            'label' => 'visually_hidden',
        ]);
    }

}

Members