MediaClient

Client for media operations This client provides methods for interacting with the media endpoints of the X API. It handles authentication, request formatting, and response parsing for all media related operations. zeUpload](/xdks/typescript/reference/classes/MediaClient#finalizeupload)

• initializeUpload
• createSubtitles
• deleteSubtitles

​

Constructors

​

constructor

• new MediaClient(client): MediaClient Creates a new media client instance

​

Parameters

​

Returns

MediaClient

​

Defined in

media/client.ts:250

​

Methods

​

getByKey

▸ getByKey(mediaKey, options): Promise<Response> Get Media by media key Retrieves details of a specific Media file by its media key.

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

media/client.ts:295 ▸ getByKey(mediaKey, options?): Promise<Get2MediaMediaKeyResponse>

​

Parameters

​

Returns

Promise<Get2MediaMediaKeyResponse>

​

Defined in

media/client.ts:308

---

​

getUploadStatus

▸ getUploadStatus(mediaId, options): Promise<Response> Get Media upload status Retrieves the status of a Media upload by its ID.

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

media/client.ts:442 ▸ getUploadStatus(mediaId, options?): Promise<MediaUploadResponse>

​

Parameters

​

Returns

Promise<MediaUploadResponse>

​

Defined in

media/client.ts:455

---

​

upload

▸ upload(options): Promise<Response> Upload media Uploads a media file for use in posts or other content.

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

media/client.ts:582 ▸ upload(options?): Promise<MediaUploadResponse>

​

Parameters

​

Returns

Promise<MediaUploadResponse>

​

Defined in

media/client.ts:591

---

​

getAnalytics

▸ getAnalytics(mediaKeys, endTime, startTime, granularity, options): Promise<Response> Get Media analytics Retrieves analytics data for media.

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

media/client.ts:699 ▸ getAnalytics(mediaKeys, endTime, startTime, granularity, options?): Promise<MediaAnalytics>

​

Parameters

​

Returns

Promise<MediaAnalytics>

​

Defined in

media/client.ts:724

---

​

appendUpload

▸ appendUpload(id, options): Promise<Response> Append Media upload Appends data to a Media upload request.

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

media/client.ts:918 ▸ appendUpload(id, options?): Promise<MediaUploadAppendResponse>

​

Parameters

​

Returns

Promise<MediaUploadAppendResponse>

​

Defined in

media/client.ts:931

---

​

getByKeys

▸ getByKeys(mediaKeys, options): Promise<Response> Get Media by media keys Retrieves details of Media files by their media keys.

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

media/client.ts:1039 ▸ getByKeys(mediaKeys, options?): Promise<Get2MediaResponse>

​

Parameters

​

Returns

Promise<Get2MediaResponse>

​

Defined in

media/client.ts:1052

---

​

createMetadata

▸ createMetadata(options): Promise<Response> Create Media metadata Creates metadata for a Media file.

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

media/client.ts:1191 ▸ createMetadata(options?): Promise<MetadataCreateResponse>

​

Parameters

​

Returns

Promise<MetadataCreateResponse>

​

Defined in

media/client.ts:1200

---

​

finalizeUpload

▸ finalizeUpload(id, options): Promise<Response> Finalize Media upload Finalizes a Media upload request.

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

media/client.ts:1296 ▸ finalizeUpload(id): Promise<MediaUploadResponse>

​

Parameters

​

Returns

Promise<MediaUploadResponse>

​

Defined in

media/client.ts:1309

---

​

initializeUpload

▸ initializeUpload(options): Promise<Response> Initialize media upload Initializes a media upload.

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

media/client.ts:1396 ▸ initializeUpload(options?): Promise<MediaUploadResponse>

​

Parameters

​

Returns

Promise<MediaUploadResponse>

​

Defined in

media/client.ts:1405

---

​

createSubtitles

▸ createSubtitles(options): Promise<Response> Create Media subtitles Creates subtitles for a specific Media file.

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

media/client.ts:1497 ▸ createSubtitles(options?): Promise<SubtitlesCreateResponse>

​

Parameters

​

Returns

Promise<SubtitlesCreateResponse>

​

Defined in

media/client.ts:1506

---

​

deleteSubtitles

▸ deleteSubtitles(options): Promise<Response> Delete Media subtitles Deletes subtitles for a specific Media file.

​

Parameters

​

Returns

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Defined in

media/client.ts:1598 ▸ deleteSubtitles(options?): Promise<SubtitlesDeleteResponse>

​

Parameters

​

Returns

Promise<SubtitlesDeleteResponse>

​

Defined in

media/client.ts:1607