media.schema.yml

Same filename in other branches
  1. 9 core/modules/media/config/schema/media.schema.yml
  2. 8.9.x core/modules/media/config/schema/media.schema.yml
  3. 11.x core/modules/media/config/schema/media.schema.yml
core/modules/media/config/schema/media.schema.yml

File

core/modules/media/config/schema/media.schema.yml

View source
  1. media.settings:
  2. type: config_object
  3. label: 'Media settings'
  4. mapping:
  5. icon_base_uri:
  6. type: string
  7. label: 'Full URI to a folder where the media icons will be installed'
  8. iframe_domain:
  9. type: uri
  10. nullable: true
  11. label: 'Domain from which to serve oEmbed content in an iframe'
  12. oembed_providers_url:
  13. type: uri
  14. label: 'The URL of the oEmbed providers database in JSON format'
  15. standalone_url:
  16. type: boolean
  17. label: 'Allow media items to be viewed standalone at /media/{id}'
  18. media.type.*:
  19. type: config_entity
  20. label: 'Media type'
  21. mapping:
  22. id:
  23. type: machine_name
  24. label: 'Machine name'
  25. constraints:
  26. Length:
  27. # Media type IDs are specifically limited to 32 characters.
  28. # @see \Drupal\media\MediaTypeForm::form()
  29. max: 32
  30. label:
  31. type: required_label
  32. label: 'Name'
  33. description:
  34. type: text
  35. label: 'Description'
  36. source:
  37. type: string
  38. label: 'Source'
  39. constraints:
  40. PluginExists:
  41. manager: plugin.manager.media.source
  42. interface: 'Drupal\media\MediaSourceInterface'
  43. queue_thumbnail_downloads:
  44. type: boolean
  45. label: 'Whether the thumbnail downloads should be queued'
  46. new_revision:
  47. type: boolean
  48. label: 'Whether a new revision should be created by default'
  49. source_configuration:
  50. type: media.source.[%parent.source]
  51. field_map:
  52. type: sequence
  53. label: 'Field map'
  54. sequence:
  55. type: string
  56. field.formatter.settings.media_thumbnail:
  57. type: field.formatter.settings.image
  58. label: 'Media thumbnail field display format settings'
  59. field.formatter.settings.oembed:
  60. type: mapping
  61. label: 'oEmbed display format settings'
  62. mapping:
  63. max_width:
  64. type: integer
  65. label: 'Maximum width'
  66. max_height:
  67. type: integer
  68. label: 'Maximum height'
  69. loading:
  70. type: mapping
  71. label: 'oEmbed loading settings'
  72. mapping:
  73. attribute:
  74. type: string
  75. label: 'Loading attribute'
  76. field.widget.settings.oembed_textfield:
  77. type: field.widget.settings.string_textfield
  78. label: 'oEmbed widget format settings'
  79. media.source.*:
  80. type: mapping
  81. label: 'Media source settings'
  82. media.source.file:
  83. type: media.source.field_aware
  84. label: '"File" media source configuration'
  85. media.source.image:
  86. type: media.source.field_aware
  87. label: '"Image" media source configuration'
  88. media.source.audio_file:
  89. type: media.source.field_aware
  90. label: '"Audio" media source configuration'
  91. media.source.video_file:
  92. type: media.source.field_aware
  93. label: '"Video" media source configuration'
  94. media.source.oembed:*:
  95. type: media.source.field_aware
  96. label: 'oEmbed media source configuration'
  97. mapping:
  98. thumbnails_directory:
  99. type: uri
  100. label: 'URI of thumbnail storage directory'
  101. providers:
  102. type: sequence
  103. label: 'Allowed oEmbed providers'
  104. sequence:
  105. type: string
  106. label: 'Provider name'
  107. media.source.field_aware:
  108. type: mapping
  109. mapping:
  110. source_field:
  111. type: string
  112. label: 'Source field'
  113. filter_settings.media_embed:
  114. type: mapping
  115. label: 'Media Embed'
  116. mapping:
  117. default_view_mode:
  118. type: string
  119. label: 'The view mode that is used by default'
  120. allowed_view_modes:
  121. type: sequence
  122. label: 'View modes selectable in the "Edit media" dialog'
  123. sequence:
  124. type: string
  125. label: 'View mode'
  126. allowed_media_types:
  127. type: sequence
  128. label: 'Media types selectable in the Media Library'
  129. sequence:
  130. type: string
  131. label: 'Media type'

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.