interface BrightcoveTextTrackInterface in Brightcove Video Connect 8

Same name and namespace in other branches

8.2 src/BrightcoveTextTrackInterface.php \Drupal\brightcove\BrightcoveTextTrackInterface
3.x src/BrightcoveTextTrackInterface.php \Drupal\brightcove\BrightcoveTextTrackInterface

Provides an interface for defining Brightcove Text Track entities.

Hierarchy

interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable; interface \Drupal\Core\Entity\EntityChangedInterface; interface \Drupal\user\EntityOwnerInterface
- interface \Drupal\brightcove\BrightcoveTextTrackInterface

Expanded class hierarchy of BrightcoveTextTrackInterface

All classes that implement BrightcoveTextTrackInterface

1 file declares its use of BrightcoveTextTrackInterface

BrightcoveTextTrack.php in src/Entity/BrightcoveTextTrack.php

File

src/BrightcoveTextTrackInterface.php, line 14

Namespace

Drupal\brightcove

View source

interface BrightcoveTextTrackInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface {

  /**
   * Returns the name of Text Track.
   *
   * @return string
   *   The name of the Text Track.
   */
  public function getName();

  /**
   * Sets the name of the Text Track.
   *
   * @param string $name
   *   The name of the Text Track.
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called BrightcoveTextTrack entity.
   */
  public function setName($name);

  /**
   * Returns the WebVTT file entity.
   *
   * @return array
   *   WebVTT file entity.
   */
  public function getWebVttFile();

  /**
   * Sets the WebVTT file.
   *
   * @param array $file
   *   The WebVTT file entity.
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called BrightcoveTextTrack entity.
   */
  public function setWebVttFile(array $file);

  /**
   * Returns the Brightcove ID of the Text Track.
   *
   * @return string
   *   The Brightcove ID of the Text Track.
   */
  public function getTextTrackId();

  /**
   * Sets the Brightcove ID of the Text Track.
   *
   * @param string $text_track_id
   *   The Brightcove ID of the Text Track.
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called BrightcoveTextTrack entity.
   */
  public function setTextTrackId($text_track_id);

  /**
   * Returns the source link.
   *
   * @return array
   *   The related link.
   */
  public function getSource();

  /**
   * Sets the source link.
   *
   * @param string $source
   *   The related link.
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called BrightcoveTextTrack entity.
   */
  public function setSource($source);

  /**
   * Returns the source language.
   *
   * @return string
   *   The 2-letter source language.
   */
  public function getSourceLanguage();

  /**
   * Sets the source language.
   *
   * @param string $source_language
   *   A 2-letter source language code, eg.: hu, en.
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called BrightcoveTextTrack entity.
   */
  public function setSourceLanguage($source_language);

  /**
   * Gets the Brightcove Text Track name.
   *
   * @return string
   *   Name of the Brightcove Text Track.
   */
  public function getLabel();

  /**
   * Sets the Brightcove Text Track name.
   *
   * @param string $label
   *   The Brightcove Text Track name.
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called Brightcove Text Track entity.
   */
  public function setLabel($label);

  /**
   * Returns the Text Tracks's kind.
   *
   * @return string
   *   The kind of the Text Track.
   */
  public function getKind();

  /**
   * Sets the Text Tracks's kind.
   *
   * @param string $kind
   *   The Text Tracks's kind.
   *   Possible values are:
   *     - BrightcoveTextTrack::KIND_CAPTIONS
   *     - BrightcoveTextTrack::KIND_SUBTITLES
   *     - BrightcoveTextTrack::KIND_DESCRIPTION
   *     - BrightcoveTextTrack::KIND_CHAPTERS
   *     - BrightcoveTextTrack::KIND_METADATA
   *   .
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called BrightcoveTextTrack entity.
   */
  public function setKind($kind);

  /**
   * Returns the mime type.
   *
   * @return string
   *   The mime type.
   */
  public function getMimeType();

  /**
   * Sets the mime type.
   *
   * @param string $mime_type
   *   The mime type.
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called BrightcoveTextTrack entity.
   */
  public function setMimeType($mime_type);

  /**
   * Returns the asset ID.
   *
   * Only for managed text tracks.
   *
   * @return string
   *   Asset ID.
   */
  public function getAssetId();

  /**
   * Sets the Asset ID.
   *
   * @param string $asset_id
   *   The asset ID.
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called BrightcoveTextTrack entity.
   */
  public function setAssetId($asset_id);

  /**
   * Returns a list of text track sources.
   *
   * @return array
   *   List of text track sources.
   */
  public function getSources();

  /**
   * Set text track sources.
   *
   * @param array $sources
   *   Text track sources.
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called BrightcoveTextTrack entity.
   */
  public function setSources(array $sources);

  /**
   * Whether or not the text track is default.
   *
   * @return bool
   *   TRUE if the text track is the default one, FALSE otherwise.
   */
  public function isDefault();

  /**
   * Set Text Track as default.
   *
   * @param bool $default
   *   TRUE or FALSE whether is the Text Track is the default one or not.
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called BrightcoveTextTrack entity.
   */
  public function setDefault($default);

  /**
   * Gets the Brightcove Text Track creation timestamp.
   *
   * @return int
   *   Creation timestamp of the Brightcove Text Track.
   */
  public function getCreatedTime();

  /**
   * Sets the Brightcove Text Track creation timestamp.
   *
   * @param int $timestamp
   *   The Brightcove Text Track creation timestamp.
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called Brightcove Text Track entity.
   */
  public function setCreatedTime($timestamp);

  /**
   * Returns the Brightcove Text Track published status indicator.
   *
   * Unpublished Brightcove Text Track are only visible to restricted users.
   *
   * @return bool
   *   TRUE if the Brightcove Text Track is published.
   */
  public function isPublished();

  /**
   * Sets the published status of a Brightcove Text Track.
   *
   * @param bool $published
   *   TRUE to set this Brightcove Text Track to published, FALSE to set it to
   *   unpublished.
   *
   * @return \Drupal\brightcove\BrightcoveTextTrackInterface
   *   The called Brightcove Text Track entity.
   */
  public function setPublished($published);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
BrightcoveTextTrackInterface::getAssetId	public	function	Returns the asset ID.	1
BrightcoveTextTrackInterface::getCreatedTime	public	function	Gets the Brightcove Text Track creation timestamp.	1
BrightcoveTextTrackInterface::getKind	public	function	Returns the Text Tracks's kind.	1
BrightcoveTextTrackInterface::getLabel	public	function	Gets the Brightcove Text Track name.	1
BrightcoveTextTrackInterface::getMimeType	public	function	Returns the mime type.	1
BrightcoveTextTrackInterface::getName	public	function	Returns the name of Text Track.	1
BrightcoveTextTrackInterface::getSource	public	function	Returns the source link.	1
BrightcoveTextTrackInterface::getSourceLanguage	public	function	Returns the source language.	1
BrightcoveTextTrackInterface::getSources	public	function	Returns a list of text track sources.	1
BrightcoveTextTrackInterface::getTextTrackId	public	function	Returns the Brightcove ID of the Text Track.	1
BrightcoveTextTrackInterface::getWebVttFile	public	function	Returns the WebVTT file entity.	1
BrightcoveTextTrackInterface::isDefault	public	function	Whether or not the text track is default.	1
BrightcoveTextTrackInterface::isPublished	public	function	Returns the Brightcove Text Track published status indicator.	1
BrightcoveTextTrackInterface::setAssetId	public	function	Sets the Asset ID.	1
BrightcoveTextTrackInterface::setCreatedTime	public	function	Sets the Brightcove Text Track creation timestamp.	1
BrightcoveTextTrackInterface::setDefault	public	function	Set Text Track as default.	1
BrightcoveTextTrackInterface::setKind	public	function	Sets the Text Tracks's kind.	1
BrightcoveTextTrackInterface::setLabel	public	function	Sets the Brightcove Text Track name.	1
BrightcoveTextTrackInterface::setMimeType	public	function	Sets the mime type.	1
BrightcoveTextTrackInterface::setName	public	function	Sets the name of the Text Track.	1
BrightcoveTextTrackInterface::setPublished	public	function	Sets the published status of a Brightcove Text Track.	1
BrightcoveTextTrackInterface::setSource	public	function	Sets the source link.	1
BrightcoveTextTrackInterface::setSourceLanguage	public	function	Sets the source language.	1
BrightcoveTextTrackInterface::setSources	public	function	Set text track sources.	1
BrightcoveTextTrackInterface::setTextTrackId	public	function	Sets the Brightcove ID of the Text Track.	1
BrightcoveTextTrackInterface::setWebVttFile	public	function	Sets the WebVTT file.	1
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
EntityChangedInterface::getChangedTime	public	function	Gets the timestamp of the last entity change for the current translation.
EntityChangedInterface::getChangedTimeAcrossTranslations	public	function	Gets the timestamp of the last entity change across all translations.
EntityChangedInterface::setChangedTime	public	function	Sets the timestamp of the last entity change for the current translation.
EntityInterface::bundle	public	function	Gets the bundle of the entity.	2
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	2
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	2
EntityInterface::delete	public	function	Deletes an entity permanently.	2
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	2
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	2
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	2
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	2
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	2
EntityInterface::getEntityType	public	function	Gets the entity type definition.	2
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	2
EntityInterface::getOriginalId	public	function	Gets the original ID.	2
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	2
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	2
EntityInterface::id	public	function	Gets the identifier.	2
EntityInterface::isNew	public	function	Determines whether the entity is new.	2
EntityInterface::label	public	function	Gets the label of the entity.	2
EntityInterface::language	public	function	Gets the language of the entity.	2
EntityInterface::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink().	2
EntityInterface::load	public static	function	Loads an entity.	2
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	2
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	2
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	2
EntityInterface::postLoad	public static	function	Acts on loaded entities.	3
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	2
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	2
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	2
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	2
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::save	public	function	Saves an entity permanently.	2
EntityInterface::setOriginalId	public	function	Sets the original ID.	2
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	2
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	2
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	2
EntityInterface::url Deprecated	public	function	Gets the public URL for this entity.	2
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
EntityOwnerInterface::getOwner	public	function	Returns the entity owner's user entity.	1
EntityOwnerInterface::getOwnerId	public	function	Returns the entity owner's user ID.	1
EntityOwnerInterface::setOwner	public	function	Sets the entity owner's user entity.	1
EntityOwnerInterface::setOwnerId	public	function	Sets the entity owner's user ID.	1
FieldableEntityInterface::baseFieldDefinitions	public static	function	Provides base field definitions for an entity type.	2
FieldableEntityInterface::bundleFieldDefinitions	public static	function	Provides field definitions for a specific bundle.	2
FieldableEntityInterface::get	public	function	Gets a field item list.	1
FieldableEntityInterface::getFieldDefinition	public	function	Gets the definition of a contained field.	1
FieldableEntityInterface::getFieldDefinitions	public	function	Gets an array of field definitions of all contained fields.	1
FieldableEntityInterface::getFields	public	function	Gets an array of all field item lists.	1
FieldableEntityInterface::getTranslatableFields	public	function	Gets an array of field item lists for translatable fields.	1
FieldableEntityInterface::hasField	public	function	Determines whether the entity has a field with the given name.	1
FieldableEntityInterface::isValidationRequired	public	function	Checks whether entity validation is required before saving the entity.	1
FieldableEntityInterface::onChange	public	function	Reacts to changes to a field.	1
FieldableEntityInterface::set	public	function	Sets a field value.	1
FieldableEntityInterface::setValidationRequired	public	function	Sets whether entity validation is required before saving the entity.	1
FieldableEntityInterface::toArray	public	function	Gets an array of all field values. Overrides EntityInterface::toArray
FieldableEntityInterface::validate	public	function	Validates the currently set values.	1
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
RevisionableInterface::getLoadedRevisionId	public	function	Gets the loaded Revision ID of the entity.	1
RevisionableInterface::getRevisionId	public	function	Gets the revision identifier of the entity.	1
RevisionableInterface::isDefaultRevision	public	function	Checks if this entity is the default revision.	1
RevisionableInterface::isLatestRevision	public	function	Checks if this entity is the latest revision.	1
RevisionableInterface::isNewRevision	public	function	Determines whether a new revision should be created on save.	1
RevisionableInterface::preSaveRevision	public	function	Acts on a revision before it gets saved.	1
RevisionableInterface::setNewRevision	public	function	Enforces an entity to be saved as a new revision.	1
RevisionableInterface::updateLoadedRevisionId	public	function	Updates the loaded Revision ID with the revision ID.	1
RevisionableInterface::wasDefaultRevision	public	function	Checks whether the entity object was a default revision when it was saved.	1
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
TranslatableInterface::addTranslation	public	function	Adds a new translation to the translatable object.	1
TranslatableInterface::getTranslation	public	function	Gets a translation of the data.	1
TranslatableInterface::getTranslationLanguages	public	function	Returns the languages the data is translated to.	1
TranslatableInterface::getUntranslated	public	function	Returns the translatable object referring to the original language.	1
TranslatableInterface::hasTranslation	public	function	Checks there is a translation for the given language code.	1
TranslatableInterface::hasTranslationChanges	public	function	Determines if the current translation of the entity has unsaved changes.	1
TranslatableInterface::isDefaultTranslation	public	function	Checks whether the translation is the default one.	1
TranslatableInterface::isNewTranslation	public	function	Checks whether the translation is new.	1
TranslatableInterface::isTranslatable	public	function	Returns the translation support status.	1
TranslatableInterface::removeTranslation	public	function	Removes the translation identified by the given language code.	1
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly	public	function	Checks if untranslatable fields should affect only the default translation.	1
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision	public	function	Checks whether this is the latest revision affecting this translation.	1
TranslatableRevisionableInterface::isRevisionTranslationAffected	public	function	Checks whether the current translation is affected by the current revision.	1
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced	public	function	Checks if the revision translation affected flag value has been enforced.	1
TranslatableRevisionableInterface::setRevisionTranslationAffected	public	function	Marks the current revision translation as affected.	1
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced	public	function	Enforces the revision translation affected flag value.	1

You are here

interface BrightcoveTextTrackInterface in Brightcove Video Connect 8

Hierarchy

File

Namespace

Members

API Navigation