Classes

The following classes are available globally.

deprecated enums and classes

  • Deprecated

    Undocumented

    See more

    Declaration

    Objective-C

    @interface AliyunErrorCode : NSObject
    
    + (AliyunIErrorCode)code:(int)err __deprecated_msg("use AliyunVideoCoreError instead");
    
    @end
  • Deprecated

    deprecated

    * A class that handles errors.

    See more

    Declaration

    Objective-C

    
    @interface AliyunErrorLogger : NSObject
  • Deprecated

    deprecated

    Undocumented

    See more

    Declaration

    Objective-C

    @interface AliyunEventManager : NSObject
    
    @property(nonatomic, copy) NSString *requestID;
    @property(nonatomic, assign) BOOL enabled;
    
    + (instancetype)sharedManager;
    
    - (void)sendEvent:(AliyunEvent)event params:(NSDictionary *)params;
    
    - (void)sendEvent:(AliyunEvent)event params:(NSDictionary *)params type:(AliyunSubmoduleType)type;
    
    + (AliyunVideoEventInfo)videoInfoWithPath:(NSString *)path;
    
    - (uint64_t)crc64WithPath:(NSString *)path;
    
    - (void)refreshRequestID;
    
    @end
  • * The point of face info

    See more

    Declaration

    Objective-C

    @interface AliyunFacePoint : NSObject
  • * API_AVAILABLE(3.27.0) The manager of filter.

    See more

    Declaration

    Objective-C

    @interface AliyunFilterManager : NSObject
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AliyunGifSticker : AliyunSticker <NSCopying>
  • * The controller of git sticker API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunGifStickerController : AliyunStickerController
  • Deprecated

    deprecated

    * A class that defines HTTP requests. Deprecated.

    See more

    Declaration

    Objective-C

    
    @interface AliyunHttpClient : NSObject

    Return Value

    AliyunHttpClient

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AliyunICanvasLineData : NSObject
    
    /****
     The color of the paint brush.
     */
    @property (nonatomic, strong, readonly) UIColor *lineColor;
    /****
     The size of the paint brush.
     */
    @property (nonatomic, assign, readonly) CGFloat lineWidth;
    /****
     The color of the shadow.
     */
    @property (nonatomic, strong, readonly) UIColor *shadowColor;
    /****
     The size of the shadow.
     */
    @property (nonatomic, assign, readonly) CGFloat shadowWidth;
    /****
     The points of line
     */
    @property (nonatomic, copy, readonly) NSArray<NSValue *> *points;
    
    @end
  • * The canvas view.

    See more

    Declaration

    Objective-C

    @interface AliyunICanvasView
  • * A class that defines paint brushes.

    See more

    Declaration

    Objective-C

    @interface AliyunIPaint : NSObject
  • * A class that defines recorders.

    See more

    Declaration

    Objective-C

    @interface AliyunIRecorder : NSObject
  • * A class that defines image croppers.

    See more

    Declaration

    Objective-C

    @interface AliyunImageCrop : NSObject
  • * the sticker of image API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunImageSticker : AliyunSticker <NSCopying>
  • * The controller of image sticker API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunImageStickerController : AliyunStickerController
  • * A class that defines importers. Use this class to create configuration files for importing media clips. The class implements the AliyunIClipConstructor protocol to configure media clips.

    See more

    Declaration

    Objective-C

    @interface AliyunImporter : AliyunClipConstructor
  • Deprecated

    * Deprecated.

    See more

    Declaration

    Objective-C

    
    @interface AliyunJSONModel : NSObject
  • * API_AVAILABLE(3.27.0) The lookup filter data model.

    See more

    Declaration

    Objective-C

    @interface AliyunLutFilter : AliyunBaseFilter
  • * API_AVAILABLE(3.27.0) The lookup filter controller.

    See more

    Declaration

    Objective-C

    @interface AliyunLutFilterController : AliyunBaseFilterController
  • Deprecated

    deprecated

    Undocumented

    Declaration

    Objective-C

    @interface AliyunMediaInfo : NSObject
    
    @end
  • * The source of mic and source of device API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunMicRecordSource : NSObject <AliyunRecordDataSource>
  • * VideoJoiner

    See more

    Declaration

    Objective-C

    @interface AliyunMixComposer : NSObject
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AliyunMixMediaVideoInfo : NSObject
    
    /****
     The level of video view layer
     Bigger value above on lesser value layer
     If same value, the record video above on file video.
     */
    @property (nonatomic, assign) NSInteger layerLevel;
    
    /****
     The border info of the video
     */
    @property (nonatomic, strong) AliyunPureColorBorderInfo *borderInfo;
    
    /****
     The layout of the video in mix video
     */
    @property (nonatomic, assign) CGRect frame;
    @end
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AliyunMixMediaRecordVideoInfo: AliyunMixMediaVideoInfo
    /****
     The resolution of the video
     */
    @property (nonatomic, assign) CGSize resolution;
    @end
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AliyunMixMediaFileVideoInfo : AliyunMixMediaVideoInfo
    /****
     The file path of the video
     */
    @property (nonatomic, copy) NSString *filePath;
    
    /****
     The start time of the sample video of the duet.
     */
    @property (nonatomic, assign) CGFloat streamStartTime;
    
    /****
     The end time of the sample video of the duet.
     */
    @property (nonatomic, assign) CGFloat streamEndTime;
    @end
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AliyunMixMediaInfoParam : NSObject
    
    /****
     The view of the duet. Required. 
     */
    @property(nonatomic, strong) UIView *outputSizeView;
    
    /****
     The video recorded by camera
     API_AVAILABLE(3.21.0)
     */
    @property(nonatomic, strong) AliyunMixMediaRecordVideoInfo *recordVideoInfo;
    
    /****
     The sample video of the duet
     API_AVAILABLE(3.21.0)
     */
    @property(nonatomic, strong) AliyunMixMediaFileVideoInfo *mixVideoInfo;
    
    
    /****
     The size of the view for displaying the sample video of the duet.
     This parameter is used to render the view for displaying the sample video on the view of the duet, outputSizeView.
     */
    @property(nonatomic, assign) CGRect mixVideoViewFrame __deprecated_msg("use mixVideoInfo.frame instead");
    
    /****
     The size of the view for displaying the video captured by camera.
     This parameter is used to render the view for displaying the video captured by camera on the view of the duet, outputSizeView.
     */
    @property(nonatomic, assign) CGRect previewViewFrame __deprecated_msg("use recordVideoInfo.frame instead");
    
    /****
     The resolution of the video recorded by camera.
     */
    @property(nonatomic, assign) CGSize previewVideoSize __deprecated_msg("use recordVideoInfo.resolution instead");
    
    /****
     The path of the sample video of the duet.
     */
    @property(nonatomic, copy) NSString *mixVideoFilePath __deprecated_msg("use mixVideoInfo.filePath instead");
    
    /****
     The start time of the sample video of the duet.
     */
    @property(nonatomic, assign) CGFloat streamStartTime __deprecated_msg("use mixVideoInfo.streamStartTime instead");
    
    /****
     The end time of the sample video of the duet.
     */
    @property(nonatomic, assign) CGFloat streamEndTime __deprecated_msg("use mixVideoInfo.streamEndTime instead");
    
    @end
  • * The recorder of mix video

    See more

    Declaration

    Objective-C

    @interface AliyunMixRecorder : NSObject
  • * THe stream of mix video

    See more

    Declaration

    Objective-C

    @interface AliyunMixStream : NSObject
  • * The track of mix video

    See more

    Declaration

    Objective-C

    @interface AliyunMixTrack : NSObject
  • * A class that defines translational motions.

    See more

    Declaration

    Objective-C

    @interface AliyunMoveAction : AliyunAction
  • * A class that defines parsers.

    See more

    Declaration

    Objective-C

    @interface AliyunNativeParser : NSObject
  • * The param of part action

    See more

    Declaration

    Objective-C

    @interface AliyunActionPartParam : NSObject <NSCopying>
  • * The action of sub node

    See more

    Declaration

    Objective-C

    @interface AliyunPartAction : NSObject
  • * A base class that defines views for stickers.

    See more

    Declaration

    Objective-C

    @interface AliyunPasterBaseView
  • * A class that defines sticker controllers.

    See more

    Declaration

    Objective-C

    @interface AliyunPasterController : NSObject <AliyunPasterUIEventProtocol>
  • Deprecated

    please use AliyunStickerManager

    * deprecated, please use AliyunStickerManager.

    See more

    Declaration

    Objective-C

    
    @interface AliyunPasterManager : NSObject
  • * API_AVAILABLE(3.25.0) The augmentation info of video clip

    See more

    Declaration

    Objective-C

    @interface AliyunClipAugmentationInfo : NSObject
  • * API_AVAILABLE(3.25.0) The Audio info of video clip

    See more

    Declaration

    Objective-C

    @interface AliyunClipAudioInfo : NSObject
  • * API_AVAILABLE(3.25.0) The model of picture in picture

    See more

    Declaration

    Objective-C

    @interface AliyunPipClip : AliyunRenderModel <NSCopying>
  • * API_AVAILABLE(3.25.0) The controller of pip clip.

    See more

    Declaration

    Objective-C

    @interface AliyunPipClipController
        : AliyunRenderBaseController <AliyunFrameAnimationProtocol>
  • * API_AVAILABLE(3.25.0) The manager of picture in picture

    See more

    Declaration

    Objective-C

    @interface AliyunPipManager : NSObject
  • * API_AVAILABLE(3.25.0) The controller of pip clip track

    See more

    Declaration

    Objective-C

    @interface AliyunPipTrackController : NSObject
  • Deprecated

    please use AliyunFileRecordSource

    * The record source of video player API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    
    @interface AliyunPlayerRecordSource
        : NSObject <AliyunRecordDataSource, AliyunRecordSourceFPS>
  • * API_AVAILABLE(3.23.0) The info of border

    See more

    Declaration

    Objective-C

    @interface AliyunPureColorBorderInfo : NSObject <NSCopying>
  • * The recorder of multi source

    See more

    Declaration

    Objective-C

    @interface AliyunRecorder : NSObject
  • * The Config param of video API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunRecorderVideoConfig : NSObject
  • * The Info of background API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunRecorderBackgroundInfo : NSObject
  • * The config of record API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunRecorderConfig : NSObject
  • * The Image sticker of recorder API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunRecorderImageSticker : AliyunImageSticker
  • * The Gif sticker of recorder API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunRecorderGifSticker : AliyunGifSticker
  • * The base Controller of render model API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunRenderBaseController
        : NSObject <AliyunRenderBaseControllerEditProtocol>
  • * The base mode of render API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunRenderModel : NSObject <NSCopying>
  • * The task for resource to load API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunResourceLoadTask : NSObject
  • * A class that defines the model of resource API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunResourceModel : NSObject
  • * A class that defines how to manager resource for loading API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunResourceTaskManager : NSObject
  • * A class that defines how to manager resource for exporting API_AVAILABLE(3.27.0)

    Declaration

    Objective-C

    @interface AliyunResourceExport : AliyunResourceTaskManager
  • * A class that defines how to manager resource for importing API_AVAILABLE(3.27.0)

    Declaration

    Objective-C

    @interface AliyunResourceImport : AliyunResourceTaskManager
  • * The composer of roll caption

    See more

    Declaration

    Objective-C

    @interface AliyunRollCaptionComposer : NSObject
  • * The style of roll caption

    See more

    Declaration

    Objective-C

    @interface AliyunRollCaptionItemStyle : NSObject
  • * A class that defines rotation animations.

    See more

    Declaration

    Objective-C

    @interface AliyunRotateAction : AliyunAction
  • * A class that defines rotation animations with a rotation angle.

    See more

    Declaration

    Objective-C

    @interface AliyunRotateByAction : AliyunRotateAction
  • * A class that defines repeated rotations.

    See more

    Declaration

    Objective-C

    @interface AliyunRotateRepeatAction : AliyunRotateAction
  • * A class that defines rotation animations with a target angle.

    See more

    Declaration

    Objective-C

    @interface AliyunRotateToAction : AliyunRotateAction
  • * A class that defines scale animations.

    See more

    Declaration

    Objective-C

    @interface AliyunScaleAction : AliyunAction
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AliyunSetAction : AliyunAction
  • * API_AVAILABLE(3.27.0) The filter data model.

    See more

    Declaration

    Objective-C

    @interface AliyunShaderFilter : AliyunBaseFilter
  • * API_AVAILABLE(3.27.0) The filter controller.

    See more

    Declaration

    Objective-C

    @interface AliyunShaderFilterController : AliyunBaseFilterController
  • * The Sticker base class API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunSticker : AliyunRenderModel <NSCopying>
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AliyunStickerController
        : AliyunRenderBaseController <AliyunFrameAnimationProtocol>
  • * The manager of sticker API_AVAILABLE(3.22.0)

    See more

    Declaration

    Objective-C

    @interface AliyunStickerManager : NSObject
  • * A class that defines param for template. API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplateParam : NSObject
  • * A class that defines template. API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplate : NSObject
  • * A class that defines the node’s content that can be modified API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplateModifyContent : NSObject
  • * A class that defines the builder for a template API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplateBuilder : NSObject
  • * A class that defines the editor for applying the template. API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplateEditor : NSObject
  • * A class that defines the exporter for a template API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplateExporter : NSObject
  • * A class that defines the importer for a template API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplateImporter : NSObject
  • * A class that defines the loader for a template API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplateLoader : NSObject
  • * A class that defines the node for applying the template. API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplateNode : NSObject
  • * A class that defines the clip node for applying the template. API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplateClipNode : AliyunTemplateNode
  • * A class that defines the caption node for applying the template. API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplateCaptionNode : AliyunTemplateNode
  • * A class that defines the template’s resource for loading API_AVAILABLE(3.27.0)

    Declaration

    Objective-C

    @interface AliyunTemplateResourceLoadTask : AliyunResourceLoadTask
  • * A class that defines the template’s resource for exporting API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplateResourceExport : NSObject
  • * A class that defines the template’s resource for importing API_AVAILABLE(3.27.0)

    See more

    Declaration

    Objective-C

    @interface AliyunTemplateResourceImport : NSObject
  • * The parser of thumbnail

    See more

    Declaration

    Objective-C

    @interface AliyunThumbnailParser : NSObject
  • * A base class that defines transition effects.

    See more

    Declaration

    Objective-C

    @interface AliyunTransitionEffect : AliyunJSONModel
  • * A class that defines circle transitions.

    See more

    Declaration

    Objective-C

    @interface AliyunTransitionEffectCircle : AliyunTransitionEffect
  • * A class that defines fade transitions.

    See more

    Declaration

    Objective-C

    @interface AliyunTransitionEffectFade : AliyunTransitionEffect
  • * A class that defines polygon transitions.

    See more

    Declaration

    Objective-C

    @interface AliyunTransitionEffectPolygon : AliyunTransitionEffect
  • * A class that defines blinds transitions.

    See more

    Declaration

    Objective-C

    @interface AliyunTransitionEffectShuffer : AliyunTransitionEffect
  • * A class that defines translational motion effects.

    See more

    Declaration

    Objective-C

    @interface AliyunTransitionEffectTranslate : AliyunTransitionEffect
  • * The Info of license feature

    See more

    Declaration

    Objective-C

    @interface AliyunVideoLicenseFeature : NSObject
  • * The Info of license

    See more

    Declaration

    Objective-C

    @interface AliyunVideoLicense : NSObject
  • * The manager for video license

    See more

    Declaration

    Objective-C

    @interface AliyunVideoLicenseManager : NSObject
  • * A class that defines video parameter settings.

    See more

    Declaration

    Objective-C

    @interface AliyunVideoParam : NSObject
  • * A class that defines basic SDK settings.

    See more

    Declaration

    Objective-C

    @interface AliyunVideoSDKInfo : NSObject
  • * A class that splices videos.

    See more

    Declaration

    Objective-C

    @interface AliyunVideoStitch : NSObject
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AliyunViewRecordSource : NSObject<AliyunRecordDataSource, AliyunRecordSourceFPS>
    /****
     is mix avplayer in view API_AVAILABLE(3.22.0)
     in using initWithTargetView, it will ignore avplayer content if mixAVPlayer is NO
     */
    @property (nonatomic, assign) BOOL mixAVPlayer;
    /****
     capture not in mainThread (can not capture content in gpu, eg. glview) API_AVAILABLE(3.22.0)
     */
    @property (nonatomic, assign) BOOL captureInBackground;
    /****
     The layer of capture target API_AVAILABLE(3.22.0)
     */
    @property (nonatomic, readonly) CALayer *targetLayer;
    /****
     Init with view API_AVAILABLE(3.22.0)
     
     @param view The target of capture view
     @param fps The fps of capture
     */
    - (instancetype) initWithTargetView:(UIView *)view fps:(int)fps;
    /****
     using AVPlayerLayer to init API_AVAILABLE(3.22.0)
     
     @param layer The target AVPlayerLayer of capture
     @param fps The fps of capture
     */
    - (instancetype) initWithAVPlayerLayer:(AVPlayerLayer *)layer fps:(int)fps;
    @end
  • Deprecated

    3.33版本开始不在支持,请参考:https://help.aliyun.com/document_detail/378095.html

    * A class that defines publish managers. Not supported after version at 3.32.0, see: https://www.alibabacloud.com/help/en/apsaravideo-for-vod/latest/ios-short-video-sdk-video-upload-1

    Declaration

    Objective-C

    
    @interface AliyunVodPublishManager : NSObject
  • * The action of wip

    See more

    Declaration

    Objective-C

    @interface AliyunWipeAction : AliyunAction
  • Deprecated

    deprecated

    Undocumented

    See more

    Declaration

    Objective-C

    @interface AliyunXianyuFaceMap : NSObject
    
    /****
     Gets the size of the texture after rendering.
     * @param width The width of the texture.
     * @param height The height of the texture.
     */
    - (id)initWithOutputWidth:(int)width height:(int)height;
    
    /****
     * Sets the TransformMatrix object.
     * @param fm float[16]
     * @param texture_asp The aspect ratio of the texture.
     */
    - (void)setTransforamMatrix:(float*) fm texture_asp:(float)texture_asp;
    
    /****
     * Adds a sticker.
     * The sticker id must be a unique value greater than 1,000.
     
     * @param vid The id of the sticker to be added.
     * @param dongtu_dir The absolute path of the sticker.
     * @param duration The display duration of the sticker in microseconds.
     */
    
    - (int)addGif:(int)vid path:(char const *)dongtu_dir duration:(int64_t)duration;
    
    /****
     * Deletes a sticker.
     * @param vid The id of the sticker to be deleted.
     */
    - (void)deleteGif:(int)vid;
    
    /****
     * Sets facial data.
     * @param vid The sticker id.
     * @param face [left_eye_x, left_eye_y, right_eye_x, right_eye_y,
     *              mouth_x, mouth_y]
     * @param size 
     */
    - (void)setFace:(int)vid face:(float *)face size:(int)size;
    
    /****
     * Renders a texture.
     * @param texture_id The id of the texture to be rendered.
     * @return The texture id after rendering.
     */
    - (int)render:(int)texture_id;
    
    /****
     Releases resources.
     */
    - (void)destory;
    
    @end