Source: ui/externs/watermark.js

  1. /*! @license
  2. * Shaka Player
  3. * Copyright 2016 Google LLC
  4. * SPDX-License-Identifier: Apache-2.0
  5. */
  6. /**
  7. * @externs
  8. * @suppress {duplicate} To prevent compiler errors with the namespace
  9. * being declared both here and by goog.provide in the library.
  10. */
  11. /**
  12. * @typedef {{
  13. * type: string,
  14. * text: string,
  15. * position: string,
  16. * color: string,
  17. * size: number,
  18. * alpha: number,
  19. * interval: number,
  20. * skip: number,
  21. * displayDuration: number,
  22. * transitionDuration: number
  23. * }}
  24. *
  25. * @property {string} type
  26. * The type of watermark ('static' or 'dynamic').
  27. * Defaults to 'static'.
  28. * @property {string} text
  29. * The text content of the watermark. Required.
  30. * @property {string} position
  31. * Position of the watermark.
  32. * Defaults to 'top-left'.
  33. * @property {string} color
  34. * The color of the watermark text.
  35. * Defaults to 'white'.
  36. * @property {number} size
  37. * Font size of the watermark text in pixels.
  38. * Defaults to 24.
  39. * @property {number} alpha
  40. * Opacity of the watermark (0.0 to 1.0).
  41. * Defaults to 0.7.
  42. * @property {number} interval
  43. * Interval between position updates for dynamic watermarks (in seconds).
  44. * Only used when type is 'dynamic'.
  45. * Defaults to 2.
  46. * @property {number} skip
  47. * Skip duration for dynamic watermarks (in seconds).
  48. * Only used when type is 'dynamic'.
  49. * Defaults to 0.5.
  50. * @property {number} displayDuration
  51. * Duration to display watermark at each position (in seconds).
  52. * Only used when type is 'dynamic'.
  53. * Defaults to 2.
  54. * @property {number} transitionDuration
  55. * Duration of fade transitions between positions (in seconds).
  56. * Only used when type is 'dynamic'.
  57. * Defaults to 0.5.
  58. * @exportDoc
  59. */
  60. shaka.ui.Watermark.Options;