MeiCam SDK For Android  3.10.0
Public Member Functions | List of all members
com.meicam.sdk.NvsTimelineCaption Class Reference

Timeline captions. More...

Inheritance diagram for com.meicam.sdk.NvsTimelineCaption:
com.meicam.sdk.NvsCaption com.meicam.sdk.NvsFx com.meicam.sdk.NvsObject

Public Member Functions

void setClipAffinityEnabled (boolean enable)
 Sets whether the affinity between the caption and the clip is on. More...
 
boolean getClipAffinityEnabled ()
 Gets whether the affinity between the caption and the clip is on. More...
 
long getInPoint ()
 Get the in-point of the caption on the timeline. More...
 
long getOutPoint ()
 The out-point of the caption on the timeline. More...
 
long changeInPoint (long newInPoint)
 Changes the in-point of the caption on the timeline. More...
 
long changeOutPoint (long newOutPoint)
 Changes the out-point of the caption on the timeline. More...
 
void movePosition (long offset)
 Changes the display position of the caption on the timeline (the in and out points are offset from the offset value at the same time). More...
 
- Public Member Functions inherited from com.meicam.sdk.NvsCaption
int getRoleInTheme ()
 The role of caption in the theme. More...
 
int getCategory ()
 Gets the type of caption. More...
 
String getCaptionStylePackageId ()
 Gets the caption style package ID. More...
 
String getModularCaptionContextPackageId ()
 Gets the modular caption context style package ID. More...
 
String getModularCaptionRendererPackageId ()
 Gets the modular caption render style package ID. More...
 
String getModularCaptionAnimationPackageId ()
 Gets the modular caption animation style package ID. More...
 
String getModularCaptionInAnimationPackageId ()
 Gets the modular caption in-animation style package ID. More...
 
String getModularCaptionOutAnimationPackageId ()
 Gets the modular caption out-animation style package ID. More...
 
boolean applyCaptionStyle (String captionStylePackageId)
 Applys caption style. More...
 
boolean applyCaptionStyle (String captionStylePackageId, int isUseDefaultAssetParam)
 Applys caption style. More...
 
boolean applyModularCaptionContext (String captionContextPackageId)
 Applys modular caption context style. More...
 
boolean applyModularCaptionRenderer (String captionRendererPackageId)
 Applys modular caption render style. More...
 
boolean applyModularCaptionAnimation (String captionAnimationPackageId)
 Applys modular caption loop-animation style. More...
 
boolean applyModularCaptionInAnimation (String captionInAnimationPackageId)
 Applys modular caption in-animation style. Notes:please set loop-Animation to null before you set in-animation, otherwise it will NOT works. More...
 
boolean applyModularCaptionOutAnimation (String captionOutAnimationPackageId)
 Applys modular caption out-animation style.Notes:please set loop-Animation to null before you set out-animation, otherwise it will NOT works. More...
 
void setModularCaptionAnimationPeroid (int periodInMS)
 Set modular caption Animation Peroid. More...
 
int getModularCaptionAnimationPeroid ()
 Get modular caption Animation Peroid. More...
 
void setModularCaptionInAnimationDuration (int inAnimationDurationInMS)
 Set modular caption in-animation duration. More...
 
int getModularCaptionInAnimationDuration ()
 Get modular caption in-animation duration. More...
 
void setModularCaptionOutAnimationDuration (int outAnimationDurationInMS)
 Set modular caption out-animation duration. More...
 
int getModularCaptionOutAnimationDuration ()
 Get modular caption out-animation duration. More...
 
void setText (String text)
 Sets caption text. More...
 
String getText ()
 Gets caption text. More...
 
void setVerticalLayout (boolean verticalLayout)
 Sets whether to layout text vertically. More...
 
boolean getVerticalLayout ()
 Gets whether to layout text vertically. More...
 
void setTextAlignment (int textAlign)
 Sets caption horizontal alignment style. More...
 
int getTextAlignment ()
 Gets caption horizontal alignment style. More...
 
void setTextVerticalAlignment (int verticalTextAlign)
 Sets caption vertical alignment style, valid for frame-caption only. More...
 
int getTextVerticalAlignment ()
 Gets caption vertical alignment style, valid for frame-caption only. More...
 
void setBold (boolean bold)
 Sets caption font bold. More...
 
boolean getBold ()
 Gets the caption font bold state. More...
 
void setWeight (int weight)
 Sets caption weight. More...
 
int getWeight ()
 Gets the caption weight. More...
 
void setItalic (boolean italic)
 Sets caption font italic. More...
 
boolean getItalic ()
 Gets the caption italic state. More...
 
void setUnderline (boolean underline)
 Sets caption under line. More...
 
boolean getUnderline ()
 Gets the caption under line. More...
 
void setLetterSpacingType (int letterSpacingType)
 Sets caption word spacing type. More...
 
int getLetterSpacingType ()
 Gets caption word spacing type. More...
 
void setLetterSpacing (float letterSpacing)
 Sets caption word spacing. More...
 
float getLetterSpacing ()
 Gets caption word spacing. More...
 
void setLineSpacing (float lineSpacing)
 Sets caption line spacing. More...
 
float getLineSpacing ()
 Gets caption line spacing. More...
 
void setTextColor (NvsColor textColor)
 Sets caption text color. More...
 
void resetTextColorState ()
 reset caption text color state. More...
 
NvsColor getTextColor ()
 Gets the current color value of the caption font. More...
 
void setDrawOutline (boolean drawOutline)
 Sets caption stroke. More...
 
boolean getDrawOutline ()
 Gets the caption stroke status. More...
 
void setOutlineColor (NvsColor outlineColor)
 Sets the color of the caption stroke. More...
 
NvsColor getOutlineColor ()
 Gets the color value of the current caption stroke. More...
 
void resetOutlineColorState ()
 reset caption text color state. More...
 
void setOutlineWidth (float outlineWidth)
 Sets the width of the caption stroke. More...
 
float getOutlineWidth ()
 Gets the width of the current caption stroke. More...
 
void setDrawShadow (boolean drawShadow)
 Sets caption shadows. More...
 
boolean getDrawShadow ()
 Gets the current caption shadow status. More...
 
void setShadowColor (NvsColor shadowColor)
 Sets the color of the caption shadow. More...
 
NvsColor getShadowColor ()
 Gets the color of the caption shadow. More...
 
void setShadowOffset (PointF shadowOffset)
 Sets the offset of the caption shadow. More...
 
PointF getShadowOffset ()
 Gets the offset of the current caption shadow. More...
 
void setShadowFeather (float feather)
 Sets the feathering degree of the caption shadow. More...
 
float getShadowFeather ()
 Gets the feathering degree of the caption shadow. More...
 
void setFontSize (float fontSize)
 Sets the caption font size. More...
 
float getFontSize ()
 Gets the font size of the current caption. More...
 
void setFontByFilePath (String filePath)
 Sets caption font. More...
 
String getFontFilePath ()
 Gets the file path of the caption font. More...
 
void setFontFamily (String family)
 Sets caption font. More...
 
String getFontFamily ()
 Get the name of caption font. More...
 
void setBoundaryPaddingRatio (float ratio)
 Sets the caption boundary padding ratio. More...
 
float getBoundaryPaddingRatio ()
 Gets the caption boundary padding ratio. More...
 
void setCaptionTranslation (PointF translation)
 Sets the amount of caption translation. More...
 
PointF getCaptionTranslation ()
 Gets the amount of caption translation. More...
 
void translateCaption (PointF translationOffset)
 Caption translation. More...
 
void setAnchorPoint (PointF anchor)
 Sets caption anchor. More...
 
PointF getAnchorPoint ()
 Gets caption anchor. More...
 
void setScaleX (float scale)
 Sets horizontal scaling factor for caption. More...
 
float getScaleX ()
 Gets caption horizontal scaling factor. More...
 
void setScaleY (float scale)
 Sets vertical scaling factor for captions. More...
 
float getScaleY ()
 Gets caption vertical scaling factor. More...
 
void scaleCaption (float scaleFactor, PointF anchor)
 Zooms caption. More...
 
void setRotationZ (float angle)
 Sets the rotation angle for the caption. More...
 
float getRotationZ ()
 Gets caption rotation angle. More...
 
void rotateCaption (float angle, PointF anchor)
 Rotates captions. More...
 
void rotateCaption (float angle)
 Rotates caption with the caption center point as the anchor point. More...
 
void setTextFrameOriginRect (RectF rc)
 Set the original frame size of the frame caption. If the current caption is not a frame caption, this function has no effect. You can get origin frame size. More...
 
RectF getTextBoundingRect ()
 Gets caption text rectangle. More...
 
List< PointF > getBoundingRectangleVertices ()
 Gets the vertex position of the original enclosing rectangle of the caption after transformation. More...
 
List< PointF > getCaptionBoundingVertices (int boundingType)
 Gets the transformed vertices position of the original caption bounding. More...
 
void setSecondaryColor (NvsColor color)
 Sets caption secondary color. it is only used in karaoke subtitles now. More...
 
NvsColor getSecondaryColor ()
 Gets the current color value of the caption. More...
 
void setSecondaryOutlineColor (NvsColor color)
 Sets caption secondary outline color. it is only used in karaoke subtitles now. More...
 
NvsColor getSecondaryOutlineColor ()
 Gets the current outline sencondary color value of the caption. More...
 
boolean isPanoramic ()
 Determines whether the current caption is a panorama caption. More...
 
boolean isModular ()
 Determines whether the current caption is a modular caption. More...
 
void setCenterPolarAngle (float centerPolarAngle)
 Sets the polar angle of the center point for the caption. It is only valid for panorama captions. More...
 
float getCenterPolarAngle ()
 Gets the polar angle of the center point for the caption. It is only valid for panorama captions. More...
 
float getTextCenterPolarAngle ()
 Gets the polar angle of the center point for the caption. It is only valid for panorama captions. More...
 
void setCenterAzimuthAngle (float centerAzimuthAngle)
 Sets the azimuth of the center point for the caption. It is only valid for panorama captions. More...
 
float getCenterAzimuthAngle ()
 Gets the azimuth of the center point for the caption. It is only valid for panorama captions. More...
 
float getTextCenterAzimuthAngle ()
 Gets the azimuth of the center point for the caption. It is only valid for panorama captions. More...
 
void setPolarAngleRange (float polarAngleRange)
 Sets the caption's field angle, which is coplanar with the polar angle. It is only valid for panorama captions. More...
 
float getPolarAngleRange ()
 Gets the caption's field angle, which is coplanar with the polar angle. It is only valid for panorama captions. More...
 
float getOrthoAngleRange ()
 Gets the caption's field angle which is perpendicular to the polar angle. It is only valid for panorama captions. More...
 
float getTextPolarAngleRange ()
 Gets the text's field angle which is perpendicular to the polar angle. It is only valid for panorama captions. More...
 
float getTextOrthoAngleRange ()
 Gets the text's field angle which is perpendicular to the polar angle. It is only valid for panorama captions. More...
 
void setPanoramicScaleX (float scaleX)
 Sets the horizontal scaling factor for the caption. It is only valid for panorama captions. More...
 
float getPanoramicScaleX ()
 Gets the horizontal scaling factor for the caption. It is only valid for panorama captions. More...
 
void setPanoramicScaleY (float scaleY)
 Sets the vertical scaling factor for the caption. It is only valid for panorama captions. More...
 
float getPanoramicScaleY ()
 Gets the vertical scaling factor for the caption. It is only valid for panorama captions. More...
 
void setPanoramicRotation (float rotationAngle)
 Sets the rotation angle for the caption. It is only valid for panorama captions. More...
 
float getPanoramicRotation ()
 Gets the rotation angle for the caption. It is only valid for panorama captions. More...
 
void setZValue (float value)
 Sets caption Z value. More...
 
float getZValue ()
 Gets caption Z value. More...
 
void setRecordingUserOperation (boolean recordingUserOperation)
 Sets whether to record user actions. More...
 
boolean isRecordingUserOperation ()
 Default is true. More...
 
void setOpacity (float opacity)
 Set the caption opacity. More...
 
float getOpacity ()
 Get the caption opacity. More...
 
void setBackgroundColor (NvsColor backgroundColor)
 Set text background color. More...
 
NvsColor getBackgroundColor ()
 Get the current text background color value. More...
 
void setBackgroundRadius (float radius)
 Set text background rectangle's corner radius. More...
 
float getBackgroundRadius ()
 Get the current text background rectangle's corner radius value. More...
 
void setCurrentKeyFrameTime (long time)
 Set the caption KeyFrameTime. More...
 
boolean setControlPoint (String fxParam, NvsControlPointPair controlPointPair)
 Set the caption's control point pair. More...
 
NvsControlPointPair getControlPoint (String fxParam)
 Get the caption's key frame control point pair. More...
 
boolean isFrameCaption ()
 Determine if it is a border caption. More...
 
void setFrameCaptionMaxFontSize (float maxFontSize)
 Sets the max font size for border caption. Only border caption can use this method. More...
 
void setTextSpanList (List< NvsCaptionSpan > nvCaptionSpanList)
 
List< NvsCaptionSpangetTextSpanList ()
 
NvsCaptionTextLayout getTextLayout ()
 
void setDisableElegantTextHeight (boolean disableElegantTextHeight)
 Due to historical factors, Meishe SDK uses the elegant text height feature in the horizontal text layout of the Android platform, which will cause the horizontal layout of the Android platform to be different from the line spacing of other platforms. Setting this property will disable the use of the elegant text height feature for Android horizontal layout. The default value is false. More...
 
boolean getDisableElegantTextHeight ()
 Get is prohibit elegant text height. More...
 
int getComplexRenderLayerCount ()
 
boolean hasOutlineLayerInComplexRender (int layerIndex)
 
NvsColor getComplexRenderLayerOutlineColor (int layerIndex)
 
boolean setComplexRenderLayerOutlineColor (int layerIndex, NvsColor color)
 
float getComplexRenderLayerOutlineWidth (int layerIndex)
 
boolean setComplexRenderLayerOutlineWidth (int layerIndex, float width)
 
float getComplexRenderLayerOpacity (int layerIndex)
 
boolean setComplexRenderLayerOpacity (int layerIndex, float opacity)
 
- Public Member Functions inherited from com.meicam.sdk.NvsFx
NvsFxDescription getDescription ()
 Get decription of Fx. More...
 
void setIntVal (String fxParam, int val)
 Set the integer parameter of NvsFx. More...
 
int getIntVal (String fxParam)
 Get the integer parameter of NvsFx. More...
 
void setIntValAtTime (String fxParam, int val, long time)
 Set the NvsFx's integer parameter at a specified time point. More...
 
int getIntValAtTime (String fxParam, long time)
 Get the NvsFx's integer parameter at a specified time point. More...
 
void setFloatVal (String fxParam, double val)
 Set the float parameter of NvsFx. More...
 
double getFloatVal (String fxParam)
 Get the float parameter of NvsFx. More...
 
void setFloatValAtTime (String fxParam, double val, long time)
 Set the NvsFx's float parameter at a specified time point. More...
 
double getFloatValAtTime (String fxParam, long time)
 Get the NvsFx's float parameter at a specified time point. More...
 
void setBooleanVal (String fxParam, boolean val)
 Set the boolean parameter of NvsFx. More...
 
boolean getBooleanVal (String fxParam)
 Get the boolean parameter of NvsFx. More...
 
void setBooleanValAtTime (String fxParam, boolean val, long time)
 Set the NvsFx’s boolean parameter at a specified time point. More...
 
boolean getBooleanValAtTime (String fxParam, long time)
 Get the NvsFx's boolean parameter at a specified time point. More...
 
void setStringVal (String fxParam, String val)
 Set the string parameter of NvsFx. More...
 
String getStringVal (String fxParam)
 Get the string parameter of NvsFx. More...
 
void setStringValAtTime (String fxParam, String val, long time)
 Set the NvsFx's string parameter at a specified time point. More...
 
String getStringValAtTime (String fxParam, long time, int flags)
 Get the NvsFx's string parameter at a specified time point. More...
 
void setColorVal (String fxParam, NvsColor val)
 Set the color parameter of NvsFx. More...
 
NvsColor getColorVal (String fxParam)
 Get the color parameter of NvsFx. More...
 
void setColorValAtTime (String fxParam, NvsColor val, long time)
 Set the NvsFx's color parameter at a specified time point. More...
 
NvsColor getColorValAtTime (String fxParam, long time)
 Get the NvsFx's color parameter at a specified time point. More...
 
void setPosition2DVal (String fxParam, NvsPosition2D val)
 Set the two dimentional coordinates parameter of NvsFx. More...
 
NvsPosition2D getPosition2DVal (String fxParam)
 Get the two dimentional coordinates parameter of NvsFx. More...
 
void setPosition2DValAtTime (String fxParam, NvsPosition2D val, long time)
 Set the NvsFx's two dimentional coordinates parameter at a specified time point. More...
 
NvsPosition2D getPosition2DValAtTime (String fxParam, long time)
 Get the NvsFx's two dimentional coordinates parameter at a specified time point. More...
 
void setPosition3DVal (String fxParam, NvsPosition3D val)
 Set the three dimentional coordinates parameter of NvsFx. More...
 
NvsPosition3D getPosition3DVal (String fxParam)
 Get the three dimentional coordinates parameter of NvsFx. More...
 
void setPosition3DValAtTime (String fxParam, NvsPosition3D val, long time)
 Set the NvsFx's three dimentional coordinates parameter at a specified time point. More...
 
NvsPosition3D getPosition3DValAtTime (String fxParam, long time)
 Get the NvsFx's three dimentional coordinates parameter at a specified time point. More...
 
void setMenuVal (String fxParam, String val)
 Set the menu parameter of NvsFx. More...
 
String getMenuVal (String fxParam)
 Get the menu parameter of NvsFx. More...
 
void setMenuValAtTime (String fxParam, String val, long time)
 Set the NvsFx's menu parameter at a specified time point. More...
 
String getMenuValAtTime (String fxParam, long time)
 Get the NvsFx menu parameter at a specified time point. More...
 
void setArbDataVal (String fxParam, NvsArbitraryData val)
 Set custom data parameter value. More...
 
NvsArbitraryData getArbDataVal (String fxParam)
 Get custom data parameter value. More...
 
void setArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
 Sets custom data parameter value. More...
 
NvsArbitraryData getArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
 Get custom data parameter value at a specified time point. More...
 
boolean removeKeyframeAtTime (String fxParam, long time)
 Remove key frame at a specified time point from key frame list. More...
 
boolean removeAllKeyframe (String fxParam)
 Remove all key frames from key frame list. More...
 
boolean hasKeyframeList (String fxParam)
 Check whether the parameter has key frame list or not. More...
 
long findKeyframeTime (String fxParam, long time, int flags)
 Get key frame at a specified time point. More...
 
boolean setKeyFrameControlPoint (String fxParam, long time, NvsControlPointPair controlPointPair)
 Set key frame control point pair. More...
 
NvsControlPointPair getKeyFrameControlPoint (String fxParam, long time)
 Get key frame control point pair. More...
 
boolean setKeyFrameControlPointMode (String fxParam, long time, NvsControlPointModePair controlPointModePair)
 Set key frame control point mode pair. More...
 
NvsControlPointModePair getKeyFrameControlPointMode (String fxParam, long time)
 Get key frame control point mode pair. More...
 
void setFilterIntensity (float intensity)
 Set the intensity of the filter. More...
 
float getFilterIntensity ()
 Get the intensity of the filter. More...
 
void setFilterMask (boolean useMask)
 Set the mask of the filter. More...
 
boolean getFilterMask ()
 Get the usage of the filter's mask. More...
 
void setRegional (boolean isRegional)
 Set whether the filter is regional. More...
 
boolean getRegional ()
 Get whether the filter is regional. More...
 
void setIgnoreBackground (boolean isIgnoreBackground)
 Set whether the regional filter ignores background. More...
 
boolean getIgnoreBackground ()
 Get whether the regional filter ignores background. More...
 
void setInverseRegion (boolean isInverseRegion)
 Set whether the regional filter inverses region. More...
 
boolean getInverseRegion ()
 Get whether the regional filter inverses region. More...
 
void setRegion (float[] region)
 Set the region of this regional filter. More...
 
float[] getRegion ()
 Get the region of this regional filter. More...
 
void setRegionInfo (NvsMaskRegionInfo info)
 Set the mask region informations of the regional filter. More...
 
NvsMaskRegionInfo getRegionInfo ()
 Get the mask region informations of the regional filter. More...
 
void setRegionInfoAtTime (NvsMaskRegionInfo info, long time)
 Set the regional filter's mask region informations at a specified time point. More...
 
NvsMaskRegionInfo getRegionInfoAtTime (long time)
 Get the the regional filter's mask region informations at a specified time. More...
 
void setRegionalFeatherWidth (float featherWidth)
 Set the feather width of the regional filter. More...
 
float getRegionalFeatherWidth ()
 Get the feather width of the regional filter. More...
 
void setRegionalFeatherWidthAtTime (float featherWidth, long time)
 Set the regional filter's feather width at a specified time point. More...
 
float getRegionalFeatherWidthAtTime (long time)
 Get the regional filter's feather width at a specified time point. More...
 
void setRegionCoordinateSystemType (int type)
 Set the coordinate system of the region. More...
 
int getRegionCoordinateSystemType ()
 Get the coordinate system type of the region. More...
 
NvsParticleSystemContext getParticleSystemContext ()
 Get the particle effect context object.Please refer to NvsParticleSystemContext. More...
 
NvsARFaceContext getARFaceContext ()
 Get face effect context object.Please refer to NvsARFaceContext. More...
 
NvsPaintingEffectContext getPaintingEffectContext ()
 Get the particle effect context object.Please refer to NvsPaintingEffectContext. More...
 
NvsARSceneManipulate getARSceneManipulate ()
 Get the AR scene operation object.Please refer to NvsARSceneManipulate. More...
 
void setExprVar (String varName, double varValue)
 Set the value of the defined parameter in the expression. More...
 
double getExprVar (String varName)
 Get the value of the defined parameter in the expression. More...
 
void setExprStringVar (String varName, String varValue)
 Set the value of the defined parameter in the expression. More...
 
String getExprStringVar (String varName)
 Get the value of the defined parameter in the expression. More...
 
void setExprObjectVar (String varName, Object varValue)
 Set the value of the defined parameter in the expression. More...
 
Object getExprObjectVar (String varName)
 Get the value of the defined parameter in the expression. More...
 
void clearExprVar (String varName)
 Clear the value of the defined parameter in the expression and set it to the default value of 0. More...
 
void clearExprVarCtx ()
 Clear all parameter values defined in the expression and set them to the default value of 0. More...
 
- Public Member Functions inherited from com.meicam.sdk.NvsObject
void setAttachment (String key, Object value)
 Adds additional data to the NvsObject object to identify the NvsObject object or for other purpose. More...
 
void setTemplateAttachment (String key, String value)
 Adds additional template data to the NvsObject object to identify the NvsObject template object. More...
 
Object getAttachment (String key)
 Gets an attachment to NvsObject. More...
 
String getTemplateAttachment (String key)
 Gets an template attachment to NvsObject. More...
 

Additional Inherited Members

- Static Public Attributes inherited from com.meicam.sdk.NvsCaption
static final int DEFAULT_CATEGORY = 0
 Default category. More...
 
static final int USER_CATEGORY = 1
 Customized category. More...
 
static final int THEME_CATEGORY = 2
 Theme category. More...
 
static final int ROLE_IN_THEME_GENERAL = 0
 General. More...
 
static final int ROLE_IN_THEME_TITLE = 1
 Title. More...
 
static final int ROLE_IN_THEME_TRAILER = 2
 Trailer. More...
 
static final int TEXT_ALIGNMENT_LEFT = 0
 Left alignment(Top alignment for vertical layout) More...
 
static final int TEXT_ALIGNMENT_CENTER = 1
 Center alignment. More...
 
static final int TEXT_ALIGNMENT_RIGHT = 2
 Right alignment(Bottom alignment for vertical layout) More...
 
static final int TEXT_ALIGNMENT_TOP = 3
 Top alignment, valid for frame-caption only. More...
 
static final int TEXT_ALIGNMENT_BOTTOM = 4
 Bottom alignment, valid for frame-caption only. More...
 
static final int TEXT_ALIGNMENT_VCENTER = 5
 Vertical center alignment, valid for frame-caption only. More...
 
static final int USE_ASSET_DEFAULT_PARAM = 0
 Uses the default caption package properties. More...
 
static final int NOT_USE_ASSET_DEFAULT_PARAM = 1
 Do not use the default caption package properties. More...
 
static final int BOUNDING_TYPE_TEXT = 0
 The actual text bounding. More...
 
static final int BOUNDING_TYPE_TEXT_FRAME = 1
 Text frame bounding. More...
 
static final int BOUNDING_TYPE_FRAME = 2
 The whole bounding including decoration. More...
 
static final int BOUNDING_TYPE_TEXT_ORIGIN_FRAME = 3
 Text frame bounding that has not been transformed. More...
 
static final int BOUNDING_TYPE_TYPOGRAPHIC_TEXT = 4
 
static final int LETTER_SPACING_TYPE_PERCENTAGE = 0
 letter spacing type is percentage More...
 
static final int LETTER_SPACING_TYPE_ABSOLUTE = 1
 
- Static Public Attributes inherited from com.meicam.sdk.NvsFx
static final int KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE = 1
 find key frame before current time More...
 
static final int KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER = 2
 
static final int REGION_COORDINATE_SYSTEM_TYPE_NDC = 0
 NDC coordinate system. More...
 
static final int REGION_COORDINATE_SYSTEM_TYPE_TIMELINE = 1
 
static final int FACE_WARP_EFFECT_STRATEGY_CUSTOM = 0x7FFFFFFF
 
- Static Public Attributes inherited from com.meicam.sdk.NvsObject
static final String TEMPLATE_KEY_REPLACE_ID = "MSTemplate-ReplaceId"
 
static final String TEMPLATE_KEY_FOOTAGE_CAN_REPLACE = "MSTemplate-FootageCanReplace"
 
static final String TEMPLATE_KEY_FOOTAGE_ID = "MSTemplate-FootageId"
 
static final String TEMPLATE_KEY_FOOTAGE_NAME = "MSTemplate-FootageName"
 
static final String TEMPLATE_KEY_FOOTAGE_M3U8_NAME = "MSTemplate-FootageM3U8Name"
 
static final String TEMPLATE_KEY_FOOTAGE_TAGS = "MSTemplate-FootageTags"
 
static final String TEMPLATE_KEY_FOOTAGE_TYPE = "MSTemplate-FootageType"
 
static final String TEMPLATE_KEY_FOOTAGE_NEED_REVERSE = "MSTemplate-FootageNeedReverse"
 
static final String TEMPLATE_KEY_CLIP_RAW_WIDTH = "MSTemplate-ClipRawWidth"
 
static final String TEMPLATE_KEY_CLIP_RAW_HEIGHT = "MSTemplate-ClipRawHeight"
 
static final String TEMPLATE_KEY_VOLUME_TYPE = "MSTemplate-VolumeType"
 
static final String TEMPLATE_KEY_FX_GROUP = "MSTemplate-FxGroup"
 
static final String TEMPLATE_KEY_BEST_SEEK_TIME = "MSTemplate-BestSeekTime"
 
static final String TEMPLATE_KEY_MASK_TYPE = "MSTemplate-MaskType"
 
static final String TEMPLATE_VALUE_MASK_TYPE_LINE = "MSTemplate-MaskType-Line"
 
static final String TEMPLATE_VALUE_MASK_TYPE_MIRROR = "MSTemplate-MaskType-Mirror"
 
static final String TEMPLATE_VALUE_MASK_TYPE_CIRCLE = "MSTemplate-MaskType-Circle"
 
static final String TEMPLATE_VALUE_MASK_TYPE_RECT = "MSTemplate-MaskType-Rect"
 
static final String TEMPLATE_VALUE_MASK_TYPE_HEART = "MSTemplate-MaskType-Heart"
 
static final String TEMPLATE_VALUE_MASK_TYPE_STAR = "MSTemplate-MaskType-Star"
 
static final String TEMPLATE_KEY_TRANS_TYPE_CUT = "MSTemplate-TransType-Cut"
 
static final String TEMPLATE_KEY_CURVE_SPEED_TYPE = "MSTemplate-CurveSpeedType"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_CUSTOM = "MSTemplate-CurveSpeedType-Custom"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_MONTAGE = "MSTemplate-CurveSpeedType-Montage"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_HERO = "MSTemplate-CurveSpeedType-Hero"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_BULLET = "MSTemplate-CurveSpeedType-bullet"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_PLUS = "MSTemplate-CurveSpeedType-Plus"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_IN = "MSTemplate-CurveSpeedType-In"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_OUT = "MSTemplate-CurveSpeedType-Out"
 
- Protected Member Functions inherited from com.meicam.sdk.NvsObject
void setInternalObject (long internalObject)
 
long getInternalObject ()
 
- Protected Attributes inherited from com.meicam.sdk.NvsObject
long m_internalObject = 0
 

Detailed Description

Timeline captions.

Timeline captions are custom text that is superimposed on the video. When editing a video, users can add and remove timeline captions and adjust the captions position. After adding captions, user can also set the style, including font size, color, shadow, stroke, etc.

Warning
In the NvsTimelineCaption class, all public APIs are used in the UI thread! ! !

Member Function Documentation

◆ changeInPoint()

long com.meicam.sdk.NvsTimelineCaption.changeInPoint ( long  newInPoint)
inline

Changes the in-point of the caption on the timeline.

Parameters
newInPointThe new in-point of the caption on the timeline (in microseconds).
Returns
Returns the in-point of the caption on the timeline (in microseconds).
Warning
This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.
See also
changeOutPoint
getInPoint
movePosition

◆ changeOutPoint()

long com.meicam.sdk.NvsTimelineCaption.changeOutPoint ( long  newOutPoint)
inline

Changes the out-point of the caption on the timeline.

Parameters
newOutPointThe new out-point of the caption on the timeline (in microseconds).
Returns
Returns the out-point of the caption on the timeline (in microseconds).
Warning
This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to [Engine Change].(Engine of Changing).
See also
changeInPoint
getOutPoint
movePosition

◆ getClipAffinityEnabled()

boolean com.meicam.sdk.NvsTimelineCaption.getClipAffinityEnabled ( )
inline

Gets whether the affinity between the caption and the clip is on.

Returns
Returns whether the affinity between caption and clips is turned on.
Since
1.7.1

◆ getInPoint()

long com.meicam.sdk.NvsTimelineCaption.getInPoint ( )
inline

Get the in-point of the caption on the timeline.

Returns
The in-point of the caption on the timeline (in microseconds).
See also
getOutPoint
changeInPoint

◆ getOutPoint()

long com.meicam.sdk.NvsTimelineCaption.getOutPoint ( )
inline

The out-point of the caption on the timeline.

Returns
The out-point of the caption on the timeline (in microseconds).
See also
getInPoint
changeOutPoint

◆ movePosition()

void com.meicam.sdk.NvsTimelineCaption.movePosition ( long  offset)
inline

Changes the display position of the caption on the timeline (the in and out points are offset from the offset value at the same time).

Parameters
offsetOffset value for in and out points changes (in microseconds).
Warning
This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.
See also
changeInPoint
changeOutPoint

◆ setClipAffinityEnabled()

void com.meicam.sdk.NvsTimelineCaption.setClipAffinityEnabled ( boolean  enable)
inline

Sets whether the affinity between the caption and the clip is on.

Parameters
enableWhether to start the affinity between the caption and the clip. If it is started, the operation of the clip will affect the caption. Default mode is on.
Since
1.7.1

The documentation for this class was generated from the following file: