class AudioPlayer in AudioField 8

Defines an AudioPlayer annotation object..

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\audiofield\Annotation\AudioPlayer

File

src/Annotation/AudioPlayer.php, line 12

Namespace

Drupal\audiofield\Annotation

class AudioPlayer extends Plugin {

  /**
   * The ID for the audio player.
   *
   * @var string
   */
  public $id;

  /**
   * The audio player's title.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title = "";

  /**
   * The filetypes which function with this audio player.
   *
   * @var array
   */
  public $fileTypes = [];

  /**
   * The description of this audio player.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = "";

  /**
   * The main library name for this audio player.
   *
   * @var string
   */
  public $libraryName = "";

  /**
   * The website of this plugin's audio player library.
   *
   * @var string
   */
  public $website = "";

}

Members

Name	Modifiers	Type	Description	Overrides
AudioPlayer::$description	public	property	The description of this audio player.
AudioPlayer::$fileTypes	public	property	The filetypes which function with this audio player.
AudioPlayer::$id	public	property	The ID for the audio player.
AudioPlayer::$libraryName	public	property	The main library name for this audio player.
AudioPlayer::$title	public	property	The audio player's title.
AudioPlayer::$website	public	property	The website of this plugin's audio player library.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2