> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# MediaClient

Cliente para operaciones de contenido multimedia

Este cliente proporciona métodos para interactuar con los endpoints de contenido multimedia
de la X API. Se encarga de la autenticación, el formato de las solicitudes y el procesamiento de las respuestas
para todas las operaciones relacionadas con contenido multimedia.

zeUpload]\(/xdks/typescript/reference/classes/MediaClient#finalizeupload)

* [initializeUpload](/es/xdks/typescript/reference/classes/MediaClient#initializeupload)
* [createSubtitles](/es/xdks/typescript/reference/classes/MediaClient#createsubtitles)
* [deleteSubtitles](/es/xdks/typescript/reference/classes/MediaClient#deletesubtitles)

<div id="constructors">
  ## Constructores
</div>

<div id="constructor">
  ### constructor
</div>

• **new MediaClient**(`client`): [`MediaClient`](/es/xdks/typescript/reference/classes/MediaClient)

Crea una nueva instancia de `MediaClient`

<div id="parameters">
  #### Parámetros
</div>

| Nombre   | type                                                     | Descripción                                   |
| :------- | :------------------------------------------------------- | :-------------------------------------------- |
| `client` | [`Client`](/es/xdks/typescript/reference/classes/Client) | La instancia principal del Client de la X API |

<div id="returns">
  #### Devuelve
</div>

[`MediaClient`](/es/xdks/typescript/reference/classes/MediaClient)

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:250](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L250)

<div id="methods">
  ## Métodos
</div>

<div id="getbykey">
  ### getByKey
</div>

▸ **getByKey**(`mediaKey`, `options`): `Promise`\<`Response`>

Obtener Media por media key
Recupera los detalles de un archivo multimedia específico a partir de su media key.

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo                                                            | Descripción         |
| :--------- | :-------------------------------------------------------------- | :------------------ |
| `mediaKey` | `string`                                                        | Una sola Media Key. |
| `options`  | `GetByKeyOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                   |

#### Returns

`Promise`\<`Response`>

Promesa que se resuelve con la respuesta de la API, o con el objeto `Response` sin procesar si `requestOptions.raw` es `true`

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:295](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L295)

▸ **getByKey**(`mediaKey`, `options?`): `Promise`\<[`Get2MediaMediaKeyResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2MediaMediaKeyResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Type              |
| :--------- | :---------------- |
| `mediaKey` | `string`          |
| `options?` | `GetByKeyOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`Get2MediaMediaKeyResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2MediaMediaKeyResponse)>

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:308](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L308)

***

<div id="getuploadstatus">
  ### getUploadStatus
</div>

▸ **getUploadStatus**(`mediaId`, `options`): `Promise`\<`Response`>

Obtener el estado de la carga de contenido multimedia\
Obtiene el estado de una carga de contenido multimedia por su identificador.

<div id="parameters">
  #### Parámetros
</div>

| Nombre    | Tipo                                                                   | Descripción                                                       |
| :-------- | :--------------------------------------------------------------------- | :---------------------------------------------------------------- |
| `mediaId` | `string`                                                               | id de contenido multimedia para el estado de la carga solicitada. |
| `options` | `GetUploadStatusOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                                 |

#### Returns

`Promise`\<`Response`>

Promise que se resuelve con la respuesta de la API, o con el objeto `Response` sin procesar si `requestOptions.raw` es `true`

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:442](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L442)

▸ **getUploadStatus**(`mediaId`, `options?`): `Promise`\<[`MediaUploadResponse`](/es/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo                     |
| :--------- | :----------------------- |
| `mediaId`  | `string`                 |
| `options?` | `GetUploadStatusOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`MediaUploadResponse`](/es/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:455](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L455)

***

<div id="upload">
  ### upload
</div>

▸ **upload**(`options`): `Promise`\<`Response`>

Carga contenido multimedia\
Carga un archivo multimedia para usarlo en Publicaciones u otros contenidos.

<div id="parameters">
  #### Parámetros
</div>

| Nombre    | type                                                          |
| :-------- | :------------------------------------------------------------ |
| `options` | `UploadOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

`Promise` que se resuelve en la respuesta de la API o en el objeto `Response` sin procesar si `requestOptions.raw` es `true`

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:582](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L582)

▸ **upload**(`options?`): `Promise`\<[`MediaUploadResponse`](/es/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo            |
| :--------- | :-------------- |
| `options?` | `UploadOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`MediaUploadResponse`](/es/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:591](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L591)

***

<div id="getanalytics">
  ### getAnalytics
</div>

▸ **getAnalytics**(`mediaKeys`, `endTime`, `startTime`, `granularity`, `options`): `Promise`\<`Response`>

Obtener analítica de contenido multimedia
Obtiene datos de analítica para contenido multimedia.

<div id="parameters">
  #### Parámetros
</div>

| Name          | Type                                                                | Description                                                                                    |
| :------------ | :------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------- |
| `mediaKeys`   | `any`\[]                                                            | Una lista de Media Keys separadas por comas. Se permiten hasta 100 en una sola solicitud.      |
| `endTime`     | `string`                                                            | YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC que representa el final del intervalo de tiempo.  |
| `startTime`   | `string`                                                            | YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC que representa el inicio del intervalo de tiempo. |
| `granularity` | `string`                                                            | La granularidad para los resultados de los conteos de búsqueda.                                |
| `options`     | `GetAnalyticsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                                                              |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

Promesa que se resuelve con la respuesta de la API, o un `Response` sin procesar si `requestOptions.raw` es `true`

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:699](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L699)

▸ **getAnalytics**(`mediaKeys`, `endTime`, `startTime`, `granularity`, `options?`): `Promise`\<[`MediaAnalytics`](/es/xdks/typescript/reference/interfaces/Schemas.MediaAnalytics)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre        | Tipo                  |
| :------------ | :-------------------- |
| `mediaKeys`   | `any`\[]              |
| `endTime`     | `string`              |
| `startTime`   | `string`              |
| `granularity` | `string`              |
| `options?`    | `GetAnalyticsOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`MediaAnalytics`](/es/xdks/typescript/reference/interfaces/Schemas.MediaAnalytics)>

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:724](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L724)

***

<div id="appendupload">
  ### appendUpload
</div>

▸ **appendUpload**(`id`, `options`): `Promise`\<`Response`>

Agregar a la carga de contenido multimedia\
Agrega datos a una solicitud de carga de contenido multimedia.

<div id="parameters">
  #### Parámetros
</div>

| Nombre    | Tipo                                                                | Descripción                                                                                  |
| :-------- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------- |
| `id`      | `string`                                                            | El identificador multimedia del contenido sobre el que se realizará la operación de anexado. |
| `options` | `AppendUploadOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                                                            |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

Promesa que se resuelve con la respuesta de la API o, si requestOptions.raw es true, con el objeto Response sin procesar

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:918](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L918)

▸ **appendUpload**(`id`, `options?`): `Promise`\<[`MediaUploadAppendResponse`](/es/xdks/typescript/reference/interfaces/Schemas.MediaUploadAppendResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo                  |
| :--------- | :-------------------- |
| `id`       | `string`              |
| `options?` | `AppendUploadOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`MediaUploadAppendResponse`](/es/xdks/typescript/reference/interfaces/Schemas.MediaUploadAppendResponse)>

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:931](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L931)

***

<div id="getbykeys">
  ### getByKeys
</div>

▸ **getByKeys**(`mediaKeys`, `options`): `Promise`\<`Response`>

Obtener archivos multimedia por media keys
Recupera los detalles de archivos multimedia a partir de sus media keys.

<div id="parameters">
  #### Parámetros
</div>

| Nombre      | Tipo                                                             | Descripción                                                                                |
| :---------- | :--------------------------------------------------------------- | :----------------------------------------------------------------------------------------- |
| `mediaKeys` | `any`\[]                                                         | Una lista de Media Keys separadas por comas. Se permiten hasta 100 en una única solicitud. |
| `options`   | `GetByKeysOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                                                          |

#### Returns

`Promise`\<`Response`>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:1039](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1039)

▸ **getByKeys**(`mediaKeys`, `options?`): `Promise`\<[`Get2MediaResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2MediaResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre      | Tipo               |
| :---------- | :----------------- |
| `mediaKeys` | `any`\[]           |
| `options?`  | `GetByKeysOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`Get2MediaResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2MediaResponse)>

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:1052](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1052)

***

<div id="createmetadata">
  ### createMetadata
</div>

▸ **createMetadata**(`options`): `Promise`\<`Response`>

Crea metadatos de Media
Crea metadatos para un archivo de Media.

<div id="parameters">
  #### Parámetros
</div>

| Nombre    | Type                                                                  |
| :-------- | :-------------------------------------------------------------------- |
| `options` | `CreateMetadataOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

Promise que se resuelve en la respuesta de la API, o un objeto Response sin procesar si `requestOptions.raw` es true

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:1191](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1191)

▸ **createMetadata**(`options?`): `Promise`\<[`MetadataCreateResponse`](/es/xdks/typescript/reference/interfaces/Schemas.MetadataCreateResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo                    |
| :--------- | :---------------------- |
| `options?` | `CreateMetadataOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`MetadataCreateResponse`](/es/xdks/typescript/reference/interfaces/Schemas.MetadataCreateResponse)>

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:1200](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1200)

***

<div id="finalizeupload">
  ### finalizeUpload
</div>

▸ **finalizeUpload**(`id`, `options`): `Promise`\<`Response`>

Finalizar la carga de contenido multimedia\
Finaliza una solicitud de carga de contenido multimedia.

<div id="parameters">
  #### Parámetros
</div>

| Nombre                       | Tipo     | Descripción                                                      |
| :--------------------------- | :------- | :--------------------------------------------------------------- |
| `id`                         | `string` | El identificador del contenido multimedia que se va a finalizar. |
| `options`                    | `Object` | -                                                                |
| `options.requestOptions`     | `Object` | -                                                                |
| `options.requestOptions.raw` | `true`   | -                                                                |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

Promesa que se resuelve con la respuesta de la API, o un objeto Response sin procesar si requestOptions.raw es true

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:1296](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1296)

▸ **finalizeUpload**(`id`): `Promise`\<[`MediaUploadResponse`](/es/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre | Tipo     |
| :----- | :------- |
| `id`   | `string` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`MediaUploadResponse`](/es/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:1309](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1309)

***

<div id="initializeupload">
  ### initializeUpload
</div>

▸ **initializeUpload**(`options`): `Promise`\<`Response`>

Inicializar la carga de medios
Inicializa la carga de medios.

<div id="parameters">
  #### Parámetros
</div>

| Nombre    | Tipo                                                                    |
| :-------- | :---------------------------------------------------------------------- |
| `options` | `InitializeUploadOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

Promise que se resuelve en la respuesta de la API, o en el objeto `Response` sin procesar si `requestOptions.raw` es `true`

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:1396](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1396)

▸ **initializeUpload**(`options?`): `Promise`\<[`MediaUploadResponse`](/es/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Type                      |
| :--------- | :------------------------ |
| `options?` | `InitializeUploadOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`MediaUploadResponse`](/es/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:1405](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1405)

***

<div id="createsubtitles">
  ### createSubtitles
</div>

▸ **createSubtitles**(`options`): `Promise`\<`Response`>

Crear subtítulos de medios\
Crea subtítulos para un archivo multimedia específico.

<div id="parameters">
  #### Parámetros
</div>

| Nombre    | Tipo                                                                   |
| :-------- | :--------------------------------------------------------------------- |
| `options` | `CreateSubtitlesOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:1497](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1497)

▸ **createSubtitles**(`options?`): `Promise`\<[`SubtitlesCreateResponse`](/es/xdks/typescript/reference/interfaces/Schemas.SubtitlesCreateResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | type                     |
| :--------- | :----------------------- |
| `options?` | `CreateSubtitlesOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`SubtitlesCreateResponse`](/es/xdks/typescript/reference/interfaces/Schemas.SubtitlesCreateResponse)>

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:1506](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1506)

***

<div id="deletesubtitles">
  ### deleteSubtitles
</div>

▸ **deleteSubtitles**(`options`): `Promise`\<`Response`>

Elimina subtítulos de Media
Elimina los subtítulos de un archivo de Media específico.

<div id="parameters">
  #### Parámetros
</div>

| Nombre    | type                                                                   |
| :-------- | :--------------------------------------------------------------------- |
| `options` | `DeleteSubtitlesOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### Returns

`Promise`\<`Response`>

Promesa que se resuelve con la respuesta de la API, o con el objeto `Response` sin procesar si `requestOptions.raw` es `true`

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:1598](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1598)

▸ **deleteSubtitles**(`options?`): `Promise`\<[`SubtitlesDeleteResponse`](/es/xdks/typescript/reference/interfaces/Schemas.SubtitlesDeleteResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | type                     |
| :--------- | :----------------------- |
| `options?` | `DeleteSubtitlesOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`SubtitlesDeleteResponse`](/es/xdks/typescript/reference/interfaces/Schemas.SubtitlesDeleteResponse)>

<div id="defined-in">
  #### Definido en
</div>

[media/client.ts:1607](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1607)