You are here

interface BrightcovePlayerInterface in Brightcove Video Connect 8

Same name and namespace in other branches
  1. 8.2 src/BrightcovePlayerInterface.php \Drupal\brightcove\BrightcovePlayerInterface
  2. 3.x src/BrightcovePlayerInterface.php \Drupal\brightcove\BrightcovePlayerInterface

Provides an interface for defining Brightcove Player.

Hierarchy

Expanded class hierarchy of BrightcovePlayerInterface

All classes that implement BrightcovePlayerInterface

1 file declares its use of BrightcovePlayerInterface
BrightcovePlayer.php in src/Entity/BrightcovePlayer.php

File

src/BrightcovePlayerInterface.php, line 10

Namespace

Drupal\brightcove
View source
interface BrightcovePlayerInterface {

  /**
   * Returns the Brightcove Player ID.
   *
   * @return string
   *   The Brightcove Player ID (not the entity's).
   */
  public function getPlayerId();

  /**
   * Sets The Brightcove Player ID.
   *
   * @param string $player_id
   *   The Brightcove Player ID (not the entity's).
   *
   * @return \Drupal\brightcove\BrightcovePlayerInterface
   *   The called Brightcove Player.
   */
  public function setPlayerId($player_id);

  /**
   * Returns whether the player is adjusted for the playlist or not.
   *
   * @return bool|null
   *   TRUE or FALSE whether the player is adjusted or not, or NULL if not set.
   */
  public function isAdjusted();

  /**
   * Sets the Player as adjusted.
   *
   * @param bool|null $adjusted
   *   TRUE or FALSE whether the player is adjusted or not, or NULL to unset
   *   the value.
   *
   * @return \Drupal\brightcove\BrightcovePlayerInterface
   *   The called Brightcove Player.
   */
  public function setAdjusted($adjusted);

  /**
   * Returns the height of the player.
   *
   * @return float
   *   The height of the player.
   */
  public function getHeight();

  /**
   * Sets the height of the player.
   *
   * @param float $height
   *   The height of the player.
   *
   * @return \Drupal\brightcove\BrightcovePlayerInterface
   *   The called Brightcove Player.
   */
  public function setHeight($height);

  /**
   * Returns the width of the player.
   *
   * @return float
   *   The width of the player.
   */
  public function getWidth();

  /**
   * Sets the width of the player.
   *
   * @param float $width
   *   The width of the player.
   *
   * @return \Drupal\brightcove\BrightcovePlayerInterface
   *   The called Brightcove Player.
   */
  public function setWidth($width);

}

Members

Namesort descending Modifiers Type Description Overrides
BrightcovePlayerInterface::getHeight public function Returns the height of the player. 1
BrightcovePlayerInterface::getPlayerId public function Returns the Brightcove Player ID. 1
BrightcovePlayerInterface::getWidth public function Returns the width of the player. 1
BrightcovePlayerInterface::isAdjusted public function Returns whether the player is adjusted for the playlist or not. 1
BrightcovePlayerInterface::setAdjusted public function Sets the Player as adjusted. 1
BrightcovePlayerInterface::setHeight public function Sets the height of the player. 1
BrightcovePlayerInterface::setPlayerId public function Sets The Brightcove Player ID. 1
BrightcovePlayerInterface::setWidth public function Sets the width of the player. 1