audio_display module hooks
- These hooks allow modules to override the default audio player.
hook_audio_display_list
Parameters:
none
Returns:
array(
'module_name' => array(
'name' => string - human-readable name
)
)
Description:
Describe this module for audio_display parent module
hook_audio_display_admin
Parameters:
none
Returns:
array() - per forms API
Description
Return form elements for managing this module from manage/playlist/settings
hook_audio_display_admin_validate
Parameters:
$form => array() - per forms API
&$form_state => array() - per forms API
Returns:
none
Description:
Form validation for hook_audio_display_admin.
hook_audio_display_admin_submit
Parameters:
$form => array() - per forms API
&$form_state => array() - per forms API
Returns:
none
Description:
Form submission for hook_audio_display_admin.
hook_audio_display_launch_button
Parameters:
$url_only => bool - just return a url instead of a full link
Returns:
string of valid HTML
Description:
Generates the HTML for the button to launch the audio player. Only needs to be implemented for modules that are different from the default.
Notes:
Called by audio_display_button()
hook_audio_display_player
Parameters:
$inc_headers => bool - include HTML headers and footers
Returns:
string of valid HTML
Description:
Generates the HTML to display the audio player. Primarily referenced in audio_player
hook_audio_display_player_embed
Parameters:
$inc_headers => bool - include HTML headers and footers
Returns:
string of valid HTML
Description:
Generates an iFrameable version of the audio player (for embedding on other pages)
hook_audio_display_player_small
Parameters:
$node => a loaded node or a node id
Returns:
string of valid HTML
Description:
Generates the HTML to display an icon-sized audio player. Do not implement this in modules that don't support an icon-sized player
hook_audio_display_player_single_seek
Parameters:
$node => a loaded node or a node id
Returns:
string of valid HTML
Description:
Generates the HTML to display a small audio player with seek capabilities. Do not implement this in modules that don't support an icon-sized player