Class MediaSpaceManager

Hierarchy (View Summary)

BaseManager
- MediaSpaceManager

Index

Constructors

Properties

Methods

cancelVideoUpload completeVideoUpload getVideoUploadResult initVideoUpload uploadImage uploadVideoPart

Constructors

constructor

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

Properties

`Protected`config

config: ShopeeConfig

Methods

cancelVideoUpload

cancelVideoUpload(
params?: CancelVideoUploadRequest,
): Promise<CancelVideoUploadResponse>
Cancel a video upload session
Parameters
- Optionalparams: CancelVideoUploadRequest
  Request parameters
Returns Promise<CancelVideoUploadResponse>
Promise resolving to the response
- Defined in src/managers/media-space.manager.ts:30

completeVideoUpload

completeVideoUpload(
params?: CompleteVideoUploadRequest,
): Promise<CompleteVideoUploadResponse>
Complete the video upload and starts the transcoding process when all parts are uploaded successfully.
Parameters
- Optionalparams: CompleteVideoUploadRequest
  Request parameters
Returns Promise<CompleteVideoUploadResponse>
Promise resolving to the response
- Defined in src/managers/media-space.manager.ts:49

getVideoUploadResult

getVideoUploadResult(
params?: GetVideoUploadResultRequest,
): Promise<GetVideoUploadResultResponse>
Query the upload status and result of video upload.
Parameters
- Optionalparams: GetVideoUploadResultRequest
  Request parameters
Returns Promise<GetVideoUploadResultResponse>
Promise resolving to the response
- Defined in src/managers/media-space.manager.ts:68

initVideoUpload

initVideoUpload(
params?: InitVideoUploadRequest,
): Promise<InitVideoUploadResponse>
Initiate video upload session.Video duration should be between 10s and 60s (inclusive).
Parameters
- Optionalparams: InitVideoUploadRequest
  Request parameters
Returns Promise<InitVideoUploadResponse>
Promise resolving to the response
- Defined in src/managers/media-space.manager.ts:87

uploadImage

uploadImage(params?: UploadImageRequest): Promise<UploadImageResponse>
Use this API to upload multiple image files (less than 9 images).
Parameters
- Optionalparams: UploadImageRequest
  Request parameters
Returns Promise<UploadImageResponse>
Promise resolving to the response
- Defined in src/managers/media-space.manager.ts:104

uploadVideoPart

uploadVideoPart(
params?: UploadVideoPartRequest,
): Promise<UploadVideoPartResponse>
Upload video file by part using the upload_id in initiate_video_upload.The request Content-Type of this API should be of multipart/form-data
Parameters
- Optionalparams: UploadVideoPartRequest
  Request parameters
Returns Promise<UploadVideoPartResponse>
Promise resolving to the response
- Defined in src/managers/media-space.manager.ts:117