tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
User Generated Short Video SDK
    Documentation
    Download PDF

    Android

    Last updated: 2022-11-17 16:50:16
    Download PDF

      TXVideoEditer

      Basic editing APIs

      API Description
      TXVideoEditer The TXVideoEditer constructor.
      setVideoPath Specifies the video path. This API works in v18 or later on Android.
      setCustomVideoProcessListener Sets the custom image processing callback (not supported in UGSV Lite).
      release Releases the resources after a video is processed or processing is canceled.

      Effect APIs

      API Description
      setSpecialRatio Sets the filter strength (not supported in UGSV Lite).
      setFilter Sets the filter (not supported in UGSV Lite).
      setFilter Sets multiple filters (not supported in UGSV Lite).
      setBeautyFilter Sets the beautification and brightening strength (not supported in UGSV Lite).
      startEffect Sets the start time for an effect (not supported in UGSV Lite).
      stopEffect Sets the end time for an effect (not supported in UGSV Lite).
      deleteLastEffect Removes the last effect applied (not supported in UGSV Lite).
      deleteAllEffect Removes all effects (not supported in UGSV Lite).

      Video generation APIs

      API Description
      setCutFromTime Sets the start and end time for video clipping.
      setVideoBitrate Sets the output video bitrate.
      setAudioBitrate Sets the output audio bitrate.
      setVideoGenerateListener Registers a listener for video generation.
      generateVideo Generates a video according to the action list.
      cancel Cancels generating the video.

      Image transition APIs

      API Description
      setPictureList Specifies the images that are to be converted to a video (not supported in UGSV Lite).
      setPictureTransition Sets the transition effects (not supported in UGSV Lite).

      Time effect APIs

      API Description
      setSpeedList Sets the playback speed for multiple video segments (not supported in UGSV Lite).
      setRepeatPlay Loops multiple video segments (not supported in UGSV Lite).
      setReverse Plays a video backwards (not supported in UGSV Lite).

      Preview APIs

      API Description
      setTXVideoPreviewListener Registers a listener for video preview.
      initWithPreview Initializes the view for video preview.
      startPlayFromTime Plays a video for a specific time period.
      pausePlay Pauses playback.
      resumePlay Resumes playback.
      stopPlay Stops playback (releases the resources).
      previewAtTime Previews a frame.
      refreshOneFrame Refreshes a frame to show the image without ghosting. This is used for the subtitle editing view.
      setRenderRotation Sets the rendering rotation (not supported in UGSV Lite).

      Preprocessing APIs

      API Description
      setVideoProcessListener Sets the preprocessing callback.
      processVideo Preprocesses a video.

      Background music APIs

      API Description
      setBGM Sets the background music (not supported in UGSV Lite).
      setBGMLoop Sets whether to loop the background music (not supported in UGSV Lite).
      setBGMAtVideoTime Sets the time point of the video to start playing music (not supported in UGSV Lite).
      setBGMStartTime Sets the start and end time of the background music (not supported in UGSV Lite).
      setBGMVolume Sets the volume of the background music (not supported in UGSV Lite).
      setBGMFadeInOutDuration Sets fade-in and fade-out effects for the background music (not supported in UGSV Lite).
      setVideoVolume Sets the audio volume of the video (not supported in UGSV Lite).

      Sticker APIs (not supported in UGSV Lite)

      API Description
      setPasterList Sets static stickers (not supported in UGSV Lite).
      setAnimatedPasterList Sets animated stickers (not supported in UGSV Lite).
      setSubtitleList Sets speech bubbles (not supported in UGSV Lite).
      setWaterMark Adds a watermark.
      setTailWaterMark Adds a watermark to the closing segment (not supported in UGSV Lite).

      Watermark APIs

      API Description
      setWaterMark Sets a global watermark (not supported in UGSV Lite).
      setTailWaterMark Adds a watermark to the closing segment (not supported in UGSV Lite).

      Thumbnail APIs

      API Description
      getThumbnail Gets the thumbnail list.
      getThumbnail Gets the thumbnail list.
      setThumbnail Sets the thumbnail output by preprocessing.
      setThumbnailListener Sets the callback for thumbnail generation by preprocessing.
      getThumbnailCount Gets the number of thumbnails.

      TXVideoGenerateListener

      Editing callback APIs

      API Description
      onGenerateProgress The video generation progress.
      onGenerateComplete A video was generated.

      TXVideoPreviewListener

      Preview callback APIs

      API Description
      onPreviewProgress The current preview time, in microseconds.
      onPreviewFinished The preview ended.

      TXVideoPreviewListenerEx

      Preview callback APIs

      API Description
      onPreviewError An error occurred during video generation.
      onPreviewProgress The preview progress, in microseconds.
      onPreviewFinished The preview ended.

      TXVideoProcessListener

      Preprocessing callback APIs

      API Description
      onProcessProgress The preprocessing progress.
      onProcessComplete The preprocessing was completed.

      TXVideoCustomProcessListener

      Custom processing callback APIs

      API Description
      onTextureCustomProcess The texture callback. You can process the video by yourself in this callback.
      onTextureDestroyed The texture releasing callback. You can release the OpenGL resources in this callback.

      TXThumbnailListener

      Thumbnail callback APIs

      API Description
      onThumbnail The thumbnail callback.

      TXVideoEditConstants

      Definitions of editing key types

      API Description
      TXVideoInfo The video information.
      TXPreviewParam The preview parameters.
      TXGenerateResult The editing result.
      TXPreviewError Preview errors.
      TXJoinerResult The generation result.
      TXSubtitle The subtitle information.
      TXPaster The static sticker information.
      TXAnimatedPaster The animated sticker information.
      TXSpeed The speed changing information.
      TXRect The area to which the watermark is applied.
      TXThumbnail The thumbnail information.
      TXRepeat The looped segment.
      TXAbsoluteRect The position and dimensions of each video.

      Error Codes

      Editing result

      Message Code Description
      GENERATE_RESULT_OK 0 The video was generated successfully.
      GENERATE_RESULT_FAILED -1 Failed to generate the video.
      GENERATE_RESULT_LICENCE_VERIFICATION_FAILED -5 Failed to generate the video due to a license verification error.

      Preview

      Message Code Description
      PREVIEW_ERROR_VIDEO_DECODE_FAIL -1 Failed to preview the video due to a decoding error.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy