Timeline is which the entity of editing the scene. More...

Inheritance diagram for com.meicam.sdk.NvsTimeline:

Classes
class	PlaybackRateControlRegion

Public Member Functions
NvsVideoResolution	getVideoRes ()
	Gets video's resolution (image's width, height and aspect ratio). More...

NvsAudioResolution	getAudioRes ()
	Gets audio's resolution (sampling rate, sampling format and number of channels). More...

NvsRational	getVideoFps ()
	Gets the framerate of the video. More...

long	getDuration ()
	Gets timeline's duration. More...

NvsVideoTrack	appendVideoTrack ()
	Appends video track. More...

NvsAudioTrack	appendAudioTrack ()
	Appends audio track. More...

boolean	removeVideoTrack (int trackIndex)
	Remove video track. More...

boolean	removeAudioTrack (int trackIndex)
	Remove audio track. More...

int	videoTrackCount ()
	Get count of video track. More...

int	audioTrackCount ()
	Get count of audio track. More...

NvsVideoTrack	getVideoTrackByIndex (int trackIndex)
	Gets video track with track index. More...

NvsAudioTrack	getAudioTrackByIndex (int trackIndex)
	Gets audio track with track index. More...

boolean	changeVideoSize (int videoWidth, int videoHeight)
	Change the timeline video resolution. Remark:If timeline is linked to a surfaceTexture, the surfaceTexture must be detached first, and then timeline video resolution can be changed. After timeline resolution is changed, the SurfaceTexture can be re-attached to timeline. More...

void	setCaptionBoundingRectInActualMode (boolean isActualBoundingRect)
	Set the border of the caption to the actual envelope size of the text. More...

NvsTimelineCaption	getFirstCaption ()
	Get the first caption on the timeline. More...

NvsTimelineCaption	getLastCaption ()
	Get the last caption on the timeline. More...

NvsTimelineCaption	getPrevCaption (NvsTimelineCaption caption)
	Get the previous caption of the current caption on the timeline. More...

NvsTimelineCaption	getNextCaption (NvsTimelineCaption caption)
	Get the next caption of the current caption on the timeline. More...

List< NvsTimelineCaption >	getCaptionsByTimelinePosition (long timelinePos)
	Get a list of captions based on the position on the timeline. More...

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

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

NvsTimelineCaption	removeCaption (NvsTimelineCaption caption)
	Remove the caption on the timeline. More...

NvsTimelineAnimatedSticker	getFirstAnimatedSticker ()
	Get the first animated sticker on the timeline. More...

NvsTimelineAnimatedSticker	getLastAnimatedSticker ()
	Get the last animated sticker on the timeline. More...

NvsTimelineAnimatedSticker	getPrevAnimatedSticker (NvsTimelineAnimatedSticker animatedSticker)
	Get the previous animated sticker of the current animated sticker of the timeline. More...

NvsTimelineAnimatedSticker	getNextAnimatedSticker (NvsTimelineAnimatedSticker animatedSticker)
	Get the next animated sticker of the current animated sticker of the timeline. More...

List< NvsTimelineAnimatedSticker >	getAnimatedStickersByTimelinePosition (long timelinePos)
	Get an animated sticker list based on the position on the timeline. More...

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

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

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

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

NvsTimelineAnimatedSticker	removeAnimatedSticker (NvsTimelineAnimatedSticker animatedSticker)
	Remove an animated sticker on the timeline. More...

NvsTimelineVideoFx	getFirstTimelineVideoFx ()
	Get the first timeline video effect on the timeline. More...

NvsTimelineVideoFx	getLastTimelineVideoFx ()
	Get the last timeline video effect on the timeline. More...

NvsTimelineVideoFx	getPrevTimelineVideoFx (NvsTimelineVideoFx videoFx)
	Get the previous timeline video effect of a timeline video effect on the timeline. More...

NvsTimelineVideoFx	getNextTimelineVideoFx (NvsTimelineVideoFx videoFx)
	Get the next timeline video effect of a timeline video effect on the timeline. More...

List< NvsTimelineVideoFx >	getTimelineVideoFxByTimelinePosition (long timelinePos)
	Get a list of timeline video effects based on position on the timeline. More...

NvsTimelineVideoFx	addBuiltinTimelineVideoFx (long inPoint, long duration, String videoFxName)
	Add a built-in timeline video effect on the timeline. More...

NvsTimelineVideoFx	addPackagedTimelineVideoFx (long inPoint, long duration, String videoFxPackageId)
	Add a timeline video effect in the form of a resource package on the timeline. More...

NvsTimelineVideoFx	addCustomTimelineVideoFx (long inPoint, long duration, NvsCustomVideoFx.Renderer customVideoFxRender)
	Add a custom timeline video effect on the timeline. More...

NvsTimelineVideoFx	removeTimelineVideoFx (NvsTimelineVideoFx videoFx)
	Remove a timeline video effect from the timeline. More...

String	getCurrentThemeId ()
	Get the id of the current theme. More...

boolean	applyTheme (String themeId)
	Apply a theme to the current timeline (the theme is relative to the entire timeline). More...

void	removeCurrentTheme ()
	Remove current theme. More...

void	setThemeTitleCaptionText (String text)
	Set the caption text for theme title. More...

void	setThemeTrailerCaptionText (String text)
	Set the caption text for theme trailer. More...

void	setThemeMusicVolumeGain (float leftVolumeGain, float rightVolumeGain)
	Set the volume value for theme music. More...

NvsVolume	getThemeMusicVolumeGain ()
	Get the volume value for theme music. More...

boolean	addWatermark (String watermarkFilePath, int displayWidth, int displayHeight, float opacity, int position, int marginX, int marginY)
	Add watermark. More...

void	deleteWatermark ()
	Delete watermark which has added. More...

boolean	setWatermarkOpacity (float opacity)
	Set watermark opacity. More...

boolean	setTimelineEndingLogo (String logoFilePath, int displayWidth, int displayHeight, int centerX, int centerY)
	Set the logo effect at the end of the timeline. More...

void	removeTimelineEndingLogo ()
	Remove the logo effect at the end of the timeline. More...

void	setAudioFadeOutDuration (long duration)
	Sets audio fade out duration. More...

long	getAudioFadeOutDuration ()
	Gets audio fade out duration. More...

void	setPlaybackRateControl (PlaybackRateControlRegion[] playbackRateControlRegions)

PlaybackRateControlRegion[]	getPlaybackRateControl ()

Public Member Functions inherited from com.meicam.sdk.NvsObject
void	setAttachment (String key, Object value)
	Adds additional data to the NvsObject object to identify the NvsObject object or for other purpose. More...

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

Static Public Attributes
Watermark position

static final int	NvsTimelineWatermarkPosition_TopRight = 0
	Watermark on top-right. More...

static final int	NvsTimelineWatermarkPosition_TopLeft = 1
	Watermark on top-left. More...

static final int	NvsTimelineWatermarkPosition_BottomLeft = 2
	Watermark on bottom-left. S. More...

static final int	NvsTimelineWatermarkPosition_BottomRight = 3

Additional Inherited Members
Protected Member Functions inherited from com.meicam.sdk.NvsObject
void	setInternalObject (long internalObject)

long	getInternalObject ()

Protected Attributes inherited from com.meicam.sdk.NvsObject
long	m_internalObject = 0

Detailed Description

Timeline is which the entity of editing the scene.

The timeline consists of tracks and can be thought of as a collection of audio and video tracks. The timeline can add or remove multiple video and audio tracks, and the multiple tracks are superimposed and combined. When editing video,users can add captions. themes, animated stickers to make final beautifull videos.Otherwise,User needs to install asset package (theme package, animated stick package, Caption style and timeline effect package) before loading and using them. Each package comes with its unique package ID.For built-in timeline effects, they can be applied only with obtaining their effect name.

Warning: : for NvsTimeline class，all public APIs should be implemented in a UI thread!!!

Member Function Documentation

NvsTimelineAnimatedSticker com.meicam.sdk.NvsTimeline.addAnimatedSticker	(	long	inPoint,
		long	duration,
		String	animatedStickerPackageId
	)

inline

Add a animated sticker on the timeline.

Parameters

inPoint	The in point of the animated sticker on the timeline (in microseconds)
duration	The duration of the animation sticker which displayed (in microseconds)
animatedStickerPackageId	Animated sticker package Id

Returns: Return the NvsTimelineAnimatedSticker object.

See also: removeAnimatedSticker

NvsTimelineVideoFx com.meicam.sdk.NvsTimeline.addBuiltinTimelineVideoFx	(	long	inPoint,
		long	duration,
		String	videoFxName
	)

inline

Add a built-in timeline video effect on the timeline.

Parameters

inPoint	The in point of the timeline video effect on the timeline (in microseconds)
duration	Duration of the timeline video effect which displayed (in microseconds)
videoFxName	The video effect name

Returns: Return the NvsTimelineVideoFx object

NvsTimelineCaption com.meicam.sdk.NvsTimeline.addCaption	(	String	captionText,
		long	inPoint,
		long	duration,
		String	captionStylePackageId
	)

inline

Add a caption on the timeline.

Parameters

captionText	Text of caption
inPoint	The in point of the caption on the timeline (in microseconds)
duration	Caption display duration (in microseconds)
captionStylePackageId	Caption style package Id

Returns: Returns the NvsTimelineCaption object

See also: removeCaption

NvsTimelineAnimatedSticker com.meicam.sdk.NvsTimeline.addCustomAnimatedSticker	(	long	inPoint,
		long	duration,
		String	animatedStickerPackageId,
		String	customImagePath
	)

inline

Add a custom animated sticker on the timeline.

Parameters

inPoint	The in point of custom animated sticker on the timeline (in microseconds)
duration	The duration of custom animation sticker which displayed (in microseconds)
animatedStickerPackageId	Animated sticker package Id
customImagePath	Path of custom animated sticker image

Returns: Return the NvsTimelineAnimatedSticker object.

See also: removeAnimatedSticker

NvsTimelineAnimatedSticker com.meicam.sdk.NvsTimeline.addCustomPanoramicAnimatedSticker	(	long	inPoint,
		long	duration,
		String	animatedStickerPackageId,
		String	customImagePath
	)

inline

Add a a custom panorama animated sticker on the timeline.

Parameters

inPoint	The in point of custom animated sticker on the timeline (in microseconds)
duration	The duration of custom animation sticker which displayed (in microseconds)
animatedStickerPackageId	Animated sticker package Id
customImagePath	Path of custom animated sticker image

Returns: Return the NvsTimelineAnimatedSticker object.

Since: 1.6.0

See also: removeAnimatedSticker

NvsTimelineVideoFx com.meicam.sdk.NvsTimeline.addCustomTimelineVideoFx	(	long	inPoint,
		long	duration,
		NvsCustomVideoFx.Renderer	customVideoFxRender
	)

inline

Add a custom timeline video effect on the timeline.

Parameters

inPoint	The in point of the timeline video effect on the timeline (in microseconds)
duration	Duration of the timeline video effect which displayed (in microseconds)
customVideoFxRender	User-implemented custom video effects renderer interface

Returns: Return the NvsTimelineVideoFx object

Since: 1.7.0

NvsTimelineVideoFx com.meicam.sdk.NvsTimeline.addPackagedTimelineVideoFx	(	long	inPoint,
		long	duration,
		String	videoFxPackageId
	)

inline

Add a timeline video effect in the form of a resource package on the timeline.

Parameters

inPoint	The in point of the timeline video effect on the timeline (in microseconds)
duration	Duration of the timeline video effect which displayed (in microseconds)
videoFxPackageId	The Id of resource package

Returns: Return the NvsTimelineVideoFx object

NvsTimelineAnimatedSticker com.meicam.sdk.NvsTimeline.addPanoramicAnimatedSticker	(	long	inPoint,
		long	duration,
		String	animatedStickerPackageId
	)

inline

Add a panorama animation sticker on the timeline.

Parameters

inPoint	The in point of the animated sticker on the timeline (in microseconds)
duration	The duration of the animation sticker which displayed (in microseconds)
animatedStickerPackageId	Animated sticker package Id

Returns: Return the NvsTimelineAnimatedSticker object.

Since: 1.6.0

See also: removeAnimatedSticker

NvsTimelineCaption com.meicam.sdk.NvsTimeline.addPanoramicCaption	(	String	captionText,
		long	inPoint,
		long	duration,
		String	captionStylePackageId
	)

inline

Add a panorama caption on the timeline.

Parameters

captionText	Text of caption
inPoint	The in point of the caption on the timeline (in microseconds)
duration	Caption display duration (in microseconds)
captionStylePackageId	Caption style package Id

Returns: Returns the NvsTimelineCaption object

Since: 1.6.0

See also: removeCaption

boolean com.meicam.sdk.NvsTimeline.addWatermark	(	String	watermarkFilePath,
		int	displayWidth,
		int	displayHeight,
		float	opacity,
		int	position,
		int	marginX,
		int	marginY
	)

inline

Add watermark.

Parameters

watermarkFilePath	The path of the watermark file must be a .PNG or .JPG file.
displayWidth	The width of the watermark displayed in the timeline. If 0, the width of the image file is used.
displayHeight	The height of the watermark displayed in the timeline. If 0, the height of the image file is used.
opacity	Watermark opacity, the range is [0,1]
position	The position of the watermark, please refer to NvsTimelineWatermarkPosition
marginX	The margin of the watermark in the horizontal direction
marginY	The margin of the watermark in the vertical direction

Warning: This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.

See also: deleteWatermark; setWatermarkOpacity

NvsAudioTrack com.meicam.sdk.NvsTimeline.appendAudioTrack ( )

inline

Appends audio track.

Returns: returns the appended NvsAudioTrack object.

Warning: This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.

See also: removeAudioTrack; audioTrackCount; getAudioTrackByIndex

NvsVideoTrack com.meicam.sdk.NvsTimeline.appendVideoTrack ( )

inline

Appends video track.

Returns: returns the appended NvsVideoTrack object.

Warning: This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.

See also: removeVideoTrack; videoTrackCount; getVideoTrackByIndex

boolean com.meicam.sdk.NvsTimeline.applyTheme ( String themeId )

inline

Apply a theme to the current timeline (the theme is relative to the entire timeline).

For themes, there may be a title or a trailer, or both of them, or none. When applying a theme with a title or a trailer or both of them are treated as a clip, resulting in an increase in the count of clips. When using this interface, be careful to determine the count of clips.

Parameters

themeId Id of theme package

Returns: Determine if the theme is applied successfully. If YES is returned, the theme is used successfully, and NO means the oppsite.

Warning: This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.

See also: getCurrentThemeId; removeCurrentTheme

int com.meicam.sdk.NvsTimeline.audioTrackCount ( )

inline

Get count of audio track.

Returns: returns count of audio track.

See also: appendAudioTrack; removeAudioTrack

boolean com.meicam.sdk.NvsTimeline.changeVideoSize	(	int	videoWidth,
		int	videoHeight
	)

inline

Change the timeline video resolution.
Remark:If timeline is linked to a surfaceTexture, the surfaceTexture must be detached first, and then timeline video resolution can be changed. After timeline resolution is changed, the SurfaceTexture can be re-attached to timeline.

Parameters

videoWidth	New video width
videoHeight	New video height

Returns: Reurns YES means it changes successfully, NO means it fails.

Since: 2.0.1

void com.meicam.sdk.NvsTimeline.deleteWatermark ( )

inline

Delete watermark which has added.

Warning: This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.

See also: addWatermark; setWatermarkOpacity

List<NvsTimelineAnimatedSticker> com.meicam.sdk.NvsTimeline.getAnimatedStickersByTimelinePosition ( long timelinePos )

inline

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

Parameters

timelinePos Position on the timeline (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.

See also: addAnimatedSticker

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

inline

Gets audio fade out duration.

Returns: Returns the duration of fade out (in microseconds).

Since: 1.15.0

See also: setAudioFadeOutDuration

NvsAudioResolution com.meicam.sdk.NvsTimeline.getAudioRes ( )

inline

Gets audio's resolution (sampling rate, sampling format and number of channels).

Returns: Returns the NvsAudioResolution object.

NvsAudioTrack com.meicam.sdk.NvsTimeline.getAudioTrackByIndex ( int trackIndex )

inline

Gets audio track with track index.

Parameters

trackIndex Index of audio track

Returns: returns the NvsAudioTrack object.

See also: appendAudioTrack; audioTrackCount; removeAudioTrack

List<NvsTimelineCaption> com.meicam.sdk.NvsTimeline.getCaptionsByTimelinePosition ( long timelinePos )

inline

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

Parameters

timelinePos The position on the timeline(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

String com.meicam.sdk.NvsTimeline.getCurrentThemeId ( )

inline

Get the id of the current theme.

Returns: Current theme id, if no theme,returns null.

See also: applyTheme; removeCurrentTheme

long com.meicam.sdk.NvsTimeline.getDuration ( )

inline

Gets timeline's duration.

Returns: Returns timeline's duration (in microseconds).

NvsTimelineAnimatedSticker com.meicam.sdk.NvsTimeline.getFirstAnimatedSticker ( )

inline

Get the first animated sticker on the timeline.

Returns: Return the acquired NvsTimelineAnimatedSticker object.

See also: getLastAnimatedSticker; addAnimatedSticker

NvsTimelineCaption com.meicam.sdk.NvsTimeline.getFirstCaption ( )

inline

Get the first caption on the timeline.

Returns: Returns the NvsTimelineCaption object.

See also: getLastCaption; addCaption

NvsTimelineVideoFx com.meicam.sdk.NvsTimeline.getFirstTimelineVideoFx ( )

inline

Get the first timeline video effect on the timeline.

Returns: Returns the acquired NvsTimelineVideoFx object.

NvsTimelineAnimatedSticker com.meicam.sdk.NvsTimeline.getLastAnimatedSticker ( )

inline

Get the last animated sticker on the timeline.

Returns: Return the acquired NvsTimelineAnimatedSticker object.

See also: getFirstAnimatedSticker

NvsTimelineCaption com.meicam.sdk.NvsTimeline.getLastCaption ( )

inline

Get the last caption on the timeline.

Returns: Returns the NvsTimelineCaption object.

See also: getFirstCaption; addCaption

NvsTimelineVideoFx com.meicam.sdk.NvsTimeline.getLastTimelineVideoFx ( )

inline

Get the last timeline video effect on the timeline.

Returns: Returns the acquired NvsTimelineVideoFx object.

NvsTimelineAnimatedSticker com.meicam.sdk.NvsTimeline.getNextAnimatedSticker ( NvsTimelineAnimatedSticker animatedSticker )

inline

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

Parameters

animatedSticker the current NvsTimelineAnimatedSticker obejct

Returns: Return the acquired NvsTimelineAnimatedSticker object.

See also: getPrevAnimatedSticker

NvsTimelineCaption com.meicam.sdk.NvsTimeline.getNextCaption ( NvsTimelineCaption caption )

inline

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

Parameters

caption The current caption on the timeline

Returns: Returns the NvsTimelineCaption object.

See also: getPrevCaption

NvsTimelineVideoFx com.meicam.sdk.NvsTimeline.getNextTimelineVideoFx ( NvsTimelineVideoFx videoFx )

inline

Get the next timeline video effect of a timeline video effect on the timeline.

Parameters

videoFx The NvsTimelineVideoFx object

Returns: Returns the acquired NvsTimelineVideoFx object.

PlaybackRateControlRegion [] com.meicam.sdk.NvsTimeline.getPlaybackRateControl ( )

inline

NvsTimelineAnimatedSticker com.meicam.sdk.NvsTimeline.getPrevAnimatedSticker ( NvsTimelineAnimatedSticker animatedSticker )

inline

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

Parameters

animatedSticker the current NvsTimelineAnimatedSticker obejct

Returns: Return the acquired NvsTimelineAnimatedSticker object.

See also: getNextAnimatedSticker

NvsTimelineCaption com.meicam.sdk.NvsTimeline.getPrevCaption ( NvsTimelineCaption caption )

inline

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

Parameters

caption The current caption on the timeline

Returns: Returns the NvsTimelineCaption object.

See also: getNextCaption

NvsTimelineVideoFx com.meicam.sdk.NvsTimeline.getPrevTimelineVideoFx ( NvsTimelineVideoFx videoFx )

inline

Get the previous timeline video effect of a timeline video effect on the timeline.

Parameters

videoFx The NvsTimelineVideoFx object

Returns: Returns the acquired NvsTimelineVideoFx object.

NvsVolume com.meicam.sdk.NvsTimeline.getThemeMusicVolumeGain ( )

inline

Get the volume value for theme music.

Returns: Returns NvsVolume object.

See also: getThemeMusicVolumeGain:rightVolumeGain:

List<NvsTimelineVideoFx> com.meicam.sdk.NvsTimeline.getTimelineVideoFxByTimelinePosition ( long timelinePos )

inline

Get a list of timeline video effects based on position on the timeline.

Parameters

timelinePos The position on the timeline (in microseconds)

Returns: Returns an list of timeline video effects in current position.
The ordering rules for the acquired timeline video effects are as follows:
1.When adding, the in points are different, arranged in the order of the in points;
2.When adding, the entry points are the same, arranged in the order of adding timeline video effects.

NvsRational com.meicam.sdk.NvsTimeline.getVideoFps ( )

inline

Gets the framerate of the video.

Returns: Returns the framerate of the video.

NvsVideoResolution com.meicam.sdk.NvsTimeline.getVideoRes ( )

inline

Gets video's resolution (image's width, height and aspect ratio).

Returns: Returns the NvsVideoResolution object

See also: getAudioRes

NvsVideoTrack com.meicam.sdk.NvsTimeline.getVideoTrackByIndex ( int trackIndex )

inline

Gets video track with track index.

Parameters

trackIndex Index of video track

Returns: returns the NvsVideoTrack object.

See also: appendVideoTrack; videoTrackCount; removeVideoTrack

NvsTimelineAnimatedSticker com.meicam.sdk.NvsTimeline.removeAnimatedSticker ( NvsTimelineAnimatedSticker animatedSticker )

inline

Remove an animated sticker on the timeline.

Parameters

animatedSticker The NvsTimelineAnimatedSticker object which will be removed

Returns: Return the next NvsTimelineAnimatedSticker object.

See also: addAnimatedSticker

boolean com.meicam.sdk.NvsTimeline.removeAudioTrack ( int trackIndex )

inline

Remove audio track.

Parameters

trackIndex Index of audio track

Returns: Returns a boolean value.YES means it removes successfully, NO means it fails

Warning: This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.

See also: appendAudioTrack; audioTrackCount; getAudioTrackByIndex

NvsTimelineCaption com.meicam.sdk.NvsTimeline.removeCaption ( NvsTimelineCaption caption )

inline

Remove the caption on the timeline.

Parameters

caption timeline caption object which removed

Returns: Returns the next NvsTimelineCaption object.

See also: addCaption

void com.meicam.sdk.NvsTimeline.removeCurrentTheme ( )

inline

Remove current theme.

Warning: This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.

See also: applyTheme; getCurrentThemeId

void com.meicam.sdk.NvsTimeline.removeTimelineEndingLogo ( )

inline

Remove the logo effect at the end of the timeline.

Warning: This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.

See also: setTimelineEndingLogo

NvsTimelineVideoFx com.meicam.sdk.NvsTimeline.removeTimelineVideoFx ( NvsTimelineVideoFx videoFx )

inline

Remove a timeline video effect from the timeline.

Parameters

videoFx The NvsTimelineVideoFx object which will be removed

Returns: Returns the next NvsTimelineVideoFx object of current timeline video effect which has removed.

boolean com.meicam.sdk.NvsTimeline.removeVideoTrack ( int trackIndex )

inline

Remove video track.

Parameters

trackIndex Index of video track

Returns: Returns a boolean value.YES means it removes successfully, NO means it fails.

Warning: This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.

See also: appendVideoTrack; videoTrackCount; getVideoTrackByIndex

void com.meicam.sdk.NvsTimeline.setAudioFadeOutDuration ( long duration )

inline

Sets audio fade out duration.

Parameters

duration duration of fade out(in microseconds), if 0 ,there's then no fade out.

Since: 1.15.0

See also: getAudioFadeOutDuration

void com.meicam.sdk.NvsTimeline.setCaptionBoundingRectInActualMode ( boolean isActualBoundingRect )

inline

Set the border of the caption to the actual envelope size of the text.

Parameters

isActualBoundingRect Whether to display the actual envelope size

Since: 2.5.0

void com.meicam.sdk.NvsTimeline.setPlaybackRateControl ( PlaybackRateControlRegion[] playbackRateControlRegions )

inline

void com.meicam.sdk.NvsTimeline.setThemeMusicVolumeGain	(	float	leftVolumeGain,
		float	rightVolumeGain
	)

inline

Set the volume value for theme music.

Parameters

leftVolumeGain	Left channel
rightVolumeGain	Right channel

See also: getThemeMusicVolumeGain

void com.meicam.sdk.NvsTimeline.setThemeTitleCaptionText ( String text )

inline

Set the caption text for theme title.

Parameters

text	The caption text

See also: setThemeTrailerCaptionText; applyTheme:

void com.meicam.sdk.NvsTimeline.setThemeTrailerCaptionText ( String text )

inline

Set the caption text for theme trailer.

Parameters

text 字幕文本

See also: setThemeTitleCaptionText; applyTheme:

boolean com.meicam.sdk.NvsTimeline.setTimelineEndingLogo	(	String	logoFilePath,
		int	displayWidth,
		int	displayHeight,
		int	centerX,
		int	centerY
	)

inline

Set the logo effect at the end of the timeline.

Parameters

logoFilePath	The path of the logo file must be a .PNG or .JPG file.
displayWidth	The width of the logo displayed in the timeline. If 0, the width of the image file is used.
displayHeight	The height of the logo displayed in the timeline. If 0, the height of the image file is used.
centerX	logo中心点在X方向的位置
centerY	logo中心点在Y方向的位置

Warning: This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.

See also: removeTimelineEndingLogo

boolean com.meicam.sdk.NvsTimeline.setWatermarkOpacity ( float opacity )

inline

Set watermark opacity.

Parameters

opacity The opacity, the range is [0,1]

See also: addWatermark; deleteWatermark

int com.meicam.sdk.NvsTimeline.videoTrackCount ( )

inline

Get count of video track.

Returns: returns count of video track.

See also: appendVideoTrack; removeVideoTrack

Member Data Documentation

final int com.meicam.sdk.NvsTimeline.NvsTimelineWatermarkPosition_BottomLeft = 2

static

Watermark on bottom-left. S.

final int com.meicam.sdk.NvsTimeline.NvsTimelineWatermarkPosition_BottomRight = 3

static

Watermark on bottom-right.

final int com.meicam.sdk.NvsTimeline.NvsTimelineWatermarkPosition_TopLeft = 1

static

Watermark on top-left.

final int com.meicam.sdk.NvsTimeline.NvsTimelineWatermarkPosition_TopRight = 0

static

Watermark on top-right.

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

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

Classes

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation