EBanner plug-in: Difference between revisions

From NSIS Wiki
Jump to navigationJump to search
m (Embedded Banner moved to EBanner plug-in)
No edit summary
Line 18: Line 18:
=== show DLL Function ===
=== show DLL Function ===


  ebanner::show /NOUNLOAD [/ALIGN={LEFT|RIGHT}] FileName
  ebanner::show /NOUNLOAD [/ALIGN={LEFT|RIGHT|FIT|STRETCH}] FileName


; /ALIGN
; /ALIGN

Revision as of 12:13, 15 January 2006

Author: Takhir (talk, contrib)


Links

Download:
EBanner.zip (32 KB)

Forum thread

Description

EBanner.dll is NSIS plug-in, displaying banner on the installer page. Not stops installer execution when banner is displayed. Banner is not clickable and it's is place limited with page bottom. BMP, JPEG, GIF, PNG (with transparency) are supported. Also can play music at the same time.

Command line (NSIS script)

Plug-in DLL functions (entry points): show, play, stop

show DLL Function

ebanner::show /NOUNLOAD [/ALIGN={LEFT|RIGHT|FIT|STRETCH}] FileName
/ALIGN
Changes horizontal alignment for the image, default (no parameter) is center.
FileName
Image file name. Empty Filename string "" cleares image but not stops sound playing.

play DLL Function

ebanner::play /NOUNLOAD [/LOOP] FileName
/LOOP
Sets 'repeat' flag for hidden MCI player.
FileName
Sound filename to play (with extension, wav, mp3 ...). Empty Filename string "" stops sound.

stop DLL Function

ebanner::stop
Destroys image, clears window, stops sound (if any). Optional, on the page close auto-stop should work (I guess).


Examples

Package includes nsi script sample.

SetOutPath '$PLUGINSDIR'
File snd.mp3
File catch.gif
ebanner::play /NOUNLOAD /LOOP '$PLUGINSDIR\snd.mp3'
ebanner::show /NOUNLOAD /ALIGN=LEFT '$PLUGINSDIR\catch.gif'
; Add your page code here
ebanner::stop
Delete '$PLUGINSDIR\snd.mp3'
Delete '$PLUGINSDIR\catch.gif'