Video clip, description of video file. The video clip source can be video or image. Each video clip can modify its trim in point, trim out point and playback speed, and can also set panning and scanning. When editing a video, you can add or insert multiple video effects according to different types of effects (built-in effects, wrapped effects, beauty effects). When adding resource pack effects, you have to install them first. After the installation is successful, you can use them only by obtaining the packageid, while builtin only needs to obtain the name of the effect. More...

Inheritance diagram for NvsVideoClip:

Public Member Functions
	constructor ()

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

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

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

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

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

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

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

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

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

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

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

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

	removeAllFx ()
	Removes all effects. More...

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

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

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

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

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

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

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

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

	getVideoType ()
	Gets clip type. More...

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

	setPlayInReverse (playInReverse)
	Sets whether the clip is reversed. More...

	getPlayInReverse ()
	Gets whether the clip is reversed. More...

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

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

	setPanAndScan (pan, scan)
	Sets pan and scan.The pan and scan functions are used to adapt the position and size of the image on the display window. More...

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

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

	getSourceBackgroundMode ()
	Gets background mode. More...

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

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

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

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

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

	isImageMotionAnimationEnabled ()
	enable image animation of motion or not More...

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

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

	disableAudioStreams (disabled)
	Disable audio streams. More...

	isAudioStreamsDisabled ()
	Is audio streams disabled. More...

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

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

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

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

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

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

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

	setBlendingMode (mode)
	Set blending mode to video Clip. More...

	getBlendingMode ()
	Get blending mode from video Clip. More...

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

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

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

	setRefImageFillMode (mode)
	Sets reference image fill mode. More...

	getRefImageFillMode ()
	Gets reference image fill mode. More...

	setRefImageSize (width, height)
	Sets reference image size. More...

	getRefImageSize ()
	Gets reference image size. More...

	setRefImageBackgroundColor (color)
	Sets reference image background color. More...

	getRefImageBackgroundColor ()
	Gets reference image background color. More...

	setRefImageBackgroundBlurRadius (radius)
	Sets reference image background blur radius. More...

	getRefImageBackgroundBlurRadius ()
	Gets reference image background blur radius. More...

	enableRawSourceMode (enable)
	Enable raw source mode of the video clip. If raw source mode is enabled, SetPanAndScan, GetPanAndScan, DisableAmbiguousCrop, IsAmbiguousCropDisabled, SetImageMotionMode, ImageMotionMode, SetImageMotionROI, GetImageMotionROI, SetImageMotionAnimationEnabled, IsImageMotionAnimationEnabled, SetImageMaskROI and GetImageMaskROI are invalid. If property fx enabled, the parameters related are invalid also. More...

	isRawSourceModeEnabled ()
	Raw source mode is enabled or not. More...

	getFirstCaption ()
	Get the first caption on video clip. More...

	getLastCaption ()
	Get the last caption on video clip. More...

	getPrevCaption (caption)
	Get the previous caption of the current caption on video clip. More...

	getNextCaption (caption)
	Get the next caption of the current caption on video clip. More...

	getCaptionsByClipTimePosition (clipTimePos)
	Get a list of captions based on the position on video clip. More...

	addCaption (captionText, inPoint, duration, captionStylePackageId, isPanoramic)
	Add a caption on video clip. More...

	addModularCaption (captionText, inPoint, duration)
	add modular caption More...

	removeCaption (caption)
	Remove the caption on video clip. More...

	getFirstCompoundCaption ()
	Get the first compound caption on video clip. More...

	getLastCompoundCaption ()
	Get the last compound caption on video clip. More...

	getPrevCompoundCaption (caption)
	Get the previous compound caption of the current compound caption on video clip. More...

	getNextCompoundCaption (caption)
	Get the next compound caption of the current caption on video clip. More...

	getCompoundCaptionsByClipTimePosition (clipTimePos)
	Get a list of compound captions based on the position on video clip. More...

	addCompoundCaption (inPoint, duration, compoundCaptionPackageId)
	add compound caption More...

	removeCompoundCaption (caption)
	Remove compound caption from video clip. More...

	getFirstAnimatedSticker ()
	Get the first animated sticker on video clip. More...

	getLastAnimatedSticker ()
	Get the last animated sticker on video clip. More...

	getPrevAnimatedSticker (animatedSticker)
	Get the previous animated sticker of the current animated sticker of video clip. More...

	getNextAnimatedSticker (animatedSticker)
	Get the next animated sticker of the current animated sticker of video clip. More...

	getAnimatedStickersByClipTimePosition (clipTimePos)
	Get an animated sticker list based on the position on video clip. More...

	addAnimatedSticker (inPoint, duration, animatedStickerPackageId, isPanoramic, isCustom, customImagePath)
	add animated sticker More...

	removeAnimatedSticker (animatedSticker)
	Remove an animated sticker on video clip. More...

	setRawFilterProcessesMode (mode)
	Set raw filter processing mode. More...

	getRawFilterProcessesMode ()
	Get raw filter processing mode. More...

Public Member Functions inherited from NvsClip
	constructor ()

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

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

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

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

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

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

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

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

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

	changeTrimInPoint (newTrimInPoint, affectSibling)
	Modifies the trim in point of the clip. This interface will cause the streaming engine state to jump to the engine stop state, please refer to Engine Change Feature for details. More...

	changeTrimOutPoint (newTrimOutPoint, affectSibling)
	Modifies the trim out point of the clip. This interface will cause the streaming engine state to jump to the engine stop state, refer to Engine Change Feature for details. More...

	getSpeed ()
	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 the playback speed of the current clip. More...

	changeSpeed (newSpeed, keepAudioPitch)
	Changes the playback speed of the clip.This interface will cause the streaming engine state to jump to the engine stop state. More...

	changeSpeedWithOutPoint (outPoint, newSpeed, keepAudioPitch)
	Changes the playback speed of the clip.This interface will cause the streaming engine state to jump to the engine stop state. More...

	isKeepAudioPitch ()
	Whether keep the tone unchanged. More...

	getVolumeGain ()
	Gets volume. More...

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

	setFadeInDuration (duration)
	Sets the fade-in time. More...

	getFadeInDuration ()
	Gets fade-in time. More...

	setFadeOutDuration (duration)
	Sets fade-out time.Fade-out duration in microseconds, 0 means no fade-out.Duration must >= 0. More...

	getFadeOutDuration ()
	Gets fade-out time. More...

	changeCurvesVariableSpeed (curvesString, keepAudioPitch)
	Changes the playback speed of the clip by curves(only support for video clip).This interface will cause the streaming engine state to jump to the engine stop state. More...

	changeCurvesVariableSpeedWithOutPoint (outPoint, curvesString, keepAudioPitch)
	Changes the playback speed of the clip by curves(only support for video clip).This interface will cause the streaming engine state to jump to the engine stop state. More...

	getClipVariableSpeedCurvesString ()
	Get current variable speed curves of clip.The x coords at the each output curves' endpoint is relative,user can scale x to any size. eg: scale curves range to equal with clip length. More...

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

	getTimelinePosByClipPosCurvesVariableSpeed (clipPos)
	Gets the pos in timelne by current clip pos when used curves variable speed. More...

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

	getInternalTimeline ()
	Gets the internal timeline object from the clip. More...

	isTimelineClip ()
	Is timeline clip. More...

	changeClipFilePath (clipFilePath)
	Change the path of clip. More...

Public Member Functions inherited from NvsProjObj
	constructor ()

	setInternalObject (obj)
	set internal object More...

	getInternalObject ()
	get internal object More...

	setTemplateAttachment (key, value)
	Adds additional template data to the NvsObject object to identify the NvsObject template object. More...

	getTemplateAttachment (key)
	Gets an template attachment to NvsObject. More...

Detailed Description

Video clip, description of video file. The video clip source can be video or image. Each video clip can modify its trim in point, trim out point and playback speed, and can also set panning and scanning. When editing a video, you can add or insert multiple video effects according to different types of effects (built-in effects, wrapped effects, beauty effects). When adding resource pack effects, you have to install them first. After the installation is successful, you can use them only by obtaining the packageid, while builtin only needs to obtain the name of the effect.

See also: NvsClip

Member Function Documentation

◆ addAnimatedSticker()

NvsVideoClip::addAnimatedSticker	(	inPoint,
		duration,
		animatedStickerPackageId,
		isPanoramic,
		isCustom,
		customImagePath
	)

inline

add animated sticker

Parameters

{Number}	inPoint The in point of the animated sticker on video clip (in microseconds)
{Number}	duration The duration of the animation sticker which displayed (in microseconds)
{String}	animatedStickerPackageId Animated sticker packageId
{Boolean}	isPanoramic Panoramic or not
{Boolean}	isCustom Customize or not
{String}	customImagePath Custome image path

Returns

{NvsClipAnimatedSticker} Return the NvsClipAnimatedSticker object. It will return null in the following situations:

No animated sticker function authorization;
The animatedStickerPackageId is empty or null;
The animatedSticker has not install successed;
If inPoint is less than 0 or greater than or equal to the current video clip duration, or duration is not greater than 0.

◆ addCaption()

NvsVideoClip::addCaption	(	captionText,
		inPoint,
		duration,
		captionStylePackageId,
		isPanoramic
	)

inline

Add a caption on video clip.

Parameters

{String}	captionText caption text
{Number}	inPoint in point
{Number}	duration duration
{String}	captionStylePackageId caption style package id
{Boolean}	isPanoramic panoramic or not

Returns

{NvsClipCaption} Returns the NvsClipCaption object. It will return null in the following situations:

No caption function authorization;
If inPoint is less than 0 or greater than or equal to the current video clip duration, or duration is not greater than 0.

◆ addCompoundCaption()

NvsVideoClip::addCompoundCaption	(	inPoint,
		duration,
		compoundCaptionPackageId
	)

inline

add compound caption

Parameters

{Number}	inPoint in point
{Number}	duration duration
{String}	compoundCaptionPackageId compound caption package id

Returns: {NvsClipCompoundCaption}

◆ addModularCaption()

NvsVideoClip::addModularCaption	(	captionText,
		inPoint,
		duration
	)

inline

add modular caption

Parameters

{String}	captionText caption text
{Number}	inPoint in point
{Number}	duration duration

Returns

{NvsClipCaption} Returns the NvsClipCaption object. It will return null in the following situations:

No caption function authorization;
If inPoint is less than 0 or greater than or equal to the current video clip duration, or duration is not greater than 0.

◆ appendAudioFx()

NvsVideoClip::appendAudioFx ( fxName )

inline

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

Parameters

{String} fxName Audio effect name.

Returns: {NvsAudioFx} Returns the appended audio effect object.

◆ appendBuiltinFx()

NvsVideoClip::appendBuiltinFx ( fxName )

inline

Appends built-in effect to clips.

Parameters

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

Returns: {NvsVideoFx} Returns the added video effect object.

◆ appendPackagedFx()

NvsVideoClip::appendPackagedFx ( fxPackageId )

inline

Appends package effect to the clip.

Parameters

{String} fxPackageId Effect resource package ID.

Returns: {NvsVideoFx} Returns the added video effect object.

◆ appendRawBuiltinFx()

NvsVideoClip::appendRawBuiltinFx ( fxName )

inline

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

Parameters

{String} fxName The effect name.

Returns: {NvsVideoFx} Returns the added video effect object.

◆ appendRawPackagedFx()

NvsVideoClip::appendRawPackagedFx ( fxPackageId )

inline

Appends package effect on the raw input to the clip.

Parameters

{String} fxPackageId Effect resource package ID.

Returns: {NvsVideoFx} Returns the added video effect object.

◆ constructor()

NvsVideoClip::constructor ( )

inline

@constructor

◆ disableAudioStreams()

NvsVideoClip::disableAudioStreams ( disabled )

inline

Disable audio streams.

Parameters

{Boolean} disabled disable or not.

Returns: {}

◆ enableClipFreezeFrame()

NvsVideoClip::enableClipFreezeFrame ( enabled )

inline

Sets the clip's hdr enable status.

Parameters

{Boolean} enabled enable status.

Returns: {}

◆ enablePropertyVideoFx()

NvsVideoClip::enablePropertyVideoFx ( enabled )

inline

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

Parameters

{Boolean} enable Turn on or not.

Returns: {}

◆ enableRawSourceMode()

NvsVideoClip::enableRawSourceMode ( enable )

inline

Enable raw source mode of the video clip. If raw source mode is enabled, SetPanAndScan, GetPanAndScan, DisableAmbiguousCrop, IsAmbiguousCropDisabled, SetImageMotionMode, ImageMotionMode, SetImageMotionROI, GetImageMotionROI, SetImageMotionAnimationEnabled, IsImageMotionAnimationEnabled, SetImageMaskROI and GetImageMaskROI are invalid. If property fx enabled, the parameters related are invalid also.

Parameters

{Boolean} enable Enable or not.

Returns: {}

◆ getAnimatedStickersByClipTimePosition()

NvsVideoClip::getAnimatedStickersByClipTimePosition ( clipTimePos )

inline

Get an animated sticker list based on the position on video clip.

Parameters

{Number} clipTimePos Position on video clip (in microseconds)

Returns: {NvsVectorVal<NvsClipAnimatedSticker>} 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.

◆ getAudioFxByIndex()

NvsVideoClip::getAudioFxByIndex ( fxIndex )

inline

Gets audio effect by index.

Parameters

{Number} fxIndex Audio effects' index to insert at.

Returns: {NvsAudioFx} Returns the acquired audio effect object.

◆ getAudioFxCount()

NvsVideoClip::getAudioFxCount ( )

inline

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

Returns: {Number} Returns the number of audio effects on the video clip.

◆ getBlendingMode()

NvsVideoClip::getBlendingMode ( )

inline

Get blending mode from video Clip.

Returns: {Number} current Clip blending mode. (CLIP_BLENDING_MODE)

◆ getCaptionsByClipTimePosition()

NvsVideoClip::getCaptionsByClipTimePosition ( clipTimePos )

inline

Get a list of captions based on the position on video clip.

Parameters

{Number} clipTimePos The position on video clip(in micro-second)

Returns: {NvsVectorVal<NvsClipCaption>} 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.

◆ getClipFreezeFrameTrimPosition()

NvsVideoClip::getClipFreezeFrameTrimPosition ( )

inline

Gets video freeze trim position(in microseconds).

Returns: {Number}

◆ getClipWrapMode()

NvsVideoClip::getClipWrapMode ( )

inline

Gets video loop mode.

Returns: {Number} Returns loop mode.(ClIP_WRAPMODE)

◆ getCompoundCaptionsByClipTimePosition()

NvsVideoClip::getCompoundCaptionsByClipTimePosition ( clipTimePos )

inline

Get a list of compound captions based on the position on video clip.

Parameters

{Number} clipTimePos The position on video clip(in micro-second)

Returns

{NvsVectorVal<NvsClipCompoundCaption>} Returns a list of compound captions at the current position。 The sorting rules for the obtained captions list are as follows:

If the in points are different, captions are sorted in the order of the in points;
If the in points are the same, and captions are sorted in the order of compound caption added.

◆ getEndROI()

NvsVideoClip::getEndROI ( )

inline

Gets image clip's terminating ROI.

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

◆ getExtraVideoRotation()

NvsVideoClip::getExtraVideoRotation ( )

inline

Gets the video's extra rotation angle.

Returns: {Number} Returns the extra rotation angle of the video.

◆ getFirstAnimatedSticker()

NvsVideoClip::getFirstAnimatedSticker ( )

inline

Get the first animated sticker on video clip.

Returns: {NvsClipAnimatedSticker} Return the NvsClipAnimatedSticker object.

◆ getFirstCaption()

NvsVideoClip::getFirstCaption ( )

inline

Get the first caption on video clip.

Returns: {NvsClipCaption} Return the NvsClipCaption object.

◆ getFirstCompoundCaption()

NvsVideoClip::getFirstCompoundCaption ( )

inline

Get the first compound caption on video clip.

Returns: {NvsClipCompoundCaption} Returns the compound caption object.

◆ getFxByIndex()

NvsVideoClip::getFxByIndex ( fxIndex )

inline

Gets special effect by index.

Parameters

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

Returns: {NvsVideoFx} Returns the obtained NvsVideoFx object.

◆ getImageMotionMode()

NvsVideoClip::getImageMotionMode ( )

inline

Gets image clip operation mode.

Returns: {Number} Returns the integer value indicating the mode of operation of the image clip.

◆ getLastAnimatedSticker()

NvsVideoClip::getLastAnimatedSticker ( )

inline

Get the last animated sticker on video clip.

Returns: {NvsClipAnimatedSticker} Return the NvsClipAnimatedSticker object.

◆ getLastCaption()

NvsVideoClip::getLastCaption ( )

inline

Get the last caption on video clip.

Returns: {NvsClipCaption} Returns the NvsClipCaption object.

◆ getLastCompoundCaption()

NvsVideoClip::getLastCompoundCaption ( )

inline

Get the last compound caption on video clip.

Returns: {NvsClipCompoundCaption} Returns the compound caption object.

◆ getNextAnimatedSticker()

NvsVideoClip::getNextAnimatedSticker ( animatedSticker )

inline

Get the next animated sticker of the current animated sticker of video clip.

Parameters

{NvsClipAnimatedSticker} animatedSticker The current animated sticker of video clip

Returns: {NvsClipAnimatedSticker} The next animated sticker.

◆ getNextCaption()

NvsVideoClip::getNextCaption ( caption )

inline

Get the next caption of the current caption on video clip.

Parameters

{NvsClipCaption} caption The current caption on video clip

Returns: {NvsClipCaption} Returns the NvsClipCaption object.

◆ getNextCompoundCaption()

NvsVideoClip::getNextCompoundCaption ( caption )

inline

Get the next compound caption of the current caption on video clip.

Parameters

{NvsClipCompoundCaption} caption The current compound caption on video clip

Returns: {NvsClipCompoundCaption} Returns the compound caption object.

◆ getPanAndScan()

NvsVideoClip::getPanAndScan ( )

inline

Gets pan and scan.

Returns: {NvsPanAndScan} Return the acquired pan and scan object.

◆ getPlayInReverse()

NvsVideoClip::getPlayInReverse ( )

inline

Gets whether the clip is reversed.

Returns: {Boolean} Returns whether the clip is reversed.

◆ getPrevAnimatedSticker()

NvsVideoClip::getPrevAnimatedSticker ( animatedSticker )

inline

Get the previous animated sticker of the current animated sticker of video clip.

Parameters

{NvsClipAnimatedSticker} animatedSticker The current animated sticker of video clip

Returns: {NvsClipAnimatedSticker} The previous animated sticker.

◆ getPrevCaption()

NvsVideoClip::getPrevCaption ( caption )

inline

Get the previous caption of the current caption on video clip.

Parameters

{NvsClipCaption} caption The current caption on video clip

Returns: {NvsClipCaption} Returns the NvsClipCaption object.

◆ getPrevCompoundCaption()

NvsVideoClip::getPrevCompoundCaption ( caption )

inline

Get the previous compound caption of the current compound caption on video clip.

Parameters

{NvsClipCompoundCaption} caption The current compound caption on video clip

Returns: {NvsClipCompoundCaption} Returns the compound caption object.

◆ getPropertyVideoFx()

NvsVideoClip::getPropertyVideoFx ( )

inline

Gets the property effect of the video clip.

Returns: {NvsVideoFx} Returns the obtained NvsVideoFx object.

◆ getRawFilterProcessesMode()

NvsVideoClip::getRawFilterProcessesMode ( )

inline

Get raw filter processing mode.

Returns: {Number} Current raw filter processing mode. (NvsRawFilterProcessesMode)

◆ getRawFxByIndex()

NvsVideoClip::getRawFxByIndex ( fxIndex )

inline

Gets special effect by index on the raw input.

Parameters

{Number} fxIndex Special effect index.

Returns: {NvsVideoFx} Returns the obtained video effect object.

◆ getRawFxCount()

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: {Number} Returns the number of special effects on the clip.

◆ getRefImageBackgroundBlurRadius()

NvsVideoClip::getRefImageBackgroundBlurRadius ( )

inline

Gets reference image background blur radius.

Returns: {Number} Current reference image background blur radius.

◆ getRefImageBackgroundColor()

NvsVideoClip::getRefImageBackgroundColor ( )

inline

Gets reference image background color.

Returns: {NvsColor} Current reference image background color.

◆ getRefImageFillMode()

NvsVideoClip::getRefImageFillMode ( )

inline

Gets reference image fill mode.

Returns: {Number} Current reference image fill mode.

◆ getRefImageSize()

NvsVideoClip::getRefImageSize ( )

inline

Gets reference image size.

Returns: {NvsVideoResolution} Reference image size.

◆ getRoleInTheme()

NvsVideoClip::getRoleInTheme ( )

inline

Gets the role of the clip in the theme.

Returns: {Number} Returns role of clip in the theme.

◆ getSourceBackgroundColor()

NvsVideoClip::getSourceBackgroundColor ( )

inline

Gets the background color.

Returns: {NvsColor} Background color

◆ getSourceBackgroundMode()

NvsVideoClip::getSourceBackgroundMode ( )

inline

Gets background mode.

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

◆ getStartROI()

NvsVideoClip::getStartROI ( )

inline

Gets the image clip's starting ROI.

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

◆ getVideoType()

NvsVideoClip::getVideoType ( )

inline

Gets clip type.

Returns: {Number} Returns clip type.

◆ insertAudioFx()

NvsVideoClip::insertAudioFx	(	fxName,
		fxIndex
	)

inline

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

Parameters

{String}	fxName Audio effect name.
{Number}	fxIndex Audio effects' index to insert at.

Returns: {NvsAudioFx} Returns the inserted audio effect object.

◆ insertBuiltinFx()

NvsVideoClip::insertBuiltinFx	(	fxName,
		fxIndex
	)

inline

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

Parameters

{String}	fxName fx name
{Number}	fxIndex fx index

Returns: {NvsVideoFx} Returns the inserted video effect object.

◆ insertPackagedFx()

NvsVideoClip::insertPackagedFx	(	fxPackageId,
		fxIndex
	)

inline

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

Parameters

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

Returns: {NvsVideoFx} Returns the inserted video effect object.

◆ insertRawBuiltinFx()

NvsVideoClip::insertRawBuiltinFx	(	fxName,
		fxIndex
	)

inline

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

Parameters

{String}	fxName The effect name.
{Number}	fxIndex Effect index to insert at.

Returns: {NvsVideoFx} Returns the inserted video effect object.

◆ insertRawPackagedFx()

NvsVideoClip::insertRawPackagedFx	(	fxPackageId,
		fxIndex
	)

inline

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

Parameters

{String}	fxPackageId Effect resource package ID.
{Number}	fxIndex Effect index to insert at.

Returns: {NvsVideoFx} Returns the inserted video effect object.

◆ isAudioStreamsDisabled()

NvsVideoClip::isAudioStreamsDisabled ( )

inline

Is audio streams disabled.

Returns: {Boolean} Disabled or not.

◆ isClipFreezeFrameEnabled()

NvsVideoClip::isClipFreezeFrameEnabled ( )

inline

Gets video freeze frame enabled.

Returns: {Boolean} Turn on or not.

◆ isImageMotionAnimationEnabled()

NvsVideoClip::isImageMotionAnimationEnabled ( )

inline

enable image animation of motion or not

Returns: {Boolean}

◆ isPropertyVideoFxEnabled()

NvsVideoClip::isPropertyVideoFxEnabled ( )

inline

Gets whether the original scale rendering mode is turned on.

Returns: {Boolean} Turn on or not.

◆ isRawSourceModeEnabled()

NvsVideoClip::isRawSourceModeEnabled ( )

inline

Raw source mode is enabled or not.

Returns: {Boolean} Enabled or not.

◆ removeAllAudioFx()

NvsVideoClip::removeAllAudioFx ( )

inline

Removes all audio effects.

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

◆ removeAllFx()

NvsVideoClip::removeAllFx ( )

inline

Removes all effects.

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

◆ removeAllVideoFx()

NvsVideoClip::removeAllVideoFx ( )

inline

Removes all video effects.

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

◆ removeAnimatedSticker()

NvsVideoClip::removeAnimatedSticker ( animatedSticker )

inline

Remove an animated sticker on video clip.

Parameters

{NvsClipAnimatedSticker} animatedSticker The animated sticker need to be removed

Returns: {NvsClipAnimatedSticker} Return the next animated sticker object.

◆ removeAudioFx()

NvsVideoClip::removeAudioFx ( fxIndex )

inline

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

Parameters

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

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

◆ removeCaption()

NvsVideoClip::removeCaption ( caption )

inline

Remove the caption on video clip.

Parameters

{NvsClipCaption} caption The caption need to be removed

Returns: {NvsClipCaption} Returns the next NvsClipCaption object.

◆ removeCompoundCaption()

NvsVideoClip::removeCompoundCaption ( caption )

inline

Remove compound caption from video clip.

Parameters

{NvsClipCompoundCaption} caption The compound caption need to be removed

Returns: {NvsClipCompoundCaption} Returns the next compound caption object.

◆ removeFx()

NvsVideoClip::removeFx ( fxIndex )

inline

Remove effect by index.

Parameters

{Number} fxIndex Special effect index, please refer togetFxCount().

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

◆ removeRawFx()

NvsVideoClip::removeRawFx ( fxIndex )

inline

Remove effect by index on the raw input.

Parameters

{Number} fxIndex Special effect index.

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

◆ setBlendingMode()

NvsVideoClip::setBlendingMode ( mode )

inline

Set blending mode to video Clip.

Parameters

{Number} mode new blending mode. (CLIP_BLENDING_MODE)

Returns: {}

◆ setClipFreezeFrameTrimPosition()

NvsVideoClip::setClipFreezeFrameTrimPosition ( trimPos )

inline

Sets the clip's freeze trim position.

Parameters

{Number} trimPos freeze trim position(in microseconds).

Returns: {}

◆ setClipWrapMode()

NvsVideoClip::setClipWrapMode ( wrapMode )

inline

Sets the clip's loop mode.

Parameters

{Number} wrapMode Loop mode.(ClIP_WRAPMODE)

Returns: {}

◆ setExtraVideoRotation()

NvsVideoClip::setExtraVideoRotation ( rotation )

inline

Sets the video's extra rotation angle.

Parameters

{Number} rotation The extra rotation angle of the video.

Returns: {}

◆ setImageMotionAnimationEnabled()

NvsVideoClip::setImageMotionAnimationEnabled ( enabled )

inline

Sets whether to support image animation.

Parameters

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

Returns: {}

◆ setImageMotionMode()

NvsVideoClip::setImageMotionMode ( mode )

inline

Sets image mode of operation.

Parameters

{Number} mode Image clip mode of operation.

Returns: {}

◆ setImageMotionROI()

NvsVideoClip::setImageMotionROI	(	startROI,
		endROI
	)

inline

Sets clip's dynamic move ROI.

Parameters

{Rect}	startROI clip's starting ROI.
{Rect}	endROI clip's terminating ROI.

Returns: {}

◆ setPanAndScan()

NvsVideoClip::setPanAndScan	(	pan,
		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.

Parameters

{Number}	pan Pan
{Number}	scan Scan

Returns: {}

◆ setPlayInReverse()

NvsVideoClip::setPlayInReverse ( playInReverse )

inline

Sets whether the clip is reversed.

Parameters

{Boolean} playInReverse Whether the clip is reversed.

Returns: {}

◆ setRawFilterProcessesMode()

NvsVideoClip::setRawFilterProcessesMode ( mode )

inline

Set raw filter processing mode.

Parameters

{Number} mode processing mode. (NvsRawFilterProcessesMode)

Returns: {}

◆ setRefImageBackgroundBlurRadius()

NvsVideoClip::setRefImageBackgroundBlurRadius ( radius )

inline

Sets reference image background blur radius.

Parameters

{Number} radius Background blur radius.

Returns: {}

◆ setRefImageBackgroundColor()

NvsVideoClip::setRefImageBackgroundColor ( color )

inline

Sets reference image background color.

Parameters

{NvsColor} color Background color.

Returns: {}

◆ setRefImageFillMode()

NvsVideoClip::setRefImageFillMode ( mode )

inline

Sets reference image fill mode.

Parameters

{Number} mode Fill mode.

Returns: {}

◆ setRefImageSize()

NvsVideoClip::setRefImageSize	(	width,
		height
	)

inline

Sets reference image size.

Parameters

{Number}	width Width.
{Number}	height Height.

Returns: {}

◆ setSourceBackgroundColor()

NvsVideoClip::setSourceBackgroundColor ( color )

inline

Sets the background color.

Parameters

{NvsColor} color The background color

Returns: {}

◆ setSourceBackgroundMode()

NvsVideoClip::setSourceBackgroundMode ( mode )

inline

Sets background mode, Background Mode (ClIP_BACKGROUNDMODE).

Parameters

{Number} mode Background mode.

Returns: {}

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

src/js/NvStreamingSdk.js

Public Member Functions

Detailed Description

Member Function Documentation

◆ addAnimatedSticker()

◆ addCaption()

◆ addCompoundCaption()

◆ addModularCaption()

◆ appendAudioFx()

◆ appendBuiltinFx()

◆ appendPackagedFx()

◆ appendRawBuiltinFx()

◆ appendRawPackagedFx()

◆ constructor()

◆ disableAudioStreams()

◆ enableClipFreezeFrame()

◆ enablePropertyVideoFx()

◆ enableRawSourceMode()

◆ getAnimatedStickersByClipTimePosition()

◆ getAudioFxByIndex()

◆ getAudioFxCount()

◆ getBlendingMode()

◆ getCaptionsByClipTimePosition()

◆ getClipFreezeFrameTrimPosition()

◆ getClipWrapMode()

◆ getCompoundCaptionsByClipTimePosition()

◆ getEndROI()

◆ getExtraVideoRotation()

◆ getFirstAnimatedSticker()

◆ getFirstCaption()

◆ getFirstCompoundCaption()

◆ getFxByIndex()

◆ getImageMotionMode()

◆ getLastAnimatedSticker()

◆ getLastCaption()

◆ getLastCompoundCaption()

◆ getNextAnimatedSticker()

◆ getNextCaption()

◆ getNextCompoundCaption()

◆ getPanAndScan()

◆ getPlayInReverse()

◆ getPrevAnimatedSticker()

◆ getPrevCaption()

◆ getPrevCompoundCaption()

◆ getPropertyVideoFx()

◆ getRawFilterProcessesMode()

◆ getRawFxByIndex()

◆ getRawFxCount()

◆ getRefImageBackgroundBlurRadius()

◆ getRefImageBackgroundColor()

◆ getRefImageFillMode()

◆ getRefImageSize()

◆ getRoleInTheme()

◆ getSourceBackgroundColor()

◆ getSourceBackgroundMode()

◆ getStartROI()

◆ getVideoType()

◆ insertAudioFx()

◆ insertBuiltinFx()

◆ insertPackagedFx()

◆ insertRawBuiltinFx()

◆ insertRawPackagedFx()

◆ isAudioStreamsDisabled()

◆ isClipFreezeFrameEnabled()

◆ isImageMotionAnimationEnabled()

◆ isPropertyVideoFxEnabled()

◆ isRawSourceModeEnabled()

◆ removeAllAudioFx()

◆ removeAllFx()

◆ removeAllVideoFx()

◆ removeAnimatedSticker()

◆ removeAudioFx()

◆ removeCaption()

◆ removeCompoundCaption()

◆ removeFx()

◆ removeRawFx()

◆ setBlendingMode()

◆ setClipFreezeFrameTrimPosition()

◆ setClipWrapMode()

◆ setExtraVideoRotation()

◆ setImageMotionAnimationEnabled()