AliyunEditor

@interface AliyunEditor : NSObject

编辑器


                    
                    
                    -initWithPath:preview:

初始化Editor

Declaration

Objective-C

- (instancetype)initWithPath:(NSString *)taskPath preview:(id)preview;

Parameters

`taskPath`	taskPath文件夹路径
`preview`	编辑预览视图

Return Value

Editor


                    
                    
                    taskPath

taskPath文件夹路径

Declaration

Objective-C

@property (nonatomic, copy, readonly) NSString *taskPath;


                    
                    
                    preview

预览视图

Declaration

Objective-C

@property(nonatomic, strong, readonly) UIView *preview


                    
                    
                    renderWrapper

内容视图

Declaration

Objective-C

@property (nonatomic, readonly) AliyunEditorRenderWrapper *renderWrapper;

-updateCover:
更新封面图片，空表示自动获取编辑首帧画面
Declaration
Objective-C

- (void)updateCover:(UIImage *)coverImage;
-getPreviewRenderSize
获取渲染窗口像素大小
Declaration
Objective-C

- (CGSize)getPreviewRenderSize;
Return Value

渲染窗口像素大小


                    
                    
                    -setScaleMode:

画面填充模式

Declaration

Objective-C

- (int)setScaleMode:(AliyunScaleMode)mode;

Parameters


                                mode

AliyunScaleModeFit = 0, // 填充 AliyunScaleModeFill = 1 // 裁剪 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID

-startEdit
创建相关资源 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 参数不正确 ALIVC_COMMON_INVALID_PARAM 组件初始化失败 ALIVC_SVIDEO_EDITOR_INIT_FAILED ALIVC_FRAMEWORK_AUDIO_PROCESS_CREATE_FAILED ALIVC_FRAMEWORK_AUDIO_PROCESS_RE_CREATE ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID
Declaration
Objective-C

- (int)startEdit;
-stopEdit
销毁相关资源 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE
Declaration
Objective-C

- (int)stopEdit;


                    
                    
                    editorCallback

编辑回调

Declaration

Objective-C

@property (nonatomic, weak) id<AliyunEditorDelegate> editorCallback;


                    
                    
                    playerCallback

播放回调

Declaration

Objective-C

@property (nonatomic, weak) id<AliyunIPlayerCallback> playerCallback;


                    
                    
                    exporterCallback

导出回调

Declaration

Objective-C

@property (nonatomic, weak) id<AliyunIExporterCallback> exporterCallback;


                    
                    
                    streamExporterCallback

实时流导出回调

Declaration

Objective-C

@property (weak) id<AliyunIStreamExporterCallback> streamExporterCallback;


                    
                    
                    renderCallback

渲染回调

Declaration

Objective-C

@property (nonatomic, weak) id<AliyunIRenderCallback> renderCallback;

Draft


                    
                    
                    -saveToDraft:

保存到草稿

Declaration

Objective-C

- (AliyunDraft *)saveToDraft:(AliyunDraftManager *)draftMgr;

Parameters


                                draftMgr

草稿管理


                    
                    
                    -saveToDraft:withTitle:

保存到草稿

Declaration

Objective-C

- (AliyunDraft *)saveToDraft:(AliyunDraftManager *)draftMgr
                   withTitle:(NSString *)title;

Parameters

`draftMgr`	草稿管理
`title`	草稿标题

Model

-getEditorProject
编辑工程模型
Declaration
Objective-C

- (AliyunEditorProject *)getEditorProject;
-getClipConstructor
获取媒体片段构造器

对媒体片段修改操作，必须在startEdit之前或stopEdit后才能生效
Declaration
Objective-C

- (id<AliyunIClipConstructor>)getClipConstructor;
Return Value

媒体片段构造器
-getPlayer
获取播放器接口实例
Declaration
Objective-C

- (id<AliyunIPlayer>)getPlayer;
Return Value

AliyunIPlayer
-getExporter
获取导出接口实例
Declaration
Objective-C

- (id<AliyunIExporter>)getExporter;
Return Value

AliyunIExporter
-getStickerManager
获取贴图管理类(字幕/动图) API_AVAILABLE(3.20.0)
Declaration
Objective-C

- (AliyunStickerManager *)getStickerManager;
Return Value

AliyunStickerManager
-getFilterManager
获取滤镜管理类(滤镜/lut滤镜) API_AVAILABLE(3.27.0)
Declaration
Objective-C

- (AliyunFilterManager *)getFilterManager;
Return Value

AliyunFilterManager
-getPipManager
获取画中画管理类 API_AVAILABLE(3.24.0)
Declaration
Objective-C

- (AliyunPipManager *)getPipManager;
Return Value

AliyunPipManager
-rollCaptionComposer
获取翻转字幕编排 API_AVAILABLE(3.20.0)
Declaration
Objective-C

- (AliyunRollCaptionComposer *)rollCaptionComposer;

Global

-screenCapture
截屏，返回当前预览效果图
Declaration
Objective-C

- (UIImage *)screenCapture;


                    
                    
                    -applyPaint:linesData:

使用涂鸦

Declaration

Objective-C

- (int)applyPaint:(AliyunEffectImage *)paintImage
        linesData:(NSArray<AliyunICanvasLineData *> *)linesData;

Parameters

`paintImage`	涂鸦图片
`linesData`	涂鸦线数据，用于草稿恢复 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 文件不存在 ALIVC_SVIDEO_EDITOR_FILE_NOT_EXIST 图片类型不支持 ALIVC_SVIDEO_EDITOR_VIEW_TYPE_NOT_SUPPORTED


                    
                    
                    -removePaint:

删除涂鸦

Declaration

Objective-C

- (int)removePaint:(AliyunEffectImage *)paintImage;

Parameters


                                paintImage

涂鸦图片 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID


                    
                    
                    -setWaterMark:

设置水印

Declaration

Objective-C

- (int)setWaterMark:(AliyunEffectImage *)waterMark;

Parameters


                                waterMark

水印 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 文件不存在 ALIVC_SVIDEO_EDITOR_FILE_NOT_EXIST 图片类型不支持 ALIVC_SVIDEO_EDITOR_VIEW_TYPE_NOT_SUPPORTED


                    
                    
                    -setTailWaterMark:

设置片尾水印

AliyunEffectImage对象需要设置endtime属性，此属性代表距离视频结尾的时长。

Declaration

Objective-C

- (int)setTailWaterMark:(AliyunEffectImage *)waterMark;

Parameters


                                waterMark

片尾水印 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 文件不存在 ALIVC_SVIDEO_EDITOR_FILE_NOT_EXIST ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID ALIVC_FRAMEWORK_RENDER_ERROR_INVALID_OPTION


                    
                    
                    -setRenderBackgroundColor:

视频渲染最底层背景颜色

在填充模式下具有效果

Declaration

Objective-C

- (int)setRenderBackgroundColor:(id)color;

Parameters


                                color

颜色 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE


                    
                    
                    -applyBlurBackgroundPlay:

API_AVAILABLE(3.7.0)

在填充模式下，设置高斯模糊视频播放背景支持多段时间段注意：如果背景色为clearColor将默认是此效果，如果是非clearColor此接口才有效果

Declaration

Objective-C

- (int)applyBlurBackgroundPlay:(AliyunEffectBlurBackground *)blur;

Parameters


                                blur

视频高斯模糊效果 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE


                    
                    
                    -removeBlurBackgroundPlay:

API_AVAILABLE(3.7.0)

移除视频高斯模糊播放背景

Declaration

Objective-C

- (int)removeBlurBackgroundPlay:(AliyunEffectBlurBackground *)blur;

Parameters


                                blur

视频高斯模糊效果 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE

Video


                    
                    
                    -setVideoAugmentation:value:streamId:

API_AVAILABLE(3.20.0) 设置视频增强参数

See

AliyunVideoAugmentationType

Declaration

Objective-C

- (int)setVideoAugmentation:(AliyunVideoAugmentationType)videoAugmentationType
                      value:(float)value
                   streamId:(int)streamId;

Parameters

`streamId`	目标流id
`videoAugmentationType`	增强类型
`value`	参数值范围[0.0, 1.0]

Return Value

正确返回0，错误返回错误码


                    
                    
                    -resetVideoAugmentation:streamId:

API_AVAILABLE(3.20.0) 重置视频增强参数

See

AliyunVideoAugmentationType

Declaration

Objective-C

- (int)resetVideoAugmentation:(AliyunVideoAugmentationType)videoAugmentationType
                     streamId:(int)streamId;

Parameters

`videoAugmentationType`	增强类型
`streamId`	目标流id

Return Value

正确返回0，错误返回错误码 *


                    
                    
                    -setVideoHorizontalFlip:streamId:

API_AVAILABLE(3.31.0) 设置视频是否水平翻转

Declaration

Objective-C

- (int)setVideoHorizontalFlip:(BOOL)flip streamId:(int)streamId;

Parameters

`flip`	是否翻转
`streamId`	目标流id

Return Value

正确返回0，错误返回错误码 *


                    
                    
                    -applyTransition:atIndex:

API_AVAILABLE(3.7.0)

 添加转场   注意：
               ① 如果只有一个视频片段，不可调用此接口
               ② 转场的时长不能超过前后两段视频中最短的视频时长
               ③ 使用此接口前，先调用[_editor stopEdit]，然后调用此接口，接着调用 [_editor startEdit] 和[_player play]

[----A视频段----] [----B视频段----] [----C视频段----]...[----N段视频----]
                 ^                ^                 ^
 clipIndex:      0                1                N-1

Declaration

Objective-C

- (int)applyTransition:(AliyunTransitionEffect *)transition
               atIndex:(int)clipIdx;

Parameters

`transition`	具体的转场
`clipIdx`	视频片段交叉序列点

Return Value

返回值为ALIVC_COMMON_RETURN_FAILED失败 ALIVC_COMMON_RETURN_SUCCESS成功


                    
                    
                    -updateTransition:atIndex:

API_AVAILABLE(3.7.0)

 更新转场   注意：
               ① 如果只有一个视频片段，不可调用此接口
               ② 转场的时长不能超过前后两段视频中最短的视频时长

[----A视频段----] [----B视频段----] [----C视频段----]...[----N段视频----]
                 ^                ^                 ^
 clipIndex:      0                1                N-1

Declaration

Objective-C

- (int)updateTransition:(AliyunTransitionEffect *)transition
                atIndex:(int)clipIdx;

Parameters

`transition`	具体的转场
`clipIdx`	视频片段交叉序列点

Return Value

返回值为ALIVC_COMMON_RETURN_FAILED失败 ALIVC_COMMON_RETURN_SUCCESS成功


                    
                    
                    -removeTransitionAtIndex:

API_AVAILABLE(3.7.0)

删除某个转场效果注意：使用此接口前，先调用[_editor stopEdit]，然后调用此接口，接着调用 [_editor startEdit] 和[_player play]

Declaration

Objective-C

- (int)removeTransitionAtIndex:(int)clipIdx;

Parameters


                                clipIdx

序列号

Audio


                    
                    
                    -setMute:

设置是否静音

Declaration

Objective-C

- (int)setMute:(BOOL)mute;

Parameters


                                mute

静音 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_AUDIO_PROCESS_CTL_INPUT_ERROR


                    
                    
                    -setVolume:

设置音量

Declaration

Objective-C

- (int)setVolume:(int)volume;

Parameters


                                volume

音量：0-200 默认值100,原始的音量大小大于100可能会破音，建议0-100 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_AUDIO_PROCESS_CTL_INPUT_ERROR


                    
                    
                    -applyMV:

使用mv

Declaration

Objective-C

- (int)applyMV:(AliyunEffectMV *)mv;

Parameters

`mv`	@return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 解析动图失败 ALIVC_SVIDEO_EDITOR_PARSE_RESOURCE_FAILED ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID ALIVC_FRAMEWORK_AUDIO_PROCESS_FILE_STREAM_LIST_FAILED 调用后，播放器将处于暂停状态

-removeMV
移除MV @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 调用后，播放器将处于暂停状态
Declaration
Objective-C

- (int)removeMV;
-removeMVMusic
移除mv音乐 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 解析动图失败 ALIVC_SVIDEO_EDITOR_PARSE_RESOURCE_FAILED ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID ALIVC_FRAMEWORK_AUDIO_PROCESS_FILE_STREAM_LIST_FAILED 调用后，播放器将处于暂停状态
Declaration
Objective-C

- (int)removeMVMusic;


                    
                    
                    -applyMusic:

使用音乐

Declaration

Objective-C

- (int)applyMusic:(AliyunEffectMusic *)music;

Parameters


                                music

music对象 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_AUDIO_PROCESS_FILE_STREAM_LIST_FAILED ALIVC_FRAMEWORK_AUDIO_PROCESS_OPTION_LIST_FAILED 调用后，播放器将处于暂停状态


                    
                    
                    -removeMusic:

删除某一路音乐

Declaration

Objective-C

- (int)removeMusic:(AliyunEffectMusic *)music;

Parameters


                                music

音乐 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 调用后，播放器将处于暂停状态

-removeMusics
移除所有音乐 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID ALIVC_FRAMEWORK_AUDIO_PROCESS_FILE_STREAM_LIST_FAILED ALIVC_FRAMEWORK_AUDIO_PROCESS_OPTION_LIST_FAILED 调用后，播放器将处于暂停状态
Declaration
Objective-C

- (int)removeMusics;


                    
                    
                    -applyDub:

添加配音

Declaration

Objective-C

- (int)applyDub:(AliyunEffectDub *)dub;

Parameters

dub

配音对象支持变速功能 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_AUDIO_PROCESS_FILE_STREAM_LIST_FAILED ALIVC_FRAMEWORK_AUDIO_PROCESS_OPTION_LIST_FAILED 调用后，播放器将处于暂停状态


                    
                    
                    -removeDub:

移除配音

Declaration

Objective-C

- (int)removeDub:(AliyunEffectDub *)dub;

Parameters

dub

配音对象 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 调用后，播放器将处于暂停状态

-removeDubs
移除所有配音
Declaration
Objective-C

- (int)removeDubs;
Return Value

返回值调用后，播放器将处于暂停状态


                    
                    
                    -setAudioMixWeight:

设置混音权重

(int)setAudioWeight:(int)weight streamId:(int)streamId;
(int)setMainStreamsAudioWeight:(int)weight; @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_AUDIO_PROCESS_OPTION_LIST_FAILED

Declaration

Objective-C

- (int)setAudioMixWeight:(int)weight;

Parameters


                                weight

混音权重0-100 设为100时，主流权重为0，只有配乐设为0时，配乐流权重为0，只有原音设为50时，主流和配乐流权重都为100 如需单独调节每个流的音量权重，可以使用以下接口：


                    
                    
                    -setAudioWeight:streamId:

设置单路音频流音量权重

Declaration

Objective-C

- (int)setAudioWeight:(int)weight streamId:(int)streamId;

Parameters

`weight`	权重 0-100，100 代表原始大小
`streamId`	流id 主流id:AliyunClip.streamId 配乐流id：AliyunEffectMusic.effectVid MV音乐流id：AliyunEffectMV.audioEffectVid @return 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_AUDIO_PROCESS_OPTION_LIST_FAILED


                    
                    
                    -setMainStreamsAudioWeight:

设置主流音量权重

Declaration

Objective-C

- (int)setMainStreamsAudioWeight:(int)weight;

Parameters


                                weight

混音权重 0-100 100 代表原始大小 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE


                    
                    
                    -setAudioDenoise:streamId:

设置单路音频降噪

Declaration

Objective-C

- (int)setAudioDenoise:(BOOL)denoise streamId:(int)streamId;

Parameters

`denoise`	是否降噪，如果开启，降噪weight=20
`streamId`	流id AliyunEffectMusic流id：effectVid AliyunEffectMV流id：audioEffectVid @return 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_AUDIO_PROCESS_OPTION_LIST_FAILED


                    
                    
                    -setAudioDenoiseWeight:streamId:

设置单路音频降噪

Declaration

Objective-C

- (int)setAudioDenoiseWeight:(int)weight streamId:(int)streamId;

Parameters

`weight`	降噪权值 [0~100]，取0表示关闭，值越大降噪越厉害
`streamId`	流id AliyunEffectMusic流id：effectVid AliyunEffectMV流id：audioEffectVid @return 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_AUDIO_PROCESS_OPTION_LIST_FAILED


                    
                    
                    -setMainStreamsAudioDenoise:

设置主流音频降噪

Declaration

Objective-C

- (int)setMainStreamsAudioDenoise:(BOOL)denoise;

Parameters


                                denoise

是否降噪，如果开启，降噪weight=20 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE


                    
                    
                    -setMainStreamsAudioDenoiseWeight:

设置主流音频降噪

Declaration

Objective-C

- (int)setMainStreamsAudioDenoiseWeight:(int)weight;

Parameters


                                weight

降噪权值 [0~100]，取0表示关闭，值越大降噪越厉害 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE


                    
                    
                    -setAudioEffect:weight:streamId:

设置单路流音效

如果素材无音轨，该接口返回成功，但是没有效果

Declaration

Objective-C

- (int)setAudioEffect:(AliyunAudioEffectType)type
               weight:(int)weight
             streamId:(int)streamId;

Parameters

`type`	音效类型
`weight`	音效权重0-100
`streamId`	流id

Return Value

返回值


                    
                    
                    -removeAudioEffect:streamId:

去除单路流音效

Declaration

Objective-C

- (int)removeAudioEffect:(AliyunAudioEffectType)type streamId:(int)streamId;

Parameters

`type`	音效类型
`streamId`	流id

Return Value

返回值


                    
                    
                    -setMainStreamsAudioEffect:weight:

设置主流音效

如果素材无音轨，该接口返回成功，但是没有效果

Declaration

Objective-C

- (int)setMainStreamsAudioEffect:(AliyunAudioEffectType)type weight:(int)weight;

Parameters

`type`	音效类型
`weight`	音效权重0-100

Return Value

返回值


                    
                    
                    -removeMainStreamsAudioEffect:

去除主流音效

Declaration

Objective-C

- (int)removeMainStreamsAudioEffect:(AliyunAudioEffectType)typ;

Parameters

typ

音效类型

Return Value

返回值


                    
                    
                    -setAudioFadeInShape:duration:streamId:

API_AVAILABLE(3.20.0) 设置音频淡入，从音频0秒开始

Declaration

Objective-C

- (int)setAudioFadeInShape:(AliyunAudioFadeShape)shape
                  duration:(float)duration
                  streamId:(int)streamId;

Parameters

`streamId`	流ID
`shape`	曲线形状 @AliyunEditorAudioFadeShape
`duration`	作用时长（单位秒）

Return Value

正确返回0，错误返回错误码


                    
                    
                    -removeAudioFadeInWithStreamId:

API_AVAILABLE(3.20.0) 去除淡入效果

Declaration

Objective-C

- (int)removeAudioFadeInWithStreamId:(int)streamId;

Parameters


                                streamId

流ID

Return Value

返回值


                    
                    
                    -setMainStreamsAudioFadeInShape:duration:

API_AVAILABLE(3.20.0) 设置主流淡入效果

Declaration

Objective-C

- (int)setMainStreamsAudioFadeInShape:(AliyunAudioFadeShape)shape
                             duration:(float)duration;

Parameters

`shape`	曲线形状 @AliyunAudioFadeShape
`duration`	作用时长（单位秒）

Return Value

正确返回0，错误返回错误码

-removeMainStreamsAudioFadeIn
API_AVAILABLE(3.20.0) 去除主流淡入效果
Declaration
Objective-C

- (int)removeMainStreamsAudioFadeIn;
Return Value

返回值


                    
                    
                    -setAudioFadeOutShape:duration:streamId:

API_AVAILABLE(3.20.0) 设置音频淡出，到结束

Declaration

Objective-C

- (int)setAudioFadeOutShape:(AliyunAudioFadeShape)shape
                   duration:(float)duration
                   streamId:(int)streamId;

Parameters

`streamId`	流ID
`shape`	曲线形状 @AliyunAudioFadeShape
`duration`	作用时长（单位秒）

Return Value

正确返回0，错误返回错误码


                    
                    
                    -removeAudioFadeOutWithStreamId:

API_AVAILABLE(3.20.0) 去除淡出效果

Declaration

Objective-C

- (int)removeAudioFadeOutWithStreamId:(int)streamId;

Parameters


                                streamId

流ID

Return Value

返回值


                    
                    
                    -setMainStreamsAudioFadeOutShape:duration:

API_AVAILABLE(3.20.0) 设置主流淡出效果

Declaration

Objective-C

- (int)setMainStreamsAudioFadeOutShape:(AliyunAudioFadeShape)shape
                              duration:(float)duration;

Parameters

`shape`	曲线形状 @AliyunAudioFadeShape
`duration`	作用时长（单位秒）

Return Value

正确返回0，错误返回错误码

-removeMainStreamsAudioFadeOut
API_AVAILABLE(3.20.0) 去除主流淡出效果
Declaration
Objective-C

- (int)removeMainStreamsAudioFadeOut;
Return Value

返回值

Filter


                    
                    
                    -applyAnimationFilter:

使用特效滤镜

Declaration

Objective-C

- (int)applyAnimationFilter:(AliyunEffectFilter *)filter;

Parameters


                                filter

filter对象 @return 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID


                    
                    
                    -updateAnimationFilter:

更新特效滤镜

Declaration

Objective-C

- (int)updateAnimationFilter:(AliyunEffectFilter *)filter;

Parameters


                                filter

filter对象 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID ALIVC_FRAMEWORK_RENDER_ERROR_INVALID_OPTION


                    
                    
                    -removeAnimationFilter:

移除某个特效滤镜

Declaration

Objective-C

- (int)removeAnimationFilter:(AliyunEffectFilter *)filter;

Parameters


                                filter

filter对象 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID


                    
                    
                    -applyTimeFilter:

使用时间特效

Declaration

Objective-C

- (int)applyTimeFilter:(AliyunEffectTimeFilter *)filter;

Parameters


                                filter

特效对象 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 参数设置不正确 ALIVC_COMMON_INVALID_PARAM 特效不支持（多个流的情况下）ALIVC_SVIDEO_EDITOR_TIME_EFFECT_NOT_SUPPORT ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID ALIVC_FRAMEWORK_RENDER_ERROR_INVALID_OPTION ALIVC_FRAMEWORK_AUDIO_PROCESS_FILE_STREAM_LIST_FAILED ALIVC_FRAMEWORK_AUDIO_PROCESS_OPTION_LIST_FAILE 调用后，播放器将处于暂停状态


                    
                    
                    -removeTimeFilter:

API_AVAILABLE(3.7.0)

删除某一个时间特效目前只能删变速的时间特效

Declaration

Objective-C

- (int)removeTimeFilter:(AliyunEffectTimeFilter *)filter;

Parameters


                                filter

待删除的时间特效 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 调用后，播放器将处于暂停状态

-removeTimeFilter
删除全部的时间特效

正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID ALIVC_FRAMEWORK_AUDIO_PROCESS_FILE_STREAM_LIST_FAILED ALIVC_FRAMEWORK_AUDIO_PROCESS_OPTION_LIST_FAILED] 调用后，播放器将处于暂停状态
Declaration
Objective-C

- (int)removeTimeFilter;
-getTimeFilter
获取当前的时间特效类型
Declaration
Objective-C

- (int)getTimeFilter;
Return Value

时间特效种类 TIME_EFFECT_NONE = 0, 无效果 TIME_EFFECT_SPEED = 1,加速或者减速 TIME_EFFECT_REPEAT = 2,反复 TIME_EFFECT_INVERT = 3 倒放

Animation


                    
                    
                    -add:withFrameAnimation:

API_AVAILABLE(3.7.0)

加帧动画

注意：1.主流不支持alpha帧动画 2.在倒播特效下，不支持此功能

Declaration

Objective-C

- (int)add:(id<AliyunActionProtocol>)obj
    withFrameAnimation:(AliyunAction *)action;

Parameters

`obj`	动画作用的对象
`action`	动画 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 错误发生 ALIVC_COMMON_RETURN_FAILED


                    
                    
                    -remove:withFrameAnimation:

API_AVAILABLE(3.7.0)

删帧动画

Declaration

Objective-C

- (int)remove:(id<AliyunActionProtocol>)obj
    withFrameAnimation:(AliyunAction *)action;

Parameters

`obj`	动画作用的对象
`action`	动画 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 错误发生 ALIVC_COMMON_RETURN_FAILED

Deprecated


                    
                    
                    -applyPaint:

Deprecated

please use applyPaint:linesData:

使用涂鸦

Declaration

Objective-C

- (int)applyPaint:(AliyunEffectImage *)paintImage;

Parameters


                                paintImage

涂鸦图片 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 文件不存在 ALIVC_SVIDEO_EDITOR_FILE_NOT_EXIST 图片类型不支持 ALIVC_SVIDEO_EDITOR_VIEW_TYPE_NOT_SUPPORTED

delegate
Deprecated

please use playerCallback/exporterCallback/RenderCallback

播放，合成，渲染回调类已经废弃
Declaration
Objective-C

@property (nonatomic, weak) id<AliyunIPlayerCallback, AliyunIExporterCallback, AliyunIRenderCallback> delegate;


                    
                    
                    -applyStaticImage:

Deprecated

please use getStickerManager, addImage:startTime:duration:

加入静态贴纸已废弃

Declaration

Objective-C

- (int)applyStaticImage:(AliyunEffectStaticImage *)staticImage;

Parameters


                                staticImage

静态贴纸 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE 文件不存在 ALIVC_SVIDEO_EDITOR_FILE_NOT_EXIST 图片类型不支持 ALIVC_SVIDEO_EDITOR_VIEW_TYPE_NOT_SUPPORTED


                    
                    
                    -removeStaticImage:

Deprecated

please use getStickerManager, remove:

移除静态贴纸已废弃

Declaration

Objective-C

- (int)removeStaticImage:(AliyunEffectStaticImage *)staticImage;

Parameters


                                staticImage

静态贴纸 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID


                    
                    
                    -applyRunningDisplayMode:

Deprecated

deprecated, will remove

API_AVAILABLE(3.7.0)

添加动态播放模式已废弃

Declaration

Objective-C

- (void)applyRunningDisplayMode:(AliyunEffectRunningDisplayMode *)mode;

Parameters


                                mode

播放模式


                    
                    
                    -removeRunningDisplayMode:

Deprecated

deprecated, will remove

API_AVAILABLE(3.7.0)

删除动态播放模式已废弃

Declaration

Objective-C

- (void)removeRunningDisplayMode:(AliyunEffectRunningDisplayMode *)mode;

Parameters


                                mode

播放模式

-getRequestId
Deprecated

deprecated, will remove

request id
Declaration
Objective-C

- (NSString *)getRequestId;
+version
Deprecated

deprecated, will remove

版本号
Declaration
Objective-C

+ (NSString *)version;


                    
                    
                    -setMaxCacheSize:

Deprecated

deprecated, will remove

设置最大内存缓存大小默认值250Mb，建议200M以上必须在startEdit之前或stopEdit后才能生效

Declaration

Objective-C

- (void)setMaxCacheSize:(int)cacheSize;

Parameters


                                cacheSize

内存缓存大小，单位：byte

-getMaxCacheSize
Deprecated

deprecated, will remove

获取当前设置的最大内存缓存大小
Declaration
Objective-C

- (int)getMaxCacheSize;
Return Value

内存缓存大小


                    
                    
                    -getMaxEstimatedCacheSize:

Deprecated

deprecated, will remove

获取视频需要的最大内存缓存大小已废弃判断视频是否支持倒播，可以通过[AliyunNativeParser getGopSize]获取gop 建议gop > 35的视频倒播转码

Declaration

Objective-C

- (int)getMaxEstimatedCacheSize:(NSString *)path;

Parameters


                                path

视频路径

Return Value

内存缓存大小


                    
                    
                    -prepare:

Deprecated

deprecated, will remove

准备播放预解码部分音视频数据，加快起播速度

Declaration

Objective-C

- (int)prepare:(AliyunEditorMode)mode;

Parameters


                                mode

编辑模式 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 参数不正确 ALIVC_COMMON_INVALID_PARAM 已废弃，无需调用


                    
                    
                    -addPath:startTime:duration:fadeDuration:inDuration:outDruation:mode:

Deprecated

Use IClipConstructor

添加视频路径返回值为streamId

Declaration

Objective-C

- (int)addPath:(NSString *)path
       startTime:(float)startTime
        duration:(float)duration
    fadeDuration:(float)fadeDuration
      inDuration:(float)inDuration
     outDruation:(float)outDuration
            mode:(int)mode;

Parameters


                                path

视频路径 Deprecated 建议使用getClipConstructor


                    
                    
                    -addImagePath:duration:fadeDuration:inAnimateDuration:outAnimateDuration:mode:

Deprecated

Use IClipConstructor

添加图片路径返回值为streamId

Declaration

Objective-C

- (int)addImagePath:(NSString *)path
              duration:(float)duration
          fadeDuration:(float)fadeDuration
     inAnimateDuration:(float)inDuration
    outAnimateDuration:(float)outDuration
                  mode:(int)mode;

Parameters


                                path

图片路径 Deprecated 建议使用getClipConstructor获取IClipConstructor进行管理

-getVideoUrls
Deprecated

Use IClipConstructor

获取所有播放的视频的本地路径
Declaration
Objective-C

- (NSArray *)getVideoUrls;
Return Value

路径数组 Deprecated 建议使用getClipConstructor获取IClipConstructor进行管理
-getMediaClips
Deprecated

Use IClipConstructor

获取媒体片段
Declaration
Objective-C

- (NSArray *)getMediaClips;
Return Value

媒体片段数组 Deprecated 建议使用getClipConstructor获取IClipConstructor进行管理


                    
                    
                    -setClipFadeDuration:inDuration:outDuration:atIndex:

Deprecated

Use IClipConstructor

设置转场时长

Declaration

Objective-C

- (int)setClipFadeDuration:(CGFloat)fadeDuration
                inDuration:(CGFloat)inDuration
               outDuration:(CGFloat)outDuration
                   atIndex:(NSInteger)index;

Parameters

`fadeDuration`	转场时长
`inDuration`	暂时无效
`outDuration`	暂时无效
`index`	视频index

Return Value

返回结果本接口弃用，返回值为0 第一段视频设置无效,转场时长不能超过最短视频时长的一半 Deprecated 建议使用getClipConstructor获取IClipConstructor进行管理


                    
                    
                    -setTailWaterMark:frame:duration:

Deprecated

use setTailWaterMark:(AliyunEffectImage *)waterMark

添加片尾水印

Declaration

Objective-C

- (int)setTailWaterMark:(UIImage *)image
                  frame:(CGRect)frame
               duration:(CGFloat)duration;

Parameters

`image`	图片
`frame`
`duration`	时长

Return Value

返回值为片尾id或错误码详细：如果返回值范围为 >0 && < ALIVC_FRAMEWORK_ERROR_START，则为片尾id；否则为错误码。


                    
                    
                    -setWaterMark:frame:

Deprecated

use setWaterMark:(AliyunEffectImage *)waterMark

添加视频水印

Declaration

Objective-C

- (int)setWaterMark:(NSString *)imagePath frame:(CGRect)frame;

Parameters

`imagePath`	视频水印路径
`frame`	水印frame

Return Value

返回值为水印id或者错误码详细：如果返回值范围为 >0 && < ALIVC_FRAMEWORK_ERROR_START，则为水印id；否则为错误码。

-getPasterManager
Deprecated

use getStickerManager

获取贴图管理类
Declaration
Objective-C

- (AliyunPasterManager *)getPasterManager;
Return Value

AliyunPasterManager
-getPasterRender
Deprecated

use getStickerManager

获取PasterRender实例
Declaration
Objective-C

- (id<AliyunIPasterRender>)getPasterRender;
Return Value

PasterRender


                    
                    
                    -applyFilter:

Deprecated

use getFilterManager

使用滤镜

Declaration

Objective-C

- (int)applyFilter:(AliyunEffectFilter *)filter;

Parameters


                                filter

filter对象 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID ALIVC_FRAMEWORK_RENDER_ERROR_INVALID_OPTION

-removeFilter
Deprecated

use getFilterManager

删除滤镜 @return 正常返回 ALIVC_COMMON_RETURN_SUCCESS 状态不正确 ALIVC_COMMON_INVALID_STATE ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID ALIVC_FRAMEWORK_RENDER_ERROR_INVALID_OPTION
Declaration
Objective-C

- (int)removeFilter;