MessageClip

From Avisynth wiki
(Difference between revisions)
Jump to: navigation, search
m (line break)
Line 1: Line 1:
'''MessageClip''' produces a clip containing a text message. The font face is "Arial". The font size is between 24 points and 9 points - chosen to fit, if possible, in the width by height clip. Used internally for error reporting.
+
'''MessageClip''' produces a clip containing a text message. The font face is "Arial". The font size is between 24 points and 9 points - chosen to fit, if possible, in the width by height clip. The pixeltype is RGB32. Used internally for error reporting.
  
  
Line 8: Line 8:
 
:: The message to be displayed. Required.  
 
:: The message to be displayed. Required.  
  
:{{Par2|width|int|0}}
+
:{{Par2|width|int|-1}}
:{{Par2|height|int|0}}
+
:{{Par2|height|int|-1}}
:: Width and height of the resulting clip. By default, the clip grows to the size required to display the message.  
+
:: Width and height of the resulting clip. By default, the width and height are chosen such that it can display the message with size 24 points.
  
 
:{{Par2|shrink|bool|false}}
 
:{{Par2|shrink|bool|false}}

Revision as of 19:59, 16 January 2016

MessageClip produces a clip containing a text message. The font face is "Arial". The font size is between 24 points and 9 points - chosen to fit, if possible, in the width by height clip. The pixeltype is RGB32. Used internally for error reporting.


Syntax and Parameters

MessageClip(string message [, int width, int height, bool shrink, int text_color, int halo_color, int bg_color ] )

string  message =
The message to be displayed. Required.
int  width = -1
int  height = -1
Width and height of the resulting clip. By default, the width and height are chosen such that it can display the message with size 24 points.
bool  shrink = false
If true, and width and/or Height are specified, the clip resolution is reduced to a smaller size, if possible, to fit the text.
If false (the default), the text will appear at the top-center of the video frame.
int  text_color = color_white
int  halo_color = color_black
int  bg_color = color_black
Colors for font fill, outline and background respectively. Default white, black, black.


Examples

MessageClip(VersionString)
MessageClip2-black.png


 MessageClip(VersionString, width=240) 
MessageClip4-240px.png


MessageClip(VersionString, bg_color=$ff0000) 
MessageClip3-red.png


 MessageClip(VersionString, bg_color=$ff0000, height=80)
MessageClip3-red-hgt80.png


 MessageClip(VersionString, bg_color=$ff0000, height=80, shrink=true)
MessageClip3-red.png
Personal tools