You are here

interface BrightcovePlaylistInterface in Brightcove Video Connect 8

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

Provides an interface for defining Brightcove Playlists.

Hierarchy

Expanded class hierarchy of BrightcovePlaylistInterface

All classes that implement BrightcovePlaylistInterface

1 file declares its use of BrightcovePlaylistInterface
BrightcovePlaylist.php in src/Entity/BrightcovePlaylist.php

File

src/BrightcovePlaylistInterface.php, line 10

Namespace

Drupal\brightcove
View source
interface BrightcovePlaylistInterface {

  /**
   * Returns the playlist type.
   *
   * @return string
   *   The type of the playlist.
   */
  public function getType();

  /**
   * Sets the playlist's type.
   *
   * @param string $type
   *   The type of the playlist, either BrightcovePlaylist::TYPE_MANUAL or
   *   BrightcovePlaylist::SMART.
   *
   * @return \Drupal\brightcove\BrightcovePlaylistInterface
   *   The called Brightcove Playlist.
   *
   * @throws \InvalidArgumentException
   *   If the value input is inappropriate.
   */
  public function setType($type);

  /**
   * Returns the Brightcove Playlist favorite indicator.
   *
   * Favorite Brightcove Playlists are displayed in the sidebar.
   *
   * @return bool
   *   TRUE if the Brightcove Playlist is favorite.
   */
  public function isFavorite();

  /**
   * Returns the Brightcove Playlist ID.
   *
   * @return int
   *   The Brightcove Playlist ID (not the entity's).
   */
  public function getPlaylistId();

  /**
   * Sets The Brightcove Playlist ID.
   *
   * @param int $playlist_id
   *   The Brightcove Playlist ID (not the entity's).
   *
   * @return \Drupal\brightcove\BrightcovePlaylistInterface
   *   The called Brightcove Playlist.
   */
  public function setPlaylistId($playlist_id);

  /**
   * Returns the tags search condition for smart playlist.
   *
   * @return string
   *   The condition of the tag search.
   */
  public function getTagsSearchCondition();

  /**
   * Sets the tags search condition for smart playlist.
   *
   * @param string $condition
   *   The condition of the tag search, possible values are:
   *     - TAG_SEARCH_CONTAINS_ONE_OR_MORE
   *     - TAG_SEARCH_CONTAINS_ALL
   *   .
   *
   * @return \Drupal\brightcove\BrightcovePlaylistInterface
   *   The called Brightcove Playlist.
   */
  public function setTagsSearchCondition($condition);

  /**
   * Returns the list of videos on the playlist.
   *
   * @return int[]
   *   The videos on the playlist.
   */
  public function getVideos();

  /**
   * Sets the playlist's videos.
   *
   * @param array $videos
   *   The videos on the playlist. Array of ['target_id' => int] items.
   *
   * @return \Drupal\brightcove\BrightcovePlaylistInterface
   *   The called Brightcove Playlist.
   */
  public function setVideos(array $videos);

}

Members

Namesort descending Modifiers Type Description Overrides
BrightcovePlaylistInterface::getPlaylistId public function Returns the Brightcove Playlist ID. 1
BrightcovePlaylistInterface::getTagsSearchCondition public function Returns the tags search condition for smart playlist. 1
BrightcovePlaylistInterface::getType public function Returns the playlist type. 1
BrightcovePlaylistInterface::getVideos public function Returns the list of videos on the playlist. 1
BrightcovePlaylistInterface::isFavorite public function Returns the Brightcove Playlist favorite indicator. 1
BrightcovePlaylistInterface::setPlaylistId public function Sets The Brightcove Playlist ID. 1
BrightcovePlaylistInterface::setTagsSearchCondition public function Sets the tags search condition for smart playlist. 1
BrightcovePlaylistInterface::setType public function Sets the playlist's type. 1
BrightcovePlaylistInterface::setVideos public function Sets the playlist's videos. 1