美摄SDK For iOS  3.7.2
构造函数 | 属性 | 所有成员列表
NvsVideoClip类 参考

视频片段，对视频文件的描述 更多...

#import <NvsVideoClip.h>

类 NvsVideoClip 继承关系图:
NvsClip NvsObject

构造函数

(void) - setPlayInReverse:
 设置片段是否倒放 更多...
 
(BOOL) - getPlayInReverse
 获取片段是否倒放 更多...
 
(void) - setExtraVideoRotation:
 设置视频额外旋转角度 更多...
 
(void) - setExtraVideoRotation:rotateROI:
 设置视频额外旋转角度 更多...
 
(NvsExtraVideoRotation) - getExtraVideoRotation
 获取视频额外旋转角度 更多...
 
(void) - setPan:andScan:
 设置摇摄和扫描 更多...
 
(void) - getPan:andScan:
 获取摇摄和扫描 更多...
 
(void) - enableVideoClipROI:
 设置视频是否启用ROI的模式,默认使用的是摇摄和扫描模式 更多...
 
(BOOL) - isVideoClipROIEnabled
 获取视频是否启用ROI的模式 更多...
 
(void) - setSourceBackgroundMode:
 设置背景模式 更多...
 
(NvsSourceBackgroundMode) - getSourceBackgroundMode
 获取背景模式 更多...
 
(void) - setSourceBackgroundColor:
 设置片段背景颜色 更多...
 
(NvsColor) - getSourceBackgroundColor
 获取背景颜色 更多...
 
(void) - disableAmbiguousCrop:
 设置是否禁止画面的近似比例裁剪，默认为false。 更多...
 
(BOOL) - isAmbiguousCropDisabled
 获取是否禁止画面的近似比例裁剪 更多...
 
(void) - setImageMotionROI:endROI:
 设置图片片段动态移动ROI 更多...
 
(void) - setClipWrapMode:
 设置片段循环模式 更多...
 
(NvsClipWrapMode) - getClipWrapMode
 获取视频循环模式 更多...
 
(void) - setAudioFadeInDuration:
 设置音频淡入的时长 更多...
 
(int64_t) - getAudioFadeInDuration
 获取音频的淡入时长 更多...
 
(void) - setAudioFadeOutDuration:
 设置音频淡出的时长 更多...
 
(int64_t) - getAudioFadeOutDuration
 获取音频的淡出时长 更多...
 
(void) - changeVariableSpeed:endSpeed:keepAudioPitch:
 改变片段的播放速度 更多...
 
(double) - getStartSpeed
 默认值为1，表示按正常速度播放;小于1的值表示慢放;大于1的值表示快放 更多...
 
(double) - getEndSpeed
 默认值为1，表示按正常速度播放;小于1的值表示慢放;大于1的值表示快放 更多...
 
(void) - setBlendingMode:
 设置合成模式 更多...
 
(NvsClipBlendingMode) - getBlendingMode
 获取合成模式 更多...
 
(void) - setOpacity:
 设置透明度 更多...
 
(float) - getOpacity
 获取透明度 更多...
 
(void) - setEnableOriginalRender:
 开启按照视频片段的原始比例进行特效渲染 更多...
 
(BOOL) - isOriginalRender
 获取是否开启了原始比例渲染的模式 更多...
 
(void) - enableClipFreezeFrame:
 设置片段静帧效果开启状态 更多...
 
(BOOL) - isClipFreezeFrameEnabled
 获取静帧效果是否开启 更多...
 
(void) - setClipFreezeFrameTrimPosition:
 设置片段静帧效果位置 更多...
 
(long) - getClipFreezeFrameTrimPosition
 获取静帧位置（单位微秒） 更多...
 
(void) - enableRawSourceMode:
 开启原始画幅模式 当这个模式开启后， SetPanAndScan, GetPanAndScan, DisableAmbiguousCrop, IsAmbiguousCropDisabled, SetImageMotionMode, ImageMotionMode SetImageMotionROI, GetImageMotionROI, SetImageMotionAnimationEnabled, IsImageMotionAnimationEnabled, SetImageMaskROI, GetImageMaskROI,都已经无效。 如果开启了属性特技，在属性特技中的对应的参数是没有效果的 更多...
 
(BOOL) - isRawSourceModeEnabled
 获取原始画幅模式状态 更多...
 
(NvsAudioFx *) - appendAudioFx:
 在片段尾部追加音频特效 更多...
 
(NvsAudioFx *) - insertAudioFx:fxIndex:
 在片段上指定特效索引处插入音频特效 更多...
 
(NvsAudioFx *) - appendCustomAudioFx:
 在音频片段上追加自定义音频特效 更多...
 
(NvsAudioFx *) - insertCustomAudioFx:fxIndex:
 在片段上指定特效索引处插入自定义音频特效 更多...
 
(BOOL) - removeAudioFx:
 移除指定索引的音频特效，后面的特效索引前移。 更多...
 
(NvsAudioFx *) - getAudioFxWithIndex:
 通过索引获取音频特效 更多...
 
(NvsVideoFx *) - appendBuiltinFx:
 在片段上追加内嵌式特效 更多...
 
(NvsVideoFx *) - insertBuiltinFx:fxIndex:
 在片段上指定特效索引处插入内嵌式特效 更多...
 
(NvsVideoFx *) - appendPackagedFx:
 在片段上追加资源包特效 更多...
 
(NvsVideoFx *) - insertPackagedFx:fxIndex:
 在片段上指定特效索引处插入包裹特效 更多...
 
(NvsVideoFx *) - appendCustomFx:
 在片段上追加自定义视频特效 更多...
 
(NvsVideoFx *) - insertCustomFx:fxIndex:
 在片段上指定特效索引处插入自定义视频特效 更多...
 
(NvsVideoFx *) - appendRawBuiltinFx:
 在片段上追加作用在原始输入上的内嵌式特效 更多...
 
(NvsVideoFx *) - insertRawBuiltinFx:fxIndex:
 在片段上指定特效索引处插入作用在原始输入上的内嵌式特效 更多...
 
(NvsVideoFx *) - appendRawPackagedFx:
 在片段上追加作用在原始输入上的资源包特效 更多...
 
(NvsVideoFx *) - insertRawPackagedFx:fxIndex:
 在片段上指定特效索引处插入作用在原始输入上的资源包特效 更多...
 
(NvsVideoFx *) - appendRawCustomFx:
 在片段上追加作用在原始输入上的自定义视频特效 更多...
 
(NvsVideoFx *) - insertRawCustomFx:fxIndex:
 在片段上指定特效索引处插入作用在原始输入上的自定义视频特效 更多...
 
(NvsVideoFx *) - appendBeautyFx
 在片段上追加美颜特效 更多...
 
(NvsVideoFx *) - insertBeautyFx:
 在片段上指定特效索引处插入美颜特效 更多...
 
(NvsVideoFx *) - appendBuiltinFx:inPoint:duration:
 在片段上追加内嵌式特效 更多...
 
(NvsVideoFx *) - insertBuiltinFx:fxIndex:inPoint:duration:
 在片段上指定特效索引处插入内嵌式特效 更多...
 
(NvsVideoFx *) - appendPackagedFx:inPoint:duration:
 在片段上追加资源包特效 更多...
 
(NvsVideoFx *) - insertPackagedFx:fxIndex:inPoint:duration:
 在片段上指定特效索引处插入包裹特效 更多...
 
(NvsVideoFx *) - appendCustomFx:inPoint:duration:
 在片段上追加自定义视频特效 更多...
 
(NvsVideoFx *) - insertCustomFx:fxIndex:inPoint:duration:
 在片段上指定特效索引处插入自定义视频特效 更多...
 
(NvsVideoFx *) - appendRawBuiltinFx:inPoint:duration:
 在片段上追加作用在原始输入上的内嵌式特效 更多...
 
(NvsVideoFx *) - insertRawBuiltinFx:fxIndex:inPoint:duration:
 在片段上指定特效索引处插入作用在原始输入上的内嵌式特效 更多...
 
(NvsVideoFx *) - appendRawPackagedFx:inPoint:duration:
 在片段上追加作用在原始输入上的资源包特效 更多...
 
(NvsVideoFx *) - insertRawPackagedFx:fxIndex:inPoint:duration:
 在片段上指定特效索引处插入作用在原始输入上的资源包特效 更多...
 
(NvsVideoFx *) - appendRawCustomFx:inPoint:duration:
 在片段上追加作用在原始输入上的自定义视频特效 更多...
 
(NvsVideoFx *) - insertRawCustomFx:fxIndex:inPoint:duration:
 在片段上指定特效索引处插入作用在原始输入上的自定义视频特效 更多...
 
(NvsVideoFx *) - appendBeautyFx:duration:
 在片段上追加美颜特效 更多...
 
(NvsVideoFx *) - insertBeautyFx:inPoint:duration:
 在片段上指定特效索引处插入美颜特效 更多...
 
(BOOL) - removeFx:
 移除特效 更多...
 
(BOOL) - removeRawFx:
 移除作用在原始输入上的特效 更多...
 
(BOOL) - removeAllAudioFx
 移除所有音频特效 更多...
 
(BOOL) - removeAllVideoFx
 移除所有视频特效 更多...
 
(BOOL) - removeAllFx
 移除所有特效 更多...
 
(NvsVideoFx *) - getFxWithIndex:
 通过索引获取特效 更多...
 
(unsigned int) - getRawFxCount
 获取片段上作用在原始输入上的特效数量。注：片段上的特效索引是从0开始 更多...
 
(NvsVideoFx *) - getRawFxByIndex:
 通过索引获取作用在原始输入上的特效 更多...
 
(NvsVariantImageFillMode) - getRefImageFillMode
 获取有参考尺寸下的填充模式 更多...
 
(void) - setRefImageFillMode:
 设置有参考尺寸下的填充模式 更多...
 
(NvsSourceBackgroundMode) - getRefImageBackgroundMode
 获取小图模式下背景填充模式 更多...
 
(void) - setRefImageBackgroundMode:
 设置小图模式下背景模式 (VARIANT_IMAGE_BACKGROUNDMODE) 更多...
 
(NvsColor) - getRefImageBackgroundColor
 获取小图模式下背景颜色 更多...
 
(void) - setRefImageBackgroundColor:
 设置小图模式下片段背景颜色 更多...
 
(float) - getRefImageBackgroundBlurRadius
 获取小图模式下背景填充模糊程度 更多...
 
(void) - setRefImageBackgroundBlurRadius:
 设置小图模式下背景模糊程度 更多...
 
(BOOL) - getRefImageBackgroundBlurNewModeEnable
 获取小图模式下背景填充模糊新模式状态 更多...
 
(void) - setRefImageBackgroundBlurNewModeEnable:
 设置小图模式下背景模糊新模式 更多...
 
(void) - updateAudioForClipVideoFx
 更新当前片段特效中携带的音频信息。 更多...
 
(NvsVideoFx *) - getPropertyVideoFx
 获取当前视频片段属性特效 更多...
 
(NvsVideoFx *) - setCustomPropertyVideoFx:
 设置当前视频片段自定义属性特效 更多...
 
(void) - enablePropertyVideoFx:
 设置属性特效是否有效 更多...
 
(NvsClipCaption *) - getFirstCaption
 获取片段上的第一个字幕,相对于每个片段上的字幕 更多...
 
(NvsClipCaption *) - getLastCaption
 获取片段上的最后一个字幕,相对于每个片段上的字幕 更多...
 
(NvsClipCaption *) - getPrevCaption:
 获取片段上的当前字幕的前一个字幕，相对于每个片段上的字幕 更多...
 
(NvsClipCaption *) - getNextCaption:
 获取片段上的当前字幕的前一个字幕，相对于每个片段上的字幕 更多...
 
(NSArray *) - getCaptionsByClipTimePosition:
 根据片段上的位置获得字幕列表，相对于单一的片段 更多...
 
(NvsClipCaption *) - addCaption:inPoint:duration:captionStylePackageId:
 在片段上添加字幕,相对于单一的片段 更多...
 
(NvsClipCaption *) - addPanoramicCaption:inPoint:duration:captionStylePackageId:
 在片段上添加全景图字幕 更多...
 
(NvsClipCaption *) - addModularCaption:inPoint:duration:
 在片段上添加模块字幕 更多...
 
(NvsClipCaption *) - removeCaption:
 移除片段上的字幕 更多...
 
(NvsClipCompoundCaption *) - getFirstCompoundCaption
 获取片段上的第一个复合字幕 更多...
 
(NvsClipCompoundCaption *) - getLastCompoundCaption
 获取片段上的最后一个复合字幕，相对于单个的片段上的字幕 更多...
 
(NvsClipCompoundCaption *) - getPrevCompoundCaption:
 获取片段上的当前复合字幕的前一个复合字幕，相对于单个片段上的字幕 更多...
 
(NvsClipCompoundCaption *) - getNextCompoundCaption:
 获取片段上的当前复合字幕的前一个复合字幕，相对于单个片段上的字幕 更多...
 
(NSArray< NvsClipCompoundCaption * > *) - getCompoundCaptionsByClipTimePosition:
 根据片段上的位置获得复合字幕列表，相对于单个片段上的字幕 更多...
 
(NvsClipCompoundCaption *) - addCompoundCaption:duration:compoundCaptionPackageId:
 在片段上添加字幕 更多...
 
(NvsClipCompoundCaption *) - removeCompoundCaption:
 移除片段上的复合字幕，相对于单个片段 更多...
 
(NvsClipAnimatedSticker *) - getFirstAnimatedSticker
 获取片段上第一个动画贴纸，相对于单个片段上的动画 更多...
 
(NvsClipAnimatedSticker *) - getLastAnimatedSticker
 获取片段上最后一个动画贴纸，相对于单个片段上的动画贴纸 更多...
 
(NvsClipAnimatedSticker *) - getPrevAnimatedSticker:
 获取片段当前动画贴纸的前一个动画贴纸，相对于单个片段上的动画贴纸 更多...
 
(NvsClipAnimatedSticker *) - getNextAnimatedSticker:
 获取片段当前动画贴纸的后一个动画贴纸。相对于单个片段上的动画贴纸 更多...
 
(NSArray *) - getAnimatedStickersByClipTimePosition:
 根据片段上的位置获得动画贴纸列表，相对于单个片段 更多...
 
(NvsClipAnimatedSticker *) - addAnimatedSticker:duration:animatedStickerPackageId:
 在片段上添加动画贴纸 更多...
 
(NvsClipAnimatedSticker *) - addPanoramicAnimatedSticker:duration:animatedStickerPackageId:
 在片段上添加全景图动画贴纸 更多...
 
(NvsClipAnimatedSticker *) - addCustomAnimatedSticker:duration:animatedStickerPackageId:customImagePath:
 在片段上添加自定义动画贴纸 更多...
 
(NvsClipAnimatedSticker *) - addCustomPanoramicAnimatedSticker:duration:animatedStickerPackageId:customImagePath:
 在片段上添加自定义全景图动画贴纸 更多...
 
(NvsClipAnimatedSticker *) - removeAnimatedSticker:
 移除片段上的动画贴纸 更多...
 
(BOOL) - isPropertyVideoFxEnabled
 获取是否开启了原始比例渲染的模式 更多...
 
- 构造函数 继承自 NvsClip
(NvsTimeline *) - getInternalTimeline
 获取片段的时间线对象 更多...
 
(BOOL) - changeFilePath:
 更改片段文件路径 更多...
 
(int64_t) - changeTrimInPoint:affectSibling:
 修改片段裁剪入点 更多...
 
(BOOL) - moveTrimPoint:
 移动片段的裁剪入出点（微秒） 更多...
 
(int64_t) - changeTrimOutPoint:affectSibling:
 修改片段裁剪出点 更多...
 
(double) - getSpeed
 获取片段的播放速度。 更多...
 
(void) - changeSpeed:
 改变片段的播放速度 更多...
 
(void) - changeSpeed:keepAudioPitch:
 改变片段的播放速度 更多...
 
(BOOL) - isKeepAudioPitch
 获取音调状态 更多...
 
(BOOL) - changeCurvesVariableSpeed:keepAudioPitch:
 使用贝塞尔曲线改变片段的播放速度(仅支持视频片段) 更多...
 
(NSString *) - getClipVariableSpeedCurvesString
 获得当前片段的变速曲线字符串 更多...
 
(int64_t) - getClipPosByTimelinePosCurvesVariableSpeed:
 在曲线变速状态下，通过给定时间线位置返回片段上的位置。 更多...
 
(int64_t) - getTimelinePosByClipPosCurvesVariableSpeed:
 在曲线变速状态下，通过给定片段上位置返回时间线位置。 更多...
 
(void) - setVolumeGain:rightVolumeGain:
 设置声道（左声道和右声道） 更多...
 
(void) - getVolumeGain:rightVolumeGain:
 获取置声道值（左声道和右声道） 更多...
 
(void) - getRealVolumeAtTime:rightVolumeGain:time:
 获取指定时间点上的实时音量 更多...
 
(void) - setLoopAudio:
 设置当前片段的剪辑出点超过其音频流长度时是否循环播放音频 更多...
 
(BOOL) - getLoopAudio
 检查当前片段的剪辑出点超过其音频流长度时是否循环播放音频 更多...
 
(NvsAudioFx *) - getAudioVolumeFx
 获取当前片段音量特效 更多...
 
- 构造函数 继承自 NvsObject
(void) - setAttachment:forKey:
 给NvsObject对象添加附件，用来标识NvsObject的对象或者用于其他用途 更多...
 
(void) - setTemplateAttachment:forKey:
 为NvsObject对象添加模板资源的附加数据，用来标识NvsObject的模板数据 更多...
 
(NSObject *) - getAttachment:
 获取已经添加的附件 更多...
 
(NSString *) - getTemplateAttachment:
 获取NvsObject的模板资源附件 更多...
 

属性

NvsVideoClipType videoType
 视频片段类型 更多...
 
NvsRoleInTheme roleInTheme
 视频片段在主题中角色(通用、片头、片尾) 更多...
 
NvsStreamingEngineImageClipMotionMode imageMotionMode
 图片片段运作模式 更多...
 
BOOL imageMotionAnimationEnabled
 是否支持图片动画 更多...
 
NvsRect startROI
 图片片段起始ROI 更多...
 
NvsRect endROI
 图片片段结束ROI 更多...
 
unsigned int audioFxCount
 片段上的特效数量 更多...
 
- 属性 继承自 NvsClip
int64_t trimIn
 片段裁剪入点(单位微秒) 更多...
 
int64_t trimOut
 片段裁剪出点(单位微秒) 更多...
 
int64_t inPoint
 片段在时间线上的入点(单位微秒) 更多...
 
int64_t outPoint
 片段在时间线上的出点(单位微秒) 更多...
 
NvsClipType type
 片段类型（视频、音频） 更多...
 
unsigned int index
 片段在轨道上的索引 更多...
 
NSString * filePath
 片段文件路径 更多...
 
unsigned int fxCount
 片段上的特效数量 更多...
 

详细描述

视频片段，对视频文件的描述

视频片段源可以是视频或者图片。每个视频片段可以修改其裁剪入点、裁剪出点以及播放速度，也可以设置摇摄和扫描。编辑视频时，可以按特效类型的不同（内建特效，包裹式特效，美颜特效）添加或者插入多个视频特效。 添加资源包特效时，都得先安装，安装成功后获取packageId才能使用，而内建特效(builtin)只需获取特效名称即可使用。

警告
NvsVideoClip类中，所有public API都在UI线程使用！！！

函数文档

◆ addAnimatedSticker:duration:animatedStickerPackageId:

- (NvsClipAnimatedSticker *) addAnimatedSticker: (int64_t)  inPoint
duration: (int64_t)  duration
animatedStickerPackageId: (NSString *)  animatedStickerPackageId 

在片段上添加动画贴纸

参数
inPoint动画贴纸在片段上的入点（单位微秒）
duration动画贴纸的显示时长（单位微秒）, -1表示铺满整个片段
animatedStickerPackageId动画贴纸包Id
返回
返回片段动画贴纸对象
以下情况会返回null：
1.没有动画贴纸功能授权；
2.animatedStickerPackageId参数为空字符串或者null；
3.该动画贴纸包没有安装成功；
4.如果inPoint小于0，或者duration小于等于0并且不为-1。
参见
removeAnimatedSticker
自从
3.0.1

◆ addCaption:inPoint:duration:captionStylePackageId:

- (NvsClipCaption *) addCaption: (NSString *)  captionText
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration
captionStylePackageId: (NSString *)  captionStylePackageId 

在片段上添加字幕,相对于单一的片段

参数
captionText字幕的文字
inPoint字幕在片段上的起点（单位微秒）
duration字幕显示时长（单位微秒）, -1表示铺满整个片段
captionStylePackageId字幕样式包Id，不存在的话，可以传空字符串或者null
返回
返回片段字幕对象
以下情况会返回null：
1.没有字幕功能授权；
2.如果inPoint小于0，或者duration小于等于0并且不为-1。
参见
removeCaption
自从
3.0.1

◆ addCompoundCaption:duration:compoundCaptionPackageId:

- (NvsClipCompoundCaption *) addCompoundCaption: (int64_t)  inPoint
duration: (int64_t)  duration
compoundCaptionPackageId: (NSString *)  compoundCaptionPackageId 

在片段上添加字幕

参数
inPoint字幕在片段上的起点（单位微秒）
duration字幕显示时长（单位微秒）, -1表示铺满整个片段
captionStylePackageId字幕样式包Id，不存在的话，可以传空字符串或者null
返回
返回片段字幕对象
以下情况会返回null：
1.没有复合字幕功能授权；
2.如果inPoint小于0，或者duration小于等于0并且不为-1。
自从
3.0.1
参见
removeCompoundCaption

◆ addCustomAnimatedSticker:duration:animatedStickerPackageId:customImagePath:

- (NvsClipAnimatedSticker *) addCustomAnimatedSticker: (int64_t)  inPoint
duration: (int64_t)  duration
animatedStickerPackageId: (NSString *)  animatedStickerPackageId
customImagePath: (NSString *)  customImagePath 

在片段上添加自定义动画贴纸

参数
inPoint自定义动画贴纸在片段上的入点（单位微秒）
duration自定义动画贴纸的显示时长（单位微秒）, -1表示铺满整个片段
animatedStickerPackageId自定义动画贴纸包Id
customImagePath自定义动画贴纸图像路径（可以是jpg、png图像，或者美摄sdk内部支持的动态caf格式图像）
返回
返回片段自定义动画贴纸对象
以下情况会返回null：
1.没有动画贴纸功能授权；
2.animatedStickerPackageId参数为空字符串或者null；
3.该动画贴纸包没有安装成功；
4.如果inPoint小于0，或者duration小于等于0并且不为-1。
注意：如果返回值非空，依旧看不到贴纸效果，需要检查customImagePath是否真实存在
参见
removeAnimatedSticker
自从
3.0.1

◆ addCustomPanoramicAnimatedSticker:duration:animatedStickerPackageId:customImagePath:

- (NvsClipAnimatedSticker *) addCustomPanoramicAnimatedSticker: (int64_t)  inPoint
duration: (int64_t)  duration
animatedStickerPackageId: (NSString *)  animatedStickerPackageId
customImagePath: (NSString *)  customImagePath 

在片段上添加自定义全景图动画贴纸

参数
inPoint动画贴纸在片段上的起点（单位微秒）
duration动画贴纸的显示时长（单位微秒）, -1表示铺满整个片段
animatedStickerPackageId动画贴纸资源包ID
customImagePath自定义动画贴纸图像路径（可以是jpg、png图像，或者美摄sdk内部支持的动态caf格式图像）
返回
返回片段动画贴纸对象
以下情况会返回null：
1.没有动画贴纸功能授权或者没有全景编辑功能授权；
2.animatedStickerPackageId参数为空字符串或者null；
3.该动画贴纸包没有安装成功；
4.如果inPoint小于0，或者duration小于等于0并且不为-1。
注意：如果返回值非空，依旧看不到贴纸效果，需要检查customImagePath是否真实存在
自从
3.0.1
参见
removeAnimatedSticker

◆ addModularCaption:inPoint:duration:

- (NvsClipCaption *) addModularCaption: (NSString *)  captionText
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上添加模块字幕

参数
captionText字幕的文字
inPoint字幕在片段上的起点（单位微秒）
duration字幕显示时长（单位微秒）, -1表示铺满整个片段
返回
返回片段字幕对象
以下情况会返回null：
1.没有字幕功能授权；
2.如果inPoint小于0，或者duration小于等于0并且不为-1。
参见
removeCaption

◆ addPanoramicAnimatedSticker:duration:animatedStickerPackageId:

- (NvsClipAnimatedSticker *) addPanoramicAnimatedSticker: (int64_t)  inPoint
duration: (int64_t)  duration
animatedStickerPackageId: (NSString *)  animatedStickerPackageId 

在片段上添加全景图动画贴纸

参数
inPoint动画贴纸在片段上的起点（单位微秒）
duration动画贴纸的显示时长（单位微秒）, -1表示铺满整个片段
animatedStickerPackageId动画贴纸资源包ID
返回
返回片段动画贴纸对象
以下情况会返回null：
1.没有动画贴纸功能授权或者没有全景编辑功能授权；
2.animatedStickerPackageId参数为空字符串或者null；
3.该动画贴纸包没有安装成功；
4.如果inPoint小于0，或者duration小于等于0并且不为-1。
自从
3.0.1
参见
removeAnimatedSticker

◆ addPanoramicCaption:inPoint:duration:captionStylePackageId:

- (NvsClipCaption *) addPanoramicCaption: (NSString *)  captionText
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration
captionStylePackageId: (NSString *)  captionStylePackageId 

在片段上添加全景图字幕

参数
captionText字幕的文字
inPoint字幕在片段上的入点（单位微秒）
duration字幕的显示时长（单位微秒）, -1表示铺满整个片段
captionStylePackageId字幕样式包Id，不存在的话，可以传空字符串或者null
返回
返回片段字幕对象
以下情况会返回null：
1.没有字幕功能授权；
2.如果inPoint小于0，或者duration小于等于0并且不为-1。
自从
1.6.0
参见
removeCaption

◆ appendAudioFx:

- (NvsAudioFx *) appendAudioFx: (NSString *)  fxName

在片段尾部追加音频特效

参数
fxName特效名称。获取特效名称，请参照getAllBuiltinAudioFxNames()或内建特效名称列表.
返回
返回追加的音频特效对象
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
参见
- insertAudioFx:fxIndex:
- removeAudioFx:
- getAudioFxWithIndex:
自从
2.24.0

◆ appendBeautyFx

- (NvsVideoFx *) appendBeautyFx

在片段上追加美颜特效

返回
返回追加的视频特效对象
参见
- insertBeautyFx:
- appendPackagedFx:
- appendBuiltinFx:

◆ appendBeautyFx:duration:

- (NvsVideoFx *) appendBeautyFx: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上追加美颜特效

参数
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回追加的视频特效对象
参见
- insertBeautyFx:
- appendPackagedFx:
- appendBuiltinFx:
自从
3.0.1

◆ appendBuiltinFx:

- (NvsVideoFx *) appendBuiltinFx: (NSString *)  fxName

在片段上追加内嵌式特效

参数
fxName特效名称。获取视频特效名称，请参见getAllBuiltinVideoFxNames()或内建特效名称列表
返回
返回追加的视频特效对象
参见
- insertBuiltinFx:fxIndex:
- appendBeautyFx
- appendPackagedFx:

◆ appendBuiltinFx:inPoint:duration:

- (NvsVideoFx *) appendBuiltinFx: (NSString *)  fxName
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上追加内嵌式特效

参数
fxName特效名称。获取视频特效名称，请参见getAllBuiltinVideoFxNames()或内建特效名称列表
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回追加的视频特效对象
参见
- insertBuiltinFx:fxIndex:
- appendBeautyFx
- appendPackagedFx:
自从
3.0.1

◆ appendCustomAudioFx:

- (NvsAudioFx *) appendCustomAudioFx: (id< NvsCustomAudioFxRenderer >)  customAudioFxRender

在音频片段上追加自定义音频特效

参数
NvsCustomAudioFx.Renderer用户实现的自定义视频特效渲染器接口
返回
返回追加的音频特效对象
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
自从
2.24.0

◆ appendCustomFx:

- (NvsVideoFx *) appendCustomFx: (id< NvsCustomVideoFxRenderer >)  customVideoFxRender

在片段上追加自定义视频特效

参数
customVideoFxRender用户实现的自定义视频特效渲染器接口
返回
返回追加的视频特效对象
自从
1.7.0

◆ appendCustomFx:inPoint:duration:

- (NvsVideoFx *) appendCustomFx: (id< NvsCustomVideoFxRenderer >)  customVideoFxRender
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上追加自定义视频特效

参数
customVideoFxRender用户实现的自定义视频特效渲染器接口
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回追加的视频特效对象
自从
3.0.1

◆ appendPackagedFx:

- (NvsVideoFx *) appendPackagedFx: (NSString *)  fxPackageId

在片段上追加资源包特效

参数
fxPackageId特效资源包ID
返回
返回追加的视频特效对象
参见
- appendBeautyFx
- appendBuiltinFx:
- insertPackagedFx:fxIndex:

◆ appendPackagedFx:inPoint:duration:

- (NvsVideoFx *) appendPackagedFx: (NSString *)  fxPackageId
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上追加资源包特效

参数
fxPackageId特效资源包ID
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回追加的视频特效对象
参见
- appendBeautyFx
- appendBuiltinFx:
- insertPackagedFx:fxIndex:

◆ appendRawBuiltinFx:

- (NvsVideoFx *) appendRawBuiltinFx: (NSString *)  fxName

在片段上追加作用在原始输入上的内嵌式特效

参数
fxName特效名称。获取视频特效名称，请参见getAllBuiltinVideoFxNames()或内建特效名称列表
返回
返回追加的视频特效对象
自从
2.20.0

◆ appendRawBuiltinFx:inPoint:duration:

- (NvsVideoFx *) appendRawBuiltinFx: (NSString *)  fxName
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上追加作用在原始输入上的内嵌式特效

参数
fxName特效名称。获取视频特效名称，请参见getAllBuiltinVideoFxNames()或内建特效名称列表
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回追加的视频特效对象
自从
3.0.1

◆ appendRawCustomFx:

- (NvsVideoFx *) appendRawCustomFx: (id< NvsCustomVideoFxRenderer >)  customVideoFxRender

在片段上追加作用在原始输入上的自定义视频特效

参数
customVideoFxRender用户实现的自定义视频特效渲染器接口
返回
返回追加的视频特效对象
自从
2.20.0

◆ appendRawCustomFx:inPoint:duration:

- (NvsVideoFx *) appendRawCustomFx: (id< NvsCustomVideoFxRenderer >)  customVideoFxRender
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上追加作用在原始输入上的自定义视频特效

参数
customVideoFxRender用户实现的自定义视频特效渲染器接口
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间,数值为-1表示特效显示整个片段
返回
返回追加的视频特效对象
自从
3.0.1

◆ appendRawPackagedFx:

- (NvsVideoFx *) appendRawPackagedFx: (NSString *)  fxPackageId

在片段上追加作用在原始输入上的资源包特效

参数
fxPackageId特效资源包ID
返回
返回追加的视频特效对象
自从
2.20.0

◆ appendRawPackagedFx:inPoint:duration:

- (NvsVideoFx *) appendRawPackagedFx: (NSString *)  fxPackageId
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上追加作用在原始输入上的资源包特效

参数
fxPackageId特效资源包ID
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回追加的视频特效对象
自从
3.0.1

◆ changeVariableSpeed:endSpeed:keepAudioPitch:

- (void) changeVariableSpeed: (double)  startSpeed
endSpeed: (double)  endSpped
keepAudioPitch: (BOOL)  keepAudioPitch 

改变片段的播放速度

参数
startSpeed开始播放速度
endSpeed结束播放速度
keepAudioPitch保持音调不变
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
参见
- getEndSpeed,
自从
2.11.0

◆ disableAmbiguousCrop:

- (void) disableAmbiguousCrop: (BOOL)  disable

设置是否禁止画面的近似比例裁剪，默认为false。

参数
disable是否禁止
参见
- isAmbiguousCropDisabled:

◆ enableClipFreezeFrame:

- (void) enableClipFreezeFrame: (BOOL)  enable

设置片段静帧效果开启状态

参数
enable是否开启
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
自从
2.18
参见
isClipFreenzeFrameEnabled

◆ enablePropertyVideoFx:

- (void) enablePropertyVideoFx: (BOOL)  enable

设置属性特效是否有效

警告
此接口会使setPan:andScan:，setSourceBackgroundMode 和setSourceBackgroundColor接口无效。 如果启用属性特效，可以通过特效中的参数来设置对应效果
参数
enable是否开启
参见
IsOriginalRender

◆ enableRawSourceMode:

- (void) enableRawSourceMode: (BOOL)  enable

开启原始画幅模式 当这个模式开启后， SetPanAndScan, GetPanAndScan, DisableAmbiguousCrop, IsAmbiguousCropDisabled, SetImageMotionMode, ImageMotionMode SetImageMotionROI, GetImageMotionROI, SetImageMotionAnimationEnabled, IsImageMotionAnimationEnabled, SetImageMaskROI, GetImageMaskROI,都已经无效。 如果开启了属性特技，在属性特技中的对应的参数是没有效果的

参见
- isRawSourceModeEnabled
自从
3.7.0

◆ enableVideoClipROI:

- (void) enableVideoClipROI: (BOOL)  enable

设置视频是否启用ROI的模式,默认使用的是摇摄和扫描模式

参数
enable是否启用
参见
- isVideoClipROIEnabled
setImageMotionROI

◆ getAnimatedStickersByClipTimePosition:

- (NSArray *) getAnimatedStickersByClipTimePosition: (int64_t)  cliptimePos

根据片段上的位置获得动画贴纸列表，相对于单个片段

参数
ClipPos片段上的位置（单位微秒）
返回
返回保存当前位置动画贴纸对象的数组
获取的动画贴纸列表排序规则如下：
1.添加时入点不同，按入点的先后顺序排列；
2.添加时入点相同，按添加动画贴纸的先后顺序排列。
参见
addAnimatedSticker
自从
3.0.1

◆ getAudioFadeInDuration

- (int64_t) getAudioFadeInDuration

获取音频的淡入时长

返回
返回淡入时长
自从
2.8.2
参见
setAudioFadeInDuration

◆ getAudioFadeOutDuration

- (int64_t) getAudioFadeOutDuration

获取音频的淡出时长

返回
返回淡出时长
自从
2.8.2
参见
setAudioFadeOutDuration

◆ getAudioFxWithIndex:

- (NvsAudioFx *) getAudioFxWithIndex: (unsigned int)  fxIndex

通过索引获取音频特效

参数
fxIndex特效索引。范围[0, getFxCount())
返回
返回获取的音频特效对象
参见
- appendAudioFx:
- insertAudioFx:fxIndex:
- removeAudioFx:
自从
2.24.0

◆ getBlendingMode

- (NvsClipBlendingMode) getBlendingMode

获取合成模式

返回
返回合成模式
参见
setBlendingMode

◆ getCaptionsByClipTimePosition:

- (NSArray *) getCaptionsByClipTimePosition: (int64_t)  cliptimePos

根据片段上的位置获得字幕列表，相对于单一的片段

参数
ClipPos片段上的位置（单位微秒）
返回
返回当前位置字幕的List集合
获取的字幕列表排序规则如下：
1.添加时字幕入点不同，按入点的先后顺序排列；
2.添加时字幕入点相同，按添加字幕的先后顺序排列。
参见
addCaption
自从
3.0.1

◆ getClipFreezeFrameTrimPosition

- (long) getClipFreezeFrameTrimPosition

获取静帧位置（单位微秒）

自从
2.18

◆ getClipWrapMode

- (NvsClipWrapMode) getClipWrapMode

获取视频循环模式

返回
返回循环模式
自从
2.2.3
参见
setClipWrapMode

◆ getCompoundCaptionsByClipTimePosition:

- (NSArray<NvsClipCompoundCaption*> *) getCompoundCaptionsByClipTimePosition: (int64_t)  cliptimePos

根据片段上的位置获得复合字幕列表，相对于单个片段上的字幕

参数
ClipPos片段上的复合位置（单位微秒）
返回
返回当前位置复合字幕的列表
获取的字幕列表排序规则如下：
1.如果字幕入点不同，按入点时间排列
2.如果字幕入点相同，按添加字幕的先后顺序排列。
自从
3.0.1
参见
addCompoundCaption

◆ getEndSpeed

- (double) getEndSpeed

默认值为1，表示按正常速度播放;小于1的值表示慢放;大于1的值表示快放

返回
返回当前片段的结束播放速度
参见
- changeVariableSpeed:endSpeed:keepAudioPitch:
自从
2.11.0

◆ getExtraVideoRotation

- (NvsExtraVideoRotation) getExtraVideoRotation

获取视频额外旋转角度

返回
返回获取额外旋转角度
参见
- setExtraVideoRotation:

◆ getFirstAnimatedSticker

- (NvsClipAnimatedSticker *) getFirstAnimatedSticker

获取片段上第一个动画贴纸，相对于单个片段上的动画

返回
返回获取的片段动画贴纸对象
参见
- getLastAnimatedSticker
addAnimatedSticker
自从
3.0.1

◆ getFirstCaption

- (NvsClipCaption *) getFirstCaption

获取片段上的第一个字幕,相对于每个片段上的字幕

返回
返回获取的片段字幕对象
参见
- getLastCaption
addCaption
自从
3.0.1

◆ getFirstCompoundCaption

- (NvsClipCompoundCaption *) getFirstCompoundCaption

获取片段上的第一个复合字幕

返回
返回获取的片段复合字幕对象
自从
3.0.1
参见
- getLastCompoundCaption
addCompoundCaption

◆ getFxWithIndex:

- (NvsVideoFx *) getFxWithIndex: (unsigned int)  fxIndex

通过索引获取特效

参数
fxIndex特效索引
返回
返回获取的视频特效对象

◆ getLastAnimatedSticker

- (NvsClipAnimatedSticker *) getLastAnimatedSticker

获取片段上最后一个动画贴纸，相对于单个片段上的动画贴纸

返回
返回获取的片段动画贴纸对象
参见
- getFirstAnimatedSticker
自从
3.0.1

◆ getLastCaption

- (NvsClipCaption *) getLastCaption

获取片段上的最后一个字幕,相对于每个片段上的字幕

返回
返回获取的片段字幕对象
参见
- getFirstCaption
addCaption
自从
3.0.1

◆ getLastCompoundCaption

- (NvsClipCompoundCaption *) getLastCompoundCaption

获取片段上的最后一个复合字幕，相对于单个的片段上的字幕

返回
返回获取的片段复合字幕对象
自从
3.0.1
参见
- getFirstCompoundCaption
addCompoundCaption

◆ getNextAnimatedSticker:

- (NvsClipAnimatedSticker *) getNextAnimatedSticker: (NvsClipAnimatedSticker *)  animatedSticker

获取片段当前动画贴纸的后一个动画贴纸。相对于单个片段上的动画贴纸

参数
animatedSticker片段动画贴纸对象
返回
返回获取的片段动画贴纸对象
参见
getPrevAnimatedSticker
自从
3.0.1

◆ getNextCaption:

- (NvsClipCaption *) getNextCaption: (NvsClipCaption *)  caption

获取片段上的当前字幕的前一个字幕，相对于每个片段上的字幕

参数
caption片段上当前字幕对象
返回
返回获取的片段字幕对象
参见
getPrevCaption
自从
3.0.1

◆ getNextCompoundCaption:

- (NvsClipCompoundCaption *) getNextCompoundCaption: (NvsClipCompoundCaption *)  caption

获取片段上的当前复合字幕的前一个复合字幕，相对于单个片段上的字幕

参数
caption片段上当前复合字幕对象
返回
返回获取的片段复合字幕对象
自从
3.0.1
参见
getPrevCompoundCaption

◆ getOpacity

- (float) getOpacity

获取透明度

返回
返回透明度
参见
setOpacity

◆ getPan:andScan:

- (void) getPan: (float *)  pan
andScan: (float *)  scan 

获取摇摄和扫描

参数
pan输出摇摄值
scan输出扫描值
参见
- setPan:andScan:

◆ getPlayInReverse

- (BOOL) getPlayInReverse

获取片段是否倒放

返回
返回片段是否倒放
自从
1.5.1
参见
setPlayInReverse

◆ getPrevAnimatedSticker:

- (NvsClipAnimatedSticker *) getPrevAnimatedSticker: (NvsClipAnimatedSticker *)  animatedSticker

获取片段当前动画贴纸的前一个动画贴纸，相对于单个片段上的动画贴纸

参数
animatedSticker片段动画贴纸对象
返回
返回获取的片段动画贴纸对象
参见
getNextAnimatedSticker
自从
3.0.1

◆ getPrevCaption:

- (NvsClipCaption *) getPrevCaption: (NvsClipCaption *)  caption

获取片段上的当前字幕的前一个字幕，相对于每个片段上的字幕

参数
caption片段上当前字幕对象
返回
返回获取的片段字幕对象
参见
getNextCaption
自从
3.0.1

◆ getPrevCompoundCaption:

- (NvsClipCompoundCaption *) getPrevCompoundCaption: (NvsClipCompoundCaption *)  caption

获取片段上的当前复合字幕的前一个复合字幕，相对于单个片段上的字幕

参数
caption片段上当前复合字幕对象
返回
返回获取的片段复合字幕对象
自从
3.0.1
参见
getNextCompoundCaption

◆ getPropertyVideoFx

- (NvsVideoFx *) getPropertyVideoFx

获取当前视频片段属性特效

返回
返回获取的视频特效对象

◆ getRawFxByIndex:

- (NvsVideoFx *) getRawFxByIndex: (unsigned int)  fxIndex

通过索引获取作用在原始输入上的特效

参数
fxIndex特效索引，参见[getRawFxCount]
返回
返回获取的视频特效对象
自从
2.20.0

◆ getRawFxCount

- (unsigned int) getRawFxCount

获取片段上作用在原始输入上的特效数量。注：片段上的特效索引是从0开始

返回
返回片段上的特效数
自从
2.20.0

◆ getRefImageBackgroundBlurNewModeEnable

- (BOOL) getRefImageBackgroundBlurNewModeEnable

获取小图模式下背景填充模糊新模式状态

返回
返回获取的背景新模式状态
参见
- getRefImageBackgroundBlurNewModeEnable
自从
3.7.0

◆ getRefImageBackgroundBlurRadius

- (float) getRefImageBackgroundBlurRadius

获取小图模式下背景填充模糊程度

返回
返回获取的背景模式程度
参见
setRefImageBackgroundBlurRadius
自从
3.4.1

◆ getRefImageBackgroundColor

- (NvsColor) getRefImageBackgroundColor

获取小图模式下背景颜色

返回
背景颜色
参见
setRefImageBackgroundColor
自从
3.4.1

◆ getRefImageBackgroundMode

- (NvsSourceBackgroundMode) getRefImageBackgroundMode

获取小图模式下背景填充模式

返回
返回获取的背景模式 (VARIANT_IMAGE_BACKGROUNDMODE)
参见
setRefImageBackgroundMode
自从
3.4.1

◆ getRefImageFillMode

- (NvsVariantImageFillMode) getRefImageFillMode

获取有参考尺寸下的填充模式

返回
返回获取的背景模式
参见
setRefImageFillMode
自从
3.7.0

◆ getSourceBackgroundColor

- (NvsColor) getSourceBackgroundColor

获取背景颜色

返回
背景颜色
参见
- setSourceBackgroundColor:
自从
2.11.1

◆ getSourceBackgroundMode

- (NvsSourceBackgroundMode) getSourceBackgroundMode

获取背景模式

返回
背景模式(ClIP_BACKGROUNDMODE)
参见
setSourceBackgroundMode:sourceBackgroundMode:

◆ getStartSpeed

- (double) getStartSpeed

默认值为1，表示按正常速度播放;小于1的值表示慢放;大于1的值表示快放

返回
返回当前片段的起始播放速度
参见
- changeVariableSpeed:endSpeed:keepAudioPitch:
自从
2.11.0

◆ insertAudioFx:fxIndex:

- (NvsAudioFx *) insertAudioFx: (NSString *)  fxName
fxIndex: (unsigned int)  fxIndex 

在片段上指定特效索引处插入音频特效

参数
fxName特效名称。获取特效名称，请参照getAllBuiltinAudioFxNames()或内建特效名称列表。
fxIndex指定特效索引。范围[0, getFxCount() - 1)。如果索引超出范围，会在最后面添加。
返回
返回插入的音频特效对象
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
参见
- appendAudioFx:
- removeAudioFx:
- getAudioFxWithIndex:
自从
2.24.0

◆ insertBeautyFx:

- (NvsVideoFx *) insertBeautyFx: (unsigned int)  fxIndex

在片段上指定特效索引处插入美颜特效

参数
fxIndex指定特效索引
返回
返回插入的视频特效对象
参见
- appendBeautyFx
- insertPackagedFx:fxIndex:
- insertBuiltinFx:fxIndex:

◆ insertBeautyFx:inPoint:duration:

- (NvsVideoFx *) insertBeautyFx: (unsigned int)  fxIndex
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上指定特效索引处插入美颜特效

参数
fxIndex指定特效索引
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回插入的视频特效对象
参见
- appendBeautyFx
- insertPackagedFx:fxIndex:
- insertBuiltinFx:fxIndex:
自从
3.0.1

◆ insertBuiltinFx:fxIndex:

- (NvsVideoFx *) insertBuiltinFx: (NSString *)  fxName
fxIndex: (unsigned int)  fxIndex 

在片段上指定特效索引处插入内嵌式特效

参数
fxName特效名称。获取视频特效名称，请参见getAllBuiltinVideoFxNames()或内建特效名称列表
fxIndex指定特效索引
返回
返回插入的视频特效对象
参见
- appendBuiltinFx:
- insertPackagedFx:fxIndex:
- insertBeautyFx:

◆ insertBuiltinFx:fxIndex:inPoint:duration:

- (NvsVideoFx *) insertBuiltinFx: (NSString *)  fxName
fxIndex: (unsigned int)  fxIndex
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上指定特效索引处插入内嵌式特效

参数
fxName特效名称。获取视频特效名称，请参见getAllBuiltinVideoFxNames()或内建特效名称列表
fxIndex指定特效索引
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回插入的视频特效对象
参见
- appendBuiltinFx:
- insertPackagedFx:fxIndex:
- insertBeautyFx:
自从
3.0.1

◆ insertCustomAudioFx:fxIndex:

- (NvsAudioFx *) insertCustomAudioFx: (id< NvsCustomAudioFxRenderer >)  customAudioFxRender
fxIndex: (unsigned int)  fxIndex 

在片段上指定特效索引处插入自定义音频特效

参数
NvsCustomAudioFx.Renderer用户实现的自定义视频特效渲染器接口
fxIndex插入音频特效索引。范围[0, getFxCount() - 1)。如果索引超出范围，会在最后面添加。
返回
返回插入的音频特效对象
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
自从
2.24.0

◆ insertCustomFx:fxIndex:

- (NvsVideoFx *) insertCustomFx: (id< NvsCustomVideoFxRenderer >)  customVideoFxRender
fxIndex: (unsigned int)  fxIndex 

在片段上指定特效索引处插入自定义视频特效

参数
customVideoFxRender用户实现的自定义视频特效渲染器接口
fxIndex插入特效索引
返回
返回插入的视频特效对象
自从
1.7.0

◆ insertCustomFx:fxIndex:inPoint:duration:

- (NvsVideoFx *) insertCustomFx: (id< NvsCustomVideoFxRenderer >)  customVideoFxRender
fxIndex: (unsigned int)  fxIndex
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上指定特效索引处插入自定义视频特效

参数
customVideoFxRender用户实现的自定义视频特效渲染器接口
fxIndex插入特效索引
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回插入的视频特效对象
自从
3.0.1

◆ insertPackagedFx:fxIndex:

- (NvsVideoFx *) insertPackagedFx: (NSString *)  fxPackageId
fxIndex: (unsigned int)  fxIndex 

在片段上指定特效索引处插入包裹特效

参数
fxPackageId包裹特效Id
fxIndex插入特效索引
返回
返回插入的视频特效对象
参见
- insertBeautyFx:
- appendPackagedFx:
- insertBuiltinFx:fxIndex:

◆ insertPackagedFx:fxIndex:inPoint:duration:

- (NvsVideoFx *) insertPackagedFx: (NSString *)  fxPackageId
fxIndex: (unsigned int)  fxIndex
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上指定特效索引处插入包裹特效

参数
fxPackageId包裹特效Id
fxIndex插入特效索引
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回插入的视频特效对象
参见
- insertBeautyFx:
- appendPackagedFx:
- insertBuiltinFx:fxIndex:

◆ insertRawBuiltinFx:fxIndex:

- (NvsVideoFx *) insertRawBuiltinFx: (NSString *)  fxName
fxIndex: (unsigned int)  fxIndex 

在片段上指定特效索引处插入作用在原始输入上的内嵌式特效

参数
fxName特效名称。获取视频特效名称，请参见getAllBuiltinVideoFxNames()或[内建特效名称列表]
fxIndex插入特效索引
返回
返回插入的视频特效对象
自从
2.20.0

◆ insertRawBuiltinFx:fxIndex:inPoint:duration:

- (NvsVideoFx *) insertRawBuiltinFx: (NSString *)  fxName
fxIndex: (unsigned int)  fxIndex
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上指定特效索引处插入作用在原始输入上的内嵌式特效

参数
fxName特效名称。获取视频特效名称，请参见getAllBuiltinVideoFxNames()或[内建特效名称列表]
fxIndex插入特效索引
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回插入的视频特效对象
自从
3.0.1

◆ insertRawCustomFx:fxIndex:

- (NvsVideoFx *) insertRawCustomFx: (id< NvsCustomVideoFxRenderer >)  customVideoFxRender
fxIndex: (unsigned int)  fxIndex 

在片段上指定特效索引处插入作用在原始输入上的自定义视频特效

参数
customVideoFxRender用户实现的自定义视频特效渲染器接口
fxIndex插入特效索引
返回
返回插入的视频特效对象
自从
2.20.0

◆ insertRawCustomFx:fxIndex:inPoint:duration:

- (NvsVideoFx *) insertRawCustomFx: (id< NvsCustomVideoFxRenderer >)  customVideoFxRender
fxIndex: (unsigned int)  fxIndex
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上指定特效索引处插入作用在原始输入上的自定义视频特效

参数
customVideoFxRender用户实现的自定义视频特效渲染器接口
fxIndex插入特效索引
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回插入的视频特效对象
自从
3.0.1

◆ insertRawPackagedFx:fxIndex:

- (NvsVideoFx *) insertRawPackagedFx: (NSString *)  fxPackageId
fxIndex: (unsigned int)  fxIndex 

在片段上指定特效索引处插入作用在原始输入上的资源包特效

参数
fxPackageId特效资源包ID
fxIndex插入特效索引，参见[getRawFxCount]
返回
返回插入的视频特效对象
自从
2.20.0

◆ insertRawPackagedFx:fxIndex:inPoint:duration:

- (NvsVideoFx *) insertRawPackagedFx: (NSString *)  fxPackageId
fxIndex: (unsigned int)  fxIndex
inPoint: (int64_t)  inPoint
duration: (int64_t)  duration 

在片段上指定特效索引处插入作用在原始输入上的资源包特效

参数
fxPackageId特效资源包ID
fxIndex插入特效索引，参见[getRawFxCount]
inPoint特效的相对于片段的起始时间
duration特效在片段上的持续时间，数值为-1表示特效显示整个片段
返回
返回插入的视频特效对象
自从
3.0.1

◆ isAmbiguousCropDisabled

- (BOOL) isAmbiguousCropDisabled

获取是否禁止画面的近似比例裁剪

返回
是否禁止画面的近似比例裁剪
参见
disableAmbiguousCrop:disable:

◆ isClipFreezeFrameEnabled

- (BOOL) isClipFreezeFrameEnabled

获取静帧效果是否开启

自从
2.18

◆ isOriginalRender

- (BOOL) isOriginalRender

获取是否开启了原始比例渲染的模式

返回
返回是否开启
参见
setEnableOriginalRender

◆ isPropertyVideoFxEnabled

- (BOOL) isPropertyVideoFxEnabled

获取是否开启了原始比例渲染的模式

返回
返回是否开启
参见
enablePropertyEffect

◆ isRawSourceModeEnabled

- (BOOL) isRawSourceModeEnabled

获取原始画幅模式状态

返回
返回是否开启了状态
参见
enableRawSourceMode
自从
3.7.0

◆ isVideoClipROIEnabled

- (BOOL) isVideoClipROIEnabled

获取视频是否启用ROI的模式

返回
返回获取的视频是否启用ROI的模式
参见
enableVideoClipROI

◆ removeAllAudioFx

- (BOOL) removeAllAudioFx

移除所有音频特效

返回
判断是否移除成功。返回YES则移除成功，NO则失败。
参见
- removeFx:

◆ removeAllFx

- (BOOL) removeAllFx

移除所有特效

返回
判断是否移除成功。返回YES则移除成功，NO则失败。
参见
- removeFx:

◆ removeAllVideoFx

- (BOOL) removeAllVideoFx

移除所有视频特效

返回
判断是否移除成功。返回YES则移除成功，NO则失败。
参见
- removeFx:

◆ removeAnimatedSticker:

- (NvsClipAnimatedSticker *) removeAnimatedSticker: (NvsClipAnimatedSticker *)  animatedSticker

移除片段上的动画贴纸

参数
animatedSticker要移除的动画贴纸对象
返回
返回下一个片段动画贴纸对象
自从
3.0.1
参见
addAnimatedSticker

◆ removeAudioFx:

- (BOOL) removeAudioFx: (unsigned int)  fxIndex

移除指定索引的音频特效，后面的特效索引前移。

参数
fxIndex特效索引。范围[0, getFxCount())
返回
返回BOOL值。值为YES则移除成功，NO则移除失败。
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
参见
- appendAudioFx:
- insertAudioFx:fxIndex:
- getAudioFxWithIndex:
自从
2.24.0

◆ removeCaption:

- (NvsClipCaption *) removeCaption: (NvsClipCaption *)  caption

移除片段上的字幕

参数
caption要移除的片段字幕对象
返回
返回下一个片段字幕对象
参见
addCaption
自从
3.0.1

◆ removeCompoundCaption:

- (NvsClipCompoundCaption *) removeCompoundCaption: (NvsClipCompoundCaption *)  caption

移除片段上的复合字幕，相对于单个片段

参数
caption要移除的片段复合字幕对象
返回
返回下一个片段复合字幕对象
自从
3.0.1
参见
addCompoundCaption

◆ removeFx:

- (BOOL) removeFx: (unsigned int)  fxIndex

移除特效

参数
fxIndex特效索引
返回
判断是否移除成功。返回YES则移除成功，NO则失败。
参见
- removeAllFx

◆ removeRawFx:

- (BOOL) removeRawFx: (unsigned int)  fxIndex

移除作用在原始输入上的特效

参数
fxIndex特效索引，参见[getRawFxCount]
返回
判断是否移除成功。返回true则移除成功，false则移除失败
自从
2.20.0

◆ setAudioFadeInDuration:

- (void) setAudioFadeInDuration: (int64_t)  fadeInDuration

设置音频淡入的时长

参数
fadeInDuration淡入的时长
自从
2.8.2
参见
- getAudioFadeInDuration

◆ setAudioFadeOutDuration:

- (void) setAudioFadeOutDuration: (int64_t)  fadeOutDuration

设置音频淡出的时长

参数
fadeOutDuration淡出的时长
自从
2.8.2
参见
- getAudioFadeOutDuration

◆ setBlendingMode:

- (void) setBlendingMode: (NvsClipBlendingMode)  blendMode

设置合成模式

参数
blendMode合成模式
参见
- getBlendingMode

◆ setClipFreezeFrameTrimPosition:

- (void) setClipFreezeFrameTrimPosition: (long)  trimPos

设置片段静帧效果位置

参数
trimPos静帧位置（单位微秒）
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
自从
2.18
参见
isClipFreenzeFrameEnabled

◆ setClipWrapMode:

- (void) setClipWrapMode: (NvsClipWrapMode)  wrapMode

设置片段循环模式

参数
wrapMode循环模式
自从
2.2.3
参见
- getClipWrapMode

◆ setCustomPropertyVideoFx:

- (NvsVideoFx *) setCustomPropertyVideoFx: (id< NvsCustomVideoFxRenderer >)  customVideoFxRender

设置当前视频片段自定义属性特效

参数
customVideoFxRender用户实现的自定义视频特效渲染器接口
返回
返回获取的视频特效对象

◆ setEnableOriginalRender:

- (void) setEnableOriginalRender: (BOOL)  enable

开启按照视频片段的原始比例进行特效渲染

参数
enable是否开启
参见
IsOriginalRender

◆ setExtraVideoRotation:

- (void) setExtraVideoRotation: (NvsExtraVideoRotation)  rotation

设置视频额外旋转角度

参数
rotation额外旋转角度
参见
- getExtraVideoRotation

◆ setExtraVideoRotation:rotateROI:

- (void) setExtraVideoRotation: (NvsExtraVideoRotation)  rotation
rotateROI: (bool)  rotateROI 

设置视频额外旋转角度

参数
rotation额外旋转角度
rotateROI是否旋转ROI运动方向
参见
- getExtraVideoRotation

◆ setImageMotionROI:endROI:

- (void) setImageMotionROI: (NvsRect *)  startROI
endROI: (NvsRect *)  endROI 

设置图片片段动态移动ROI

具体情况请参见图片片段ROI专题

参数
startROI图片片段起始ROI
endROI图片片段终止ROI
自从
1.1.0
参见
- setPan:andScan:

◆ setOpacity:

- (void) setOpacity: (float)  opacity

设置透明度

参数
opacity透明度，默认值为1，范围(0,1]
参见
- getOpacity

◆ setPan:andScan:

- (void) setPan: (float)  pan
andScan: (float)  scan 

设置摇摄和扫描

摇摄和扫描功能是用来适配图像在显示窗口上的位置与大小的。具体请参见摇摄与扫描(Pan and Scan)专题。

参数
pan摇摄
scan扫描
参见
- getPan:andScan:

◆ setPlayInReverse:

- (void) setPlayInReverse: (BOOL)  playInReverse

设置片段是否倒放

注意：使用片段倒放请确保当前视频文件为全I帧视频，否则倒放播放效率极低完全无法忍受！可以利用美摄SDK录制标志 STREAMING_ENGINE_RECORDING_FLAG_VIDEO_INTRA_FRAME_ONLY来产生出全I帧视频文件。如果从别的地方 导入的文件无法保证为全I帧视频又想用倒放功能则可以使用美摄的转码SDK直接将原始视频转码为一个倒放的文件再使用。 注意：请确保需要倒放的视频文件位于APP的沙盒中

参数
playInReverse片段是否倒放
自从
1.5.1
参见
- getPlayInReverse

◆ setRefImageBackgroundBlurNewModeEnable:

- (void) setRefImageBackgroundBlurNewModeEnable: (BOOL)  newModeEnable

设置小图模式下背景模糊新模式

参数
mode背景模糊新模式
参见
setRefImageBackgroundBlurNewModeEnable
自从
3.7.0

◆ setRefImageBackgroundBlurRadius:

- (void) setRefImageBackgroundBlurRadius: (float)  radius

设置小图模式下背景模糊程度

参数
mode背景模糊程度
参见
- getRefImageBackgroundBlurRadius
自从
3.4.1

◆ setRefImageBackgroundColor:

- (void) setRefImageBackgroundColor: (NvsColor *)  color

设置小图模式下片段背景颜色

参数
color背景颜色
参见
- getRefImageBackgroundColor
自从
3.4.1

◆ setRefImageBackgroundMode:

- (void) setRefImageBackgroundMode: (NvsSourceBackgroundMode)  variantImageBackgroundMode

设置小图模式下背景模式 (VARIANT_IMAGE_BACKGROUNDMODE)

参数
mode背景模式
参见
- getRefImageBackgroundMode
自从
3.4.1

◆ setRefImageFillMode:

- (void) setRefImageFillMode: (NvsVariantImageFillMode)  variantImageBackgroundMode

设置有参考尺寸下的填充模式

参数
mode填充模式
参见
- getRefImageFillMode
自从
3.7.0

◆ setSourceBackgroundColor:

- (void) setSourceBackgroundColor: (NvsColor *)  color

设置片段背景颜色

参数
color背景颜色
参见
- getSourceBackgroundColor:
自从
2.11.1

◆ setSourceBackgroundMode:

- (void) setSourceBackgroundMode: (NvsSourceBackgroundMode)  sourceBackgroundMode

设置背景模式

参数
sourceBackgroundMode背景模式 (ClIP_BACKGROUNDMODE)
参见
- getSourceBackgroundMode:

◆ updateAudioForClipVideoFx

- (void) updateAudioForClipVideoFx

更新当前片段特效中携带的音频信息。

返回
无返回值。
自从
3.8.0

属性说明

◆ audioFxCount

- (unsigned int) audioFxCount
readatomicassign

片段上的特效数量

◆ endROI

- (NvsRect) endROI
readatomicassign

图片片段结束ROI

自从
1.1.0

◆ imageMotionAnimationEnabled

- (BOOL) imageMotionAnimationEnabled
readwritenonatomicassign

是否支持图片动画

自从
1.1.0

◆ imageMotionMode

- (NvsStreamingEngineImageClipMotionMode) imageMotionMode
readwritenonatomicassign

图片片段运作模式

自从
1.1.0

◆ roleInTheme

- (NvsRoleInTheme) roleInTheme
readatomicassign

视频片段在主题中角色(通用、片头、片尾)

◆ startROI

- (NvsRect) startROI
readatomicassign

图片片段起始ROI

自从
1.1.0

◆ videoType

- (NvsVideoClipType) videoType
readatomicassign

视频片段类型

该类的文档由以下文件生成:
制作者   doxygen 1.8.18