Protocols

Objective-C

@protocol AliyunAETemplatePlayerDelegate <NSObject>

Objective-C

@protocol AliyunAETemplateRenderDelegate <NSObject>

Objective-C

@protocol AliyunActionProtocol <NSObject>

Objective-C

@protocol AliyunAudioRecordController <AliyunRecordController>

Objective-C

@protocol AliyunAudioRecorderDelegate <NSObject>

Objective-C

@protocol AliyunCameraRecordController <AliyunVideoRecordController>

Objective-C

@protocol AliyunCropDelegate <NSObject>

Objective-C

@protocol AliyunDraftManagerDelegate <NSObject>
/****
 The event for draft list did change
 */
- (void) onAliyunDraftManager:(AliyunDraftManager *)mgr listDidChange:(NSArray<AliyunDraft *> *)list;
@end

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

Objective-C

@protocol AliyunEditorRenderWrapperDelegate <NSObject>

Objective-C

@protocol AliyunFrameAnimationProtocol <NSObject>

/****
 add frame animation.
 
 @param action @see AliyunAction.
 */
- (int)addFrameAnimation:(AliyunAction *)action;


/****
 remove frame animation.
 
 @param action @see AliyunAction.
 */
- (int)removeFrameAnimation:(AliyunAction *)action;

@end

Objective-C

@protocol AliyunICanvasViewDelegate <NSObject>

/****
 Starts drawing.
 
 @param startPoint The start point.
 */
- (void)startDrawingWithCurrentPoint:(CGPoint)startPoint;

/****
 Ends drawing.
 
 @param endPoint The end point.
 */
- (void)endDrawingWithCurrentPoint:(CGPoint)endPoint;
@end

Objective-C

@protocol AliyunIClipConstructor <NSObject>

Objective-C

@protocol AliyunIEffectRecovery <NSObject>

/****
 Initializer. This method is automatically invoked after the effect is restored from the JSON configuration file.

 @param dict The initialization parameter.
 @return An effect object.
 */
- (id)initWithRestore:(NSDictionary *)dict;

/****
 Creates a copy of an object.

 @return An object copy.
 */
- (id)copyAnother;

@end

Objective-C

@protocol AliyunIExporter <NSObject>
/****
 Sets a watermark.
 
 @param waterMark The watermark image.
 @return
 ALIVC_COMMON_RETURN_SUCCESS if the invocation is successful.
 ALIVC_COMMON_INVALID_STATE if the exporter's state is incorrect.
 ALIVC_SVIDEO_EDITOR_FILE_NOT_EXIST if the image file does not exist.
 ALIVC_SVIDEO_EDITOR_VIEW_TYPE_NOT_SUPPORTED if the image type is not supported.
 */
- (int)setWaterMark:(AliyunEffectImage *)waterMark;

/****
 Sets a watermark to the end of the video.
 
 @param waterMark The watermark image.
 @return
 ALIVC_COMMON_RETURN_SUCCESS if the invocation is successful.
 ALIVC_COMMON_INVALID_STATE if the exporter's state is incorrect.
 ALIVC_SVIDEO_EDITOR_FILE_NOT_EXIST if the image file does not exist.
 ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID
 ALIVC_FRAMEWORK_RENDER_ERROR_INVALID_OPTION
 */
- (int)setTailWaterMark:(AliyunEffectImage *)waterMark;

/****
 Sets the encoding mode.
 
 Hardware encoding is required in iOS.
 @param encodeMode The encoding mode. See the codecType in AliyunVideoParam.
 */
- (void)setEncodeMode:(AliyunVideoCodecType)encodeMode;

/****
 Sets the video output parameter.
 
 @param videoParam The output parameter.
 */
- (void)setVideoParam:(AliyunVideoParam *)videoParam;

/****
 Sets whether to cancel exporting when the app is set to run in the background.
 
 YES indicates cancel exporting. No indicates pause exporting. Default is NO.
 @param flag
 */
- (void)setCancelExportInResignActive:(BOOL)flag;

/****
 Starts exporting.
 
 @param outputPath The video output path. 
 @return
 ALIVC_COMMON_RETURN_SUCCESS if the invocation is successful.
 ALIVC_COMMON_INVALID_STATE if the exporter's state is incorrect.
 ALIVC_COMMON_INVALID_PARAM if the parameter setting is incorrect.
 ALIVC_SVIDEO_EDITOR_INIT_FAILED if an error occurred during component initialization.
 ALIVC_FRAMEWORK_AUDIO_PROCESS_CREATE_FAILED
 ALIVC_FRAMEWORK_AUDIO_PROCESS_RE_CREATE
 ALIVC_FRAMEWORK_RENDER_ERROR_SCENE_INVALID
 */
- (int)startExport:(NSString *)outputPath;

/****
 Pauses exporting.
 
 @return
 ALIVC_COMMON_RETURN_SUCCESS if the invocation is successful.
 ALIVC_COMMON_INVALID_STATE if the exporter's state is incorrect.
 */
- (int)pauseExport;

/****
 Resumes exporting.
 
 @return
 ALIVC_COMMON_RETURN_SUCCESS if the invocation is successful.
 ALIVC_COMMON_INVALID_STATE if the exporter's state is incorrect.
 */
- (int)resumeExport;

/****
 Cancels exporting.
 
 @return
 ALIVC_COMMON_RETURN_SUCCESS if the invocation is successful.
 ALIVC_COMMON_INVALID_STATE if the exporter's state is incorrect.
 */
-(int)cancelExport;

@optional
/****
 Adds a watermark to the end of the video.
 
 @param image The watermark image.
 @return The watermark id or an error code.
 */
- (int)setTailWaterMark:(UIImage *)image frame:(CGRect)frame duration:(CGFloat)duration __deprecated_msg("use setWaterMark:(AliyunEffectImage *)waterMark in AliyunEditor");
@end

Objective-C

@protocol AliyunIExporterCallback <NSObject>

Objective-C

@protocol AliyunIStreamExporterCallback <NSObject>

Objective-C

@protocol AliyunIPasterRender <NSObject>

Objective-C

@protocol AliyunIPlayer <NSObject>

Objective-C

@protocol AliyunIPlayerCallback <NSObject>

Objective-C

@protocol AliyunIRenderCallback <NSObject>

Objective-C

@protocol AliyunIRecorderDelegate <NSObject>

Objective-C

@protocol AliyunIStickerRender <NSObject>


/****
 Adds a sticker. API_AVAILABLE(3.22.0)
 
 @param sticker AliyunGifSticker/AliyunCaptionSticker
 @return status
 */
- (int)addSticker:(AliyunSticker *)sticker;


/****
 Remove a sticker. API_AVAILABLE(3.22.0)
 
 @param sticker AliyunGifSticker/AliyunCaptionSticker
 @return status
 */
- (int)removeSticker:(AliyunSticker *)sticker;


/****
 update a sticker. API_AVAILABLE(3.22.0)
 
 @param sticker AliyunGifSticker/AliyunCaptionSticker
 @return status
 */
- (int)updateSticker:(AliyunSticker *)sticker;

@end

Objective-C

@protocol AliyunMicRecordController <AliyunAudioRecordController>

Objective-C

@protocol AlivcMixComposerDelegate <NSObject>

- (void)mixComposerOnProgress:(float)progress;
- (void)mixComposerDidComplete;
- (void)mixComposerDidError:(int)error;

@end

Objective-C

@protocol AliyunMixRecorderDelegate <AliyunIRecorderDelegate>

/****
 The callback when the composition process is started.
 */
- (void)mixRecorderComposerDidStart;

/****
 The callback that outputs the progress of composition.

 @param progress The progress.
 */
- (void)mixRecorderComposerOnProgress:(CGFloat)progress;

/****
 The callback when the composition process is complete.
 */
- (void)mixRecorderComposerDidComplete;

/****
 The callback when an error occurs during the composition process.

 @param errorCode The error code.
 */
- (void)mixRecorderComposerDidError:(int)errorCode;

@end

Objective-C

@protocol AliyunPasterManagerDelegate <NSObject>

Objective-C

@protocol AliyunPasterUIEventProtocol <NSObject>

Objective-C

@protocol AliyunPlayerRecordController <AliyunVideoBaseRecordController,
                                        AliyunAudioRecordController>

Objective-C

@protocol AliyunRecordControllerCustomSourceHandler <NSObject>

Objective-C

@protocol AliyunRecordController <NSObject>

Objective-C

@protocol AliyunRecordSource <NSObject>

Objective-C

@protocol AliyunRecordDataSourceDelegate <NSObject>

Objective-C

@protocol AliyunRecordDataSource <AliyunRecordSource>

Objective-C

@protocol AliyunRecordFileSource <AliyunRecordSource>

Objective-C

@protocol AliyunRecordSourceFPS <NSObject>

Objective-C

@protocol AliyunRecorderDelegate <NSObject>

Objective-C

@protocol AliyunRecorderCustomRender <NSObject>

Objective-C

@protocol AliyunRenderBaseControllerEditProtocol <NSObject>

/****
 start edit; be used for merge multi modify API_AVAILABLE(3.22.0)
 */
- (void) beginEdit;
/****
 end edit; be used for apply all the modify between begin and end API_AVAILABLE(3.22.0)
 */
- (void) endEdit;
/****
 cancel edit; be used for reback the state before call the begin edit API_AVAILABLE(3.22.0)
 */
- (void) cancelEdit;

@end

Objective-C

@protocol AliyunThumbnailParserDelegate <NSObject>

/****
 onError when get pic, call back not in main thread. API_AVAILABLE(3.20.0)
 
 @param code the errorcode.
 */
- (void)thumbnailParser:(AliyunThumbnailParser *)parser onError:(int)code;


/****
 onError when get pic, call back not in main thread. API_AVAILABLE(3.20.0)
 
 @param code the errorcode
 @param time the timestampe of the video to get pic, unit: seconds
 */
- (void)thumbnailParser:(AliyunThumbnailParser *)parser onPicError:(int)code time:(float)time;


/****
 the image get of the time, call back not in main thread. API_AVAILABLE(3.20.0)
 
 @param image the image, noneable, maybe nil
 @param time the timestampe of the video to get pic, unit: seconds
 */
- (void)thumbnailParser:(AliyunThumbnailParser *)parser onGetPicture:(UIImage *)image time:(float)time;

/****
 compelete all image to get in timelist, call back not in main thread. API_AVAILABLE(3.20.0)
 */
- (void)thumbnailParserOnCompleted:(AliyunThumbnailParser *)parser;


@end

Objective-C

@protocol AliyunVideoLicenseEventDelegate <NSObject>

Objective-C

@protocol AliyunVideoSourceOrientation <NSObject>

Objective-C

@protocol AliyunVideoBaseRecordController <AliyunRecordController>

Objective-C

@protocol AliyunVideoRecordController <AliyunVideoBaseRecordController>

Objective-C

@protocol AliyunViewRecordController <AliyunVideoBaseRecordController>