Timeline captions. More...

Inheritance diagram for com.meicam.sdk.NvsTimelineCaption:

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...

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...

boolean	applyCaptionStyle (String captionStylePackageId)
	Applys caption style. More...

boolean	applyCaptionStyle (String captionStylePackageId, int isUseDefaultAssetParam)
	Applys caption style. More...

void	setText (String text)
	Sets caption text. More...

String	getText ()
	Gets caption text. More...

void	setTextAlignment (int textAlign)
	Sets caption alignment style. More...

int	getTextAlignment ()
	Gets caption alignment style. More...

void	setBold (boolean bold)
	Sets caption font bold. More...

boolean	getBold ()
	Gets the caption font bold state. More...

void	setItalic (boolean italic)
	Sets caption font italic. More...

boolean	getItalic ()
	Gets the caption italic state. More...

void	setLetterSpacing (float letterSpacing)
	Sets caption word spacing. More...

float	getLetterSpacing ()
	Gets caption word spacing. More...

void	setTextColor (NvsColor textColor)
	Sets caption text color. 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	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	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	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...

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...

boolean	isPanoramic ()
	Determines whether the current caption is a panorama 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...

Public Member Functions inherited from com.meicam.sdk.NvsFx
NvsFxDescription	getDescription ()
	Gets decription of Fx. More...

void	setIntVal (String fxParam, int val)
	Sets the integer parameter of NvsFx. More...

int	getIntVal (String fxParam)
	Gets the integer parameter of NvsFx. More...

void	setFloatVal (String fxParam, double val)
	Sets the float parameter of NvsFx. More...

double	getFloatVal (String fxParam)
	Gets the float parameter of NvsFx. More...

void	setBooleanVal (String fxParam, boolean val)
	Sets the boolean parameter of NvsFx. More...

boolean	getBooleanVal (String fxParam)
	Gets the boolean parameter of NvsFx. More...

void	setStringVal (String fxParam, String val)
	Sets the string parameter of NvsFx. More...

String	getStringVal (String fxParam)
	Gets the string parameter of NvsFx. More...

void	setColorVal (String fxParam, NvsColor val)
	Sets the color parameter of NvsFx. More...

NvsColor	getColorVal (String fxParam)
	Gets the color parameter of NvsFx. More...

void	setPosition2DVal (String fxParam, NvsPosition2D val)
	Sets the two dimentional coordinates parameter of NvsFx. More...

NvsPosition2D	getPosition2DVal (String fxParam)
	Gets the two dimentional coordinates parameter of NvsFx. More...

void	setPosition3DVal (String fxParam, NvsPosition3D val)
	Sets the three dimentional coordinates parameter of NvsFx. More...

NvsPosition3D	getPosition3DVal (String fxParam)
	Gets the three dimentional coordinates parameter of NvsFx. More...

void	setMenuVal (String fxParam, String val)
	Sets the menu parameter of NvsFx. More...

String	getMenuVal (String fxParam)
	Gets the menu parameter of NvsFx. More...

void	setFilterIntensity (float intensity)
	Sets the intensity of the filter. More...

float	getFilterIntensity ()
	Gets the intensity of the filter. More...

NvsParticleSystemContext	getParticleSystemContext ()

NvsARFaceContext	getARFaceContext ()

NvsPaintingEffectContext	getPaintingEffectContext ()

NvsARSceneManipulate	getARSceneManipulate ()
	获得NvsARSceneManipulate接口 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...

Object	getAttachment (String key)
	Gets an attachment to NvsObject. More...

Static Public Attributes
Caption type

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...

The role of caption in the theme

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...

Caption alignment

static final int	TEXT_ALIGNMENT_LEFT = 0
	Left alignment. More...

static final int	TEXT_ALIGNMENT_CENTER = 1
	Center alignment. More...

static final int	TEXT_ALIGNMENT_RIGHT = 2
	Right alignment. More...

Uses the default caption package properties

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...

Additional Inherited Members
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

boolean com.meicam.sdk.NvsTimelineCaption.applyCaptionStyle ( String captionStylePackageId )

inline

Applys caption style.

Parameters

captionStylePackageId Caption style resource package ID.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

boolean com.meicam.sdk.NvsTimelineCaption.applyCaptionStyle	(	String	captionStylePackageId,
		int	isUseDefaultAssetParam
	)

inline

Applys caption style.

Parameters

captionStylePackageId	Caption style resource package ID.
isUseDefaultAssetParam	Whether to use the properties that come with the caption package. Please refer to Uses the default caption package properties.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

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

inline

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

Parameters

newInPoint The 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

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

inline

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

Parameters

newOutPoint The 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

PointF com.meicam.sdk.NvsTimelineCaption.getAnchorPoint ( )

inline

Gets caption anchor.

Returns: Returns caption anchor.

Since: 1.15.0

See also: setAnchorPoint

boolean com.meicam.sdk.NvsTimelineCaption.getBold ( )

inline

Gets the caption font bold state.

Returns: Returns the caption font bold state. True means the font is bold, false means the font is not bold.

See also: setBold

List<PointF> com.meicam.sdk.NvsTimelineCaption.getBoundingRectangleVertices ( )

inline

Gets the vertex position of the original enclosing rectangle of the caption after transformation.

Returns: Returns a List<PointF> object containing four vertex positions, which in turn correspond to the top left, bottom left, bottom right, and top right vertices of the original bounding rectangle.

Since: 1.8.1

String com.meicam.sdk.NvsTimelineCaption.getCaptionStylePackageId ( )

inline

Gets the caption style package ID.

Returns: Returns the obtained caption style resource package ID.

PointF com.meicam.sdk.NvsTimelineCaption.getCaptionTranslation ( )

inline

Gets the amount of caption translation.

Returns: Returns PointF object indicating the amount of caption translation obtained.

See also: setCaptionTranslation

int com.meicam.sdk.NvsTimelineCaption.getCategory ( )

inline

Gets the type of caption.

Returns: Returns to the obtained Caption type.

float com.meicam.sdk.NvsTimelineCaption.getCenterAzimuthAngle ( )

inline

Gets the azimuth of the center point for the caption. It is only valid for panorama captions.

Returns: Returns the polar angle of the center point in degrees.

Since: 1.6.0

float com.meicam.sdk.NvsTimelineCaption.getCenterPolarAngle ( )

inline

Gets the polar angle of the center point for the caption. It is only valid for panorama captions.

Returns: Returns the polar angle of the center point in degrees.

Since: 1.6.0

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

boolean com.meicam.sdk.NvsTimelineCaption.getDrawOutline ( )

inline

Gets the caption stroke status.

Returns: Returns boolean value, true means it is stroked, and false means it is not stroked.

See also: setDrawOutline

boolean com.meicam.sdk.NvsTimelineCaption.getDrawShadow ( )

inline

Gets the current caption shadow status.

Returns: Returns boolean value. True means there is caption shadow, false means there is no caption shadow.

See also: setDrawShadow

String com.meicam.sdk.NvsTimelineCaption.getFontFamily ( )

inline

Get the name of caption font.

Returns: Returns the name of caption font.

Since: 2.4.2

See also: setFontFamily

String com.meicam.sdk.NvsTimelineCaption.getFontFilePath ( )

inline

Gets the file path of the caption font.

Returns: Returns the file path of the caption font.

Since: 1.3.0

See also: setFontByFilePath

float com.meicam.sdk.NvsTimelineCaption.getFontSize ( )

inline

Gets the font size of the current caption.

Returns: Returns the obtained caption font size value.

See also: setFontSize

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

boolean com.meicam.sdk.NvsTimelineCaption.getItalic ( )

inline

Gets the caption italic state.

Returns: Returns boolean value. True means it is italic font, false means it is not italic.

See also: setItalic

float com.meicam.sdk.NvsTimelineCaption.getLetterSpacing ( )

inline

Gets caption word spacing.

Returns: Returns the float value, the percentage value. 100 is the original default word spacing.

See also: SetLetterSpacing

Since: 1.16.0

float com.meicam.sdk.NvsTimelineCaption.getOrthoAngleRange ( )

inline

Gets the caption's field angle which is perpendicular to the polar angle. It is only valid for panorama captions.

Returns: Returns caption's field angle which is perpendicular to the polar angle, in degrees.

Since: 1.7.0

NvsColor com.meicam.sdk.NvsTimelineCaption.getOutlineColor ( )

inline

Gets the color value of the current caption stroke.

Returns: Returns the NvsColor object representing the color of the resulting caption stroke.

See also: setOutlineColor

float com.meicam.sdk.NvsTimelineCaption.getOutlineWidth ( )

inline

Gets the width of the current caption stroke.

Returns: Returns the width value of the obtained caption stroke.

See also: setOutlineWidth

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

float com.meicam.sdk.NvsTimelineCaption.getPanoramicRotation ( )

inline

Gets the rotation angle for the caption. It is only valid for panorama captions.

Returns: Returns the rotation angle of caption.

Since: 1.7.1

float com.meicam.sdk.NvsTimelineCaption.getPanoramicScaleX ( )

inline

Gets the horizontal scaling factor for the caption. It is only valid for panorama captions.

Returns: Returns horizontal scaling factor.

Since: 1.6.0

float com.meicam.sdk.NvsTimelineCaption.getPanoramicScaleY ( )

inline

Gets the vertical scaling factor for the caption. It is only valid for panorama captions.

Returns: Returns the vertical scaling factor.

Since: 1.6.0

float com.meicam.sdk.NvsTimelineCaption.getPolarAngleRange ( )

inline

Gets the caption's field angle, which is coplanar with the polar angle. It is only valid for panorama captions.

Returns: Returns field angle coplanar with the polar angle, in degrees.

Since: 1.6.0

int com.meicam.sdk.NvsTimelineCaption.getRoleInTheme ( )

inline

The role of caption in the theme.

Returns: Returns The role of caption in the theme.

float com.meicam.sdk.NvsTimelineCaption.getRotationZ ( )

inline

Gets caption rotation angle.

Returns: Returns caption rotation angle.

Since: 1.14.1

See also: setRotationZ

float com.meicam.sdk.NvsTimelineCaption.getScaleX ( )

inline

Gets caption horizontal scaling factor.

Returns: Returns caption horizontal scaling factor.

Since: 1.14.1

See also: setScaleX; getScaleY

float com.meicam.sdk.NvsTimelineCaption.getScaleY ( )

inline

Gets caption vertical scaling factor.

Returns: Returns caption vertical scaling factor.

Since: 1.14.1

See also: setScaleY; getScaleX

NvsColor com.meicam.sdk.NvsTimelineCaption.getShadowColor ( )

inline

Gets the color of the caption shadow.

Returns: Returns the NvsColor object representing the caption shadow color value obtained.

See also: setShadowColor

PointF com.meicam.sdk.NvsTimelineCaption.getShadowOffset ( )

inline

Gets the offset of the current caption shadow.

Returns: Returns a PointF object representing the caption shadow offset obtained.

See also: setShadowOffset

String com.meicam.sdk.NvsTimelineCaption.getText ( )

inline

Gets caption text.

Returns: Returns caption text obtained.

See also: setText

int com.meicam.sdk.NvsTimelineCaption.getTextAlignment ( )

inline

Gets caption alignment style.

Returns: Returns caption alignment style.

See also: setTextAlignment

Since: 1.10.0

RectF com.meicam.sdk.NvsTimelineCaption.getTextBoundingRect ( )

inline

Gets caption text rectangle.

Returns: Returns RectF object representing the obtained caption text rectangle.

float com.meicam.sdk.NvsTimelineCaption.getTextCenterAzimuthAngle ( )

inline

Gets the azimuth of the center point for the caption. It is only valid for panorama captions.

Returns: Returns the polar angle of the center point in degrees.

Since: 2.5.1

float com.meicam.sdk.NvsTimelineCaption.getTextCenterPolarAngle ( )

inline

Gets the polar angle of the center point for the caption. It is only valid for panorama captions.

Returns: Returns the polar angle of the center point in degrees.

Since: 2.5.1

NvsColor com.meicam.sdk.NvsTimelineCaption.getTextColor ( )

inline

Gets the current color value of the caption font.

Returns: Returns the NvsColor object representing the color value obtained.

See also: setTextColor

float com.meicam.sdk.NvsTimelineCaption.getTextOrthoAngleRange ( )

inline

Gets the text's field angle which is perpendicular to the polar angle. It is only valid for panorama captions.

Returns: Returns text's field angle which is perpendicular to the polar angle, in degrees.

Since: 2.5.1

float com.meicam.sdk.NvsTimelineCaption.getTextPolarAngleRange ( )

inline

Gets the text's field angle which is perpendicular to the polar angle. It is only valid for panorama captions.

Returns: Returns the text's field angle which is perpendicular to the polar angle, in degrees.

Since: 2.5.1

float com.meicam.sdk.NvsTimelineCaption.getZValue ( )

inline

Gets caption Z value.

Returns: Returns caption Z value.

Since: 1.10.0

boolean com.meicam.sdk.NvsTimelineCaption.isPanoramic ( )

inline

Determines whether the current caption is a panorama caption.

Returns: If returns value is true, it is panorama caption.

Since: 1.6.0

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

offset Offset 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

void com.meicam.sdk.NvsTimelineCaption.rotateCaption	(	float	angle,
		PointF	anchor
	)

inline

Rotates captions.

Parameters

angle	Angle of caption rotation.
anchor	Anchor of caption rotation.

Since: 1.8.1

void com.meicam.sdk.NvsTimelineCaption.rotateCaption ( float angle )

inline

Rotates caption with the caption center point as the anchor point.

Parameters

angle Angle of caption rotation.

Since: 1.8.1

void com.meicam.sdk.NvsTimelineCaption.scaleCaption	(	float	scaleFactor,
		PointF	anchor
	)

inline

Zooms caption.

Parameters

scaleFactor	Caption scaling factor.
anchor	Caption zoom anchor.

Since: 1.8.1

void com.meicam.sdk.NvsTimelineCaption.setAnchorPoint ( PointF anchor )

inline

Sets caption anchor.

Parameters

anchor Anchor.

Since: 1.15.0

See also: getAnchorPoint

void com.meicam.sdk.NvsTimelineCaption.setBold ( boolean bold )

inline

Sets caption font bold.

Parameters

bold	Indicates whether the caption font is bold. True means the font is bold, false means the font is not bold.

See also: getBold

void com.meicam.sdk.NvsTimelineCaption.setCaptionTranslation ( PointF translation )

inline

Sets the amount of caption translation.

Parameters

translation The horizontal and vertical absolute translation of the caption.

See also: getCaptionTranslation

void com.meicam.sdk.NvsTimelineCaption.setCenterAzimuthAngle ( float centerAzimuthAngle )

inline

Sets the azimuth of the center point for the caption. It is only valid for panorama captions.

Parameters

centerAzimuthAngle The polar angle of the center point in degrees.

Since: 1.6.0

void com.meicam.sdk.NvsTimelineCaption.setCenterPolarAngle ( float centerPolarAngle )

inline

Sets the polar angle of the center point for the caption. It is only valid for panorama captions.

Parameters

centerPolarAngle The polar angle of the center point in degrees.

Since: 1.6.0

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

inline

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

Parameters

enable Whether 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

void com.meicam.sdk.NvsTimelineCaption.setDrawOutline ( boolean drawOutline )

inline

Sets caption stroke.

Parameters

drawOutline Whether to stroke the captions. True means it strokes the caption. False means it does not stroke the edges.

See also: getDrawOutline

void com.meicam.sdk.NvsTimelineCaption.setDrawShadow ( boolean drawShadow )

inline

Sets caption shadows.

Parameters

drawShadow Whether to set the caption shadow. True means to set the caption shadow, false means to not set.

See also: getDrawShadow

void com.meicam.sdk.NvsTimelineCaption.setFontByFilePath ( String filePath )

inline

Sets caption font.

Parameters

filePath The file path of the caption font. If it is set to a null string, it is set as the default font.

Since: 1.3.0

See also: getFontFilePath

void com.meicam.sdk.NvsTimelineCaption.setFontFamily ( String family )

inline

Sets caption font.

Parameters

family Caption font name. It will be set to default font if a null string which is given.

Since: 2.4.2

See also: getFontFamily

void com.meicam.sdk.NvsTimelineCaption.setFontSize ( float fontSize )

inline

Sets the caption font size.

Parameters

fontSize Caption font size value

See also: getFontSize

void com.meicam.sdk.NvsTimelineCaption.setItalic ( boolean italic )

inline

Sets caption font italic.

Parameters

italic Whether it is set to italic. True means that the caption font is set to italic, and false means the caption font is not set to italic.

See also: getItalic

void com.meicam.sdk.NvsTimelineCaption.setLetterSpacing ( float letterSpacing )

inline

Sets caption word spacing.

Parameters

letterSpacing Word spacing is expressed in percentage value. 100 is the original default word spacing value.

See also: GetLetterSpacing

Since: 1.16.0

void com.meicam.sdk.NvsTimelineCaption.setOutlineColor ( NvsColor outlineColor )

inline

Sets the color of the caption stroke.

Parameters

outlineColor Caption stroke color value.

See also: getOutlineColor

void com.meicam.sdk.NvsTimelineCaption.setOutlineWidth ( float outlineWidth )

inline

Sets the width of the caption stroke.

Parameters

outlineWidth The width of the caption stroke.

See also: getOutlineWidth

void com.meicam.sdk.NvsTimelineCaption.setPanoramicRotation ( float rotationAngle )

inline

Sets the rotation angle for the caption. It is only valid for panorama captions.

Parameters

rotationAngle The rotation angle.

Since: 1.7.1

void com.meicam.sdk.NvsTimelineCaption.setPanoramicScaleX ( float scaleX )

inline

Sets the horizontal scaling factor for the caption. It is only valid for panorama captions.

Parameters

scaleX Horizontal scaling factor.

Since: 1.6.0

void com.meicam.sdk.NvsTimelineCaption.setPanoramicScaleY ( float scaleY )

inline

Sets the vertical scaling factor for the caption. It is only valid for panorama captions.

Parameters

scaleY The vertical scaling factor.

Since: 1.6.0

void com.meicam.sdk.NvsTimelineCaption.setPolarAngleRange ( float polarAngleRange )

inline

Sets the caption's field angle, which is coplanar with the polar angle. It is only valid for panorama captions.

Parameters

polarAngleRange The field angle coplanar with the polar angle, in degrees.

Since: 1.6.0

void com.meicam.sdk.NvsTimelineCaption.setRotationZ ( float angle )

inline

Sets the rotation angle for the caption.

Parameters

angle Rotation angle.

Since: 1.14.1

See also: getRotationZ

void com.meicam.sdk.NvsTimelineCaption.setScaleX ( float scale )

inline

Sets horizontal scaling factor for caption.

Parameters

scale Horizontal scaling factor.

Since: 1.14.1

See also: getScaleX; setScaleY

void com.meicam.sdk.NvsTimelineCaption.setScaleY ( float scale )

inline

Sets vertical scaling factor for captions.

Parameters

scale Vertical scaling factor.

Since: 1.14.1

See also: getScaleY; setScaleX

void com.meicam.sdk.NvsTimelineCaption.setShadowColor ( NvsColor shadowColor )

inline

Sets the color of the caption shadow.

Parameters

shadowColor Caption shadow color value.

See also: getShadowColor

void com.meicam.sdk.NvsTimelineCaption.setShadowOffset ( PointF shadowOffset )

inline

Sets the offset of the caption shadow.

Parameters

shadowOffset Caption shadow offset.

See also: getShadowOffset

void com.meicam.sdk.NvsTimelineCaption.setText ( String text )

inline

Sets caption text.

Parameters

text	Caption text

See also: getText

void com.meicam.sdk.NvsTimelineCaption.setTextAlignment ( int textAlign )

inline

Sets caption alignment style.

Parameters

textAlign Indicates the caption alignment style. Please refer to Caption alignment.

See also: getTextAlignment

Since: 1.10.0

void com.meicam.sdk.NvsTimelineCaption.setTextColor ( NvsColor textColor )

inline

Sets caption text color.

Parameters

textColor Caption text color value.

See also: getTextColor

void com.meicam.sdk.NvsTimelineCaption.setZValue ( float value )

inline

Sets caption Z value.

Parameters

value Z value

Since: 1.10.0

void com.meicam.sdk.NvsTimelineCaption.translateCaption ( PointF translationOffset )

inline

Caption translation.

Parameters

translationOffset Horizontal and vertical offset values for caption.

Since: 1.7.0

See also: setCaptionTranslation; getCaptionTranslation

Member Data Documentation

final int com.meicam.sdk.NvsTimelineCaption.DEFAULT_CATEGORY = 0

static

Default category.

final int com.meicam.sdk.NvsTimelineCaption.NOT_USE_ASSET_DEFAULT_PARAM = 1

static

Do not use the default caption package properties.

final int com.meicam.sdk.NvsTimelineCaption.ROLE_IN_THEME_GENERAL = 0

static

General.

final int com.meicam.sdk.NvsTimelineCaption.ROLE_IN_THEME_TITLE = 1

static

Title.

final int com.meicam.sdk.NvsTimelineCaption.ROLE_IN_THEME_TRAILER = 2

static

Trailer.

final int com.meicam.sdk.NvsTimelineCaption.TEXT_ALIGNMENT_CENTER = 1

static

Center alignment.

final int com.meicam.sdk.NvsTimelineCaption.TEXT_ALIGNMENT_LEFT = 0

static

Left alignment.

final int com.meicam.sdk.NvsTimelineCaption.TEXT_ALIGNMENT_RIGHT = 2

static

Right alignment.

final int com.meicam.sdk.NvsTimelineCaption.THEME_CATEGORY = 2

static

Theme category.

final int com.meicam.sdk.NvsTimelineCaption.USE_ASSET_DEFAULT_PARAM = 0

static

Uses the default caption package properties.

final int com.meicam.sdk.NvsTimelineCaption.USER_CATEGORY = 1

static

Customized category.

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

src/android/jar/com/meicam/sdk/NvsTimelineCaption.java

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation