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

Timeline compound caption. More...

Inheritance diagram for com.meicam.sdk.NvsTimelineCompoundCaption:
com.meicam.sdk.NvsFx com.meicam.sdk.NvsObject

Public Member Functions

int getCaptionCount ()
 Gets number of sub-cpations in this compound caption. More...
 
void setClipAffinityEnabled (boolean enable)
 Sets whether to turn on affinity between the caption and video clip. More...
 
boolean getClipAffinityEnabled ()
 Gets whether the affinity between the caption and video clip is on. Default 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...
 
void setText (int captionIndex, String text)
 Sets caption text. More...
 
String getText (int captionIndex)
 Get caption text. More...
 
void setFontFamily (int captionIndex, String family)
 Sets caption font family. More...
 
String getFontFamily (int captionIndex)
 Get the name of caption font. More...
 
void setTextColor (int captionIndex, NvsColor textColor)
 Sets caption text color. More...
 
NvsColor getTextColor (int captionIndex)
 Gets the color value of the caption. 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)
 Translate caption. 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 rotateCaptionAroundCenter (float angle, int boundingType)
 Rotates caption around center of the bounding. More...
 
List< PointF > getCaptionBoundingVertices (int captionIndex, int boundingType)
 Gets the transformed vertices position of the original caption bounding. More...
 
List< PointF > getCompoundBoundingVertices (int boundingType)
 Gets the transformed vertices position of the original compound caption bounding. 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

Bounding type

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
 

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

Timeline compound captions are compound caption that is superimposed on the video, each compound caption may composed of several sub-captions. When editing a video, users can add or remove timeline compound captions and adjust the captions position. User can also set its properties such as font family, text color, etc.

Warning
In the NvsTimelineCompoundCaption class, all public APIs should be used in the UI thread!!!
Since
2.9.0

Member Function Documentation

long com.meicam.sdk.NvsTimelineCompoundCaption.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).
See also
changeOutPoint
getInPoint
movePosition
long com.meicam.sdk.NvsTimelineCompoundCaption.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).
See also
changeInPoint
getOutPoint
movePosition
PointF com.meicam.sdk.NvsTimelineCompoundCaption.getAnchorPoint ( )
inline

Gets caption anchor.

Returns
Returns caption anchor.
See also
setAnchorPoint
List<PointF> com.meicam.sdk.NvsTimelineCompoundCaption.getCaptionBoundingVertices ( int  captionIndex,
int  boundingType 
)
inline

Gets the transformed vertices position of the original caption bounding.

Parameters
captionIndexCaption index to get vertices positions
boundingTypeBounding type. Please refer to Bounding Type
Returns
Returns a List<PointF> object containing four vertices positions, which correspond to the top left, bottom left, bottom right, and top right vertices of the original bounding.
int com.meicam.sdk.NvsTimelineCompoundCaption.getCaptionCount ( )
inline

Gets number of sub-cpations in this compound caption.

Returns
Returns number of sub-cpations
PointF com.meicam.sdk.NvsTimelineCompoundCaption.getCaptionTranslation ( )
inline

Gets the amount of caption translation.

Returns
Returns PointF object indicating the amount of caption translation obtained.
See also
setCaptionTranslation
boolean com.meicam.sdk.NvsTimelineCompoundCaption.getClipAffinityEnabled ( )
inline

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

Returns
Returns whether the affinity between the caption and video clip is turned on.
List<PointF> com.meicam.sdk.NvsTimelineCompoundCaption.getCompoundBoundingVertices ( int  boundingType)
inline

Gets the transformed vertices position of the original compound caption bounding.

Parameters
boundingTypeBounding type. Please refer to Bounding Type
Returns
Returns a List<PointF> object containing four vertices positions, which correspond to the top left, bottom left, bottom right, and top right vertices of the original bounding.
String com.meicam.sdk.NvsTimelineCompoundCaption.getFontFamily ( int  captionIndex)
inline

Get the name of caption font.

Parameters
captionIndexcaption index to get font family
Returns
Returns the name of caption font.
See also
setFontFamily
long com.meicam.sdk.NvsTimelineCompoundCaption.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
long com.meicam.sdk.NvsTimelineCompoundCaption.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.NvsTimelineCompoundCaption.getRotationZ ( )
inline

Gets caption rotation angle.

Returns
Returns caption rotation angle.
See also
setRotationZ
float com.meicam.sdk.NvsTimelineCompoundCaption.getScaleX ( )
inline

Gets caption horizontal scaling factor.

Returns
Returns caption horizontal scaling factor.
See also
setScaleX
getScaleY
float com.meicam.sdk.NvsTimelineCompoundCaption.getScaleY ( )
inline

Gets caption vertical scaling factor.

Returns
Returns caption vertical scaling factor.
See also
setScaleY
getScaleX
String com.meicam.sdk.NvsTimelineCompoundCaption.getText ( int  captionIndex)
inline

Get caption text.

Parameters
captionIndexcaption index to get text
Returns
Returns caption text.
See also
setText
NvsColor com.meicam.sdk.NvsTimelineCompoundCaption.getTextColor ( int  captionIndex)
inline

Gets the color value of the caption.

Parameters
captionIndexcaption index to get text color
Returns
Return NvsColor object which is the text color
See also
setTextColor
float com.meicam.sdk.NvsTimelineCompoundCaption.getZValue ( )
inline

Gets caption Z value.

Returns
Returns caption Z value.
void com.meicam.sdk.NvsTimelineCompoundCaption.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).
See also
changeInPoint
changeOutPoint
void com.meicam.sdk.NvsTimelineCompoundCaption.rotateCaption ( float  angle,
PointF  anchor 
)
inline

Rotates captions.

Parameters
angleAngle of caption rotation.
anchorAnchor of caption rotation.
void com.meicam.sdk.NvsTimelineCompoundCaption.rotateCaptionAroundCenter ( float  angle,
int  boundingType 
)
inline

Rotates caption around center of the bounding.

Parameters
angleAngle of rotation, in degree
boundingTypeBounding type to calculate center point. Please refer to Bounding Type
void com.meicam.sdk.NvsTimelineCompoundCaption.scaleCaption ( float  scaleFactor,
PointF  anchor 
)
inline

Zooms caption.

Parameters
scaleFactorCaption scaling factor.
anchorCaption zoom anchor.
void com.meicam.sdk.NvsTimelineCompoundCaption.setAnchorPoint ( PointF  anchor)
inline

Sets caption anchor.

Parameters
anchorAnchor.
See also
getAnchorPoint
void com.meicam.sdk.NvsTimelineCompoundCaption.setCaptionTranslation ( PointF  translation)
inline

Sets the amount of caption translation.

Parameters
translationThe horizontal and vertical translation of the caption.
See also
getCaptionTranslation
void com.meicam.sdk.NvsTimelineCompoundCaption.setClipAffinityEnabled ( boolean  enable)
inline

Sets whether to turn on affinity between the caption and video clip.

Parameters
enableWhether to turn on affinity between the caption and video clip
void com.meicam.sdk.NvsTimelineCompoundCaption.setFontFamily ( int  captionIndex,
String  family 
)
inline

Sets caption font family.

Parameters
captionIndexcaption index to set font family
familyCaption font family name. It will be set to default font if family is an empty string
See also
getFontFamily
void com.meicam.sdk.NvsTimelineCompoundCaption.setRotationZ ( float  angle)
inline

Sets the rotation angle for the caption.

Parameters
angleRotation angle.
See also
getRotationZ
void com.meicam.sdk.NvsTimelineCompoundCaption.setScaleX ( float  scale)
inline

Sets horizontal scaling factor for caption.

Parameters
scaleHorizontal scaling factor.
See also
getScaleX
setScaleY
void com.meicam.sdk.NvsTimelineCompoundCaption.setScaleY ( float  scale)
inline

Sets vertical scaling factor for captions.

Parameters
scaleVertical scaling factor.
See also
getScaleY
setScaleX
void com.meicam.sdk.NvsTimelineCompoundCaption.setText ( int  captionIndex,
String  text 
)
inline

Sets caption text.

Parameters
captionIndexcaption index to set text
textCaption text
See also
getText
void com.meicam.sdk.NvsTimelineCompoundCaption.setTextColor ( int  captionIndex,
NvsColor  textColor 
)
inline

Sets caption text color.

Parameters
captionIndexcaption index to set text color
textColorCaption text color value.
See also
getTextColor
void com.meicam.sdk.NvsTimelineCompoundCaption.setZValue ( float  value)
inline

Sets caption Z value.

Parameters
valueZ value
void com.meicam.sdk.NvsTimelineCompoundCaption.translateCaption ( PointF  translationOffset)
inline

Translate caption.

Parameters
translationOffsetHorizontal and vertical offset values for caption.
See also
setCaptionTranslation
getCaptionTranslation

Member Data Documentation

final int com.meicam.sdk.NvsTimelineCompoundCaption.BOUNDING_TYPE_FRAME = 2
static

The whole bounding including decoration

final int com.meicam.sdk.NvsTimelineCompoundCaption.BOUNDING_TYPE_TEXT = 0
static

The actual text bounding.

final int com.meicam.sdk.NvsTimelineCompoundCaption.BOUNDING_TYPE_TEXT_FRAME = 1
static

Text frame bounding.


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