Class MediaManager

Hierarchy (View Summary)

BaseManager
- MediaManager

Index

Constructors

Properties

Methods

cancelVideoUpload completeVideoUpload getVideoUploadResult initVideoUpload uploadImage uploadVideoPart

Constructors

constructor

new MediaManager(config: ShopeeConfig): MediaManager
Parameters
- config: ShopeeConfig
Returns MediaManager
Overrides BaseManager.constructor
- Defined in src/managers/media.manager.ts:21

Properties

`Protected`config

config: ShopeeConfig

Methods

cancelVideoUpload

cancelVideoUpload(
params?: CancelVideoUploadRequest,
): Promise<CancelVideoUploadResponse>
Use this API to cancel an ongoing video upload task. If the upload has already succeeded, failed, or been cancelled, this operation will fail and return error.
Parameters
- Optionalparams: CancelVideoUploadRequest
  Request parameters
Returns Promise<CancelVideoUploadResponse>
Promise resolving to the response
- Defined in src/managers/media.manager.ts:30

completeVideoUpload

completeVideoUpload(
params?: CompleteVideoUploadRequest,
): Promise<CompleteVideoUploadResponse>
Use this API to finalize a video upload task. Once called, the system will transcode all uploaded video parts and prepare the video for use. All parts must be fully uploaded before calling this API.
Parameters
- Optionalparams: CompleteVideoUploadRequest
  Request parameters
Returns Promise<CompleteVideoUploadResponse>
Promise resolving to the response
- Defined in src/managers/media.manager.ts:45

getVideoUploadResult

getVideoUploadResult(
params?: GetVideoUploadResultRequest,
): Promise<GetVideoUploadResultResponse>
Use this API to retrieve the current status and result of a video upload task. You can also use video_upload_result_push to get notified immediately when a video upload reaches a final status (SUCCEEDED, FAILED, or CANCELLED).
Parameters
- Optionalparams: GetVideoUploadResultRequest
  Request parameters
Returns Promise<GetVideoUploadResultResponse>
Promise resolving to the response
- Defined in src/managers/media.manager.ts:64

initVideoUpload

initVideoUpload(
params?: InitVideoUploadRequest,
): Promise<InitVideoUploadResponse>
Use this API to initialize a new video upload task and obtain a unique upload session ID.
Parameters
- Optionalparams: InitVideoUploadRequest
  Request parameters
Returns Promise<InitVideoUploadResponse>
Promise resolving to the response
- Defined in src/managers/media.manager.ts:84

uploadImage

uploadImage(params?: UploadImageRequest): Promise<UploadImageResponse>
Use this API to upload images and support different business scenarios through business and scene parameters.
Parameters
- Optionalparams: UploadImageRequest
  Request parameters
Returns Promise<UploadImageResponse>
Promise resolving to the response
- Defined in src/managers/media.manager.ts:97

uploadVideoPart

uploadVideoPart(
params?: UploadVideoPartRequest,
): Promise<UploadVideoPartResponse>
Use this API to upload a video file in parts.
Parameters
- Optionalparams: UploadVideoPartRequest
  Request parameters
Returns Promise<UploadVideoPartResponse>
Promise resolving to the response
- Defined in src/managers/media.manager.ts:110