Class MediaSpaceManager

MediaSpaceManager handles media file uploads (images and videos) to Shopee's media space.

This manager provides functionality for:

Uploading images with different scenes and aspect ratios
Multi-part video upload with session management
Video transcoding status tracking
Video upload cancellation

Hierarchy (View Summary)

BaseManager
- MediaSpaceManager

Index

Constructors

constructor

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

Properties

`Protected`config

config: ShopeeConfig

Methods

cancelVideoUpload

cancelVideoUpload(
params: CancelVideoUploadParams,
): Promise<CancelVideoUploadResponse>
Cancel a video upload session.
Parameters
- params: CancelVideoUploadParams
  Parameters for canceling video upload
  
  Parameters for canceling video upload
  - video_upload_id: string
    The ID of this upload session, returned in init_video_upload
Returns Promise<CancelVideoUploadResponse>
Promise indicating cancellation status
Remarks
Use this API to cancel an ongoing video upload session if needed. After cancellation, the video_upload_id cannot be used for further operations.
Throws
When the API request fails or returns an error
- error_invalid_upload_id: Invalid upload_id
- error_already_completed: Upload already completed
Example
```
await sdk.mediaSpace.cancelVideoUpload({
  video_upload_id: 'sg_90ce045e-fd92-4f0b-97a4-eda40546cd9f_000000'
});
```
- Defined in src/managers/media-space.manager.ts:262

completeVideoUpload

completeVideoUpload(
params: CompleteVideoUploadParams,
): Promise<CompleteVideoUploadResponse>
Complete the video upload and start the transcoding process when all parts are uploaded successfully.
Parameters
- params: CompleteVideoUploadParams
  Parameters for completing video upload
  
  Parameters for completing video upload
  - part_seq_list: number[]
    All uploaded sequence numbers
  - report_data: ReportData
    Report data for tracking upload performance
  - video_upload_id: string
    The ID of this upload session, returned in init_video_upload
Returns Promise<CompleteVideoUploadResponse>
Promise indicating completion status
Remarks
Call this API after all video parts have been successfully uploaded. The video will be transcoded and ready for use in item operations once transcoding completes.
Throws
When the API request fails or returns an error
- error_invalid_upload_id: Invalid upload_id
- error_already_completed: Upload already completed
Example
```
await sdk.mediaSpace.completeVideoUpload({
  video_upload_id: 'sg_90ce045e-fd92-4f0b-97a4-eda40546cd9f_000000',
  part_seq_list: [0, 1, 2, 3],
  report_data: { upload_cost: 11832 }
});
```
- Defined in src/managers/media-space.manager.ts:181

getVideoUploadResult

getVideoUploadResult(
params: GetVideoUploadResultParams,
): Promise<GetVideoUploadResultResponse>
Query the upload status and result of video upload.
Parameters
- params: GetVideoUploadResultParams
  Parameters for getting video upload result
  
  Parameters for getting video upload result
  - [key: string]: string | number | boolean | undefined
  - video_upload_id: string
    The video_upload_id from init_video_upload response
Returns Promise<GetVideoUploadResultResponse>
Promise with upload status and video information (if transcoding is complete)
Remarks
Possible status values:
- INITIATED: Waiting for part uploading and/or complete_video_upload call
- TRANSCODING: Transcoding the video file
- SUCCEEDED: Transcoding completed, ready for use
- FAILED: Upload failed, check message field for details
- CANCELLED: Upload was cancelled
Throws
When the API request fails or returns an error
- error_invalid_upload_id: Invalid upload_id
Example
```
const result = await sdk.mediaSpace.getVideoUploadResult({
  video_upload_id: 'sg_90ce045e-fd92-4f0b-97a4-eda40546cd9f_000000'
});
if (result.response.status === 'SUCCEEDED') {
  console.log('Video URL:', result.response.video_info.video_url_list[0].video_url);
}
```
- Defined in src/managers/media-space.manager.ts:224

initVideoUpload

initVideoUpload(params: InitVideoUploadParams): Promise<InitVideoUploadResponse>
Initiate video upload session.
Parameters
- params: InitVideoUploadParams
  Parameters for initializing video upload
  
  Parameters for initializing video upload
  - file_md5: string
    MD5 of video file
  - file_size: number
    Size of video file, in bytes. Maximum is 30MB
Returns Promise<InitVideoUploadResponse>
Promise with video_upload_id for subsequent upload operations
Remarks
Video duration should be between 10s and 60s (inclusive). Use the returned video_upload_id for uploading video parts and completing the upload.
Throws
When the API request fails or returns an error
- error_file_size: File size is too large. Video size should be less than 30M
- error_param: Invalid parameter
Example
```
const result = await sdk.mediaSpace.initVideoUpload({
  file_md5: '2abf0b6e5ff90ff24437a0808f171a93',
  file_size: 1261876
});
const uploadId = result.response.video_upload_id;
```
- Defined in src/managers/media-space.manager.ts:99

uploadImage

uploadImage(params: UploadImageParams): Promise<UploadImageResponse>
Upload multiple image files to MediaSpace (less than 9 images).
Parameters
- params: UploadImageParams
  Parameters for image upload
  
  Parameters for uploading image to MediaSpace
  - Optionalimage?: File | Blob | Buffer<ArrayBufferLike>
    Image files. Max 10.0 MB each. Image format accepted: JPG, JPEG, PNG. Image number should be less than 9. Note: This is handled as multipart/form-data in the actual request
  - Optionalratio?: "1:1" | "3:4"
    Image aspect ratio. Only applicable to whitelisted sellers. Supported values: "1:1" (default), "3:4"
  - Optionalscene?: "normal" | "desc"
    The scene where the picture is used. Default is 'normal'
    
    normal: Process the image as a square image (recommended for item images)
    
    desc: Do not process the image (recommended for extend_description images)
Returns Promise<UploadImageResponse>
Promise with uploaded image information including image IDs and URLs
Remarks
This API requires multipart/form-data content type.
- normal scene: Images will be processed as square images (recommended for item images)
- desc scene: Images will not be processed (recommended for extend_description)
Throws
When the API request fails or returns an error
- error_tier_img_partial: Internal error, please contact openapi team
- error_tier_img_old_app: Internal error, please contact openapi team
Example
```
const result = await sdk.mediaSpace.uploadImage({
  scene: 'normal',
  ratio: '1:1',
  image: imageFile
});
console.log('Uploaded image ID:', result.response.image_info_list[0].image_info.image_id);
```
- Defined in src/managers/media-space.manager.ts:61

uploadVideoPart

uploadVideoPart(params: UploadVideoPartParams): Promise<UploadVideoPartResponse>
Upload video file by part using the upload_id from initVideoUpload.
Parameters
- params: UploadVideoPartParams
  Parameters for uploading video part
  
  Parameters for uploading video part
  - content_md5: string
    MD5 of this part
  - Optionalpart_content?: File | Blob | Buffer<ArrayBufferLike>
    The content of this part of file. Part size should be exactly 4MB, except last part of file. Note: This is handled as multipart/form-data in the actual request
  - part_seq: number
    Sequence of the current part, starts from 0
  - video_upload_id: string
    The video_upload_id from init_video_upload response
Returns Promise<UploadVideoPartResponse>
Promise indicating success or failure of the part upload
Remarks
The request Content-Type should be multipart/form-data. Part size should be exactly 4MB, except for the last part of file.
Throws
When the API request fails or returns an error
- error_invalid_upload_id: Invalid upload_id
- error_invalid_part_seq: Invalid part_seq
- error_invalid_part_size: Invalid part_size
Example
```
await sdk.mediaSpace.uploadVideoPart({
  video_upload_id: 'sg_90ce045e-fd92-4f0b-97a4-eda40546cd9f_000000',
  part_seq: 0,
  content_md5: '3bb08579fffbfc13ed9d23cda8bbb46d',
  part_content: videoPart
});
```
- Defined in src/managers/media-space.manager.ts:142

Class MediaSpaceManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MediaSpaceManager

Properties

Protectedconfig

Methods

cancelVideoUpload

Parameters

video_upload_id: string

Returns Promise<CancelVideoUploadResponse>

Remarks

Throws

Example

completeVideoUpload

Parameters

part_seq_list: number[]

report_data: ReportData

video_upload_id: string

Returns Promise<CompleteVideoUploadResponse>

Remarks

Throws

Example

getVideoUploadResult

Parameters

[key: string]: string | number | boolean | undefined

video_upload_id: string

Returns Promise<GetVideoUploadResultResponse>

Remarks

Throws

Example

initVideoUpload

Parameters

file_md5: string

file_size: number

Returns Promise<InitVideoUploadResponse>

Remarks

Throws

Example

uploadImage

Parameters

Optionalimage?: File | Blob | Buffer<ArrayBufferLike>

Optionalratio?: "1:1" | "3:4"

Optionalscene?: "normal" | "desc"

Returns Promise<UploadImageResponse>

Remarks

Throws

Example

uploadVideoPart

Parameters

content_md5: string

Optionalpart_content?: File | Blob | Buffer<ArrayBufferLike>

part_seq: number

video_upload_id: string

Returns Promise<UploadVideoPartResponse>

Remarks

Throws

Example

Settings

On This Page

`Protected`config

`Optional`image?: File | Blob | Buffer<ArrayBufferLike>

`Optional`ratio?: "1:1" | "3:4"

`Optional`scene?: "normal" | "desc"

`Optional`part_content?: File | Blob | Buffer<ArrayBufferLike>