Class MediaManager

MediaManager handles media upload operations for the Shopee API

Provides methods for:

Image upload for various business scenarios
Video upload with multi-part upload support
Video upload status tracking

Hierarchy (View Summary)

BaseManager
- MediaManager

Index

Constructors

constructor

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

Properties

`Protected`config

config: ShopeeConfig

Methods

cancelMediaVideoUpload

cancelMediaVideoUpload(
params: CancelMediaVideoUploadParams,
): Promise<CancelMediaVideoUploadResponse>
Cancel a video upload session under the media module
Parameters
- params: CancelMediaVideoUploadParams
  Parameters for cancelling video upload
Returns Promise<CancelMediaVideoUploadResponse>
Response indicating cancellation
- Defined in src/managers/media.manager.ts:440

cancelVideoUpload

cancelVideoUpload(
params: CancelVideoUploadParams,
): Promise<CancelVideoUploadResponse>
Cancel a video upload session
Parameters
- params: CancelVideoUploadParams
  Parameters for cancelling video upload
  
  Parameters for v2.media_space.cancel_video_upload
  - video_upload_id: string
    The ID of this upload session, returned in init_video_upload
Returns Promise<CancelVideoUploadResponse>
Response indicating cancellation
Example
```
await sdk.media.cancelVideoUpload({
  video_upload_id: videoUploadId
});
console.log('Video upload cancelled');
```
Use Cases:
- Cancel upload on user request
- Cancel failed upload to free resources
- Cancel when upload takes too long
Throws
When the API request fails
- error_invalid_upload_id: Invalid upload_id
- error_already_completed: Upload already completed (cannot cancel)
- Defined in src/managers/media.manager.ts:334

completeMediaVideoUpload

completeMediaVideoUpload(
params: CompleteMediaVideoUploadParams,
): Promise<CompleteMediaVideoUploadResponse>
Complete the video upload under the media module
Parameters
- params: CompleteMediaVideoUploadParams
  Parameters for completing video upload
Returns Promise<CompleteMediaVideoUploadResponse>
Response indicating completion
- Defined in src/managers/media.manager.ts:397

completeVideoUpload

completeVideoUpload(
params: CompleteVideoUploadParams,
): Promise<CompleteVideoUploadResponse>
Complete the video upload and start transcoding
Parameters
- params: CompleteVideoUploadParams
  Parameters for completing video upload
  
  Parameters for v2.media_space.complete_video_upload
  - part_seq_list: number[]
    All uploaded sequence numbers
  - report_data: VideoUploadReportData
    Upload performance tracking data
  - video_upload_id: string
    The ID of this upload session, returned in init_video_upload
Returns Promise<CompleteVideoUploadResponse>
Response indicating completion
Example
```
const startTime = Date.now();
// ... upload all parts ...
const uploadCost = Date.now() - startTime;

await sdk.media.completeVideoUpload({
  video_upload_id: videoUploadId,
  part_seq_list: [0, 1, 2, 3],
  report_data: {
    upload_cost: uploadCost
  }
});
```
Notes:
- Call this after all parts are uploaded successfully
- Transcoding process begins after this call
- Use getVideoUploadResult to check transcoding status
Throws
When the API request fails
- error_invalid_upload_id: Invalid upload_id
- error_already_completed: Upload already completed
- Defined in src/managers/media.manager.ts:248

getMediaVideoUploadResult

getMediaVideoUploadResult(
params: GetMediaVideoUploadResultParams,
): Promise<GetMediaVideoUploadResultResponse>
Query the upload status and result of a video upload under the media module
Parameters
- params: GetMediaVideoUploadResultParams
  Parameters for querying video status
Returns Promise<GetMediaVideoUploadResultResponse>
Response containing upload status and video info
- Defined in src/managers/media.manager.ts:418

getVideoUploadResult

getVideoUploadResult(
params: GetVideoUploadResultParams,
): Promise<GetVideoUploadResultResponse>
Query the upload status and result of a video upload
Parameters
- params: GetVideoUploadResultParams
  Parameters for querying video status
  
  Parameters for v2.media_space.get_video_upload_result
  - [key: string]: string | number | boolean | null | undefined
  - video_upload_id: string
    The video_upload_id returned by init_video_upload
Returns Promise<GetVideoUploadResultResponse>
Response containing upload status and video info
Example
```
const result = await sdk.media.getVideoUploadResult({
  video_upload_id: videoUploadId
});

if (result.response.status === 'SUCCEEDED') {
  console.log('Video URL:', result.response.video_info.video_url_list);
  console.log('Duration:', result.response.video_info.duration);
} else if (result.response.status === 'FAILED') {
  console.error('Upload failed:', result.response.message);
}
```
Upload Status:
- INITIATED: Waiting for parts or complete_video_upload call
- TRANSCODING: Transcoding the video file
- SUCCEEDED: Transcoding completed, video ready to use
- FAILED: Upload failed, check message for details
- CANCELLED: Upload was cancelled
Throws
When the API request fails
- error_invalid_upload_id: Invalid upload_id
- Defined in src/managers/media.manager.ts:294

initMediaVideoUpload

initMediaVideoUpload(
params: InitMediaVideoUploadParams,
): Promise<InitMediaVideoUploadResponse>
Initiate a video upload session under the media module
Parameters
- params: InitMediaVideoUploadParams
  Parameters for initiating video upload
Returns Promise<InitMediaVideoUploadResponse>
Response containing video_upload_id and part_size
- Defined in src/managers/media.manager.ts:354

initVideoUpload

initVideoUpload(params: InitVideoUploadParams): Promise<InitVideoUploadResponse>
Initiate a video upload session
Parameters
- params: InitVideoUploadParams
  Parameters for initiating video upload
  
  Parameters for v2.media_space.init_video_upload
  - file_md5: string
    MD5 of video file
  - file_size: number
    Size of video file in bytes (maximum 30MB)
Returns Promise<InitVideoUploadResponse>
Response containing video_upload_id
Example
```
const result = await sdk.media.initVideoUpload({
  file_md5: '2abf0b6e5ff90ff24437a0808f171a93',
  file_size: 1261876
});
const videoUploadId = result.response.video_upload_id;
```
Video Requirements:
- Duration: 10-60 seconds (inclusive)
- Maximum size: 30MB
- Must upload by parts after initialization
Throws
When the API request fails
- error_file_size: File size is too large (max 30MB)
- Defined in src/managers/media.manager.ts:154

uploadImage

uploadImage(params: UploadImageParams): Promise<UploadImageResponse>
Upload multiple image files for general use
Parameters
- params: UploadImageParams
  Parameters for uploading images
  
  Parameters for v2.media_space.upload_image
  - image: Buffer<ArrayBufferLike> | Buffer<ArrayBufferLike>[]
    The image files to be uploaded as buffers (up to 9 images)
  - Optionalratio?: MediaSpaceImageRatio
    Image ratio (only for whitelisted sellers)
  - Optionalscene?: MediaSpaceImageScene
    Scene where the picture is used
Returns Promise<UploadImageResponse>
Response containing uploaded image information
Example
```
// Upload product images (square processing)
const result = await sdk.media.uploadImage({
  image: [Buffer.from('image-1'), Buffer.from('image-2')],
  scene: 'normal',
  ratio: '1:1'
});

// Upload description images (no processing)
const descResult = await sdk.media.uploadImage({
  image: Buffer.from('desc-image-bytes'),
  scene: 'desc'
});
```
Image Requirements:
- Maximum: 9 images per request
- Maximum size: 10MB per image
- Formats: JPG, JPEG, PNG
- Scene "normal": Image processed as square (recommended for item images)
- Scene "desc": No processing (recommended for extended descriptions)
Throws
When the API request fails
- Defined in src/managers/media.manager.ts:115

uploadMediaImage

uploadMediaImage(
params: UploadMediaImageParams,
): Promise<UploadMediaImageResponse>
Upload images for specific business scenarios (e.g., returns)
Parameters
- params: UploadMediaImageParams
  Parameters for uploading images
  
  Parameters for v2.media.upload_image
  - business: 2
    Defines the business type of the uploaded image
  - images: Buffer<ArrayBufferLike> | Buffer<ArrayBufferLike>[]
    The image files to be uploaded as buffers
  - scene: 1
    Defines the purpose of the uploaded image under the specified business type
Returns Promise<UploadMediaImageResponse>
Response containing uploaded image information
Example
```
const result = await sdk.media.uploadMediaImage({
  business: 2,
  scene: 1,
  images: Buffer.from('image-bytes')
});
console.log('Uploaded images:', result.response.image_list);
```
Restrictions:
- business = 2, scene = 1: Up to 3 images, max 10MB each, formats: JPG, JPEG, PNG
Throws
When the API request fails
- Defined in src/managers/media.manager.ts:68

uploadMediaVideoPart

uploadMediaVideoPart(
params: UploadMediaVideoPartParams,
): Promise<UploadMediaVideoPartResponse>
Upload a video part under the media module
Parameters
- params: UploadMediaVideoPartParams
  Parameters for uploading video part
Returns Promise<UploadMediaVideoPartResponse>
Response indicating upload success
- Defined in src/managers/media.manager.ts:376

uploadVideoPart

uploadVideoPart(params: UploadVideoPartParams): Promise<UploadVideoPartResponse>
Upload a video file by parts
Parameters
- params: UploadVideoPartParams
  Parameters for uploading video part
  
  Parameters for v2.media_space.upload_video_part
  - content_md5: string
    MD5 of this part
  - part_content: Buffer
    The content of this part of file as a buffer (exactly 4MB except last part)
  - part_seq: number
    Sequence of the current part, starts from 0
  - video_upload_id: string
    The video_upload_id returned by init_video_upload
Returns Promise<UploadVideoPartResponse>
Response indicating upload success
Example
```
// Upload video parts sequentially
for (let i = 0; i < partCount; i++) {
  await sdk.media.uploadVideoPart({
    video_upload_id: videoUploadId,
    part_seq: i,
    content_md5: partMd5,
    part_content: Buffer.from('part-bytes')
  });
}
```
Part Requirements:
- Part size: Exactly 4MB except for the last part
- Must provide MD5 hash for each part
- Upload parts sequentially starting from 0
Throws
When the API request fails
- error_invalid_upload_id: Invalid upload_id
- error_invalid_part_seq: Invalid part_seq
- error_invalid_part_size: Invalid part_size
- Defined in src/managers/media.manager.ts:201

Class MediaManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MediaManager

Properties

Protectedconfig

Methods

cancelMediaVideoUpload

Parameters

Returns Promise<CancelMediaVideoUploadResponse>

cancelVideoUpload

Parameters

video_upload_id: string

Returns Promise<CancelVideoUploadResponse>

Example

Throws

completeMediaVideoUpload

Parameters

Returns Promise<CompleteMediaVideoUploadResponse>

completeVideoUpload

Parameters

part_seq_list: number[]

report_data: VideoUploadReportData

video_upload_id: string

Returns Promise<CompleteVideoUploadResponse>

Example

Throws

getMediaVideoUploadResult

Parameters

Returns Promise<GetMediaVideoUploadResultResponse>

getVideoUploadResult

Parameters

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

video_upload_id: string

Returns Promise<GetVideoUploadResultResponse>

Example

Throws

initMediaVideoUpload

Parameters

Returns Promise<InitMediaVideoUploadResponse>

initVideoUpload

Parameters

file_md5: string

file_size: number

Returns Promise<InitVideoUploadResponse>

Example

Throws

uploadImage

Parameters

image: Buffer<ArrayBufferLike> | Buffer<ArrayBufferLike>[]

Optionalratio?: MediaSpaceImageRatio

Optionalscene?: MediaSpaceImageScene

Returns Promise<UploadImageResponse>

Example

Throws

uploadMediaImage

Parameters

business: 2

images: Buffer<ArrayBufferLike> | Buffer<ArrayBufferLike>[]

scene: 1

Returns Promise<UploadMediaImageResponse>

Example

Throws

uploadMediaVideoPart

Parameters

Returns Promise<UploadMediaVideoPartResponse>

uploadVideoPart

Parameters

content_md5: string

part_content: Buffer

part_seq: number

video_upload_id: string

Returns Promise<UploadVideoPartResponse>

Example

`Protected`config

`Optional`ratio?: MediaSpaceImageRatio

`Optional`scene?: MediaSpaceImageScene