You are here

function hook_scald_player in Scald: Media Management made easy 7

Define information about atom players provided by a module.

Return value

array An array of atom players. This array is keyed by the machine-readable player name. Each player is defined as an associative array containing the following items:

  • "name": The untranslated human-readable name of the player.
  • "description": The longer description of the player.
  • "type": The type array that is compatible with the player. The special value '*' means this player is compatible with all atom types.
  • "settings": The default settings array.
3 functions implement hook_scald_player()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

scald_audio_scald_player in modules/providers/scald_audio/scald_audio.module
Implements hook_scald_player().
scald_image_scald_player in modules/providers/scald_image/scald_image.module
Implements hook_scald_player().
scald_scald_player in ./scald.module
Implements hook_scald_player().

File

./scald.api.php, line 175
Hooks related to Scald atoms and providers.

Code

function hook_scald_player() {
  return array(
    'html5' => array(
      'name' => 'HTML5 player',
      'description' => 'The HTML5 player for images and videos.',
      'type' => array(
        'image',
        'video',
      ),
      'settings' => array(
        'classes' => '',
        'caption' => '[atom:title], by [atom:author]',
      ),
    ),
  );
}