Video clip, description of the video file. More...

Inheritance diagram for com.meicam.sdk.NvsVideoClip:

Public Member Functions
int	getVideoType ()
	Gets clip type. More...

NvsClipCaption	getFirstCaption ()
	Get the first caption on the Clip. More...

NvsClipCaption	getLastCaption ()
	Get the last caption on the Clip. More...

NvsClipCaption	getPrevCaption (NvsClipCaption caption)
	Get the previous caption of the current caption on the Clip. More...

NvsClipCaption	getNextCaption (NvsClipCaption caption)
	Get the next caption of the current caption on the Clip. More...

List< NvsClipCaption >	getCaptionsByClipTimePosition (long cliptimePos)
	Get a list of captions based on the position on the Clip. More...

NvsClipCaption	addCaption (String captionText, long inPoint, long duration, String captionStylePackageId)
	Add a caption on the Clip. More...

NvsClipCaption	addPanoramicCaption (String captionText, long inPoint, long duration, String captionStylePackageId)
	Add a panorama caption on the Clip. More...

NvsClipCaption	addModularCaption (String captionText, long inPoint, long duration)
	Add a modular caption on the Clip. More...

NvsClipCaption	removeCaption (NvsClipCaption caption)
	Remove the caption on the Clip. More...

NvsClipCompoundCaption	getFirstCompoundCaption ()
	Get the first compound caption on the Clip. More...

NvsClipCompoundCaption	getLastCompoundCaption ()
	Get the last compound caption on the Clip. More...

NvsClipCompoundCaption	getPrevCaption (NvsClipCompoundCaption caption)
	Get the previous compound caption of the current compound caption on the Clip. More...

NvsClipCompoundCaption	getNextCaption (NvsClipCompoundCaption caption)
	Get the next compound caption of the current compound caption on the Clip. More...

List< NvsClipCompoundCaption >	getCompoundCaptionsByClipTimePosition (long cliptimePos)
	Get a list of compound captions based on the position on the Clip. More...

NvsClipCompoundCaption	addCompoundCaption (long inPoint, long duration, String compoundCaptionPackageId)
	Add a caption on the Clip. More...

NvsClipCompoundCaption	removeCompoundCaption (NvsClipCompoundCaption caption)
	Remove compound caption from the Clip. More...

NvsClipAnimatedSticker	getFirstAnimatedSticker ()
	Get the first animated sticker on the Clip. More...

NvsClipAnimatedSticker	getLastAnimatedSticker ()
	Get the last animated sticker on the Clip. More...

NvsClipAnimatedSticker	getPrevAnimatedSticker (NvsClipAnimatedSticker animatedSticker)
	Get the previous animated sticker of the current animated sticker of the Clip. More...

NvsClipAnimatedSticker	getNextAnimatedSticker (NvsClipAnimatedSticker animatedSticker)
	Get the next animated sticker of the current animated sticker of the Clip. More...

List< NvsClipAnimatedSticker >	getAnimatedStickersByClipTimePosition (long cliptimePos)
	Get an animated sticker list based on the position on the Clip. More...

NvsClipAnimatedSticker	addAnimatedSticker (long inPoint, long duration, String animatedStickerPackageId)
	Add a animated sticker on the Clip. More...

NvsClipAnimatedSticker	addPanoramicAnimatedSticker (long inPoint, long duration, String animatedStickerPackageId)
	Add a panorama animation sticker on the Clip. More...

NvsClipAnimatedSticker	addCustomAnimatedSticker (long inPoint, long duration, String animatedStickerPackageId, String customImagePath)
	Add a custom animated sticker on the Clip. More...

NvsClipAnimatedSticker	addCustomPanoramicAnimatedSticker (long inPoint, long duration, String animatedStickerPackageId, String customImagePath)
	Add a a custom panorama animated sticker on the Clip. More...

NvsClipAnimatedSticker	removeAnimatedSticker (NvsClipAnimatedSticker animatedSticker)
	Remove an animated sticker on the Clip. More...

int	getRoleInTheme ()
	Gets the role of the clip in the theme. More...

void	setExtraVideoRotation (int rotation)
	Sets the video's extra rotation angle. More...

void	setExtraVideoRotation (int rotation, boolean rotateROI)
	Sets the video's extra rotation angle. More...

int	getExtraVideoRotation ()
	Gets the video's extra rotation angle. More...

boolean	isRotateROI ()
	Default is true. More...

void	setSoftWareDecoding (boolean softwareUsed)
	Sets whether to apply software decoding on the video. More...

boolean	isSoftWareDeocedUsed ()
	Gets whether to apply software decoding on the video. More...

void	disableAmbiguousCrop (boolean disable)
	Sets whether to disable the ambiguous cropping of the screen on video, The default is false. More...

boolean	isAmbiguousCropDisabled ()
	Gets whether to disable the ambiguous cropping of the screen on video. More...

void	setPanAndScan (float pan, float scan)
	Sets pan and scan. More...

NvsPanAndScan	getPanAndScan ()
	Gets pan and scan. More...

void	enableVideoClipROI (boolean enable)
	Sets whether to enable ROI mode on video clip. default pan and scan mode is used. More...

boolean	isVideoClipROIEnabled ()
	Gets whether to enable ROI mode on video clip. More...

void	enableSlowMotionBlended (boolean enable)
	Sets whether to enable frame blending mode for slow playback, The default is false. More...

boolean	isSlowMotionBlended ()
	Gets whether the video has frame blending mode enabled. More...

int	getSourceBackgroundMode ()
	Gets background mode. More...

void	setSourceBackgroundMode (int mode)
	Sets background mode, Background Mode (ClIP_BACKGROUNDMODE) More...

void	setSourceBackgroundColor (NvsColor color)
	Sets the background color. More...

NvsColor	getSourceBackgroundColor ()
	Gets the background color. More...

int	getImageMotionMode ()
	Gets image clip operation mode. More...

void	setImageMotionMode (int mode)
	Sets image mode of operation. More...

boolean	getImageMotionAnimationEnabled ()
	Gets image animation status. More...

void	setImageMotionAnimationEnabled (boolean enabled)
	Sets whether to support image animation. More...

RectF	getStartROI ()
	Gets the image clip's starting ROI. More...

RectF	getEndROI ()
	Gets image clip's terminating ROI. More...

void	setImageMotionROI (RectF startROI, RectF endROI)
	Sets clip's dynamic move ROI. More...

RectF	getImageMaskROI ()
	Gets image clip's mask ROI. More...

void	setImageMaskROI (RectF maskROI)
	Sets image clip‘s mask ROI. More...

void	setClipWrapMode (int wrapMode)
	Sets the clip's loop mode. More...

int	getClipWrapMode ()
	Gets video loop mode. More...

void	setAudioFadeInDuration (long fadeInDuration)
	Set Audio Fade-In Duration. More...

long	getAudioFadeInDuration ()
	Get Audio Fade-In Duration. More...

void	setAudioFadeOutDuration (long fadeOutDuration)
	Set Audio Fade-Out Duration. More...

long	getAudioFadeOutDuration ()
	Get Audio Fade-Out Duration. More...

void	changeVariableSpeed (double startSpeed, double endSpeed, boolean keepAudioPitch)
	Changes the playback speed of the clip. More...

double	getStartSpeed ()
	Get the playback speed of the clip. More...

double	getEndSpeed ()
	Get the playback speed of the clip. More...

void	setBlendingMode (int blendMode)
	set blending mode to video Clip. More...

int	getBlendingMode ()
	get blending mode from video Clip. More...

void	setOpacity (float opacity)
	set opacity value to video clip, Default value is 1, range (0,1). More...

float	getOpacity ()
	set opacity value from video clip. More...

void	setEnableOriginalRender (boolean enable)
	Turn on special effect rendering based on the original scale of the video clip. More...

boolean	isOriginalRender ()
	Gets whether the original scale rendering mode is turned on. More...

NvsVideoFx	getPropertyVideoFx ()
	Gets the property effect of the video clip. More...

NvsVideoFx	setCustomPropertyVideoFx (NvsCustomVideoFx.Renderer customVideoFxRender)
	set the custom property effect of the video clip More...

void	enablePropertyVideoFx (boolean enable)
	Turn on special effect rendering based on the original scale of the video clip. More...

boolean	isPropertyVideoFxEnabled ()
	Gets whether the original scale rendering mode is turned on. More...

void	enableClipHDR (boolean enable)
	Sets the clip's hdr enable status. More...

boolean	isClipHDREnabled ()
	Gets video hdr enabled. More...

void	enableClipFreezeFrame (boolean enable)
	Sets the clip's hdr enable status. More...

boolean	isClipFreezeFrameEnabled ()
	Gets video freeze frame enabled. More...

void	setClipFreezeFrameTrimPosition (long trimPos)
	Sets the clip's freeze trim position. More...

long	getClipFreezeFrameTrimPosition ()
	Gets video freeze trim position(in microseconds). More...

NvsAudioFx	appendAudioFx (String fxName)
	Adds an audio effect to the end of the video clip. More...

NvsAudioFx	insertAudioFx (String fxName, int fxIndex)
	Inserts an audio effect at the specified effect index on the video clip. More...

NvsAudioFx	appendCustomAudioFx (NvsCustomAudioFx.Renderer customAudioFxRender)
	Appends custom audio effect to the video clip. More...

NvsAudioFx	insertCustomAudioFx (NvsCustomAudioFx.Renderer customAudioFxRender, int fxIndex)
	Inserts a custom audio effect at the specified effect index on the video clip. More...

boolean	removeAudioFx (int fxIndex)
	Removes audio effect by index，The subsequent audioFx index moves forward. More...

NvsAudioFx	getAudioFxByIndex (int fxIndex)
	Gets audio effect by index. More...

int	getAudioFxCount ()
	Gets the number of audio effects on the video clip. Note: The effect index on the clip starts from 0. More...

NvsVideoFx	appendBuiltinFx (String fxName)
	Appends built-in effect to clips. More...

NvsVideoFx	insertBuiltinFx (String fxName, int fxIndex)
	Inserts a built-in effect at the specified effect index on the clip. More...

NvsVideoFx	appendPackagedFx (String fxPackageId)
	Appends package effect to the clip. More...

NvsVideoFx	insertPackagedFx (String fxPackageId, int fxIndex)
	Inserts package effect at the specified effect index on the clip. More...

NvsVideoFx	appendCustomFx (NvsCustomVideoFx.Renderer customVideoFxRender)
	Appends custom video effect to the clip. More...

NvsVideoFx	insertCustomFx (NvsCustomVideoFx.Renderer customVideoFxRender, int fxIndex)
	Inserts a custom video effect at the specified effect index on the clip. More...

NvsVideoFx	appendRawBuiltinFx (String fxName)
	Appends built-in effect on the raw input to clips. More...

NvsVideoFx	insertRawBuiltinFx (String fxName, int fxIndex)
	Inserts a built-in effect at the specified effect index on the raw input on the clip. More...

NvsVideoFx	appendRawPackagedFx (String fxPackageId)
	Appends package effect on the raw input to the clip. More...

NvsVideoFx	insertRawPackagedFx (String fxPackageId, int fxIndex)
	Inserts package effect at the specified effect index on the raw input on the clip. More...

NvsVideoFx	appendRawCustomFx (NvsCustomVideoFx.Renderer customVideoFxRender)
	Appends custom video effect on the raw input to the clip. More...

NvsVideoFx	insertRawCustomFx (NvsCustomVideoFx.Renderer customVideoFxRender, int fxIndex)
	Inserts a custom video effect at the specified effect index on the raw input on the clip. More...

NvsVideoFx	appendBeautyFx ()
	Adds a beauty effect to the clip. More...

NvsVideoFx	insertBeautyFx (int fxIndex)
	Inserts a beauty effect at the specified effect index on the clip. More...

NvsVideoFx	appendBuiltinFx (String fxName, long inPoint, long duration)
	Appends built-in effect to clips. More...

NvsVideoFx	insertBuiltinFx (String fxName, int fxIndex, long inPoint, long duration)
	Inserts a built-in effect at the specified effect index on the clip. More...

NvsVideoFx	appendPackagedFx (String fxPackageId, long inPoint, long duration)
	Appends package effect to the clip. More...

NvsVideoFx	insertPackagedFx (String fxPackageId, int fxIndex, long inPoint, long duration)
	Inserts package effect at the specified effect index on the clip. More...

NvsVideoFx	appendCustomFx (NvsCustomVideoFx.Renderer customVideoFxRender, long inPoint, long duration)
	Appends custom video effect to the clip. More...

NvsVideoFx	insertCustomFx (NvsCustomVideoFx.Renderer customVideoFxRender, int fxIndex, long inPoint, long duration)
	Inserts a custom video effect at the specified effect index on the clip. More...

NvsVideoFx	appendRawBuiltinFx (String fxName, long inPoint, long duration)
	Appends built-in effect on the raw input to clips. More...

NvsVideoFx	insertRawBuiltinFx (String fxName, int fxIndex, long inPoint, long duration)
	Inserts a built-in effect at the specified effect index on the raw input on the clip. More...

NvsVideoFx	appendRawPackagedFx (String fxPackageId, long inPoint, long duration)
	Appends package effect on the raw input to the clip. More...

NvsVideoFx	insertRawPackagedFx (String fxPackageId, int fxIndex, long inPoint, long duration)
	Inserts package effect at the specified effect index on the raw input on the clip. More...

NvsVideoFx	appendRawCustomFx (NvsCustomVideoFx.Renderer customVideoFxRender, long inPoint, long duration)
	Appends custom video effect on the raw input to the clip. More...

NvsVideoFx	insertRawCustomFx (NvsCustomVideoFx.Renderer customVideoFxRender, int fxIndex, long inPoint, long duration)
	Inserts a custom video effect at the specified effect index on the raw input on the clip. More...

NvsVideoFx	appendBeautyFx (long inPoint, long duration)
	Adds a beauty effect to the clip. More...

NvsVideoFx	insertBeautyFx (int fxIndex, long inPoint, long duration)
	Inserts a beauty effect at the specified effect index on the clip. More...

boolean	removeFx (int fxIndex)
	Remove effect by index. More...

boolean	removeRawFx (int fxIndex)
	Remove effect by index on the raw input. More...

boolean	removeAllAudioFx ()
	Removes all audio effects. More...

boolean	removeAllVideoFx ()
	Removes all video effects. More...

boolean	removeAllFx ()
	Removes all effects. More...

NvsVideoFx	getFxByIndex (int fxIndex)
	Gets special effect by index. More...

int	getRawFxCount ()
	Gets the number of effects on the raw input on the clip. Note: The effect index on the clip starts from 0. More...

NvsVideoFx	getRawFxByIndex (int fxIndex)
	Gets special effect by index on the raw input. More...

void	enableRawSourceMode (boolean enable)
	Enable the original frame mode If enable this mode: SetPanAndScan, GetPanAndScan, DisableAmbiguousCrop, IsAmbiguousCropDisabled, SetImageMotionMode, ImageMotionMode SetImageMotionROI, GetImageMotionROI, SetImageMotionAnimationEnabled, IsImageMotionAnimationEnabled, SetImageMaskROI, GetImageMaskROI,are already invalid. If the property videoFx is enable, the corresponding parameters in the property videoFx have no effect. More...

boolean	isRawSourceModeEnabled ()
	The raw source mode is enabled. More...

void	setRefImageFillMode (int mode)
	Sets ref image fill mode, Fill Mode (VARIANT_IMAGE_FILLMODE) More...

int	getRefImageFillMode ()
	Gets ref image fill mode. More...

NvsSize	getRefImageSize ()
	Gets ref image size. More...

int	getRefImageBackgroundMode ()
	Gets ref image background mode. More...

void	setRefImageBackgroundMode (int mode)
	Sets ref image background mode, Background Mode (ClIP_BACKGROUNDMODE) More...

void	setRefImageBackgroundColor (NvsColor color)
	Sets the ref image background color. More...

NvsColor	getRefImageBackgroundColor ()
	Gets the ref image background color. More...

float	getRefImageBackgroundBlurRadius ()
	Gets ref image background blur radius. More...

void	setRefImageBackgroundBlurRadius (float radius)
	Sets ref image background blur radius. More...

boolean	getRefImageBackgroundBlurNewModeEnable ()
	Gets ref image background blur new mode enable. More...

void	updateAudioForClipVideoFx ()
	Update the audio information in the current clip effect. More...

void	setRefImageBackgroundBlurNewModeEnable (boolean newModeEnable)
	Sets ref image background blur new mode enable. More...

Public Member Functions inherited from com.meicam.sdk.NvsClip
NvsTimeline	getInternalTimeline ()
	Gets the internal timeline object from the clip. More...

long	getTrimIn ()
	Gets the trim in point of the clip. More...

long	getTrimOut ()
	Gets the trim out point of the clip. More...

boolean	moveTrimPoint (long offset)
	Move trim points of clip(in microseconds) More...

long	getInPoint ()
	Gets the in-point of the clip on the timeline. More...

long	getOutPoint ()
	Gets the out-point of the clip on the timeline. More...

int	getType ()
	Gets the clip type (video clip, audio clip). More...

int	getIndex ()
	Gets the index of the clip on the track. More...

boolean	changeFilePath (String filePath)
	Change the clip file path. More...

String	getFilePath ()
	Gets the clip file path. More...

int	getFxCount ()
	Gets the number of effects on the clip. Note: The effect index on the clip starts from 0. More...

long	changeTrimInPoint (long newTrimInPoint, boolean affectSibling)
	Modifies the trim in point of the clip. More...

long	changeTrimOutPoint (long newTrimOutPoint, boolean affectSibling)
	Modifies the trim out point of the clip. More...

double	getSpeed ()
	Get the playback speed of the clip. More...

boolean	isKeepAudioPitch ()
	Is keep the tone unchanged. More...

void	changeSpeed (double newSpeed)
	Changes the playback speed of the clip. More...

boolean	changeCurvesVariableSpeed (String curvesString, boolean keepAudioPitch)
	Changes the playback speed of the clip by curves(only support for video clip). More...

String	getClipVariableSpeedCurvesString ()
	get current variable speed curves of clip. More...

NvsAudioFx	getAudioVolumeFx ()
	Gets the audio volume effect of the clip. More...

void	changeSpeed (double newSpeed, boolean keepAudioPitch)
	Changes the playback speed of the clip. More...

void	setVolumeGain (float leftVolumeGain, float rightVolumeGain)
	Sets the volume. More...

NvsVolume	getVolumeGain ()
	Gets volume. More...

NvsVolume	getRealVolumeAtTime (long time)
	Get the real-time volume at a specified time point. More...

void	setLoopAudio (boolean loop)
	Sets whether to loop audio if the clip' trim out go beyond its audio stream's duration. More...

boolean	getLoopAudio ()
	Gets whether to loop audio if the clip' trim out go beyond its audio stream's duration. More...

long	GetClipPosByTimelinePosCurvesVariableSpeed (long timelinePos)
	Gets the pos in clip by current timeline pos when used curves variable speed. More...

long	GetTimelinePosByClipPosCurvesVariableSpeed (long clipPos)
	Gets the pos in timelne by current clip pos when used curves variable speed. 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...

Static Public Attributes
Clip type

static final int	VIDEO_CLIP_TYPE_AV = 0
	Audio and video type. More...

static final int	VIDEO_CLIP_TYPE_IMAGE = 1
	Image type. More...

The clip's role in themes.

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

Clip motion mode

static final int	CLIP_MOTIONMODE_LETTERBOX_ZOOMIN = 0
	Zoom in. More...

static final int	ClIP_MOTIONMODE_LETTERBOX_ZOOMOUT = 1
	Zoom out. More...

static final int	IMAGE_CLIP_MOTIONMMODE_ROI = 2
	Image clip's ROI(Region Of Interesting) More...

static final int	IMAGE_CLIP_MOTIONMMODE_CROP = 3
	Image clip's crop. More...

Clip loop mode

static final int	CLIP_WRAPMODE_REPEAT_LASTFRAME = 0
	Last frame. More...

static final int	ClIP_WRAPMODE_REPEAT_FIRSTFRAME = 1
	First frame. More...

static final int	ClIP_WRAPMODE_REPEAT = 2

Extra rotation of the video

static final int	ClIP_EXTRAVIDEOROTATION_0 = 0
	0 degree More...

static final int	ClIP_EXTRAVIDEOROTATION_90 = 1
	90 degree More...

static final int	ClIP_EXTRAVIDEOROTATION_180 = 2
	180 degree More...

static final int	ClIP_EXTRAVIDEOROTATION_270 = 3

Clip background display mode

static final int	ClIP_BACKGROUNDMODE_COLOR_SOLID = 0
	Solid color. More...

static final int	ClIP_BACKGROUNDMODE_BLUR = 1

Variant image fill mode

static final int	VARIANT_IMAGE_FILLMODE_ASPECT_FIT = 0
	Select one of the long sides of the length and width as the basis to fill in equal proportions. More...

static final int	VARIANT_IMAGE_FILLMODE_ASPECT_FILL = 1
	Select one of the short sides of the length and width as the basis to fill in equal proportions. More...

static final int	VARIANT_IMAGE_FILLMODE_FILL = 2

Clip blending mode

static final int	CLIP_BLENDING_MODE_NORMAL = 0
	Normal mode. More...

static final int	CLIP_BLENDING_MODE_MULTIPLY = 1
	multiplay mode More...

static final int	CLIP_BLENDING_MODE_SUBTRACT = 2
	Subtract mode. More...

static final int	CLIP_BLENDING_MODE_SCREEN = 3
	Screen mode. More...

static final int	CLIP_BLENDING_MODE_ADD = 4
	Add mode. More...

static final int	CLIP_BLENDING_MODE_EXCLUSION = 5
	Exclusion mode. More...

static final int	CLIP_BLENDING_MODE_DARKEN = 6
	Darken mode. More...

static final int	CLIP_BLENDING_MODE_BURN = 7
	Burn mode. More...

static final int	CLIP_BLENDING_MODE_LINEAR_BURN = 8
	Linear Burn mode. More...

static final int	CLIP_BLENDING_MODE_LIGHTEN = 9
	Lighten mode. More...

static final int	CLIP_BLENDING_MODE_DODGE = 10
	Dodge mode. More...

static final int	CLIP_BLENDING_MODE_OVERLAY = 11
	Overlay mode. More...

static final int	CLIP_BLENDING_MODE_SOFT_LIGHT = 12
	SoftLight mode. More...

static final int	CLIP_BLENDING_MODE_HARD_LIGHT = 13
	HardLight mode. More...

static final int	CLIP_BLENDING_MODE_VIVID_LIGHT = 14
	VividLight mode. More...

static final int	CLIP_BLENDING_MODE_PIN_LIGHT = 15
	PinLight mode. More...

static final int	CLIP_BLENDING_MODE_LINEAR_LIGHT = 16
	LinearLight mode. More...

static final int	CLIP_BLENDING_MODE_HARD_MIX = 17
	HardMix mode. More...

static final int	CLIP_BLENDING_MODE_DIFFERENCE = 18
	Difference mode. More...

Static Public Attributes inherited from com.meicam.sdk.NvsClip
static final int	CLIP_TYPE_VIDEO = 0
	video clip type More...

static final int	CLIP_TYPE_AUDIO = 1
	audio clip type More...

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"

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

Video clip, description of the video file.

The video clip source can be a video or an image. Each video clip can be modified for its in and out point and playback speed, as well as pan and scan. When editing a video, users can add or insert multiple video effects by the type of effect (built-in effects, wrapped effects, beauty effects). When adding a resource package effect, users have to install it firstly. When installation is successful, users can get the package Id to use, and the built-in effect can be used only by obtaining the effect name.

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

Member Function Documentation

◆ addAnimatedSticker()

NvsClipAnimatedSticker com.meicam.sdk.NvsVideoClip.addAnimatedSticker	(	long	inPoint,
		long	duration,
		String	animatedStickerPackageId
	)

inline

Add a animated sticker on the Clip.

Parameters

inPoint	The in point of the animated sticker on the Clip (in microseconds)
duration	The duration of the animation sticker which displayed (in microseconds), -1 indicates that the whole clip is covered.
animatedStickerPackageId	Animated sticker package Id

Returns: Return the NvsClipAnimatedSticker object.
It will return null in the following situations:
1. No animated sticker function authorization;
2. The animatedStickerPackageId is empty or null;
3. The animatedSticker has not install successed;
4. If inPoint is less than 0 or greater than or equal to the current Clip duration, or duration is not greater than 0.

Since: 3.0.1

See also: removeAnimatedSticker

◆ addCaption()

NvsClipCaption com.meicam.sdk.NvsVideoClip.addCaption	(	String	captionText,
		long	inPoint,
		long	duration,
		String	captionStylePackageId
	)

inline

Add a caption on the Clip.

Parameters

captionText	Text of caption
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.
captionStylePackageId	Caption style package Id.If it does not exist, you can pass an empty string or null.

Returns: Returns the NvsClipCaption object.
It will return null in the following situations:
1. No caption function authorization;
2. If inPoint is less than 0 or greater than or equal to the current Clip duration, or duration is not greater than 0.

See also: removeCaption

Since: 3.0.1

◆ addCompoundCaption()

NvsClipCompoundCaption com.meicam.sdk.NvsVideoClip.addCompoundCaption	(	long	inPoint,
		long	duration,
		String	compoundCaptionPackageId
	)

inline

Add a caption on the Clip.

Parameters

captionText	Text of caption
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.
captionStylePackageId	Caption style package Id.If it does not exist, you can pass an empty string or null.

Returns: Returns the NvsClipCaption object.
It will return null in the following situations:
1. No compound caption function authorization;
2. If inPoint is less than 0 or greater than or equal to the current Clip duration, or duration is not greater than 0.

Since: 3.0.1

See also: removeCompoundCaption

◆ addCustomAnimatedSticker()

NvsClipAnimatedSticker com.meicam.sdk.NvsVideoClip.addCustomAnimatedSticker	(	long	inPoint,
		long	duration,
		String	animatedStickerPackageId,
		String	customImagePath
	)

inline

Add a custom animated sticker on the Clip.

Parameters

inPoint	The in point of custom animated sticker on the Clip (in microseconds)
duration	The duration of custom animation sticker which displayed (in microseconds), -1 indicates that the whole clip is covered.
animatedStickerPackageId	Animated sticker package Id
customImagePath	Path of custom animated sticker image(It can be a jpg, png image, or a dynamic caf format image supported by Meishe sdk)

Returns: Return the NvsClipAnimatedSticker object.
It will return null in the following situations:
1. No animated sticker function authorization;
2. The animatedStickerPackageId is empty or null;
3. The animatedSticker has not install successed;
4. If inPoint is less than 0 or greater than or equal to the current Clip duration, or duration is not greater than 0.
Note: If the return value is not null, you still cannot see the sticker effect, you need to check whether the customImagePath actually exists.

See also: removeAnimatedSticker

Since: 3.0.1

◆ addCustomPanoramicAnimatedSticker()

NvsClipAnimatedSticker com.meicam.sdk.NvsVideoClip.addCustomPanoramicAnimatedSticker	(	long	inPoint,
		long	duration,
		String	animatedStickerPackageId,
		String	customImagePath
	)

inline

Add a a custom panorama animated sticker on the Clip.

Parameters

inPoint	The in point of custom animated sticker on the Clip (in microseconds)
duration	The duration of custom animation sticker which displayed (in microseconds), -1 indicates that the whole clip is covered.
animatedStickerPackageId	Animated sticker package Id
customImagePath	Path of custom animated sticker image

Returns: Return the NvsClipAnimatedSticker object.
It will return null in the following situations:
1. No animated sticker function authorization or no panoramic function authorization;
2. The animatedStickerPackageId is empty or null;
3. The animatedSticker has not install successed;
4. If inPoint is less than 0 or greater than or equal to the current Clip duration, or duration is not greater than 0.
Note: If the return value is not null, you still cannot see the sticker effect, you need to check whether the customImagePath actually exists.

Since: 3.0.1

See also: removeAnimatedSticker

◆ addModularCaption()

NvsClipCaption com.meicam.sdk.NvsVideoClip.addModularCaption	(	String	captionText,
		long	inPoint,
		long	duration
	)

inline

Add a modular caption on the Clip.

Parameters

captionText	Text of caption
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered

Returns: Returns the NvsClipCaption object.
It will return null in the following situations:
1. No caption function authorization;
2. If inPoint is less than 0 or greater than or equal to the current Clip duration, or duration is not greater than 0.

Since: 3.0.1

See also: removeCaption

◆ addPanoramicAnimatedSticker()

NvsClipAnimatedSticker com.meicam.sdk.NvsVideoClip.addPanoramicAnimatedSticker	(	long	inPoint,
		long	duration,
		String	animatedStickerPackageId
	)

inline

Add a panorama animation sticker on the Clip.

Parameters

inPoint	The in point of the animated sticker on the Clip (in microseconds)
duration	The duration of the animation sticker which displayed (in microseconds), -1 indicates that the whole clip is covered.
animatedStickerPackageId	Animated sticker package Id

Returns: Return the NvsClipAnimatedSticker object.
It will return null in the following situations:
1. No animated sticker function authorization or no panoramic function authorization;
2. The animatedStickerPackageId is empty or null;
3. The animatedSticker has not install successed;
4. If inPoint is less than 0 or greater than or equal to the current Clip duration, or duration is not greater than 0.

Since: 3.0.1

See also: removeAnimatedSticker

◆ addPanoramicCaption()

NvsClipCaption com.meicam.sdk.NvsVideoClip.addPanoramicCaption	(	String	captionText,
		long	inPoint,
		long	duration,
		String	captionStylePackageId
	)

inline

Add a panorama caption on the Clip.

Parameters

captionText	Text of caption
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.
captionStylePackageId	Caption style package Id.If it does not exist, you can pass an empty string or null.

Returns: Returns the NvsClipCaption object.
It will return null in the following situations:
1. No caption function authorization;
2. If inPoint is less than 0 or greater than or equal to the current Clip duration, or duration is not greater than 0.

Since: 3.0.1

See also: removeCaption

◆ appendAudioFx()

NvsAudioFx com.meicam.sdk.NvsVideoClip.appendAudioFx ( String fxName )

inline

Adds an audio effect to the end of the video clip.

Parameters

fxName Audio effect name. For the effect name, please refer to getAllBuiltinAudioFxNames() or built-in effect name list.

Returns: Returns the appended audio effect object.

Warning: This interface causes the streaming engine state to jump to the engine stop state. For more infomations please refer to Engine Changes.

See also: insertAudioFx; removeAudioFx; getAudioFxByIndex

Since: 2.24.0

◆ appendBeautyFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendBeautyFx ( )

inline

Adds a beauty effect to the clip.

Returns: Returns the added video effect object.

See also: insertBeautyFx; appendPackagedFx; appendBuiltinFx

◆ appendBeautyFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendBeautyFx	(	long	inPoint,
		long	duration
	)

inline

Adds a beauty effect to the clip.

Parameters

inPoint	The in point of the fx on the Clip (in microseconds)
duration	Fx display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the added video effect object.

See also: insertBeautyFx; appendPackagedFx; appendBuiltinFx

Since: 3.0.1

◆ appendBuiltinFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendBuiltinFx ( String fxName )

inline

Appends built-in effect to clips.

Parameters

fxName The effect name. To get the video effect name, please refer to getAllBuiltinVideoFxNames() or built-in effect name list.

Returns: Returns the added video effect object.

See also: insertBuiltinFx; appendBeautyFx; appendPackagedFx

◆ appendBuiltinFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendBuiltinFx	(	String	fxName,
		long	inPoint,
		long	duration
	)

inline

Appends built-in effect to clips.

Parameters

inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.
fxName	The effect name. To get the video effect name, please refer to getAllBuiltinVideoFxNames() or built-in effect name list.

Returns: Returns the added video effect object.

See also: insertBuiltinFx; appendBeautyFx; appendPackagedFx

◆ appendCustomAudioFx()

NvsAudioFx com.meicam.sdk.NvsVideoClip.appendCustomAudioFx ( NvsCustomAudioFx.Renderer customAudioFxRender )

inline

Appends custom audio effect to the video clip.

Parameters

NvsCustomAudioFx.Renderer User-implemented custom audio effect renderer interface.

Returns: Returns the appended audio effect object.

Warning: This interface causes the streaming engine state to jump to the engine stop state. For more infomations please refer to Engine Changes.

Since: 2.24.0

◆ appendCustomFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendCustomFx ( NvsCustomVideoFx.Renderer customVideoFxRender )

inline

Appends custom video effect to the clip.

Parameters

customVideoFxRender User-implemented custom video effect renderer interface.

Returns: Returns the added video effect object.

Since: 1.7.0

◆ appendCustomFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendCustomFx	(	NvsCustomVideoFx.Renderer	customVideoFxRender,
		long	inPoint,
		long	duration
	)

inline

Appends custom video effect to the clip.

Parameters

customVideoFxRender	User-implemented custom video effect renderer interface.
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the added video effect object.

Since: 3.0.1

◆ appendPackagedFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendPackagedFx ( String fxPackageId )

inline

Appends package effect to the clip.

Parameters

fxPackageId Effect resource package ID.

Returns: Returns the added video effect object.

See also: insertPackagedFx; appendBuiltinFx; appendBeautyFx

◆ appendPackagedFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendPackagedFx	(	String	fxPackageId,
		long	inPoint,
		long	duration
	)

inline

Appends package effect to the clip.

Parameters

fxPackageId	Effect resource package ID.
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the added video effect object.

See also: insertPackagedFx; appendBuiltinFx; appendBeautyFx

Since: 3.0.1

◆ appendRawBuiltinFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendRawBuiltinFx ( String fxName )

inline

Appends built-in effect on the raw input to clips.

Parameters

fxName The effect name. To get the video effect name, please refer to getAllBuiltinVideoFxNames() or built-in effect name list.

Returns: Returns the added video effect object.

Since: 2.20.0

◆ appendRawBuiltinFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendRawBuiltinFx	(	String	fxName,
		long	inPoint,
		long	duration
	)

inline

Appends built-in effect on the raw input to clips.

Parameters

fxName	The effect name. To get the video effect name, please refer to getAllBuiltinVideoFxNames() or built-in effect name list.
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the added video effect object.

Since: 3.0.1

◆ appendRawCustomFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendRawCustomFx ( NvsCustomVideoFx.Renderer customVideoFxRender )

inline

Appends custom video effect on the raw input to the clip.

Parameters

customVideoFxRender User-implemented custom video effect renderer interface.

Returns: Returns the added video effect object.

Since: 2.20.0

◆ appendRawCustomFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendRawCustomFx	(	NvsCustomVideoFx.Renderer	customVideoFxRender,
		long	inPoint,
		long	duration
	)

inline

Appends custom video effect on the raw input to the clip.

Parameters

customVideoFxRender	User-implemented custom video effect renderer interface.
inPoint	The in point of the fx on the Clip (in microseconds)
duration	Fx display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the added video effect object.

Since: 3.0.1

◆ appendRawPackagedFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendRawPackagedFx ( String fxPackageId )

inline

Appends package effect on the raw input to the clip.

Parameters

fxPackageId Effect resource package ID.

Returns: Returns the added video effect object.

Since: 2.20.0

◆ appendRawPackagedFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.appendRawPackagedFx	(	String	fxPackageId,
		long	inPoint,
		long	duration
	)

inline

Appends package effect on the raw input to the clip.

Parameters

fxPackageId	Effect resource package ID.
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the added video effect object.

Since: 3.0.1

◆ changeVariableSpeed()

void com.meicam.sdk.NvsVideoClip.changeVariableSpeed	(	double	startSpeed,
		double	endSpeed,
		boolean	keepAudioPitch
	)

inline

Changes the playback speed of the clip.

Parameters

startSpeed	start playback speed.
endSpeed	end playback speed.
keepAudioPitch	Keep the tone unchanged.

Warning: This interface will cause the streaming engine state to jump to the engine stop state, see Engine Change Feature for details.

See also: getStartSpeed

Since: 2.11.0

◆ disableAmbiguousCrop()

void com.meicam.sdk.NvsVideoClip.disableAmbiguousCrop ( boolean disable )

inline

Sets whether to disable the ambiguous cropping of the screen on video, The default is false.

Parameters

disable whether to disable or not.

See also: isAmbiguousCropDisabled

◆ enableClipFreezeFrame()

void com.meicam.sdk.NvsVideoClip.enableClipFreezeFrame ( boolean enable )

inline

Sets the clip's hdr enable status.

Parameters

enable enable status.

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

Since: 2.18

See also: isClipFreenzeFrameEnabled

◆ enableClipHDR()

void com.meicam.sdk.NvsVideoClip.enableClipHDR ( boolean enable )

inline

Sets the clip's hdr enable status.

Parameters

enable enable status.

Since: 2.17

See also: getClipWrapMode

◆ enablePropertyVideoFx()

void com.meicam.sdk.NvsVideoClip.enablePropertyVideoFx ( boolean enable )

inline

Turn on special effect rendering based on the original scale of the video clip.

Warning

Parameters

Enable Turn on or not.

See also: IsOriginalRender

◆ enableRawSourceMode()

void com.meicam.sdk.NvsVideoClip.enableRawSourceMode ( boolean enable )

inline

Enable the original frame mode If enable this mode: SetPanAndScan, GetPanAndScan, DisableAmbiguousCrop, IsAmbiguousCropDisabled, SetImageMotionMode, ImageMotionMode SetImageMotionROI, GetImageMotionROI, SetImageMotionAnimationEnabled, IsImageMotionAnimationEnabled, SetImageMaskROI, GetImageMaskROI,are already invalid. If the property videoFx is enable, the corresponding parameters in the property videoFx have no effect.

See also: isRawSourceModeEnabled

Since: 3.7.0

◆ enableSlowMotionBlended()

void com.meicam.sdk.NvsVideoClip.enableSlowMotionBlended ( boolean enable )

inline

Sets whether to enable frame blending mode for slow playback, The default is false.

Parameters

disable whether to enable or not.

Since: 2.14.0

See also: isSlowMotionBlended

◆ enableVideoClipROI()

void com.meicam.sdk.NvsVideoClip.enableVideoClipROI ( boolean enable )

inline

Sets whether to enable ROI mode on video clip. default pan and scan mode is used.

Parameters

disable whether to enable or not.

See also: isVideoClipROIEnabled; setImageMotionROI

◆ getAnimatedStickersByClipTimePosition()

List<NvsClipAnimatedSticker> com.meicam.sdk.NvsVideoClip.getAnimatedStickersByClipTimePosition ( long cliptimePos )

inline

Get an animated sticker list based on the position on the Clip.

Parameters

ClipPos Position on the Clip (in microseconds)

Returns: Returns a list which holding the current position animated sticker object
The sorting rules for the obtained animated sticker list are as follows:
1.When adding, the in points are different,animated stickers are arranged in the order of the in points;
2.When adding, the in points are the same, they are arranged in the order in which the animation stickers are added.

Since: 3.0.1

See also: addAnimatedSticker

◆ getAudioFadeInDuration()

long com.meicam.sdk.NvsVideoClip.getAudioFadeInDuration ( )

inline

Get Audio Fade-In Duration.

Returns: Returns Fade-In Duration

Since: 2.8.2

See also: setAudioFadeInDuration

◆ getAudioFadeOutDuration()

long com.meicam.sdk.NvsVideoClip.getAudioFadeOutDuration ( )

inline

Get Audio Fade-Out Duration.

Returns: Returns Fade-Out Duration

Since: 2.8.2

See also: setAudioFadeOutDuration

◆ getAudioFxByIndex()

NvsAudioFx com.meicam.sdk.NvsVideoClip.getAudioFxByIndex ( int fxIndex )

inline

Gets audio effect by index.

Parameters

fxIndex Audio effect's index. Range [0, getFxCount())

Returns: Returns the acquired audio effect object.

See also: appendAudioFx; insertAudioFx; removeAudioFx

Since: 2.24.0

◆ getAudioFxCount()

int com.meicam.sdk.NvsVideoClip.getAudioFxCount ( )

inline

Gets the number of audio effects on the video clip. Note: The effect index on the clip starts from 0.

Returns: Returns the number of audio effects on the video clip.

Since: 2.24.0

◆ getBlendingMode()

int com.meicam.sdk.NvsVideoClip.getBlendingMode ( )

inline

get blending mode from video Clip.

Returns: current Clip blending mode. (CLIP_BLENDING_MODE)

See also: setBlendingMode

◆ getCaptionsByClipTimePosition()

List<NvsClipCaption> com.meicam.sdk.NvsVideoClip.getCaptionsByClipTimePosition ( long cliptimePos )

inline

Get a list of captions based on the position on the Clip.

Parameters

ClipPos The position on the Clip(in micro-second)

Returns: Returns a list of arrays of captions at the current position。
The sorting rules for the obtained captions list are as follows:
1.When adding, the in points are different, and captions are arranged in the order of the in points;
2.When adding, the in points are the same, and captions are arranged in the order of adding captions.

See also: addCaption

Since: 3.0.1

◆ getClipFreezeFrameTrimPosition()

long com.meicam.sdk.NvsVideoClip.getClipFreezeFrameTrimPosition ( )

inline

Gets video freeze trim position(in microseconds).

Since: 2.18

◆ getClipWrapMode()

int com.meicam.sdk.NvsVideoClip.getClipWrapMode ( )

inline

Gets video loop mode.

Returns: Returns loop mode.(ClIP_WRAPMODE)

Since: 2.2.3

See also: setClipWrapMode

◆ getCompoundCaptionsByClipTimePosition()

List<NvsClipCompoundCaption> com.meicam.sdk.NvsVideoClip.getCompoundCaptionsByClipTimePosition ( long cliptimePos )

inline

Get a list of compound captions based on the position on the Clip.

Parameters

ClipPos The position on the Clip(in micro-second)

Returns: Returns a list of compound captions at the current position。
The sorting rules for the obtained captions list are as follows:
1. If the in points are different, captions are sorted in the order of the in points;
2. If the in points are the same, and captions are sorted in the order of compound caption added.

Since: 3.0.1

See also: addCompoundCaption

◆ getEndROI()

RectF com.meicam.sdk.NvsVideoClip.getEndROI ( )

inline

Gets image clip's terminating ROI.

Returns: Returns a RectF object indicating that the image clip's terminating ROI.

Since: 1.1.0

See also: setImageMotionROI

◆ getEndSpeed()

double com.meicam.sdk.NvsVideoClip.getEndSpeed ( )

inline

Get the playback speed of the clip.

The default value is 1, which means that it plays at normal speed; the value less than 1 means slower playback; the value greater than 1 means faster playback.

Returns: Returns the playback end speed of the current clip.

See also: changeVariableSpeed

Since: 2.11.0

◆ getExtraVideoRotation()

int com.meicam.sdk.NvsVideoClip.getExtraVideoRotation ( )

inline

Gets the video's extra rotation angle.

Returns: Returns the extra rotation angle of the video. Please refer to Video Extra Rotation Angle.

See also: setExtraVideoRotation

◆ getFirstAnimatedSticker()

NvsClipAnimatedSticker com.meicam.sdk.NvsVideoClip.getFirstAnimatedSticker ( )

inline

Get the first animated sticker on the Clip.

Returns: Return the acquired NvsClipAnimatedSticker object.

See also: getLastAnimatedSticker; addAnimatedSticker

Since: 3.0.1

◆ getFirstCaption()

NvsClipCaption com.meicam.sdk.NvsVideoClip.getFirstCaption ( )

inline

Get the first caption on the Clip.

Returns: Returns the NvsClipCaption object.

See also: getLastCaption; addCaption

Since: 3.0.1

◆ getFirstCompoundCaption()

NvsClipCompoundCaption com.meicam.sdk.NvsVideoClip.getFirstCompoundCaption ( )

inline

Get the first compound caption on the Clip.

Returns: Returns the compound caption object.

Since: 3.0.1

See also: getLastCompoundCaption; addCompoundCaption

◆ getFxByIndex()

NvsVideoFx com.meicam.sdk.NvsVideoClip.getFxByIndex ( int fxIndex )

inline

Gets special effect by index.

Parameters

fxIndex Special effect index, please refer to getFxCount().

Returns: Returns the obtained video effect object.

◆ getImageMaskROI()

RectF com.meicam.sdk.NvsVideoClip.getImageMaskROI ( )

inline

Gets image clip's mask ROI.

Returns: Returns a RectF object representing the image clip's mask ROI.

Since: 2.2.3

See also: setImageMaskROI

◆ getImageMotionAnimationEnabled()

boolean com.meicam.sdk.NvsVideoClip.getImageMotionAnimationEnabled ( )

inline

Gets image animation status.

Returns: Returns a boolean value indicating the state of the image animation. A value of true supports image animation, and false does not support it.

Since: 1.1.0

See also: setImageMotionAnimationEnabled

◆ getImageMotionMode()

int com.meicam.sdk.NvsVideoClip.getImageMotionMode ( )

inline

Gets image clip operation mode.

Returns: Returns the integer value indicating the mode of operation of the image clip. Please refer to [Fragment Operation Mode].

Since: 1.1.0

See also: setImageMotionMode

◆ getLastAnimatedSticker()

NvsClipAnimatedSticker com.meicam.sdk.NvsVideoClip.getLastAnimatedSticker ( )

inline

Get the last animated sticker on the Clip.

Returns: Return the acquired NvsClipAnimatedSticker object.

Since: 3.0.1

See also: getFirstAnimatedSticker

◆ getLastCaption()

NvsClipCaption com.meicam.sdk.NvsVideoClip.getLastCaption ( )

inline

Get the last caption on the Clip.

Returns: Returns the NvsClipCaption object.

See also: getFirstCaption; addCaption

Since: 3.0.1

◆ getLastCompoundCaption()

NvsClipCompoundCaption com.meicam.sdk.NvsVideoClip.getLastCompoundCaption ( )

inline

Get the last compound caption on the Clip.

Returns: Returns the compound caption object.

Since: 3.0.1

See also: getFirstCompoundCaption; addCompoundCaption

◆ getNextAnimatedSticker()

NvsClipAnimatedSticker com.meicam.sdk.NvsVideoClip.getNextAnimatedSticker ( NvsClipAnimatedSticker animatedSticker )

inline

Get the next animated sticker of the current animated sticker of the Clip.

Parameters

animatedSticker the current NvsClipAnimatedSticker obejct

Returns: Return the acquired NvsClipAnimatedSticker object.

Since: 3.0.1

See also: getPrevAnimatedSticker

◆ getNextCaption() [1/2]

NvsClipCaption com.meicam.sdk.NvsVideoClip.getNextCaption ( NvsClipCaption caption )

inline

Get the next caption of the current caption on the Clip.

Parameters

caption The current caption on the Clip

Returns: Returns the NvsClipCaption object.

See also: getPrevCaption

Since: 3.0.1

◆ getNextCaption() [2/2]

NvsClipCompoundCaption com.meicam.sdk.NvsVideoClip.getNextCaption ( NvsClipCompoundCaption caption )

inline

Get the next compound caption of the current compound caption on the Clip.

Parameters

caption The current compound caption on the Clip

Returns: Returns the compound caption object.

Since: 3.0.1

See also: getPrevCompoundCaption

◆ getOpacity()

float com.meicam.sdk.NvsVideoClip.getOpacity ( )

inline

set opacity value from video clip.

Returns: current Clip opacity value.

See also: setClipOpacity

◆ getPanAndScan()

NvsPanAndScan com.meicam.sdk.NvsVideoClip.getPanAndScan ( )

inline

Gets pan and scan.

Returns: Return the acquired pan and scan object.

See also: setPanAndScan

◆ getPrevAnimatedSticker()

NvsClipAnimatedSticker com.meicam.sdk.NvsVideoClip.getPrevAnimatedSticker ( NvsClipAnimatedSticker animatedSticker )

inline

Get the previous animated sticker of the current animated sticker of the Clip.

Parameters

animatedSticker the current NvsClipAnimatedSticker obejct

Returns: Return the acquired NvsClipAnimatedSticker object.

Since: 3.0.1

See also: getNextAnimatedSticker

◆ getPrevCaption() [1/2]

NvsClipCaption com.meicam.sdk.NvsVideoClip.getPrevCaption ( NvsClipCaption caption )

inline

Get the previous caption of the current caption on the Clip.

Parameters

caption The current caption on the Clip

Returns: Returns the NvsClipCaption object.

See also: getNextCaption

Since: 3.0.1

◆ getPrevCaption() [2/2]

NvsClipCompoundCaption com.meicam.sdk.NvsVideoClip.getPrevCaption ( NvsClipCompoundCaption caption )

inline

Get the previous compound caption of the current compound caption on the Clip.

Parameters

caption The current compound caption on the Clip

Returns: Returns the compound caption object.

Since: 3.0.1

See also: getNextCompoundCaption

◆ getPropertyVideoFx()

NvsVideoFx com.meicam.sdk.NvsVideoClip.getPropertyVideoFx ( )

inline

Gets the property effect of the video clip.

Returns: Returns the obtained NvsVideoFx object.

◆ getRawFxByIndex()

NvsVideoFx com.meicam.sdk.NvsVideoClip.getRawFxByIndex ( int fxIndex )

inline

Gets special effect by index on the raw input.

Parameters

fxIndex Special effect index, please refer to [getRawFxCount()].

Returns: Returns the obtained video effect object.

Since: 2.20.0

◆ getRawFxCount()

int com.meicam.sdk.NvsVideoClip.getRawFxCount ( )

inline

Gets the number of effects on the raw input on the clip. Note: The effect index on the clip starts from 0.

Returns: Returns the number of special effects on the clip.

Since: 2.20.0

◆ getRefImageBackgroundBlurNewModeEnable()

boolean com.meicam.sdk.NvsVideoClip.getRefImageBackgroundBlurNewModeEnable ( )

inline

Gets ref image background blur new mode enable.

Returns: Returns the obtained background blur new mode enable.

See also: getRefImageBackgroundBlurNewMode

Since: 3.7.0

◆ getRefImageBackgroundBlurRadius()

float com.meicam.sdk.NvsVideoClip.getRefImageBackgroundBlurRadius ( )

inline

Gets ref image background blur radius.

Returns: Returns the obtained background blur radius.

See also: setRefImageBackgroundBlurRadius

Since: 3.4.1

◆ getRefImageBackgroundColor()

NvsColor com.meicam.sdk.NvsVideoClip.getRefImageBackgroundColor ( )

inline

Gets the ref image background color.

Returns: Background color

See also: setRefImageBackgroundColor

Since: 3.4.1

◆ getRefImageBackgroundMode()

int com.meicam.sdk.NvsVideoClip.getRefImageBackgroundMode ( )

inline

Gets ref image background mode.

Returns: Returns the obtained background mode object, Background Mode (ClIP_BACKGROUNDMODE)

See also: setRefImageBackgroundMode

Since: 3.4.1

◆ getRefImageFillMode()

int com.meicam.sdk.NvsVideoClip.getRefImageFillMode ( )

inline

Gets ref image fill mode.

Returns: Returns the obtained fill mode object, Fill Mode (VARIANT_IMAGE_FILLMODE)

See also: setRefImageFillMode

Since: 3.7.0

◆ getRefImageSize()

NvsSize com.meicam.sdk.NvsVideoClip.getRefImageSize ( )

inline

Gets ref image size.

See also: setRefImageBackgroundBlurNewModeEnable

Since: 3.8.0

◆ getRoleInTheme()

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

inline

Gets the role of the clip in the theme.

Returns: Returns role of clip in the theme.

◆ getSourceBackgroundColor()

NvsColor com.meicam.sdk.NvsVideoClip.getSourceBackgroundColor ( )

inline

Gets the background color.

Returns: Background color

See also: setSourceBackgroundColor

Since: 2.11.1

◆ getSourceBackgroundMode()

int com.meicam.sdk.NvsVideoClip.getSourceBackgroundMode ( )

inline

Gets background mode.

Returns: Returns the obtained background mode object, Background Mode (ClIP_BACKGROUNDMODE)

See also: setClipBackgroundMode

◆ getStartROI()

RectF com.meicam.sdk.NvsVideoClip.getStartROI ( )

inline

Gets the image clip's starting ROI.

Returns: Returns a RectF object representing the starting ROI of the image clip.

Since: 1.1.0

See also: setImageMotionROI

◆ getStartSpeed()

double com.meicam.sdk.NvsVideoClip.getStartSpeed ( )

inline

Get the playback speed of the clip.

The default value is 1, which means that it plays at normal speed; the value less than 1 means slower playback; the value greater than 1 means faster playback.

Returns: Returns the playback start speed of the current clip.

See also: changeVariableSpeed

Since: 2.11.0

◆ getVideoType()

int com.meicam.sdk.NvsVideoClip.getVideoType ( )

inline

Gets clip type.

Returns: Returns clip type.

◆ insertAudioFx()

NvsAudioFx com.meicam.sdk.NvsVideoClip.insertAudioFx	(	String	fxName,
		int	fxIndex
	)

inline

Inserts an audio effect at the specified effect index on the video clip.

Parameters

fxName	Audio effect name. For information about getting all effects' names, please refer to getAllBuiltinAudioFxNames() or built-in effect name list.
fxIndex	audio effects' index to insert at. Range [0, getFxCount() - 1 ). If index is outOfRange,It will be add in the end.

Returns: Returns the inserted audio effect object.

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

See also: appendAudioFx; removeAudioFx; getAudioFxByIndex

Since: 2.24.0

◆ insertBeautyFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertBeautyFx ( int fxIndex )

inline

Inserts a beauty effect at the specified effect index on the clip.

Parameters

fxIndex Effect index to insert at, please refer togetFxCount().

Returns: Returns the inserted video effect object.

See also: appendBeautyFx; insertBuiltinFx; insertPackagedFx

◆ insertBeautyFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertBeautyFx	(	int	fxIndex,
		long	inPoint,
		long	duration
	)

inline

Inserts a beauty effect at the specified effect index on the clip.

Parameters

fxIndex	Effect index to insert at, please refer togetFxCount().
inPoint	The in point of the fx on the Clip (in microseconds)
duration	Fx display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the inserted video effect object.

See also: appendBeautyFx; insertBuiltinFx; insertPackagedFx

Since: 3.0.1

◆ insertBuiltinFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertBuiltinFx	(	String	fxName,
		int	fxIndex
	)

inline

Inserts a built-in effect at the specified effect index on the clip.

Parameters

fxName	The effect name. To get the video effect name, please refer to getAllBuiltinVideoFxNames() or Built-in Effect Name List.
fxIndex	Effect index to insert at.

Returns: Returns the inserted video effect object.

See also: appendBuiltinFx; insertPackagedFx; insertBeautyFx

◆ insertBuiltinFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertBuiltinFx	(	String	fxName,
		int	fxIndex,
		long	inPoint,
		long	duration
	)

inline

Inserts a built-in effect at the specified effect index on the clip.

Parameters

fxName	The effect name. To get the video effect name, please refer to getAllBuiltinVideoFxNames() or Built-in Effect Name List.
fxIndex	Effect index to insert at.
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the inserted video effect object.

See also: appendBuiltinFx; insertPackagedFx; insertBeautyFx

Since: 3.0.1

◆ insertCustomAudioFx()

NvsAudioFx com.meicam.sdk.NvsVideoClip.insertCustomAudioFx	(	NvsCustomAudioFx.Renderer	customAudioFxRender,
		int	fxIndex
	)

inline

Inserts a custom audio effect at the specified effect index on the video clip.

Parameters

NvsCustomAudioFx.Renderer	User-implemented custom audio effect renderer interface.
fxIndex	audio effects' index to insert at.Range [0, getFxCount() - 1 ). If index is outOfRange,It will be add in the end.

Returns: Returns the inserted audio effect object.

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

Since: 2.24.0

◆ insertCustomFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertCustomFx	(	NvsCustomVideoFx.Renderer	customVideoFxRender,
		int	fxIndex
	)

inline

Inserts a custom video effect at the specified effect index on the clip.

Parameters

customVideoFxRender	User-implemented custom video effects renderer interface.
fxIndex	Effect index to insert at.

Returns: Returns the inserted video special effect object.

Since: 1.7.0

◆ insertCustomFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertCustomFx	(	NvsCustomVideoFx.Renderer	customVideoFxRender,
		int	fxIndex,
		long	inPoint,
		long	duration
	)

inline

Inserts a custom video effect at the specified effect index on the clip.

Parameters

customVideoFxRender	User-implemented custom video effects renderer interface.
fxIndex	Effect index to insert at.
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the inserted video special effect object.

Since: 3.0.1

◆ insertPackagedFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertPackagedFx	(	String	fxPackageId,
		int	fxIndex
	)

inline

Inserts package effect at the specified effect index on the clip.

Parameters

fxPackageId	Effect resource package ID.
fxIndex	Effect index to insert at, please refer to getFxCount().

Returns: Returns the inserted video effect object.

See also: appendPackagedFx; insertBeautyFx; insertBuiltinFx

◆ insertPackagedFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertPackagedFx	(	String	fxPackageId,
		int	fxIndex,
		long	inPoint,
		long	duration
	)

inline

Inserts package effect at the specified effect index on the clip.

Parameters

fxPackageId	Effect resource package ID.
fxIndex	Effect index to insert at, please refer to getFxCount().
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the inserted video effect object.

See also: appendPackagedFx; insertBeautyFx; insertBuiltinFx

Since: 3.0.1

◆ insertRawBuiltinFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertRawBuiltinFx	(	String	fxName,
		int	fxIndex
	)

inline

Inserts a built-in effect at the specified effect index on the raw input on the clip.

Parameters

fxName	The effect name. To get the video effect name, please refer to getAllBuiltinVideoFxNames() or Built-in Effect Name List.
fxIndex	Effect index to insert at.

Returns: Returns the inserted video effect object.

Since: 2.20.0

◆ insertRawBuiltinFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertRawBuiltinFx	(	String	fxName,
		int	fxIndex,
		long	inPoint,
		long	duration
	)

inline

Inserts a built-in effect at the specified effect index on the raw input on the clip.

Parameters

fxName	The effect name. To get the video effect name, please refer to getAllBuiltinVideoFxNames() or Built-in Effect Name List.
fxIndex	Effect index to insert at.
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the inserted video effect object.

Since: 3.0.1

◆ insertRawCustomFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertRawCustomFx	(	NvsCustomVideoFx.Renderer	customVideoFxRender,
		int	fxIndex
	)

inline

Inserts a custom video effect at the specified effect index on the raw input on the clip.

Parameters

customVideoFxRender	User-implemented custom video effects renderer interface.
fxIndex	Effect index to insert at.

Returns: Returns the inserted video special effect object.

Since: 2.20.0

◆ insertRawCustomFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertRawCustomFx	(	NvsCustomVideoFx.Renderer	customVideoFxRender,
		int	fxIndex,
		long	inPoint,
		long	duration
	)

inline

Inserts a custom video effect at the specified effect index on the raw input on the clip.

Parameters

customVideoFxRender	User-implemented custom video effects renderer interface.
fxIndex	Effect index to insert at.
inPoint	The in point of the fx on the Clip (in microseconds)
duration	Fx display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the inserted video special effect object.

Since: 3.0.1

◆ insertRawPackagedFx() [1/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertRawPackagedFx	(	String	fxPackageId,
		int	fxIndex
	)

inline

Inserts package effect at the specified effect index on the raw input on the clip.

Parameters

fxPackageId	Effect resource package ID.
fxIndex	Effect index to insert at, please refer to [getRawFxCount()].

Returns: Returns the inserted video effect object.

Since: 2.20.0

◆ insertRawPackagedFx() [2/2]

NvsVideoFx com.meicam.sdk.NvsVideoClip.insertRawPackagedFx	(	String	fxPackageId,
		int	fxIndex,
		long	inPoint,
		long	duration
	)

inline

Inserts package effect at the specified effect index on the raw input on the clip.

Parameters

fxPackageId	Effect resource package ID.
fxIndex	Effect index to insert at, please refer to [getRawFxCount()].
inPoint	The in point of the caption on the Clip (in microseconds)
duration	Caption display duration (in microseconds), -1 indicates that the whole clip is covered.

Returns: Returns the inserted video effect object.

Since: 3.0.1

◆ isAmbiguousCropDisabled()

boolean com.meicam.sdk.NvsVideoClip.isAmbiguousCropDisabled ( )

inline

Gets whether to disable the ambiguous cropping of the screen on video.

Returns: Returns whether to disable the approximate scale cropping of the screen on video.

See also: disableAmbiguousCrop

◆ isClipFreezeFrameEnabled()

boolean com.meicam.sdk.NvsVideoClip.isClipFreezeFrameEnabled ( )

inline

Gets video freeze frame enabled.

Since: 2.18

◆ isClipHDREnabled()

boolean com.meicam.sdk.NvsVideoClip.isClipHDREnabled ( )

inline

Gets video hdr enabled.

Since: 2.17

◆ isOriginalRender()

boolean com.meicam.sdk.NvsVideoClip.isOriginalRender ( )

inline

Gets whether the original scale rendering mode is turned on.

Returns: Turn on or not.

See also: setEnableOriginalRender

◆ isPropertyVideoFxEnabled()

boolean com.meicam.sdk.NvsVideoClip.isPropertyVideoFxEnabled ( )

inline

Gets whether the original scale rendering mode is turned on.

Returns: Turn on or not.

See also: setEnableOriginalRender

◆ isRawSourceModeEnabled()

boolean com.meicam.sdk.NvsVideoClip.isRawSourceModeEnabled ( )

inline

The raw source mode is enabled.

Returns: Returns Whether to enable raw source mode

See also: enableRawSourceMode

Since: 3.7.0

◆ isRotateROI()

boolean com.meicam.sdk.NvsVideoClip.isRotateROI ( )

inline

Default is true.

Returns: Whether to rotate the direction of movement of the ROI.

◆ isSlowMotionBlended()

boolean com.meicam.sdk.NvsVideoClip.isSlowMotionBlended ( )

inline

Gets whether the video has frame blending mode enabled.

Since: 2.14.0

See also: enableSlowMotionBlended

◆ isSoftWareDeocedUsed()

boolean com.meicam.sdk.NvsVideoClip.isSoftWareDeocedUsed ( )

inline

Gets whether to apply software decoding on the video.

Returns: Returns whether the obtained video is software decoded.

See also: setSoftWareDecoding

◆ isVideoClipROIEnabled()

boolean com.meicam.sdk.NvsVideoClip.isVideoClipROIEnabled ( )

inline

Gets whether to enable ROI mode on video clip.

Returns: Returns whether to enable ROI mode on video clip.

See also: enableVideoClipROI

◆ removeAllAudioFx()

boolean com.meicam.sdk.NvsVideoClip.removeAllAudioFx ( )

inline

Removes all audio effects.

Returns: Determines whether the removal is successful. If it returns true, the removal is successful and if it returns false, it fails to remove.

See also: removeFx

Since: 2.24.0

◆ removeAllFx()

boolean com.meicam.sdk.NvsVideoClip.removeAllFx ( )

inline

Removes all effects.

Returns: Determines whether the removal is successful. If it returns true, the removal is successful and if it returns false, it fails to remove.

See also: removeFx

◆ removeAllVideoFx()

boolean com.meicam.sdk.NvsVideoClip.removeAllVideoFx ( )

inline

Removes all video effects.

Returns: Determines whether the removal is successful. If it returns true, the removal is successful and if it returns false, it fails to remove.

See also: removeFx

Since: 2.24.0

◆ removeAnimatedSticker()

NvsClipAnimatedSticker com.meicam.sdk.NvsVideoClip.removeAnimatedSticker ( NvsClipAnimatedSticker animatedSticker )

inline

Remove an animated sticker on the Clip.

Parameters

animatedSticker The NvsClipAnimatedSticker object which will be removed

Returns: Return the next NvsClipAnimatedSticker object.

Since: 3.0.1

See also: addAnimatedSticker

◆ removeAudioFx()

boolean com.meicam.sdk.NvsVideoClip.removeAudioFx ( int fxIndex )

inline

Removes audio effect by index，The subsequent audioFx index moves forward.

Parameters

fxIndex Audio effects' index. Range [0, getFxCount())

Returns: Determines if the audio effect is removed successfully. true means a successfull removal, false means failure.

Warning: This interface causes the streaming engine state to jump to the engine stop state, as described in Engine Changes.

See also: appendFx; insertFx; getFxByIndex

◆ removeCaption()

NvsClipCaption com.meicam.sdk.NvsVideoClip.removeCaption ( NvsClipCaption caption )

inline

Remove the caption on the Clip.

Parameters

caption Clip caption object which removed

Returns: Returns the next NvsClipCaption object.

Since: 3.0.1

See also: addCaption

◆ removeCompoundCaption()

NvsClipCompoundCaption com.meicam.sdk.NvsVideoClip.removeCompoundCaption ( NvsClipCompoundCaption caption )

inline

Remove compound caption from the Clip.

Parameters

caption Clip compound caption object which to be removed

Returns: Returns the next compound caption object.

Since: 3.0.1

See also: addCompoundCaption

◆ removeFx()

boolean com.meicam.sdk.NvsVideoClip.removeFx ( int fxIndex )

inline

Remove effect by index.

Parameters

fxIndex Special effect index, please refer togetFxCount().

Returns: Determines whether the removal is successful. If it returns true, the removal is successful and if it returns false, it fails to remove.

See also: removeAllFx; getFxByIndex

◆ removeRawFx()

boolean com.meicam.sdk.NvsVideoClip.removeRawFx ( int fxIndex )

inline

Remove effect by index on the raw input.

Parameters

fxIndex Special effect index, please refer togetFxCount().

Returns: Determines whether the removal is successful. If it returns true, the removal is successful and if it returns false, it fails to remove.

Since: 2.20.0

◆ setAudioFadeInDuration()

void com.meicam.sdk.NvsVideoClip.setAudioFadeInDuration ( long fadeInDuration )

inline

Set Audio Fade-In Duration.

Parameters

fadeInDuration Fade-In Duration

Since: 2.8.2

See also: getAudioFadeInDuration

◆ setAudioFadeOutDuration()

void com.meicam.sdk.NvsVideoClip.setAudioFadeOutDuration ( long fadeOutDuration )

inline

Set Audio Fade-Out Duration.

Parameters

fadeOutDuration Fade-Out Duration

Since: 2.8.2

See also: getAudioFadeOutDuration

◆ setBlendingMode()

void com.meicam.sdk.NvsVideoClip.setBlendingMode ( int blendMode )

inline

set blending mode to video Clip.

Parameters

blendMode new blending mode. (CLIP_BLENDING_MODE)

See also: getBlendingMode

◆ setClipFreezeFrameTrimPosition()

void com.meicam.sdk.NvsVideoClip.setClipFreezeFrameTrimPosition ( long trimPos )

inline

Sets the clip's freeze trim position.

Parameters

trimPos freeze trim position(in microseconds).

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

Since: 2.18

See also: isClipFreenzeFrameEnabled

◆ setClipWrapMode()

void com.meicam.sdk.NvsVideoClip.setClipWrapMode ( int wrapMode )

inline

Sets the clip's loop mode.

Parameters

wrapMode Loop mode.(ClIP_WRAPMODE)

Since: 2.2.3

See also: getClipWrapMode

< Loop mode is between 0 and 2

◆ setCustomPropertyVideoFx()

NvsVideoFx com.meicam.sdk.NvsVideoClip.setCustomPropertyVideoFx ( NvsCustomVideoFx.Renderer customVideoFxRender )

inline

set the custom property effect of the video clip

Parameters

customVideoFxRender User-implemented custom video effect renderer interface.

Returns: Returns the obtained NvsVideoFx object.

◆ setEnableOriginalRender()

void com.meicam.sdk.NvsVideoClip.setEnableOriginalRender ( boolean enable )

inline

Turn on special effect rendering based on the original scale of the video clip.

Parameters

Enable Turn on or not.

See also: IsOriginalRender

◆ setExtraVideoRotation() [1/2]

void com.meicam.sdk.NvsVideoClip.setExtraVideoRotation ( int rotation )

inline

Sets the video's extra rotation angle.

Parameters

rotation The extra rotation angle of the video. Please refer to Video Extra Rotation Angle.

See also: getExtraVideoRotation

◆ setExtraVideoRotation() [2/2]

void com.meicam.sdk.NvsVideoClip.setExtraVideoRotation	(	int	rotation,
		boolean	rotateROI
	)

inline

Sets the video's extra rotation angle.

Parameters

rotation The extra rotation angle of the video. Please refer to Video Extra Rotation Angle.

See also: getExtraVideoRotation

◆ setImageMaskROI()

void com.meicam.sdk.NvsVideoClip.setImageMaskROI ( RectF maskROI )

inline

Sets image clip‘s mask ROI.

For details, please refer to Image CLip's ROI Topics.

Parameters

maskROI Image clip's mask ROI.

Since: 2.2.3

See also: getStartROI

◆ setImageMotionAnimationEnabled()

void com.meicam.sdk.NvsVideoClip.setImageMotionAnimationEnabled ( boolean enabled )

inline

Sets whether to support image animation.

Parameters

enabled Whether to support image animation. A value of true supports image animation, and false does not.

Since: 1.1.0

See also: getImageMotionAnimationEnabled

◆ setImageMotionMode()

void com.meicam.sdk.NvsVideoClip.setImageMotionMode ( int mode )

inline

Sets image mode of operation.

Parameters

mode	Image clip mode of operation. Please refer to Fragment Operation Mode.

Since: 1.1.0

See also: getImageMotionMode

◆ setImageMotionROI()

void com.meicam.sdk.NvsVideoClip.setImageMotionROI	(	RectF	startROI,
		RectF	endROI
	)

inline

Sets clip's dynamic move ROI.

For details, please refer to Image Clip's ROI Topics.

Parameters

startROI	clip's starting ROI.
endROI	clip's terminating ROI.

Since: 1.1.0

See also: getStartROI; getEndROI

◆ setOpacity()

void com.meicam.sdk.NvsVideoClip.setOpacity ( float opacity )

inline

set opacity value to video clip, Default value is 1, range (0,1).

Parameters

opacity new opacity value.

See also: getClipOpacity

◆ setPanAndScan()

void com.meicam.sdk.NvsVideoClip.setPanAndScan	(	float	pan,
		float	scan
	)

inline

Sets pan and scan.

The pan and scan functions are used to adapt the position and size of the image on the display window. For details, please refer to Pan and Scan topic.

Parameters

pan	Pan
scan	Scan

See also: getPanAndScan

◆ setRefImageBackgroundBlurNewModeEnable()

void com.meicam.sdk.NvsVideoClip.setRefImageBackgroundBlurNewModeEnable ( boolean newModeEnable )

inline

Sets ref image background blur new mode enable.

Parameters

Background blur new mode enable.

See also: setRefImageBackgroundBlurNewModeEnable

Since: 3.7.0

◆ setRefImageBackgroundBlurRadius()

void com.meicam.sdk.NvsVideoClip.setRefImageBackgroundBlurRadius ( float radius )

inline

Sets ref image background blur radius.

Parameters

Background blur radius.

See also: getRefImageBackgroundBlurRadius

Since: 3.4.1

◆ setRefImageBackgroundColor()

void com.meicam.sdk.NvsVideoClip.setRefImageBackgroundColor ( NvsColor color )

inline

Sets the ref image background color.

Parameters

color the ref image background color

See also: getRefImageBackgroundColor

Since: 3.4.1

◆ setRefImageBackgroundMode()

void com.meicam.sdk.NvsVideoClip.setRefImageBackgroundMode ( int mode )

inline

Sets ref image background mode, Background Mode (ClIP_BACKGROUNDMODE)

Parameters

mode	Background mode.

See also: getRefImageBackgroundMode

Since: 3.4.1

◆ setRefImageFillMode()

void com.meicam.sdk.NvsVideoClip.setRefImageFillMode ( int mode )

inline

Sets ref image fill mode, Fill Mode (VARIANT_IMAGE_FILLMODE)

Parameters

mode	Fill mode.

See also: getRefImageFillMode

Since: 3.7.0

◆ setSoftWareDecoding()

void com.meicam.sdk.NvsVideoClip.setSoftWareDecoding ( boolean softwareUsed )

inline

Sets whether to apply software decoding on the video.

Parameters

softwareUsed Whether to use software decoder to decode.

See also: isSoftWareDeocedUsed

◆ setSourceBackgroundColor()

void com.meicam.sdk.NvsVideoClip.setSourceBackgroundColor ( NvsColor color )

inline

Sets the background color.

Parameters

color the background color

See also: getSourceBackgroundColor

Since: 2.11.1

◆ setSourceBackgroundMode()

void com.meicam.sdk.NvsVideoClip.setSourceBackgroundMode ( int mode )

inline

Sets background mode, Background Mode (ClIP_BACKGROUNDMODE)

Parameters

mode	Background mode.

See also: getSourceBackgroundMode

◆ updateAudioForClipVideoFx()

void com.meicam.sdk.NvsVideoClip.updateAudioForClipVideoFx ( )

inline

Update the audio information in the current clip effect.

Returns

Since: 3.8.0

Member Data Documentation

◆ ClIP_BACKGROUNDMODE_BLUR

final int com.meicam.sdk.NvsVideoClip.ClIP_BACKGROUNDMODE_BLUR = 1

static

Blur

◆ ClIP_BACKGROUNDMODE_COLOR_SOLID

final int com.meicam.sdk.NvsVideoClip.ClIP_BACKGROUNDMODE_COLOR_SOLID = 0

static

Solid color.

◆ CLIP_BLENDING_MODE_ADD

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_ADD = 4

static

Add mode.

◆ CLIP_BLENDING_MODE_BURN

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_BURN = 7

static

Burn mode.

◆ CLIP_BLENDING_MODE_DARKEN

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_DARKEN = 6

static

Darken mode.

◆ CLIP_BLENDING_MODE_DIFFERENCE

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_DIFFERENCE = 18

static

Difference mode.

◆ CLIP_BLENDING_MODE_DODGE

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_DODGE = 10

static

Dodge mode.

◆ CLIP_BLENDING_MODE_EXCLUSION

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_EXCLUSION = 5

static

Exclusion mode.

◆ CLIP_BLENDING_MODE_HARD_LIGHT

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_HARD_LIGHT = 13

static

HardLight mode.

◆ CLIP_BLENDING_MODE_HARD_MIX

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_HARD_MIX = 17

static

HardMix mode.

◆ CLIP_BLENDING_MODE_LIGHTEN

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_LIGHTEN = 9

static

Lighten mode.

◆ CLIP_BLENDING_MODE_LINEAR_BURN

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_LINEAR_BURN = 8

static

Linear Burn mode.

◆ CLIP_BLENDING_MODE_LINEAR_LIGHT

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_LINEAR_LIGHT = 16

static

LinearLight mode.

◆ CLIP_BLENDING_MODE_MULTIPLY

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_MULTIPLY = 1

static

multiplay mode

◆ CLIP_BLENDING_MODE_NORMAL

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_NORMAL = 0

static

Normal mode.

◆ CLIP_BLENDING_MODE_OVERLAY

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_OVERLAY = 11

static

Overlay mode.

◆ CLIP_BLENDING_MODE_PIN_LIGHT

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_PIN_LIGHT = 15

static

PinLight mode.

◆ CLIP_BLENDING_MODE_SCREEN

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_SCREEN = 3

static

Screen mode.

◆ CLIP_BLENDING_MODE_SOFT_LIGHT

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_SOFT_LIGHT = 12

static

SoftLight mode.

◆ CLIP_BLENDING_MODE_SUBTRACT

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_SUBTRACT = 2

static

Subtract mode.

◆ CLIP_BLENDING_MODE_VIVID_LIGHT

final int com.meicam.sdk.NvsVideoClip.CLIP_BLENDING_MODE_VIVID_LIGHT = 14

static

VividLight mode.

◆ ClIP_EXTRAVIDEOROTATION_0

final int com.meicam.sdk.NvsVideoClip.ClIP_EXTRAVIDEOROTATION_0 = 0

static

0 degree

◆ ClIP_EXTRAVIDEOROTATION_180

final int com.meicam.sdk.NvsVideoClip.ClIP_EXTRAVIDEOROTATION_180 = 2

static

180 degree

◆ ClIP_EXTRAVIDEOROTATION_270

final int com.meicam.sdk.NvsVideoClip.ClIP_EXTRAVIDEOROTATION_270 = 3

static

270 degree

◆ ClIP_EXTRAVIDEOROTATION_90

final int com.meicam.sdk.NvsVideoClip.ClIP_EXTRAVIDEOROTATION_90 = 1

static

90 degree

◆ CLIP_MOTIONMODE_LETTERBOX_ZOOMIN

final int com.meicam.sdk.NvsVideoClip.CLIP_MOTIONMODE_LETTERBOX_ZOOMIN = 0

static

Zoom in.

◆ ClIP_MOTIONMODE_LETTERBOX_ZOOMOUT

final int com.meicam.sdk.NvsVideoClip.ClIP_MOTIONMODE_LETTERBOX_ZOOMOUT = 1

static

Zoom out.

◆ ClIP_WRAPMODE_REPEAT

final int com.meicam.sdk.NvsVideoClip.ClIP_WRAPMODE_REPEAT = 2

static

Repeat

◆ ClIP_WRAPMODE_REPEAT_FIRSTFRAME

final int com.meicam.sdk.NvsVideoClip.ClIP_WRAPMODE_REPEAT_FIRSTFRAME = 1

static

First frame.

◆ CLIP_WRAPMODE_REPEAT_LASTFRAME

final int com.meicam.sdk.NvsVideoClip.CLIP_WRAPMODE_REPEAT_LASTFRAME = 0

static

Last frame.

◆ IMAGE_CLIP_MOTIONMMODE_CROP

final int com.meicam.sdk.NvsVideoClip.IMAGE_CLIP_MOTIONMMODE_CROP = 3

static

Image clip's crop.

◆ IMAGE_CLIP_MOTIONMMODE_ROI

final int com.meicam.sdk.NvsVideoClip.IMAGE_CLIP_MOTIONMMODE_ROI = 2

static

Image clip's ROI(Region Of Interesting)

◆ ROLE_IN_THEME_GENERAL

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

static

General.

◆ ROLE_IN_THEME_TITLE

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

static

Title.

◆ ROLE_IN_THEME_TRAILER

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

static

Trailer.

◆ VARIANT_IMAGE_FILLMODE_ASPECT_FILL

final int com.meicam.sdk.NvsVideoClip.VARIANT_IMAGE_FILLMODE_ASPECT_FILL = 1

static

Select one of the short sides of the length and width as the basis to fill in equal proportions.

◆ VARIANT_IMAGE_FILLMODE_ASPECT_FIT

final int com.meicam.sdk.NvsVideoClip.VARIANT_IMAGE_FILLMODE_ASPECT_FIT = 0

static

Select one of the long sides of the length and width as the basis to fill in equal proportions.

◆ VARIANT_IMAGE_FILLMODE_FILL

final int com.meicam.sdk.NvsVideoClip.VARIANT_IMAGE_FILLMODE_FILL = 2

static

fill

◆ VIDEO_CLIP_TYPE_AV

final int com.meicam.sdk.NvsVideoClip.VIDEO_CLIP_TYPE_AV = 0

static

Audio and video type.

◆ VIDEO_CLIP_TYPE_IMAGE

final int com.meicam.sdk.NvsVideoClip.VIDEO_CLIP_TYPE_IMAGE = 1

static

Image type.

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

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addAnimatedSticker()

◆ addCaption()

◆ addCompoundCaption()

◆ addCustomAnimatedSticker()

◆ addCustomPanoramicAnimatedSticker()

◆ addModularCaption()

◆ addPanoramicAnimatedSticker()

◆ addPanoramicCaption()

◆ appendAudioFx()

◆ appendBeautyFx() [1/2]

◆ appendBeautyFx() [2/2]

◆ appendBuiltinFx() [1/2]

◆ appendBuiltinFx() [2/2]

◆ appendCustomAudioFx()

◆ appendCustomFx() [1/2]

◆ appendCustomFx() [2/2]

◆ appendPackagedFx() [1/2]

◆ appendPackagedFx() [2/2]

◆ appendRawBuiltinFx() [1/2]

◆ appendRawBuiltinFx() [2/2]

◆ appendRawCustomFx() [1/2]

◆ appendRawCustomFx() [2/2]

◆ appendRawPackagedFx() [1/2]

◆ appendRawPackagedFx() [2/2]

◆ changeVariableSpeed()

◆ disableAmbiguousCrop()

◆ enableClipFreezeFrame()

◆ enableClipHDR()

◆ enablePropertyVideoFx()

◆ enableRawSourceMode()

◆ enableSlowMotionBlended()

◆ enableVideoClipROI()

◆ getAnimatedStickersByClipTimePosition()

◆ getAudioFadeInDuration()

◆ getAudioFadeOutDuration()

◆ getAudioFxByIndex()

◆ getAudioFxCount()

◆ getBlendingMode()

◆ getCaptionsByClipTimePosition()

◆ getClipFreezeFrameTrimPosition()

◆ getClipWrapMode()

◆ getCompoundCaptionsByClipTimePosition()

◆ getEndROI()

◆ getEndSpeed()

◆ getExtraVideoRotation()

◆ getFirstAnimatedSticker()

◆ getFirstCaption()

◆ getFirstCompoundCaption()

◆ getFxByIndex()

◆ getImageMaskROI()

◆ getImageMotionAnimationEnabled()

◆ getImageMotionMode()

◆ getLastAnimatedSticker()

◆ getLastCaption()

◆ getLastCompoundCaption()

◆ getNextAnimatedSticker()

◆ getNextCaption() [1/2]

◆ getNextCaption() [2/2]

◆ getOpacity()

◆ getPanAndScan()

◆ getPrevAnimatedSticker()

◆ getPrevCaption() [1/2]

◆ getPrevCaption() [2/2]

◆ getPropertyVideoFx()

◆ getRawFxByIndex()

◆ getRawFxCount()

◆ getRefImageBackgroundBlurNewModeEnable()

◆ getRefImageBackgroundBlurRadius()

◆ getRefImageBackgroundColor()

◆ getRefImageBackgroundMode()

◆ getRefImageFillMode()

◆ getRefImageSize()

◆ getRoleInTheme()

◆ getSourceBackgroundColor()

◆ getSourceBackgroundMode()