MeiCam SDK For iOS
3.11.2
|
Timeline is which the entity of editing the scene. More...
#import <NvsTimeline.h>
Instance Methods | |
(int) | - getCreationFlags |
Get the flag for creating timeline. NvsCreateTimelineTypeFlag. More... | |
(NvsVideoTrack *) | - appendVideoTrack |
Appends video track. More... | |
(NvsAudioTrack *) | - appendAudioTrack |
Appends audio track. More... | |
(NvsVideoTrack *) | - insertVideoTrack: |
insert video track. More... | |
(NvsAudioTrack *) | - insertAudioTrack: |
Appends audio track. More... | |
(BOOL) | - removeVideoTrack: |
Remove video track. More... | |
(BOOL) | - removeAudioTrack: |
Remove audio track. More... | |
(unsigned int) | - videoTrackCount |
Get count of video track. More... | |
(unsigned int) | - audioTrackCount |
Get count of audio track. More... | |
(NvsVideoTrack *) | - getVideoTrackByIndex: |
Gets video track with track index. More... | |
(NvsAudioTrack *) | - getAudioTrackByIndex: |
Gets audio track with track index. More... | |
(BOOL) | - changeVideoSize: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... | |
(BOOL) | - changeVideoBitDepth: |
Change the timeline video bit depth. More... | |
(void) | - setCaptionBoundingRectInActualMode: |
Set the border of the caption to the actual envelope size of the text. More... | |
(void) | - enableRenderOrderByZValue: |
Turn on use the Z value as the render order. Note: there are timeline caption, compound caption, module captions, animation stickers and timeline filters If the Z value in the same type is the same, it is the same as the sorting method in which the property is not enabled If the Z values of different types are the same, the order is: timeline Filter > Animation sticker > timeline caption (including module caption) > compound caption. More... | |
(BOOL) | - isRenderOrderByZValueEnabled |
Whether to turn on use Z value as the rendering order. More... | |
(NvsTimelineCaption *) | - getFirstCaption |
Get the first caption on the timeline. More... | |
(NvsTimelineCaption *) | - getLastCaption |
Get the last caption on the timeline. More... | |
(NvsTimelineCaption *) | - getPrevCaption: |
Get the previous caption of the current caption on the timeline. More... | |
(NvsTimelineCaption *) | - getNextCaption: |
Get the next caption of the current caption on the timeline. More... | |
(NSArray *) | - getCaptionsByTimelinePosition: |
Get a list of captions based on the position on the timeline. More... | |
(NvsTimelineCaption *) | - addCaption:inPoint:duration:captionStylePackageId: |
Add a caption on the timeline. More... | |
(NvsTimelineCaption *) | - addPanoramicCaption:inPoint:duration:captionStylePackageId: |
Add a panorama caption on the timeline. More... | |
(NvsTimelineCaption *) | - addModularCaption:inPoint:duration: |
Add a modular caption on the timeline. More... | |
(NvsTimelineCaption *) | - removeCaption: |
Remove the caption on the timeline. More... | |
(NvsTimelineCompoundCaption *) | - getFirstCompoundCaption |
Get the first compound caption on the timeline. More... | |
(NvsTimelineCompoundCaption *) | - getLastCompoundCaption |
Get the last compound caption on the timeline. More... | |
(NvsTimelineCompoundCaption *) | - getPrevCompoundCaption: |
Get the previous compound caption of the current compound caption on the timeline. More... | |
(NvsTimelineCompoundCaption *) | - getNextCompoundCaption: |
Get the next compound caption of the current compound caption on the timeline. More... | |
(NSArray< NvsTimelineCompoundCaption * > *) | - getCompoundCaptionsByTimelinePosition: |
Get a list of compound captions based on the position on the timeline. More... | |
(NvsTimelineCompoundCaption *) | - addCompoundCaption:duration:compoundCaptionPackageId: |
Add a caption on the timeline. More... | |
(NvsTimelineCompoundCaption *) | - addPanoramicCompoundCaption:duration:compoundCaptionPackageId: |
Add a VR caption on the timeline. More... | |
(NvsTimelineCompoundCaption *) | - removeCompoundCaption: |
Remove compound caption from 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: |
Get the previous animated sticker of the current animated sticker of the timeline. More... | |
(NvsTimelineAnimatedSticker *) | - getNextAnimatedSticker: |
Get the next animated sticker of the current animated sticker of the timeline. More... | |
(NSArray *) | - getAnimatedStickersByTimelinePosition: |
Get an animated sticker list based on the position on the timeline. More... | |
(NvsTimelineAnimatedSticker *) | - addAnimatedSticker:duration:animatedStickerPackageId: |
Add a animated sticker on the timeline. More... | |
(NvsTimelineAnimatedSticker *) | - addPanoramicAnimatedSticker:duration:animatedStickerPackageId: |
Add a panorama animation sticker on the timeline. More... | |
(NvsTimelineAnimatedSticker *) | - addCustomAnimatedSticker:duration:animatedStickerPackageId:customImagePath: |
Add a custom animated sticker on the timeline. More... | |
(NvsTimelineAnimatedSticker *) | - addCustomPanoramicAnimatedSticker:duration:animatedStickerPackageId:customImagePath: |
Add a a custom panorama animated sticker on the timeline. More... | |
(NvsTimelineAnimatedSticker *) | - removeAnimatedSticker: |
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: |
Get the previous timeline video effect of a timeline video effect on the timeline. More... | |
(NvsTimelineVideoFx *) | - getNextTimelineVideoFx: |
Get the next timeline video effect of a timeline video effect on the timeline. More... | |
(NSArray *) | - getTimelineVideoFxByTimelinePosition: |
Get a list of timeline video effects based on position on the timeline. More... | |
(NvsTimelineVideoFx *) | - addBuiltinTimelineVideoFx:duration:videoFxName: |
Add a built-in timeline video effect on the timeline. More... | |
(NvsTimelineVideoFx *) | - addPackagedTimelineVideoFx:duration:videoFxPackageId: |
Add a timeline video effect in the form of a resource package on the timeline. More... | |
(NvsTimelineVideoFx *) | - addCustomTimelineVideoFx:duration:customVideoFxRender: |
Add a custom timeline video effect on the timeline. More... | |
(NvsTimelineVideoFx *) | - removeTimelineVideoFx: |
Remove a timeline video effect from the timeline. More... | |
(NSString *) | - getCurrentThemeId |
Get the id of the current theme. More... | |
(BOOL) | - applyTheme: |
Apply a theme to the current timeline (the theme is relative to the entire timeline). More... | |
(void) | - removeCurrentTheme |
Remove current theme. More... | |
(void) | - setThemeTitleCaptionText: |
Set the caption text for theme title. More... | |
(void) | - setThemeTrailerCaptionText: |
Set the caption text for theme trailer. More... | |
(void) | - setThemeMusicVolumeGain:rightVolumeGain: |
Set the volume value for theme music. More... | |
(void) | - getThemeMusicVolumeGain:rightVolumeGain: |
Get the volume value for theme music. More... | |
(bool) | - addWatermark:displayWidth:displayHeight:opacity:position:marginX:marginY: |
Add watermark. More... | |
(void) | - deleteWatermark |
Delete watermark which has added. More... | |
(bool) | - setWatermarkOpacity: |
Set watermark opacity. More... | |
(bool) | - setTimelineEndingLogo:displayWidth:displayHeight:centerX:centerY: |
Set the logo effect at the end of the timeline.The duration is one second. More... | |
(void) | - removeTimelineEndingLogo |
Remove the logo effect at the end of the timeline. More... | |
(void) | - setPlaybackRateControl: |
(NSArray *) | - getPlaybackRateControl |
(BOOL) | - moveVideoTrackIndex:dstTrackIndex: |
Move video track.After moving, all video tracks will reset their index from 0. More... | |
(NvsTimelineGraphCompositor *) | - getFirstTimelineGraphCompositor |
Get the first timeline GraphCompositor on the timeline. More... | |
(NvsTimelineGraphCompositor *) | - getLastTimelineGraphCompositor |
Get the last timeline GraphCompositor on the timeline. More... | |
(NvsTimelineGraphCompositor *) | - getPrevTimelineGraphCompositor: |
Get the previous timeline GraphCompositor of a timeline GraphCompositor on the timeline. More... | |
(NvsTimelineGraphCompositor *) | - getNextTimelineGraphCompositor: |
Get the next timeline GraphCompositor of a timeline GraphCompositor on the timeline. More... | |
(NvsTimelineGraphCompositor *) | - getTimelineGraphCompositorByTimelinePosition: |
Get a timeline GraphCompositor based on position on the timeline. More... | |
(NvsTimelineGraphCompositor *) | - addTimelineGraphCompositor:duration:graphDescStr: |
Add a timeline GraphCompositor on the timeline. More... | |
(NvsTimelineGraphCompositor *) | - addTimelineGraphCompositor:duration:graphDescStr:buddyTrackIndex: |
Add a timeline GraphCompositor on the timeline, deprecated from 3.12.0. More... | |
(NvsTimelineGraphCompositor *) | - removeTimelineGraphCompositor: |
Remove a timeline GraphCompositor from the timeline. More... | |
(unsigned int) | - creationFlags |
Get count of video track. More... | |
(bool) | - applyThemeTemplate: |
(NSArray< NvsCaptionBoundingVerticesInfo * > *) | - getCaptionsBoundingVerticesRecursively:timelinePosition: |
(NSArray< NvsClipBoundingVerticesInfo * > *) | - getVideoClipBoundingVerticesRecursively: |
Instance Methods inherited from NvsObject | |
(void) | - setAttachment:forKey: |
Adds an attachment to the NvsObject object to identify the object of the NvsObject or for other purposes. More... | |
(void) | - setTemplateAttachment:forKey: |
Adds additional template data to the NvsObject object to identify the NvsObject template object. More... | |
(NSObject *) | - getAttachment: |
Gets attached attachments. More... | |
(NSString *) | - getTemplateAttachment: |
Gets an template attachment to NvsObject. More... | |
Properties | |
NvsVideoResolution | videoRes |
Video resolution (width:height ratio of video image). More... | |
NvsAudioResolution | audioRes |
Audio resolution (sampling rate, format and channel count) More... | |
NvsRational | videoFps |
Video frame rate. More... | |
int64_t | duration |
Timeline duration(in micro-second). More... | |
int64_t | audioFadeOutDuration |
Audio fade out duration(in micro-second). More... | |
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.
- (NvsTimelineAnimatedSticker *) addAnimatedSticker: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
animatedStickerPackageId: | (NSString *) | animatedStickerPackageId | |
Add a animated sticker on the timeline.
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 |
- (NvsTimelineVideoFx *) addBuiltinTimelineVideoFx: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
videoFxName: | (NSString *) | videoFxName | |
Add a built-in timeline video effect on the timeline.
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 |
- (NvsTimelineCaption *) addCaption: | (NSString *) | captionText | |
inPoint: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
captionStylePackageId: | (NSString *) | captionStylePackageId | |
Add a caption on the timeline.
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.If it does not exist, you can pass an empty string or nil. |
- (NvsTimelineCompoundCaption *) addCompoundCaption: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
compoundCaptionPackageId: | (NSString *) | compoundCaptionPackageId | |
Add a caption on the timeline.
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.If it does not exist, you can pass an empty string or nil. |
- (NvsTimelineAnimatedSticker *) addCustomAnimatedSticker: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
animatedStickerPackageId: | (NSString *) | animatedStickerPackageId | |
customImagePath: | (NSString *) | customImagePath | |
Add a custom animated sticker on the timeline.
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(It can be a jpg, png image, or a dynamic caf format image supported by Meishe sdk) |
- (NvsTimelineAnimatedSticker *) addCustomPanoramicAnimatedSticker: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
animatedStickerPackageId: | (NSString *) | animatedStickerPackageId | |
customImagePath: | (NSString *) | customImagePath | |
Add a a custom panorama animated sticker on the timeline.
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(It can be a jpg, png image, or a dynamic caf format image supported by Meishe sdk) |
- (NvsTimelineVideoFx *) addCustomTimelineVideoFx: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
customVideoFxRender: | (id< NvsCustomVideoFxRenderer >) | customVideoFxRender | |
Add a custom timeline video effect on the timeline.
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 |
- (NvsTimelineCaption *) addModularCaption: | (NSString *) | captionText | |
inPoint: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
Add a modular caption on the timeline.
captionText | Text of caption |
inPoint | The in point of the caption on the timeline (in microseconds) |
duration | Caption display duration (in microseconds) |
- (NvsTimelineVideoFx *) addPackagedTimelineVideoFx: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
videoFxPackageId: | (NSString *) | videoFxPackageId | |
Add a timeline video effect in the form of a resource package on the timeline.
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 |
- (NvsTimelineAnimatedSticker *) addPanoramicAnimatedSticker: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
animatedStickerPackageId: | (NSString *) | animatedStickerPackageId | |
Add a panorama animation sticker on the timeline.
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 |
- (NvsTimelineCaption *) addPanoramicCaption: | (NSString *) | captionText | |
inPoint: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
captionStylePackageId: | (NSString *) | captionStylePackageId | |
Add a panorama caption on the timeline.
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.If it does not exist, you can pass an empty string or nil. |
- (NvsTimelineCompoundCaption *) addPanoramicCompoundCaption: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
compoundCaptionPackageId: | (NSString *) | compoundCaptionPackageId | |
Add a VR caption on the timeline.
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.If it does not exist, you can pass an empty string or null. |
- (NvsTimelineGraphCompositor *) addTimelineGraphCompositor: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
graphDescStr: | (NSString *) | graphDescStr | |
Add a timeline GraphCompositor on the timeline.
inPoint | The in point of the timeline GraphCompositor on the timeline (in microseconds) |
duration | Duration of the timeline GraphCompositor which displayed (in microseconds) |
graphDescStr | The string parameter value of the effect |
- (NvsTimelineGraphCompositor *) addTimelineGraphCompositor: | (int64_t) | inPoint | |
duration: | (int64_t) | duration | |
graphDescStr: | (NSString *) | graphDescStr | |
buddyTrackIndex: | (int) | buddyTrackIndex | |
Add a timeline GraphCompositor on the timeline, deprecated from 3.12.0.
inPoint | The in point of the timeline GraphCompositor on the timeline (in microseconds) |
duration | Duration of the timeline GraphCompositor which displayed (in microseconds) |
graphDescStr | The string parameter value of the effect |
buddyTrackIndex | The buddy frame track index |
- (bool) addWatermark: | (NSString *) | watermarkFilePath | |
displayWidth: | (int) | displayWidth | |
displayHeight: | (int) | displayHeight | |
opacity: | (float) | opacity | |
position: | (int) | position | |
marginX: | (int) | marginX | |
marginY: | (int) | marginY | |
Add watermark.
watermarkFilePath | The path of the watermark file must be a .PNG or .JPG or .CAF 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 |
- (NvsAudioTrack *) appendAudioTrack |
Appends audio track.
- (NvsVideoTrack *) appendVideoTrack |
Appends video track.
- (BOOL) applyTheme: | (NSString *) | themeId |
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.
themeId | Id of theme package(if themeId if empty string or nil, will remove current theme) |
- (bool) applyThemeTemplate: | (NSString *) | templateId |
- (unsigned int) audioTrackCount |
Get count of audio track.
- (BOOL) changeVideoBitDepth: | (NvsVideoResolutionBitDepth) | newBitDepth |
Change the timeline video bit depth.
newBitDepth | New video bit depth |
- (BOOL) changeVideoSize: | (int) | videoWidth | |
videoHeight: | (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.
videoWidth | New video width(the imported image's width has to be a multiple of 4) |
videoHeight | New video height(the imported image's height has to be a multiple of 2) |
- (unsigned int) creationFlags |
Get count of video track.
- (void) deleteWatermark |
Delete watermark which has added.
- (void) enableRenderOrderByZValue: | (BOOL) | enable |
Turn on use the Z value as the render order. Note: there are timeline caption, compound caption, module captions, animation stickers and timeline filters If the Z value in the same type is the same, it is the same as the sorting method in which the property is not enabled If the Z values of different types are the same, the order is: timeline Filter > Animation sticker > timeline caption (including module caption) > compound caption.
enable | Enable or not |
- (NSArray *) getAnimatedStickersByTimelinePosition: | (int64_t) | timelinePos |
Get an animated sticker list based on the position on the timeline.
timelinePos | Position on the timeline (in microseconds) |
- (NvsAudioTrack *) getAudioTrackByIndex: | (unsigned int) | trackIndex |
Gets audio track with track index.
trackIndex | Index of audio track |
- (NSArray<NvsCaptionBoundingVerticesInfo*>*) getCaptionsBoundingVerticesRecursively: | (NvsBoundingType) | boundingType | |
timelinePosition: | (int64_t) | timelinePosition | |
- (NSArray *) getCaptionsByTimelinePosition: | (int64_t) | timelinePos |
Get a list of captions based on the position on the timeline.
timelinePos | The position on the timeline(in micro-second) |
- (NSArray<NvsTimelineCompoundCaption*> *) getCompoundCaptionsByTimelinePosition: | (int64_t) | timelinePos |
Get a list of compound captions based on the position on the timeline.
timelinePos | The position on the timeline(in micro-second) |
- (int) getCreationFlags |
Get the flag for creating timeline. NvsCreateTimelineTypeFlag.
- (NSString *) getCurrentThemeId |
Get the id of the current theme.
- (NvsTimelineAnimatedSticker *) getFirstAnimatedSticker |
Get the first animated sticker on the timeline.
- (NvsTimelineCaption *) getFirstCaption |
Get the first caption on the timeline.
- (NvsTimelineCompoundCaption *) getFirstCompoundCaption |
Get the first compound caption on the timeline.
- (NvsTimelineGraphCompositor *) getFirstTimelineGraphCompositor |
Get the first timeline GraphCompositor on the timeline.
- (NvsTimelineVideoFx *) getFirstTimelineVideoFx |
Get the first timeline video effect on the timeline.
- (NvsTimelineAnimatedSticker *) getLastAnimatedSticker |
Get the last animated sticker on the timeline.
- (NvsTimelineCaption *) getLastCaption |
Get the last caption on the timeline.
- (NvsTimelineCompoundCaption *) getLastCompoundCaption |
Get the last compound caption on the timeline.
- (NvsTimelineGraphCompositor *) getLastTimelineGraphCompositor |
Get the last timeline GraphCompositor on the timeline.
- (NvsTimelineVideoFx *) getLastTimelineVideoFx |
Get the last timeline video effect on the timeline.
- (NvsTimelineAnimatedSticker *) getNextAnimatedSticker: | (NvsTimelineAnimatedSticker *) | animatedSticker |
Get the next animated sticker of the current animated sticker of the timeline.
animatedSticker | the current NvsTimelineAnimatedSticker obejct |
- (NvsTimelineCaption *) getNextCaption: | (NvsTimelineCaption *) | caption |
Get the next caption of the current caption on the timeline.
caption | The current caption on the timeline |
- (NvsTimelineCompoundCaption *) getNextCompoundCaption: | (NvsTimelineCompoundCaption *) | caption |
Get the next compound caption of the current compound caption on the timeline.
caption | The current compound caption on the timeline |
- (NvsTimelineGraphCompositor *) getNextTimelineGraphCompositor: | (NvsTimelineGraphCompositor *) | graphCompositor |
Get the next timeline GraphCompositor of a timeline GraphCompositor on the timeline.
graphCompositor | The NvsTimelineGraphCompositor object |
- (NvsTimelineVideoFx *) getNextTimelineVideoFx: | (NvsTimelineVideoFx *) | videoFx |
Get the next timeline video effect of a timeline video effect on the timeline.
videoFx | The NvsTimelineVideoFx object |
- (NSArray *) getPlaybackRateControl |
- (NvsTimelineAnimatedSticker *) getPrevAnimatedSticker: | (NvsTimelineAnimatedSticker *) | animatedSticker |
Get the previous animated sticker of the current animated sticker of the timeline.
animatedSticker | the current NvsTimelineAnimatedSticker obejct |
- (NvsTimelineCaption *) getPrevCaption: | (NvsTimelineCaption *) | caption |
Get the previous caption of the current caption on the timeline.
caption | The current caption on the timeline |
- (NvsTimelineCompoundCaption *) getPrevCompoundCaption: | (NvsTimelineCompoundCaption *) | caption |
Get the previous compound caption of the current compound caption on the timeline.
caption | The current compound caption on the timeline |
- (NvsTimelineGraphCompositor *) getPrevTimelineGraphCompositor: | (NvsTimelineGraphCompositor *) | graphCompositor |
Get the previous timeline GraphCompositor of a timeline GraphCompositor on the timeline.
graphCompositor | The NvsTimelineGraphCompositor object |
- (NvsTimelineVideoFx *) getPrevTimelineVideoFx: | (NvsTimelineVideoFx *) | videoFx |
Get the previous timeline video effect of a timeline video effect on the timeline.
videoFx | The NvsTimelineVideoFx object |
- (void) getThemeMusicVolumeGain: | (float *) | leftVolumeGain | |
rightVolumeGain: | (float *) | rightVolumeGain | |
Get the volume value for theme music.
leftVolumeGain | Output the value of left channel |
rightVolumeGain | Output the value of right channel |
- (NvsTimelineGraphCompositor *) getTimelineGraphCompositorByTimelinePosition: | (int64_t) | timelinePos |
Get a timeline GraphCompositor based on position on the timeline.
timelinePos | The position on the timeline (in microseconds) |
- (NSArray *) getTimelineVideoFxByTimelinePosition: | (int64_t) | timelinePos |
Get a list of timeline video effects based on position on the timeline.
timelinePos | The position on the timeline (in microseconds) |
- (NSArray<NvsClipBoundingVerticesInfo*>*) getVideoClipBoundingVerticesRecursively: | (int64_t) | timelinePosition |
- (NvsVideoTrack *) getVideoTrackByIndex: | (unsigned int) | trackIndex |
Gets video track with track index.
trackIndex | Index of video track |
- (NvsAudioTrack *) insertAudioTrack: | (unsigned int) | clipIndex |
Appends audio track.
trackIndex | Index of the inserted track.If you pass in an index less than 0 or more than current audio track count, it will be inserted at the end of the current audio track number. |
- (NvsVideoTrack *) insertVideoTrack: | (unsigned int) | clipIndex |
insert video track.
trackIndex | Index of the inserted track.If you pass in an index less than 0 or more than current video track count, it will be inserted at the end of the current video track number. |
- (BOOL) isRenderOrderByZValueEnabled |
Whether to turn on use Z value as the rendering order.
- (BOOL) moveVideoTrackIndex: | (unsigned int) | srcTrackIndex | |
dstTrackIndex: | (unsigned int) | dstTrackIndex | |
Move video track.After moving, all video tracks will reset their index from 0.
srcTrackIndex | Index of source video track |
dstTrackIndex | Index of destination video track |
- (NvsTimelineAnimatedSticker *) removeAnimatedSticker: | (NvsTimelineAnimatedSticker *) | animatedSticker |
Remove an animated sticker on the timeline.
animatedSticker | The NvsTimelineAnimatedSticker object which will be removed |
- (BOOL) removeAudioTrack: | (unsigned int) | trackIndex |
Remove audio track.
trackIndex | Index of audio track |
- (NvsTimelineCaption *) removeCaption: | (NvsTimelineCaption *) | caption |
Remove the caption on the timeline.
caption | timeline caption object which removed |
- (NvsTimelineCompoundCaption *) removeCompoundCaption: | (NvsTimelineCompoundCaption *) | caption |
Remove compound caption from the timeline.
caption | timeline compound caption object which to be removed |
- (void) removeCurrentTheme |
Remove current theme.
- (void) removeTimelineEndingLogo |
Remove the logo effect at the end of the timeline.
- (NvsTimelineGraphCompositor *) removeTimelineGraphCompositor: | (NvsTimelineGraphCompositor *) | graphCompositor |
Remove a timeline GraphCompositor from the timeline.
graphCompositor | The NvsTimelineGraphCompositor object which will be removed |
- (NvsTimelineVideoFx *) removeTimelineVideoFx: | (NvsTimelineVideoFx *) | videoFx |
Remove a timeline video effect from the timeline.
videoFx | The NvsTimelineVideoFx object which will be removed |
- (BOOL) removeVideoTrack: | (unsigned int) | trackIndex |
Remove video track.
trackIndex | Index of video track |
- (void) setCaptionBoundingRectInActualMode: | (BOOL) | isActualBoundingRect |
Set the border of the caption to the actual envelope size of the text.
isActualBoundingRect | Whether to display the actual envelope size |
- (void) setPlaybackRateControl: | (NSArray *) | arrayPlaybackRateControlRegion |
- (void) setThemeMusicVolumeGain: | (float) | leftVolumeGain | |
rightVolumeGain: | (float) | rightVolumeGain | |
Set the volume value for theme music.
leftVolumeGain | Left channel, value range [0, 8). The suggestion is [0, 3], if it exceeds 3, the sound may break. |
rightVolumeGain | Right channel, value range [0, 8). The suggestion is [0, 3], if it exceeds 3, the sound may break. |
- (void) setThemeTitleCaptionText: | (NSString *) | text |
Set the caption text for theme title.
text | The caption text |
- (void) setThemeTrailerCaptionText: | (NSString *) | text |
Set the caption text for theme trailer.
text | 字幕文本 |
- (bool) setTimelineEndingLogo: | (NSString *) | logoFilePath | |
displayWidth: | (unsigned int) | displayWidth | |
displayHeight: | (unsigned int) | displayHeight | |
centerX: | (int) | centerX | |
centerY: | (int) | centerY | |
Set the logo effect at the end of the timeline.The duration is one second.
logoFilePath | The path of the logo file must be a .PNG or .JPG or .CAF 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方向的位置 |
- (bool) setWatermarkOpacity: | (float) | opacity |
Set watermark opacity.
opacity | The opacity, the range is [0,1] |
- (unsigned int) videoTrackCount |
Get count of video track.
|
readwritenonatomicassign |
Audio fade out duration(in micro-second).
|
readatomicassign |
Audio resolution (sampling rate, format and channel count)
|
readatomicassign |
Timeline duration(in micro-second).
|
readatomicassign |
Video frame rate.
|
readatomicassign |
Video resolution (width:height ratio of video image).