Protocols

The following protocols are available globally.

  • 播放回调 API_AVAILABLE(3.35.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunAETemplatePlayerDelegate <NSObject>
  • 渲染回调 API_AVAILABLE(3.35.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunAETemplateRenderDelegate <NSObject>
  • 帧动画协议

    See more

    Declaration

    Objective-C

    @protocol AliyunActionProtocol <NSObject>
  • 音频控制器 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunAudioRecordController <AliyunRecordController>
  • 音频录制回调协议

    See more

    Declaration

    Objective-C

    @protocol AliyunAudioRecorderDelegate <NSObject>
  • 摄像头控制器 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunCameraRecordController <AliyunVideoRecordController>
  • 裁剪回调协议

    See more

    Declaration

    Objective-C

    @protocol AliyunCropDelegate <NSObject>
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AliyunDraftManagerDelegate <NSObject>
    /**
     草稿列表发生变化
     */
    - (void) onAliyunDraftManager:(AliyunDraftManager *)mgr listDidChange:(NSArray<AliyunDraft *> *)list;
    @end
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AliyunEditorDelegate <NSObject>
    @optional
    - (void) onEditor:(AliyunEditor *)editor editingDidChange:(BOOL)isEditing;
    - (void) onEditor:(AliyunEditor *)editor loadingDidChange:(BOOL)isLoading;
    - (void) onEditor:(AliyunEditor *)editor loadError:(NSError *)error;
    @end
  • 编辑器内容视图回调 API_AVAILABLE(3.25.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunEditorRenderWrapperDelegate <NSObject>
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AliyunFrameAnimationProtocol <NSObject>
    
    /**
     添加帧动画效果
     
     @param action 动画参数,@see AliyunAction.
     */
    - (int)addFrameAnimation:(AliyunAction *)action;
    
    
    /**
     移除帧动画效果
     
     @param action 动画参数,@see AliyunAction.
     */
    - (int)removeFrameAnimation:(AliyunAction *)action;
    
    @end
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AliyunICanvasViewDelegate <NSObject>
    
    /**
     开始画图
    
     @param startPoint 开始point
     */
    - (void)startDrawingWithCurrentPoint:(CGPoint)startPoint;
    
    /**
     结束画图
    
     @param endPoint 结束point
     */
    - (void)endDrawingWithCurrentPoint:(CGPoint)endPoint;
    @end
  • 媒体片段构造器协议

    See more

    Declaration

    Objective-C

    @protocol AliyunIClipConstructor <NSObject>
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AliyunIEffectRecovery <NSObject>
    
    /**
     初始化方法 内部从json文件恢复后调用此方法
    
     @param dict 初始化参数
     @return 实例对象
     */
    - (id)initWithRestore:(NSDictionary *)dict;
    
    /**
     拷贝对象
    
     @return 拷贝后的对象
     */
    - (id)copyAnother;
    
    @end
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AliyunIExporter <NSObject>
    /**
     设置水印
    
     @param waterMark 水印
     @return
     正常返回 ALIVC_COMMON_RETURN_SUCCESS
     状态不正确 ALIVC_COMMON_INVALID_STATE
     文件不存在 ALIVC_SVIDEO_EDITOR_FILE_NOT_EXIST
     图片类型不支持 ALIVC_SVIDEO_EDITOR_VIEW_TYPE_NOT_SUPPORTED
     */
    - (int)setWaterMark:(AliyunEffectImage *)waterMark;
    
    /**
     设置片尾水印
    
     @param 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
     */
    - (int)setTailWaterMark:(AliyunEffectImage *)waterMark;
    
    /**
     设置编码模式
    
     iOS强制硬编
     @param encodeMode 编码模式 参见AliyunVideoParam中codecType的定义
     */
    - (void)setEncodeMode:(AliyunVideoCodecType)encodeMode;
    
    /**
     设置视频输出参数
    
     @param videoParam 视频输出参数
     */
    - (void)setVideoParam:(AliyunVideoParam *)videoParam;
    
    /**
     设置退后台是否取消导出合成
    
     默认值NO:退后台暂停合成,回到前台继续合成,YES:退后台取消合成
     @param flag flag
     */
    - (void)setCancelExportInResignActive:(BOOL)flag;
    
    /**
     开始导出视频
    
     @param outputPath 导出视频文件路径,需要保证多级目录文件夹已经创建
     @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
     */
    - (int)startExport:(NSString *)outputPath;
    
    /**
     暂停导出视频
    
     @return
     正常返回 ALIVC_COMMON_RETURN_SUCCESS
     状态不正确 ALIVC_COMMON_INVALID_STATE
     */
    - (int)pauseExport;
    
    /**
     继续导出视频
    
     @return 
     正常返回 ALIVC_COMMON_RETURN_SUCCESS
     状态不正确 ALIVC_COMMON_INVALID_STATE
     */
    - (int)resumeExport;
    
    /**
     取消导出视频
     
     @return
     正常返回 ALIVC_COMMON_RETURN_SUCCESS
     状态不正确 ALIVC_COMMON_INVALID_STATE
     */
    -(int)cancelExport;
    
    @optional
    /**
     添加片尾水印
    
     @param image 水印图片
     @return 返回值为片尾id或者错误码 详细:如果返回值范围为 >0  && < ALIVC_FRAMEWORK_ERROR_START, 则为片尾水印id;否则为错误码。
     */
    - (int)setTailWaterMark:(UIImage *)image frame:(CGRect)frame duration:(CGFloat)duration __deprecated_msg("use setWaterMark:(AliyunEffectImage *)waterMark in AliyunEditor");
    @end
  • 编辑合成导出回调协议

    See more

    Declaration

    Objective-C

    @protocol AliyunIExporterCallback <NSObject>
  • 实时流导出

    See more

    Declaration

    Objective-C

    @protocol AliyunIStreamExporterCallback <NSObject>
  • 动图渲染协议

    See more

    Declaration

    Objective-C

    @protocol AliyunIPasterRender <NSObject>
  • 播放器协议

    See more

    Declaration

    Objective-C

    @protocol AliyunIPlayer <NSObject>
  • 播放器回调协议

    See more

    Declaration

    Objective-C

    @protocol AliyunIPlayerCallback <NSObject>
  • 渲染回调协议

    See more

    Declaration

    Objective-C

    @protocol AliyunIRenderCallback <NSObject>
  • 录制回调协议

    See more

    Declaration

    Objective-C

    @protocol AliyunIRecorderDelegate <NSObject>
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AliyunIStickerRender <NSObject>
    
    
    /**
     添加动图 API_AVAILABLE(3.22.0)
     
     @param sticker 动图数据对象,AliyunGifSticker/AliyunCaptionSticker
     @return 返回状态码
     */
    - (int)addSticker:(AliyunSticker *)sticker;
    
    
    /**
     移除动图 API_AVAILABLE(3.22.0)
     
     @param sticker 动图数据对象,AliyunGifSticker/AliyunCaptionSticker
     @return 返回状态码
     */
    - (int)removeSticker:(AliyunSticker *)sticker;
    
    
    /**
     更新动图 API_AVAILABLE(3.22.0)
     
     @param sticker 动图数据对象,AliyunGifSticker/AliyunCaptionSticker
     @return 返回状态码
     */
    - (int)updateSticker:(AliyunSticker *)sticker;
    
    @end
  • 麦克风控制器 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunMicRecordController <AliyunAudioRecordController>
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AlivcMixComposerDelegate <NSObject>
    
    - (void)mixComposerOnProgress:(float)progress;
    - (void)mixComposerDidComplete;
    - (void)mixComposerDidError:(int)error;
    
    @end
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AliyunMixRecorderDelegate <AliyunIRecorderDelegate>
    
    /**
     mixRecord的视频拼接开始
     */
    - (void)mixRecorderComposerDidStart;
    
    /**
     mixRecord的视频拼接进度
    
     @param progress 进度
     */
    - (void)mixRecorderComposerOnProgress:(CGFloat)progress;
    
    /**
     mixRecord的视频拼接完成
     */
    - (void)mixRecorderComposerDidComplete;
    
    /**
     mixRecord的视频拼接异常错误
    
     @param errorCode 错误码
     */
    - (void)mixRecorderComposerDidError:(int)errorCode;
    
    @end
  • Deprecated

    please use AliyunStickerManager

    已废弃,请使用AliyunStickerManager

    See more

    Declaration

    Objective-C

    @protocol AliyunPasterManagerDelegate <NSObject>
  • 动图UI事件回调协议

    See more

    Declaration

    Objective-C

    @protocol AliyunPasterUIEventProtocol <NSObject>
  • Deprecated

    please use AliyunAVFileRecordController

    视频播放的录制控制器 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunPlayerRecordController <AliyunVideoBaseRecordController,
                                            AliyunAudioRecordController>
  • 自定义数据源数据处理 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunRecordControllerCustomSourceHandler <NSObject>
  • 录制源的控制器 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunRecordController <NSObject>
  • 录制源协议 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunRecordSource <NSObject>
  • 数据流的采集回调 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunRecordDataSourceDelegate <NSObject>
  • 数据流类型的采集源 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunRecordDataSource <AliyunRecordSource>
  • 文件类型的采集源 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunRecordFileSource <AliyunRecordSource>
  • 动态帧率的协议 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunRecordSourceFPS <NSObject>
  • 录制事件回调 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunRecorderDelegate <NSObject>
  • 自定义渲染回调 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunRecorderCustomRender <NSObject>
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AliyunRenderBaseControllerEditProtocol <NSObject>
    
    /**
     开始编辑;用于合并多个属性修改; API_AVAILABLE(3.22.0)
     */
    - (void) beginEdit;
    /**
     结束编辑;用于把从beginEdit到endEdit之间的修改最终生效 API_AVAILABLE(3.22.0)
     */
    - (void) endEdit;
    /**
     取消编辑:用于把状态恢复到beginEdit之前 API_AVAILABLE(3.22.0)
     */
    - (void) cancelEdit;
    
    @end
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AliyunThumbnailParserDelegate <NSObject>
    
    /**
     获取出错,注意在子线程回调,而不是主线程 API_AVAILABLE(3.20.0)
     
     @param code 错误码.
     */
    - (void)thumbnailParser:(AliyunThumbnailParser *)parser onError:(int)code;
    
    
    /**
     获取某张图片出错,注意在子线程回调,而不是主线程 API_AVAILABLE(3.20.0)
     
     @param code 错误码
     @param time 时间戳,单位:秒
     */
    - (void)thumbnailParser:(AliyunThumbnailParser *)parser onPicError:(int)code time:(float)time;
    
    
    /**
     获取到的图片,注意在子线程回调,而不是主线程 API_AVAILABLE(3.20.0)
     
     @param image 图片,可能是nil,需要做判断
     @param time 时间戳,单位:秒
     */
    - (void)thumbnailParser:(AliyunThumbnailParser *)parser onGetPicture:(UIImage *)image time:(float)time;
    
    /**
     完成所有图片的获取,注意在子线程回调,而不是主线程 API_AVAILABLE(3.20.0)
     */
    - (void)thumbnailParserOnCompleted:(AliyunThumbnailParser *)parser;
    
    
    @end
  • 短视频证书相关事件通知

    See more

    Declaration

    Objective-C

    @protocol AliyunVideoLicenseEventDelegate <NSObject>
  • 根据机器方向判断旋转的协议 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunVideoSourceOrientation <NSObject>
  • 基础视频控制器 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunVideoBaseRecordController <AliyunRecordController>
  • 全功能的视频控制器 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunVideoRecordController <AliyunVideoBaseRecordController>
  • 视图源控制器 API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @protocol AliyunViewRecordController <AliyunVideoBaseRecordController>